diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-15 19:43:11 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-15 19:43:11 +0000 |
| commit | fc22b3d6507c6745911b9dfcc68f1e665ae13dbc (patch) | |
| tree | ce1e3bce06471410239a6f41282e328770aa404a /upstream/opensuse-leap-15-6/man8 | |
| parent | Initial commit. (diff) | |
| download | manpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.tar.xz manpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.zip | |
Adding upstream version 4.22.0.upstream/4.22.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'upstream/opensuse-leap-15-6/man8')
387 files changed, 86250 insertions, 0 deletions
diff --git a/upstream/opensuse-leap-15-6/man8/accton.8 b/upstream/opensuse-leap-15-6/man8/accton.8 new file mode 100644 index 00000000..bd7af5ef --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/accton.8 @@ -0,0 +1,61 @@ +.TH ACCTON 8 "2008 November 24" +.SH NAME +accton \- turns process accounting on or off +.SH SYNOPSIS +.hy 0 +.na +.TP +.B accton +.RI [\| OPTION \|] +.RB on \||\| off \||\| filename +.TP +.B accton +[ +.B \-V +| +.B \-\-version +] +[ +.B \-h +| +.B \-\-help +] +.SH DESCRIPTION +.LP +.B accton +.I filename +turns on process accounting. +.SH OPTIONS +.PD 0 +.TP +.TP +.B \-V, \-\-version +Print the version number of +.B ac +to standard output and quit. +.TP +.B \-h, \-\-help +Prints the usage string and default locations of system files to +standard output and exits. +.TP +.B on +Turns on process accounting using the default accounting file name. +.TP +.B off +Turns off process accounting. +.SH FILES +.TP +.I acct +The system wide process accounting file. See +.BR acct (5) +(or +.BR pacct (5)) +for further details. +.LP +.SH AUTHOR +The GNU accounting utilities were written by Noel Cragg +<noel@gnu.ai.mit.edu>. The man page was adapted from the accounting +texinfo page by Susan Kleinmann <sgk@sgk.tiac.net>. +.SH "SEE ALSO" +.BR acct (5), +.BR ac (1) diff --git a/upstream/opensuse-leap-15-6/man8/addpart.8 b/upstream/opensuse-leap-15-6/man8/addpart.8 new file mode 100644 index 00000000..e389db67 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/addpart.8 @@ -0,0 +1,75 @@ +'\" t +.\" Title: addpart +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "ADDPART" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +addpart \- tell the kernel about the existence of a partition +.SH "SYNOPSIS" +.sp +\fBaddpart\fP \fIdevice partition start length\fP +.SH "DESCRIPTION" +.sp +\fBaddpart\fP tells the Linux kernel about the existence of the specified partition. The command is a simple wrapper around the "add partition" ioctl. +.sp +This command doesn\(cqt manipulate partitions on a block device. +.SH "PARAMETERS" +.sp +\fIdevice\fP +.RS 4 +The disk device. +.RE +.sp +\fIpartition\fP +.RS 4 +The partition number. +.RE +.sp +\fIstart\fP +.RS 4 +The beginning of the partition (in 512\-byte sectors). +.RE +.sp +\fIlength\fP +.RS 4 +The length of the partition (in 512\-byte sectors). +.RE +.SH "SEE ALSO" +.sp +\fBdelpart\fP(8), +\fBfdisk\fP(8), +\fBparted\fP(8), +\fBpartprobe\fP(8), +\fBpartx\fP(8) +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBaddpart\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/agetty.8 b/upstream/opensuse-leap-15-6/man8/agetty.8 new file mode 100644 index 00000000..220d01ee --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/agetty.8 @@ -0,0 +1,593 @@ +'\" t +.\" Title: agetty +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "AGETTY" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +agetty \- alternative Linux getty +.SH "SYNOPSIS" +.sp +\fBagetty\fP [options] \fIport\fP [\fIbaud_rate\fP...] [\fIterm\fP] +.SH "DESCRIPTION" +.sp +\fBagetty\fP opens a tty port, prompts for a login name and invokes the /bin/login command. It is normally invoked by \fBinit\fP(8). +.sp +\fBagetty\fP has several \fInon\-standard\fP features that are useful for hardwired and for dial\-in lines: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +. sp -1 +. IP \(bu 2.3 +.\} +Adapts the tty settings to parity bits and to erase, kill, end\-of\-line and uppercase characters when it reads a login name. The program can handle 7\-bit characters with even, odd, none or space parity, and 8\-bit characters with no parity. The following special characters are recognized: Control\-U (kill); DEL and backspace (erase); carriage return and line feed (end of line). See also the \fB\-\-erase\-chars\fP and \fB\-\-kill\-chars\fP options. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +. sp -1 +. IP \(bu 2.3 +.\} +Optionally deduces the baud rate from the CONNECT messages produced by Hayes(tm)\-compatible modems. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +. sp -1 +. IP \(bu 2.3 +.\} +Optionally does not hang up when it is given an already opened line (useful for call\-back applications). +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +. sp -1 +. IP \(bu 2.3 +.\} +Optionally does not display the contents of the \fI/etc/issue\fP file. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +. sp -1 +. IP \(bu 2.3 +.\} +Optionally displays an alternative issue files or directories instead of \fI/etc/issue\fP or \fI/etc/issue.d\fP. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +. sp -1 +. IP \(bu 2.3 +.\} +Optionally does not ask for a login name. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +. sp -1 +. IP \(bu 2.3 +.\} +Optionally invokes a non\-standard login program instead of \fI/bin/login\fP. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +. sp -1 +. IP \(bu 2.3 +.\} +Optionally turns on hardware flow control. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +. sp -1 +. IP \(bu 2.3 +.\} +Optionally forces the line to be local with no need for carrier detect. +.RE +.sp +This program does not use the \fI/etc/gettydefs\fP (System V) or \fI/etc/gettytab\fP (SunOS 4) files. +.SH "ARGUMENTS" +.sp +\fIport\fP +.RS 4 +A path name relative to the \fI/dev\fP directory. If a "\-" is specified, \fBagetty\fP assumes that its standard input is already connected to a tty port and that a connection to a remote user has already been established. +.sp +Under System V, a "\-" \fIport\fP argument should be preceded by a "\-\-". +.RE +.sp +\fIbaud_rate\fP,... +.RS 4 +A comma\-separated list of one or more baud rates. Each time \fBagetty\fP receives a BREAK character it advances through the list, which is treated as if it were circular. +.sp +Baud rates should be specified in descending order, so that the null character (Ctrl\-@) can also be used for baud\-rate switching. +.sp +This argument is optional and unnecessary for \fBvirtual terminals\fP. +.sp +The default for \fBserial terminals\fP is keep the current baud rate (see \fB\-\-keep\-baud\fP) and if unsuccessful then default to \(aq9600\(aq. +.RE +.sp +\fIterm\fP +.RS 4 +The value to be used for the \fBTERM\fP environment variable. This overrides whatever \fBinit\fP(1) may have set, and is inherited by login and the shell. +.sp +The default is \(aqvt100\(aq, or \(aqlinux\(aq for Linux on a virtual terminal, or \(aqhurd\(aq for GNU Hurd on a virtual terminal. +.RE +.SH "OPTIONS" +.sp +\fB\-8\fP, \fB\-\-8bits\fP +.RS 4 +Assume that the tty is 8\-bit clean, hence disable parity detection. +.RE +.sp +\fB\-a\fP, \fB\-\-autologin\fP \fIusername\fP +.RS 4 +Automatically log in the specified user without asking for a username or password. Using this option causes an \fB\-f\fP \fIusername\fP option and argument to be added to the \fB/bin/login\fP command line. See \fB\-\-login\-options\fP, which can be used to modify this option\(cqs behavior. +.sp +Note that \fB\-\-autologin\fP may affect the way in which \fBgetty\fP initializes the serial line, because on auto\-login \fBagetty\fP does not read from the line and it has no opportunity optimize the line setting. +.RE +.sp +\fB\-c\fP, \fB\-\-noreset\fP +.RS 4 +Do not reset terminal cflags (control modes). See \fBtermios\fP(3) for more details. +.RE +.sp +\fB\-E\fP, \fB\-\-remote\fP +.RS 4 +Typically the \fBlogin\fP(1) command is given a remote hostname when called by something such as \fBtelnetd\fP(8). This option allows \fBagetty\fP to pass what it is using for a hostname to \fBlogin\fP(1) for use in \fButmp\fP(5). See \fB\-\-host\fP, \fBlogin\fP(1), and \fButmp\fP(5). +.sp +If the \fB\-\-host\fP \fIfakehost\fP option is given, then an \fB\-h\fP \fIfakehost\fP option and argument are added to the \fI/bin/login\fP command line. +.sp +If the \fB\-\-nohostname\fP option is given, then an \fB\-H\fP option is added to the \fB/bin/login\fP command line. +.sp +See \fB\-\-login\-options\fP. +.RE +.sp +\fB\-f\fP, \fB\-\-issue\-file\fP \fIpath\fP +.RS 4 +Specifies a ":" delimited list of files and directories to be displayed instead of \fI/etc/issue\fP (or other). All specified files and directories are displayed, missing or empty files are silently ignored. If the specified path is a directory then display all files with .issue file extension in version\-sort order from the directory. This allows custom messages to be displayed on different terminals. The \fB\-\-noissue\fP option will override this option. +.RE +.sp +\fB\-\-show\-issue\fP +.RS 4 +Display the current issue file (or other) on the current terminal and exit. Use this option to review the current setting, it is not designed for any other purpose. Note that output may use some default or incomplete information as proper output depends on terminal and agetty command line. +.RE +.sp +\fB\-h, \-\-flow\-control\fP +.RS 4 +Enable hardware (RTS/CTS) flow control. It is left up to the application to disable software (XON/XOFF) flow protocol where appropriate. +.RE +.sp +\fB\-H\fP, \fB\-\-host\fP \fIfakehost\fP +.RS 4 +Write the specified \fIfakehost\fP into the utmp file. Normally, no login host is given, since \fBagetty\fP is used for local hardwired connections and consoles. However, this option can be useful for identifying terminal concentrators and the like. +.RE +.sp +\fB\-i\fP, \fB\-\-noissue\fP +.RS 4 +Do not display the contents of \fI/etc/issue\fP (or other) before writing the login prompt. Terminals or communications hardware may become confused when receiving lots of text at the wrong baud rate; dial\-up scripts may fail if the login prompt is preceded by too much text. +.RE +.sp +\fB\-I\fP, \fB\-\-init\-string\fP \fIinitstring\fP +.RS 4 +Set an initial string to be sent to the tty or modem before sending anything else. This may be used to initialize a modem. Non\-printable characters may be sent by writing their octal code preceded by a backslash (\(rs). For example, to send a linefeed character (ASCII 10, octal 012), write \(rs12. +.RE +.sp +\fB\-J\fP, \fB\-\-noclear\fP +.RS 4 +Do not clear the screen before prompting for the login name. By default the screen is cleared. +.RE +.sp +\fB\-l\fP, \fB\-\-login\-program\fP \fIlogin_program\fP +.RS 4 +Invoke the specified \fIlogin_program\fP instead of /bin/login. This allows the use of a non\-standard login program. Such a program could, for example, ask for a dial\-up password or use a different password file. See \fB\-\-login\-options\fP. +.RE +.sp +\fB\-L\fP, \fB\-\-local\-line\fP[=\fImode\fP] +.RS 4 +Control the CLOCAL line flag. The optional \fImode\fP argument is \(aqauto\(aq, \(aqalways\(aq or \(aqnever\(aq. If the \fImode\fP argument is omitted, then the default is \(aqalways\(aq. If the \fB\-\-local\-line\fP option is not given at all, then the default is \(aqauto\(aq. +.sp +\fIalways\fP +.RS 4 +Forces the line to be a local line with no need for carrier detect. This can be useful when you have a locally attached terminal where the serial line does not set the carrier\-detect signal. +.RE +.sp +\fInever\fP +.RS 4 +Explicitly clears the CLOCAL flag from the line setting and the carrier\-detect signal is expected on the line. +.RE +.sp +\fIauto\fP +.RS 4 +The \fBagetty\fP default. Does not modify the CLOCAL setting and follows the setting enabled by the kernel. +.RE +.RE +.sp +\fB\-m\fP, \fB\-\-extract\-baud\fP +.RS 4 +Try to extract the baud rate from the CONNECT status message produced by Hayes(tm)\-compatible modems. These status messages are of the form: "<junk><speed><junk>". \fBagetty\fP assumes that the modem emits its status message at the same speed as specified with (the first) \fIbaud_rate\fP value on the command line. +.sp +Since the \fB\-\-extract\-baud\fP feature may fail on heavily\-loaded systems, you still should enable BREAK processing by enumerating all expected baud rates on the command line. +.RE +.sp +\fB\-\-list\-speeds\fP +.RS 4 +Display supported baud rates. These are determined at compilation time. +.RE +.sp +\fB\-n\fP, \fB\-\-skip\-login\fP +.RS 4 +Do not prompt the user for a login name. This can be used in connection with the \fB\-\-login\-program\fP option to invoke a non\-standard login process such as a BBS system. Note that with the \fB\-\-skip\-login\fP option, \fBagetty\fP gets no input from the user who logs in and therefore will not be able to figure out parity, character size, and newline processing of the connection. It defaults to space parity, 7 bit characters, and ASCII CR (13) end\-of\-line character. Beware that the program that \fBagetty\fP starts (usually /bin/login) is run as root. +.RE +.sp +\fB\-N\fP, \fB\-\-nonewline\fP +.RS 4 +Do not print a newline before writing out \fI/etc/issue\fP. +.RE +.sp +\fB\-o\fP, \fB\-\-login\-options\fP \fIlogin_options\fP +.RS 4 +Options and arguments that are passed to \fBlogin\fP(1). Where \(rsu is replaced by the login name. For example: +.sp +\fB\-\-login\-options \(aq\-h darkstar \(em \(rsu\(aq\fP +.sp +See \fB\-\-autologin\fP, \fB\-\-login\-program\fP and \fB\-\-remote\fP. +.sp +Please read the SECURITY NOTICE below before using this option. +.RE +.sp +\fB\-p\fP, \fB\-\-login\-pause\fP +.RS 4 +Wait for any key before dropping to the login prompt. Can be combined with \fB\-\-autologin\fP to save memory by lazily spawning shells. +.RE +.sp +\fB\-r\fP, \fB\-\-chroot\fP \fIdirectory\fP +.RS 4 +Change root to the specified directory. +.RE +.sp +\fB\-R\fP, \fB\-\-hangup\fP +.RS 4 +Call \fBvhangup\fP(2) to do a virtual hangup of the specified terminal. +.RE +.sp +\fB\-s\fP, \fB\-\-keep\-baud\fP +.RS 4 +Try to keep the existing baud rate. The baud rates from the command line are used when \fBagetty\fP receives a BREAK character. If another baud rates specified then the original baud rate is also saved to the end of the wanted baud rates list. This can be used to return to the original baud rate after unexpected BREAKs. +.RE +.sp +\fB\-t\fP, \fB\-\-timeout\fP \fItimeout\fP +.RS 4 +Terminate if no user name could be read within \fItimeout\fP seconds. Use of this option with hardwired terminal lines is not recommended. +.RE +.sp +\fB\-U\fP, \fB\-\-detect\-case\fP +.RS 4 +Turn on support for detecting an uppercase\-only terminal. This setting will detect a login name containing only capitals as indicating an uppercase\-only terminal and turn on some upper\-to\-lower case conversions. Note that this has no support for any Unicode characters. +.RE +.sp +\fB\-w\fP, \fB\-\-wait\-cr\fP +.RS 4 +Wait for the user or the modem to send a carriage\-return or a linefeed character before sending the \fI/etc/issue\fP file (or others) and the login prompt. This is useful with the \fB\-\-init\-string\fP option. +.RE +.sp +\fB\-\-nohints\fP +.RS 4 +Do not print hints about Num, Caps and Scroll Locks. +.RE +.sp +\fB\-\-nohostname\fP +.RS 4 +By default the hostname will be printed. With this option enabled, no hostname at all will be shown. +.RE +.sp +\fB\-\-long\-hostname\fP +.RS 4 +By default the hostname is only printed until the first dot. With this option enabled, the fully qualified hostname by \fBgethostname\fP(3P) or (if not found) by \fBgetaddrinfo\fP(3) is shown. +.RE +.sp +\fB\-\-erase\-chars\fP \fIstring\fP +.RS 4 +This option specifies additional characters that should be interpreted as a backspace ("ignore the previous character") when the user types the login name. The default additional \(aqerase\(aq has been \(aq#\(aq, but since util\-linux 2.23 no additional erase characters are enabled by default. +.RE +.sp +\fB\-\-kill\-chars\fP \fIstring\fP +.RS 4 +This option specifies additional characters that should be interpreted as a kill ("ignore all previous characters") when the user types the login name. The default additional \(aqkill\(aq has been \(aq@\(aq, but since util\-linux 2.23 no additional kill characters are enabled by default. +.RE +.sp +\fB\-\-chdir\fP \fIdirectory\fP +.RS 4 +Change directory before the login. +.RE +.sp +\fB\-\-delay\fP \fInumber\fP +.RS 4 +Sleep seconds before open tty. +.RE +.sp +\fB\-\-nice\fP \fInumber\fP +.RS 4 +Run login with this priority. +.RE +.sp +\fB\-\-reload\fP +.RS 4 +Ask all running agetty instances to reload and update their displayed prompts, if the user has not yet commenced logging in. After doing so the command will exit. This feature might be unsupported on systems without Linux \fBinotify\fP(7). +.RE +.sp +\fB\-\-version\fP +.RS 4 +Display version information and exit. +.RE +.sp +\fB\-\-help\fP +.RS 4 +Display help text and exit. +.RE +.SH "EXAMPLE" +.sp +This section shows examples for the process field of an entry in the \fI/etc/inittab\fP file. You\(cqll have to prepend appropriate values for the other fields. See \fBinittab\fP(5) for more details. +.sp +For a hardwired line or a console tty: +.RS 3 +.ll -.6i +.sp +\fB/sbin/agetty 9600 ttyS1\fP +.br +.RE +.ll +.sp +For a directly connected terminal without proper carrier\-detect wiring (try this if your terminal just sleeps instead of giving you a password: prompt): +.RS 3 +.ll -.6i +.sp +\fB/sbin/agetty \-\-local\-line 9600 ttyS1 vt100\fP +.br +.RE +.ll +.sp +For an old\-style dial\-in line with a 9600/2400/1200 baud modem: +.RS 3 +.ll -.6i +.sp +\fB/sbin/agetty \-\-extract\-baud \-\-timeout 60 ttyS1 9600,2400,1200\fP +.br +.RE +.ll +.sp +For a Hayes modem with a fixed 115200 bps interface to the machine (the example init string turns off modem echo and result codes, makes modem/computer DCD track modem/modem DCD, makes a DTR drop cause a disconnection, and turns on auto\-answer after 1 ring): +.RS 3 +.ll -.6i +.sp +\fB/sbin/agetty \-\-wait\-cr \-\-init\-string \(aqATE0Q1&D2&C1S0=1\(rs015\(aq 115200 ttyS1\fP +.br +.RE +.ll +.SH "SECURITY NOTICE" +.sp +If you use the \fB\-\-login\-program\fP and \fB\-\-login\-options\fP options, be aware that a malicious user may try to enter lognames with embedded options, which then get passed to the used login program. Agetty does check for a leading "\-" and makes sure the logname gets passed as one parameter (so embedded spaces will not create yet another parameter), but depending on how the login binary parses the command line that might not be sufficient. Check that the used login program cannot be abused this way. +.sp +Some programs use "\-\-" to indicate that the rest of the command line should not be interpreted as options. Use this feature if available by passing "\-\-" before the username gets passed by \(rsu. +.SH "ISSUE FILES" +.sp +The default issue file is \fI/etc/issue\fP. If the file exists, then \fBagetty\fP also checks for \fI/etc/issue.d\fP directory. The directory is optional extension to the default issue file and content of the directory is printed after \fI/etc/issue\fP content. If the \fI/etc/issue\fP does not exist, then the directory is ignored. All files \fBwith .issue extension\fP from the directory are printed in version\-sort order. The directory can be used to maintain 3rd\-party messages independently on the primary system \fI/etc/issue\fP file. +.sp +Since version 2.35 additional locations for issue file and directory are supported. If the default \fI/etc/issue\fP does not exist, then \fBagetty\fP checks for \fI/run/issue\fP and \fI/run/issue.d\fP, thereafter for \fI/usr/lib/issue\fP and \fI/usr/lib/issue.d\fP. The directory \fI/etc\fP is expected for host specific configuration, \fI/run\fP is expected for generated stuff and \fI/usr/lib\fP for static distribution maintained configuration. +.sp +The default path maybe overridden by \fB\-\-issue\-file\fP option. In this case specified path has to be file or directory and all the default issue file and directory locations are ignored. +.sp +The issue file feature can be completely disabled by \fB\-\-noissue\fP option. +.sp +It is possible to review the current issue file by \fBagetty \-\-show\-issue\fP on the current terminal. +.sp +The issue files may contain certain escape codes to display the system name, date, time et cetera. All escape codes consist of a backslash (\(rs) immediately followed by one of the characters listed below. +.sp +4 or 4{\fIinterface\fP} +.RS 4 +Insert the IPv4 address of the specified network interface (for example: \(rs4{eth0}). If the \fIinterface\fP argument is not specified, then select the first fully configured (UP, non\-LOCALBACK, RUNNING) interface. If not any configured interface is found, fall back to the IP address of the machine\(cqs hostname. +.RE +.sp +6 or 6{\fIinterface\fP} +.RS 4 +The same as \(rs4 but for IPv6. +.RE +.sp +b +.RS 4 +Insert the baudrate of the current line. +.RE +.sp +d +.RS 4 +Insert the current date. +.RE +.sp +e or e{\fIname\fP} +.RS 4 +Translate the human\-readable \fIname\fP to an escape sequence and insert it (for example: \(rse{red}Alert text.\(rse{reset}). If the \fIname\fP argument is not specified, then insert \(rs033. The currently supported names are: black, blink, blue, bold, brown, cyan, darkgray, gray, green, halfbright, lightblue, lightcyan, lightgray, lightgreen, lightmagenta, lightred, magenta, red, reset, reverse, yellow and white. All unknown names are silently ignored. +.RE +.sp +s +.RS 4 +Insert the system name (the name of the operating system). Same as \(aquname \-s\(aq. See also the \(rsS escape code. +.RE +.sp +S or S{VARIABLE} +.RS 4 +Insert the VARIABLE data from \fI/etc/os\-release\fP. If this file does not exist then fall back to \fI/usr/lib/os\-release\fP. If the VARIABLE argument is not specified, then use PRETTY_NAME from the file or the system name (see \(rss). This escape code can be used to keep \fI/etc/issue\fP distribution and release independent. Note that \(rsS{ANSI_COLOR} is converted to the real terminal escape sequence. +.RE +.sp +l +.RS 4 +Insert the name of the current tty line. +.RE +.sp +m +.RS 4 +Insert the architecture identifier of the machine. Same as \fBuname \-m\fP. +.RE +.sp +n +.RS 4 +Insert the nodename of the machine, also known as the hostname. Same as \fBuname \-n\fP. +.RE +.sp +o +.RS 4 +Insert the NIS domainname of the machine. Same as \fBhostname \-d\fP. +.RE +.sp +O +.RS 4 +Insert the DNS domainname of the machine. +.RE +.sp +r +.RS 4 +Insert the release number of the OS. Same as \fBuname \-r\fP. +.RE +.sp +t +.RS 4 +Insert the current time. +.RE +.sp +u +.RS 4 +Insert the number of current users logged in. +.RE +.sp +U +.RS 4 +Insert the string "1 user" or "<n> users" where <n> is the number of current users logged in. +.RE +.sp +v +.RS 4 +Insert the version of the OS, that is, the build\-date and such. +.RE +.sp +An example. On my system, the following \fI/etc/issue\fP file: +.sp +.if n .RS 4 +.nf +.fam C +This is \(rsn.\(rso (\(rss \(rsm \(rsr) \(rst +.fam +.fi +.if n .RE +.sp +displays as: +.sp +.if n .RS 4 +.nf +.fam C +This is thingol.orcan.dk (Linux i386 1.1.9) 18:29:30 +.fam +.fi +.if n .RE +.SH "FILES" +.sp +\fI/var/run/utmp\fP +.RS 4 +the system status file. +.RE +.sp +\fI/etc/issue\fP +.RS 4 +printed before the login prompt. +.RE +.sp +\fI/etc/os\-release /usr/lib/os\-release\fP +.RS 4 +operating system identification data. +.RE +.sp +\fI/dev/console\fP +.RS 4 +problem reports (if \fBsyslog\fP(3) is not used). +.RE +.sp +\fI/etc/inittab\fP +.RS 4 +\fBinit\fP(8) configuration file for SysV\-style init daemon. +.RE +.SH "BUGS" +.sp +The baud\-rate detection feature (the \fB\-\-extract\-baud\fP option) requires that \fBagetty\fP be scheduled soon enough after completion of a dial\-in call (within 30 ms with modems that talk at 2400 baud). For robustness, always use the \fB\-\-extract\-baud\fP option in combination with a multiple baud rate command\-line argument, so that BREAK processing is enabled. +.sp +The text in the \fI/etc/issue\fP file (or other) and the login prompt are always output with 7\-bit characters and space parity. +.sp +The baud\-rate detection feature (the \fB\-\-extract\-baud\fP option) requires that the modem emits its status message \fIafter\fP raising the DCD line. +.SH "DIAGNOSTICS" +.sp +Depending on how the program was configured, all diagnostics are written to the console device or reported via the \fBsyslog\fP(3) facility. Error messages are produced if the \fIport\fP argument does not specify a terminal device; if there is no utmp entry for the current process (System V only); and so on. +.SH "AUTHORS" +.sp +.MTO "werner\(atsuse.de" "Werner Fink" "," +.MTO "kzak\(atredhat.com" "Karel Zak" "" +.sp +The original \fBagetty\fP for serial terminals was written by \c +.MTO "wietse\(atwzv.win.tue.nl" "W.Z. Venema" "" +and ported to Linux by +.MTO "poe\(atdaimi.aau.dk" "Peter Orbaek" "." +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBagetty\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/anacron.8 b/upstream/opensuse-leap-15-6/man8/anacron.8 new file mode 100644 index 00000000..170fa7c1 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/anacron.8 @@ -0,0 +1,217 @@ +.TH ANACRON 8 2012-11-22 "cronie" "System Administration" +.SH NAME +anacron \- runs commands periodically +.SH SYNOPSIS +.B anacron \fR[\fB-s\fR] [\fB-f\fR] [\fB-n\fR] [\fB-d\fR] [\fB-q\fR] +[\fB-t anacrontab\fR] [\fB-S spooldir\fR] [\fIjob\fR] +.br +.B anacron \fR[\fB-S spooldir\fR] -u [\fB-t anacrontab\fR] \fR[\fIjob\fR] +.br +.B anacron \fR[\fB-V\fR|\fB-h\fR] +.br +.B anacron -T \fR[\fB-t anacrontab\fR] +.SH DESCRIPTION +.B Anacron +is used to execute commands periodically, with a frequency specified in +days. Unlike +.BR cron(8) , +it does not assume that the machine is running continuously. Hence, it +can be used on machines that are not running 24 hours a day to control +regular jobs as daily, weekly, and monthly jobs. +.PP +Anacron reads a list of jobs from the +.I /etc/anacrontab +configuration file (see +.BR anacrontab (5)). +This file contains the list of jobs that Anacron controls. Each job +entry specifies a period in days, a delay in minutes, a unique job +identifier, and a shell command. +.PP +For each job, Anacron checks whether this job has been executed in the +last +.B n +days, where +.B n +is the time period specified for that job. If a job has not been +executed in +.B n +days or more, Anacron runs the job's shell command, after waiting for the +number of minutes specified as the delay parameter. +.PP +After the command exits, Anacron records the date (excludes the hour) in +a special timestamp file for that job, so it knows when to execute that +job again. +.PP +When there are no more jobs to be run, Anacron exits. +.PP +Anacron only considers jobs whose identifier, as specified in +.BR anacrontab (5), +matches any of the +.I job +command-line arguments. The +.I job +command-line arguments can be represented by shell wildcard patterns (be +sure to protect them from your shell with adequate quoting). Specifying +no +.I job +command-line arguments is equivalent to specifying "*" (that is, all +jobs are considered by Anacron). +.PP +Unless Anacron is run with the +.B \-d +option (specified below), it forks to the background when it starts, and +any parent processes exit immediately. +.PP +Unless Anacron is run with the +.B \-s +or +.B \-n +options, it starts jobs immediately when their delay is over. The +execution of different jobs is completely independent. +.PP +If an executed job generates any output to standard output or to standard +error, the output is mailed to the user under whom Anacron is running +(usually root), or to the address specified in the +.B MAILTO +environment variable in the +.I /etc/anacrontab +file, if such exists. If the +.B LOGNAME +environment variable is set, it is used in the From: field of the mail. +.PP +Any informative messages generated by Anacron are sent to +.BR syslogd (8) +or +.BR rsyslogd (8) +under with facility set to +.B cron +and priority set to +.BR notice . +Any error messages are sent with the priority +.BR error . +.PP +"Active" jobs (i.e., jobs that Anacron already decided to run and are now +waiting for their delay to pass, and jobs that are currently being +executed by Anacron), are "locked", so that other copies of Anacron +cannot run them at the same time. +.SH OPTIONS +.TP +.B \-f +Forces execution of all jobs, ignoring any timestamps. +.TP +.B \-u +Updates the timestamps of all jobs to the current date, but does not run +any. +.TP +.B \-s +Serializes execution of jobs. Anacron does not start a new job before the +previous one finished. +.TP +.B \-n +Runs jobs immediately and ignores the specified delays in the +.I /etc/anacrontab +file. This options implies +.BR -s . +.TP +.B \-d +Does not fork Anacron to the background. In this mode, Anacron will +output informational messages to standard error, as well as to syslog. +The output of any job is mailed by Anacron. +.TP +.B \-q +Suppresses any messages to standard error. Only applicable with +.BR -d . +.TP +.B -t some_anacrontab +Uses the specified anacrontab, rather than the +.I /etc/anacrontab +default one. +.TP +.B -T +Anacrontab testing. Tests the +.I /etc/anacrontab +configuration file for validity. If there is an error in the file, it is +shown on the standard output and Anacron returns the value of 1. Valid +anacrontabs return the value of 0. +.TP +.B -S spooldir +Uses the specified spooldir to store timestamps in. This option is +required for users who wish to run anacron themselves. +.TP +.B -V +Prints version information, and exits. +.TP +.B -h +Prints short usage message, and exits. +.SH SIGNALS +After receiving a +.B SIGUSR1 +signal, Anacron waits for any running jobs to finish and then exits. +This can be used to stop Anacron cleanly. +.SH NOTES +Make sure your time-zone is set correctly before Anacron is started since +the time-zone affects the date. This is usually accomplished by setting +the TZ environment variable, or by installing a +.I /usr/lib/zoneinfo/localtime +file. See +.BR tzset (3) +for more information. +.PP +Timestamp files are created in the spool directory for each job specified +in an anacrontab. These files are never removed automatically by +Anacron, and should be removed by hand if a job is no longer being +scheduled. +.SH FILES +.TP +.I /etc/anacrontab +Contains specifications of jobs. See +.BR anacrontab (5) +for a complete description. +.TP +.I /var/spool/anacron +This directory is used by Anacron for storing timestamp files. +.SH "SEE ALSO" +.BR anacrontab (5), +.BR cron (8), +.BR tzset (3) +.PP +The Anacron +.I README +file. +.SH BUGS +Anacron never removes timestamp files. Remove unused files manually. +.PP +Anacron uses up to two file descriptors for each active job. It may run +out of descriptors if there are lots of active jobs. See +.B echo $(($(ulimit -n) / 2)) +for information how many concurent jobs anacron may run. +.PP +Mail comments, suggestions and bug reports to +.MT shaleh@\:(debian.\:org|\:valinux.\:com) +Sean 'Shaleh' Perry +.ME . +.SH AUTHOR +Anacron was originally conceived and implemented by +.MT schwarz@\:monet.\:m.\:isar.\:de +Christian Schwarz +.ME . +.PP +The current implementation is a complete rewrite by +.MT itzur@\:actcom.\:co.\:il +Itai Tzur +.ME . +.PP +The code base was maintained by +.MT shaleh@\:(debian.\:org|\:valinux.\:com) +Sean 'Shaleh' Perry +.ME . +.PP +Since 2004, it is maintained by +.MT pasc@\:(debian.\:org|\:redellipse.\:net) +Pascal Hakim +.ME . +.PP +For Fedora, Anacron is maintained by +.MT mmaslano@redhat.\:com +Marcela Mašláňová +.ME . diff --git a/upstream/opensuse-leap-15-6/man8/applydeltaiso.8 b/upstream/opensuse-leap-15-6/man8/applydeltaiso.8 new file mode 100644 index 00000000..da491856 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/applydeltaiso.8 @@ -0,0 +1,28 @@ +.\" man page for applydeltaiso +.\" Copyright (c) 2005 Michael Schroeder <mls@suse.de> +.\" See LICENSE.BSD for license +.TH APPLYDELTAISO 8 "Jul 2009" +.SH NAME +applydeltaiso \- reconstruct an iso from the old iso and the deltaiso + +.SH SYNOPSIS +.B applydeltaiso +.I oldiso +.I deltaiso +.I newiso + +.SH DESCRIPTION +applydeltaiso applies a deltaiso to +.I oldiso +to re-create +.IR newiso . + +When specifying +.IR oldiso , +you can specify a device (such as /dev/dvd). + +.SH SEE ALSO +.BR makedeltaiso (8) + +.SH AUTHOR +Michael Schroeder <mls@suse.de> diff --git a/upstream/opensuse-leap-15-6/man8/applydeltarpm.8 b/upstream/opensuse-leap-15-6/man8/applydeltarpm.8 new file mode 100644 index 00000000..766bbac9 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/applydeltarpm.8 @@ -0,0 +1,78 @@ +.\" man page for applydeltarpm +.\" Copyright (c) 2005 Michael Schroeder <mls@suse.de> +.\" See LICENSE.BSD for license +.TH APPLYDELTARPM 8 "Feb 2005" +.SH NAME +applydeltarpm \- reconstruct an rpm from a deltarpm + +.SH SYNOPSIS +.B applydeltarpm +.RB [ -v ] +.RB [ -p ] +.RB [ -r +.IR oldrpm ] +.I deltarpm +.I newrpm +.br +.B applydeltarpm +.BR -c | -C +.I deltarpm +.br +.B applydeltarpm +.RB [ -c | -C ] +.B -s +.I sequence +.br +.B applydeltarpm +.BR -i +.I deltarpm + +.SH DESCRIPTION +applydeltarpm applies a binary delta to either an old rpm or to +on-disk data to re-create a new rpm. The old rpm can be specified +with the +.B -r +option, if no rpm name is provided on-disk data is used. You +can use +.B -p +to make applydeltarpm print the percentage of completion, or +.B -v +to make it more verbose about its operation. + +The second an third form can be used to check if the reconstruction +is possible. It may fail if the on-disk data got changed +(deltarpms are created in a way that config file changes do not +matter) or the deltarpm does not match the rpm the delta was generated +with. The +.B -c +option selects full (i.e. slow) on-disk checking, whereas +.B -C +only checks if the filesizes have not changed. + +Instead of a full deltarpm a sequence id can be given with the +.B -s +.I sequence +option. Such an id contains all the information that is needed to +do reconstruction checking. + +Finally information about a deltarpm can be printed with +the +.B -i +option. + +.SH MEMORY CONSIDERATIONS +applydeltarpm was written to work on systems with limited memory. +It uses a paging algorithm to keep the size of in-core data low +and not bring the system in an out-of-memory situation. + +.SH EXIT STATUS +applydeltarpm returns 0 if the rpm could be recreated or the +checking succeeded, it returns 1 and prints an error message +to stderr if something failed. + +.SH SEE ALSO +.BR makedeltarpm (8), +.BR rpm (8) + +.SH AUTHOR +Michael Schroeder <mls@suse.de> diff --git a/upstream/opensuse-leap-15-6/man8/arping.8 b/upstream/opensuse-leap-15-6/man8/arping.8 new file mode 100644 index 00000000..af00f474 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/arping.8 @@ -0,0 +1,155 @@ +'\" t +.TH "ARPING" "8" "" "iputils 20221126" "iputils" +.\" ----------------------------------------------------------------- +.\" * 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" +arping \- send ARP REQUEST to a neighbour host +.SH "SYNOPSIS" +.HP \w'\fBarping\fR\ 'u +\fBarping\fR [\fB\-AbDfhqUV\fR] [\fB\-c\ \fR\fB\fIcount\fR\fR] [\fB\-w\ \fR\fB\fIdeadline\fR\fR] [\fB\-i\ \fR\fB\fIinterval\fR\fR] [\fB\-s\ \fR\fB\fIsource\fR\fR] [\fB\-I\ \fR\fB\fIinterface\fR\fR] {destination} +.SH "DESCRIPTION" +.PP +Ping +\fIdestination\fR +on device +\fIinterface\fR +by ARP packets, using source address +\fIsource\fR\&. +.PP +arping supports IPv4 addresses only\&. For IPv6, see +\fBndisc6\fR(8)\&. +.SH "OPTIONS" +.PP +\fB\-A\fR +.RS 4 +The same as +\fB\-U\fR, but ARP REPLY packets used instead of ARP REQUEST\&. +.RE +.PP +\fB\-b\fR +.RS 4 +Send only MAC level broadcasts\&. Normally +\fBarping\fR +starts from sending broadcast, and switch to unicast after reply received\&. +.RE +.PP +\fB\-c \fR\fB\fIcount\fR\fR +.RS 4 +Stop after sending +\fIcount\fR +ARP REQUEST packets\&. With +\fIdeadline\fR +option, instead wait for +\fIcount\fR +ARP REPLY packets, or until the timeout expires\&. +.RE +.PP +\fB\-D\fR +.RS 4 +Duplicate address detection mode (DAD)\&. See RFC2131, 4\&.4\&.1\&. Returns 0, if DAD succeeded i\&.e\&. no replies are received\&. +.RE +.PP +\fB\-f\fR +.RS 4 +Finish after the first reply confirming that target is alive\&. +.RE +.PP +\fB\-I \fR\fB\fIinterface\fR\fR +.RS 4 +Name of network device where to send ARP REQUEST packets\&. +.RE +.PP +\fB\-h\fR +.RS 4 +Print help page and exit\&. +.RE +.PP +\fB\-q\fR +.RS 4 +Quiet output\&. Nothing is displayed\&. +.RE +.PP +\fB\-s \fR\fB\fIsource\fR\fR +.RS 4 +IP source address to use in ARP packets\&. If this option is absent, source address is: +.PP +.RS 4 +\(bu In DAD mode (with option +\fB\-D\fR) set to 0\&.0\&.0\&.0\&. +.RE +.PP +.RS 4 +\(bu In Unsolicited ARP mode (with options +\fB\-U\fR +or +\fB\-A\fR) set to +\fIdestination\fR\&. +.RE +.PP +.RS 4 +\(bu Otherwise, it is calculated from routing tables\&. +.RE +.RE +.PP +\fB\-U\fR +.RS 4 +Unsolicited ARP mode to update neighbours\*(Aq ARP caches\&. No replies are expected\&. +.RE +.PP +\fB\-V\fR +.RS 4 +Print version of the program and exit\&. +.RE +.PP +\fB\-w \fR\fB\fIdeadline\fR\fR +.RS 4 +Specify a timeout, in seconds, before +\fBarping\fR +exits regardless of how many packets have been sent or received\&. If any replies are received, exit with status 0, otherwise status 1\&. When combined with the +\fIcount\fR +option, exit with status 0 if +\fIcount\fR +replies are received before the deadline expiration, otherwise status 1\&. +.RE +.PP +\fB\-i \fR\fB\fIinterval\fR\fR +.RS 4 +Specify an interval, in seconds, between packets\&. +.RE +.SH "SEE ALSO" +.PP +\fBndisc6\fR(8), +\fBping\fR(8), +\fBclockdiff\fR(8), +\fBtracepath\fR(8)\&. +.SH "AUTHOR" +.PP +\fBarping\fR +was written by Alexey Kuznetsov <kuznet@ms2\&.inr\&.ac\&.ru>\&. +.SH "SECURITY" +.PP +\fBarping\fR +requires CAP_NET_RAW capability to be executed\&. It is not recommended to be used as set\-uid root, because it allows user to modify ARP caches of neighbour hosts\&. +.SH "AVAILABILITY" +.PP +\fBarping\fR +is part of +\fIiputils\fR +package\&. diff --git a/upstream/opensuse-leap-15-6/man8/arptables-nft-restore.8 b/upstream/opensuse-leap-15-6/man8/arptables-nft-restore.8 new file mode 100644 index 00000000..09d9082c --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/arptables-nft-restore.8 @@ -0,0 +1,39 @@ +.TH ARPTABLES-RESTORE 8 "March 2019" "" "" +.\" +.\" Man page written by Jesper Dangaard Brouer <brouer@redhat.com> based on a +.\" Man page written by Harald Welte <laforge@gnumonks.org> +.\" It is based on the iptables-restore man page. +.\" +.\" This program is free software; you can redistribute it and/or modify +.\" it under the terms of the GNU General Public License as published by +.\" the Free Software Foundation; either version 2 of the License, or +.\" (at your option) any later version. +.\" +.\" This program is distributed in the hope that it will be useful, +.\" but WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.\" GNU General Public License for more details. +.\" +.\" You should have received a copy of the GNU General Public License +.\" along with this program; if not, write to the Free Software +.\" Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. +.\" +.\" +.SH NAME +arptables-restore \- Restore ARP Tables (nft-based) +.SH SYNOPSIS +\fBarptables\-restore +.SH DESCRIPTION +.PP +.B arptables-restore +is used to restore ARP Tables from data specified on STDIN or +via a file as first argument. +Use I/O redirection provided by your shell to read from a file +.TP +.B arptables-restore +flushes (deletes) all previous contents of the respective ARP Table. +.SH AUTHOR +Jesper Dangaard Brouer <brouer@redhat.com> +.SH SEE ALSO +\fBarptables\-save\fP(8), \fBarptables\fP(8) +.PP diff --git a/upstream/opensuse-leap-15-6/man8/arptables-nft-save.8 b/upstream/opensuse-leap-15-6/man8/arptables-nft-save.8 new file mode 100644 index 00000000..905e5985 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/arptables-nft-save.8 @@ -0,0 +1,47 @@ +.TH ARPTABLES-SAVE 8 "March 2019" "" "" +.\" +.\" Man page written by Jesper Dangaard Brouer <brouer@redhat.com> based on a +.\" Man page written by Harald Welte <laforge@gnumonks.org> +.\" It is based on the iptables-save man page. +.\" +.\" This program is free software; you can redistribute it and/or modify +.\" it under the terms of the GNU General Public License as published by +.\" the Free Software Foundation; either version 2 of the License, or +.\" (at your option) any later version. +.\" +.\" This program is distributed in the hope that it will be useful, +.\" but WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.\" GNU General Public License for more details. +.\" +.\" You should have received a copy of the GNU General Public License +.\" along with this program; if not, write to the Free Software +.\" Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. +.\" +.\" +.SH NAME +arptables-save \- dump arptables rules to stdout (nft-based) +.SH SYNOPSIS +\fBarptables\-save\fP [\fB\-M\fP \fImodprobe\fP] [\fB\-c\fP] +.P +\fBarptables\-save\fP [\fB\-V\fP] +.SH DESCRIPTION +.PP +.B arptables-save +is used to dump the contents of an ARP Table in easily parseable format +to STDOUT. Use I/O-redirection provided by your shell to write to a file. +.TP +\fB\-M\fR, \fB\-\-modprobe\fR \fImodprobe_program\fP +Specify the path to the modprobe program. By default, arptables-save will +inspect /proc/sys/kernel/modprobe to determine the executable's path. +.TP +\fB\-c\fR, \fB\-\-counters\fR +Include the current values of all packet and byte counters in the output. +.TP +\fB\-V\fR, \fB\-\-version\fR +Print version information and exit. +.SH AUTHOR +Jesper Dangaard Brouer <brouer@redhat.com> +.SH SEE ALSO +\fBarptables\-restore\fP(8), \fBarptables\fP(8) +.PP diff --git a/upstream/opensuse-leap-15-6/man8/arptables-nft.8 b/upstream/opensuse-leap-15-6/man8/arptables-nft.8 new file mode 100644 index 00000000..ea31e084 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/arptables-nft.8 @@ -0,0 +1,348 @@ +.TH ARPTABLES 8 "March 2019" +.\" +.\" Man page originally written by Jochen Friedrich <jochen@scram.de>, +.\" maintained by Bart De Schuymer. +.\" It is based on the iptables man page. +.\" +.\" Iptables page by Herve Eychenne March 2000. +.\" +.\" This program is free software; you can redistribute it and/or modify +.\" it under the terms of the GNU General Public License as published by +.\" the Free Software Foundation; either version 2 of the License, or +.\" (at your option) any later version. +.\" +.\" This program is distributed in the hope that it will be useful, +.\" but WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.\" GNU General Public License for more details. +.\" +.\" You should have received a copy of the GNU General Public License +.\" along with this program; if not, write to the Free Software +.\" Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. +.\" +.\" +.SH NAME +arptables \- ARP table administration (nft-based) +.SH SYNOPSIS +.BR "arptables " [ "-t table" ] " -" [ AD ] " chain rule-specification " [ options ] +.br +.BR "arptables " [ "-t table" ] " -" [ RI ] " chain rulenum rule-specification " [ options ] +.br +.BR "arptables " [ "-t table" ] " -D chain rulenum " [ options ] +.br +.BR "arptables " [ "-t table" ] " -" [ "LFZ" ] " " [ chain ] " " [ options ] +.br +.BR "arptables " [ "-t table" ] " -" [ "NX" ] " chain" +.br +.BR "arptables " [ "-t table" ] " -E old-chain-name new-chain-name" +.br +.BR "arptables " [ "-t table" ] " -P chain target " [ options ] + +.SH DESCRIPTION +.B arptables +is a user space tool, it is used to set up and maintain the +tables of ARP rules in the Linux kernel. These rules inspect +the ARP frames which they see. +.B arptables +is analogous to the +.B iptables +user space tool, but +.B arptables +is less complicated. + +.SS CHAINS +The kernel table is used to divide functionality into +different sets of rules. Each set of rules is called a chain. +Each chain is an ordered list of rules that can match ARP frames. If a +rule matches an ARP frame, then a processing specification tells +what to do with that matching frame. The processing specification is +called a 'target'. However, if the frame does not match the current +rule in the chain, then the next rule in the chain is examined and so forth. +The user can create new (user-defined) chains which can be used as the 'target' of a rule. + +.SS TARGETS +A firewall rule specifies criteria for an ARP frame and a frame +processing specification called a target. When a frame matches a rule, +then the next action performed by the kernel is specified by the target. +The target can be one of these values: +.IR ACCEPT , +.IR DROP , +.IR CONTINUE , +.IR RETURN , +an 'extension' (see below) or a user-defined chain. +.PP +.I ACCEPT +means to let the frame through. +.I DROP +means the frame has to be dropped. +.I CONTINUE +means the next rule has to be checked. This can be handy to know how many +frames pass a certain point in the chain or to log those frames. +.I RETURN +means stop traversing this chain and resume at the next rule in the +previous (calling) chain. +For the extension targets please see the +.B "TARGET EXTENSIONS" +section of this man page. +.SS TABLES +There is only one ARP table in the Linux +kernel. The table is +.BR filter. +You can drop the '-t filter' argument to the arptables command. +The -t argument must be the +first argument on the arptables command line, if used. +.TP +.B "-t, --table" +.br +.BR filter , +is the only table and contains two built-in chains: +.B INPUT +(for frames destined for the host) and +.B OUTPUT +(for locally-generated frames). +.br +.br +.SH ARPTABLES COMMAND LINE ARGUMENTS +After the initial arptables command line argument, the remaining +arguments can be divided into several different groups. These groups +are commands, miscellaneous commands, rule-specifications, match-extensions, +and watcher-extensions. +.SS COMMANDS +The arptables command arguments specify the actions to perform on the table +defined with the -t argument. If you do not use the -t argument to name +a table, the commands apply to the default filter table. +With the exception of the +.B "-Z" +command, only one command may be used on the command line at a time. +.TP +.B "-A, --append" +Append a rule to the end of the selected chain. +.TP +.B "-D, --delete" +Delete the specified rule from the selected chain. There are two ways to +use this command. The first is by specifying an interval of rule numbers +to delete, syntax: start_nr[:end_nr]. Using negative numbers is allowed, for more +details about using negative numbers, see the -I command. The second usage is by +specifying the complete rule as it would have been specified when it was added. +.TP +.B "-I, --insert" +Insert the specified rule into the selected chain at the specified rule number. +If the current number of rules equals N, then the specified number can be +between -N and N+1. For a positive number i, it holds that i and i-N-1 specify the +same place in the chain where the rule should be inserted. The number 0 specifies +the place past the last rule in the chain and using this number is therefore +equivalent with using the -A command. +.TP +.B "-R, --replace" +Replaces the specified rule into the selected chain at the specified rule number. +If the current number of rules equals N, then the specified number can be +between 1 and N. i specifies the place in the chain where the rule should be replaced. +.TP +.B "-P, --policy" +Set the policy for the chain to the given target. The policy can be +.BR ACCEPT ", " DROP " or " RETURN . +.TP +.B "-F, --flush" +Flush the selected chain. If no chain is selected, then every chain will be +flushed. Flushing the chain does not change the policy of the +chain, however. +.TP +.B "-Z, --zero" +Set the counters of the selected chain to zero. If no chain is selected, all the counters +are set to zero. The +.B "-Z" +command can be used in conjunction with the +.B "-L" +command. +When both the +.B "-Z" +and +.B "-L" +commands are used together in this way, the rule counters are printed on the screen +before they are set to zero. +.TP +.B "-L, --list" +List all rules in the selected chain. If no chain is selected, all chains +are listed. +.TP +.B "-N, --new-chain" +Create a new user-defined chain with the given name. The number of +user-defined chains is unlimited. A user-defined chain name has maximum +length of 31 characters. +.TP +.B "-X, --delete-chain" +Delete the specified user-defined chain. There must be no remaining references +to the specified chain, otherwise +.B arptables +will refuse to delete it. If no chain is specified, all user-defined +chains that aren't referenced will be removed. +.TP +.B "-E, --rename-chain" +Rename the specified chain to a new name. Besides renaming a user-defined +chain, you may rename a standard chain name to a name that suits your +taste. For example, if you like PREBRIDGING more than PREROUTING, +then you can use the -E command to rename the PREROUTING chain. If you do +rename one of the standard +.B arptables +chain names, please be sure to mention +this fact should you post a question on the +.B arptables +mailing lists. +It would be wise to use the standard name in your post. Renaming a standard +.B arptables +chain in this fashion has no effect on the structure or function +of the +.B arptables +kernel table. + +.SS MISCELLANOUS COMMANDS +.TP +.B "-V, --version" +Show the version of the arptables userspace program. +.TP +.B "-h, --help" +Give a brief description of the command syntax. +.TP +.BR "-j, --jump " "\fItarget\fP" +The target of the rule. This is one of the following values: +.BR ACCEPT , +.BR DROP , +.BR CONTINUE , +.BR RETURN , +a target extension (see +.BR "TARGET EXTENSIONS" ")" +or a user-defined chain name. +.TP +.BI "-c, --set-counters " "PKTS BYTES" +This enables the administrator to initialize the packet and byte +counters of a rule (during +.B INSERT, +.B APPEND, +.B REPLACE +operations). + +.SS RULE-SPECIFICATIONS +The following command line arguments make up a rule specification (as used +in the add and delete commands). A "!" option before the specification +inverts the test for that specification. Apart from these standard rule +specifications there are some other command line arguments of interest. +.TP +.BR "-s, --source-ip " "[!] \fIaddress\fP[/\fImask]\fP" +The Source IP specification. +.TP +.BR "-d, --destination-ip " "[!] \fIaddress\fP[/\fImask]\fP" +The Destination IP specification. +.TP +.BR "--source-mac " "[!] \fIaddress\fP[/\fImask\fP]" +The source mac address. Both mask and address are written as 6 hexadecimal +numbers separated by colons. +.TP +.BR "--destination-mac " "[!] \fIaddress\fP[/\fImask\fP]" +The destination mac address. Both mask and address are written as 6 hexadecimal +numbers separated by colons. +.TP +.BR "-i, --in-interface " "[!] \fIname\fP" +The interface via which a frame is received (for the +.B INPUT +chain). The flag +.B --in-if +is an alias for this option. +.TP +.BR "-o, --out-interface " "[!] \fIname\fP" +The interface via which a frame is going to be sent (for the +.B OUTPUT +chain). The flag +.B --out-if +is an alias for this option. +.TP +.BR "-l, --h-length " "\fIlength\fP[/\fImask\fP]" +The hardware length (nr of bytes) +.TP +.BR "--opcode " "\fIcode\fP[/\fImask\fP] +The operation code (2 bytes). Available values are: +.BR 1 = Request +.BR 2 = Reply +.BR 3 = Request_Reverse +.BR 4 = Reply_Reverse +.BR 5 = DRARP_Request +.BR 6 = DRARP_Reply +.BR 7 = DRARP_Error +.BR 8 = InARP_Request +.BR 9 = ARP_NAK . +.TP +.BR "--h-type " "\fItype\fP[/\fImask\fP]" +The hardware type (2 bytes, hexadecimal). Available values are: +.BR 1 = Ethernet . +.TP +.BR "--proto-type " "\fItype\fP[/\fImask\fP]" +The protocol type (2 bytes). Available values are: +.BR 0x800 = IPv4 . + +.SS TARGET-EXTENSIONS +.B arptables +extensions are precompiled into the userspace tool. So there is no need +to explicitly load them with a -m option like in +.BR iptables . +However, these +extensions deal with functionality supported by supplemental kernel modules. +.SS mangle +.TP +.BR "--mangle-ip-s IP address" +Mangles Source IP Address to given value. +.TP +.BR "--mangle-ip-d IP address" +Mangles Destination IP Address to given value. +.TP +.BR "--mangle-mac-s MAC address" +Mangles Source MAC Address to given value. +.TP +.BR "--mangle-mac-d MAC address" +Mangles Destination MAC Address to given value. +.TP +.BR "--mangle-target target " +Target of ARP mangle operation +.BR "" ( DROP ", " CONTINUE " or " ACCEPT " -- default is " ACCEPT ). +.SS CLASSIFY +This module allows you to set the skb->priority value (and thus clas- +sify the packet into a specific CBQ class). + +.TP +.BR "--set-class major:minor" + +Set the major and minor class value. The values are always +interpreted as hexadecimal even if no 0x prefix is given. + +.SS MARK +This module allows you to set the skb->mark value (and thus classify +the packet by the mark in u32) + +.TP +.BR "--set-mark mark" +Set the mark value. The values are always +interpreted as hexadecimal even if no 0x prefix is given + +.TP +.BR "--and-mark mark" +Binary AND the mark with bits. + +.TP +.BR "--or-mark mark" +Binary OR the mark with bits. + +.SH NOTES +In this nft-based version of +.BR arptables , +support for +.B FORWARD +chain has not been implemented. Since ARP packets are "forwarded" only by Linux +bridges, the same may be achieved using +.B FORWARD +chain in +.BR ebtables . + +.SH MAILINGLISTS +.BR "" "See " http://netfilter.org/mailinglists.html +.SH SEE ALSO +.BR xtables-nft "(8), " iptables "(8), " ebtables "(8), " ip (8) +.PP +.BR "" "See " https://wiki.nftables.org diff --git a/upstream/opensuse-leap-15-6/man8/atd.8 b/upstream/opensuse-leap-15-6/man8/atd.8 new file mode 100644 index 00000000..1f561185 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/atd.8 @@ -0,0 +1,79 @@ +.TH ATD 8 2009-11-14 +.SH NAME +atd \- run jobs queued for later execution +.SH SYNOPSIS +.B atd +.RB [ \-l +.IR load_avg ] +.RB [ \-b +.IR batch_interval ] +.RB [ \-d ] +.RB [ \-f ] +.RB [ \-s ] +.SH DESCRIPTION +.B atd +runs jobs queued by +.BR at (1) . +.PP +.SH OPTIONS +.TP 8 +.B \-l +Specifies a limiting load factor, over which batch jobs should +not be run, instead of the compile-time choice of 0.8. +This number is multiplied by the amount of CPUs when comparing +to /proc/loadavg, because loadavg is a sum over all processors on Linux. +.TP 8 +.B \-b +Specify the minimum interval in seconds between the start of two +batch jobs (60 default). +.TP 8 +.B \-d +Debug; print error messages to standard error instead of using +.BR syslog (3) . +This option also implies +.BR \-f . +.TP +.B \-f +Run +.BR atd +in the foreground. +.TP 8 +.B \-s +Process the at/batch queue only once. +This is primarily of use for compatibility with old versions of +.BR at ; +.B "atd \-s" +is equivalent to the old +.B atrun +command. +.SH WARNING +.B atd +won't work if its spool directory is mounted via NFS even if +.I no_root_squash +is set. +.SH FILES +.I /var/spool/atjobs +The directory for storing jobs; this should be mode 700, owner +at. +.PP +.I /var/spool/atspool +The directory for storing output; this should be mode 700, owner +at. +.PP +.IR /etc/at.allow , +.I /etc/at.deny +determine who can use the +.B at +system. +.SH "SEE ALSO" +.BR at (1), +.BR at.deny (5), +.BR at.allow (5), +.BR cron (8), +.BR crontab (1), +.BR syslog (3). +.SH BUGS +The functionality of +.B atd +should be merged into +.BR cron (8) . diff --git a/upstream/opensuse-leap-15-6/man8/atrun.8 b/upstream/opensuse-leap-15-6/man8/atrun.8 new file mode 100644 index 00000000..aade47d8 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/atrun.8 @@ -0,0 +1,23 @@ +.TH ATRUN 8 "Nov 1996" local "Linux Programmer's Manual" +.SH NAME +atrun \- run jobs queued for later execution +.SH SYNOPSIS +.B atrun +.RB [ -l +.IR load_avg ] +.RB [ -d ] +.SH DESCRIPTION +.B atrun +runs jobs queued by +.BR at(1) . +It is a shell script invoking +.B /usr/sbin/atd +with the +.I -s +option, and is provided for backward compatibility with older +installations. +.SH SEE ALSO +.BR at (1), +.BR atd (8). +.SH AUTHOR +At was mostly written by Thomas Koenig. diff --git a/upstream/opensuse-leap-15-6/man8/badblocks.8 b/upstream/opensuse-leap-15-6/man8/badblocks.8 new file mode 100644 index 00000000..0b0d8644 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/badblocks.8 @@ -0,0 +1,234 @@ +.\" -*- nroff -*- +.TH BADBLOCKS 8 "February 2023" "E2fsprogs version 1.47.0" +.SH NAME +badblocks \- search a device for bad blocks +.SH SYNOPSIS +.B badblocks +[ +.B \-svwnfBX +] +[ +.B \-b +.I block_size +] +[ +.B \-c +.I blocks_at_once +] +[ +.B \-d +.I read_delay_factor +] +[ +.B \-e +.I max_bad_blocks +] +[ +.B \-i +.I input_file +] +[ +.B \-o +.I output_file +] +[ +.B \-p +.I num_passes +] +[ +.B \-t +.I test_pattern +] +.I device +[ +.I last_block +] [ +.I first_block +] +.SH DESCRIPTION +.B badblocks +is used to search for bad blocks on a device (usually a disk partition). +.I device +is the special file corresponding to the device (e.g +.IR /dev/hdc1 ). +.I last_block +is the last block to be checked; if it is not specified, the last block +on the device is used as a default. +.I first_block +is an optional parameter specifying the starting block number +for the test, which allows the testing to start in the middle of the +disk. If it is not specified the first block on the disk is used as a default. +.PP +.B Important note: +If the output of +.B badblocks +is going to be fed to the +.B e2fsck +or +.B mke2fs +programs, it is important that the block size is properly specified, +since the block numbers which are generated are very dependent on the +block size in use by the file system. +For this reason, it is strongly recommended that +users +.B not +run +.B badblocks +directly, but rather use the +.B \-c +option of the +.B e2fsck +and +.B mke2fs +programs. +.SH OPTIONS +.TP +.BI \-b " block_size" +Specify the size of blocks in bytes. The default is 1024. +.TP +.BI \-c " number of blocks" +is the number of blocks which are tested at a time. The default is 64. +.TP +.BI \-d " read delay factor" +This parameter, if passed and non-zero, will cause bad blocks to sleep +between reads if there were no errors encountered in the read +operation; the delay will be calculated as a percentage of the time it +took for the read operation to be performed. In other words, a value of +100 will cause each read to be delayed by the amount the previous read +took, and a value of 200 by twice the amount. +.TP +.BI \-e " max bad block count" +Specify a maximum number of bad blocks before aborting the test. The +default is 0, meaning the test will continue until the end of the test +range is reached. +.TP +.B \-f +Normally, badblocks will refuse to do a read/write or a non-destructive +test on a device which is mounted, since either can cause the system to +potentially crash and/or damage the file system even if it is mounted +read-only. This can be overridden using the +.B \-f +flag, but should almost never be used --- if you think you're smarter +than the +.B badblocks +program, you almost certainly aren't. The only time when this option +might be safe to use is if the /etc/mtab file is incorrect, and the device +really isn't mounted. +.TP +.BI \-i " input_file" +Read a list of already existing known bad blocks. +.B Badblocks +will skip testing these blocks since they are known to be bad. If +.I input_file +is specified as "-", the list will be read from the standard input. +Blocks listed in this list will be omitted from the list of +.I new +bad blocks produced on the standard output or in the output file. +The +.B \-b +option of +.BR dumpe2fs (8) +can be used to retrieve the list of blocks currently marked bad on +an existing file system, in a format suitable for use with this option. +.TP +.B \-n +Use non-destructive read-write mode. By default only a non-destructive +read-only test is done. This option must not be combined with the +.B \-w +option, as they are mutually exclusive. +.TP +.BI \-o " output_file" +Write the list of bad blocks to the specified file. Without this option, +.B badblocks +displays the list on its standard output. The format of this file is suitable +for use by the +. +.B \-l +option in +.BR e2fsck (8) +or +.BR mke2fs (8). +.TP +.BI \-p " num_passes" +Repeat scanning the disk until there are no new blocks discovered in +num_passes consecutive scans of the disk. +Default is 0, meaning +.B badblocks +will exit after the first pass. +.TP +.B \-s +Show the progress of the scan by writing out rough percentage completion +of the current badblocks pass over the disk. Note that badblocks may do +multiple test passes over the disk, in particular if the +.B \-p +or +.B \-w +option is requested by the user. +.TP +.BI \-t " test_pattern" +Specify a test pattern to be read (and written) to disk blocks. The +.I test_pattern +may either be a numeric value between 0 and ULONG_MAX-1 inclusive, or the word +"random", which specifies that the block should be filled with a random +bit pattern. +For read/write (\fB-w\fR) and non-destructive (\fB-n\fR) modes, +one or more test patterns may be specified by specifying the +.B -t +option for each test pattern desired. For +read-only mode only a single pattern may be specified and it may not be +"random". Read-only testing with a pattern assumes that the +specified pattern has previously been written to the disk - if not, large +numbers of blocks will fail verification. +If multiple patterns +are specified then all blocks will be tested with one pattern +before proceeding to the next pattern. +.TP +.B \-v +Verbose mode. Will write the number of read errors, write errors and data- +corruptions to stderr. +.TP +.B \-w +Use write-mode test. With this option, +.B badblocks +scans for bad blocks by writing some patterns (0xaa, 0x55, 0xff, 0x00) on +every block of the device, reading every block and comparing the contents. +This option may not be combined with the +.B \-n +option, as they are mutually exclusive. +.TP +.B \-B +Use buffered I/O and do not use Direct I/O, even if it is available. +.TP +.B \-X +Internal flag only to be used by +.BR e2fsck (8) +and +.BR mke2fs (8). +It bypasses the exclusive mode in-use device safety check. +.SH WARNING +Never use the +.B \-w +option on a device containing an existing file system. +This option erases data! If you want to do write-mode testing on +an existing file system, use the +.B \-n +option instead. It is slower, but it will preserve your data. +.PP +The +.B \-e +option will cause badblocks to output a possibly incomplete list of +bad blocks. Therefore it is recommended to use it only when one wants +to know if there are any bad blocks at all on the device, and not when +the list of bad blocks is wanted. +.SH AUTHOR +.B badblocks +was written by Remy Card <Remy.Card@linux.org>. Current maintainer is +Theodore Ts'o <tytso@alum.mit.edu>. Non-destructive read/write test +implemented by David Beattie <dbeattie@softhome.net>. +.SH AVAILABILITY +.B badblocks +is part of the e2fsprogs package and is available from +http://e2fsprogs.sourceforge.net. +.SH SEE ALSO +.BR e2fsck (8), +.BR mke2fs (8) diff --git a/upstream/opensuse-leap-15-6/man8/blkdiscard.8 b/upstream/opensuse-leap-15-6/man8/blkdiscard.8 new file mode 100644 index 00000000..a8048510 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/blkdiscard.8 @@ -0,0 +1,105 @@ +'\" t +.\" Title: blkdiscard +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "BLKDISCARD" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +blkdiscard \- discard sectors on a device +.SH "SYNOPSIS" +.sp +\fBblkdiscard\fP [options] [\fB\-o\fP \fIoffset\fP] [\fB\-l\fP \fIlength\fP] \fIdevice\fP +.SH "DESCRIPTION" +.sp +\fBblkdiscard\fP is used to discard device sectors. This is useful for solid\-state drivers (SSDs) and thinly\-provisioned storage. Unlike \fBfstrim\fP(8), this command is used directly on the block device. +.sp +By default, \fBblkdiscard\fP will discard all blocks on the device. Options may be used to modify this behavior based on range or size, as explained below. +.sp +The \fIdevice\fP argument is the pathname of the block device. +.sp +\fBWARNING: All data in the discarded region on the device will be lost!\fP +.SH "OPTIONS" +.sp +The \fIoffset\fP and \fIlength\fP arguments may be followed by the multiplicative suffixes KiB (=1024), MiB (=1024*1024), and so on for GiB, TiB, PiB, EiB, ZiB and YiB (the "iB" is optional, e.g., "K" has the same meaning as "KiB") or the suffixes KB (=1000), MB (=1000*1000), and so on for GB, TB, PB, EB, ZB and YB. +.sp +\fB\-f\fP, \fB\-\-force\fP +.RS 4 +Disable all checking. Since v2.36 the block device is open in exclusive mode (O_EXCL) by default to avoid collision with mounted filesystem or another kernel subsystem. The \fB\-\-force\fP option disables the exclusive access mode. +.RE +.sp +\fB\-o\fP, \fB\-\-offset\fP \fIoffset\fP +.RS 4 +Byte offset into the device from which to start discarding. The provided value must be aligned to the device sector size. The default value is zero. +.RE +.sp +\fB\-l\fP, \fB\-\-length\fP \fIlength\fP +.RS 4 +The number of bytes to discard (counting from the starting point). The provided value must be aligned to the device sector size. If the specified value extends past the end of the device, \fBblkdiscard\fP will stop at the device size boundary. The default value extends to the end of the device. +.RE +.sp +\fB\-p\fP, \fB\-\-step\fP \fIlength\fP +.RS 4 +The number of bytes to discard within one iteration. The default is to discard all by one ioctl call. +.RE +.sp +\fB\-s\fP, \fB\-\-secure\fP +.RS 4 +Perform a secure discard. A secure discard is the same as a regular discard except that all copies of the discarded blocks that were possibly created by garbage collection must also be erased. This requires support from the device. +.RE +.sp +\fB\-z\fP, \fB\-\-zeroout\fP +.RS 4 +Zero\-fill rather than discard. +.RE +.sp +\fB\-v\fP, \fB\-\-verbose\fP +.RS 4 +Display the aligned values of \fIoffset\fP and \fIlength\fP. If the \fB\-\-step\fP option is specified, it prints the discard progress every second. +.RE +.sp +\fB\-V\fP, \fB\-\-version\fP +.RS 4 +Display version information and exit. +.RE +.sp +\fB\-h\fP, \fB\-\-help\fP +.RS 4 +Display help text and exit. +.RE +.SH "AUTHORS" +.sp +.MTO "lczerner\(atredhat.com" "Lukas Czerner" "" +.SH "SEE ALSO" +.sp +\fBfstrim\fP(8) +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBblkdiscard\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/blkid.8 b/upstream/opensuse-leap-15-6/man8/blkid.8 new file mode 100644 index 00000000..c42992a2 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/blkid.8 @@ -0,0 +1,270 @@ +'\" t +.\" Title: blkid +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "BLKID" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +blkid \- locate/print block device attributes +.SH "SYNOPSIS" +.sp +\fBblkid\fP \fB\-\-label\fP \fIlabel\fP | \fB\-\-uuid\fP \fIuuid\fP +.sp +\fBblkid\fP [\fB\-\-no\-encoding\fP \fB\-\-garbage\-collect\fP \fB\-\-list\-one\fP \fB\-\-cache\-file\fP \fIfile\fP] [\fB\-\-output\fP \fIformat\fP] [\fB\-\-match\-tag\fP \fItag\fP] [\fB\-\-match\-token\fP \fINAME=value\fP] [\fIdevice\fP...] +.sp +\fBblkid\fP \fB\-\-probe\fP [\fB\-\-offset\fP \fIoffset\fP] [\fB\-\-output\fP \fIformat\fP] [\fB\-\-size\fP \fIsize\fP] [\fB\-\-match\-tag\fP \fItag\fP] [\fB\-\-match\-types\fP \fIlist\fP] [\fB\-\-usages\fP \fIlist\fP] [\fB\-\-no\-part\-details\fP] \fIdevice\fP... +.sp +\fBblkid\fP \fB\-\-info\fP [\fB\-\-output format\fP] [\fB\-\-match\-tag\fP \fItag\fP] \fIdevice\fP... +.SH "DESCRIPTION" +.sp +The \fBblkid\fP program is the command\-line interface to working with the \fBlibblkid\fP(3) library. It can determine the type of content (e.g., filesystem or swap) that a block device holds, and also the attributes (tokens, NAME=value pairs) from the content metadata (e.g., LABEL or UUID fields). +.sp +\fBIt is recommended to use\fP \fBlsblk\fP(8) \fBcommand to get information about block devices, or lsblk \-\-fs to get an overview of filesystems, or\fP \fBfindmnt\fP(8) \fBto search in already mounted filesystems.\fP +.RS 3 +.ll -.6i +.sp +\fBlsblk\fP(8) provides more information, better control on output formatting, easy to use in scripts and it does not require root permissions to get actual information. \fBblkid\fP reads information directly from devices and for non\-root users it returns cached unverified information. \fBblkid\fP is mostly designed for system services and to test \fBlibblkid\fP(3) functionality. +.br +.RE +.ll +.sp +When \fIdevice\fP is specified, tokens from only this device are displayed. It is possible to specify multiple \fIdevice\fP arguments on the command line. If none is given, all partitions or unpartitioned devices which appear in \fI/proc/partitions\fP are shown, if they are recognized. +.sp +\fBblkid\fP has two main forms of operation: either searching for a device with a specific NAME=value pair, or displaying NAME=value pairs for one or more specified devices. +.sp +For security reasons \fBblkid\fP silently ignores all devices where the probing result is ambivalent (multiple colliding filesystems are detected). The low\-level probing mode (\fB\-p\fP) provides more information and extra exit status in this case. It\(cqs recommended to use \fBwipefs\fP(8) to get a detailed overview and to erase obsolete stuff (magic strings) from the device. +.SH "OPTIONS" +.sp +The \fIsize\fP and \fIoffset\fP arguments may be followed by the multiplicative suffixes like KiB (=1024), MiB (=1024*1024), and so on for GiB, TiB, PiB, EiB, ZiB and YiB (the "iB" is optional, e.g., "K" has the same meaning as "KiB"), or the suffixes KB (=1000), MB (=1000*1000), and so on for GB, TB, PB, EB, ZB and YB. +.sp +\fB\-c\fP, \fB\-\-cache\-file\fP \fIcachefile\fP +.RS 4 +Read from \fIcachefile\fP instead of reading from the default cache file (see the CONFIGURATION FILE section for more details). If you want to start with a clean cache (i.e., don\(cqt report devices previously scanned but not necessarily available at this time), specify \fI/dev/null\fP. +.RE +.sp +\fB\-d\fP, \fB\-\-no\-encoding\fP +.RS 4 +Don\(cqt encode non\-printing characters. The non\-printing characters are encoded by ^ and M\- notation by default. Note that the \fB\-\-output udev\fP output format uses a different encoding which cannot be disabled. +.RE +.sp +\fB\-D\fP, \fB\-\-no\-part\-details\fP +.RS 4 +Don\(cqt print information (PART_ENTRY_* tags) from partition table in low\-level probing mode. +.RE +.sp +\fB\-g\fP, \fB\-\-garbage\-collect\fP +.RS 4 +Perform a garbage collection pass on the blkid cache to remove devices which no longer exist. +.RE +.sp +\fB\-h\fP, \fB\-\-help\fP +.RS 4 +Display a usage message and exit. +.RE +.sp +\fB\-H\fP, \fB\-\-hint\fP \fIsetting\fP +.RS 4 +Set probing hint. The hints are optional way how to force probing functions to +check for example another location. The currently supported is +"session_offset=\fInumber\fP" to set session offset on multi\-session UDF. +.RE +.sp +\fB\-i\fP, \fB\-\-info\fP +.RS 4 +Display information about I/O Limits (aka I/O topology). The \(aqexport\(aq output format is automatically enabled. This option can be used together with the \fB\-\-probe\fP option. +.RE +.sp +\fB\-k\fP, \fB\-\-list\-filesystems\fP +.RS 4 +List all known filesystems and RAIDs and exit. +.RE +.sp +\fB\-l\fP, \fB\-\-list\-one\fP +.RS 4 +Look up only one device that matches the search parameter specified with the \fB\-\-match\-token\fP option. If there are multiple devices that match the specified search parameter, then the device with the highest priority is returned, and/or the first device found at a given priority (but see below note about udev). Device types in order of decreasing priority are: Device Mapper, EVMS, LVM, MD, and finally regular block devices. If this option is not specified, \fBblkid\fP will print all of the devices that match the search parameter. +.sp +This option forces \fBblkid\fP to use udev when used for LABEL or UUID tokens in \fB\-\-match\-token\fP. The goal is to provide output consistent with other utils (like \fBmount\fP(8), etc.) on systems where the same tag is used for multiple devices. +.RE +.sp +\fB\-L\fP, \fB\-\-label\fP \fIlabel\fP +.RS 4 +Look up the device that uses this filesystem \fIlabel\fP; this is equal to \fB\-\-list\-one \-\-output device \-\-match\-token LABEL=\fP\fIlabel\fP. This lookup method is able to reliably use /dev/disk/by\-label udev symlinks (dependent on a setting in \fI/etc/blkid.conf\fP). Avoid using the symlinks directly; it is not reliable to use the symlinks without verification. The \fB\-\-label\fP option works on systems with and without udev. +.sp +Unfortunately, the original \fBblkid\fP(8) from e2fsprogs uses the \fB\-L\fP option as a synonym for \fB\-o list\fP. For better portability, use \fB\-l \-o device \-t LABEL=\fP\fIlabel\fP and \fB\-o list\fP in your scripts rather than the \fB\-L\fP option. +.RE +.sp +\fB\-n\fP, \fB\-\-match\-types\fP \fIlist\fP +.RS 4 +Restrict the probing functions to the specified (comma\-separated) \fIlist\fP of superblock types (names). The list items may be prefixed with "no" to specify the types which should be ignored. For example: +.sp +\fBblkid \-\-probe \-\-match\-types vfat,ext3,ext4 /dev/sda1\fP +.sp +probes for vfat, ext3 and ext4 filesystems, and +.sp +\fBblkid \-\-probe \-\-match\-types nominix /dev/sda1\fP +.sp +probes for all supported formats except minix filesystems. This option is only useful together with \fB\-\-probe\fP. +.RE +.sp +\fB\-o\fP, \fB\-\-output\fP \fIformat\fP +.RS 4 +Use the specified output format. Note that the order of variables and devices is not fixed. See also option \fB\-s\fP. The \fIformat\fP parameter may be: +.sp +\fBfull\fP +.RS 4 +print all tags (the default) +.RE +.sp +\fBvalue\fP +.RS 4 +print the value of the tags +.RE +.sp +\fBlist\fP +.RS 4 +print the devices in a user\-friendly format; this output format is unsupported for low\-level probing (\fB\-\-probe\fP or \fB\-\-info\fP). +.sp +This output format is \fBDEPRECATED\fP in favour of the \fBlsblk\fP(8) command. +.RE +.sp +\fBdevice\fP +.RS 4 +print the device name only; this output format is always enabled for the \fB\-\-label\fP and \fB\-\-uuid\fP options +.RE +.sp +\fBudev\fP +.RS 4 +print key="value" pairs for easy import into the udev environment; the keys are prefixed by ID_FS_ or ID_PART_ prefixes. The value may be modified to be safe for udev environment; allowed is plain ASCII, hex\-escaping and valid UTF\-8, everything else (including whitespaces) is replaced with \(aq_\(aq. The keys with \fI_ENC\fP postfix use hex\-escaping for unsafe chars. +.sp +The udev output returns the ID_FS_AMBIVALENT tag if more superblocks are detected, and ID_PART_ENTRY_* tags are always returned for all partitions including empty partitions. +.sp +This output format is \fBDEPRECATED\fP. +.RE +.sp +\fBexport\fP +.RS 4 +print key=value pairs for easy import into the environment; this output format is automatically enabled when I/O Limits (\fB\-\-info\fP option) are requested. +.sp +The non\-printing characters are encoded by ^ and M\- notation and all potentially unsafe characters are escaped. +.RE +.RE +.sp +\fB\-O\fP, \fB\-\-offset\fP \fIoffset\fP +.RS 4 +Probe at the given \fIoffset\fP (only useful with \fB\-\-probe\fP). This option can be used together with the \fB\-\-info\fP option. +.RE +.sp +\fB\-p\fP, \fB\-\-probe\fP +.RS 4 +Switch to low\-level superblock probing mode (bypassing the cache). +.sp +Note that low\-level probing also returns information about partition table type (PTTYPE tag) and partitions (PART_ENTRY_* tags). The tag names produced by low\-level probing are based on names used internally by libblkid and it may be different than when executed without \fB\-\-probe\fP (for example PART_ENTRY_UUID= vs PARTUUID=). See also \fB\-\-no\-part\-details\fP. +.RE +.sp +\fB\-s\fP, \fB\-\-match\-tag\fP \fItag\fP +.RS 4 +For each (specified) device, show only the tags that match \fItag\fP. It is possible to specify multiple \fB\-\-match\-tag\fP options. If no tag is specified, then all tokens are shown for all (specified) devices. In order to just refresh the cache without showing any tokens, use \fB\-\-match\-tag none\fP with no other options. +.RE +.sp +\fB\-S\fP, \fB\-\-size\fP \fIsize\fP +.RS 4 +Override the size of device/file (only useful with \fB\-\-probe\fP). +.RE +.sp +\fB\-t\fP, \fB\-\-match\-token\fP \fINAME=value\fP +.RS 4 +Search for block devices with tokens named \fINAME\fP that have the value \fIvalue\fP, and display any devices which are found. Common values for \fINAME\fP include \fBTYPE\fP, \fBLABEL\fP, and \fBUUID\fP. If there are no devices specified on the command line, all block devices will be searched; otherwise only the specified devices are searched. +.RE +.sp +\fB\-u\fP, \fB\-\-usages\fP \fIlist\fP +.RS 4 +Restrict the probing functions to the specified (comma\-separated) \fIlist\fP of "usage" types. Supported usage types are: filesystem, raid, crypto and other. The list items may be prefixed with "no" to specify the usage types which should be ignored. For example: +.sp +\fBblkid \-\-probe \-\-usages filesystem,other /dev/sda1\fP +.sp +probes for all filesystem and other (e.g., swap) formats, and +.sp +\fBblkid \-\-probe \-\-usages noraid /dev/sda1\fP +.sp +probes for all supported formats except RAIDs. This option is only useful together with \fB\-\-probe\fP. +.RE +.sp +\fB\-U\fP, \fB\-\-uuid\fP \fIuuid\fP +.RS 4 +Look up the device that uses this filesystem \fIuuid\fP. For more details see the \fB\-\-label\fP option. +.RE +.sp +\fB\-V\fP, \fB\-\-version\fP +.RS 4 +Display version number and exit. +.RE +.SH "EXIT STATUS" +.sp +If the specified device or device addressed by specified token (option \fB\-\-match\-token\fP) was found and it\(cqs possible to gather any information about the device, an exit status 0 is returned. Note the option \fB\-\-match\-tag\fP filters output tags, but it does not affect exit status. +.sp +If the specified token was not found, or no (specified) devices could be identified, or it is impossible to gather any information about the device identifiers or device content an exit status of 2 is returned. +.sp +For usage or other errors, an exit status of 4 is returned. +.sp +If an ambivalent probing result was detected by low\-level probing mode (\fB\-p\fP), an exit status of 8 is returned. +.SH "CONFIGURATION FILE" +.sp +The standard location of the \fI/etc/blkid.conf\fP config file can be overridden by the environment variable BLKID_CONF. The following options control the libblkid library: +.sp +\fISEND_UEVENT=<yes|not>\fP +.RS 4 +Sends uevent when \fI/dev/disk/by\-{label,uuid,partuuid,partlabel}/\fP symlink does not match with LABEL, UUID, PARTUUID or PARTLABEL on the device. Default is "yes". +.RE +.sp +\fICACHE_FILE=<path>\fP +.RS 4 +Overrides the standard location of the cache file. This setting can be overridden by the environment variable \fBBLKID_FILE\fP. Default is \fI/run/blkid/blkid.tab\fP, or \fI/etc/blkid.tab\fP on systems without a \fI/run\fP directory. +.RE +.sp +\fIEVALUATE=<methods>\fP +.RS 4 +Defines LABEL and UUID evaluation method(s). Currently, the libblkid library supports the "udev" and "scan" methods. More than one method may be specified in a comma\-separated list. Default is "udev,scan". The "udev" method uses udev \fI/dev/disk/by\-*\fP symlinks and the "scan" method scans all block devices from the \fI/proc/partitions\fP file. +.RE +.SH "ENVIRONMENT" +.sp +Setting \fILIBBLKID_DEBUG=all\fP enables debug output. +.SH "AUTHORS" +.sp +\fBblkid\fP was written by Andreas Dilger for libblkid and improved by Theodore Ts\(cqo and Karel Zak. +.SH "SEE ALSO" +.sp +\fBlibblkid\fP(3), +\fBfindfs\fP(8), +\fBlsblk\fP(8), +\fBwipefs\fP(8) +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBblkid\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/blkmapd.8 b/upstream/opensuse-leap-15-6/man8/blkmapd.8 new file mode 100644 index 00000000..914b80f2 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/blkmapd.8 @@ -0,0 +1,57 @@ +.\" +.\" Copyright 2011, Jim Rees. +.\" +.\" You may distribute under the terms of the GNU General Public +.\" License as specified in the file COPYING that comes with the +.\" nfs-utils distribution. +.\" +.TH blkmapd 8 "11 August 2011" +.SH NAME +blkmapd \- pNFS block layout mapping daemon +.SH SYNOPSIS +.B "blkmapd [-h] [-d] [-f]" +.SH DESCRIPTION +The +.B blkmapd +daemon performs device discovery and mapping for the parallel NFS (pNFS) block layout +client [RFC5663]. +.PP +The pNFS block layout protocol builds a complex storage hierarchy from a set +of +.I simple volumes. +These simple volumes are addressed by content, using a signature on the +volume to uniquely name each one. +The daemon locates a volume by examining each block device in the system for +the given signature. +.PP +The topology typically consists of a hierarchy of volumes built by striping, +slicing, and concatenating the simple volumes. +The +.B blkmapd +daemon uses the device-mapper driver to construct logical devices that +reflect the server topology, and passes these devices to the kernel for use +by the pNFS block layout client. +.SH OPTIONS +.TP +.B -h +Display usage message. +.TP +.B -d +Performs device discovery only then exits. +.TP +.B -f +Runs +.B blkmapd +in the foreground and sends output to stderr (as opposed to syslogd) +.SH SEE ALSO +.BR nfs (5), +.BR dmsetup (8) +.sp +RFC 5661 for the NFS version 4.1 specification. +.br +RFC 5663 for the pNFS block layout specification. +.SH AUTHORS +.br +Haiying Tang <Tang_Haiying@emc.com> +.br +Jim Rees <rees@umich.edu> diff --git a/upstream/opensuse-leap-15-6/man8/blkzone.8 b/upstream/opensuse-leap-15-6/man8/blkzone.8 new file mode 100644 index 00000000..7bc0e56a --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/blkzone.8 @@ -0,0 +1,250 @@ +'\" t +.\" Title: blkzone +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "BLKZONE" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +blkzone \- run zone command on a device +.SH "SYNOPSIS" +.sp +\fBblkzone\fP \fIcommand\fP [options] \fIdevice\fP +.SH "DESCRIPTION" +.sp +\fBblkzone\fP is used to run zone command on device that support the Zoned Block Commands (ZBC) or Zoned\-device ATA Commands (ZAC). The zones to operate on can be specified using the offset, count and length options. +.sp +The \fIdevice\fP argument is the pathname of the block device. +.SH "COMMANDS" +.SS "report" +.sp +The command \fBblkzone report\fP is used to report device zone information. +.sp +By default, the command will report all zones from the start of the block device. Options may be used to modify this behavior, changing the starting zone or the size of the report, as explained below. +.sp +Report output: +.TS +allbox tab(:); +lt lt. +T{ +.sp +start +T}:T{ +.sp +Zone start sector +T} +T{ +.sp +len +T}:T{ +.sp +Zone length in number of sectors +T} +T{ +.sp +cap +T}:T{ +.sp +Zone capacity in number of sectors +T} +T{ +.sp +wptr +T}:T{ +.sp +Zone write pointer position +T} +T{ +.sp +reset +T}:T{ +.sp +Reset write pointer recommended +T} +T{ +.sp +non\-seq +T}:T{ +.sp +Non\-sequential write resources active +T} +T{ +.sp +cond +T}:T{ +.sp +Zone condition +T} +T{ +.sp +type +T}:T{ +.sp +Zone type +T} +.TE +.sp +.sp +Zone conditions: +.TS +allbox tab(:); +lt lt. +T{ +.sp +cl +T}:T{ +.sp +Closed +T} +T{ +.sp +nw +T}:T{ +.sp +Not write pointer +T} +T{ +.sp +em +T}:T{ +.sp +Empty +T} +T{ +.sp +fu +T}:T{ +.sp +Full +T} +T{ +.sp +oe +T}:T{ +.sp +Explicitly opened +T} +T{ +.sp +oi +T}:T{ +.sp +Implicitly opened +T} +T{ +.sp +ol +T}:T{ +.sp +Offline +T} +T{ +.sp +ro +T}:T{ +.sp +Read only +T} +T{ +.sp +x? +T}:T{ +.sp +Reserved conditions (should not be reported) +T} +.TE +.sp +.SS "capacity" +.sp +The command \fBblkzone capacity\fP is used to report device capacity information. +.sp +By default, the command will report the sum, in number of sectors, of all zone capacities on the device. Options may be used to modify this behavior, changing the starting zone or the size of the report, as explained below. +.SS "reset" +.sp +The command \fBblkzone reset\fP is used to reset one or more zones. Unlike \fBsg_reset_wp\fP(8), this command operates from the block layer and can reset a range of zones. +.SS "open" +.sp +The command \fBblkzone open\fP is used to explicitly open one or more zones. Unlike \fBsg_zone\fP(8), open action, this command operates from the block layer and can open a range of zones. +.SS "close" +.sp +The command \fBblkzone close\fP is used to close one or more zones. Unlike \fBsg_zone\fP(8), close action, this command operates from the block layer and can close a range of zones. +.SS "finish" +.sp +The command \fBblkzone finish\fP is used to finish (transition to full condition) one or more zones. Unlike \fBsg_zone\fP(8), finish action, this command operates from the block layer and can finish a range of zones. +.sp +By default, the reset, open, close and finish commands will operate from the zone at device sector 0 and operate on all zones. Options may be used to modify this behavior as explained below. +.SH "OPTIONS" +.sp +The \fIoffset\fP and \fIlength\fP option arguments may be followed by the multiplicative suffixes KiB (=1024), MiB (=1024*1024), and so on for GiB, TiB, PiB, EiB, ZiB and YiB (the "iB" is optional, e.g., "K" has the same meaning as "KiB") or the suffixes KB (=1000), MB (=1000*1000), and so on for GB, TB, PB, EB, ZB and YB. Additionally, the 0x prefix can be used to specify \fIoffset\fP and \fIlength\fP in hex. +.sp +\fB\-o\fP, \fB\-\-offset\fP \fIsector\fP +.RS 4 +The starting zone specified as a sector offset. The provided offset in sector units (512 bytes) should match the start of a zone. The default value is zero. +.RE +.sp +\fB\-l\fP, \fB\-\-length\fP \fIsectors\fP +.RS 4 +The maximum number of sectors the command should operate on. The default value is the number of sectors remaining after \fIoffset\fP. This option cannot be used together with the option \fB\-\-count\fP. +.RE +.sp +\fB\-c\fP, \fB\-\-count\fP \fIcount\fP +.RS 4 +The maximum number of zones the command should operate on. The default value is the number of zones starting from \fIoffset\fP. This option cannot be used together with the option \fB\-\-length\fP. +.RE +.sp +\fB\-f\fP, \fB\-\-force\fP +.RS 4 +Enforce commands to change zone status on block devices used by the system. +.RE +.sp +\fB\-v\fP, \fB\-\-verbose\fP +.RS 4 +Display the number of zones returned in the report or the range of sectors reset. +.RE +.sp +\fB\-V\fP, \fB\-\-version\fP +.RS 4 +Display version information and exit. +.RE +.sp +\fB\-h\fP, \fB\-\-help\fP +.RS 4 +Display help text and exit. +.RE +.SH "AUTHORS" +.sp +.MTO "shaun\(attancheff.com" "Shaun Tancheff" "," +.MTO "kzak\(atredhat.com" "Karel Zak" "" +.SH "SEE ALSO" +.sp +\fBsg_rep_zones\fP(8) +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBblkzone\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/blockdev.8 b/upstream/opensuse-leap-15-6/man8/blockdev.8 new file mode 100644 index 00000000..bbaf1959 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/blockdev.8 @@ -0,0 +1,186 @@ +'\" t +.\" Title: blockdev +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "BLOCKDEV" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +blockdev \- call block device ioctls from the command line +.SH "SYNOPSIS" +.sp +\fBblockdev\fP [\fB\-q\fP] [\fB\-v\fP] \fIcommand\fP [\fIcommand\fP...] \fIdevice\fP [\fIdevice\fP...] +.sp +\fBblockdev\fP \fB\-\-report\fP [\fIdevice\fP...] +.sp +\fBblockdev\fP \fB\-h\fP|\fB\-V\fP +.SH "DESCRIPTION" +.sp +The utility \fBblockdev\fP allows one to call block device ioctls from the command line. +.SH "OPTIONS" +.sp +\fB\-q\fP +.RS 4 +Be quiet. +.RE +.sp +\fB\-v\fP +.RS 4 +Be verbose. +.RE +.sp +\fB\-\-report\fP +.RS 4 +Print a report for the specified device. It is possible to give multiple devices. If none is given, all devices which appear in \fI/proc/partitions\fP are shown. Note that the partition StartSec is in 512\-byte sectors. +.RE +.sp +\fB\-h\fP, \fB\-\-help\fP +.RS 4 +Display help text and exit. +.RE +.sp +\fB\-V\fP, \fB\-\-version\fP +.RS 4 +Print version and exit. +.RE +.SH "COMMANDS" +.sp +It is possible to give multiple devices and multiple commands. +.sp +\fB\-\-flushbufs\fP +.RS 4 +Flush buffers. +.RE +.sp +\fB\-\-getalignoff\fP +.RS 4 +Get alignment offset. +.RE +.sp +\fB\-\-getbsz\fP +.RS 4 +Print the blocksize in bytes. This size does not describe device topology. It\(cqs the size used internally by the kernel and it may be modified (for example) by filesystem driver on mount. +.RE +.sp +\fB\-\-getdiscardzeroes\fP +.RS 4 +Get discard zeroes support status. +.RE +.sp +\fB\-\-getfra\fP +.RS 4 +Get filesystem readahead in 512\-byte sectors. +.RE +.sp +\fB\-\-getiomin\fP +.RS 4 +Get minimum I/O size. +.RE +.sp +\fB\-\-getioopt\fP +.RS 4 +Get optimal I/O size. +.RE +.sp +\fB\-\-getmaxsect\fP +.RS 4 +Get max sectors per request. +.RE +.sp +\fB\-\-getpbsz\fP +.RS 4 +Get physical block (sector) size. +.RE +.sp +\fB\-\-getra\fP +.RS 4 +Print readahead (in 512\-byte sectors). +.RE +.sp +\fB\-\-getro\fP +.RS 4 +Get read\-only. Print 1 if the device is read\-only, 0 otherwise. +.RE +.sp +\fB\-\-getsize64\fP +.RS 4 +Print device size in bytes. +.RE +.sp +\fB\-\-getsize\fP +.RS 4 +Print device size (32\-bit!) in sectors. Deprecated in favor of the \fB\-\-getsz\fP option. +.RE +.sp +\fB\-\-getss\fP +.RS 4 +Print logical sector size in bytes \- usually 512. +.RE +.sp +\fB\-\-getsz\fP +.RS 4 +Get size in 512\-byte sectors. +.RE +.sp +\fB\-\-rereadpt\fP +.RS 4 +Reread partition table +.RE +.sp +\fB\-\-setbsz\fP \fIbytes\fP +.RS 4 +Set blocksize. Note that the block size is specific to the current file descriptor opening the block device, so the change of block size only persists for as long as \fBblockdev\fP has the device open, and is lost once \fBblockdev\fP exits. +.RE +.sp +\fB\-\-setfra\fP \fIsectors\fP +.RS 4 +Set filesystem readahead (same as \fB\-\-setra\fP on 2.6 kernels). +.RE +.sp +\fB\-\-setra\fP \fIsectors\fP +.RS 4 +Set readahead (in 512\-byte sectors). +.RE +.sp +\fB\-\-setro\fP +.RS 4 +Set read\-only. The currently active access to the device may not be affected by the change. For example, a filesystem already mounted in read\-write mode will not be affected. The change applies after remount. +.RE +.sp +\fB\-\-setrw\fP +.RS 4 +Set read\-write. +.RE +.SH "AUTHORS" +.sp +\fBblockdev\fP was written by Andries E. Brouwer and rewritten by Karel Zak. +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBblockdev\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/btrfs-balance.8 b/upstream/opensuse-leap-15-6/man8/btrfs-balance.8 new file mode 100644 index 00000000..40906670 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/btrfs-balance.8 @@ -0,0 +1,584 @@ +.\" Man page generated from reStructuredText. +. +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.TH "BTRFS-BALANCE" "8" "Sep 13, 2023" "6.5.1" "BTRFS" +.SH NAME +btrfs-balance \- balance block groups on a btrfs filesystem +.SH SYNOPSIS +.sp +\fBbtrfs balance\fP <subcommand> <args> +.SH DESCRIPTION +.sp +The primary purpose of the balance feature is to spread block groups across +all devices so they match constraints defined by the respective profiles. See +\fI\%mkfs.btrfs(8)\fP section \fI\%PROFILES\fP +for more details. +The scope of the balancing process can be further tuned by use of filters that +can select the block groups to process. Balance works only on a mounted +filesystem. Extent sharing is preserved and reflinks are not broken. +Files are not defragmented nor recompressed, file extents are preserved +but the physical location on devices will change. +.sp +The balance operation is cancellable by the user. The on\-disk state of the +filesystem is always consistent so an unexpected interruption (e.g. system crash, +reboot) does not corrupt the filesystem. The progress of the balance operation +is temporarily stored as an internal state and will be resumed upon mount, +unless the mount option \fIskip_balance\fP is specified. +.sp +\fBWARNING:\fP +.INDENT 0.0 +.INDENT 3.5 +Running balance without filters will take a lot of time as it basically move +data/metadata from the whole filesystem and needs to update all block +pointers. +.UNINDENT +.UNINDENT +.sp +The filters can be used to perform following actions: +.INDENT 0.0 +.IP \(bu 2 +convert block group profiles (filter \fIconvert\fP) +.IP \(bu 2 +make block group usage more compact (filter \fIusage\fP) +.IP \(bu 2 +perform actions only on a given device (filters \fIdevid\fP, \fIdrange\fP) +.UNINDENT +.sp +The filters can be applied to a combination of block group types (data, +metadata, system). Note that changing only the \fIsystem\fP type needs the force +option. Otherwise \fIsystem\fP gets automatically converted whenever \fImetadata\fP +profile is converted. +.sp +When metadata redundancy is reduced (e.g. from RAID1 to single) the force option +is also required and it is noted in system log. +.sp +\fBNOTE:\fP +.INDENT 0.0 +.INDENT 3.5 +The balance operation needs enough work space, i.e. space that is completely +unused in the filesystem, otherwise this may lead to ENOSPC reports. See +the section \fIENOSPC\fP for more details. +.UNINDENT +.UNINDENT +.SH COMPATIBILITY +.sp +\fBNOTE:\fP +.INDENT 0.0 +.INDENT 3.5 +The balance subcommand also exists under the \fBbtrfs filesystem\fP namespace. +This still works for backward compatibility but is deprecated and should not +be used any more. +.UNINDENT +.UNINDENT +.sp +\fBNOTE:\fP +.INDENT 0.0 +.INDENT 3.5 +A short syntax \fBbtrfs balance <path>\fP works due to backward compatibility +but is deprecated and should not be used any more. Use \fBbtrfs balance start\fP +command instead. +.UNINDENT +.UNINDENT +.SH PERFORMANCE IMPLICATIONS +.sp +Balancing operations are very IO intensive and can also be quite CPU intensive, +impacting other ongoing filesystem operations. Typically large amounts of data +are copied from one location to another, with corresponding metadata updates. +.sp +Depending upon the block group layout, it can also be seek heavy. Performance +on rotational devices is noticeably worse compared to SSDs or fast arrays. +.SH SUBCOMMAND +.INDENT 0.0 +.TP +.B cancel <path> +cancels a running or paused balance, the command will block and wait until the +current block group being processed completes +.sp +Since kernel 5.7 the response time of the cancellation is significantly +improved, on older kernels it might take a long time until currently +processed chunk is completely finished. +.TP +.B pause <path> +pause running balance operation, this will store the state of the balance +progress and used filters to the filesystem +.TP +.B resume <path> +resume interrupted balance, the balance status must be stored on the filesystem +from previous run, e.g. after it was paused or forcibly interrupted and mounted +again with \fIskip_balance\fP +.TP +.B start [options] <path> +start the balance operation according to the specified filters, without any filters +the data and metadata from the whole filesystem are moved. The process runs in +the foreground. +.sp +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +The balance command without filters will basically move everything in the +filesystem to a new physical location on devices (i.e. it does not affect the +logical properties of file extents like offsets within files and extent +sharing). The run time is potentially very long, depending on the filesystem +size. To prevent starting a full balance by accident, the user is warned and +has a few seconds to cancel the operation before it starts. The warning and +delay can be skipped with \fI\-\-full\-balance\fP option. +.UNINDENT +.UNINDENT +.sp +Please note that the filters must be written together with the \fI\-d\fP, \fI\-m\fP and +\fI\-s\fP options, because they\(aqre optional and bare \fI\-d\fP and \fI\-m\fP also work and +mean no filters. +.sp +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +When the target profile for conversion filter is \fIraid5\fP or \fIraid6\fP, +there\(aqs a safety timeout of 10 seconds to warn users about the status of the feature +.UNINDENT +.UNINDENT +.sp +\fBOptions\fP +.INDENT 7.0 +.TP +.B \-d[<filters>] +act on data block groups, see section \fI\%FILTERS\fP for details about \fIfilters\fP +.TP +.B \-m[<filters>] +act on metadata chunks, see \fI\%FILTERS\fP for details about \fIfilters\fP +.TP +.B \-s[<filters>] +act on system chunks (requires \fI\-f\fP), see \fI\%FILTERS\fP for details about \fIfilters\fP\&. +.UNINDENT +.INDENT 7.0 +.TP +.B \-f +force a reduction of metadata integrity, e.g. when going from \fIraid1\fP to +\fIsingle\fP, or skip safety timeout when the target conversion profile is \fIraid5\fP +or \fIraid6\fP +.UNINDENT +.INDENT 7.0 +.TP +.B \-\-background|\-\-bg +run the balance operation asynchronously in the background, uses \fBfork(2)\fP to +start the process that calls the kernel ioctl +.UNINDENT +.INDENT 7.0 +.TP +.B \-\-enqueue +wait if there\(aqs another exclusive operation running, otherwise continue +.TP +.B \-v +(deprecated) alias for global \(aq\-v\(aq option +.UNINDENT +.TP +.B status [\-v] <path> +Show status of running or paused balance. +.sp +\fBOptions\fP +.INDENT 7.0 +.TP +.B \-v +(deprecated) alias for global \fI\-v\fP option +.UNINDENT +.UNINDENT +.SH FILTERS +.sp +From kernel 3.3 onwards, BTRFS balance can limit its action to a subset of the +whole filesystem, and can be used to change the replication configuration (e.g. +convert data from \fBsingle\fP to \fBRAID1\fP). +.sp +Balance can be limited to a block group profile with the following options: +.INDENT 0.0 +.IP \(bu 2 +\fB\-d\fP for data block groups +.IP \(bu 2 +\fB\-m\fP for metadata block groups (also implicitly applies to \fI\-s\fP) +.IP \(bu 2 +\fB\-s\fP for system block groups +.UNINDENT +.sp +The options have an optional parameter which means that the parameter must start +right after the option without a space (this is mandatory getopt syntax), like +\fB\-dusage=10\fP\&. Options for all block group types can be specified in one command. +.sp +A filter has the following structure: \fBfilter[=params][,filter=...]\fP +.sp +To combine multiple filters use \fB,\fP, without spaces. Example: \fB\-dconvert=raid1,soft\fP +.sp +BTRFS can have different profiles on a single device or the same profile on +multiple device. +.sp +The main reason why you want to have different profiles for data and metadata +is to provide additional protection of the filesystem\(aqs metadata when devices fail, +since a single sector of unrecoverable metadata will break the filesystem, +while a single sector of lost data can be trivially recovered by deleting the broken file. +.sp +Before changing profiles, make sure there is enough unallocated space on +existing drives to create new metadata block groups (for filesystems +over 50GiB, this is \fB1GB * (number_of_devices + 2))\fP\&. +.sp +Default profiles on BTRFS are: +.INDENT 0.0 +.IP \(bu 2 +data: \fBsingle\fP +.IP \(bu 2 +.INDENT 2.0 +.TP +.B metadata: +.INDENT 7.0 +.IP \(bu 2 +single devices: \fBdup\fP +.IP \(bu 2 +multiple devices: \fBraid1\fP +.UNINDENT +.UNINDENT +.UNINDENT +.sp +The available filter types are: +.SS Filter types +.INDENT 0.0 +.TP +.B profiles=<profiles> +Balances only block groups with the given profiles. Parameters +are a list of profile names separated by \fB|\fP (pipe). +.TP +.B usage=<percent>, usage=<range> +Balances only block groups with usage under the given percentage. The +value of 0 is allowed and will clean up completely unused block groups, this +should not require any new work space allocated. You may want to use \fIusage=0\fP +in case balance is returning ENOSPC and your filesystem is not too full. +.sp +The argument may be a single value or a range. The single value \fBN\fP means \fIat +most N percent used\fP, equivalent to \fB\&..N\fP range syntax. Kernels prior to 4.4 +accept only the single value format. +The minimum range boundary is inclusive, maximum is exclusive. +.TP +.B devid=<id> +Balances only block groups which have at least one chunk on the given +device. To list devices with ids use \fBbtrfs filesystem show\fP\&. +.TP +.B drange=<range> +Balance only block groups which overlap with the given byte range on any +device. Use in conjunction with \fBdevid\fP to filter on a specific device. The +parameter is a range specified as \fBstart..end\fP\&. +.TP +.B vrange=<range> +Balance only block groups which overlap with the given byte range in the +filesystem\(aqs internal virtual address space. This is the address space that +most reports from btrfs in the kernel log use. The parameter is a range +specified as \fBstart..end\fP\&. +.TP +.B convert=<profile> +Convert each selected block group to the given profile name identified by +parameters. +.sp +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +Starting with kernel 4.5, the \fBdata\fP chunks can be converted to/from the +\fBDUP\fP profile on a single device. +.UNINDENT +.UNINDENT +.sp +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +Starting with kernel 4.6, all profiles can be converted to/from \fBDUP\fP on +multi\-device filesystems. +.UNINDENT +.UNINDENT +.TP +.B limit=<number>, limit=<range> +Process only given number of chunks, after all filters are applied. This can be +used to specifically target a chunk in connection with other filters (\fBdrange\fP, +\fBvrange\fP) or just simply limit the amount of work done by a single balance run. +.sp +The argument may be a single value or a range. The single value \fBN\fP means \fIat +most N chunks\fP, equivalent to \fB\&..N\fP range syntax. Kernels prior to 4.4 accept +only the single value format. The range minimum and maximum are inclusive. +.TP +.B stripes=<range> +Balance only block groups which have the given number of stripes. The parameter +is a range specified as \fBstart..end\fP\&. Makes sense for block group profiles that +utilize striping, i.e. RAID0/10/5/6. The range minimum and maximum are +inclusive. +.TP +.B soft +Takes no parameters. Only has meaning when converting between profiles, or +When doing convert from one profile to another and soft mode is on, +chunks that already have the target profile are left untouched. +This is useful e.g. when half of the filesystem was converted earlier but got +cancelled. +.sp +The soft mode switch is (like every other filter) per\-type. +For example, this means that we can convert metadata chunks the \(dqhard\(dq way +while converting data chunks selectively with soft switch. +.UNINDENT +.sp +Profile names, used in \fBprofiles\fP and \fBconvert\fP are one of: +.INDENT 0.0 +.IP \(bu 2 +\fBraid0\fP +.IP \(bu 2 +\fBraid1\fP +.IP \(bu 2 +\fBraid1c3\fP +.IP \(bu 2 +\fBraid1c4\fP +.IP \(bu 2 +\fBraid10\fP +.IP \(bu 2 +\fBraid5\fP +.IP \(bu 2 +\fBraid6\fP +.IP \(bu 2 +\fBdup\fP +.IP \(bu 2 +\fBsingle\fP +.UNINDENT +.sp +The mixed data/metadata profiles can be converted in the same way, but conversion +between mixed and non\-mixed is not implemented. For the constraints of the +profiles please refer to \fI\%mkfs.btrfs(8)\fP section +\fI\%PROFILES\fP\&. +.SH ENOSPC +.sp +The way balance operates, it usually needs to temporarily create a new block +group and move the old data there, before the old block group can be removed. +For that it needs the work space, otherwise it fails for ENOSPC reasons. +This is not the same ENOSPC as if the free space is exhausted. This refers to +the space on the level of block groups, which are bigger parts of the filesystem +that contain many file extents. +.sp +The free work space can be calculated from the output of the \fBbtrfs filesystem show\fP +command: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +Label: \(aqBTRFS\(aq uuid: 8a9d72cd\-ead3\-469d\-b371\-9c7203276265 + Total devices 2 FS bytes used 77.03GiB + devid 1 size 53.90GiB used 51.90GiB path /dev/sdc2 + devid 2 size 53.90GiB used 51.90GiB path /dev/sde1 +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +\fIsize\fP \- \fIused\fP = \fIfree work space\fP +.sp +\fI53.90GiB\fP \- \fI51.90GiB\fP = \fI2.00GiB\fP +.sp +An example of a filter that does not require workspace is \fIusage=0\fP\&. This will +scan through all unused block groups of a given type and will reclaim the +space. After that it might be possible to run other filters. +.sp +\fBCONVERSIONS ON MULTIPLE DEVICES\fP +.sp +Conversion to profiles based on striping (RAID0, RAID5/6) require the work +space on each device. An interrupted balance may leave partially filled block +groups that consume the work space. +.SH EXAMPLES +.sp +A more comprehensive example when going from one to multiple devices, and back, +can be found in section \fITYPICAL USECASES\fP of \fI\%btrfs\-device(8)\fP\&. +.SS MAKING BLOCK GROUP LAYOUT MORE COMPACT +.sp +The layout of block groups is not normally visible; most tools report only +summarized numbers of free or used space, but there are still some hints +provided. +.sp +Let\(aqs use the following real life example and start with the output: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +$ btrfs filesystem df /path +Data, single: total=75.81GiB, used=64.44GiB +System, RAID1: total=32.00MiB, used=20.00KiB +Metadata, RAID1: total=15.87GiB, used=8.84GiB +GlobalReserve, single: total=512.00MiB, used=0.00B +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Roughly calculating for data, \fI75G \- 64G = 11G\fP, the used/total ratio is +about \fI85%\fP\&. How can we can interpret that: +.INDENT 0.0 +.IP \(bu 2 +chunks are filled by 85% on average, i.e. the \fIusage\fP filter with anything +smaller than 85 will likely not affect anything +.IP \(bu 2 +in a more realistic scenario, the space is distributed unevenly, we can +assume there are completely used chunks and the remaining are partially filled +.UNINDENT +.sp +Compacting the layout could be used on both. In the former case it would spread +data of a given chunk to the others and removing it. Here we can estimate that +roughly 850 MiB of data have to be moved (85% of a 1 GiB chunk). +.sp +In the latter case, targeting the partially used chunks will have to move less +data and thus will be faster. A typical filter command would look like: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +# btrfs balance start \-dusage=50 /path +Done, had to relocate 2 out of 97 chunks + +$ btrfs filesystem df /path +Data, single: total=74.03GiB, used=64.43GiB +System, RAID1: total=32.00MiB, used=20.00KiB +Metadata, RAID1: total=15.87GiB, used=8.84GiB +GlobalReserve, single: total=512.00MiB, used=0.00B +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +As you can see, the \fItotal\fP amount of data is decreased by just 1 GiB, which is +an expected result. Let\(aqs see what will happen when we increase the estimated +usage filter. +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +# btrfs balance start \-dusage=85 /path +Done, had to relocate 13 out of 95 chunks + +$ btrfs filesystem df /path +Data, single: total=68.03GiB, used=64.43GiB +System, RAID1: total=32.00MiB, used=20.00KiB +Metadata, RAID1: total=15.87GiB, used=8.85GiB +GlobalReserve, single: total=512.00MiB, used=0.00B +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Now the used/total ratio is about 94% and we moved about \fI74G \- 68G = 6G\fP of +data to the remaining block groups, i.e. the 6GiB are now free of filesystem +structures, and can be reused for new data or metadata block groups. +.sp +We can do a similar exercise with the metadata block groups, but this should +not typically be necessary, unless the used/total ratio is really off. Here +the ratio is roughly 50% but the difference as an absolute number is \(dqa few +gigabytes\(dq, which can be considered normal for a workload with snapshots or +reflinks updated frequently. +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +# btrfs balance start \-musage=50 /path +Done, had to relocate 4 out of 89 chunks + +$ btrfs filesystem df /path +Data, single: total=68.03GiB, used=64.43GiB +System, RAID1: total=32.00MiB, used=20.00KiB +Metadata, RAID1: total=14.87GiB, used=8.85GiB +GlobalReserve, single: total=512.00MiB, used=0.00B +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Just 1 GiB decrease, which possibly means there are block groups with good +utilization. Making the metadata layout more compact would in turn require +updating more metadata structures, i.e. lots of IO. As running out of metadata +space is a more severe problem, it\(aqs not necessary to keep the utilization +ratio too high. For the purpose of this example, let\(aqs see the effects of +further compaction: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +# btrfs balance start \-musage=70 /path +Done, had to relocate 13 out of 88 chunks + +$ btrfs filesystem df . +Data, single: total=68.03GiB, used=64.43GiB +System, RAID1: total=32.00MiB, used=20.00KiB +Metadata, RAID1: total=11.97GiB, used=8.83GiB +GlobalReserve, single: total=512.00MiB, used=0.00B +.ft P +.fi +.UNINDENT +.UNINDENT +.SS GETTING RID OF COMPLETELY UNUSED BLOCK GROUPS +.sp +Normally the balance operation needs a work space, to temporarily move the +data before the old block groups gets removed. If there\(aqs no work space, it +ends with \fIno space left\fP\&. +.sp +There\(aqs a special case when the block groups are completely unused, possibly +left after removing lots of files or deleting snapshots. Removing empty block +groups is automatic since 3.18. The same can be achieved manually with a +notable exception that this operation does not require the work space. Thus it +can be used to reclaim unused block groups to make it available. +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +# btrfs balance start \-dusage=0 /path +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +This should lead to decrease in the \fItotal\fP numbers in the \fBbtrfs filesystem df\fP output. +.SH EXIT STATUS +.sp +Unless indicated otherwise below, all \fBbtrfs balance\fP subcommands +return a zero exit status if they succeed, and non zero in case of +failure. +.sp +The \fBpause\fP, \fBcancel\fP, and \fBresume\fP subcommands exit with a status of +\fB2\fP if they fail because a balance operation was not running. +.sp +The \fBstatus\fP subcommand exits with a status of \fB0\fP if a balance +operation is not running, \fB1\fP if the command\-line usage is incorrect +or a balance operation is still running, and \fB2\fP on other errors. +.SH AVAILABILITY +.sp +\fBbtrfs\fP is part of btrfs\-progs. Please refer to the documentation at +\fI\%https://btrfs.readthedocs.io\fP\&. +.SH SEE ALSO +.sp +\fI\%mkfs.btrfs(8)\fP, +\fI\%btrfs\-device(8)\fP +.\" Generated by docutils manpage writer. +. diff --git a/upstream/opensuse-leap-15-6/man8/btrfs-check.8 b/upstream/opensuse-leap-15-6/man8/btrfs-check.8 new file mode 100644 index 00000000..df2e0127 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/btrfs-check.8 @@ -0,0 +1,221 @@ +.\" Man page generated from reStructuredText. +. +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.TH "BTRFS-CHECK" "8" "Sep 13, 2023" "6.5.1" "BTRFS" +.SH NAME +btrfs-check \- check or repair a btrfs filesystem +.SH SYNOPSIS +.sp +\fBbtrfs check\fP [options] <device> +.SH DESCRIPTION +.sp +The filesystem checker is used to verify structural integrity of a filesystem +and attempt to repair it if requested. It is recommended to unmount the +filesystem prior to running the check, but it is possible to start checking a +mounted filesystem (see \fI\%\-\-force\fP). +.sp +By default, \fBbtrfs check\fP will not modify the device but you can reaffirm that +by the option \fI\-\-readonly\fP\&. +.sp +\fBbtrfsck\fP is an alias of \fBbtrfs check\fP command and is now deprecated. +.sp +\fBWARNING:\fP +.INDENT 0.0 +.INDENT 3.5 +Do not use \fI\-\-repair\fP unless you are advised to do so by a developer +or an experienced user, and then only after having accepted that no \fIfsck\fP +successfully repair all types of filesystem corruption. E.g. some other software +or hardware bugs can fatally damage a volume. +.UNINDENT +.UNINDENT +.sp +The structural integrity check verifies if internal filesystem objects or +data structures satisfy the constraints, point to the right objects or are +correctly connected together. +.sp +There are several cross checks that can detect wrong reference counts of shared +extents, backreferences, missing extents of inodes, directory and inode +connectivity etc. +.sp +The amount of memory required can be high, depending on the size of the +filesystem, similarly the run time. Check the modes that can also affect that. +.SH SAFE OR ADVISORY OPTIONS +.INDENT 0.0 +.TP +.B \-b|\-\-backup +use the first valid set of backup roots stored in the superblock +.sp +This can be combined with \fI\-\-super\fP if some of the superblocks are damaged. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-check\-data\-csum +verify checksums of data blocks +.sp +This expects that the filesystem is otherwise OK, and is basically an offline +\fIscrub\fP that does not repair data from spare copies. +.TP +.BI \-\-chunk\-root \ <bytenr> +use the given offset \fIbytenr\fP for the chunk tree root +.UNINDENT +.INDENT 0.0 +.TP +.B \-E|\-\-subvol\-extents <subvolid> +show extent state for the given subvolume +.TP +.B \-p|\-\-progress +indicate progress at various checking phases +.TP +.B \-Q|\-\-qgroup\-report +verify qgroup accounting and compare against filesystem accounting +.TP +.B \-r|\-\-tree\-root <bytenr> +use the given offset \(aqbytenr\(aq for the tree root +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-readonly +(default) +run in read\-only mode, this option exists to calm potential panic when users +are going to run the checker +.UNINDENT +.INDENT 0.0 +.TP +.B \-s|\-\-super <N> +use Nth superblock copy, valid values are 0, 1 or 2 if the +respective superblock offset is within the device size +.sp +This can be used to use a different starting point if some of the primary +superblock is damaged. +.TP +.B \-\-clear\-space\-cache v1|v2 +completely remove the free space cache of the given version +.sp +See also the \fIclear_cache\fP mount option. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-clear\-ino\-cache +remove leftover items pertaining to the deprecated inode map feature +.UNINDENT +.SH DANGEROUS OPTIONS +.INDENT 0.0 +.TP +.B \-\-repair +enable the repair mode and attempt to fix problems where possible +.sp +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +There\(aqs a warning and 10 second delay when this option is run without +\fI\-\-force\fP to give users a chance to think twice before running repair, the +warnings in documentation have shown to be insufficient. +.UNINDENT +.UNINDENT +.TP +.B \-\-init\-csum\-tree +create a new checksum tree and recalculate checksums in all files +.sp +\fBWARNING:\fP +.INDENT 7.0 +.INDENT 3.5 +Do not blindly use this option to fix checksum mismatch problems. +.UNINDENT +.UNINDENT +.TP +.B \-\-init\-extent\-tree +build the extent tree from scratch +.sp +\fBWARNING:\fP +.INDENT 7.0 +.INDENT 3.5 +Do not use unless you know what you\(aqre doing. +.UNINDENT +.UNINDENT +.TP +.BI \-\-mode \ <MODE> +select mode of operation regarding memory and IO +.sp +The \fIMODE\fP can be one of: +.INDENT 7.0 +.TP +.B original +The metadata are read into memory and verified, thus the requirements are high +on large filesystems and can even lead to out\-of\-memory conditions. The +possible workaround is to export the block device over network to a machine +with enough memory. +.TP +.B lowmem +This mode is supposed to address the high memory consumption at the cost of +increased IO when it needs to re\-read blocks. This may increase run time. +.UNINDENT +.sp +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +\fIlowmem\fP mode does not work with \fI\-\-repair\fP yet, and is still considered +experimental. +.UNINDENT +.UNINDENT +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-force +allow work on a mounted filesystem and skip mount checks. Note that +this should work fine on a quiescent or read\-only mounted filesystem +but may crash if the device is changed externally, e.g. by the kernel +module. +.sp +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +It is possible to run with \-\-repair but on a mounted filesystem +that will most likely lead to a corruption unless the filesystem +is in a quiescent state which may not be possible to guarantee. +.UNINDENT +.UNINDENT +.sp +This option also skips the delay and warning in the repair mode (see +\fI\-\-repair\fP). +.UNINDENT +.SH EXIT STATUS +.sp +\fBbtrfs check\fP returns a zero exit status if it succeeds. Non zero is +returned in case of failure. +.SH AVAILABILITY +.sp +\fBbtrfs\fP is part of btrfs\-progs. Please refer to the documentation at +\fI\%https://btrfs.readthedocs.io\fP\&. +.SH SEE ALSO +.sp +\fI\%mkfs.btrfs(8)\fP, +\fI\%btrfs\-scrub(8)\fP, +\fI\%btrfs\-rescue(8)\fP +.\" Generated by docutils manpage writer. +. diff --git a/upstream/opensuse-leap-15-6/man8/btrfs-convert.8 b/upstream/opensuse-leap-15-6/man8/btrfs-convert.8 new file mode 100644 index 00000000..70b09382 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/btrfs-convert.8 @@ -0,0 +1,253 @@ +.\" Man page generated from reStructuredText. +. +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.TH "BTRFS-CONVERT" "8" "Sep 13, 2023" "6.5.1" "BTRFS" +.SH NAME +btrfs-convert \- convert from ext2/3/4 or reiserfs filesystem to btrfs in-place +.SH SYNOPSIS +.sp +\fBbtrfs\-convert\fP [options] <device> +.SH DESCRIPTION +.sp +The \fBbtrfs\-convert\fP tool can be used to convert existing source filesystem +image to a btrfs filesystem in\-place. The original filesystem image is +accessible in subvolume named like \fIext2_saved\fP as file \fIimage\fP\&. +.sp +Supported filesystems: +.INDENT 0.0 +.IP \(bu 2 +ext2, ext3, ext4 \-\- original feature, always built in +.IP \(bu 2 +reiserfs \-\- since version 4.13, optionally built, requires libreiserfscore 3.6.27 +.IP \(bu 2 +NTFS \-\- external tool \fI\%https://github.com/maharmstone/ntfs2btrfs\fP +.UNINDENT +.sp +The list of supported source filesystem by a given binary is listed at the end +of help (option \fI\-\-help\fP). +.sp +\fBWARNING:\fP +.INDENT 0.0 +.INDENT 3.5 +If you are going to perform rollback to the original filesystem, you +should not execute \fBbtrfs balance\fP command on the converted filesystem. This +will change the extent layout and make \fBbtrfs\-convert\fP unable to rollback. +.UNINDENT +.UNINDENT +.sp +The conversion utilizes free space of the original filesystem. The exact +estimate of the required space cannot be foretold. The final btrfs metadata +might occupy several gigabytes on a hundreds\-gigabyte filesystem. +.sp +If the ability to rollback is no longer important, the it is recommended to +perform a few more steps to transition the btrfs filesystem to a more compact +layout. This is because the conversion inherits the original data blocks\(aq +fragmentation, and also because the metadata blocks are bound to the original +free space layout. +.sp +Due to different constraints, it is only possible to convert filesystems that +have a supported data block size (i.e. the same that would be valid for +\fBmkfs.btrfs\fP). This is typically the system page size (4KiB on x86_64 +machines). +.sp +\fBBEFORE YOU START\fP +.sp +The source filesystem must be clean, e.g. no journal to replay or no repairs +needed. The respective \fBfsck\fP utility must be run on the source filesystem prior +to conversion. Please refer to the manual pages in case you encounter problems. +.sp +For ext2/3/4: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +# e2fsck \-fvy /dev/sdx +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +For reiserfs: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +# reiserfsck \-fy /dev/sdx +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Skipping that step could lead to incorrect results on the target filesystem, +but it may work. +.sp +\fBREMOVE THE ORIGINAL FILESYSTEM METADATA\fP +.sp +By removing the subvolume named like \fIext2_saved\fP or \fIreiserfs_saved\fP, all +metadata of the original filesystem will be removed: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +# btrfs subvolume delete /mnt/ext2_saved +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +At this point it is not possible to do a rollback. The filesystem is usable but +may be impacted by the fragmentation inherited from the original filesystem. +.sp +\fBMAKE FILE DATA MORE CONTIGUOUS\fP +.sp +An optional but recommended step is to run defragmentation on the entire +filesystem. This will attempt to make file extents more contiguous. +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +# btrfs filesystem defrag \-v \-r \-f \-t 32M /mnt/btrfs +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Verbose recursive defragmentation (\fI\-v\fP, \fI\-r\fP), flush data per\-file (\fI\-f\fP) with +target extent size 32MiB (\fI\-t\fP). +.sp +\fBATTEMPT TO MAKE BTRFS METADATA MORE COMPACT\fP +.sp +Optional but recommended step. +.sp +The metadata block groups after conversion may be smaller than the default size +(256MiB or 1GiB). Running a balance will attempt to merge the block groups. +This depends on the free space layout (and fragmentation) and may fail due to +lack of enough work space. This is a soft error leaving the filesystem usable +but the block group layout may remain unchanged. +.sp +Note that balance operation takes a lot of time, please see also +\fI\%btrfs\-balance(8)\fP\&. +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +# btrfs balance start \-m /mnt/btrfs +.ft P +.fi +.UNINDENT +.UNINDENT +.SH OPTIONS +.INDENT 0.0 +.TP +.BI \-\-csum \ <type>\fR,\fB \ \-\-checksum \ <type> +Specify the checksum algorithm. Default is \fIcrc32c\fP\&. Valid values are \fIcrc32c\fP, +\fIxxhash\fP, \fIsha256\fP or \fIblake2\fP\&. To mount such filesystem kernel must support the +checksums as well. +.UNINDENT +.INDENT 0.0 +.TP +.B \-d|\-\-no\-datasum +disable data checksum calculations and set the NODATASUM file flag, this can speed +up the conversion +.TP +.B \-i|\-\-no\-xattr +ignore xattrs and ACLs of files +.TP +.B \-n|\-\-no\-inline +disable inlining of small files to metadata blocks, this will decrease the metadata +consumption and may help to convert a filesystem with low free space +.TP +.B \-N|\-\-nodesize <SIZE> +set filesystem nodesize, the tree block size in which btrfs stores its metadata. +The default value is 16KiB (16384) or the page size, whichever is bigger. +Must be a multiple of the sectorsize, but not larger than 65536. See +\fI\%mkfs.btrfs(8)\fP for more details. +.TP +.B \-r|\-\-rollback +rollback to the original ext2/3/4 filesystem if possible +.TP +.B \-l|\-\-label <LABEL> +set filesystem label during conversion +.TP +.B \-L|\-\-copy\-label +use label from the converted filesystem +.TP +.B \-O|\-\-features <feature1>[,<feature2>...] +A list of filesystem features enabled the at time of conversion. Not all features +are supported by old kernels. To disable a feature, prefix it with \fI^\fP\&. +Description of the features is in section +\fI\%FILESYSTEM FEATURES\fP of +\fI\%mkfs.btrfs(8)\fP\&. +.sp +To see all available features that btrfs\-convert supports run: +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +btrfs\-convert \-O list\-all +.ft P +.fi +.UNINDENT +.UNINDENT +.TP +.B \-p|\-\-progress +show progress of conversion (a heartbeat indicator and number of inodes +processed), on by default +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-no\-progress +disable progress and show only the main phases of conversion +.TP +.BI \-\-uuid \ <SPEC> +set the FSID of the new filesystem based on \(aqSPEC\(aq: +.INDENT 7.0 +.IP \(bu 2 +\fInew\fP \- (default) generate UUID for the FSID of btrfs +.IP \(bu 2 +\fIcopy\fP \- copy UUID from the source filesystem +.IP \(bu 2 +\fIUUID\fP \- a conforming UUID value, the 36 byte string representation +.UNINDENT +.UNINDENT +.SH EXIT STATUS +.sp +\fBbtrfs\-convert\fP will return 0 if no error happened. +If any problems happened, 1 will be returned. +.SH SEE ALSO +.sp +\fI\%mkfs.btrfs(8)\fP +.\" Generated by docutils manpage writer. +. diff --git a/upstream/opensuse-leap-15-6/man8/btrfs-device.8 b/upstream/opensuse-leap-15-6/man8/btrfs-device.8 new file mode 100644 index 00000000..e02dd772 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/btrfs-device.8 @@ -0,0 +1,466 @@ +.\" Man page generated from reStructuredText. +. +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.TH "BTRFS-DEVICE" "8" "Sep 13, 2023" "6.5.1" "BTRFS" +.SH NAME +btrfs-device \- manage devices of btrfs filesystems +.SH SYNOPSIS +.sp +\fBbtrfs device\fP <subcommand> <args> +.SH DESCRIPTION +.sp +The \fBbtrfs device\fP command group is used to manage devices of the btrfs filesystems. +.SH DEVICE MANAGEMENT +.sp +BTRFS filesystem can be created on top of single or multiple block devices. +Devices can be then added, removed or replaced on demand. Data and metadata are +organized in allocation profiles with various redundancy policies. There\(aqs some +similarity with traditional RAID levels, but this could be confusing to users +familiar with the traditional meaning. Due to the similarity, the RAID +terminology is widely used in the documentation. See \fI\%mkfs.btrfs(8)\fP for more +details and the exact profile capabilities and constraints. +.sp +The device management works on a mounted filesystem. Devices can be added, +removed or replaced, by commands provided by \fBbtrfs device\fP and \fBbtrfs replace\fP\&. +.sp +The profiles can be also changed, provided there\(aqs enough workspace to do the +conversion, using the \fBbtrfs balance\fP command and namely the filter \fIconvert\fP\&. +.INDENT 0.0 +.TP +.B Type +The block group profile type is the main distinction of the information stored +on the block device. User data are called \fIData\fP, the internal data structures +managed by filesystem are \fIMetadata\fP and \fISystem\fP\&. +.TP +.B Profile +A profile describes an allocation policy based on the redundancy/replication +constraints in connection with the number of devices. The profile applies to +data and metadata block groups separately. E.g. \fIsingle\fP, \fIRAID1\fP\&. +.TP +.B RAID level +Where applicable, the level refers to a profile that matches constraints of the +standard RAID levels. At the moment the supported ones are: RAID0, RAID1, +RAID10, RAID5 and RAID6. +.UNINDENT +.SH TYPICAL USE CASES +.SS Starting with a single\-device filesystem +.sp +Assume we\(aqve created a filesystem on a block device \fB/dev/sda\fP with profile +\fIsingle/single\fP (data/metadata), the device size is 50GiB and we\(aqve used the +whole device for the filesystem. The mount point is \fB/mnt\fP\&. +.sp +The amount of data stored is 16GiB, metadata have allocated 2GiB. +.SS Add new device +.sp +We want to increase the total size of the filesystem and keep the profiles. The +size of the new device \fB/dev/sdb\fP is 100GiB. +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +$ btrfs device add /dev/sdb /mnt +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +The amount of free data space increases by less than 100GiB, some space is +allocated for metadata. +.SS Convert to RAID1 +.sp +Now we want to increase the redundancy level of both data and metadata, but +we\(aqll do that in steps. Note, that the device sizes are not equal and we\(aqll use +that to show the capabilities of split data/metadata and independent profiles. +.sp +The constraint for RAID1 gives us at most 50GiB of usable space and exactly 2 +copies will be stored on the devices. +.sp +First we\(aqll convert the metadata. As the metadata occupy less than 50GiB and +there\(aqs enough workspace for the conversion process, we can do: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +$ btrfs balance start \-mconvert=raid1 /mnt +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +This operation can take a while, because all metadata have to be moved and all +block pointers updated. Depending on the physical locations of the old and new +blocks, the disk seeking is the key factor affecting performance. +.sp +You\(aqll note that the system block group has been also converted to RAID1, this +normally happens as the system block group also holds metadata (the physical to +logical mappings). +.sp +What changed: +.INDENT 0.0 +.IP \(bu 2 +available data space decreased by 3GiB, usable roughly (50 \- 3) + (100 \- 3) = 144 GiB +.IP \(bu 2 +metadata redundancy increased +.UNINDENT +.sp +IOW, the unequal device sizes allow for combined space for data yet improved +redundancy for metadata. If we decide to increase redundancy of data as well, +we\(aqre going to lose 50GiB of the second device for obvious reasons. +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +$ btrfs balance start \-dconvert=raid1 /mnt +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +The balance process needs some workspace (i.e. a free device space without any +data or metadata block groups) so the command could fail if there\(aqs too much +data or the block groups occupy the whole first device. +.sp +The device size of \fB/dev/sdb\fP as seen by the filesystem remains unchanged, but +the logical space from 50\-100GiB will be unused. +.SS Remove device +.sp +Device removal must satisfy the profile constraints, otherwise the command +fails. For example: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +$ btrfs device remove /dev/sda /mnt +ERROR: error removing device \(aq/dev/sda\(aq: unable to go below two devices on raid1 +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +In order to remove a device, you need to convert the profile in this case: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +$ btrfs balance start \-mconvert=dup \-dconvert=single /mnt +$ btrfs device remove /dev/sda /mnt +.ft P +.fi +.UNINDENT +.UNINDENT +.SH SUBCOMMAND +.INDENT 0.0 +.TP +.B add [\-Kf] <device> [<device>...] <path> +Add device(s) to the filesystem identified by \fIpath\fP\&. +.sp +If applicable, a whole device discard (TRIM) operation is performed prior to +adding the device. A device with existing filesystem detected by \fBblkid(8)\fP +will prevent device addition and has to be forced. Alternatively the filesystem +can be wiped from the device using e.g. the \fBwipefs(8)\fP tool. +.sp +The operation is instant and does not affect existing data. The operation merely +adds the device to the filesystem structures and creates some block groups +headers. +.sp +\fBOptions\fP +.INDENT 7.0 +.TP +.B \-K|\-\-nodiscard +do not perform discard (TRIM) by default +.TP +.B \-f|\-\-force +force overwrite of existing filesystem on the given disk(s) +.UNINDENT +.INDENT 7.0 +.TP +.B \-\-enqueue +wait if there\(aqs another exclusive operation running, otherwise continue +.UNINDENT +.TP +.B remove [options] <device>|<devid> [<device>|<devid>...] <path> +Remove device(s) from a filesystem identified by <path> +.sp +Device removal must satisfy the profile constraints, otherwise the command +fails. The filesystem must be converted to profile(s) that would allow the +removal. This can typically happen when going down from 2 devices to 1 and +using the RAID1 profile. See the section \fI\%Typical use cases\fP\&. +.sp +The operation can take long as it needs to move all data from the device. +.sp +It is possible to delete the device that was used to mount the filesystem. The +device entry in the mount table will be replaced by another device name with +the lowest device id. +.sp +If the filesystem is mounted in degraded mode (\fI\-o degraded\fP), special term +\fImissing\fP can be used for \fIdevice\fP\&. In that case, the first device that is +described by the filesystem metadata, but not present at the mount time will be +removed. +.sp +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +In most cases, there is only one missing device in degraded mode, +otherwise mount fails. If there are two or more devices missing (e.g. possible +in RAID6), you need specify \fImissing\fP as many times as the number of missing +devices to remove all of them. +.UNINDENT +.UNINDENT +.sp +\fBOptions\fP +.INDENT 7.0 +.TP +.B \-\-enqueue +wait if there\(aqs another exclusive operation running, otherwise continue +.UNINDENT +.TP +.B delete <device>|<devid> [<device>|<devid>...] <path> +Alias of remove kept for backward compatibility +.TP +.B replace <command> [options] <path> +Alias of whole command group \fIbtrfs replace\fP for convenience. See +\fI\%btrfs\-replace(8)\fP\&. +.TP +.B ready <device> +Wait until all devices of a multiple\-device filesystem are scanned and +registered within the kernel module. This is to provide a way for automatic +filesystem mounting tools to wait before the mount can start. The device scan +is only one of the preconditions and the mount can fail for other reasons. +Normal users usually do not need this command and may safely ignore it. +.TP +.B scan [options] [<device> [<device>...]] +Scan devices for a btrfs filesystem and register them with the kernel module. +This allows mounting multiple\-device filesystem by specifying just one from the +whole group. +.sp +If no devices are passed, all block devices that blkid reports to contain btrfs +are scanned. +.sp +The options \fI\-\-all\-devices\fP or \fI\-d\fP can be used as a fallback in case blkid is +not available. If used, behavior is the same as if no devices are passed. +.sp +The command can be run repeatedly. Devices that have been already registered +remain as such. Reloading the kernel module will drop this information. There\(aqs +an alternative way of mounting multiple\-device filesystem without the need for +prior scanning. See the mount option \fI\%device\fP\&. +.sp +\fBOptions\fP +.INDENT 7.0 +.TP +.B \-d|\-\-all\-devices +Enumerate and register all devices, use as a fallback in case blkid is not +available. +.TP +.B \-u|\-\-forget +Unregister a given device or all stale devices if no path is given, the device +must be unmounted otherwise it\(aqs an error. +.UNINDENT +.TP +.B stats [options] <path>|<device> +Read and print the device IO error statistics for all devices of the given +filesystem identified by \fIpath\fP or for a single \fIdevice\fP\&. The filesystem must +be mounted. See section \fI\%DEVICE STATS\fP +for more information about the reported statistics and the meaning. +.sp +\fBOptions\fP +.INDENT 7.0 +.TP +.B \-z|\-\-reset +Print the stats and reset the values to zero afterwards. +.TP +.B \-c|\-\-check +Check if the stats are all zeros and return 0 if it is so. Set bit 6 of the +return code if any of the statistics is no\-zero. The error values is 65 if +reading stats from at least one device failed, otherwise it\(aqs 64. +.UNINDENT +.INDENT 7.0 +.TP +.B \-T +Print stats in a tabular form, devices as rows and stats as columns +.UNINDENT +.TP +.B usage [options] <path> [<path>...]:: +Show detailed information about internal allocations on devices. +.sp +The level of detail can differ if the command is run under a regular or the +root user (due to use of restricted ioctls). The first example below is for +normal user (warning included) and the next one with root on the same +filesystem: +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +WARNING: cannot read detailed chunk info, per\-device usage will not be shown, run as root +/dev/sdc1, ID: 1 + Device size: 931.51GiB + Device slack: 0.00B + Unallocated: 931.51GiB + +/dev/sdc1, ID: 1 + Device size: 931.51GiB + Device slack: 0.00B + Data,single: 641.00GiB + Data,RAID0/3: 1.00GiB + Metadata,single: 19.00GiB + System,single: 32.00MiB + Unallocated: 271.48GiB +.ft P +.fi +.UNINDENT +.UNINDENT +.INDENT 7.0 +.IP \(bu 2 +\fIDevice size\fP \-\- size of the device as seen by the filesystem (may be +different than actual device size) +.IP \(bu 2 +\fIDevice slack\fP \-\- portion of device not used by the filesystem but +still available in the physical space provided by the device, e.g. +after a device shrink +.IP \(bu 2 +\fIData,single\fP, \fIMetadata,single\fP, \fISystem,single\fP \-\- in general, list +of block group type (Data, Metadata, System) and profile (single, +RAID1, ...) allocated on the device +.IP \(bu 2 +\fIData,RAID0/3\fP \-\- in particular, striped profiles +RAID0/RAID10/RAID5/RAID6 with the number of devices on which the +stripes are allocated, multiple occurrences of the same profile can +appear in case a new device has been added and all new available +stripes have been used for writes +.IP \(bu 2 +\fIUnallocated\fP \-\- remaining space that the filesystem can still use +for new block groups +.UNINDENT +.sp +\fBOptions\fP +.INDENT 7.0 +.TP +.B \-b|\-\-raw +raw numbers in bytes, without the \fIB\fP suffix +.TP +.B \-h|\-\-human\-readable +print human friendly numbers, base 1024, this is the default +.UNINDENT +.INDENT 7.0 +.TP +.B \-H +print human friendly numbers, base 1000 +.TP +.B \-\-iec +select the 1024 base for the following options, according to the IEC standard +.TP +.B \-\-si +select the 1000 base for the following options, according to the SI standard +.UNINDENT +.INDENT 7.0 +.TP +.B \-k|\-\-kbytes +show sizes in KiB, or kB with \-\-si +.TP +.B \-m|\-\-mbytes +show sizes in MiB, or MB with \-\-si +.TP +.B \-g|\-\-gbytes +show sizes in GiB, or GB with \-\-si +.TP +.B \-t|\-\-tbytes +show sizes in TiB, or TB with \-\-si +.UNINDENT +.sp +If conflicting options are passed, the last one takes precedence. +.UNINDENT +.SH DEVICE STATS +.sp +The device stats keep persistent record of several error classes related to +doing IO. The current values are printed at mount time and updated during +filesystem lifetime or from a scrub run. +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +$ btrfs device stats /dev/sda3 +[/dev/sda3].write_io_errs 0 +[/dev/sda3].read_io_errs 0 +[/dev/sda3].flush_io_errs 0 +[/dev/sda3].corruption_errs 0 +[/dev/sda3].generation_errs 0 +.ft P +.fi +.UNINDENT +.UNINDENT +.INDENT 0.0 +.TP +.B write_io_errs +Failed writes to the block devices, means that the layers beneath the +filesystem were not able to satisfy the write request. +.TP +.B read_io_errors +Read request analogy to write_io_errs. +.TP +.B flush_io_errs +Number of failed writes with the \fIFLUSH\fP flag set. The flushing is a method of +forcing a particular order between write requests and is crucial for +implementing crash consistency. In case of btrfs, all the metadata blocks must +be permanently stored on the block device before the superblock is written. +.TP +.B corruption_errs +A block checksum mismatched or a corrupted metadata header was found. +.TP +.B generation_errs +The block generation does not match the expected value (e.g. stored in the +parent node). +.UNINDENT +.sp +Since kernel 5.14 the device stats are also available in textual form in +\fB/sys/fs/btrfs/FSID/devinfo/DEVID/error_stats\fP\&. +.SH EXIT STATUS +.sp +\fBbtrfs device\fP returns a zero exit status if it succeeds. Non zero is +returned in case of failure. +.sp +If the \fI\-c\fP option is used, \fIbtrfs device stats\fP will add 64 to the +exit status if any of the error counters is non\-zero. +.SH AVAILABILITY +.sp +\fBbtrfs\fP is part of btrfs\-progs. Please refer to the documentation at +\fI\%https://btrfs.readthedocs.io\fP\&. +.SH SEE ALSO +.sp +\fI\%btrfs\-balance(8)\fP +\fI\%btrfs\-device(8)\fP, +\fI\%btrfs\-replace(8)\fP, +\fI\%mkfs.btrfs(8)\fP +.\" Generated by docutils manpage writer. +. diff --git a/upstream/opensuse-leap-15-6/man8/btrfs-filesystem.8 b/upstream/opensuse-leap-15-6/man8/btrfs-filesystem.8 new file mode 100644 index 00000000..cd53ccca --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/btrfs-filesystem.8 @@ -0,0 +1,644 @@ +.\" Man page generated from reStructuredText. +. +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.TH "BTRFS-FILESYSTEM" "8" "Sep 13, 2023" "6.5.1" "BTRFS" +.SH NAME +btrfs-filesystem \- command group that primarily does work on the whole filesystems +.SH SYNOPSIS +.sp +\fBbtrfs filesystem\fP <subcommand> <args> +.SH DESCRIPTION +.sp +\fBbtrfs filesystem\fP is used to perform several whole filesystem level tasks, +including all the regular filesystem operations like resizing, space stats, +label setting/getting, and defragmentation. There are other whole filesystem +tasks like scrub or balance that are grouped in separate commands. +.SH SUBCOMMAND +.INDENT 0.0 +.TP +.B df [options] <path> +Show a terse summary information about allocation of block group types of a given +mount point. The original purpose of this command was a debugging helper. The +output needs to be further interpreted and is not suitable for quick overview. +.sp +An example with description: +.INDENT 7.0 +.IP \(bu 2 +device size: \fI1.9TiB\fP, one device, no RAID +.IP \(bu 2 +filesystem size: \fI1.9TiB\fP +.IP \(bu 2 +created with: \fBmkfs.btrfs \-d single \-m single\fP +.UNINDENT +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +$ btrfs filesystem df /path +Data, single: total=1.15TiB, used=1.13TiB +System, single: total=32.00MiB, used=144.00KiB +Metadata, single: total=12.00GiB, used=6.45GiB +GlobalReserve, single: total=512.00MiB, used=0.00B +.ft P +.fi +.UNINDENT +.UNINDENT +.INDENT 7.0 +.IP \(bu 2 +\fIData\fP, \fISystem\fP and \fIMetadata\fP are separate block group types. +\fIGlobalReserve\fP is an artificial and internal emergency space, see +below. +.IP \(bu 2 +\fIsingle\fP \-\- the allocation profile, defined at mkfs time +.IP \(bu 2 +\fItotal\fP \-\- sum of space reserved for all allocation profiles of the +given type, i.e. all Data/single. Note that it\(aqs not total size of +filesystem. +.IP \(bu 2 +\fIused\fP \-\- sum of used space of the above, i.e. file extents, metadata blocks +.UNINDENT +.sp +\fIGlobalReserve\fP is an artificial and internal emergency space. It is used e.g. +when the filesystem is full. Its \fItotal\fP size is dynamic based on the +filesystem size, usually not larger than 512MiB, \fIused\fP may fluctuate. +.sp +The GlobalReserve is a portion of Metadata. In case the filesystem metadata is +exhausted, \fIGlobalReserve/total + Metadata/used = Metadata/total\fP\&. Otherwise +there appears to be some unused space of Metadata. +.sp +\fBOptions\fP +.INDENT 7.0 +.TP +.B \-b|\-\-raw +raw numbers in bytes, without the \fIB\fP suffix +.TP +.B \-h|\-\-human\-readable +print human friendly numbers, base 1024, this is the default +.UNINDENT +.INDENT 7.0 +.TP +.B \-H +print human friendly numbers, base 1000 +.TP +.B \-\-iec +select the 1024 base for the following options, according to the IEC standard +.TP +.B \-\-si +select the 1000 base for the following options, according to the SI standard +.UNINDENT +.INDENT 7.0 +.TP +.B \-k|\-\-kbytes +show sizes in KiB, or kB with \-\-si +.TP +.B \-m|\-\-mbytes +show sizes in MiB, or MB with \-\-si +.TP +.B \-g|\-\-gbytes +show sizes in GiB, or GB with \-\-si +.TP +.B \-t|\-\-tbytes +show sizes in TiB, or TB with \-\-si +.UNINDENT +.sp +If conflicting options are passed, the last one takes precedence. +.UNINDENT +.INDENT 0.0 +.TP +.B defragment [options] <file>|<dir> [<file>|<dir>...] +Defragment file data on a mounted filesystem. Requires kernel 2.6.33 and newer. +.sp +If \fI\-r\fP is passed, files in dir will be defragmented recursively (not +descending to subvolumes, mount points and directory symlinks). +The start position and the number of bytes to defragment can be specified by +start and length using \fI\-s\fP and \fI\-l\fP options below. +Extents bigger than value given by \fI\-t\fP will be skipped, otherwise this value +is used as a target extent size, but is only advisory and may not be reached +if the free space is too fragmented. +Use 0 to take the kernel default, which is 256KiB but may change in the future. +You can also turn on compression in defragment operations. +.sp +\fBWARNING:\fP +.INDENT 7.0 +.INDENT 3.5 +Defragmenting with Linux kernel versions < 3.9 or ≥ 3.14\-rc2 as well as +with Linux stable kernel versions ≥ 3.10.31, ≥ 3.12.12 or ≥ 3.13.4 will break up +the reflinks of COW data (for example files copied with \fBcp \-\-reflink\fP, +snapshots or de\-duplicated data). +This may cause considerable increase of space usage depending on the broken up +reflinks. +.UNINDENT +.UNINDENT +.sp +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +Directory arguments without \fI\-r\fP do not defragment files recursively but will +defragment certain internal trees (extent tree and the subvolume tree). This has been +confusing and could be removed in the future. +.UNINDENT +.UNINDENT +.sp +For \fIstart\fP, \fIlen\fP, \fIsize\fP it is possible to append +units designator: \fIK\fP, \fIM\fP, \fIG\fP, \fIT\fP, \fIP\fP, or \fIE\fP, which represent +KiB, MiB, GiB, TiB, PiB, or EiB, respectively (case does not matter). +.sp +\fBOptions\fP +.INDENT 7.0 +.TP +.B \-c[<algo>] +compress file contents while defragmenting. Optional argument selects the compression +algorithm, \fIzlib\fP (default), \fIlzo\fP or \fIzstd\fP\&. Currently it\(aqs not possible to select no +compression. See also section \fIEXAMPLES\fP\&. +.UNINDENT +.INDENT 7.0 +.TP +.B \-r +defragment files recursively in given directories, does not descend to +subvolumes or mount points +.TP +.B \-f +flush data for each file before going to the next file. +.sp +This will limit the amount of dirty data to current file, otherwise the amount +accumulates from several files and will increase system load. This can also lead +to ENOSPC if there\(aqs too much dirty data to write and it\(aqs not possible to make +the reservations for the new data (i.e. how the COW design works). +.UNINDENT +.INDENT 7.0 +.TP +.B \-s <start>[kKmMgGtTpPeE] +defragmentation will start from the given offset, default is beginning of a file +.TP +.B \-l <len>[kKmMgGtTpPeE] +defragment only up to \fIlen\fP bytes, default is the file size +.TP +.B \-t <size>[kKmMgGtTpPeE] +target extent size, do not touch extents bigger than \fIsize\fP, default: 32MiB +.sp +The value is only advisory and the final size of the extents may differ, +depending on the state of the free space and fragmentation or other internal +logic. Reasonable values are from tens to hundreds of megabytes. +.UNINDENT +.INDENT 7.0 +.TP +.B \-v +(deprecated) alias for global \fI\-v\fP option +.UNINDENT +.TP +.B du [options] <path> [<path>..] +Calculate disk usage of the target files using FIEMAP. For individual +files, it will report a count of total bytes, and exclusive (not +shared) bytes. We also calculate a \(aqset shared\(aq value which is +described below. +.sp +Each argument to \fBbtrfs filesystem du\fP will have a \fIset shared\fP value +calculated for it. We define each \fIset\fP as those files found by a +recursive search of an argument (recursion descends to subvolumes but not +mount points). The \fIset shared\fP value then is a sum of all shared space +referenced by the set. +.sp +\fIset shared\fP takes into account overlapping shared extents, hence it +isn\(aqt as simple as adding up shared extents. +.sp +\fBOptions\fP +.INDENT 7.0 +.TP +.B \-s|\-\-summarize +display only a total for each argument +.UNINDENT +.INDENT 7.0 +.TP +.B \-\-raw +raw numbers in bytes, without the \fIB\fP suffix. +.TP +.B \-\-human\-readable +print human friendly numbers, base 1024, this is the default +.TP +.B \-\-iec +select the 1024 base for the following options, according to the IEC standard. +.TP +.B \-\-si +select the 1000 base for the following options, according to the SI standard. +.TP +.B \-\-kbytes +show sizes in KiB, or kB with \-\-si. +.TP +.B \-\-mbytes +show sizes in MiB, or MB with \-\-si. +.TP +.B \-\-gbytes +show sizes in GiB, or GB with \-\-si. +.TP +.B \-\-tbytes +show sizes in TiB, or TB with \-\-si. +.UNINDENT +.TP +.B label [<device>|<mountpoint>] [<newlabel>] +Show or update the label of a filesystem. This works on a mounted filesystem or +a filesystem image. +.sp +The \fInewlabel\fP argument is optional. Current label is printed if the argument +is omitted. +.sp +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +The maximum allowable length shall be less than 256 chars and must not contain +a newline. The trailing newline is stripped automatically. +.UNINDENT +.UNINDENT +.TP +.B mkswapfile [\-s size] file +Create a new file that\(aqs suitable and formatted as a swapfile. Default +size is 2GiB, fixed page size 4KiB, minimum size is 40KiB. +.sp +A swapfile must be created in a specific way: NOCOW and preallocated. +Subvolume containing a swapfile cannot be snapshotted and blocks of an +activated swapfile cannot be balanced. +.sp +Swapfile creation can be achieved by standalone commands too. Activation +needs to be done by command \fBswapon(8)\fP\&. See also command +\fBbtrfs inspect\-internal map\-swapfile\fP +and the \fI\%Swapfile feature\fP description. +.sp +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +The command is a simplified version of \(aqmkswap\(aq, if you want to set +label, page size, or other parameters please use \(aqmkswap\(aq proper. +.UNINDENT +.UNINDENT +.sp +\fBOptions\fP +.INDENT 7.0 +.TP +.B \-s|\-\-size SIZE +Create swapfile of a given size SIZE (accepting k/m/g/e/p +suffix). +.TP +.B \-U|\-\-uuid UUID +specify UUID to use, or a special value: clear (all zeros), random, +time (time\-based random) +.UNINDENT +.UNINDENT +.INDENT 0.0 +.TP +.B resize [options] [<devid>:][+/\-]<size>[kKmMgGtTpPeE]|[<devid>:]max <path> +Resize a mounted filesystem identified by \fIpath\fP\&. A particular device +can be resized by specifying a \fIdevid\fP\&. +.sp +\fBWARNING:\fP +.INDENT 7.0 +.INDENT 3.5 +If \fIpath\fP is a file containing a BTRFS image then resize does not work +as expected and does not resize the image. This would resize the underlying +filesystem instead. +.UNINDENT +.UNINDENT +.sp +The \fIdevid\fP can be found in the output of \fBbtrfs filesystem show\fP and +defaults to 1 if not specified. +The \fIsize\fP parameter specifies the new size of the filesystem. +If the prefix \fI+\fP or \fI\-\fP is present the size is increased or decreased +by the quantity \fIsize\fP\&. +If no units are specified, bytes are assumed for \fIsize\fP\&. +Optionally, the size parameter may be suffixed by one of the following +unit designators: \fIK\fP, \fIM\fP, \fIG\fP, \fIT\fP, \fIP\fP, or \fIE\fP, which represent +KiB, MiB, GiB, TiB, PiB, or EiB, respectively (case does not matter). +.sp +If \fImax\fP is passed, the filesystem will occupy all available space on the +device respecting \fIdevid\fP (remember, devid 1 by default). +.sp +The resize command does not manipulate the size of underlying +partition. If you wish to enlarge/reduce a filesystem, you must make sure you +can expand the partition before enlarging the filesystem and shrink the +partition after reducing the size of the filesystem. This can done using +\fBfdisk(8)\fP or \fBparted(8)\fP to delete the existing partition and recreate +it with the new desired size. When recreating the partition make sure to use +the same starting partition offset as before. +.sp +Growing is usually instant as it only updates the size. However, shrinking could +take a long time if there are data in the device area that\(aqs beyond the new +end. Relocation of the data takes time. +.sp +See also section \fIEXAMPLES\fP\&. +.sp +\fBOptions\fP +.INDENT 7.0 +.TP +.B \-\-enqueue +wait if there\(aqs another exclusive operation running, otherwise continue +.UNINDENT +.TP +.B show [options] [<path>|<uuid>|<device>|<label>] +Show the btrfs filesystem with some additional info about devices and space +allocation. +.sp +If no option none of \fIpath\fP/\fIuuid\fP/\fIdevice\fP/\fIlabel\fP is passed, information +about all the BTRFS filesystems is shown, both mounted and unmounted. +.sp +\fBOptions\fP +.INDENT 7.0 +.TP +.B \-m|\-\-mounted +probe kernel for mounted BTRFS filesystems +.TP +.B \-d|\-\-all\-devices +scan all devices under \fB/dev\fP, otherwise the devices list is extracted from the +\fB/proc/partitions\fP file. This is a fallback option if there\(aqs no device node +manager (like udev) available in the system. +.UNINDENT +.INDENT 7.0 +.TP +.B \-\-raw +raw numbers in bytes, without the \fIB\fP suffix +.TP +.B \-\-human\-readable +print human friendly numbers, base 1024, this is the default +.TP +.B \-\-iec +select the 1024 base for the following options, according to the IEC standard +.TP +.B \-\-si +select the 1000 base for the following options, according to the SI standard +.TP +.B \-\-kbytes +show sizes in KiB, or kB with \-\-si +.TP +.B \-\-mbytes +show sizes in MiB, or MB with \-\-si +.TP +.B \-\-gbytes +show sizes in GiB, or GB with \-\-si +.TP +.B \-\-tbytes +show sizes in TiB, or TB with \-\-si +.UNINDENT +.TP +.B sync <path> +Force a sync of the filesystem at \fIpath\fP, similar to the \fBsync(1)\fP command. In +addition, it starts cleaning of deleted subvolumes. To wait for the subvolume +deletion to complete use the \fBbtrfs subvolume sync\fP command. +.TP +.B usage [options] <path> [<path>...] +Show detailed information about internal filesystem usage. This is supposed to +replace the \fBbtrfs filesystem df\fP command in the long run. +.sp +The level of detail can differ if the command is run under a regular or the +root user (due to use of restricted ioctl). For both there\(aqs a summary section +with information about space usage: +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +$ btrfs filesystem usage /path +WARNING: cannot read detailed chunk info, RAID5/6 numbers will be incorrect, run as root +Overall: + Device size: 1.82TiB + Device allocated: 1.17TiB + Device unallocated: 669.99GiB + Device missing: 0.00B + Device slack: 1.00GiB + Used: 1.14TiB + Free (estimated): 692.57GiB (min: 692.57GiB) + Free (statfs, df) 692.57GiB + Data ratio: 1.00 + Metadata ratio: 1.00 + Global reserve: 512.00MiB (used: 0.00B) + Multiple profiles: no +.ft P +.fi +.UNINDENT +.UNINDENT +.INDENT 7.0 +.IP \(bu 2 +\fIDevice size\fP \-\- sum of raw device capacity available to the +filesystem, note that this may not be the same as the total device +size (the difference is accounted as slack) +.IP \(bu 2 +\fIDevice allocated\fP \-\- sum of total space allocated for +data/metadata/system profiles, this also accounts space reserved but +not yet used for extents +.IP \(bu 2 +\fIDevice unallocated\fP \-\- the remaining unallocated space for future +allocations (difference of the above two numbers) +.IP \(bu 2 +\fIDevice missing\fP \-\- sum of capacity of all missing devices +.IP \(bu 2 +\fIDevice slack\fP \-\- sum of slack space on all devices (difference +between entire device size and the space occupied by filesystem) +.IP \(bu 2 +\fIUsed\fP \-\- sum of the used space of data/metadata/system profiles, not +including the reserved space +.IP \(bu 2 +\fIFree (estimated)\fP \-\- approximate size of the remaining free space +usable for data, including currently allocated space and estimating +the usage of the unallocated space based on the block group profiles, +the \fImin\fP is the lower bound of the estimate in case multiple +profiles are present +.IP \(bu 2 +\fIFree (statfs, df)\fP \-\- the amount of space available for data as +reported by the \fBstatfs\fP syscall, also returned as \fIAvail\fP in the +output of \fBdf\fP\&. The value is calculated in a different way and may +not match the estimate in some cases (e.g. multiple profiles). +.IP \(bu 2 +\fIData ratio\fP \-\- ratio of total space for data including redundancy or +parity to the effectively usable data space, e.g. single is 1.0, RAID1 +is 2.0 and for RAID5/6 it depends on the number of devices +.IP \(bu 2 +\fIMetadata ratio\fP \-\- ditto, for metadata +.IP \(bu 2 +\fIGlobal reserve\fP \-\- portion of metadata currently used for global +block reserve, used for emergency purposes (like deletion on a full +filesystem) +.IP \(bu 2 +\fIMultiple profiles\fP \-\- what block group types (data, metadata) have +more than one profile (single, raid1, ...), see \fI\%btrfs(5)\fP section +\fI\%FILESYSTEMS WITH MULTIPLE PROFILES\fP\&. +.UNINDENT +.sp +And on a zoned filesystem there are two more lines in the \fIDevice\fP section: +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +Device zone unusable: 5.13GiB +Device zone size: 256.00MiB +.ft P +.fi +.UNINDENT +.UNINDENT +.INDENT 7.0 +.IP \(bu 2 +\fIDevice zone unusable\fP \-\- sum of of space that\(aqs been used in the +past but now is not due to COW and not referenced anymore, the chunks +have to be reclaimed and zones reset to make it usable again +.IP \(bu 2 +\fIDevice zone size\fP \-\- the reported zone size of the host\-managed +device, same for all devices +.UNINDENT +.sp +The root user will also see stats broken down by block group types: +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +Data,single: Size:1.15TiB, Used:1.13TiB (98.26%) + /dev/sdb 1.15TiB + +Metadata,single: Size:12.00GiB, Used:6.45GiB (53.75%) + /dev/sdb 12.00GiB + +System,single: Size:32.00MiB, Used:144.00KiB (0.44%) + /dev/sdb 32.00MiB + +Unallocated: + /dev/sdb 669.99GiB +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +\fIData\fP is block group type, \fIsingle\fP is block group profile, \fISize\fP is total +size occupied by this type, \fIUsed\fP is the actually used space, the percent is +ratio of \fIUsed/Size\fP\&. The \fIUnallocated\fP is remaining space. +.sp +\fBOptions\fP +.INDENT 7.0 +.TP +.B \-b|\-\-raw +raw numbers in bytes, without the \fIB\fP suffix +.TP +.B \-h|\-\-human\-readable +print human friendly numbers, base 1024, this is the default +.UNINDENT +.INDENT 7.0 +.TP +.B \-H +print human friendly numbers, base 1000 +.TP +.B \-\-iec +select the 1024 base for the following options, according to the IEC standard +.TP +.B \-\-si +select the 1000 base for the following options, according to the SI standard +.UNINDENT +.INDENT 7.0 +.TP +.B \-k|\-\-kbytes +show sizes in KiB, or kB with \-\-si +.TP +.B \-m|\-\-mbytes +show sizes in MiB, or MB with \-\-si +.TP +.B \-g|\-\-gbytes +show sizes in GiB, or GB with \-\-si +.TP +.B \-t|\-\-tbytes +show sizes in TiB, or TB with \-\-si +.UNINDENT +.INDENT 7.0 +.TP +.B \-T +show data in tabular format +.UNINDENT +.sp +If conflicting options are passed, the last one takes precedence. +.UNINDENT +.SH EXAMPLES +.sp +\fB$ btrfs filesystem defrag \-v \-r dir/\fP +.sp +Recursively defragment files under \fBdir/\fP, print files as they are processed. +The file names will be printed in batches, similarly the amount of data triggered +by defragmentation will be proportional to last N printed files. The system dirty +memory throttling will slow down the defragmentation but there can still be a lot +of IO load and the system may stall for a moment. +.sp +\fB$ btrfs filesystem defrag \-v \-r \-f dir/\fP +.sp +Recursively defragment files under \fBdir/\fP, be verbose and wait until all blocks +are flushed before processing next file. You can note slower progress of the +output and lower IO load (proportional to currently defragmented file). +.sp +\fB$ btrfs filesystem defrag \-v \-r \-f \-clzo dir/\fP +.sp +Recursively defragment files under \fBdir/\fP, be verbose, wait until all blocks are +flushed and force file compression. +.sp +\fB$ btrfs filesystem defrag \-v \-r \-t 64M dir/\fP +.sp +Recursively defragment files under \fBdir/\fP, be verbose and try to merge extents +to be about 64MiB. As stated above, the success rate depends on actual free +space fragmentation and the final result is not guaranteed to meet the target +even if run repeatedly. +.sp +\fB$ btrfs filesystem resize \-1G /path\fP +.sp +\fB$ btrfs filesystem resize 1:\-1G /path\fP +.sp +Shrink size of the filesystem\(aqs device id 1 by 1GiB. The first syntax expects a +device with id 1 to exist, otherwise fails. The second is equivalent and more +explicit. For a single\-device filesystem it\(aqs typically not necessary to +specify the devid though. +.sp +\fB$ btrfs filesystem resize max /path\fP +.sp +\fB$ btrfs filesystem resize 1:max /path\fP +.sp +Let\(aqs assume that devid 1 exists and the filesystem does not occupy the whole +block device, e.g. it has been enlarged and we want to grow the filesystem. By +simply using \fImax\fP as size we will achieve that. +.sp +\fBNOTE:\fP +.INDENT 0.0 +.INDENT 3.5 +There are two ways to minimize the filesystem on a given device. The +\fBbtrfs inspect\-internal min\-dev\-size\fP command, or iteratively shrink in steps. +.UNINDENT +.UNINDENT +.SH EXIT STATUS +.sp +\fBbtrfs filesystem\fP returns a zero exit status if it succeeds. Non zero is +returned in case of failure. +.SH AVAILABILITY +.sp +\fBbtrfs\fP is part of btrfs\-progs. Please refer to the documentation at +\fI\%https://btrfs.readthedocs.io\fP\&. +.SH SEE ALSO +.sp +\fI\%btrfs\-subvolume(8)\fP, +\fI\%mkfs.btrfs(8)\fP +.\" Generated by docutils manpage writer. +. diff --git a/upstream/opensuse-leap-15-6/man8/btrfs-image.8 b/upstream/opensuse-leap-15-6/man8/btrfs-image.8 new file mode 100644 index 00000000..6a7654a2 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/btrfs-image.8 @@ -0,0 +1,90 @@ +.\" Man page generated from reStructuredText. +. +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.TH "BTRFS-IMAGE" "8" "Sep 13, 2023" "6.5.1" "BTRFS" +.SH NAME +btrfs-image \- create/restore an image of the filesystem +.SH SYNOPSIS +.sp +\fBbtrfs\-image\fP [options] <source> <target> +.SH DESCRIPTION +.sp +\fBbtrfs\-image\fP is used to create an image of a btrfs filesystem. +All data will be zeroed, but metadata and the like is preserved. +Mainly used for debugging purposes. +.sp +In the dump mode, source is the btrfs device/file and target is the output +file (use \fI\-\fP for stdout). +.sp +In the restore mode (option \fI\-r\fP), source is the dumped image and target is the btrfs device/file. +.SH OPTIONS +.INDENT 0.0 +.TP +.B \-r +Restore metadump image. By default, this fixes super\(aqs chunk tree, by +using 1 stripe pointing to primary device, so that file system can be +restored by running tree log reply if possible. To restore without +changing number of stripes in chunk tree check \fI\-o\fP option. +.TP +.BI \-c \ <value> +Compression level (0 ~ 9). +.TP +.BI \-t \ <value> +Number of threads (1 ~ 32) to be used to process the image dump or restore. +.TP +.B \-o +Use the old restore method, this does not fixup the chunk tree so the restored +file system will not be able to be mounted. +.TP +.B \-s +Sanitize the file names when generating the image. One \-s means just +generate random garbage, which means that the directory indexes won\(aqt match up +since the hashes won\(aqt match with the garbage filenames. Using \fI\-s\fP will +calculate a collision for the filename so that the hashes match, and if it +can\(aqt calculate a collision then it will just generate garbage. The collision +calculator is very time and CPU intensive so only use it if you are having +problems with your file system tree and need to have it mostly working. +.TP +.B \-w +Walk all the trees manually and copy any blocks that are referenced. Use this +option if your extent tree is corrupted to make sure that all of the metadata is +captured. +.TP +.B \-m +Restore for multiple devices, more than 1 device should be provided. +.UNINDENT +.SH EXIT STATUS +.sp +\fBbtrfs\-image\fP will return 0 if no error happened. +If any problems happened, 1 will be returned. +.SH SEE ALSO +.sp +\fI\%mkfs.btrfs(8)\fP +.\" Generated by docutils manpage writer. +. diff --git a/upstream/opensuse-leap-15-6/man8/btrfs-inspect-internal.8 b/upstream/opensuse-leap-15-6/man8/btrfs-inspect-internal.8 new file mode 100644 index 00000000..9ab78841 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/btrfs-inspect-internal.8 @@ -0,0 +1,336 @@ +.\" Man page generated from reStructuredText. +. +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.TH "BTRFS-INSPECT-INTERNAL" "8" "Sep 13, 2023" "6.5.1" "BTRFS" +.SH NAME +btrfs-inspect-internal \- query various internal information +.SH SYNOPSIS +.sp +\fBbtrfs inspect\-internal\fP <subcommand> <args> +.SH DESCRIPTION +.sp +This command group provides an interface to query internal information. The +functionality ranges from a simple UI to an ioctl or a more complex query that +assembles the result from several internal structures. The latter usually +requires calls to privileged ioctls. +.SH SUBCOMMAND +.INDENT 0.0 +.TP +.B dump\-super [options] <device> [device...] +Show btrfs superblock information stored on given devices in textual form. +By default the first superblock is printed, more details about all copies or +additional backup data can be printed. +.sp +Besides verification of the filesystem signature, there are no other sanity +checks. The superblock checksum status is reported, the device item and +filesystem UUIDs are checked and reported. +.sp +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +The meaning of option \fI\-s\fP has changed in version 4.8 to be consistent +with other tools to specify superblock copy rather the offset. The old way still +works, but prints a warning. Please update your scripts to use \fI\-\-bytenr\fP +instead. The option \fI\-i\fP has been deprecated. +.UNINDENT +.UNINDENT +.sp +\fBOptions\fP +.INDENT 7.0 +.TP +.B \-f|\-\-full +print full superblock information, including the system chunk array and backup roots +.TP +.B \-a|\-\-all +print information about all present superblock copies (cannot be used together +with \fI\-s\fP option) +.UNINDENT +.INDENT 7.0 +.TP +.BI \-i \ <super> +(deprecated since 4.8, same behaviour as \fI\-\-super\fP) +.TP +.BI \-\-bytenr \ <bytenr> +specify offset to a superblock in a non\-standard location at \fIbytenr\fP, useful +for debugging (disables the \fI\-f\fP option) +.sp +If there are multiple options specified, only the last one applies. +.UNINDENT +.INDENT 7.0 +.TP +.B \-F|\-\-force +attempt to print the superblock even if a valid BTRFS signature is not found; +the result may be completely wrong if the data does not resemble a superblock +.TP +.B \-s|\-\-super <bytenr> +(see compatibility note above) +.sp +specify which mirror to print, valid values are 0, 1 and 2 and the superblock +must be present on the device with a valid signature, can be used together with +\fI\-\-force\fP +.UNINDENT +.TP +.B dump\-tree [options] <device> [device...] +Dump tree structures from a given device in textual form, expand keys to human +readable equivalents where possible. +This is useful for analyzing filesystem state or inconsistencies and has +a positive educational effect on understanding the internal filesystem structure. +.sp +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +Contains file names, consider that if you\(aqre asked to send the dump for +analysis. Does not contain file data. +.UNINDENT +.UNINDENT +.sp +\fBOptions\fP +.INDENT 7.0 +.TP +.B \-e|\-\-extents +print only extent\-related information: extent and device trees +.TP +.B \-d|\-\-device +print only device\-related information: tree root, chunk and device trees +.TP +.B \-r|\-\-roots +print only short root node information, i.e. the root tree keys +.TP +.B \-R|\-\-backups +same as \fI\-\-roots\fP plus print backup root info, i.e. the backup root keys and +the respective tree root block offset +.TP +.B \-u|\-\-uuid +print only the uuid tree information, empty output if the tree does not exist +.UNINDENT +.INDENT 7.0 +.TP +.BI \-b \ <block_num> +print info of the specified block only, can be specified multiple times +.TP +.B \-\-follow +use with \fI\-b\fP, print all children tree blocks of \fI<block_num>\fP +.TP +.B \-\-dfs +(default up to 5.2) +.sp +use depth\-first search to print trees, the nodes and leaves are +intermixed in the output +.TP +.B \-\-bfs +(default since 5.3) +.sp +use breadth\-first search to print trees, the nodes are printed before all +leaves +.TP +.B \-\-hide\-names +print a placeholder \fIHIDDEN\fP instead of various names, useful for developers to +inspect the dump while keeping potentially sensitive information hidden +.sp +This is: +.INDENT 7.0 +.IP \(bu 2 +directory entries (files, directories, subvolumes) +.IP \(bu 2 +default subvolume +.IP \(bu 2 +extended attributes (name, value) +.IP \(bu 2 +hardlink names (if stored inside another item or as extended references in standalone items) +.UNINDENT +.sp +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +Lengths are not hidden because they can be calculated from the item size anyway. +.UNINDENT +.UNINDENT +.TP +.B \-\-csum\-headers +print b\-tree node checksums stored in headers (metadata) +.TP +.B \-\-csum\-items +print checksums stored in checksum items (data) +.TP +.B \-\-noscan +do not automatically scan the system for other devices from the same +filesystem, only use the devices provided as the arguments +.TP +.BI \-t \ <tree_id> +print only the tree with the specified ID, where the ID can be numerical or +common name in a flexible human readable form +.sp +The tree id name recognition rules: +.INDENT 7.0 +.IP \(bu 2 +case does not matter +.IP \(bu 2 +the C source definition, e.g. BTRFS_ROOT_TREE_OBJECTID +.IP \(bu 2 +short forms without BTRFS_ prefix, without _TREE and _OBJECTID suffix, e.g. ROOT_TREE, ROOT +.IP \(bu 2 +convenience aliases, e.g. DEVICE for the DEV tree, CHECKSUM for CSUM +.IP \(bu 2 +unrecognized ID is an error +.UNINDENT +.UNINDENT +.TP +.B inode\-resolve [\-v] <ino> <path> +(needs root privileges) +.sp +resolve paths to all files with given inode number \fIino\fP in a given subvolume +at \fIpath\fP, i.e. all hardlinks +.sp +\fBOptions\fP +.INDENT 7.0 +.TP +.B \-v +(deprecated) alias for global \fI\-v\fP option +.UNINDENT +.TP +.B logical\-resolve [\-Pvo] [\-s <bufsize>] <logical> <path> +(needs root privileges) +.sp +resolve paths to all files at given \fIlogical\fP address in the linear filesystem space +.sp +\fBOptions\fP +.INDENT 7.0 +.TP +.B \-P +skip the path resolving and print the inodes instead +.TP +.B \-o +ignore offsets, find all references to an extent instead of a single block. +Requires kernel support for the V2 ioctl (added in 4.15). The results might need +further processing to filter out unwanted extents by the offset that is supposed +to be obtained by other means. +.TP +.BI \-s \ <bufsize> +set internal buffer for storing the file names to \fIbufsize\fP, default is 64KiB, +maximum 16MiB. Buffer sizes over 64Kib require kernel support for the V2 ioctl +(added in 4.15). +.TP +.B \-v +(deprecated) alias for global \fI\-v\fP option +.UNINDENT +.UNINDENT +.INDENT 0.0 +.TP +.B map\-swapfile [options] <file> +(needs root privileges) +.sp +Find device\-specific physical offset of \fIfile\fP that can be used for +hibernation. Also verify that the \fIfile\fP is suitable as a swapfile. +See also command \fBbtrfs filesystem mkswapfile\fP and the +\fI\%Swapfile feature\fP description. +.sp +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +Do not use \fBfilefrag\fP or \fIFIEMAP\fP ioctl values reported as +physical, this is different due to internal filesystem mappings. +The hibernation expects offset relative to the physical block device. +.UNINDENT +.UNINDENT +.sp +\fBOptions\fP +.INDENT 7.0 +.TP +.B \-r|\-\-resume\-offset +print only the value suitable as resume offset for file \fI/sys/power/resume_offset\fP +.UNINDENT +.TP +.B min\-dev\-size [options] <path> +(needs root privileges) +.sp +return the minimum size the device can be shrunk to, without performing any +resize operation, this may be useful before executing the actual resize operation +.sp +\fBOptions\fP +.INDENT 7.0 +.TP +.BI \-\-id \ <id> +specify the device \fIid\fP to query, default is 1 if this option is not used +.UNINDENT +.UNINDENT +.INDENT 0.0 +.TP +.B rootid <path> +for a given file or directory, return the containing tree root id, but for a +subvolume itself return its own tree id (i.e. subvol id) +.sp +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +The result is undefined for the so\-called empty subvolumes (identified by +inode number 2), but such a subvolume does not contain any files anyway +.UNINDENT +.UNINDENT +.TP +.B subvolid\-resolve <subvolid> <path> +(needs root privileges) +.sp +resolve the absolute path of the subvolume id \fIsubvolid\fP +.TP +.B tree\-stats [options] <device> +(needs root privileges) +.sp +Print sizes and statistics of trees. This takes a device as an argument +and not a mount point unlike other commands. +.sp +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +In case the the filesystem is still mounted it\(aqs possible to +run the command but the results may be inaccurate or various +errors may be printed in case there are ongoing writes to the +filesystem. A warning is printed in such case. +.UNINDENT +.UNINDENT +.sp +\fBOptions\fP +.INDENT 7.0 +.TP +.B \-b +Print raw numbers in bytes. +.UNINDENT +.UNINDENT +.SH EXIT STATUS +.sp +\fBbtrfs inspect\-internal\fP returns a zero exit status if it succeeds. Non zero is +returned in case of failure. +.SH AVAILABILITY +.sp +\fBbtrfs\fP is part of btrfs\-progs. Please refer to the documentation at +\fI\%https://btrfs.readthedocs.io\fP\&. +.SH SEE ALSO +.sp +\fI\%mkfs.btrfs(8)\fP +.\" Generated by docutils manpage writer. +. diff --git a/upstream/opensuse-leap-15-6/man8/btrfs-map-logical.8 b/upstream/opensuse-leap-15-6/man8/btrfs-map-logical.8 new file mode 100644 index 00000000..c6e79e67 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/btrfs-map-logical.8 @@ -0,0 +1,65 @@ +.\" Man page generated from reStructuredText. +. +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.TH "BTRFS-MAP-LOGICAL" "8" "Sep 13, 2023" "6.5.1" "BTRFS" +.SH NAME +btrfs-map-logical \- map btrfs logical extent to physical extent +.SH SYNOPSIS +.sp +\fBbtrfs\-map\-logical\fP <options> <device> +.SH DESCRIPTION +.sp +\fBbtrfs\-map\-logical\fP can be used to find out what the physical offsets are +on the mirrors, the result is dumped to stdout by default. +.sp +Mainly used for debug purpose. +.SH OPTIONS +.INDENT 0.0 +.TP +.B \-l|\-\-logical <logical_num> +Logical extent to map. +.TP +.B \-c|\-\-copy <copy> +Copy of the extent to read(usually 1 or 2). +.TP +.B \-o|\-\-output <filename> +Output file to hold the extent. +.TP +.B \-b|\-\-bytes <bytes> +Number of bytes to read. +.UNINDENT +.SH EXIT STATUS +.sp +\fBbtrfs\-map\-logical\fP will return 0 if no error happened. +If any problems happened, 1 will be returned. +.SH SEE ALSO +.sp +\fI\%mkfs.btrfs(8)\fP +.\" Generated by docutils manpage writer. +. diff --git a/upstream/opensuse-leap-15-6/man8/btrfs-property.8 b/upstream/opensuse-leap-15-6/man8/btrfs-property.8 new file mode 100644 index 00000000..89e06073 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/btrfs-property.8 @@ -0,0 +1,178 @@ +.\" Man page generated from reStructuredText. +. +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.TH "BTRFS-PROPERTY" "8" "Sep 13, 2023" "6.5.1" "BTRFS" +.SH NAME +btrfs-property \- get/set/list properties for given filesystem object +.SH SYNOPSIS +.sp +\fBbtrfs property\fP <subcommand> <args> +.SH DESCRIPTION +.sp +\fBbtrfs property\fP is used to get/set/list property for given filesystem object. +The object can be an inode (file or directory), subvolume or the whole +filesystem. +.sp +\fBbtrfs property\fP provides an unified and user\-friendly method to tune different +btrfs properties instead of using the traditional method like \fBchattr(1)\fP or +\fBlsattr(1)\fP\&. +.SS Object types +.sp +A property might apply to several object types so in some cases it\(aqs necessary +to specify that explicitly, however it\(aqs not needed in the most common case of +files and directories. +.sp +The subcommands take parameter \fI\-t\fP, use first letter as a shortcut (\fIf/s/d/i\fP) +of the type: +.INDENT 0.0 +.IP \(bu 2 +filesystem +.IP \(bu 2 +subvolume +.IP \(bu 2 +device +.IP \(bu 2 +inode (file or directory) +.UNINDENT +.SS Inode properties +.INDENT 0.0 +.TP +.B compression +compression algorithm set for an inode (it\(aqs not possible to set the +compression level this way), possible values: +.INDENT 7.0 +.IP \(bu 2 +\fIlzo\fP +.IP \(bu 2 +\fIzlib\fP +.IP \(bu 2 +\fIzstd\fP +.IP \(bu 2 +\fIno\fP or \fInone\fP \- disable compression (equivalent to \fBchattr +m\fP) +.IP \(bu 2 +\fI\(dq\(dq\fP (empty string) \- set the default value +.INDENT 2.0 +.INDENT 3.5 +.sp +\fBNOTE:\fP +.INDENT 0.0 +.INDENT 3.5 +This has changed in version 5.18 of btrfs\-progs and +requires kernel 5.14 or newer to work. +.UNINDENT +.UNINDENT +.UNINDENT +.UNINDENT +.UNINDENT +.UNINDENT +.SS Subvolume properties +.INDENT 0.0 +.TP +.B ro +read\-only flag of subvolume: true or false. Please also see section \fISUBVOLUME FLAGS\fP +in \fI\%btrfs\-subvolume(8)\fP for possible implications regarding incremental send. +.UNINDENT +.SS Filesystem properties +.INDENT 0.0 +.TP +.B label +label of the filesystem. For an unmounted filesystem, provide a path to a block +device as object. For a mounted filesystem, specify a mount point. +.UNINDENT +.SH SUBCOMMAND +.INDENT 0.0 +.TP +.B get [\-t <type>] <object> [<name>] +Read value of a property \fIname\fP of btrfs \fIobject\fP of given \fItype\fP, +empty \fIname\fP will read all of them +.TP +.B list [\-t <type>] <object> +List available properties with their descriptions for the given object. +.TP +.B set [\-f] [\-t <type>] <object> <name> <value> +Set \fIvalue\fP of property \fIname\fP on a given btrfs object. +.sp +\fBOptions\fP +.INDENT 7.0 +.TP +.B \-f +Force the change. Changing some properties may involve safety checks or +additional changes that depend on the properties semantics. +.UNINDENT +.UNINDENT +.SH EXAMPLES +.sp +Set compression on a file: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +$ touch file1 +$ btrfs prop get file1 +[ empty output ] +$ btrfs prop set file1 compression zstd +$ btrfs prop get file1 +compression=zstd +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Make a writeable subvolume read\-only: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +$ btrfs subvol create subvol1 +[ fill subvol1 with data ] +$ btrfs prop get subvol1 +ro=false +$ btrfs prop set subvol1 ro true +ro=true +.ft P +.fi +.UNINDENT +.UNINDENT +.SH EXIT STATUS +.sp +\fBbtrfs property\fP returns a zero exit status if it succeeds. Non zero is +returned in case of failure. +.SH AVAILABILITY +.sp +\fBbtrfs\fP is part of btrfs\-progs. Please refer to the documentation at +\fI\%https://btrfs.readthedocs.io\fP\&. +.SH SEE ALSO +.sp +\fI\%mkfs.btrfs(8)\fP, +\fBlsattr(1)\fP, +\fBchattr(1)\fP +.\" Generated by docutils manpage writer. +. diff --git a/upstream/opensuse-leap-15-6/man8/btrfs-qgroup.8 b/upstream/opensuse-leap-15-6/man8/btrfs-qgroup.8 new file mode 100644 index 00000000..bae97fe5 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/btrfs-qgroup.8 @@ -0,0 +1,316 @@ +.\" Man page generated from reStructuredText. +. +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.TH "BTRFS-QGROUP" "8" "Sep 13, 2023" "6.5.1" "BTRFS" +.SH NAME +btrfs-qgroup \- control the quota group of a btrfs filesystem +.SH SYNOPSIS +.sp +\fBbtrfs qgroup\fP <subcommand> <args> +.SH DESCRIPTION +.sp +\fBbtrfs qgroup\fP is used to control quota group (qgroup) of a btrfs filesystem. +.sp +\fBNOTE:\fP +.INDENT 0.0 +.INDENT 3.5 +To use qgroup you need to enable quota first using \fBbtrfs quota enable\fP +command. +.UNINDENT +.UNINDENT +.sp +\fBWARNING:\fP +.INDENT 0.0 +.INDENT 3.5 +Qgroup is not stable yet and will impact performance in current mainline +kernel (v4.14). +.UNINDENT +.UNINDENT +.SH QGROUP +.sp +Quota groups or qgroup in btrfs make a tree hierarchy, the leaf qgroups are +attached to subvolumes. The size limits are set per qgroup and apply when any +limit is reached in tree that contains a given subvolume. +.sp +The limits are separated between shared and exclusive and reflect the extent +ownership. For example a fresh snapshot shares almost all the blocks with the +original subvolume, new writes to either subvolume will raise towards the +exclusive limit. +.sp +The qgroup identifiers conform to \fIlevel/id\fP where level 0 is reserved to the +qgroups associated with subvolumes. Such qgroups are created automatically. +.sp +The qgroup hierarchy is built by commands \fBcreate\fP and \fBassign\fP\&. +.sp +\fBNOTE:\fP +.INDENT 0.0 +.INDENT 3.5 +If the qgroup of a subvolume is destroyed, quota about the subvolume will +not be functional until qgroup \fI0/<subvolume id>\fP is created again. +.UNINDENT +.UNINDENT +.SH SUBCOMMAND +.INDENT 0.0 +.TP +.B assign [options] <src> <dst> <path> +Assign qgroup \fIsrc\fP as the child qgroup of \fIdst\fP in the btrfs filesystem +identified by \fIpath\fP\&. +.sp +\fBOptions\fP +.INDENT 7.0 +.TP +.B \-\-rescan +(default since: 4.19) Automatically schedule quota rescan if the new qgroup +assignment would lead to quota inconsistency. See \fIQUOTA RESCAN\fP for more +information. +.TP +.B \-\-no\-rescan +Explicitly ask not to do a rescan, even if the assignment will make the quotas +inconsistent. This may be useful for repeated calls where the rescan would add +unnecessary overhead. +.UNINDENT +.TP +.B create <qgroupid> <path> +Create a subvolume quota group. +.sp +For the \fI0/<subvolume id>\fP qgroup, a qgroup can be created even before the +subvolume is created. +.TP +.B destroy <qgroupid> <path> +Destroy a qgroup. +.sp +If a qgroup is not isolated, meaning it is a parent or child qgroup, then it +can only be destroyed after the relationship is removed. +.TP +.B clear\-stale <path> +Clear all stale qgroups whose subvolume does not exist anymore, this is the +level 0 qgroup like 0/subvolid. Higher level qgroups are not deleted even +if they don\(aqt have any child qgroups. +.TP +.B limit [options] <size>|none [<qgroupid>] <path> +Limit the size of a qgroup to \fIsize\fP or no limit in the btrfs filesystem +identified by \fIpath\fP\&. +.sp +If \fIqgroupid\fP is not given, qgroup of the subvolume identified by \fIpath\fP +is used if possible. +.sp +\fBOptions\fP +.INDENT 7.0 +.TP +.B \-c +limit amount of data after compression. This is the default, it is currently not +possible to turn off this option. +.TP +.B \-e +limit space exclusively assigned to this qgroup. +.UNINDENT +.TP +.B remove <src> <dst> <path> +Remove the relationship between child qgroup \fIsrc\fP and parent qgroup \fIdst\fP in +the btrfs filesystem identified by \fIpath\fP\&. +.sp +\fBOptions\fP +.INDENT 7.0 +.TP +.B \-\-rescan +(default since: 4.19) Automatically schedule quota rescan if the removed qgroup +relation would lead to quota inconsistency. See \fIQUOTA RESCAN\fP for more +information. +.TP +.B \-\-no\-rescan +Explicitly ask not to do a rescan, even if the removal will make the quotas +inconsistent. This may be useful for repeated calls where the rescan would add +unnecessary overhead. +.UNINDENT +.TP +.B show [options] <path> +Show all qgroups in the btrfs filesystem identified by <path>. +.sp +\fBOptions\fP +.INDENT 7.0 +.TP +.B \-p +print parent qgroup id. +.TP +.B \-c +print child qgroup id. +.TP +.B \-r +print limit of referenced size of qgroup. +.TP +.B \-e +print limit of exclusive size of qgroup. +.TP +.B \-F +list all qgroups which impact the given path(include ancestral qgroups) +.TP +.B \-f +list all qgroups which impact the given path(exclude ancestral qgroups) +.TP +.B \-\-raw +raw numbers in bytes, without the \fIB\fP suffix. +.TP +.B \-\-human\-readable +print human friendly numbers, base 1024, this is the default +.TP +.B \-\-iec +select the 1024 base for the following options, according to the IEC standard. +.TP +.B \-\-si +select the 1000 base for the following options, according to the SI standard. +.TP +.B \-\-kbytes +show sizes in KiB, or kB with \-\-si. +.TP +.B \-\-mbytes +show sizes in MiB, or MB with \-\-si. +.TP +.B \-\-gbytes +show sizes in GiB, or GB with \-\-si. +.TP +.B \-\-tbytes +show sizes in TiB, or TB with \-\-si. +.UNINDENT +.INDENT 7.0 +.TP +.B \-\-sort=[+/\-]<attr>[,[+/\-]<attr>]... +list qgroups in order of <attr>. +.sp +<attr> can be one or more of qgroupid,rfer,excl,max_rfer,max_excl. +.sp +Prefix \fI+\fP means ascending order and \fI\-\fP means descending order of \fIattr\fP\&. +If no prefix is given, use ascending order by default. +.sp +If multiple \fIattr\fP values are given, use comma to separate. +.UNINDENT +.INDENT 7.0 +.TP +.B \-\-sync +To retrieve information after updating the state of qgroups, +force sync of the filesystem identified by \fIpath\fP before getting information. +.UNINDENT +.UNINDENT +.SH QUOTA RESCAN +.sp +The rescan reads all extent sharing metadata and updates the respective qgroups +accordingly. +.sp +The information consists of bytes owned exclusively (\fIexcl\fP) or shared/referred +to (\fIrfer\fP). There\(aqs no explicit information about which extents are shared or +owned exclusively. This means when qgroup relationship changes, extent owners +change and qgroup numbers are no longer consistent unless we do a full rescan. +.sp +However there are cases where we can avoid a full rescan, if a subvolume whose +\fIrfer\fP number equals its \fIexcl\fP number, which means all bytes are exclusively +owned, then assigning/removing this subvolume only needs to add/subtract \fIrfer\fP +number from its parent qgroup. This can speed up the rescan. +.SH EXAMPLES +.SS Make a parent group that has two quota group children +.sp +Given the following filesystem mounted at \fB/mnt/my\-vault\fP +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +Label: none uuid: 60d2ab3b\-941a\-4f22\-8d1a\-315f329797b2 + Total devices 1 FS bytes used 128.00KiB + devid 1 size 5.00GiB used 536.00MiB path /dev/vdb +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Enable quota and create subvolumes. Check subvolume ids. +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +$ cd /mnt/my\-vault +$ btrfs quota enable . +$ btrfs subvolume create a +$ btrfs subvolume create b +$ btrfs subvolume list . + +ID 261 gen 61 top level 5 path a +ID 262 gen 62 top level 5 path b +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Create qgroup and set limit to 10MiB. +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +$ btrfs qgroup create 1/100 . +$ btrfs qgroup limit 10M 1/100 . +$ btrfs qgroup assign 0/261 1/100 . +$ btrfs qgroup assign 0/262 1/100 . +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +And check qgroups. +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +$ btrfs qgroup show . + +qgroupid rfer excl +\-\-\-\-\-\-\-\- \-\-\-\- \-\-\-\- +0/5 16.00KiB 16.00KiB +0/261 16.00KiB 16.00KiB +0/262 16.00KiB 16.00KiB +1/100 32.00KiB 32.00KiB +.ft P +.fi +.UNINDENT +.UNINDENT +.SH EXIT STATUS +.sp +\fBbtrfs qgroup\fP returns a zero exit status if it succeeds. Non zero is +returned in case of failure. +.SH AVAILABILITY +.sp +\fBbtrfs\fP is part of btrfs\-progs. Please refer to the documentation at +\fI\%https://btrfs.readthedocs.io\fP\&. +.SH SEE ALSO +.sp +\fI\%btrfs\-quota(8)\fP, +\fI\%btrfs\-subvolume(8)\fP, +\fI\%mkfs.btrfs(8)\fP +.\" Generated by docutils manpage writer. +. diff --git a/upstream/opensuse-leap-15-6/man8/btrfs-quota.8 b/upstream/opensuse-leap-15-6/man8/btrfs-quota.8 new file mode 100644 index 00000000..3c86a036 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/btrfs-quota.8 @@ -0,0 +1,292 @@ +.\" Man page generated from reStructuredText. +. +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.TH "BTRFS-QUOTA" "8" "Sep 13, 2023" "6.5.1" "BTRFS" +.SH NAME +btrfs-quota \- control the global quota status of a btrfs filesystem +.SH SYNOPSIS +.sp +\fBbtrfs quota\fP <subcommand> <args> +.SH DESCRIPTION +.sp +The commands under \fBbtrfs quota\fP are used to affect the global status of quotas +of a btrfs filesystem. The quota groups (qgroups) are managed by the subcommand +\fI\%btrfs\-qgroup(8)\fP\&. +.sp +\fBNOTE:\fP +.INDENT 0.0 +.INDENT 3.5 +Qgroups are different than the traditional user quotas and designed +to track shared and exclusive data per\-subvolume. Please refer to the section +\fI\%HIERARCHICAL QUOTA GROUP CONCEPTS\fP +for a detailed description. +.UNINDENT +.UNINDENT +.SS PERFORMANCE IMPLICATIONS +.sp +When quotas are activated, they affect all extent processing, which takes a +performance hit. Activation of qgroups is not recommended unless the user +intends to actually use them. +.SS STABILITY STATUS +.sp +The qgroup implementation has turned out to be quite difficult as it affects +the core of the filesystem operation. Qgroup users have hit various corner cases +over time, such as incorrect accounting or system instability. The situation is +gradually improving and issues found and fixed. +.SH HIERARCHICAL QUOTA GROUP CONCEPTS +.sp +The concept of quota has a long\-standing tradition in the Unix world. Ever +since computers allow multiple users to work simultaneously in one filesystem, +there is the need to prevent one user from using up the entire space. Every +user should get his fair share of the available resources. +.sp +In case of files, the solution is quite straightforward. Each file has an +\fIowner\fP recorded along with it, and it has a size. Traditional quota just +restricts the total size of all files that are owned by a user. The concept is +quite flexible: if a user hits his quota limit, the administrator can raise it +on the fly. +.sp +On the other hand, the traditional approach has only a poor solution to +restrict directories. +At installation time, the harddisk can be partitioned so that every directory +(e.g. \fB/usr\fP, \fB/var\fP, ...) that needs a limit gets its own partition. The obvious +problem is that those limits cannot be changed without a reinstallation. The +btrfs subvolume feature builds a bridge. Subvolumes correspond in many ways to +partitions, as every subvolume looks like its own filesystem. With subvolume +quota, it is now possible to restrict each subvolume like a partition, but keep +the flexibility of quota. The space for each subvolume can be expanded or +restricted on the fly. +.sp +As subvolumes are the basis for snapshots, interesting questions arise as to +how to account used space in the presence of snapshots. If you have a file +shared between a subvolume and a snapshot, whom to account the file to? The +creator? Both? What if the file gets modified in the snapshot, should only +these changes be accounted to it? But wait, both the snapshot and the subvolume +belong to the same user home. I just want to limit the total space used by +both! But somebody else might not want to charge the snapshots to the users. +.sp +Btrfs subvolume quota solves these problems by introducing groups of subvolumes +and let the user put limits on them. It is even possible to have groups of +groups. In the following, we refer to them as \fIqgroups\fP\&. +.sp +Each qgroup primarily tracks two numbers, the amount of total referenced +space and the amount of exclusively referenced space. +.INDENT 0.0 +.TP +.B referenced +space is the amount of data that can be reached from any of the +subvolumes contained in the qgroup, while +.TP +.B exclusive +is the amount of data where all references to this data can be reached +from within this qgroup. +.UNINDENT +.SS Subvolume quota groups +.sp +The basic notion of the Subvolume Quota feature is the quota group, short +qgroup. Qgroups are notated as \fIlevel/id\fP, e.g. the qgroup 3/2 is a qgroup of +level 3. For level 0, the leading \fI0/\fP can be omitted. +Qgroups of level 0 get created automatically when a subvolume/snapshot gets +created. The ID of the qgroup corresponds to the ID of the subvolume, so 0/5 +is the qgroup for the root subvolume. +For the \fBbtrfs qgroup\fP command, the path to the subvolume can also be used +instead of \fI0/ID\fP\&. For all higher levels, the ID can be chosen freely. +.sp +Each qgroup can contain a set of lower level qgroups, thus creating a hierarchy +of qgroups. Figure 1 shows an example qgroup tree. +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C + +\-\-\-+ + |2/1| + +\-\-\-+ + / \e + +\-\-\-+/ \e+\-\-\-+ + |1/1| |1/2| + +\-\-\-+ +\-\-\-+ + / \e / \e + +\-\-\-+/ \e+\-\-\-+/ \e+\-\-\-+ +qgroups |0/1| |0/2| |0/3| + +\-+\-+ +\-\-\-+ +\-\-\-+ + | / \e / \e + | / \e / \e + | / \e / \e +extents 1 2 3 4 + +Figure 1: Sample qgroup hierarchy +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +At the bottom, some extents are depicted showing which qgroups reference which +extents. It is important to understand the notion of \fIreferenced\fP vs +\fIexclusive\fP\&. In the example, qgroup 0/2 references extents 2 and 3, while 1/2 +references extents 2\-4, 2/1 references all extents. +.sp +On the other hand, extent 1 is exclusive to 0/1, extent 2 is exclusive to 0/2, +while extent 3 is neither exclusive to 0/2 nor to 0/3. But because both +references can be reached from 1/2, extent 3 is exclusive to 1/2. All extents +are exclusive to 2/1. +.sp +So exclusive does not mean there is no other way to reach the extent, but it +does mean that if you delete all subvolumes contained in a qgroup, the extent +will get deleted. +.sp +Exclusive of a qgroup conveys the useful information how much space will be +freed in case all subvolumes of the qgroup get deleted. +.sp +All data extents are accounted this way. Metadata that belongs to a specific +subvolume (i.e. its filesystem tree) is also accounted. Checksums and extent +allocation information are not accounted. +.sp +In turn, the referenced count of a qgroup can be limited. All writes beyond +this limit will lead to a \(aqQuota Exceeded\(aq error. +.SS Inheritance +.sp +Things get a bit more complicated when new subvolumes or snapshots are created. +The case of (empty) subvolumes is still quite easy. If a subvolume should be +part of a qgroup, it has to be added to the qgroup at creation time. To add it +at a later time, it would be necessary to at least rescan the full subvolume +for a proper accounting. +.sp +Creation of a snapshot is the hard case. Obviously, the snapshot will +reference the exact amount of space as its source, and both source and +destination now have an exclusive count of 0 (the filesystem nodesize to be +precise, as the roots of the trees are not shared). But what about qgroups of +higher levels? If the qgroup contains both the source and the destination, +nothing changes. If the qgroup contains only the source, it might lose some +exclusive. +.sp +But how much? The tempting answer is, subtract all exclusive of the source from +the qgroup, but that is wrong, or at least not enough. There could have been +an extent that is referenced from the source and another subvolume from that +qgroup. This extent would have been exclusive to the qgroup, but not to the +source subvolume. With the creation of the snapshot, the qgroup would also +lose this extent from its exclusive set. +.sp +So how can this problem be solved? In the instant the snapshot gets created, we +already have to know the correct exclusive count. We need to have a second +qgroup that contains all the subvolumes as the first qgroup, except the +subvolume we want to snapshot. The moment we create the snapshot, the +exclusive count from the second qgroup needs to be copied to the first qgroup, +as it represents the correct value. The second qgroup is called a tracking +qgroup. It is only there in case a snapshot is needed. +.SS Use cases +.sp +Below are some use cases that do not mean to be extensive. You can find your +own way how to integrate qgroups. +.SS Single\-user machine +.sp +\fBReplacement for partitions.\fP +The simplest use case is to use qgroups as simple replacement for partitions. +Btrfs takes the disk as a whole, and \fB/\fP, \fB/usr\fP, \fB/var\fP, etc. are created as +subvolumes. As each subvolume gets it own qgroup automatically, they can +simply be restricted. No hierarchy is needed for that. +.sp +\fBTrack usage of snapshots.\fP +When a snapshot is taken, a qgroup for it will automatically be created with +the correct values. \fIReferenced\fP will show how much is in it, possibly shared +with other subvolumes. \fIExclusive\fP will be the amount of space that gets freed +when the subvolume is deleted. +.SS Multi\-user machine +.sp +\fBRestricting homes.\fP +When you have several users on a machine, with home directories probably under +\fB/home\fP, you might want to restrict \fB/home\fP as a whole, while restricting every +user to an individual limit as well. This is easily accomplished by creating a +qgroup for \fB/home\fP , e.g. 1/1, and assigning all user subvolumes to it. +Restricting this qgroup will limit /home, while every user subvolume can get +its own (lower) limit. +.sp +\fBAccounting snapshots to the user.\fP +Let\(aqs say the user is allowed to create snapshots via some mechanism. It would +only be fair to account space used by the snapshots to the user. This does not +mean the user doubles his usage as soon as he takes a snapshot. Of course, +files that are present in his home and the snapshot should only be accounted +once. This can be accomplished by creating a qgroup for each user, say +\fI1/UID\fP\&. The user home and all snapshots are assigned to this qgroup. +Limiting it will extend the limit to all snapshots, counting files only once. +To limit \fB/home\fP as a whole, a higher level group 2/1 replacing 1/1 from the +previous example is needed, with all user qgroups assigned to it. +.sp +\fBDo not account snapshots.\fP +On the other hand, when the snapshots get created automatically, the user has +no chance to control them, so the space used by them should not be accounted to +him. This is already the case when creating snapshots in the example from +the previous section. +.sp +\fBSnapshots for backup purposes.\fP +This scenario is a mixture of the previous two. The user can create snapshots, +but some snapshots for backup purposes are being created by the system. The +user\(aqs snapshots should be accounted to the user, not the system. The solution +is similar to the one from section \fIAccounting snapshots to the user\fP, but do +not assign system snapshots to user\(aqs qgroup. +.SH SUBCOMMAND +.INDENT 0.0 +.TP +.B disable <path> +Disable subvolume quota support for a filesystem. +.TP +.B enable <path> +Enable subvolume quota support for a filesystem. +.TP +.B rescan [options] <path> +Trash all qgroup numbers and scan the metadata again with the current config. +.sp +\fBOptions\fP +.INDENT 7.0 +.TP +.B \-s|\-\-status +show status of a running rescan operation. +.TP +.B \-w|\-\-wait +start rescan and wait for it to finish (can be already in progress) +.TP +.B \-W|\-\-wait\-norescan +wait for rescan to finish without starting it +.UNINDENT +.UNINDENT +.SH EXIT STATUS +.sp +\fBbtrfs quota\fP returns a zero exit status if it succeeds. Non zero is +returned in case of failure. +.SH AVAILABILITY +.sp +\fBbtrfs\fP is part of btrfs\-progs. Please refer to the documentation at +\fI\%https://btrfs.readthedocs.io\fP\&. +.SH SEE ALSO +.sp +\fI\%btrfs\-qgroup(8)\fP, +\fI\%btrfs\-subvolume(8)\fP, +\fI\%mkfs.btrfs(8)\fP +.\" Generated by docutils manpage writer. +. diff --git a/upstream/opensuse-leap-15-6/man8/btrfs-receive.8 b/upstream/opensuse-leap-15-6/man8/btrfs-receive.8 new file mode 100644 index 00000000..51bbe783 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/btrfs-receive.8 @@ -0,0 +1,159 @@ +.\" Man page generated from reStructuredText. +. +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.TH "BTRFS-RECEIVE" "8" "Sep 13, 2023" "6.5.1" "BTRFS" +.SH NAME +btrfs-receive \- receive subvolumes from send stream +.SH SYNOPSIS +.sp +\fBbtrfs receive\fP [options] <path> +.sp +or +.sp +\fBbtrfs receive\fP \-\-dump [options] +.SH DESCRIPTION +.sp +Receive a stream of changes and replicate one or more subvolumes that were +previously generated by \fBbtrfs send\fP\&. The received subvolumes are stored to +\fIpath\fP, unless \fI\-\-dump\fP option is given. +.sp +If \fI\-\-dump\fP option is specified, \fBbtrfs receive\fP will only do the validation of +the stream, and print the stream metadata, one operation per line. +.sp +\fBbtrfs receive\fP will fail in the following cases: +.INDENT 0.0 +.IP 1. 3 +receiving subvolume already exists +.IP 2. 3 +previously received subvolume has been changed after it was received +.IP 3. 3 +default subvolume has changed or you didn\(aqt mount the filesystem at the toplevel subvolume +.UNINDENT +.sp +A subvolume is made read\-only after the receiving process finishes successfully (see BUGS below). +.sp +\fBOptions\fP +.INDENT 0.0 +.TP +.BI \-f \ <FILE> +read the stream from \fIFILE\fP instead of stdin, +.UNINDENT +.INDENT 0.0 +.TP +.B \-C|\-\-chroot +confine the process to \fIpath\fP using \fBchroot(1)\fP +.UNINDENT +.INDENT 0.0 +.TP +.B \-e +terminate after receiving an \fIend cmd\fP marker in the stream. +.sp +Without this option the receiver side terminates only in case +of an error on end of file. +.UNINDENT +.INDENT 0.0 +.TP +.B \-E|\-\-max\-errors <NERR> +terminate as soon as NERR errors occur while stream processing commands from +the stream +.sp +Default value is 1. A value of 0 means no limit. +.UNINDENT +.INDENT 0.0 +.TP +.BI \-m \ <ROOTMOUNT> +the root mount point of the destination filesystem +.sp +By default the mount point is searched in :\fI\%file:/proc/self\fP/mounts\(ga. +If \fB/proc\fP is not accessible, e.g. in a chroot environment, use this option to +tell us where this filesystem is mounted. +.TP +.B \-\-force\-decompress +if the stream contains compressed data (see \fI\-\-compressed\-data\fP in +\fI\%btrfs\-send(8)\fP), always decompress it instead of writing it with +encoded I/O +.TP +.B \-\-dump +dump the stream metadata, one line per operation +.sp +Does not require the \fIpath\fP parameter. The filesystem remains unchanged. +.UNINDENT +.INDENT 0.0 +.TP +.B \-q|\-\-quiet +(deprecated) alias for global \fI\-q\fP option +.UNINDENT +.INDENT 0.0 +.TP +.B \-v +(deprecated) alias for global \fI\-v\fP option +.UNINDENT +.sp +\fBGlobal options\fP +.INDENT 0.0 +.TP +.B \-v|\-\-verbose +increase verbosity about performed actions, print details about each operation +.TP +.B \-q|\-\-quiet +suppress all messages except errors +.UNINDENT +.SH BUGS +.sp +\fBbtrfs receive\fP sets the subvolume read\-only after it completes +successfully. However, while the receive is in progress, users who have +write access to files or directories in the receiving \fIpath\fP can add, +remove, or modify files, in which case the resulting read\-only subvolume +will not be an exact copy of the sent subvolume. +.sp +If the intention is to create an exact copy, the receiving \fIpath\fP +should be protected from access by users until the receive operation +has completed and the subvolume is set to read\-only. +.sp +Additionally, receive does not currently do a very good job of validating +that an incremental send stream actually makes sense, and it is thus +possible for a specially crafted send stream to create a subvolume with +reflinks to arbitrary files in the same filesystem. Because of this, +users are advised to not use \fIbtrfs receive\fP on send streams from +untrusted sources, and to protect trusted streams when sending them +across untrusted networks. +.SH EXIT STATUS +.sp +\fBbtrfs receive\fP returns a zero exit status if it succeeds. Non zero is +returned in case of failure. +.SH AVAILABILITY +.sp +\fBbtrfs\fP is part of btrfs\-progs. Please refer to the documentation at +\fI\%https://btrfs.readthedocs.io\fP\&. +.SH SEE ALSO +.sp +\fI\%btrfs\-send(8)\fP, +\fI\%mkfs.btrfs(8)\fP +.\" Generated by docutils manpage writer. +. diff --git a/upstream/opensuse-leap-15-6/man8/btrfs-replace.8 b/upstream/opensuse-leap-15-6/man8/btrfs-replace.8 new file mode 100644 index 00000000..a836b21c --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/btrfs-replace.8 @@ -0,0 +1,179 @@ +.\" Man page generated from reStructuredText. +. +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.TH "BTRFS-REPLACE" "8" "Sep 13, 2023" "6.5.1" "BTRFS" +.SH NAME +btrfs-replace \- replace devices managed by btrfs with other device +.SH SYNOPSIS +.sp +\fBbtrfs replace\fP <subcommand> <args> +.SH DESCRIPTION +.sp +\fBbtrfs replace\fP is used to replace btrfs managed devices with other device. +.SH SUBCOMMAND +.INDENT 0.0 +.TP +.B cancel <mount_point> +Cancel a running device replace operation. +.TP +.B start [options] <srcdev>|<devid> <targetdev> <path> +Replace device of a btrfs filesystem. +.sp +On a live filesystem, duplicate the data to the target device which +is currently stored on the source device. +If the source device is not available anymore, or if the \-r option is set, +the data is built only using the RAID redundancy mechanisms. +After completion of the operation, the source device is removed from the +filesystem. +If the \fIsrcdev\fP is a numerical value, it is assumed to be the device id +of the filesystem which is mounted at \fIpath\fP, otherwise it is +the path to the source device. If the source device is disconnected, +from the system, you have to use the devid parameter format. +The \fItargetdev\fP needs to be same size or larger than the \fIsrcdev\fP\&. +.sp +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +The filesystem has to be resized to fully take advantage of a +larger target device; this can be achieved with +\fBbtrfs filesystem resize <devid>:max /path\fP +.UNINDENT +.UNINDENT +.sp +\fBOptions\fP +.INDENT 7.0 +.TP +.B \-r +only read from \fIsrcdev\fP if no other zero\-defect mirror exists. +(enable this if your drive has lots of read errors, the access would be very +slow) +.TP +.B \-f +force using and overwriting \fItargetdev\fP even if it looks like +it contains a valid btrfs filesystem. +.sp +A valid filesystem is assumed if a btrfs superblock is found which contains a +correct checksum. Devices that are currently mounted are +never allowed to be used as the \fItargetdev\fP\&. +.TP +.B \-B +no background replace. +.TP +.B \-\-enqueue +wait if there\(aqs another exclusive operation running, otherwise continue +.UNINDENT +.INDENT 7.0 +.TP +.B \-K|\-\-nodiscard +Do not perform whole device TRIM operation on devices that are capable of that. +This does not affect discard/trim operation when the filesystem is mounted. +Please see the mount option \fIdiscard\fP for that in \fI\%btrfs(5)\fP\&. +.UNINDENT +.TP +.B status [\-1] <mount_point> +Print status and progress information of a running device replace operation. +.sp +\fBOptions\fP +.INDENT 7.0 +.TP +.B \-1 +print once instead of print continuously until the replace +operation finishes (or is cancelled) +.UNINDENT +.UNINDENT +.SH EXAMPLES +.SS Replacing an online drive with a bigger one +.sp +Given the following filesystem mounted at \fB/mnt/my\-vault\fP +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +Label: \(aqMyVault\(aq uuid: ae20903e\-b72d\-49ba\-b944\-901fc6d888a1 + Total devices 2 FS bytes used 1TiB + devid 1 size 1TiB used 500.00GiB path /dev/sda + devid 2 size 1TiB used 500.00GiB path /dev/sdb +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +In order to replace \fB/dev/sda\fP (\fIdevid 1\fP) with a bigger drive located at +\fB/dev/sdc\fP you would run the following: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +btrfs replace start 1 /dev/sdc /mnt/my\-vault/ +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +You can monitor progress via: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +btrfs replace status /mnt/my\-vault/ +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +After the replacement is complete, as per the docs at \fI\%btrfs\-filesystem(8)\fP in +order to use the entire storage space of the new drive you need to run: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +btrfs filesystem resize 1:max /mnt/my\-vault/ +.ft P +.fi +.UNINDENT +.UNINDENT +.SH EXIT STATUS +.sp +\fBbtrfs replace\fP returns a zero exit status if it succeeds. Non zero is +returned in case of failure. +.SH AVAILABILITY +.sp +\fBbtrfs\fP is part of btrfs\-progs. Please refer to the documentation at +\fI\%https://btrfs.readthedocs.io\fP\&. +.SH SEE ALSO +.sp +\fI\%btrfs\-device(8)\fP, +\fI\%btrfs\-filesystem(8)\fP, +\fI\%mkfs.btrfs(8)\fP +.\" Generated by docutils manpage writer. +. diff --git a/upstream/opensuse-leap-15-6/man8/btrfs-rescue.8 b/upstream/opensuse-leap-15-6/man8/btrfs-rescue.8 new file mode 100644 index 00000000..c41f8129 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/btrfs-rescue.8 @@ -0,0 +1,180 @@ +.\" Man page generated from reStructuredText. +. +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.TH "BTRFS-RESCUE" "8" "Sep 13, 2023" "6.5.1" "BTRFS" +.SH NAME +btrfs-rescue \- recover a damaged btrfs filesystem +.SH SYNOPSIS +.sp +\fBbtrfs rescue\fP <subcommand> <args> +.SH DESCRIPTION +.sp +\fBbtrfs rescue\fP is used to try to recover a damaged btrfs filesystem. +.SH SUBCOMMAND +.INDENT 0.0 +.TP +.B chunk\-recover [options] <device> +Recover the chunk tree by scanning the devices +.sp +\fBOptions\fP +.INDENT 7.0 +.TP +.B \-y +assume an answer of \fIyes\fP to all questions. +.TP +.B \-h +help. +.TP +.B \-v +(deprecated) alias for global \fI\-v\fP option +.UNINDENT +.UNINDENT +.sp +\fBNOTE:\fP +.INDENT 0.0 +.INDENT 3.5 +Since \fBchunk\-recover\fP will scan the whole device, it will be very +slow especially executed on a large device. +.UNINDENT +.UNINDENT +.INDENT 0.0 +.TP +.B fix\-device\-size <device> +fix device size and super block total bytes values that are do not match +.sp +Kernel 4.11 starts to check the device size more strictly and this might +mismatch the stored value of total bytes. See the exact error message below. +Newer kernel will refuse to mount the filesystem where the values do not match. +This error is not fatal and can be fixed. This command will fix the device +size values if possible. +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +BTRFS error (device sdb): super_total_bytes 92017859088384 mismatch with fs_devices total_rw_bytes 92017859094528 +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +The mismatch may also exhibit as a kernel warning: +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +WARNING: CPU: 3 PID: 439 at fs/btrfs/ctree.h:1559 btrfs_update_device+0x1c5/0x1d0 [btrfs] +.ft P +.fi +.UNINDENT +.UNINDENT +.TP +.B clear\-uuid\-tree <device> +Clear UUID tree, so that kernel can re\-generate it at next read\-write +mount. +.sp +Since kernel v4.16 there are more sanity check performed, and sometimes +non\-critical trees like UUID tree can cause problems and reject the mount. +In such case, clearing UUID tree may make the filesystem to be mountable again +without much risk as it\(aqs built from other trees. +.TP +.B super\-recover [options] <device> +Recover bad superblocks from good copies. +.sp +\fBOptions\fP +.INDENT 7.0 +.TP +.B \-y +assume an answer of \fIyes\fP to all questions. +.TP +.B \-v +(deprecated) alias for global \fI\-v\fP option +.UNINDENT +.TP +.B zero\-log <device> +clear the filesystem log tree +.sp +This command will clear the filesystem log tree. This may fix a specific +set of problem when the filesystem mount fails due to the log replay. See below +for sample stack traces that may show up in system log. +.sp +The common case where this happens was fixed a long time ago, +so it is unlikely that you will see this particular problem, but the command is +kept around. +.sp +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +Clearing the log may lead to loss of changes that were made +since the last transaction commit. This may be up to 30 seconds +(default commit period) or less if the commit was implied by +other filesystem activity. +.UNINDENT +.UNINDENT +.sp +One can determine whether \fBzero\-log\fP is needed according to the kernel +backtrace: +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +? replay_one_dir_item+0xb5/0xb5 [btrfs] +? walk_log_tree+0x9c/0x19d [btrfs] +? btrfs_read_fs_root_no_radix+0x169/0x1a1 [btrfs] +? btrfs_recover_log_trees+0x195/0x29c [btrfs] +? replay_one_dir_item+0xb5/0xb5 [btrfs] +? btree_read_extent_buffer_pages+0x76/0xbc [btrfs] +? open_ctree+0xff6/0x132c [btrfs] +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +If the errors are like above, then \fBzero\-log\fP should be used to clear +the log and the filesystem may be mounted normally again. The keywords to look +for are \(aqopen_ctree\(aq which says that it\(aqs during mount and function names +that contain \fIreplay\fP, \fIrecover\fP or \fIlog_tree\fP\&. +.UNINDENT +.SH EXIT STATUS +.sp +\fBbtrfs rescue\fP returns a zero exit status if it succeeds. Non zero is +returned in case of failure. +.SH AVAILABILITY +.sp +\fBbtrfs\fP is part of btrfs\-progs. Please refer to the documentation at +\fI\%https://btrfs.readthedocs.io\fP\&. +.SH SEE ALSO +.sp +\fI\%btrfs\-check(8)\fP, +\fI\%btrfs\-scrub(8)\fP, +\fI\%mkfs.btrfs(8)\fP +.\" Generated by docutils manpage writer. +. diff --git a/upstream/opensuse-leap-15-6/man8/btrfs-restore.8 b/upstream/opensuse-leap-15-6/man8/btrfs-restore.8 new file mode 100644 index 00000000..76c590ce --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/btrfs-restore.8 @@ -0,0 +1,147 @@ +.\" Man page generated from reStructuredText. +. +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.TH "BTRFS-RESTORE" "8" "Sep 13, 2023" "6.5.1" "BTRFS" +.SH NAME +btrfs-restore \- try to restore files from a damaged filesystem image +.SH SYNOPSIS +.sp +\fBbtrfs restore\fP [options] <device> <path> | \-l <device> +.SH DESCRIPTION +.sp +\fBbtrfs restore\fP is used to try to salvage files from a damaged filesystem and +restore them into \fIpath\fP or just list the subvolume tree roots. The filesystem +image is not modified. +.sp +If the filesystem is damaged and cannot be repaired by the other tools +(\fI\%btrfs\-check(8)\fP or \fI\%btrfs\-rescue(8)\fP), +\fBbtrfs restore\fP could be used to +retrieve file data, as far as the metadata are readable. The checks done by +restore are less strict and the process is usually able to get far enough to +retrieve data from the whole filesystem. This comes at a cost that some data +might be incomplete or from older versions if they\(aqre available. +.sp +There are several options to attempt restoration of various file metadata type. +You can try a dry run first to see how well the process goes and use further +options to extend the set of restored metadata. +.sp +For images with damaged tree structures, there are several options to point the +process to some spare copy. +.SH OPTIONS +.INDENT 0.0 +.TP +.B \-s|\-\-snapshots +get also snapshots that are skipped by default +.TP +.B \-x|\-\-xattr +get extended attributes +.TP +.B \-m|\-\-metadata +restore owner, mode and times for files and directories +.TP +.B \-S|\-\-symlinks +restore symbolic links as well as normal files +.TP +.B \-i|\-\-ignore\-errors +ignore errors during restoration and continue +.TP +.B \-o|\-\-overwrite +overwrite directories/files in \fIpath\fP, e.g. for repeated runs +.UNINDENT +.INDENT 0.0 +.TP +.BI \-t \ <bytenr> +use \fIbytenr\fP to read the root tree +.TP +.BI \-f \ <bytenr> +only restore files that are under specified subvolume root pointed by \fIbytenr\fP +.UNINDENT +.INDENT 0.0 +.TP +.B \-u|\-\-super <mirror> +use given superblock mirror identified by <mirror>, it can be 0,1 or 2 +.TP +.B \-r|\-\-root <rootid> +only restore files that are under a specified subvolume whose objectid is \fIrootid\fP +.UNINDENT +.INDENT 0.0 +.TP +.B \-d +find directory +.UNINDENT +.INDENT 0.0 +.TP +.B \-l|\-\-list\-roots +list subvolume tree roots, can be used as argument for \fI\-r\fP +.TP +.B \-D|\-\-dry\-run +dry run (only list files that would be recovered) +.UNINDENT +.INDENT 0.0 +.TP +.BI \-\-path\-regex \ <regex> +restore only filenames matching a regular expression (\fBregex(7)\fP) +with a mandatory format +.sp +\fB^/(|home(|/username(|/Desktop(|/.*))))$\fP +.sp +The format is not very comfortable and restores all files in the +directories in the whole path, so this is not useful for restoring +single file in a deep hierarchy. +.TP +.B \-c +ignore case (\fI\-\-path\-regex\fP only) +.UNINDENT +.INDENT 0.0 +.TP +.B \-v|\-\-verbose +(deprecated) alias for global \fI\-v\fP option +.UNINDENT +.sp +\fBGlobal options\fP +.INDENT 0.0 +.TP +.B \-v|\-\-verbose +be verbose and print what is being restored +.UNINDENT +.SH EXIT STATUS +.sp +\fBbtrfs restore\fP returns a zero exit status if it succeeds. Non zero is +returned in case of failure. +.SH AVAILABILITY +.sp +\fBbtrfs\fP is part of btrfs\-progs. Please refer to the documentation at +\fI\%https://btrfs.readthedocs.io\fP\&. +.SH SEE ALSO +.sp +\fI\%btrfs\-check(8)\fP, +\fI\%btrfs\-rescue(8)\fP, +\fI\%mkfs.btrfs(8)\fP +.\" Generated by docutils manpage writer. +. diff --git a/upstream/opensuse-leap-15-6/man8/btrfs-scrub.8 b/upstream/opensuse-leap-15-6/man8/btrfs-scrub.8 new file mode 100644 index 00000000..20556828 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/btrfs-scrub.8 @@ -0,0 +1,274 @@ +.\" Man page generated from reStructuredText. +. +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.TH "BTRFS-SCRUB" "8" "Sep 13, 2023" "6.5.1" "BTRFS" +.SH NAME +btrfs-scrub \- scrub btrfs filesystem, verify block checksums +.SH SYNOPSIS +.sp +\fBbtrfs scrub\fP <subcommand> <args> +.SH DESCRIPTION +.sp +Scrub is a pass over all filesystem data and metadata and verifying the +checksums. If a valid copy is available (replicated block group profiles) then +the damaged one is repaired. All copies of the replicated profiles are validated. +.sp +\fBNOTE:\fP +.INDENT 0.0 +.INDENT 3.5 +Scrub is not a filesystem checker (fsck) and does not verify nor repair +structural damage in the filesystem. It really only checks checksums of data +and tree blocks, it doesn\(aqt ensure the content of tree blocks is valid and +consistent. There\(aqs some validation performed when metadata blocks are read +from disk but it\(aqs not extensive and cannot substitute full \fBbtrfs check\fP +run. +.UNINDENT +.UNINDENT +.sp +The user is supposed to run it manually or via a periodic system service. The +recommended period is a month but could be less. The estimated device bandwidth +utilization is about 80% on an idle filesystem. The IO priority class is by +default \fIidle\fP so background scrub should not significantly interfere with +normal filesystem operation. The IO scheduler set for the device(s) might not +support the priority classes though. +.sp +The scrubbing status is recorded in \fB/var/lib/btrfs/\fP in textual files named +\fIscrub.status.UUID\fP for a filesystem identified by the given UUID. (Progress +state is communicated through a named pipe in file \fIscrub.progress.UUID\fP in the +same directory.) The status file is updated every 5 seconds. A resumed scrub +will continue from the last saved position. +.sp +Scrub can be started only on a mounted filesystem, though it\(aqs possible to +scrub only a selected device. See \fI\%btrfs scrub start\fP for more. +.SH SUBCOMMAND +.INDENT 0.0 +.TP +.B cancel <path>|<device> +If a scrub is running on the filesystem identified by \fIpath\fP or +\fIdevice\fP, cancel it. +.sp +If a \fIdevice\fP is specified, the corresponding filesystem is found and +\fBbtrfs scrub cancel\fP behaves as if it was called on that filesystem. +The progress is saved in the status file so \fBbtrfs scrub resume\fP can +continue from the last position. +.TP +.B resume [\-BdqrR] <path>|<device> +Resume a cancelled or interrupted scrub on the filesystem identified by +\fIpath\fP or on a given \fIdevice\fP\&. The starting point is read from the +status file if it exists. +.sp +This does not start a new scrub if the last scrub finished successfully. +.sp +\fBOptions\fP +.sp +see \fBscrub start\fP\&. +.UNINDENT +.INDENT 0.0 +.TP +.B start [\-BdrRf] <path>|<device> +Start a scrub on all devices of the mounted filesystem identified by +\fIpath\fP or on a single \fIdevice\fP\&. If a scrub is already running, the new +one will not start. A device of an unmounted filesystem cannot be +scrubbed this way. +.sp +Without options, scrub is started as a background process. The +automatic repairs of damaged copies are performed by default for block +group profiles with redundancy. No\-repair can be enabled by option \fI\-r\fP\&. +.sp +\fBOptions\fP +.INDENT 7.0 +.TP +.B \-B +do not background and print scrub statistics when finished +.TP +.B \-d +print separate statistics for each device of the filesystem +(\fI\-B\fP only) at the end +.TP +.B \-r +run in read\-only mode, do not attempt to correct anything, can +be run on a read\-only filesystem +.TP +.B \-R +raw print mode, print full data instead of summary +.TP +.B \-f +force starting new scrub even if a scrub is already running, +this can useful when scrub status file is damaged and reports a +running scrub although it is not, but should not normally be +necessary +.UNINDENT +.sp +\fBDeprecated options\fP +.INDENT 7.0 +.TP +.BI \-c \ <ioprio_class> +set IO priority class (see \fBionice(1)\fP manpage) if the IO +scheduler configured for the device supports ionice. This is +not supported byg BFQ or Kyber but is \fInot\fP supported by +mq\-deadline. +.TP +.BI \-n \ <ioprio_classdata> +set IO priority classdata (see \fBionice(1)\fP manpage) +.TP +.B \-q +(deprecated) alias for global \fI\-q\fP option +.UNINDENT +.TP +.B status [options] <path>|<device> +.INDENT 7.0 +.INDENT 3.5 +Show status of a running scrub for the filesystem identified by \fIpath\fP +or for the specified \fIdevice\fP\&. +.sp +If no scrub is running, show statistics of the last finished or +cancelled scrub for that filesystem or device. +.sp +\fBOptions\fP +.INDENT 0.0 +.TP +.B \-d +print separate statistics for each device of the filesystem +.TP +.B \-R +print all raw statistics without postprocessing as returned by +the status ioctl +.TP +.B \-\-raw +print all numbers raw values in bytes without the \fIB\fP suffix +.TP +.B \-\-human\-readable +print human friendly numbers, base 1024, this is the default +.TP +.B \-\-iec +select the 1024 base for the following options, according to +the IEC standard +.TP +.B \-\-si +select the 1000 base for the following options, according to the SI standard +.TP +.B \-\-kbytes +show sizes in KiB, or kB with \-\-si +.TP +.B \-\-mbytes +show sizes in MiB, or MB with \-\-si +.TP +.B \-\-gbytes +show sizes in GiB, or GB with \-\-si +.TP +.B \-\-tbytes +show sizes in TiB, or TB with \-\-si +.UNINDENT +.sp +A status on a filesystem without any error looks like the following: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +# btrfs scrub start / +# btrfs scrub status / +UUID: 76fac721\-2294\-4f89\-a1af\-620cde7a1980 +Scrub started: Wed Apr 10 12:34:56 2023 +Status: running +Duration: 0:00:05 +Time left: 0:00:05 +ETA: Wed Apr 10 12:35:01 2023 +Total to scrub: 28.32GiB +Bytes scrubbed: 13.76GiB (48.59%) +Rate: 2.75GiB/s +Error summary: no errors found +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +With some errors found: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +Error summary: csum=72 + Corrected: 2 + Uncorrectable: 72 + Unverified: 0 +.ft P +.fi +.UNINDENT +.UNINDENT +.UNINDENT +.UNINDENT +.INDENT 7.0 +.IP \(bu 2 +\fICorrected\fP \-\- number of bad blocks that were repaired from another copy +.IP \(bu 2 +\fIUncorrectable\fP \-\- errors detected at read time but not possible to repair from other copy +.IP \(bu 2 +\fIUnverified\fP \-\- transient errors, first read failed but a retry +succeeded, may be affected by lower layers that group or split IO requests +.IP \(bu 2 +\fIError summary\fP \-\- followed by a more detailed list of errors found +.INDENT 2.0 +.IP \(bu 2 +\fIcsum\fP \-\- checksum mismatch +.IP \(bu 2 +\fIsuper\fP \-\- super block errors, unless the error is fixed +immediately, the next commit will overwrite superblock +.IP \(bu 2 +\fIverify\fP \-\- metadata block header errors +.IP \(bu 2 +\fIread\fP \-\- blocks can\(aqt be read due to IO errors +.UNINDENT +.UNINDENT +.UNINDENT +.SH EXIT STATUS +.sp +\fBbtrfs scrub\fP returns a zero exit status if it succeeds. Non zero is +returned in case of failure: +.INDENT 0.0 +.TP +.B 1 +scrub couldn\(aqt be performed +.TP +.B 2 +there is nothing to resume +.TP +.B 3 +scrub found uncorrectable errors +.UNINDENT +.SH AVAILABILITY +.sp +\fBbtrfs\fP is part of btrfs\-progs. Please refer to the documentation at +\fI\%https://btrfs.readthedocs.io\fP\&. +.SH SEE ALSO +.sp +\fI\%mkfs.btrfs(8)\fP +.\" Generated by docutils manpage writer. +. diff --git a/upstream/opensuse-leap-15-6/man8/btrfs-select-super.8 b/upstream/opensuse-leap-15-6/man8/btrfs-select-super.8 new file mode 100644 index 00000000..110234fc --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/btrfs-select-super.8 @@ -0,0 +1,80 @@ +.\" Man page generated from reStructuredText. +. +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.TH "BTRFS-SELECT-SUPER" "8" "Sep 13, 2023" "6.5.1" "BTRFS" +.SH NAME +btrfs-select-super \- overwrite primary superblock with a backup copy +.SH SYNOPSIS +.sp +\fBbtrfs\-select\-super\fP \-s number <device> +.SH DESCRIPTION +.sp +Destructively overwrite all copies of the superblock with a specified copy. +This helps in certain cases, for example when write barriers were disabled +during a power failure and not all superblocks were written, or if the primary +superblock is damaged, e.g. accidentally overwritten. +.sp +The filesystem specified by \fIdevice\fP must not be mounted. +.sp +\fBNOTE:\fP +.INDENT 0.0 +.INDENT 3.5 +Prior to overwriting the primary superblock, please make sure that the +backup copies are valid! +.UNINDENT +.UNINDENT +.sp +To dump a superblock use the \fBbtrfs inspect\-internal dump\-super\fP command. +.sp +Then run the check (in the non\-repair mode) using the command \fBbtrfs check \-s\fP +where \fI\-s\fP specifies the superblock copy to use. +.sp +Superblock copies exist in the following offsets on the device: +.INDENT 0.0 +.IP \(bu 2 +primary: 64KiB (65536) +.IP \(bu 2 +1st copy: 64MiB (67108864) +.IP \(bu 2 +2nd copy: 256GiB (274877906944) +.UNINDENT +.sp +A superblock size is 4KiB (4096). +.SH OPTIONS +.INDENT 0.0 +.TP +.B \-s|\-\-super <N> +use Nth superblock copy, valid values are 0 1 or 2 if the +respective superblock offset is within the device size +.UNINDENT +.SH SEE ALSO +.sp +\fI\%btrfs(8)\fP +.\" Generated by docutils manpage writer. +. diff --git a/upstream/opensuse-leap-15-6/man8/btrfs-send.8 b/upstream/opensuse-leap-15-6/man8/btrfs-send.8 new file mode 100644 index 00000000..03ae23fc --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/btrfs-send.8 @@ -0,0 +1,146 @@ +.\" Man page generated from reStructuredText. +. +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.TH "BTRFS-SEND" "8" "Sep 13, 2023" "6.5.1" "BTRFS" +.SH NAME +btrfs-send \- generate a stream of changes between two subvolume snapshots +.SH SYNOPSIS +.sp +\fBbtrfs send\fP [\-ve] [\-p <parent>] [\-c <clone\-src>] [\-f <outfile>] <subvol> [<subvol>...] +.SH DESCRIPTION +.sp +This command will generate a stream of instructions that describe changes +between two subvolume snapshots. The stream can be consumed by the \fBbtrfs receive\fP +command to replicate the sent snapshot on a different filesystem. +The command operates in two modes: full and incremental. +.sp +All snapshots involved in one send command must be read\-only, and this status +cannot be changed as long as there\(aqs a running send operation that uses the +snapshot. Read\-only mount of the subvolume is not sufficient, there\(aqs no way to +guarantee that there won\(aqt be any other writable mount of the same subvolume +that would potentially write while send would be running. +.sp +In the full mode, the entire snapshot data and metadata will end up in the +stream. +.sp +In the incremental mode (options \fI\-p\fP and \fI\-c\fP), previously sent snapshots that +are available on both the sending and receiving side can be used to reduce the +amount of information that has to be sent to reconstruct the sent snapshot on a +different filesystem. +.sp +The \fI\-p <parent>\fP option can be omitted when \fI\-c <clone\-src>\fP options are +given, in which case \fBbtrfs send\fP will determine a suitable parent from among +the clone sources. +.sp +You must not specify clone sources unless you guarantee that these snapshots +are exactly in the same state on both sides\-\-both for the sender and the +receiver. For implications of changed read\-write status of a received snapshot +please see section \fISUBVOLUME FLAGS\fP in \fI\%btrfs\-subvolume(8)\fP\&. +.sp +\fBOptions\fP +.INDENT 0.0 +.TP +.B \-e +if sending multiple subvolumes at once, use the new format and omit the +\fIend cmd\fP marker in the stream separating the subvolumes +.TP +.BI \-p \ <parent> +send an incremental stream from \fIparent\fP to \fIsubvol\fP +.TP +.BI \-c \ <clone\-src> +use this snapshot as a clone source for an incremental send (multiple +allowed) +.TP +.BI \-f \ <outfile> +output is normally written to standard output so it can be, for +example, piped to btrfs receive. Use this option to write it to a file +instead. +.TP +.B \-\-no\-data +send in \fINO_FILE_DATA\fP mode +.sp +The output stream does not contain any file data and thus cannot be +used to transfer changes. This mode is faster and is useful to show the +differences in metadata. +.TP +.BI \-\-proto \ <N> +use send protocol version N +.sp +The default is 1, which was the original protocol version. Version 2 +encodes file data slightly more efficiently; it is also required for +sending compressed data directly (see \fI\-\-compressed\-data\fP). Version 2 +requires at least btrfs\-progs 6.0 on both the sender and receiver and +at least Linux 6.0 on the sender. Passing 0 means to use the highest +version supported by the running kernel. +.TP +.B \-\-compressed\-data +send data that is compressed on the filesystem directly without +decompressing it +.sp +If the receiver supports the \fIBTRFS_IOC_ENCODED_WRITE\fP ioctl (added in +Linux 6.0), it can also write it directly without decompressing it. +Otherwise, the receiver will fall back to decompressing it and writing +it normally. +.sp +This requires protocol version 2 or higher. If \fI\-\-proto\fP was not used, +then \fI\-\-compressed\-data\fP implies \fI\-\-proto 2\fP\&. +.UNINDENT +.INDENT 0.0 +.TP +.B \-q|\-\-quiet +(deprecated) alias for global \fI\-q\fP option +.TP +.B \-v|\-\-verbose +(deprecated) alias for global \fI\-v\fP option +.UNINDENT +.sp +\fBGlobal options\fP +.INDENT 0.0 +.TP +.B \-q|\-\-quiet +suppress all messages except errors +.TP +.B \-v|\-\-verbose +increase output verbosity, print generated commands in a readable form +.UNINDENT +.SH EXIT STATUS +.sp +\fBbtrfs send\fP returns a zero exit status if it succeeds. Non zero is +returned in case of failure. +.SH AVAILABILITY +.sp +\fBbtrfs\fP is part of btrfs\-progs. Please refer to the documentation at +\fI\%https://btrfs.readthedocs.io\fP\&. +.SH SEE ALSO +.sp +\fI\%btrfs\-receive(8)\fP, +\fI\%btrfs\-subvolume(8)\fP, +\fI\%mkfs.btrfs(8)\fP +.\" Generated by docutils manpage writer. +. diff --git a/upstream/opensuse-leap-15-6/man8/btrfs-subvolume.8 b/upstream/opensuse-leap-15-6/man8/btrfs-subvolume.8 new file mode 100644 index 00000000..ba412127 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/btrfs-subvolume.8 @@ -0,0 +1,545 @@ +.\" Man page generated from reStructuredText. +. +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.TH "BTRFS-SUBVOLUME" "8" "Sep 13, 2023" "6.5.1" "BTRFS" +.SH NAME +btrfs-subvolume \- manage btrfs subvolumes +.SH SYNOPSIS +.sp +\fBbtrfs subvolume\fP <subcommand> [<args>] +.SH DESCRIPTION +.sp +\fBbtrfs subvolume\fP is used to create/delete/list/show btrfs subvolumes and +snapshots. +.sp +A BTRFS subvolume is a part of filesystem with its own independent +file/directory hierarchy and inode number namespace. Subvolumes can share file +extents. A snapshot is also subvolume, but with a given initial content of the +original subvolume. A subvolume has always inode number 256. +.sp +\fBNOTE:\fP +.INDENT 0.0 +.INDENT 3.5 +A subvolume in BTRFS is not like an LVM logical volume, which is block\-level +snapshot while BTRFS subvolumes are file extent\-based. +.UNINDENT +.UNINDENT +.sp +A subvolume looks like a normal directory, with some additional operations +described below. Subvolumes can be renamed or moved, nesting subvolumes is not +restricted but has some implications regarding snapshotting. The numeric id +(called \fIsubvolid\fP or \fIrootid\fP) of the subvolume is persistent and cannot be +changed. +.sp +A subvolume in BTRFS can be accessed in two ways: +.INDENT 0.0 +.IP \(bu 2 +like any other directory that is accessible to the user +.IP \(bu 2 +like a separately mounted filesystem (options \fIsubvol\fP or \fIsubvolid\fP) +.UNINDENT +.sp +In the latter case the parent directory is not visible and accessible. This is +similar to a bind mount, and in fact the subvolume mount does exactly that. +.sp +A freshly created filesystem is also a subvolume, called \fItop\-level\fP, +internally has an id 5. This subvolume cannot be removed or replaced by another +subvolume. This is also the subvolume that will be mounted by default, unless +the default subvolume has been changed (see \fI\%btrfs subvolume set\-default\fP). +.sp +A snapshot is a subvolume like any other, with given initial content. By +default, snapshots are created read\-write. File modifications in a snapshot +do not affect the files in the original subvolume. +.sp +Subvolumes can be given capacity limits, through the qgroups/quota facility, but +otherwise share the single storage pool of the whole btrfs filesystem. They may +even share data between themselves (through deduplication or snapshotting). +.sp +\fBNOTE:\fP +.INDENT 0.0 +.INDENT 3.5 +A snapshot is not a backup: snapshots work by use of BTRFS\(aq copy\-on\-write +behaviour. A snapshot and the original it was taken from initially share all +of the same data blocks. If that data is damaged in some way (cosmic rays, +bad disk sector, accident with dd to the disk), then the snapshot and the +original will both be damaged. Snapshots are useful to have local online +\(dqcopies\(dq of the filesystem that can be referred back to, or to implement a +form of deduplication, or to fix the state of a filesystem for making a full +backup without anything changing underneath it. They do not in themselves +make your data any safer. +.UNINDENT +.UNINDENT +.SH SUBVOLUME FLAGS +.sp +The subvolume flag currently implemented is the \fIro\fP property (read\-only +status). Read\-write subvolumes have that set to \fIfalse\fP, snapshots as \fItrue\fP\&. +In addition to that, a plain snapshot will also have last change generation and +creation generation equal. +.sp +Read\-only snapshots are building blocks of incremental send (see +\fI\%btrfs\-send(8)\fP) and the whole use case relies on unmodified snapshots where +the relative changes are generated from. Thus, changing the subvolume flags +from read\-only to read\-write will break the assumptions and may lead to +unexpected changes in the resulting incremental stream. +.sp +A snapshot that was created by send/receive will be read\-only, with different +last change generation, read\-only and with set \fIreceived_uuid\fP which identifies +the subvolume on the filesystem that produced the stream. The use case relies +on matching data on both sides. Changing the subvolume to read\-write after it +has been received requires to reset the \fIreceived_uuid\fP\&. As this is a notable +change and could potentially break the incremental send use case, performing +it by \fBbtrfs property set\fP requires force if that is really desired by user. +.sp +\fBNOTE:\fP +.INDENT 0.0 +.INDENT 3.5 +The safety checks have been implemented in 5.14.2, any subvolumes previously +received (with a valid \fIreceived_uuid\fP) and read\-write status may exist and +could still lead to problems with send/receive. You can use \fBbtrfs subvolume show\fP +to identify them. Flipping the flags to read\-only and back to +read\-write will reset the \fIreceived_uuid\fP manually. There may exist a +convenience tool in the future. +.UNINDENT +.UNINDENT +.SH NESTED SUBVOLUMES +.sp +There are no restrictions for subvolume creation, so it\(aqs up to the user how to +organize them, whether to have a flat layout (all subvolumes are direct +descendants of the toplevel one), or nested. +.sp +What should be mentioned early is that a snapshotting is not recursive, so a +subvolume or a snapshot is effectively a barrier and no files in the nested +appear in the snapshot. Instead there\(aqs a stub subvolume (also sometimes +\fIempty subvolume\fP with the same name as original subvolume, with inode number +2). This can be used intentionally but could be confusing in case of nested +layouts. +.SS Case study: system root layouts +.sp +There are two ways how the system root directory and subvolume layout could be +organized. The interesting use case for root is to allow rollbacks to previous +version, as one atomic step. If the entire filesystem hierarchy starting in \fB/\fP +is in one subvolume, taking snapshot will encompass all files. This is easy for +the snapshotting part but has undesirable consequences for rollback. For example, +log files would get rolled back too, or any data that are stored on the root +filesystem but are not meant to be rolled back either (database files, VM +images, ...). +.sp +Here we could utilize the snapshotting barrier mentioned above, each directory +that stores data to be preserved across rollbacks is it\(aqs own subvolume. This +could be e.g. \fB/var\fP\&. Further more\-fine grained partitioning could be done, e.g. +adding separate subvolumes for \fB/var/log\fP, \fB/var/cache\fP etc. +.sp +That there are separate subvolumes requires separate actions to take the +snapshots (here it gets disconnected from the system root snapshots). This needs +to be taken care of by system tools, installers together with selection of which +directories are highly recommended to be separate subvolumes. +.SH MOUNT OPTIONS +.sp +Mount options are of two kinds, generic (that are handled by VFS layer) and +specific, handled by the filesystem. The following list shows which are +applicable to individual subvolume mounts, while there are more options that +always affect the whole filesystem: +.INDENT 0.0 +.IP \(bu 2 +generic: noatime/relatime/..., nodev, nosuid, ro, rw, dirsync +.IP \(bu 2 +fs\-specific: compress, autodefrag, nodatacow, nodatasum +.UNINDENT +.sp +An example of whole filesystem options is e.g. \fIspace_cache\fP, \fIrescue\fP, \fIdevice\fP, +\fIskip_balance\fP, etc. The exceptional options are \fIsubvol\fP and \fIsubvolid\fP that +are actually used for mounting a given subvolume and can be specified only once +for the mount. +.sp +Subvolumes belong to a single filesystem and as implemented now all share the +same specific mount options, changes done by remount have immediate effect. This +may change in the future. +.sp +Mounting a read\-write snapshot as read\-only is possible and will not change the +\fIro\fP property and flag of the subvolume. +.sp +The name of the mounted subvolume is stored in file \fB/proc/self/mountinfo\fP in +the 4th column: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +27 21 0:19 /subv1 /mnt rw,relatime \- btrfs /dev/sda rw,space_cache + ^^^^^^ +.ft P +.fi +.UNINDENT +.UNINDENT +.SH INODE NUMBERS +.sp +A proper subvolume has always inode number 256. If a subvolume is nested and +then a snapshot is taken, then the cloned directory entry representing the +subvolume becomes empty and the inode has number 2. All other files and +directories in the target snapshot preserve their original inode numbers. +.sp +\fBNOTE:\fP +.INDENT 0.0 +.INDENT 3.5 +Inode number is not a filesystem\-wide unique identifier, some applications +assume that. Please use pair \fIsubvolumeid:inodenumber\fP for that purpose. +.UNINDENT +.UNINDENT +.SH PERFORMANCE +.sp +Subvolume creation needs to flush dirty data that belong to the subvolume, this +step may take some time, otherwise once there\(aqs nothing else to do, the snapshot +is instant and in the metadata it only creates a new tree root copy. +.sp +Snapshot deletion has two phases: first its directory is deleted and the +subvolume is added to a list, then the list is processed one by one and the +data related to the subvolume get deleted. This is usually called \fIcleaning\fP and +can take some time depending on the amount of shared blocks (can be a lot of +metadata updates), and the number of currently queued deleted subvolumes. +.SH SUBVOLUME AND SNAPSHOT +.sp +A subvolume is a part of filesystem with its own independent +file/directory hierarchy. Subvolumes can share file extents. A snapshot is +also subvolume, but with a given initial content of the original subvolume. +.sp +\fBNOTE:\fP +.INDENT 0.0 +.INDENT 3.5 +A subvolume in btrfs is not like an LVM logical volume, which is block\-level +snapshot while btrfs subvolumes are file extent\-based. +.UNINDENT +.UNINDENT +.sp +A subvolume looks like a normal directory, with some additional operations +described below. Subvolumes can be renamed or moved, nesting subvolumes is not +restricted but has some implications regarding snapshotting. +.sp +A subvolume in btrfs can be accessed in two ways: +.INDENT 0.0 +.IP \(bu 2 +like any other directory that is accessible to the user +.IP \(bu 2 +like a separately mounted filesystem (options \fIsubvol\fP or \fIsubvolid\fP) +.UNINDENT +.sp +In the latter case the parent directory is not visible and accessible. This is +similar to a bind mount, and in fact the subvolume mount does exactly that. +.sp +A freshly created filesystem is also a subvolume, called \fItop\-level\fP, +internally has an id 5. This subvolume cannot be removed or replaced by another +subvolume. This is also the subvolume that will be mounted by default, unless +the default subvolume has been changed (see subcommand \fI\%set\-default\fP). +.sp +A snapshot is a subvolume like any other, with given initial content. By +default, snapshots are created read\-write. File modifications in a snapshot +do not affect the files in the original subvolume. +.SH SUBCOMMAND +.INDENT 0.0 +.TP +.B create [\-i <qgroupid>] [<dest>/]<name> +Create a subvolume \fIname\fP in \fIdest\fP\&. +.sp +If \fIdest\fP is not given, subvolume \fIname\fP will be created in the current +directory. +.sp +\fBOptions\fP +.INDENT 7.0 +.TP +.BI \-i \ <qgroupid> +Add the newly created subvolume to a qgroup. This option can be given multiple +times. +.UNINDENT +.TP +.B delete [options] [<subvolume> [<subvolume>...]], delete \-i|\-\-subvolid <subvolid> <path> +Delete the subvolume(s) from the filesystem. +.sp +If \fIsubvolume\fP is not a subvolume, btrfs returns an error but continues if +there are more arguments to process. +.sp +If \fI\-\-subvolid\fP is used, \fIpath\fP must point to a btrfs filesystem. See +\fI\%btrfs subvolume list\fP or +\fI\%btrfs inspect\-internal rootid\fP +how to get the subvolume id. +.sp +The corresponding directory is removed instantly but the data blocks are +removed later in the background. The command returns immediately. See +\fI\%btrfs subvolume sync\fP how to wait until the subvolume gets completely removed. +.sp +The deletion does not involve full transaction commit by default due to +performance reasons. As a consequence, the subvolume may appear again after a +crash. Use one of the \fI\-\-commit\fP options to wait until the operation is +safely stored on the device. +.sp +Deleting subvolume needs sufficient permissions, by default the owner +cannot delete it unless it\(aqs enabled by a mount option +\fIuser_subvol_rm_allowed\fP, or deletion is run as root. +The default subvolume (see \fI\%btrfs subvolume set\-default\fP) +cannot be deleted and +returns error (EPERM) and this is logged to the system log. A subvolume that\(aqs +currently involved in send (see \fI\%btrfs\-send(8)\fP) +also cannot be deleted until the +send is finished. This is also logged in the system log. +.sp +\fBOptions\fP +.INDENT 7.0 +.TP +.B \-c|\-\-commit\-after +wait for transaction commit at the end of the operation. +.TP +.B \-C|\-\-commit\-each +wait for transaction commit after deleting each subvolume. +.TP +.B \-i|\-\-subvolid <subvolid> +subvolume id to be removed instead of the <path> that should point to the +filesystem with the subvolume +.TP +.B \-v|\-\-verbose +(deprecated) alias for global \fI\-v\fP option +.UNINDENT +.TP +.B find\-new <subvolume> <last_gen> +List the recently modified files in a subvolume, after \fIlast_gen\fP generation. +.TP +.B get\-default <path> +Get the default subvolume of the filesystem \fIpath\fP\&. +.sp +The output format is similar to \fBsubvolume list\fP command. +.UNINDENT +.INDENT 0.0 +.TP +.B list [options] [\-G [+|\-]<value>] [\-C [+|\-]<value>] [\-\-sort=rootid,gen,ogen,path] <path> +List the subvolumes present in the filesystem \fIpath\fP\&. +.sp +For every subvolume the following information is shown by default: +.sp +ID \fIID\fP gen \fIgeneration\fP top level \fIparent_ID\fP path \fIpath\fP +.sp +where \fIID\fP is subvolume\(aqs (root)id, \fIgeneration\fP is an internal counter which is +updated every transaction, \fIparent_ID\fP is the same as the parent subvolume\(aqs id, +and \fIpath\fP is the relative path of the subvolume to the top level subvolume. +The subvolume\(aqs ID may be used by the subvolume set\-default command, +or at mount time via the \fIsubvolid=\fP option. +.sp +\fBOptions\fP +.sp +Path filtering: +.INDENT 7.0 +.TP +.B \-o +print only subvolumes below specified <path>. +.TP +.B \-a +print all the subvolumes in the filesystem and distinguish between +absolute and relative path with respect to the given \fIpath\fP\&. +.UNINDENT +.sp +Field selection: +.INDENT 7.0 +.TP +.B \-p +print the parent ID +(\fIparent\fP here means the subvolume which contains this subvolume). +.TP +.B \-c +print the ogeneration of the subvolume, aliases: ogen or origin generation. +.TP +.B \-g +print the generation of the subvolume (default). +.TP +.B \-u +print the UUID of the subvolume. +.TP +.B \-q +print the parent UUID of the subvolume +(\fIparent\fP here means subvolume of which this subvolume is a snapshot). +.TP +.B \-R +print the UUID of the sent subvolume, where the subvolume is the result of a receive operation. +.UNINDENT +.sp +Type filtering: +.INDENT 7.0 +.TP +.B \-s +only snapshot subvolumes in the filesystem will be listed. +.TP +.B \-r +only readonly subvolumes in the filesystem will be listed. +.TP +.B \-d +list deleted subvolumes that are not yet cleaned. +.UNINDENT +.sp +Other: +.INDENT 7.0 +.TP +.B \-t +print the result as a table. +.UNINDENT +.sp +Sorting: +.sp +By default the subvolumes will be sorted by subvolume ID ascending. +.INDENT 7.0 +.TP +.B \-G [+|\-]<value> +list subvolumes in the filesystem that its generation is +>=, <= or = value. \(aq+\(aq means >= value, \(aq\-\(aq means <= value, If there is +neither \(aq+\(aq nor \(aq\-\(aq, it means = value. +.TP +.B \-C [+|\-]<value> +list subvolumes in the filesystem that its ogeneration is +>=, <= or = value. The usage is the same to \fI\-G\fP option. +.TP +.B \-\-sort=rootid,gen,ogen,path +list subvolumes in order by specified items. +you can add \fI+\fP or \fI\-\fP in front of each items, \fI+\fP means ascending, +\fI\-\fP means descending. The default is ascending. +.sp +for \fI\-\-sort\fP you can combine some items together by \fI,\fP, just like +\fI\-\-sort=+ogen,\-gen,path,rootid\fP\&. +.UNINDENT +.UNINDENT +.INDENT 0.0 +.TP +.B set\-default [<subvolume>|<id> <path>] +Set the default subvolume for the (mounted) filesystem. +.sp +Set the default subvolume for the (mounted) filesystem at \fIpath\fP\&. This will hide +the top\-level subvolume (i.e. the one mounted with \fIsubvol=/\fP or \fIsubvolid=5\fP). +Takes action on next mount. +.sp +There are two ways how to specify the subvolume, by \fIid\fP or by the \fIsubvolume\fP +path. +The id can be obtained from \fI\%btrfs subvolume list\fP +\fI\%btrfs subvolume show\fP or +\fI\%btrfs inspect\-internal rootid\fP\&. +.UNINDENT +.INDENT 0.0 +.TP +.B show [options] <path> +Show more information about a subvolume (UUIDs, generations, times, flags, +related snapshots). +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +/mnt/btrfs/subvolume + Name: subvolume + UUID: 5e076a14\-4e42\-254d\-ac8e\-55bebea982d1 + Parent UUID: \- + Received UUID: \- + Creation time: 2018\-01\-01 12:34:56 +0000 + Subvolume ID: 79 + Generation: 2844 + Gen at creation: 2844 + Parent ID: 5 + Top level ID: 5 + Flags: \- + Snapshot(s): +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +\fBOptions\fP +.INDENT 7.0 +.TP +.B \-r|\-\-rootid <ID> +show details about subvolume with root \fIID\fP, looked up in \fIpath\fP +.TP +.B \-u|\-\-uuid UUID +show details about subvolume with the given \fIUUID\fP, looked up in \fIpath\fP +.UNINDENT +.TP +.B snapshot [\-r] [\-i <qgroupid>] <source> <dest>|[<dest>/]<name> +Create a snapshot of the subvolume \fIsource\fP with the +name \fIname\fP in the \fIdest\fP directory. +.sp +If only \fIdest\fP is given, the subvolume will be named the basename of \fIsource\fP\&. +If \fIsource\fP is not a subvolume, btrfs returns an error. +.sp +\fBOptions\fP +.INDENT 7.0 +.TP +.B \-r +Make the new snapshot read only. +.TP +.BI \-i \ <qgroupid> +Add the newly created subvolume to a qgroup. This option can be given multiple +times. +.UNINDENT +.UNINDENT +.INDENT 0.0 +.TP +.B sync <path> [subvolid...] +Wait until given subvolume(s) are completely removed from the filesystem after +deletion. If no subvolume id is given, wait until all current deletion requests +are completed, but do not wait for subvolumes deleted in the meantime. +.sp +\fBOptions\fP +.INDENT 7.0 +.TP +.BI \-s \ <N> +sleep N seconds between checks (default: 1) +.UNINDENT +.UNINDENT +.SH EXAMPLES +.SS Deleting a subvolume +.sp +If we want to delete a subvolume called \fIfoo\fP from a btrfs volume mounted at +\fB/mnt/bar\fP we could run the following: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +btrfs subvolume delete /mnt/bar/foo +.ft P +.fi +.UNINDENT +.UNINDENT +.SH EXIT STATUS +.sp +\fBbtrfs subvolume\fP returns a zero exit status if it succeeds. A non\-zero value is +returned in case of failure. +.SH AVAILABILITY +.sp +\fBbtrfs\fP is part of btrfs\-progs. Please refer to the documentation at +\fI\%https://btrfs.readthedocs.io\fP\&. +.SH SEE ALSO +.sp +\fI\%btrfs\-qgroup(8)\fP, +\fI\%btrfs\-quota(8)\fP, +\fI\%btrfs\-send(8)\fP, +\fI\%mkfs.btrfs(8)\fP, +\fBmount(8)\fP +.\" Generated by docutils manpage writer. +. diff --git a/upstream/opensuse-leap-15-6/man8/btrfs.8 b/upstream/opensuse-leap-15-6/man8/btrfs.8 new file mode 100644 index 00000000..2114775c --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/btrfs.8 @@ -0,0 +1,223 @@ +.\" Man page generated from reStructuredText. +. +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.TH "BTRFS" "8" "Sep 13, 2023" "6.5.1" "BTRFS" +.SH NAME +btrfs \- a toolbox to manage btrfs filesystems +.SH SYNOPSIS +.sp +\fBbtrfs\fP [global] <group> [<group>...] <command> [<args>] +.SH DESCRIPTION +.sp +The \fBbtrfs\fP utility is a toolbox for managing btrfs filesystems. There are +command groups to work with subvolumes, devices, for whole filesystem or other +specific actions. See section \fI\%COMMANDS\fP\&. +.sp +There are also standalone tools for some tasks like \fI\%btrfs\-convert(8)\fP or +\fI\%btrfstune(8)\fP that were separate historically and/or haven\(aqt been merged to the +main utility. See section \fI\%STANDALONE TOOLS\fP +for more details. +.sp +For other topics (mount options, etc) please refer to the separate manual +page \fI\%btrfs(5)\fP\&. +.SH COMMAND SYNTAX +.sp +Any command name can be shortened so long as the shortened form is unambiguous, +however, it is recommended to use full command names in scripts. All command +groups have their manual page named \fBbtrfs\-<group>\fP\&. +.sp +For example: it is possible to run \fBbtrfs sub snaps\fP instead of +\fBbtrfs subvolume snapshot\fP\&. +But \fBbtrfs file s\fP is not allowed, because \fBfile s\fP may be interpreted +both as \fBfilesystem show\fP and as \fBfilesystem sync\fP\&. +.sp +If the command name is ambiguous, the list of conflicting options is +printed. +.sp +\fISizes\fP, both upon input and output, can be expressed in either SI or IEC\-I +units (see \fI\%numfmt(1)\fP) +with the suffix \fIB\fP appended. +All numbers will be formatted according to the rules of the \fIC\fP locale +(ignoring the shell locale, see \fI\%locale(7)\fP). +.sp +For an overview of a given command use \fBbtrfs command \-\-help\fP +or \fBbtrfs [command...] \-\-help \-\-full\fP to print all available options. +.sp +There are global options that are passed between \fIbtrfs\fP and the \fIgroup\fP name +and affect behaviour not specific to the command, e.g. verbosity or the type +of the output. +.INDENT 0.0 +.TP +.BI \-\-format \ <format> +if supported by the command, print subcommand output in that format (text, json) +.UNINDENT +.INDENT 0.0 +.TP +.B \-v|\-\-verbose +increase verbosity of the subcommand +.TP +.B \-q|\-\-quiet +print only errors +.UNINDENT +.INDENT 0.0 +.TP +.BI \-\-log \ <level> +set log level (default, info, verbose, debug, quiet) +.UNINDENT +.sp +The remaining options are relevant only for the main tool: +.INDENT 0.0 +.TP +.B \-\-help +print condensed help for all subcommands +.TP +.B \-\-version +print version string +.UNINDENT +.SH COMMANDS +.INDENT 0.0 +.TP +.B balance +Balance btrfs filesystem chunks across single or several devices. +See \fI\%btrfs\-balance(8)\fP for details. +.TP +.B check +Do off\-line check on a btrfs filesystem. +See \fI\%btrfs\-check(8)\fP for details. +.TP +.B device +Manage devices managed by btrfs, including add/delete/scan and so +on. See \fI\%btrfs\-device(8)\fP for details. +.TP +.B filesystem +Manage a btrfs filesystem, including label setting/sync and so on. +See \fI\%btrfs\-filesystem(8)\fP for details. +.TP +.B inspect\-internal +Debug tools for developers/hackers. +See \fI\%btrfs\-inspect\-internal(8)\fP for details. +.TP +.B property +Get/set a property from/to a btrfs object. +See \fI\%btrfs\-property(8)\fP for details. +.TP +.B qgroup +Manage quota group(qgroup) for btrfs filesystem. +See \fI\%btrfs\-qgroup(8)\fP for details. +.TP +.B quota +Manage quota on btrfs filesystem like enabling/rescan and etc. +See \fI\%btrfs\-quota(8)\fP and \fI\%btrfs\-qgroup(8)\fP for details. +.TP +.B receive +Receive subvolume data from stdin/file for restore and etc. +See \fI\%btrfs\-receive(8)\fP for details. +.TP +.B replace +Replace btrfs devices. +See \fI\%btrfs\-replace(8)\fP for details. +.TP +.B rescue +Try to rescue damaged btrfs filesystem. +See \fI\%btrfs\-rescue(8)\fP for details. +.TP +.B restore +Try to restore files from a damaged btrfs filesystem. +See \fI\%btrfs\-restore(8)\fP for details. +.TP +.B scrub +Scrub a btrfs filesystem. +See \fI\%btrfs\-scrub(8)\fP for details. +.TP +.B send +Send subvolume data to stdout/file for backup and etc. +See \fI\%btrfs\-send(8)\fP for details. +.TP +.B subvolume +Create/delete/list/manage btrfs subvolume. +See \fI\%btrfs\-subvolume(8)\fP for details. +.UNINDENT +.SH STANDALONE TOOLS +.sp +New functionality could be provided using a standalone tool. If the functionality +proves to be useful, then the standalone tool is declared obsolete and its +functionality is copied to the main tool. Obsolete tools are removed after a +long (years) depreciation period. +.sp +Tools that are still in active use without an equivalent in \fBbtrfs\fP: +.INDENT 0.0 +.TP +.B btrfs\-convert +in\-place conversion from ext2/3/4 filesystems to btrfs +.TP +.B btrfstune +tweak some filesystem properties on a unmounted filesystem +.TP +.B btrfs\-select\-super +rescue tool to overwrite primary superblock from a spare copy +.TP +.B btrfs\-find\-root +rescue helper to find tree roots in a filesystem +.UNINDENT +.sp +For space\-constrained environments, it\(aqs possible to build a single binary with +functionality of several standalone tools. This is following the concept of +busybox where the file name selects the functionality. This works for symlinks +or hardlinks. The full list can be obtained by \fBbtrfs help \-\-box\fP\&. +.SH EXIT STATUS +.sp +\fBbtrfs\fP returns a zero exit status if it succeeds. Non zero is returned in +case of failure. +.SH AVAILABILITY +.sp +\fBbtrfs\fP is part of btrfs\-progs. Please refer to the documentation at +\fI\%https://btrfs.readthedocs.io\fP\&. +.SH SEE ALSO +.sp +\fI\%btrfs(5)\fP, +\fI\%btrfs\-balance(8)\fP, +\fI\%btrfs\-check(8)\fP, +\fI\%btrfs\-convert(8)\fP, +\fI\%btrfs\-device(8)\fP, +\fI\%btrfs\-filesystem(8)\fP, +\fI\%btrfs\-inspect\-internal(8)\fP, +\fI\%btrfs\-property(8)\fP, +\fI\%btrfs\-qgroup(8)\fP, +\fI\%btrfs\-quota(8)\fP, +\fI\%btrfs\-receive(8)\fP, +\fI\%btrfs\-replace(8)\fP, +\fI\%btrfs\-rescue(8)\fP, +\fI\%btrfs\-restore(8)\fP, +\fI\%btrfs\-scrub(8)\fP, +\fI\%btrfs\-send(8)\fP, +\fI\%btrfs\-subvolume(8)\fP, +\fI\%btrfstune(8)\fP, +\fI\%mkfs.btrfs(8)\fP +.\" Generated by docutils manpage writer. +. diff --git a/upstream/opensuse-leap-15-6/man8/btrfstune.8 b/upstream/opensuse-leap-15-6/man8/btrfstune.8 new file mode 100644 index 00000000..f19c63a3 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/btrfstune.8 @@ -0,0 +1,178 @@ +.\" Man page generated from reStructuredText. +. +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.TH "BTRFSTUNE" "8" "Sep 13, 2023" "6.5.1" "BTRFS" +.SH NAME +btrfstune \- tune various filesystem parameters +.SH SYNOPSIS +.sp +\fBbtrfstune\fP [options] <device> [<device>...] +.SH DESCRIPTION +.sp +\fBbtrfstune\fP can be used to enable, disable, or set various filesystem +parameters. The filesystem must be unmounted. +.sp +The common use case is to enable features that were not enabled at mkfs time. +Please make sure that you have kernel support for the features. You can find a +complete list of features and kernel version of their introduction at +\fI\%Feature by version\fP page. Also, the manual page +\fI\%mkfs.btrfs(8)\fP contains more details about the features. +.sp +Some of the features could be also enabled on a mounted filesystem by other +means. Please refer to the \fIFILESYSTEM FEATURES\fP in \fI\%btrfs(5)\fP\&. +.SH OPTIONS +.INDENT 0.0 +.TP +.B \-\-convert\-to\-block\-group\-tree +(since kernel 6.1) +.sp +Convert portions of extent tree that tracks block groups to a separate +block group tree. This greatly reduces mount time. Can be also enabled +at mkfs time. +.TP +.B \-\-convert\-from\-block\-group\-tree +(since kernel 6.1) +.sp +Convert block groups tracked in standalone block group tree back to +extent tree and remove \fIblock\-group\-tree\fP feature bit from the filesystem. +.TP +.B \-\-convert\-to\-free\-space\-tree +(since kernel 4.5) +.sp +Convert to free\-space\-tree feature (v2 of space cache). +.TP +.B \-f +Allow dangerous changes, e.g. clear the seeding flag or change fsid. +Make sure that you are aware of the dangers. +.TP +.B \-m +(since kernel: 5.0) +.sp +change fsid stored as \fImetadata_uuid\fP to a randomly generated UUID, +see also \fI\-U\fP +.UNINDENT +.INDENT 0.0 +.TP +.BI \-M \ <UUID> +(since kernel: 5.0) +.sp +change fsid stored as \fImetadata_uuid\fP to a given UUID, see also \fI\-U\fP +.sp +The metadata_uuid is stored only in the superblock and is a backward +incompatible change. The fsid in metadata blocks remains unchanged and +is not overwritten, thus the whole operation is significantly faster +than \fI\-U\fP\&. +.sp +The new metadata_uuid can be used for mount by UUID and is also used to +identify devices of a multi\-device filesystem. +.TP +.B \-n +(since kernel: 3.14) +.sp +Enable no\-holes feature (more efficient representation of file holes), +enabled by mkfs feature \fIno\-holes\fP\&. +.TP +.B \-r +(since kernel: 3.7) +.sp +Enable extended inode refs (hardlink limit per file in a directory is +65536), enabled by mkfs feature \fIextref\fP\&. +.TP +.BI \-S \ <0|1> +Enable seeding on a given device. Value 1 will enable seeding, 0 will +disable it. A seeding filesystem is forced to be mounted read\-only. A +new device can be added to the filesystem and will capture all writes +keeping the seeding device intact. See also section +\fI\%SEEDING DEVICE\fP +in \fI\%btrfs(5)\fP\&. +.sp +\fBWARNING:\fP +.INDENT 7.0 +.INDENT 3.5 +Clearing the seeding flag on a device may be dangerous. If a +previously\-seeding device is changed, all filesystems that used +that device will become unmountable. Setting the seeding flag +back will not fix that. +.sp +A valid usecase is \fIseeding device as a base image\fP\&. Clear the +seeding flag, update the filesystem and make it seeding again, +provided that it\(aqs OK to throw away all filesystems built on +top of the previous base. +.UNINDENT +.UNINDENT +.TP +.B \-u +Change fsid to a randomly generated UUID or continue previous fsid +change operation in case it was interrupted. +.TP +.BI \-U \ <UUID> +Change fsid to \fIUUID\fP in all metadata blocks. +.sp +The \fIUUID\fP should be a 36 bytes string in \fBprintf(3)\fP format +\fB%08x\-%04x\-%04x\-%04x\-%012x\fP\&. +If there is a previous unfinished fsid change, it will continue only if the +\fIUUID\fP matches the unfinished one or if you use the option \fI\-u\fP\&. +.sp +All metadata blocks are rewritten, this may take some time, but the final +filesystem compatibility is unaffected, unlike \fI\-M\fP\&. +.sp +\fBWARNING:\fP +.INDENT 7.0 +.INDENT 3.5 +Cancelling or interrupting a UUID change operation will make +the filesystem temporarily unmountable. To fix it, rerun +\fBbtrfstune \-u\fP and let it complete. +.UNINDENT +.UNINDENT +.TP +.B \-x +(since kernel: 3.10) +.sp +Enable skinny metadata extent refs (more efficient representation of +extents), enabled by mkfs feature \fIskinny\-metadata\fP\&. +.sp +All newly created extents will use the new representation. To +completely switch the entire filesystem, run a full balance of the +metadata. Please refer to \fI\%btrfs\-balance(8)\fP\&. +.UNINDENT +.SH EXIT STATUS +.sp +\fBbtrfstune\fP returns 0 if no error happened, 1 otherwise. +.SH COMPATIBILITY NOTE +.sp +This deprecated tool exists for historical reasons but is still in use today. +Its functionality will be merged to the main tool, at which time \fBbtrfstune\fP +will be declared obsolete and scheduled for removal. +.SH SEE ALSO +.sp +\fI\%btrfs(5)\fP, +\fI\%btrfs\-balance(8)\fP, +\fI\%mkfs.btrfs(8)\fP +.\" Generated by docutils manpage writer. +. diff --git a/upstream/opensuse-leap-15-6/man8/cfdisk.8 b/upstream/opensuse-leap-15-6/man8/cfdisk.8 new file mode 100644 index 00000000..4e7fe603 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/cfdisk.8 @@ -0,0 +1,217 @@ +'\" t +.\" Title: cfdisk +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "CFDISK" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +cfdisk \- display or manipulate a disk partition table +.SH "SYNOPSIS" +.sp +\fBcfdisk\fP [options] [\fIdevice\fP] +.SH "DESCRIPTION" +.sp +\fBcfdisk\fP is a curses\-based program for partitioning any block device. The default device is \fI/dev/sda\fP. +.sp +Note that \fBcfdisk\fP provides basic partitioning functionality with a user\-friendly interface. If you need advanced features, use \fBfdisk\fP(8) instead. +.sp +All disk label changes will remain in memory only, and the disk will be unmodified until you decide to write your changes. Be careful before using the write command. +.sp +Since version 2.25 \fBcfdisk\fP supports MBR (DOS), GPT, SUN and SGI disk labels, but no longer provides any functionality for CHS (Cylinder\-Head\-Sector) addressing. CHS has never been important for Linux, and this addressing concept does not make any sense for new devices. +.sp +Since version 2.25 \fBcfdisk\fP also does not provide a \(aqprint\(aq command any more. This functionality is provided by the utilities \fBpartx\fP(8) and \fBlsblk\fP(8) in a very comfortable and rich way. +.sp +If you want to remove an old partition table from a device, use \fBwipefs\fP(8). +.SH "OPTIONS" +.sp +\fB\-h\fP, \fB\-\-help\fP +.RS 4 +Display help text and exit. +.RE +.sp +\fB\-L\fP, \fB\-\-color\fP[\fB=\fP\fIwhen\fP] +.RS 4 +Colorize the output. The optional argument \fIwhen\fP can be \fBauto\fP, \fBnever\fP or \fBalways\fP. If the \fIwhen\fP argument is omitted, it defaults to \fBauto\fP. The colors can be disabled, for the current built\-in default see \fB\-\-help\fP output. See also the COLORS section. +.RE +.sp +\fB\-\-lock\fP[=\fImode\fP] +.RS 4 +Use exclusive BSD lock for device or file it operates. The optional argument \fImode\fP can be \fByes\fP, \fBno\fP (or 1 and 0) or \fBnonblock\fP. If the \fImode\fP argument is omitted, it defaults to \fB"yes"\fP. This option overwrites environment variable \fB$LOCK_BLOCK_DEVICE\fP. The default is not to use any lock at all, but it\(cqs recommended to avoid collisions with udevd or other tools. +.RE +.sp +\fB\-r\fP, \fB\-\-read\-only\fP +.RS 4 +Forced open in read\-only mode. +.RE +.sp +\fB\-V\fP, \fB\-\-version\fP +.RS 4 +Display version information and exit. +.RE +.sp +\fB\-z\fP, \fB\-\-zero\fP +.RS 4 +Start with an in\-memory zeroed partition table. This option does not zero the partition table on the disk; rather, it simply starts the program without reading the existing partition table. This option allows you to create a new partition table from scratch or from an \fBsfdisk\fP(8)\-compatible script. +.RE +.SH "COMMANDS" +.sp +The commands for \fBcfdisk\fP can be entered by pressing the corresponding key (pressing \fIEnter\fP after the command is not necessary). Here is a list of the available commands: +.sp +\fBb\fP +.RS 4 +Toggle the bootable flag of the current partition. This allows you to select which primary partition is bootable on the drive. This command may not be available for all partition label types. +.RE +.sp +\fBd\fP +.RS 4 +Delete the current partition. This will convert the current partition into free space and merge it with any free space immediately surrounding the current partition. A partition already marked as free space or marked as unusable cannot be deleted. +.RE +.sp +\fBh\fP +.RS 4 +Show the help screen. +.RE +.sp +\fBn\fP +.RS 4 +Create a new partition from free space. \fBcfdisk\fP then prompts you for the size of the partition you want to create. The default size is equal to the entire available free space at the current position. +.sp +The size may be followed by a multiplicative suffix: KiB (=1024), MiB (=1024*1024), and so on for GiB, TiB, PiB, EiB, ZiB and YiB (the "iB" is optional, e.g., "K" has the same meaning as "KiB"). +.RE +.sp +\fBq\fP +.RS 4 +Quit the program. This will exit the program without writing any data to the disk. +.RE +.sp +\fBr\fP +.RS 4 +Reduce or enlarge the current partition. \fBcfdisk\fP then prompts you for the new size of the partition. The default size is the current size. A partition marked as free space or marked as unusable cannot be resized. +.sp +\fBNote that reducing the size of a partition might destroy data on that partition.\fP +.RE +.sp +\fBs\fP +.RS 4 +Sort the partitions in ascending start\-sector order. When deleting and adding partitions, it is likely that the numbering of the partitions will no longer match their order on the disk. This command restores that match. +.RE +.sp +\fBt\fP +.RS 4 +Change the partition type. By default, new partitions are created as \fILinux\fP partitions. +.RE +.sp +\fBu\fP +.RS 4 +Dump the current in\-memory partition table to an sfdisk\-compatible script file. +.sp +The script files are compatible between \fBcfdisk\fP, \fBfdisk\fP(8) \fBsfdisk\fP(8) and other libfdisk applications. For more details see \fBsfdisk\fP(8). +.sp +It is also possible to load an sfdisk\-script into \fBcfdisk\fP if there is no partition table on the device or when you start \fBcfdisk\fP with the \fB\-\-zero\fP command\-line option. +.RE +.sp +\fBW\fP +.RS 4 +Write the partition table to disk (you must enter an uppercase W). Since this might destroy data on the disk, you must either confirm or deny the write by entering `yes\(aq or `no\(aq. If you enter `yes\(aq, \fBcfdisk\fP will write the partition table to disk and then tell the kernel to re\-read the partition table from the disk. +.sp +The re\-reading of the partition table does not always work. In such a case you need to inform the kernel about any new partitions by using \fBpartprobe\fP(8) or \fBpartx\fP(8), or by rebooting the system. +.RE +.sp +\fBx\fP +.RS 4 +Toggle extra information about a partition. +.RE +.sp +\fIUp Arrow\fP, \fIDown Arrow\fP +.RS 4 +Move the cursor to the previous or next partition. If there are more partitions than can be displayed on a screen, you can display the next (previous) set of partitions by moving down (up) at the last (first) partition displayed on the screen. +.RE +.sp +\fILeft Arrow\fP, \fIRight Arrow\fP +.RS 4 +Select the preceding or the next menu item. Hitting \fIEnter\fP will execute the currently selected item. +.RE +.sp +All commands can be entered with either uppercase or lowercase letters (except for \fBW\fPrite). When in a submenu or at a prompt, you can hit the \fIEsc\fP key to return to the main menu. +.SH "COLORS" +.sp +Implicit coloring can be disabled by creating the empty file \fI/etc/terminal\-colors.d/cfdisk.disable\fP. +.sp +See \fBterminal\-colors.d\fP(5) for more details about colorization configuration. +.sp +\fBcfdisk\fP does not support color customization with a color\-scheme file. +.SH "ENVIRONMENT" +.sp +\fBCFDISK_DEBUG\fP=all +.RS 4 +enables cfdisk debug output. +.RE +.sp +\fBLIBFDISK_DEBUG\fP=all +.RS 4 +enables libfdisk debug output. +.RE +.sp +\fBLIBBLKID_DEBUG\fP=all +.RS 4 +enables libblkid debug output. +.RE +.sp +\fBLIBSMARTCOLS_DEBUG\fP=all +.RS 4 +enables libsmartcols debug output. +.RE +.sp +\fBLIBSMARTCOLS_DEBUG_PADDING\fP=on +.RS 4 +use visible padding characters. Requires enabled \fBLIBSMARTCOLS_DEBUG\fP. +.RE +.sp +\fBLOCK_BLOCK_DEVICE\fP=<mode> +.RS 4 +use exclusive BSD lock. The mode is "1" or "0". See \fB\-\-lock\fP for more details. +.RE +.SH "AUTHORS" +.sp +.MTO "kzak\(atredhat.com" "Karel Zak" "" +.sp +The current \fBcfdisk\fP implementation is based on the original \fBcfdisk\fP from \c +.MTO "martin\(atcs.unc.edu" "Kevin E. Martin" "." +.SH "SEE ALSO" +.sp +\fBfdisk\fP(8), +\fBparted\fP(8), +\fBpartprobe\fP(8), +\fBpartx\fP(8), +\fBsfdisk\fP(8) +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBcfdisk\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/chat.8 b/upstream/opensuse-leap-15-6/man8/chat.8 new file mode 100644 index 00000000..6d10836c --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/chat.8 @@ -0,0 +1,514 @@ +.\" -*- nroff -*- +.\" manual page [] for chat 1.8 +.\" $Id: chat.8,v 1.11 2004/11/13 12:22:49 paulus Exp $ +.\" SH section heading +.\" SS subsection heading +.\" LP paragraph +.\" IP indented paragraph +.\" TP hanging label +.TH CHAT 8 "22 May 1999" "Chat Version 1.22" +.SH NAME +chat \- Automated conversational script with a modem +.SH SYNOPSIS +.B chat +[ +.I options +] +.I script +.SH DESCRIPTION +.LP +The \fIchat\fR program defines a conversational exchange between the +computer and the modem. Its primary purpose is to establish the +connection between the Point-to-Point Protocol Daemon (\fIpppd\fR) and +the remote's \fIpppd\fR process. +.SH OPTIONS +.TP +.B \-f \fI<chat file> +Read the chat script from the chat \fIfile\fR. The use of this option +is mutually exclusive with the chat script parameters. The user must +have read access to the file. Multiple lines are permitted in the +file. Space or horizontal tab characters should be used to separate +the strings. +.TP +.B \-t \fI<timeout> +Set the timeout for the expected string to be received. If the string +is not received within the time limit then the reply string is not +sent. An alternate reply may be sent or the script will fail if there +is no alternate reply string. A failed script will cause the +\fIchat\fR program to terminate with a non-zero error code. +.TP +.B \-r \fI<report file> +Set the file for output of the report strings. If you use the keyword +\fIREPORT\fR, the resulting strings are written to this file. If this +option is not used and you still use \fIREPORT\fR keywords, the +\fIstderr\fR file is used for the report strings. +.TP +.B \-e +Start with the echo option turned on. Echoing may also be turned on +or off at specific points in the chat script by using the \fIECHO\fR +keyword. When echoing is enabled, all output from the modem is echoed +to \fIstderr\fR. +.TP +.B \-E +Enables environment variable substitution within chat scripts using the +standard \fI$xxx\fR syntax. +.TP +.B \-v +Request that the \fIchat\fR script be executed in a verbose mode. The +\fIchat\fR program will then log the execution state of the chat +script as well as all text received from the modem and the output +strings sent to the modem. The default is to log through the SYSLOG; +the logging method may be altered with the \-S and \-s flags. +.TP +.B \-V +Request that the \fIchat\fR script be executed in a stderr verbose +mode. The \fIchat\fR program will then log all text received from the +modem and the output strings sent to the modem to the stderr device. This +device is usually the local console at the station running the chat or +pppd program. +.TP +.B \-s +Use stderr. All log messages from '\-v' and all error messages will be +sent to stderr. +.TP +.B \-S +Do not use the SYSLOG. By default, error messages are sent to the +SYSLOG. The use of \-S will prevent both log messages from '\-v' and +error messages from being sent to the SYSLOG. +.TP +.B \-T \fI<phone number> +Pass in an arbitrary string, usually a phone number, that will be +substituted for the \eT substitution metacharacter in a send string. +.TP +.B \-U \fI<phone number 2> +Pass in a second string, usually a phone number, that will be +substituted for the \eU substitution metacharacter in a send string. +This is useful when dialing an ISDN terminal adapter that requires two +numbers. +.TP +.B script +If the script is not specified in a file with the \fI\-f\fR option then +the script is included as parameters to the \fIchat\fR program. +.SH CHAT SCRIPT +.LP +The \fIchat\fR script defines the communications. +.LP +A script consists of one or more "expect\-send" pairs of strings, +separated by spaces, with an optional "subexpect\-subsend" string pair, +separated by a dash as in the following example: +.IP +ogin:\-BREAK\-ogin: ppp ssword: hello2u2 +.LP +This line indicates that the \fIchat\fR program should expect the string +"ogin:". If it fails to receive a login prompt within the time interval +allotted, it is to send a break sequence to the remote and then expect the +string "ogin:". If the first "ogin:" is received then the break sequence is +not generated. +.LP +Once it received the login prompt the \fIchat\fR program will send the +string ppp and then expect the prompt "ssword:". When it receives the +prompt for the password, it will send the password hello2u2. +.LP +A carriage return is normally sent following the reply string. It is not +expected in the "expect" string unless it is specifically requested by using +the \er character sequence. +.LP +The expect sequence should contain only what is needed to identify the +string. Since it is normally stored on a disk file, it should not contain +variable information. It is generally not acceptable to look for time +strings, network identification strings, or other variable pieces of data as +an expect string. +.LP +To help correct for characters which may be corrupted during the initial +sequence, look for the string "ogin:" rather than "login:". It is possible +that the leading "l" character may be received in error and you may never +find the string even though it was sent by the system. For this reason, +scripts look for "ogin:" rather than "login:" and "ssword:" rather than +"password:". +.LP +A very simple script might look like this: +.IP +ogin: ppp ssword: hello2u2 +.LP +In other words, expect ....ogin:, send ppp, expect ...ssword:, send hello2u2. +.LP +In actual practice, simple scripts are rare. At the vary least, you +should include sub-expect sequences should the original string not be +received. For example, consider the following script: +.IP +ogin:\-\-ogin: ppp ssword: hello2u2 +.LP +This would be a better script than the simple one used earlier. This would look +for the same login: prompt, however, if one was not received, a single +return sequence is sent and then it will look for login: again. Should line +noise obscure the first login prompt then sending the empty line will +usually generate a login prompt again. +.SH COMMENTS +Comments can be embedded in the chat script. A comment is a line which +starts with the \fB#\fR (hash) character in column 1. Such comment +lines are just ignored by the chat program. If a '#' character is to +be expected as the first character of the expect sequence, you should +quote the expect string. +If you want to wait for a prompt that starts with a # (hash) +character, you would have to write something like this: +.IP +# Now wait for the prompt and send logout string +.br +\&'# ' logout +.LP + +.SH SENDING DATA FROM A FILE +If the string to send starts with an at sign (@), the rest of the +string is taken to be the name of a file to read to get the string to +send. If the last character of the data read is a newline, it is +removed. The file can be a named pipe (or fifo) instead of a regular +file. This provides a way for \fBchat\fR to communicate with another +program, for example, a program to prompt the user and receive a +password typed in. +.LP + +.SH ABORT STRINGS +Many modems will report the status of the call as a string. These +strings may be \fBCONNECTED\fR or \fBNO CARRIER\fR or \fBBUSY\fR. It +is often desirable to terminate the script should the modem fail to +connect to the remote. The difficulty is that a script would not know +exactly which modem string it may receive. On one attempt, it may +receive \fBBUSY\fR while the next time it may receive \fBNO CARRIER\fR. +.LP +These "abort" strings may be specified in the script using the \fIABORT\fR +sequence. It is written in the script as in the following example: +.IP +ABORT BUSY ABORT 'NO CARRIER' '' ATZ OK ATDT5551212 CONNECT +.LP +This sequence will expect nothing; and then send the string ATZ. The +expected response to this is the string \fIOK\fR. When it receives \fIOK\fR, +the string ATDT5551212 to dial the telephone. The expected string is +\fICONNECT\fR. If the string \fICONNECT\fR is received the remainder of the +script is executed. However, should the modem find a busy telephone, it will +send the string \fIBUSY\fR. This will cause the string to match the abort +character sequence. The script will then fail because it found a match to +the abort string. If it received the string \fINO CARRIER\fR, it will abort +for the same reason. Either string may be received. Either string will +terminate the \fIchat\fR script. +.SH CLR_ABORT STRINGS +This sequence allows for clearing previously set \fBABORT\fR strings. +\fBABORT\fR strings are kept in an array of a pre-determined size (at +compilation time); \fBCLR_ABORT\fR will reclaim the space for cleared +entries so that new strings can use that space. +.SH SAY STRINGS +The \fBSAY\fR directive allows the script to send strings to the user +at the terminal via standard error. If \fBchat\fR is being run by +pppd, and pppd is running as a daemon (detached from its controlling +terminal), standard error will normally be redirected to the file +/etc/ppp/connect\-errors. +.LP +\fBSAY\fR strings must be enclosed in single or double quotes. If +carriage return and line feed are needed in the string to be output, +you must explicitly add them to your string. +.LP +The SAY strings could be used to give progress messages in sections of +the script where you want to have 'ECHO OFF' but still let the user +know what is happening. An example is: +.IP +ABORT BUSY +.br +ECHO OFF +.br +SAY "Dialling your ISP...\en" +.br +\&'' ATDT5551212 +.br +TIMEOUT 120 +.br +SAY "Waiting up to 2 minutes for connection ... " +.br +CONNECT '' +.br +SAY "Connected, now logging in ...\en" +.br +ogin: account +.br +ssword: pass +.br +$ \ec +.br +SAY "Logged in OK ...\en" +\fIetc ...\fR +.LP +This sequence will only present the SAY strings to the user and all +the details of the script will remain hidden. For example, if the +above script works, the user will see: +.IP +Dialling your ISP... +.br +Waiting up to 2 minutes for connection ... Connected, now logging in ... +.br +Logged in OK ... +.LP + +.SH REPORT STRINGS +A \fBreport\fR string is similar to the ABORT string. The difference +is that the strings, and all characters to the next control character +such as a carriage return, are written to the report file. +.LP +The report strings may be used to isolate the transmission rate of the +modem's connect string and return the value to the chat user. The +analysis of the report string logic occurs in conjunction with the +other string processing such as looking for the expect string. The use +of the same string for a report and abort sequence is probably not +very useful, however, it is possible. +.LP +The report strings to no change the completion code of the program. +.LP +These "report" strings may be specified in the script using the \fIREPORT\fR +sequence. It is written in the script as in the following example: +.IP +REPORT CONNECT ABORT BUSY '' ATDT5551212 CONNECT '' ogin: account +.LP +This sequence will expect nothing; and then send the string +ATDT5551212 to dial the telephone. The expected string is +\fICONNECT\fR. If the string \fICONNECT\fR is received the remainder +of the script is executed. In addition the program will write to the +expect\-file the string "CONNECT" plus any characters which follow it +such as the connection rate. +.SH CLR_REPORT STRINGS +This sequence allows for clearing previously set \fBREPORT\fR strings. +\fBREPORT\fR strings are kept in an array of a pre-determined size (at +compilation time); \fBCLR_REPORT\fR will reclaim the space for cleared +entries so that new strings can use that space. +.SH ECHO +The echo options controls whether the output from the modem is echoed +to \fIstderr\fR. This option may be set with the \fI\-e\fR option, but +it can also be controlled by the \fIECHO\fR keyword. The "expect\-send" +pair \fIECHO\fR \fION\fR enables echoing, and \fIECHO\fR \fIOFF\fR +disables it. With this keyword you can select which parts of the +conversation should be visible. For instance, with the following +script: +.IP +ABORT 'BUSY' +.br +ABORT 'NO CARRIER' +.br +\&'' ATZ +.br +OK\er\en ATD1234567 +.br +\er\en \ec +.br +ECHO ON +.br +CONNECT \ec +.br +ogin: account +.LP +all output resulting from modem configuration and dialing is not visible, +but starting with the \fICONNECT\fR (or \fIBUSY\fR) message, everything +will be echoed. +.SH HANGUP +The HANGUP options control whether a modem hangup should be considered +as an error or not. This option is useful in scripts for dialling +systems which will hang up and call your system back. The HANGUP +options can be \fBON\fR or \fBOFF\fR. +.br +When HANGUP is set OFF and the modem hangs up (e.g., after the first +stage of logging in to a callback system), \fBchat\fR will continue +running the script (e.g., waiting for the incoming call and second +stage login prompt). As soon as the incoming call is connected, you +should use the \fBHANGUP ON\fR directive to reinstall normal hang up +signal behavior. Here is an (simple) example script: +.IP +ABORT 'BUSY' +.br +\&'' ATZ +.br +OK\er\en ATD1234567 +.br +\er\en \ec +.br +CONNECT \ec +.br +\&'Callback login:' call_back_ID +.br +HANGUP OFF +.br +ABORT "Bad Login" +.br +\&'Callback Password:' Call_back_password +.br +TIMEOUT 120 +.br +CONNECT \ec +.br +HANGUP ON +.br +ABORT "NO CARRIER" +.br +ogin:\-\-BREAK\-\-ogin: real_account +.br +\fIetc ...\fR +.LP +.SH TIMEOUT +The initial timeout value is 45 seconds. This may be changed using the \fB\-t\fR +parameter. +.LP +To change the timeout value for the next expect string, the following +example may be used: +.IP +ATZ OK ATDT5551212 CONNECT TIMEOUT 10 ogin:\-\-ogin: TIMEOUT 5 assword: hello2u2 +.LP +This will change the timeout to 10 seconds when it expects the login: +prompt. The timeout is then changed to 5 seconds when it looks for the +password prompt. +.LP +The timeout, once changed, remains in effect until it is changed again. +.SH SENDING EOT +The special reply string of \fIEOT\fR indicates that the chat program +should send an EOT character to the remote. This is normally the +End-of-file character sequence. A return character is not sent +following the EOT. +The EOT sequence may be embedded into the send string using the +sequence \fI^D\fR. +.SH GENERATING BREAK +The special reply string of \fIBREAK\fR will cause a break condition +to be sent. The break is a special signal on the transmitter. The +normal processing on the receiver is to change the transmission rate. +It may be used to cycle through the available transmission rates on +the remote until you are able to receive a valid login prompt. +The break sequence may be embedded into the send string using the +\fI\eK\fR sequence. +.SH ESCAPE SEQUENCES +The expect and reply strings may contain escape sequences. All of the +sequences are legal in the reply string. Many are legal in the expect. +Those which are not valid in the expect sequence are so indicated. +.TP +.B '' +Expects or sends a null string. If you send a null string then it will still +send the return character. This sequence may either be a pair of apostrophe +or quote characters. +.TP +.B \eb +represents a backspace character. +.TP +.B \ec +Suppresses the newline at the end of the reply string. This is the only +method to send a string without a trailing return character. It must +be at the end of the send string. For example, +the sequence hello\ec will simply send the characters h, e, l, l, o. +.I (not valid in expect.) +.TP +.B \ed +Delay for one second. The program uses sleep(1) which will delay to a +maximum of one second. +.I (not valid in expect.) +.TP +.B \eK +Insert a BREAK +.I (not valid in expect.) +.TP +.B \en +Send a newline or linefeed character. +.TP +.B \eN +Send a null character. The same sequence may be represented by \e0. +.I (not valid in expect.) +.TP +.B \ep +Pause for a fraction of a second. The delay is 1/10th of a second. +.I (not valid in expect.) +.TP +.B \eq +Suppress writing the string to the SYSLOG file. The string ?????? is +written to the log in its place. +.I (not valid in expect.) +.TP +.B \er +Send or expect a carriage return. +.TP +.B \es +Represents a space character in the string. This may be used when it +is not desirable to quote the strings which contains spaces. The +sequence 'HI TIM' and HI\esTIM are the same. +.TP +.B \et +Send or expect a tab character. +.TP +.B \eT +Send the phone number string as specified with the \fI\-T\fR option +.I (not valid in expect.) +.TP +.B \eU +Send the phone number 2 string as specified with the \fI\-U\fR option +.I (not valid in expect.) +.TP +.B \e\e +Send or expect a backslash character. +.TP +.B \eddd +Collapse the octal digits (ddd) into a single ASCII character and send that +character. +.I (some characters are not valid in expect.) +.TP +.B \^^C +Substitute the sequence with the control character represented by C. +For example, the character DC1 (17) is shown as \^^Q. +.I (some characters are not valid in expect.) +.SH ENVIRONMENT VARIABLES +Environment variables are available within chat scripts, if the \fI\-E\fR +option was specified in the command line. The metacharacter \fI$\fR is used +to introduce the name of the environment variable to substitute. If the +substitution fails, because the requested environment variable is not set, +\fInothing\fR is replaced for the variable. +.SH TERMINATION CODES +The \fIchat\fR program will terminate with the following completion +codes. +.TP +.B 0 +The normal termination of the program. This indicates that the script +was executed without error to the normal conclusion. +.TP +.B 1 +One or more of the parameters are invalid or an expect string was too +large for the internal buffers. This indicates that the program as not +properly executed. +.TP +.B 2 +An error occurred during the execution of the program. This may be due +to a read or write operation failing for some reason or chat receiving +a signal such as SIGINT. +.TP +.B 3 +A timeout event occurred when there was an \fIexpect\fR string without +having a "\-subsend" string. This may mean that you did not program the +script correctly for the condition or that some unexpected event has +occurred and the expected string could not be found. +.TP +.B 4 +The first string marked as an \fIABORT\fR condition occurred. +.TP +.B 5 +The second string marked as an \fIABORT\fR condition occurred. +.TP +.B 6 +The third string marked as an \fIABORT\fR condition occurred. +.TP +.B 7 +The fourth string marked as an \fIABORT\fR condition occurred. +.TP +.B ... +The other termination codes are also strings marked as an \fIABORT\fR +condition. +.LP +Using the termination code, it is possible to determine which event +terminated the script. It is possible to decide if the string "BUSY" +was received from the modem as opposed to "NO DIAL TONE". While the +first event may be retried, the second will probably have little +chance of succeeding during a retry. +.SH SEE ALSO +Additional information about \fIchat\fR scripts may be found with UUCP +documentation. The \fIchat\fR script was taken from the ideas proposed +by the scripts used by the \fIuucico\fR program. +.LP +uucico(1), uucp(1) +.SH COPYRIGHT +The \fIchat\fR program is in public domain. This is not the GNU public +license. If it breaks then you get to keep both pieces. diff --git a/upstream/opensuse-leap-15-6/man8/chcpu.8 b/upstream/opensuse-leap-15-6/man8/chcpu.8 new file mode 100644 index 00000000..c74d998e --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/chcpu.8 @@ -0,0 +1,129 @@ +'\" t +.\" Title: chcpu +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "CHCPU" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +chcpu \- configure CPUs +.SH "SYNOPSIS" +.sp +\fBchcpu\fP \fB\-c\fP|\fB\-d\fP|\fB\-e\fP|\fB\-g\fP \fIcpu\-list\fP +.sp +\fBchcpu\fP \fB\-p\fP \fImode\fP +.sp +\fBchcpu\fP \fB\-r\fP|\fB\-h\fP|\fB\-V\fP +.SH "DESCRIPTION" +.sp +\fBchcpu\fP can modify the state of CPUs. It can enable or disable CPUs, scan for new CPUs, change the CPU dispatching \fImode\fP of the underlying hypervisor, and request CPUs from the hypervisor (configure) or return CPUs to the hypervisor (deconfigure). +.sp +Some options have a \fIcpu\-list\fP argument. Use this argument to specify a comma\-separated list of CPUs. The list can contain individual CPU addresses or ranges of addresses. For example, \fB0,5,7,9\-11\fP makes the command applicable to the CPUs with the addresses 0, 5, 7, 9, 10, and 11. +.SH "OPTIONS" +.sp +\fB\-c\fP, \fB\-\-configure\fP \fIcpu\-list\fP +.RS 4 +Configure the specified CPUs. Configuring a CPU means that the hypervisor takes a CPU from the CPU pool and assigns it to the virtual hardware on which your kernel runs. +.RE +.sp +\fB\-d\fP, \fB\-\-disable\fP \fIcpu\-list\fP +.RS 4 +Disable the specified CPUs. Disabling a CPU means that the kernel sets it offline. +.RE +.sp +\fB\-e\fP, \fB\-\-enable\fP \fIcpu\-list\fP +.RS 4 +Enable the specified CPUs. Enabling a CPU means that the kernel sets it online. A CPU must be configured, see \fB\-c\fP, before it can be enabled. +.RE +.sp +\fB\-g\fP, \fB\-\-deconfigure\fP \fIcpu\-list\fP +.RS 4 +Deconfigure the specified CPUs. Deconfiguring a CPU means that the hypervisor removes the CPU from the virtual hardware on which the Linux instance runs and returns it to the CPU pool. A CPU must be offline, see \fB\-d\fP, before it can be deconfigured. +.RE +.sp +\fB\-p\fP, \fB\-\-dispatch\fP \fImode\fP +.RS 4 +Set the CPU dispatching \fImode\fP (polarization). This option has an effect only if your hardware architecture and hypervisor support CPU polarization. Available \fImodes\fP are: +.sp +\fBhorizontal\fP +.RS 4 +The workload is spread across all available CPUs. +.RE +.sp +\fBvertical\fP +.RS 4 +The workload is concentrated on few CPUs. +.RE +.RE +.sp +\fB\-r\fP, \fB\-\-rescan\fP +.RS 4 +Trigger a rescan of CPUs. After a rescan, the Linux kernel recognizes the new CPUs. Use this option on systems that do not automatically detect newly attached CPUs. +.RE +.sp +\fB\-V\fP, \fB\-\-version\fP +.RS 4 +Display version information and exit. +.RE +.sp +\fB\-h\fP, \fB\-\-help\fP +.RS 4 +Display help text and exit. +.RE +.SH "EXIT STATUS" +.sp +\fBchcpu\fP has the following exit status values: +.sp +\fB0\fP +.RS 4 +success +.RE +.sp +\fB1\fP +.RS 4 +failure +.RE +.sp +\fB64\fP +.RS 4 +partial success +.RE +.SH "AUTHORS" +.sp +.MTO "heiko.carstens\(atde.ibm.com" "Heiko Carstens" "" +.SH "COPYRIGHT" +.sp +Copyright IBM Corp. 2011 +.SH "SEE ALSO" +.sp +\fBlscpu\fP(1) +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBchcpu\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/chmem.8 b/upstream/opensuse-leap-15-6/man8/chmem.8 new file mode 100644 index 00000000..0a1274a5 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/chmem.8 @@ -0,0 +1,173 @@ +'\" t +.\" Title: chmem +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "CHMEM" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +chmem \- configure memory +.SH "SYNOPSIS" +.sp +\fBchmem\fP [\fB\-h] [\fP\-V*] [\fB\-v\fP] [\fB\-e\fP|\fB\-d\fP] [\fISIZE\fP|\fIRANGE\fP \fB\-b\fP \fIBLOCKRANGE\fP] [\fB\-z\fP \fIZONE\fP] +.SH "DESCRIPTION" +.sp +The chmem command sets a particular size or range of memory online or offline. +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +. sp -1 +. IP \(bu 2.3 +.\} +Specify \fISIZE\fP as <size>[m|M|g|G]. With m or M, <size> specifies the memory size in MiB (1024 x 1024 bytes). With g or G, <size> specifies the memory size in GiB (1024 x 1024 x 1024 bytes). The default unit is MiB. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +. sp -1 +. IP \(bu 2.3 +.\} +Specify \fIRANGE\fP in the form 0x<start>\-0x<end> as shown in the output of the \fBlsmem\fP(1) command. <start> is the hexadecimal address of the first byte and <end> is the hexadecimal address of the last byte in the memory range. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +. sp -1 +. IP \(bu 2.3 +.\} +Specify \fIBLOCKRANGE\fP in the form <first>\-<last> or <block> as shown in the output of the \fBlsmem\fP(1) command. <first> is the number of the first memory block and <last> is the number of the last memory block in the memory range. Alternatively a single block can be specified. \fIBLOCKRANGE\fP requires the \fB\-\-blocks\fP option. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +. sp -1 +. IP \(bu 2.3 +.\} +Specify \fIZONE\fP as the name of a memory zone, as shown in the output of the \fBlsmem \-o +ZONES\fP command. The output shows one or more valid memory zones for each memory range. If multiple zones are shown, then the memory range currently belongs to the first zone. By default, \fBchmem\fP will set memory online to the zone Movable, if this is among the valid zones. This default can be changed by specifying the \fB\-\-zone\fP option with another valid zone. For memory ballooning, it is recommended to select the zone Movable for memory online and offline, if possible. Memory in this zone is much more likely to be able to be offlined again, but it cannot be used for arbitrary kernel allocations, only for migratable pages (e.g., anonymous and page cache pages). Use the \fB\-\-help\fP option to see all available zones. +.RE +.sp +\fISIZE\fP and \fIRANGE\fP must be aligned to the Linux memory block size, as shown in the output of the \fBlsmem\fP(1) command. +.sp +Setting memory online can fail for various reasons. On virtualized systems it can fail if the hypervisor does not have enough memory left, for example because memory was overcommitted. Setting memory offline can fail if Linux cannot free the memory. If only part of the requested memory can be set online or offline, a message tells you how much memory was set online or offline instead of the requested amount. +.sp +When setting memory online \fBchmem\fP starts with the lowest memory block numbers. When setting memory offline \fBchmem\fP starts with the highest memory block numbers. +.SH "OPTIONS" +.sp +\fB\-b\fP, \fB\-\-blocks\fP +.RS 4 +Use a \fIBLOCKRANGE\fP parameter instead of \fIRANGE\fP or \fISIZE\fP for the \fB\-\-enable\fP and \fB\-\-disable\fP options. +.RE +.sp +\fB\-d\fP, \fB\-\-disable\fP +.RS 4 +Set the specified \fIRANGE\fP, \fISIZE\fP, or \fIBLOCKRANGE\fP of memory offline. +.RE +.sp +\fB\-e\fP, \fB\-\-enable\fP +.RS 4 +Set the specified \fIRANGE\fP, \fISIZE\fP, or \fIBLOCKRANGE\fP of memory online. +.RE +.sp +\fB\-z\fP, \fB\-\-zone\fP +.RS 4 +Select the memory \fIZONE\fP where to set the specified \fIRANGE\fP, \fISIZE\fP, or \fIBLOCKRANGE\fP of memory online or offline. By default, memory will be set online to the zone Movable, if possible. +.RE +.sp +\fB\-h\fP, \fB\-\-help\fP +.RS 4 +Print a short help text, then exit. +.RE +.sp +\fB\-v\fP, \fB\-\-verbose\fP +.RS 4 +Verbose mode. Causes \fBchmem\fP to print debugging messages about it\(cqs progress. +.RE +.sp +\fB\-V\fP, \fB\-\-version\fP +.RS 4 +Print the version number, then exit. +.RE +.SH "EXIT STATUS" +.sp +\fBchmem\fP has the following exit status values: +.sp +\fB0\fP +.RS 4 +success +.RE +.sp +\fB1\fP +.RS 4 +failure +.RE +.sp +\fB64\fP +.RS 4 +partial success +.RE +.SH "EXAMPLE" +.sp +\fBchmem \-\-enable 1024\fP +.RS 4 +This command requests 1024 MiB of memory to be set online. +.RE +.sp +\fBchmem \-e 2g\fP +.RS 4 +This command requests 2 GiB of memory to be set online. +.RE +.sp +\fBchmem \-\-disable 0x00000000e4000000\-0x00000000f3ffffff\fP +.RS 4 +This command requests the memory range starting with 0x00000000e4000000 and ending with 0x00000000f3ffffff to be set offline. +.RE +.sp +\fBchmem \-b \-d 10\fP +.RS 4 +This command requests the memory block number 10 to be set offline. +.RE +.SH "SEE ALSO" +.sp +\fBlsmem\fP(1) +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBchmem\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/clockdiff.8 b/upstream/opensuse-leap-15-6/man8/clockdiff.8 new file mode 100644 index 00000000..b782dc43 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/clockdiff.8 @@ -0,0 +1,112 @@ +'\" t +.TH "CLOCKDIFF" "8" "" "iputils 20221126" "iputils" +.\" ----------------------------------------------------------------- +.\" * 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" +clockdiff \- measure clock difference between hosts +.SH "SYNOPSIS" +.HP \w'\fBclockdiff\fR\ 'u +\fBclockdiff\fR [\fB\-o\fR] [\fB\-o1\fR] [\fB\-\-time\-format\ \fR\fB\fIctime\ iso\fR\fR] [\fB\-V\fR] {destination} +.SH "DESCRIPTION" +.PP +\fBclockdiff\fR +Measures clock difference between us and +\fIdestination\fR +with 1 msec resolution using ICMP TIMESTAMP [2] packets or, optionally, IP TIMESTAMP option [3] added to ICMP ECHO\&. [1] +.SH "OPTIONS" +.PP +\fB\-o\fR +.RS 4 +Use IP TIMESTAMP with ICMP ECHO instead of ICMP TIMESTAMP messages\&. It is useful with some destinations, which do not support ICMP TIMESTAMP (f\&.e\&. Solaris <2\&.4)\&. +.RE +.PP +\fB\-o1\fR +.RS 4 +Slightly different form of +\fB\-o\fR, namely it uses three\-term IP TIMESTAMP with prespecified hop addresses instead of four term one\&. What flavor works better depends on target host\&. Particularly, +\fB\-o\fR +is better for Linux\&. +.RE +.PP +\fB\-T\fR, \fB\-\-time\-format \fR\fB\fIctime iso\fR\fR +.RS 4 +Print time stamp in output either ISO\-8601 format or classical ctime format\&. The ctime format is default\&. The ISO time stamp includes timezone, and is easier to parse\&. +.RE +.PP +\fB\-I\fR +.RS 4 +Alias of +\fB\-\-time\-format \fR\fB\fIiso\fR\fR\fB \fR +option and argument\&. +.RE +.PP +\fB\-h\fR, \fB\-\-help\fR +.RS 4 +Print help and exit\&. +.RE +.PP +\fB\-V\fR, \fB\-\-version\fR +.RS 4 +Print version and exit\&. +.RE +.SH "WARNINGS" +.PP +.RS 4 +\(bu Some nodes (Cisco) use non\-standard timestamps, which is allowed by RFC, but makes timestamps mostly useless\&. +.RE +.PP +.RS 4 +\(bu Some nodes generate messed timestamps (Solaris>2\&.4), when run +\fBxntpd\fR\&. Seems, its IP stack uses a corrupted clock source, which is synchronized to time\-of\-day clock periodically and jumps randomly making timestamps mostly useless\&. Good news is that you can use NTP in this case, which is even better\&. +.RE +.PP +.RS 4 +\(bu +\fBclockdiff\fR +shows difference in time modulo 24 days\&. +.RE +.SH "SEE ALSO" +.PP +\fBping\fR(8), +\fBarping\fR(8), +\fBtracepath\fR(8)\&. +.SH "REFERENCES" +.PP +[1] ICMP ECHO, RFC0792, page 14\&. +.PP +[2] ICMP TIMESTAMP, RFC0792, page 16\&. +.PP +[3] IP TIMESTAMP option, RFC0791, 3\&.1, page 16\&. +.SH "AUTHOR" +.PP +\fBclockdiff\fR +was compiled by Alexey Kuznetsov <kuznet@ms2\&.inr\&.ac\&.ru>\&. It was based on code borrowed from BSD +\fBtimed\fR +daemon\&. +.SH "SECURITY" +.PP +\fBclockdiff\fR +requires CAP_NET_RAW and CAP_SYS_NICE capabilities to be executed\&. It is safe to be used as set\-uid root\&. +.SH "AVAILABILITY" +.PP +\fBclockdiff\fR +is part of +\fIiputils\fR +package\&. diff --git a/upstream/opensuse-leap-15-6/man8/clrunimap.8 b/upstream/opensuse-leap-15-6/man8/clrunimap.8 new file mode 100644 index 00000000..61fe4a51 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/clrunimap.8 @@ -0,0 +1,24 @@ +.TH CLRUNIMAP 8 "2002-10-12" "kbd" + +.SH NAME +clrunimap \- Clear the current console unicode map + +.SH SYNOPSIS +.B clrunimap + +.SH DESCRIPTION + +The command +.B clrunimap +clears the unicode map (also called "Screen Font Map") for the current console. + +.SH NOTES +If you are not the maintainer of the kbd package, it is very unlikely +that you want to use this command. On many kernels the result will be +that your screen is black. On some kernels a reboot will be necessary. +.br +Use +.B "setfont -u" +to load a Unicode map for a console. +.SH SEE ALSO +.BR setfont (8). diff --git a/upstream/opensuse-leap-15-6/man8/combinedeltarpm.8 b/upstream/opensuse-leap-15-6/man8/combinedeltarpm.8 new file mode 100644 index 00000000..ce70cbd8 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/combinedeltarpm.8 @@ -0,0 +1,52 @@ +.\" man page for combinedeltarpm +.\" Copyright (c) 2005 Michael Schroeder <mls@suse.de> +.\" See LICENSE.BSD for license +.TH COMBINEDELTARPM 8 "May 2005" +.SH NAME +combindeltarpm \- combine multiple deltarpms to a single one + +.SH SYNOPSIS +.B combinedeltarpm +.RB [ -v ] +.RB [ -V +.IR version ] +.RB [ -z +.IR compression ] +.RB [ -S +.IR signaturerpm ] +.I olddeltarpms... +.I newdeltarpm + +.SH DESCRIPTION +combinedeltarpm creates a new deltarpm from multiple old ones. +Applying the rsulting deltarpm has the same effect as applying +each of the old ones in the specified order. Use the +.B -v +option to make combinedeltarpm more verbose about its work. +.PP +combinedeltarpm normally produces a V3 format deltarpm, use the +.B -V +option to specify a different version if desired. The +.B -z +option can be used to specify a different compression method, the +default is to use the same compression method as used in the +last of the old deltarpms. +.PP +If you want to use a different header +signature you can also specify a rpm with the +.B -S +option which will be used as signature reference. This feature can +be used to if a deltarpm was made against an unsigned rpm which +later got signed. + +.SH MEMORY CONSIDERATIONS +The implementation of combinedeltarpm currently unpacks the +add-blocks of the deltarpms in memory, thus it needs about twice +the uncompressed payload size of the target rpm. + +.SH SEE ALSO +.BR makedeltarpm (8) +.BR applydeltarpm (8) + +.SH AUTHOR +Michael Schroeder <mls@suse.de> diff --git a/upstream/opensuse-leap-15-6/man8/convertquota.8 b/upstream/opensuse-leap-15-6/man8/convertquota.8 new file mode 100644 index 00000000..5313c7e0 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/convertquota.8 @@ -0,0 +1,73 @@ +.TH CONVERTQUOTA 8 "Fri Aug 20 1999" +.UC 4 +.SH NAME +convertquota \- convert quota from old file format to new one +.SH SYNOPSIS +.B convertquota +[ +.B -ug +] +.B -e +.I filesystem +.LP +.B convertquota +[ +.B -ug +] +.B -f +.IR oldformat , newformat +.I filesystem +.SH DESCRIPTION +.B convertquota +converts old quota files +.BR quota.user +and +.BR quota.group +to files +.BR aquota.user +and +.BR aquota.group +in new format currently used by 2.4.0-ac? and newer or by SuSE or Red Hat Linux 2.4 kernels on +.IR filesystem . +.PP +New file format allows using quotas for 32-bit uids / gids, setting quotas for root, +accounting used space in bytes (and so allowing use of quotas in ReiserFS) and it +is also architecture independent. This format introduces Radix Tree (a simple form of tree +structure) to quota file. +.SH OPTIONS +.TP +.B -u, --user +convert user quota file. This is the default. +.TP +.B -g, --group +convert group quota file. +.TP +.B -f, --convert-format \f2oldformat,newformat\f1 +convert quota file from +.I oldformat +to +.IR newformat . +.TP +.B -e, --convert-endian +convert vfsv0 file format from big endian to little endian (old kernels had +a bug and did not store quota files in little endian format). +.TP +.B -V, --version +print version information. +.SH FILES +.TP 20 +.B aquota.user +new user quota file +.TP +.B aquota.group +new group quota file +.SH "SEE ALSO" +.BR quota (1), +.BR setquota (8), +.BR edquota (8), +.BR quotacheck (8), +.BR quotaon (8), +.BR repquota (8) +.SH AUTHOR +Jan Kara \<jack@suse.cz\> + diff --git a/upstream/opensuse-leap-15-6/man8/cron.8 b/upstream/opensuse-leap-15-6/man8/cron.8 new file mode 100644 index 00000000..032d1deb --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/cron.8 @@ -0,0 +1,282 @@ +.\"/* Copyright 1988,1990,1993,1996 by Paul Vixie +.\" * All rights reserved +.\" */ +.\" +.\" Copyright (c) 2004 by Internet Systems Consortium, Inc. ("ISC") +.\" Copyright (c) 1997,2000 by Internet Software Consortium, Inc. +.\" +.\" Permission to use, copy, modify, and distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT +.\" OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.\" Modified 2010/09/12 by Colin Dean, Durham University IT Service, +.\" to add clustering support. +.\" +.\" $Id: cron.8,v 1.8 2004/01/23 19:03:32 vixie Exp $ +.\" +.TH CRON "8" "2013-09-26" "cronie" "System Administration" +.SH NAME +crond \- daemon to execute scheduled commands +.SH SYNOPSIS +.B crond +.RB [ -c " | " -h " | " -i " | " -n " | " -p " | " -P " | " -s " | " -m \fP\fI<mail command>\fP ] +.br +.B crond +.B -x +.RB [ext,sch,proc,pars,load,misc,test,bit] +.br +.B crond +.B -V +.SH DESCRIPTION +.I Cron +is started from +.I /etc/rc.d/init.d +or +.I /etc/init.d +when classical sysvinit scripts are used. In case systemd is enabled, then unit file is installed into +.I /lib/systemd/system/crond.service +and daemon is started by +.I systemctl start crond.service +command. It returns immediately, thus, there is no need to need to start it with +the '&' parameter. +.PP +.I Cron +searches +.I /var/spool/cron +for crontab files which are named after accounts in +.I /etc/passwd; +The found crontabs are loaded into the memory. +.I Cron +also searches for +.I /etc/crontab +and any files in the +.I /etc/cron.d +directory, which have a different format (see +.BR crontab (5)). +.I Cron +examines all stored crontabs and checks each job to see if it needs to be +run in the current minute. When executing commands, any output is mailed +to the owner of the crontab (or to the user specified in the +.I MAILTO +environment variable in the crontab, if such exists). Any job output can +also be sent to syslog by using the +.B "\-s" +option. +.PP +There are two ways how changes in crontables are checked. The first +method is checking the modtime of a file. The second method is using the +inotify support. Using of inotify is logged in the +.I /var/log/cron +log after the daemon is started. The inotify support checks for changes +in all crontables and accesses the hard disk only when a change is +detected. +.PP +When using the modtime option, +.I Cron +checks its crontables' modtimes every minute to check for any changes and +reloads the crontables which have changed. There is no need to restart +.I Cron +after some of the crontables were modified. The modtime option is also +used when inotify can not be initialized. +.PP +.I Cron +checks these files and directories: +.TP +.IR /etc/crontab +system crontab. Nowadays the file is empty by default. Originally it +was usually used to run daily, weekly, monthly jobs. By default these +jobs are now run through anacron which reads +.IR /etc/anacrontab +configuration file. See +.BR anacrontab (5) +for more details. +.TP +.IR /etc/cron.d/ +directory that contains system cronjobs stored for different users. +.TP +.IR /var/spool/cron +directory that contains user crontables created by the +.IR crontab +command. +.PP +Note that the +.BR crontab (1) +command updates the modtime of the spool directory whenever it changes a +crontab. +.PP +.SS Daylight Saving Time and other time changes +Local time changes of less than three hours, such as those caused by the +Daylight Saving Time changes, are handled in a special way. This only +applies to jobs that run at a specific time and jobs that run with a +granularity greater than one hour. Jobs that run more frequently are +scheduled normally. +.PP +If time was adjusted one hour forward, those jobs that would have run in +the interval that has been skipped will be run immediately. Conversely, +if time was adjusted backward, running the same job twice is avoided. +.PP +Time changes of more than 3 hours are considered to be corrections to the +clock or the timezone, and the new time is used immediately. +.PP +It is possible to use different time zones for crontables. See +.BR crontab (5) +for more information. +.SS PAM Access Control +.IR Cron +supports access control with PAM if the system has PAM installed. For +more information, see +.BR pam (8). +A PAM configuration file for +.IR crond +is installed in +.IR /etc/pam.d/crond . +The daemon loads the PAM environment from the pam_env module. This can +be overridden by defining specific settings in the appropriate crontab +file. +.SH "OPTIONS" +.TP +.B "\-h" +Prints a help message and exits. +.TP +.B "\-i" +Disables inotify support. +.TP +.B "\-m" +This option allows you to specify a shell command to use for sending +.I Cron +mail output instead of using +.BR sendmail (8) +This command must accept a fully formatted mail message (with headers) on +standard input and send it as a mail message to the recipients specified +in the mail headers. Specifying the string +.I "off" +(i.e., crond -m off) +will disable the sending of mail. +.TP +.B "\-n" +Tells the daemon to run in the foreground. This can be useful when +starting it out of init. With this option is needed to change pam setting. +.I /etc/pam.d/crond +must not enable +.I pam_loginuid.so +module. +.TP +.B "\-p" +Allows +.I Cron +to accept any user set crontables. +.TP +.B "\-P" +Don't set PATH. PATH is instead inherited from the environment. +.TP +.B "\-c" +This option enables clustering support, as described below. +.TP +.B "\-s" +This option will direct +.I Cron +to send the job output to the system log using +.BR syslog (3). +This is useful if your system does not have +.BR sendmail (8), +installed or if mail is disabled. +.TP +.B "\-x" +This option allows you to set debug flags. +.TP +.B "\-V" +Print version and exit. +.SH SIGNALS +When the +.I SIGHUP +is received, the +.I Cron +daemon will close and reopen its log file. This proves to be useful in +scripts which rotate and age log files. Naturally, this is not relevant +if +.I Cron +was built to use +.IR syslog (3). +.SH CLUSTERING SUPPORT +In this version of +.IR Cron +it is possible to use a network-mounted shared +.I /var/spool/cron +across a cluster of hosts and specify that only one of the hosts should +run the crontab jobs in this directory at any one time. This is done by +starting +.I Cron +with the +.B \-c +option, and have the +.I /var/spool/cron/.cron.hostname +file contain just one line, which represents the hostname of whichever +host in the cluster should run the jobs. If this file does not exist, or +the hostname in it does not match that returned by +.BR gethostname (2), +then all crontab files in this directory are ignored. This has no effect +on cron jobs specified in the +.I /etc/crontab +file or on files in the +.I /etc/cron.d +directory. These files are always run and considered host-specific. +.PP +Rather than editing +.I /var/spool/cron/.cron.hostname +directly, use the +.B \-n +option of +.BR crontab (1) +to specify the host. +.PP +You should ensure that all hosts in a cluster, and the file server from +which they mount the shared crontab directory, have closely synchronised +clocks, e.g., using +.BR ntpd (8), +otherwise the results will be very unpredictable. +.PP +Using cluster sharing automatically disables inotify support, because +inotify cannot be relied on with network-mounted shared file systems. +.SH CAVEATS +All +.BR crontab +files have to be regular files or symlinks to regular files, they must +not be executable or writable for anyone else but the owner. This +requirement can be overridden by using the +.B \-p +option on the crond command line. If inotify support is in use, changes +in the symlinked crontabs are not automatically noticed by the cron +daemon. The cron daemon must receive a SIGHUP signal to reload the +crontabs. This is a limitation of the inotify API. +.PP +The syslog output will be used instead of mail, when sendmail is not +installed. +.SH "SEE ALSO" +.BR crontab (1), +.BR crontab (5), +.BR inotify (7), +.BR pam (8) +.SH AUTHOR +.MT vixie@isc.org +Paul Vixie +.ME +.br +.MT mmaslano@redhat.com +Marcela Mašláňová +.ME +.br +.MT colin@colin-dean.org +Colin Dean +.ME +.br +.MT tmraz@fedoraproject.org +Tomáš Mráz +.ME diff --git a/upstream/opensuse-leap-15-6/man8/ctrlaltdel.8 b/upstream/opensuse-leap-15-6/man8/ctrlaltdel.8 new file mode 100644 index 00000000..3dd7b3e7 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/ctrlaltdel.8 @@ -0,0 +1,80 @@ +'\" t +.\" Title: ctrlaltdel +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "CTRLALTDEL" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +ctrlaltdel \- set the function of the Ctrl\-Alt\-Del combination +.SH "SYNOPSIS" +.sp +\fBctrlaltdel\fP \fBhard\fP|\fBsoft\fP +.SH "DESCRIPTION" +.sp +Based on examination of the \fIlinux/kernel/reboot.c\fP code, it is clear that there are two supported functions that the <Ctrl\-Alt\-Del> sequence can perform. +.sp +\fBhard\fP +.RS 4 +Immediately reboot the computer without calling \fBsync\fP(2) and without any other preparation. This is the default. +.RE +.sp +\fBsoft\fP +.RS 4 +Make the kernel send the \fBSIGINT\fP (interrupt) signal to the \fBinit\fP process (this is always the process with PID 1). If this option is used, the \fBinit\fP(8) program must support this feature. Since there are now several \fBinit\fP(8) programs in the Linux community, please consult the documentation for the version that you are currently using. +.RE +.sp +When the command is run without any argument, it will display the current setting. +.sp +The function of \fBctrlaltdel\fP is usually set in the \fI/etc/rc.local\fP file. +.SH "OPTIONS" +.sp +\fB\-V\fP, \fB\-\-version\fP +.RS 4 +Display version information and exit. +.RE +.sp +\fB\-h\fP, \fB\-\-help\fP +.RS 4 +Display help text and exit. +.RE +.SH "FILES" +.sp +\fI/etc/rc.local\fP +.SH "AUTHORS" +.sp +.MTO "poe\(atdaimi.aau.dk" "Peter Orbaek" "" +.SH "SEE ALSO" +.sp +\fBinit\fP(8), +\fBsystemd\fP(1) +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBctrlaltdel\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/debugfs.8 b/upstream/opensuse-leap-15-6/man8/debugfs.8 new file mode 100644 index 00000000..8b6a600d --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/debugfs.8 @@ -0,0 +1,880 @@ +.\" -*- 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 DEBUGFS 8 "February 2023" "E2fsprogs version 1.47.0" +.SH NAME +debugfs \- ext2/ext3/ext4 file system debugger +.SH SYNOPSIS +.B debugfs +[ +.B \-DVwcin +] +[ +.B \-b +blocksize +] +[ +.B \-s +superblock +] +[ +.B \-f +cmd_file +] +[ +.B \-R +request +] +[ +.B \-d +data_source_device +] +[ +.B \-z +.I undo_file +] +[ +device +] +.SH DESCRIPTION +The +.B debugfs +program is an interactive file system debugger. It can be used to +examine and change the state of an ext2, ext3, or ext4 file system. +.PP +.I device +is a block device (e.g., /dev/sdXX) or a file containing the file system. +.SH OPTIONS +.TP +.I \-w +Specifies that the file system should be opened in read-write mode. +Without this option, the file system is opened in read-only mode. +.TP +.I \-n +Disables metadata checksum verification. This should only be used if +you believe the metadata to be correct despite the complaints of +e2fsprogs. +.TP +.I \-c +Specifies that the file system should be opened in catastrophic mode, in +which the inode and group bitmaps are not read initially. This can be +useful for file systems with significant corruption, but because of this, +catastrophic mode forces the file system to be opened read-only. +.TP +.I \-i +Specifies that +.I device +represents an ext2 image file created by the +.B e2image +program. Since the ext2 image file only contains the superblock, block +group descriptor, block and inode allocation bitmaps, and +the inode table, many +.B debugfs +commands will not function properly. +.B Warning: +no safety checks are in place, and +.B debugfs +may fail in interesting ways if commands such as +.IR ls ", " dump ", " +etc. are tried without specifying the +.I data_source_device +using the +.I \-d +option. +.B debugfs +is a debugging tool. It has rough edges! +.TP +.I -d data_source_device +Used with the +.I \-i +option, specifies that +.I data_source_device +should be used when reading blocks not found in the ext2 image file. +This includes data, directory, and indirect blocks. +.TP +.I -b blocksize +Forces the use of the given block size (in bytes) for the file system, +rather than detecting the correct block size automatically. (This +option is rarely needed; it is used primarily when the file system is +extremely badly damaged/corrupted.) +.TP +.I -s superblock +Causes the file system superblock to be read from the given block +number, instead of using the primary superblock (located at an offset of +1024 bytes from the beginning of the file system). If you specify the +.I -s +option, you must also provide the blocksize of the file system via the +.I -b +option. (This +option is rarely needed; it is used primarily when the file system is +extremely badly damaged/corrupted.) +.TP +.I -f cmd_file +Causes +.B debugfs +to read in commands from +.IR cmd_file , +and execute them. When +.B debugfs +is finished executing those commands, it will exit. +.TP +.I -D +Causes +.B debugfs +to open the device using Direct I/O, bypassing the buffer cache. Note +that some Linux devices, notably device mapper as of this writing, do +not support Direct I/O. +.TP +.I -R request +Causes +.B debugfs +to execute the single command +.IR request , +and then exit. +.TP +.I -V +print the version number of +.B debugfs +and exit. +.TP +.BI \-z " undo_file" +Before overwriting a file system block, write the old contents of the block to +an undo file. This undo file can be used with e2undo(8) to restore the old +contents of the file system should something go wrong. If the empty string is +passed as the undo_file argument, the undo file will be written to a file named +debugfs-\fIdevice\fR.e2undo in the directory specified via the +\fIE2FSPROGS_UNDO_DIR\fR environment variable. + +WARNING: The undo file cannot be used to recover from a power or system crash. +.SH SPECIFYING FILES +Many +.B debugfs +commands take a +.I filespec +as an argument to specify an inode (as opposed to a pathname) +in the file system which is currently opened by +.BR debugfs . +The +.I filespec +argument may be specified in two forms. The first form is an inode +number surrounded by angle brackets, e.g., +.IR <2> . +The second form is a pathname; if the pathname is prefixed by a forward slash +('/'), then it is interpreted relative to the root of the file system +which is currently opened by +.BR debugfs . +If not, the pathname is +interpreted relative to the current working directory as maintained by +.BR debugfs . +This may be modified by using the +.B debugfs +command +.IR cd . +.\" +.\" +.\" +.SH COMMANDS +This is a list of the commands which +.B debugfs +supports. +.TP +.BI blocks " filespec" +Print the blocks used by the inode +.I filespec +to stdout. +.TP +.BI bmap " [ -a ] filespec logical_block [physical_block]" +Print or set the physical block number corresponding to the logical block number +.I logical_block +in the inode +.IR filespec . +If the +.I \-a +flag is specified, try to allocate a block if necessary. +.TP +.BI block_dump " '[ -x ] [-f filespec] block_num" +Dump the file system block given by +.I block_num +in hex and ASCII format to the console. If the +.I \-f +option is specified, the block number is relative to the start of the given +.BR filespec . +If the +.I \-x +option is specified, the block is interpreted as an extended attribute +block and printed to show the structure of extended attribute data +structures. +.TP +.BI cat " filespec" +Dump the contents of the inode +.I filespec +to stdout. +.TP +.BI cd " filespec" +Change the current working directory to +.IR filespec . +.TP +.BI chroot " filespec" +Change the root directory to be the directory +.IR filespec . +.TP +.BI close " [-a]" +Close the currently open file system. If the +.I -a +option is specified, write out any changes to the superblock and block +group descriptors to all of the backup superblocks, not just to the +master superblock. +.TP +.BI clri " filespec" +Clear the contents of the inode +.IR filespec . +.TP +.BI copy_inode " source_inode destination_inode" +Copy the contents of the inode structure in +.I source_inode +and use it to overwrite the inode structure at +.IR destination_inode . +.TP +.BI dirsearch " filespec filename" +Search the directory +.I filespec +for +.IR filename . +.TP +.BI dirty " [-clean]" +Mark the file system as dirty, so that the superblocks will be written on exit. +Additionally, clear the superblock's valid flag, or set it if +.I -clean +is specified. +.TP +.BI dump " [-p] filespec out_file" +Dump the contents of the inode +.I filespec +to the output file +.IR out_file . +If the +.I -p +option is given set the owner, group and permissions information on +.I out_file +to match +.IR filespec . +.TP +.BI dump_mmp " [mmp_block]" +Display the multiple-mount protection (mmp) field values. If +.I mmp_block +is specified then verify and dump the MMP values from the given block +number, otherwise use the +.B s_mmp_block +field in the superblock to locate and use the existing MMP block. +.TP +.BI dx_hash " [-h hash_alg] [-s hash_seed] filename" +Calculate the directory hash of +.IR filename . +The hash algorithm specified with +.I -h +may be +.BR legacy , " half_md4" ", or " tea . +The hash seed specified with +.I -s +must be in UUID format. +.TP +.BI dump_extents " [-n] [-l] filespec" +Dump the extent tree of the inode +.IR filespec . +The +.I -n +flag will cause +.B dump_extents +to only display the interior nodes in the extent tree. The +.I -l +flag will cause +.B dump_extents +to only display the leaf nodes in the extent tree. +.IP +(Please note that the length and range of blocks for the last extent in +an interior node is an estimate by the extents library functions, and is +not stored in file system data structures. Hence, the values displayed +may not necessarily by accurate and does not indicate a problem or +corruption in the file system.) +.TP +.B dump_unused +Dump unused blocks which contain non-null bytes. +.TP +.BI ea_get " [-f outfile]|[-xVC] [-r] filespec attr_name" +Retrieve the value of the extended attribute +.I attr_name +in the file +.I filespec +and write it either to stdout or to \fIoutfile\fR. +.TP +.BI ea_list " filespec +List the extended attributes associated with the file +.I filespec +to standard output. +.TP +.BI ea_set " [-f infile] [-r] filespec attr_name attr_value +Set the value of the extended attribute +.I attr_name +in the file +.I filespec +to the string value +.I attr_value +or read it from \fIinfile\fR. +.TP +.BI ea_rm " filespec attr_names... +Remove the extended attribute +.I attr_name +from the file \fIfilespec\fR. +.TP +.BI expand_dir " filespec" +Expand the directory +.IR filespec . +.TP +.BI fallocate " filespec start_block [end_block] +Allocate and map uninitialized blocks into \fIfilespec\fR between +logical block \fIstart_block\fR and \fIend_block\fR, inclusive. If +\fIend_block\fR is not supplied, this function maps until it runs out +of free disk blocks or the maximum file size is reached. Existing +mappings are left alone. +.TP +.BI feature " [fs_feature] [-fs_feature] ..." +Set or clear various file system features in the superblock. After setting +or clearing any file system features that were requested, print the current +state of the file system feature set. +.TP +.BI filefrag " [-dvr] filespec" +Print the number of contiguous extents in +.IR filespec . +If +.I filespec +is a directory and the +.I -d +option is not specified, +.I filefrag +will print the number of contiguous extents for each file in +the directory. The +.I -v +option will cause +.I filefrag +print a tabular listing of the contiguous extents in the +file. The +.I -r +option will cause +.I filefrag +to do a recursive listing of the directory. +.TP +.BI find_free_block " [count [goal]]" +Find the first +.I count +free blocks, starting from +.I goal +and allocate it. Also available as +.BR ffb . +.TP +.BI find_free_inode " [dir [mode]]" +Find a free inode and allocate it. If present, +.I dir +specifies the inode number of the directory +which the inode is to be located. The second +optional argument +.I mode +specifies the permissions of the new inode. (If the directory bit is set +on the mode, the allocation routine will function differently.) Also +available as +.BR ffi . +.TP +.BI freeb " block [count]" +Mark the block number +.I block +as not allocated. +If the optional argument +.I count +is present, then +.I count +blocks starting at block number +.I block +will be marked as not allocated. +.TP +.BI freefrag " [-c chunk_kb]" +Report free space fragmentation on the currently open file system. +If the +.I \-c +option is specified then the filefrag command will print how many free +chunks of size +.I chunk_kb +can be found in the file system. The chunk size must be a power of two +and be larger than the file system block size. +.TP +.BI freei " filespec [num]" +Free the inode specified by +.IR filespec . +If +.I num +is specified, also clear num-1 inodes after the specified inode. +.TP +.BI get_quota " quota_type id" +Display quota information for given quota type (user, group, or project) and ID. +.TP +.B help +Print a list of commands understood by +.BR debugfs . +.TP +.BI htree_dump " filespec" +Dump the hash-indexed directory +.IR filespec , +showing its tree structure. +.TP +.BI icheck " block ..." +Print a listing of the inodes which use the one or more blocks specified +on the command line. +.TP +.BI inode_dump " [-b]|[-e]|[-x] filespec" +Print the contents of the inode data structure in hex and ASCII format. +The +.I \-b +option causes the command to only dump the contents of the +.B i_blocks +array. The +.I \-e +option causes the command to only dump the contents of the extra inode +space, which is used to store in-line extended attributes. The +.I \-x +option causes the command to dump the extra inode space interpreted and +extended attributes. This is useful to debug corrupted inodes +containing extended attributes. +.TP +.BI imap " filespec" +Print the location of the inode data structure (in the inode table) +of the inode +.IR filespec . +.TP +.BI init_filesys " device blocksize" +Create an ext2 file system on +.I device +with device size +.IR blocksize . +Note that this does not fully initialize all of the data structures; +to do this, use the +.BR mke2fs (8) +program. This is just a call to the low-level library, which sets up +the superblock and block descriptors. +.TP +.BI journal_close +Close the open journal. +.TP +.BI journal_open " [-c] [-v ver] [-f ext_jnl] +Opens the journal for reading and writing. Journal checksumming can +be enabled by supplying \fI-c\fR; checksum formats 2 and 3 can be +selected with the \fI-v\fR option. An external journal can be loaded +from \fIext_jnl\fR. +.TP +.BI journal_run +Replay all transactions in the open journal. +.TP +.BI journal_write " [-b blocks] [-r revoke] [-c] file +Write a transaction to the open journal. The list of blocks to write +should be supplied as a comma-separated list in \fIblocks\fR; the +blocks themselves should be readable from \fIfile\fR. A list of +blocks to revoke can be supplied as a comma-separated list in +\fIrevoke\fR. By default, a commit record is written at the end; the +\fI-c\fR switch writes an uncommitted transaction. +.TP +.BI kill_file " filespec" +Deallocate the inode +.I filespec +and its blocks. Note that this does not remove any directory +entries (if any) to this inode. See the +.BR rm (1) +command if you wish to unlink a file. +.TP +.BI lcd " directory" +Change the current working directory of the +.B debugfs +process to +.I directory +on the native file system. +.TP +.BI list_quota " quota_type" +Display quota information for given quota type (user, group, or project). +.TP +.BI ln " filespec dest_file" +Create a link named +.I dest_file +which is a hard link to +.IR filespec . +Note this does not adjust the inode reference counts. +.TP +.BI logdump " [-acsOS] [-b block] [-n num_trans ] [-i filespec] [-f journal_file] [output_file]" +Dump the contents of the ext3 journal. By default, dump the journal inode as +specified in the superblock. However, this can be overridden with the +.I \-i +option, which dumps the journal from the internal inode given by +.IR filespec . +A regular file containing journal data can be specified using the +.I \-f +option. Finally, the +.I \-s +option utilizes the backup information in the superblock to locate the +journal. +.IP +The +.I \-S +option causes +.B logdump +to print the contents of the journal superblock. +.IP +The +.I \-a +option causes the +.B logdump +to print the contents of all of the descriptor blocks. +The +.I \-b +option causes +.B logdump +to print all journal records that refer to the specified block. +The +.I \-c +option will print out the contents of all of the data blocks selected by +the +.I \-a +and +.I \-b +options. +.IP +The +.I \-O +option causes logdump to display old (checkpointed) journal entries. +This can be used to try to track down journal problems even after the +journal has been replayed. +.IP +The +.I \-n +option causes +.B logdump +to continue past a journal block which is missing a magic number. +Instead, it will stop only when the entire log is printed or after +.I num_trans +transactions. +.TP +.BI ls " [-l] [-c] [-d] [-p] [-r] filespec" +Print a listing of the files in the directory +.IR filespec . +The +.I \-c +flag causes directory block checksums (if present) to be displayed. +The +.I \-d +flag will list deleted entries in the directory. +The +.I \-l +flag will list files using a more verbose format. +The +.I \-p +flag will list the files in a format which is more easily parsable by +scripts, as well as making it more clear when there are spaces or other +non-printing characters at the end of filenames. +The +.I \-r +flag will force the printing of the filename, even if it is encrypted. +.TP +.BI list_deleted_inodes " [limit]" +List deleted inodes, optionally limited to those deleted within +.I limit +seconds ago. Also available as +.BR lsdel . +.IP +This command was useful for recovering from accidental file deletions +for ext2 file systems. Unfortunately, it is not useful for this purpose +if the files were deleted using ext3 or ext4, since the inode's +data blocks are no longer available after the inode is released. +.TP +.BI modify_inode " filespec" +Modify the contents of the inode structure in the inode +.IR filespec . +Also available as +.BR mi . +.TP +.BI mkdir " filespec" +Make a directory. +.TP +.BI mknod " filespec [p|[[c|b] major minor]]" +Create a special device file (a named pipe, character or block device). +If a character or block device is to be made, the +.I major +and +.I minor +device numbers must be specified. +.TP +.BI ncheck " [-c] inode_num ..." +Take the requested list of inode numbers, and print a listing of pathnames +to those inodes. The +.I -c +flag will enable checking the file type information in the directory +entry to make sure it matches the inode's type. +.TP +.BI open " [-weficD] [-b blocksize] [-d image_filename] [-s superblock] [-z undo_file] device" +Open a file system for editing. The +.I -f +flag forces the file system to be opened even if there are some unknown +or incompatible file system features which would normally +prevent the file system from being opened. The +.I -e +flag causes the file system to be opened in exclusive mode. The +.IR -b ", " -c ", " -d ", " -i ", " -s ", " -w ", and " -D +options behave the same as the command-line options to +.BR debugfs . +.TP +.BI punch " filespec start_blk [end_blk]" +Delete the blocks in the inode ranging from +.I start_blk +to +.IR end_blk . +If +.I end_blk +is omitted then this command will function as a truncate command; that +is, all of the blocks starting at +.I start_blk +through to the end of the file will be deallocated. +.TP +.BI symlink " filespec target" +Make a symbolic link. +.TP +.B pwd +Print the current working directory. +.TP +.B quit +Quit +.B debugfs +.TP +.BI rdump " directory[...] destination" +Recursively dump +.IR directory , +or multiple +.IR directories , +and all its contents (including regular files, symbolic links, and other +directories) into the named +.IR destination , +which should be an existing directory on the native file system. +.TP +.BI rm " pathname" +Unlink +.IR pathname . +If this causes the inode pointed to by +.I pathname +to have no other references, deallocate the file. This command functions +as the unlink() system call. +.I +.TP +.BI rmdir " filespec" +Remove the directory +.IR filespec . +.TP +.BI setb " block [count]" +Mark the block number +.I block +as allocated. +If the optional argument +.I count +is present, then +.I count +blocks starting at block number +.I block +will be marked as allocated. +.TP +.BI set_block_group " bgnum field value" +Modify the block group descriptor specified by +.I bgnum +so that the block group descriptor field +.I field +has value +.IR value . +Also available as +.BR set_bg . +.TP +.BI set_current_time " time" +Set current time in seconds since Unix epoch to use when setting file system +fields. +.TP +.BI seti " filespec [num]" +Mark inode +.I filespec +as in use in the inode bitmap. If +.I num +is specified, also set num-1 inodes after the specified inode. +.TP +.BI set_inode_field " filespec field value" +Modify the inode specified by +.I filespec +so that the inode field +.I field +has value +.I value. +The list of valid inode fields which can be set via this command +can be displayed by using the command: +.B set_inode_field -l +Also available as +.BR sif . +.TP +.BI set_mmp_value " field value" +Modify the multiple-mount protection (MMP) data so that the MMP field +.I field +has value +.I value. +The list of valid MMP fields which can be set via this command +can be displayed by using the command: +.B set_mmp_value -l +Also available as +.BR smmp . +.TP +.BI set_super_value " field value" +Set the superblock field +.I field +to +.I value. +The list of valid superblock fields which can be set via this command +can be displayed by using the command: +.B set_super_value -l +Also available as +.BR ssv . +.TP +.B show_debugfs_params +Display +.B debugfs +parameters such as information about currently opened file system. +.TP +.BI show_super_stats " [-h]" +List the contents of the super block and the block group descriptors. If the +.I -h +flag is given, only print out the superblock contents. Also available as +.BR stats . +.TP +.BI stat " filespec" +Display the contents of the inode structure of the inode +.IR filespec . +.TP +.B supported_features +Display file system features supported by this version of +.BR debugfs . +.TP +.BI testb " block [count]" +Test if the block number +.I block +is marked as allocated in the block bitmap. +If the optional argument +.I count +is present, then +.I count +blocks starting at block number +.I block +will be tested. +.TP +.BI testi " filespec" +Test if the inode +.I filespec +is marked as allocated in the inode bitmap. +.TP +.BI undel " <inode_number> [pathname]" +Undelete the specified inode number (which must be surrounded by angle +brackets) so that it and its blocks are marked in use, and optionally +link the recovered inode to the specified pathname. The +.B e2fsck +command should always be run after using the +.B undel +command to recover deleted files. +.IP +Note that if you are recovering a large number of deleted files, linking +the inode to a directory may require the directory to be expanded, which +could allocate a block that had been used by one of the +yet-to-be-undeleted files. So it is safer to undelete all of the +inodes without specifying a destination pathname, and then in a separate +pass, use the debugfs +.B link +command to link the inode to the destination pathname, or use +.B e2fsck +to check the file system and link all of the recovered inodes to the +lost+found directory. +.TP +.BI unlink " pathname" +Remove the link specified by +.I pathname +to an inode. Note this does not adjust the inode reference counts. +.TP +.BI write " source_file out_file" +Copy the contents of +.I source_file +into a newly-created file in the file system named +.IR out_file . +.TP +.BI zap_block " [-f filespec] [-o offset] [-l length] [-p pattern] block_num" +Overwrite the block specified by +.I block_num +with zero (NUL) bytes, or if +.I -p +is given use the byte specified by +.IR pattern . +If +.I -f +is given then +.I block_num +is relative to the start of the file given by +.IR filespec . +The +.I -o +and +.I -l +options limit the range of bytes to zap to the specified +.I offset +and +.I length +relative to the start of the block. +.TP +.BI zap_block " [-f filespec] [-b bit] block_num" +Bit-flip portions of the physical +.IR block_num . +If +.I -f +is given, then +.I block_num +is a logical block relative to the start of +.IR filespec . +.SH ENVIRONMENT VARIABLES +.TP +.B DEBUGFS_PAGER, PAGER +The +.B debugfs +program always pipes the output of the some commands through a +pager program. These commands include: +.IR show_super_stats " (" stats ), +.IR list_directory " (" ls ), +.IR show_inode_info " (" stat ), +.IR list_deleted_inodes " (" lsdel ), +and +.IR htree_dump . +The specific pager can explicitly specified by the +.B DEBUGFS_PAGER +environment variable, and if it is not set, by the +.B PAGER +environment variable. +.IP +Note that since a pager is always used, the +.BR less (1) +pager is not particularly appropriate, since it clears the screen before +displaying the output of the command and clears the output the screen +when the pager is exited. Many users prefer to use the +.BR less (1) +pager for most purposes, which is why the +.B DEBUGFS_PAGER +environment variable is available to override the more general +.B PAGER +environment variable. +.SH AUTHOR +.B debugfs +was written by Theodore Ts'o <tytso@mit.edu>. +.SH SEE ALSO +.BR dumpe2fs (8), +.BR tune2fs (8), +.BR e2fsck (8), +.BR mke2fs (8), +.BR ext4 (5) diff --git a/upstream/opensuse-leap-15-6/man8/debugreiserfs.8 b/upstream/opensuse-leap-15-6/man8/debugreiserfs.8 new file mode 100644 index 00000000..11d13898 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/debugreiserfs.8 @@ -0,0 +1,97 @@ +.\" -*- nroff -*- +.\" Copyright 1996-2004 Hans Reiser. +.\" +.TH DEBUGREISERFS 8 "January 2009" "Reiserfsprogs 3.6.27" +.SH NAME +debugreiserfs \- The debugging tool for the ReiserFS filesystem. +.SH SYNOPSIS +.B debugreiserfs +[ +.B -dDJmoqpuSV +] [ +.B -j \fIdevice +] [ +.B -B \fIfile +] [ +.B -1 \fIN +] + +.\" ] [ +.\" .B -s +.\" ] [ +.I device +.SH DESCRIPTION +\fBdebugreiserfs\fR sometimes helps to solve problems with reiserfs filesystems. +When run without options it prints the super block of the ReiserFS filesystem found +on the \fIdevice\fR. +.TP +.I device +is the special file corresponding to the device (e.g /dev/hdXX for +an IDE disk partition or /dev/sdXX for a SCSI disk partition). +.SH OPTIONS +.TP +\fB-j\fR \fIdevice\fR +prints the contents of the journal. The option \-p allows it to pack the journal +with other metadata into the archive. +.TP +\fB-J\fR +prints the journal header. +.TP +.B -d +prints the formatted nodes of the internal tree of the filesystem. +.TP +.B -D +prints the formatted nodes of all used blocks of the filesystem. +.TP +.B -m +prints the contents of the bitmap (slightly useful). +.TP +.B -o +prints the objectid map (slightly useful). +.TP +\fB-B\fR \fIfile\fR +takes the list of bad blocks stored in the internal ReiserFS tree and translates it +into an ascii list written to the specified file. +.TP +\fB-1\fR \fIblocknumber\fR +prints the specified block of the filesystem. +.TP +.\" \fB-s +.\" scans the partition and prints a line when any kind of reiserfs +.\" formatted nodes found. Can be used to find specific key in the filesystem. +.\" .TP +.B -p +extracts the filesystem's metadata with \fBdebugreiserfs\fR \-p /dev/xxx | gzip \-c > +xxx.gz. None of your data are packed unless a filesystem corruption presents when +the whole block having this corruption is packed. You send us the output, and we use +it to create a filesystem with the same strucure as yours using \fBdebugreiserfs \-u\fR. +When the data file is not too large, this usually allows us to quickly reproduce +and debug the problem. +.TP +.B -u +builds the ReiserFS filesystem image with gunzip \-c xxx.gz | \fBdebugreiserfs\fR +\-u /dev/image of the previously packed metadata with \fBdebugreiserfs \-p\fR. The +result image is not the same as the original filesystem, because mostly only metadata +were packed with \fBdebugreiserfs \-p\fR, but the filesystem structure is completely +recreated. +.TP +.B -S +When \-S is not specified \-p +.\" and -s +deals with blocks marked used in the filesystem bitmap only. With this option +set \fBdebugreiserfs\fR will work with the entire device. +.TP +.B -q +When +.\" -s or +\-p is in use, suppress showing the speed of progress. +.SH AUTHOR +This version of \fBdebugreiserfs\fR has been written by Vitaly Fertman +<vitaly@namesys.com>. +.SH BUGS +Please report bugs to the ReiserFS developers <reiserfs-devel@vger.kernel.org>, providing +as much information as possible--your hardware, kernel, patches, settings, all printed +messages; check the syslog file for any related information. +.SH SEE ALSO +.BR reiserfsck (8), +.BR mkreiserfs (8) diff --git a/upstream/opensuse-leap-15-6/man8/delpart.8 b/upstream/opensuse-leap-15-6/man8/delpart.8 new file mode 100644 index 00000000..c397b226 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/delpart.8 @@ -0,0 +1,54 @@ +'\" t +.\" Title: delpart +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "DELPART" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +delpart \- tell the kernel to forget about a partition +.SH "SYNOPSIS" +.sp +\fBdelpart\fP \fIdevice partition\fP +.SH "DESCRIPTION" +.sp +\fBdelpart\fP asks the Linux kernel to forget about the specified \fIpartition\fP (a number) on the specified \fIdevice\fP. The command is a simple wrapper around the "del partition" ioctl. +.sp +This command doesn\(cqt manipulate partitions on a block device. +.SH "SEE ALSO" +.sp +\fBaddpart\fP(8), +\fBfdisk\fP(8), +\fBparted\fP(8), +\fBpartprobe\fP(8), +\fBpartx\fP(8) +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBdelpart\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/depmod.8 b/upstream/opensuse-leap-15-6/man8/depmod.8 new file mode 100644 index 00000000..cd9239d2 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/depmod.8 @@ -0,0 +1,173 @@ +'\" t +.\" Title: depmod +.\" Author: Jon Masters <jcm@jonmasters.org> +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 01/29/2021 +.\" Manual: depmod +.\" Source: kmod +.\" Language: English +.\" +.TH "DEPMOD" "8" "01/29/2021" "kmod" "depmod" +.\" ----------------------------------------------------------------- +.\" * 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" +depmod \- Generate modules\&.dep and map files\&. +.SH "SYNOPSIS" +.HP \w'\fBdepmod\fR\ 'u +\fBdepmod\fR [\fB\-b\ \fR\fB\fIbasedir\fR\fR] [\fB\-e\fR] [\fB\-E\ \fR\fB\fIModule\&.symvers\fR\fR] [\fB\-F\ \fR\fB\fISystem\&.map\fR\fR] [\fB\-n\fR] [\fB\-v\fR] [\fB\-A\fR] [\fB\-P\ \fR\fB\fIprefix\fR\fR] [\fB\-w\fR] [\fB\fIversion\fR\fR] +.HP \w'\fBdepmod\fR\ 'u +\fBdepmod\fR [\fB\-e\fR] [\fB\-E\ \fR\fB\fIModule\&.symvers\fR\fR] [\fB\-F\ \fR\fB\fISystem\&.map\fR\fR] [\fB\-n\fR] [\fB\-v\fR] [\fB\-P\ \fR\fB\fIprefix\fR\fR] [\fB\-w\fR] [\fB\fIversion\fR\fR] [\fB\fIfilename\fR\fR...] +.SH "DESCRIPTION" +.PP +Linux kernel modules can provide services (called "symbols") for other modules to use (using one of the EXPORT_SYMBOL variants in the code)\&. If a second module uses this symbol, that second module clearly depends on the first module\&. These dependencies can get quite complex\&. +.PP +\fBdepmod\fR +creates a list of module dependencies by reading each module under +/lib/modules/\fIversion\fR +and determining what symbols it exports and what symbols it needs\&. By default, this list is written to +modules\&.dep, and a binary hashed version named +modules\&.dep\&.bin, in the same directory\&. If filenames are given on the command line, only those modules are examined (which is rarely useful unless all modules are listed)\&. +\fBdepmod\fR +also creates a list of symbols provided by modules in the file named +modules\&.symbols +and its binary hashed version, +modules\&.symbols\&.bin\&. Finally, +\fBdepmod\fR +will output a file named +modules\&.devname +if modules supply special device names (devname) that should be populated in /dev on boot (by a utility such as systemd\-tmpfiles)\&. +.PP +If a +\fIversion\fR +is provided, then that kernel version\*(Aqs module directory is used rather than the current kernel version (as returned by +\fBuname \-r\fR)\&. +.SH "OPTIONS" +.PP +\fB\-a\fR, \fB\-\-all\fR +.RS 4 +Probe all modules\&. This option is enabled by default if no file names are given in the command\-line\&. +.RE +.PP +\fB\-A\fR, \fB\-\-quick\fR +.RS 4 +This option scans to see if any modules are newer than the +modules\&.dep +file before any work is done: if not, it silently exits rather than regenerating the files\&. +.RE +.PP +\fB\-b \fR\fB\fIbasedir\fR\fR, \fB\-\-basedir \fR\fB\fIbasedir\fR\fR +.RS 4 +If your modules are not currently in the (normal) directory +/lib/modules/\fIversion\fR, but in a staging area, you can specify a +\fIbasedir\fR +which is prepended to the directory name\&. This +\fIbasedir\fR +is stripped from the resulting +modules\&.dep +file, so it is ready to be moved into the normal location\&. Use this option if you are a distribution vendor who needs to pre\-generate the meta\-data files rather than running depmod again later\&. +.RE +.PP +\fB\-C\fR, \fB\-\-config \fR\fB\fIfile or directory\fR\fR +.RS 4 +This option overrides the default configuration directory at +/etc/depmod\&.d/\&. +.RE +.PP +\fB\-e\fR, \fB\-\-errsyms\fR +.RS 4 +When combined with the +\fB\-F\fR +option, this reports any symbols which a module needs which are not supplied by other modules or the kernel\&. Normally, any symbols not provided by modules are assumed to be provided by the kernel (which should be true in a perfect world), but this assumption can break especially when additionally updated third party drivers are not correctly installed or were built incorrectly\&. +.RE +.PP +\fB\-E\fR, \fB\-\-symvers\fR +.RS 4 +When combined with the +\fB\-e\fR +option, this reports any symbol versions supplied by modules that do not match with the symbol versions provided by the kernel in its +Module\&.symvers\&. This option is mutually incompatible with +\fB\-F\fR\&. +.RE +.PP +\fB\-F\fR, \fB\-\-filesyms \fR\fB\fISystem\&.map\fR\fR +.RS 4 +Supplied with the +System\&.map +produced when the kernel was built, this allows the +\fB\-e\fR +option to report unresolved symbols\&. This option is mutually incompatible with +\fB\-E\fR\&. +.RE +.PP +\fB\-h\fR, \fB\-\-help\fR +.RS 4 +Print the help message and exit\&. +.RE +.PP +\fB\-n\fR, \fB\-\-show\fR, \fB\-\-dry\-run\fR +.RS 4 +This sends the resulting modules\&.dep and the various map files to standard output rather than writing them into the module directory\&. +.RE +.PP +\fB\-P\fR +.RS 4 +Some architectures prefix symbols with an extraneous character\&. This specifies a prefix character (for example \*(Aq_\*(Aq) to ignore\&. +.RE +.PP +\fB\-v\fR, \fB\-\-verbose\fR +.RS 4 +In verbose mode, +\fBdepmod\fR +will print (to stdout) all the symbols each module depends on and the module\*(Aqs file name which provides that symbol\&. +.RE +.PP +\fB\-V\fR, \fB\-\-version\fR +.RS 4 +Show version of program and exit\&. See below for caveats when run on older kernels\&. +.RE +.PP +\fB\-w\fR +.RS 4 +Warn on duplicate dependencies, aliases, symbol versions, etc\&. +.RE +.SH "COPYRIGHT" +.PP +This manual page originally Copyright 2002, Rusty Russell, IBM Corporation\&. Portions Copyright Jon Masters, and others\&. +.SH "SEE ALSO" +.PP +\fBdepmod.d\fR(5), +\fBmodprobe\fR(8), +\fBmodules.dep\fR(5) +.SH "AUTHORS" +.PP +\fBJon Masters\fR <\&jcm@jonmasters\&.org\&> +.RS 4 +Developer +.RE +.PP +\fBRobby Workman\fR <\&rworkman@slackware\&.com\&> +.RS 4 +Developer +.RE +.PP +\fBLucas De Marchi\fR <\&lucas\&.de\&.marchi@gmail\&.com\&> +.RS 4 +Developer +.RE diff --git a/upstream/opensuse-leap-15-6/man8/dnf-builddep.8 b/upstream/opensuse-leap-15-6/man8/dnf-builddep.8 new file mode 100644 index 00000000..04ea70fb --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/dnf-builddep.8 @@ -0,0 +1,100 @@ +.\" Man page generated from reStructuredText. +. +.TH "DNF-BUILDDEP" "8" "Nov 03, 2021" "4.0.24" "dnf-plugins-core" +.SH NAME +dnf-builddep \- DNF builddep Plugin +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.sp +Install whatever is needed to build the given .src.rpm, .nosrc.rpm or .spec file. +.sp +\fBWARNING:\fP +.INDENT 0.0 +.INDENT 3.5 +Build dependencies in a package (i.e. src.rpm) might be different +than you would expect because they were evaluated according macros +set on the package build host. +.UNINDENT +.UNINDENT +.SH SYNOPSIS +.sp +\fBdnf builddep <package>...\fP +.SH ARGUMENTS +.INDENT 0.0 +.TP +.B \fB<package>\fP +Either path to .src.rpm, .nosrc.rpm or .spec file or package available in a repository. +.UNINDENT +.SH OPTIONS +.sp +All general DNF options are accepted, see \fIOptions\fP in \fBdnf(8)\fP for details. +.INDENT 0.0 +.TP +.B \fB\-\-help\-cmd\fP +Show this help. +.TP +.B \fB\-D <macro expr>, \-\-define <macro expr>\fP +Define the RPM macro named \fImacro\fP to the value \fIexpr\fP when parsing spec files. +.TP +.B \fB\-\-spec\fP +Treat arguments as .spec files. +.TP +.B \fB\-\-srpm\fP +Treat arguments as source rpm files. +.TP +.B \fB\-\-skip\-unavailable\fP +Skip build dependencies not available in repositories. All available build dependencies will be installed. +.UNINDENT +.sp +Note that \fIbuilddep\fP command does not honor the \fI\-\-skip\-broken\fP option, so there is no way to skip uninstallable packages (e.g. with broken dependencies). +.SH EXAMPLES +.INDENT 0.0 +.TP +.B \fBdnf builddep foobar.spec\fP +Install the needed build requirements, defined in the foobar.spec file. +.TP +.B \fBdnf builddep \-\-spec foobar.spec.in\fP +Install the needed build requirements, defined in the spec file when filename ends +with something different than \fB\&.spec\fP\&. +.TP +.B \fBdnf builddep foobar\-1.0\-1.src.rpm\fP +Install the needed build requirements, defined in the foobar\-1.0\-1.src.rpm file. +.TP +.B \fBdnf builddep foobar\-1.0\-1\fP +Look up foobar\-1.0\-1 in enabled repositories and install build requirements +for its source rpm. +.TP +.B \fBdnf builddep \-D \(aqscl python27\(aq python\-foobar.spec\fP +Install the needed build requirements for the python27 SCL version of python\-foobar. +.UNINDENT +.SH AUTHOR +See AUTHORS in your Core DNF Plugins distribution +.SH COPYRIGHT +2021, Red Hat, Licensed under GPLv2+ +.\" Generated by docutils manpage writer. +. diff --git a/upstream/opensuse-leap-15-6/man8/dnf-changelog.8 b/upstream/opensuse-leap-15-6/man8/dnf-changelog.8 new file mode 100644 index 00000000..8e427bf2 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/dnf-changelog.8 @@ -0,0 +1,101 @@ +.\" Man page generated from reStructuredText. +. +.TH "DNF-CHANGELOG" "8" "Nov 03, 2021" "4.0.24" "dnf-plugins-core" +.SH NAME +dnf-changelog \- DNF changelog Plugin +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.SH DESCRIPTION +.sp +\fIchangelog\fP is a plugin for viewing package changelogs. +.SH SYNOPSIS +.sp +\fBdnf changelog [<options>] <package\-spec>...\fP +.SH ARGUMENTS +.INDENT 0.0 +.TP +.B \fB<package\-spec>\fP +Package specification for packages to display changelogs. +.UNINDENT +.SH OPTIONS +.sp +All general DNF options are accepted, see \fIOptions\fP in \fBdnf(8)\fP for details. +.INDENT 0.0 +.TP +.B \fB\-\-since=<date>\fP +Show only changelog entries since \fB<date>\fP\&. To avoid ambiguosity using YYYY\-MM\-DD date format is recommended. +.TP +.B \fB\-\-count=<number>\fP +Show maximum of \fB<number>\fP changelog entries per package. +.TP +.B \fB\-\-upgrades\fP +Show only new changelog entries for packages, that provide an upgrade for some of already installed packages. +.UNINDENT +.SH EXAMPLES +.sp +Show changelogs for all packages since November 1, 2018: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +dnf changelog \-\-since=2018\-11\-1 +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Show 3 latest changelogs of package dnf: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +dnf changelog \-\-count=3 dnf +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Show what is new in upgradable packages: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +dnf changelog \-\-upgrades +.ft P +.fi +.UNINDENT +.UNINDENT +.SH AUTHOR +See AUTHORS in your Core DNF Plugins distribution +.SH COPYRIGHT +2021, Red Hat, Licensed under GPLv2+ +.\" Generated by docutils manpage writer. +. diff --git a/upstream/opensuse-leap-15-6/man8/dnf-config-manager.8 b/upstream/opensuse-leap-15-6/man8/dnf-config-manager.8 new file mode 100644 index 00000000..120d073a --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/dnf-config-manager.8 @@ -0,0 +1,113 @@ +.\" Man page generated from reStructuredText. +. +.TH "DNF-CONFIG-MANAGER" "8" "Nov 03, 2021" "4.0.24" "dnf-plugins-core" +.SH NAME +dnf-config-manager \- DNF config-manager Plugin +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.sp +Manage main and repository DNF configuration options, toggle which +repositories are enabled or disabled, and add new repositories. +.SH SYNOPSIS +.sp +\fBdnf config\-manager [options] <section>...\fP +.SH ARGUMENTS +.INDENT 0.0 +.TP +.B \fB<section>\fP +This argument can be used to explicitly select the configuration sections to manage. +A section can either be \fBmain\fP or a repoid. +If not specified, the program will select the \fBmain\fP section and each repoid +used within any \fB\-\-setopt\fP options. +A repoid can be specified using globs. +.UNINDENT +.SH OPTIONS +.sp +All general DNF options are accepted, see \fIOptions\fP in \fBdnf(8)\fP for details. +.INDENT 0.0 +.TP +.B \fB\-\-help\-cmd\fP +Show this help. +.TP +.B \fB\-\-add\-repo=URL\fP +Add (and enable) the repo from the specified file or url. If it has to be added into installroot, combine it with +\fB\-\-setopt=reposdir=/<installroot>/etc/yum.repos.d\fP command\-line option. +.TP +.B \fB\-\-dump\fP +Print dump of current configuration values to stdout. +.TP +.B \fB\-\-set\-disabled\fP, \fB\-\-disable\fP +Disable the specified repos (implies \fB\-\-save\fP). +.TP +.B \fB\-\-set\-enabled\fP, \fB\-\-enable\fP +Enable the specified repos (implies \fB\-\-save\fP). +.TP +.B \fB\-\-save\fP +Save the current options (useful with \fB\-\-setopt\fP). +.TP +.B \fB\-\-setopt=<option>=<value>\fP +Set a configuration option. To set configuration options for repositories, use +\fBrepoid.option\fP for the \fB<option>\fP\&. Globs are supported in repoid. +.UNINDENT +.SH EXAMPLES +.INDENT 0.0 +.TP +.B \fBdnf config\-manager \-\-add\-repo http://example.com/some/additional.repo\fP +Download additional.repo and store it in repodir. +.TP +.B \fBdnf config\-manager \-\-add\-repo http://example.com/different/repo\fP +Create new repo file with \fI\%http://example.com/different/repo\fP as baseurl and enable it. +.TP +.B \fBdnf config\-manager \-\-dump\fP +Display main DNF configuration. +.TP +.B \fBdnf config\-manager \-\-dump <section>\fP +Display configuration of a repository identified by <section>. +.TP +.B \fBdnf config\-manager \-\-set\-enabled <repoid>\fP +Enable repository identified by <repoid> and make the change permanent. +.TP +.B \fBdnf config\-manager \-\-set\-disabled <repoid1> <repoid2>\fP +Disable repositories identified by <repoid1> and <repoid2> +.TP +.B \fBdnf config\-manager \-\-set\-disabled <repoid1>,<repoid2>\fP +Disable repositories identified by <repoid1> and <repoid2> +.TP +.B \fBdnf config\-manager \-\-save \-\-setopt=*.proxy=http://proxy.example.com:3128/ <repo1> <repo2>\fP +Update proxy setting in repositories with repoid <repo1> and <repo2> and make the change +permanent. +.TP +.B \fBdnf config\-manager \-\-save \-\-setopt=*\-debuginfo.gpgcheck=0\fP +Update gpgcheck setting in all repositories whose id ends with \-debuginfo and make the change permanent. +.UNINDENT +.SH AUTHOR +See AUTHORS in your Core DNF Plugins distribution +.SH COPYRIGHT +2021, Red Hat, Licensed under GPLv2+ +.\" Generated by docutils manpage writer. +. diff --git a/upstream/opensuse-leap-15-6/man8/dnf-copr.8 b/upstream/opensuse-leap-15-6/man8/dnf-copr.8 new file mode 100644 index 00000000..869a4903 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/dnf-copr.8 @@ -0,0 +1,143 @@ +.\" Man page generated from reStructuredText. +. +.TH "DNF-COPR" "8" "Nov 03, 2021" "4.0.24" "dnf-plugins-core" +.SH NAME +dnf-copr \- DNF copr Plugin +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.sp +Work with Copr & Playground repositories on the local system. +.INDENT 0.0 +.IP \(bu 2 +The \fBcopr\fP command is used to add or remove Copr repositories to the local system +.IP \(bu 2 +The \fBplayground\fP is used to enable or disable the Playground repository +.UNINDENT +.SH SYNOPSIS +.sp +\fBdnf copr [enable|disable|remove|list|search] <parameters>\fP +.sp +\fBdnf playground [enable|disable|upgrade]\fP +.SH ARGUMENTS (COPR) +.INDENT 0.0 +.TP +.B \fBenable name/project [chroot]\fP +Enable the \fBname/project\fP Copr repository with the optional \fBchroot\fP\&. +.TP +.B \fBdisable name/project\fP +Disable the \fBname/project\fP Copr repository. +.TP +.B \fBremove name/project\fP +Remove the \fBname/project\fP Copr repository. +.TP +.B \fBlist \-\-installed\fP +List installed Copr repositories (default). +.TP +.B \fBlist \-\-enabled\fP +List enabled Copr repositories. +.TP +.B \fBlist \-\-disabled\fP +List disabled Copr repositories. +.TP +.B \fBlist \-\-available\-by\-user=name\fP +List available Copr repositories for a given \fBname\fP\&. +.TP +.B \fBsearch project\fP +Search for a given \fBproject\fP\&. +.TP +.B \fBenable hub/name/project\fP +Enable the \fBname/project\fP Copr repository from the specified Copr \fBhub\fP, +Hub is be specified either by its hostname (eg. \fIcopr.fedorainfracloud.org\fP) +or by an ID that\(aqs defined in a configuration file. +.UNINDENT +.SH OPTIONS (COPR) +.sp +All general DNF options are accepted, see \fIOptions\fP in \fBdnf(8)\fP for details. +.INDENT 0.0 +.TP +.B \fB\-\-hub Copr\fP +Specify a Copr hub to use. Default is the Fedora Copr: \fBhttps://copr.fedorainfracloud.org\fP\&. +.UNINDENT +.SH CONFIGURATION (COPR) +.sp +\fB/etc/dnf/plugins/copr.conf\fP +\fB/etc/dnf/plugins/copr.d/\fP +.INDENT 0.0 +.TP +.B Configuration file should contain a section for each hub, each section having \fBhostname\fP +(mandatory), \fBprotocol\fP (default \fBhttps\fP) and \fBport\fP (default \fB443\fP) parameters.: +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +[fedora] +hostname = copr.fedorainfracloud.org +protocol = https +port = 443 +.ft P +.fi +.UNINDENT +.UNINDENT +.UNINDENT +.SH ARGUMENTS (PLAYGROUND) +.INDENT 0.0 +.TP +.B \fBenable\fP +Enable the Playground repository. +.TP +.B \fBdisable\fP +Disable the Playground repository. +.TP +.B \fBupgrade\fP +Upgrade the Playground repository settings (same as \fBdisable\fP and then \fBenable\fP). +.UNINDENT +.SH OPTIONS (PLAYGROUND) +.sp +All general DNF options are accepted, see \fIOptions\fP in \fBdnf(8)\fP for details. +.SH EXAMPLES +.INDENT 0.0 +.TP +.B \fBcopr enable rhscl/perl516 epel\-6\-x86_64\fP +Enable the \fBrhscl/perl516\fP Copr repository, using the \fBepel\-6\-x86_64\fP chroot. +.TP +.B \fBcopr disable rhscl/perl516\fP +Disable the \fBrhscl/perl516\fP Copr repository +.TP +.B \fBcopr list \-\-available\-by\-user=rita\fP +List available Copr projects for user \fBrita\fP\&. +.TP +.B \fBcopr search tests\fP +Search for Copr projects named \fBtests\fP\&. +.UNINDENT +.SH AUTHOR +See AUTHORS in your Core DNF Plugins distribution +.SH COPYRIGHT +2021, Red Hat, Licensed under GPLv2+ +.\" Generated by docutils manpage writer. +. diff --git a/upstream/opensuse-leap-15-6/man8/dnf-debug.8 b/upstream/opensuse-leap-15-6/man8/dnf-debug.8 new file mode 100644 index 00000000..b13e2448 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/dnf-debug.8 @@ -0,0 +1,107 @@ +.\" Man page generated from reStructuredText. +. +.TH "DNF-DEBUG" "8" "Nov 03, 2021" "4.0.24" "dnf-plugins-core" +.SH NAME +dnf-debug \- DNF debug Plugin +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.SH DESCRIPTION +.sp +The plugin provides two dnf commands: +.INDENT 0.0 +.TP +.B \fBdebug\-dump\fP +Writes system RPM configuration to a dump file +.TP +.B \fBdebug\-restore\fP +Restore the installed packages to the versions written in the dump file. By +default, it does not remove already installed versions of install\-only +packages and only marks those versions that are mentioned in the dump file +for installation. The final decision on which versions to keep on the +system is left to dnf and can be fine\-tuned using the \fIinstallonly_limit\fP +(see \fBdnf.conf(5)\fP) configuration option. +.UNINDENT +.sp +\fBNOTE:\fP +.INDENT 0.0 +.INDENT 3.5 +DNF and Yum debug files are not compatible and thus can\(aqt be used +by the other program. +.UNINDENT +.UNINDENT +.SH SYNOPSIS +.sp +\fBdnf debug\-dump [\-\-norepos] [<filename>]\fP +.sp +\fBdnf debug\-restore [\-\-output] [\-\-install\-latest] [\-\-ignore\-arch] +[\-\-filter\-types = [install,remove,replace]] <filename>\fP +.SH ARGUMENTS +.INDENT 0.0 +.TP +.B \fB<filename>\fP +File to write dump to or read from. +.UNINDENT +.SH OPTIONS +.sp +All general DNF options are accepted, see \fIOptions\fP in \fBdnf(8)\fP for details. +.sp +\fBdnf debug\-dump\fP +.INDENT 0.0 +.TP +.B \fB\-\-norepos\fP +Do not dump content of enabled repos. +.UNINDENT +.sp +\fBdnf debug\-restore\fP +.INDENT 0.0 +.TP +.B \fB\-\-filter\-types=[install,remove,replace]\fP +Limit package changes to specified type. +.TP +.B \fB\-\-ignore\-arch\fP +When installing package ignore architecture and install missing packages +matching the name, epoch, version and release. +.TP +.B \fB\-\-install\-latest\fP +When installing use the latest package of the same name and architecture. +.TP +.B \fB\-\-output\fP +Only output list of packages which will be installed or removed. +No actuall changes are done. +.TP +.B \fB\-\-remove\-installonly\fP +Allow removal of install\-only packages. Using this option may result in an +attempt to remove the running kernel version (in situations when the currently +running kernel version is not part of the dump file). +.UNINDENT +.SH AUTHOR +See AUTHORS in your Core DNF Plugins distribution +.SH COPYRIGHT +2021, Red Hat, Licensed under GPLv2+ +.\" Generated by docutils manpage writer. +. diff --git a/upstream/opensuse-leap-15-6/man8/dnf-debuginfo-install.8 b/upstream/opensuse-leap-15-6/man8/dnf-debuginfo-install.8 new file mode 100644 index 00000000..8e902305 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/dnf-debuginfo-install.8 @@ -0,0 +1,78 @@ +.\" Man page generated from reStructuredText. +. +.TH "DNF-DEBUGINFO-INSTALL" "8" "Nov 03, 2021" "4.0.24" "dnf-plugins-core" +.SH NAME +dnf-debuginfo-install \- DNF debuginfo-install Plugin +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.sp +Install the associated debuginfo packages for a given package specification. +.SH SYNOPSIS +.sp +\fBdnf debuginfo\-install <pkg\-spec>...\fP +.SH ARGUMENTS +.INDENT 0.0 +.TP +.B \fB<pkg\-spec>\fP +The package to install the associated debuginfo package for. +.UNINDENT +.SH OPTIONS +.sp +All general DNF options are accepted, see \fIOptions\fP in \fBdnf(8)\fP for details. +.SH CONFIGURATION +.sp +\fB/etc/dnf/plugins/debuginfo\-install.conf\fP +.sp +The minimal content of conf file should contain \fBmain\fP sections with \fBenabled\fP and +\fBautoupdate\fP parameter. +.INDENT 0.0 +.TP +.B \fBautoupdate\fP +A boolean option which controls updates of debuginfo packages. If options is enabled +and there are debuginfo packages installed it automatically enables all configured +debuginfo repositories. +(Disabled by default.) +.UNINDENT +.SH EXAMPLES +.INDENT 0.0 +.TP +.B \fBdnf debuginfo\-install foobar\fP +Install the debuginfo packages for the foobar package. +.TP +.B \fBdnf upgrade \-\-enablerepo=*\-debuginfo <package\-name>\-debuginfo\fP +Upgrade debuginfo package of a <package\-name>. +.TP +.B \fBdnf upgrade \-\-enablerepo=*\-debuginfo "*\-debuginfo"\fP +Upgrade all debuginfo packages. +.UNINDENT +.SH AUTHOR +See AUTHORS in your Core DNF Plugins distribution +.SH COPYRIGHT +2021, Red Hat, Licensed under GPLv2+ +.\" Generated by docutils manpage writer. +. diff --git a/upstream/opensuse-leap-15-6/man8/dnf-download.8 b/upstream/opensuse-leap-15-6/man8/dnf-download.8 new file mode 100644 index 00000000..331100be --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/dnf-download.8 @@ -0,0 +1,109 @@ +.\" Man page generated from reStructuredText. +. +.TH "DNF-DOWNLOAD" "8" "Nov 03, 2021" "4.0.24" "dnf-plugins-core" +.SH NAME +dnf-download \- DNF download Plugin +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.sp +Download binary or source packages. +.SH SYNOPSIS +.sp +\fBdnf download [options] <pkg\-spec>...\fP +.SH ARGUMENTS +.INDENT 0.0 +.TP +.B \fB<pkg\-spec>\fP +Package specification for the package to download. +Local RPMs can be specified as well. This is useful with the \fB\-\-source\fP +option or if you want to download the same RPM again. +.UNINDENT +.SH OPTIONS +.sp +All general DNF options are accepted, see \fIOptions\fP in \fBdnf(8)\fP for details. +.INDENT 0.0 +.TP +.B \fB\-\-help\-cmd\fP +Show this help. +.TP +.B \fB\-\-arch <arch>[,<arch>...]\fP +Limit the query to packages of given architectures (default is all compatible architectures with +your system). To download packages with arch incompatible with your system use +\fB\-\-forcearch=<arch>\fP option to change basearch. +.TP +.B \fB\-\-source\fP +Download the source rpm. Enables source repositories of all enabled binary repositories. +.TP +.B \fB\-\-debuginfo\fP +Download the debuginfo rpm. Enables debuginfo repositories of all enabled binary repositories. +.TP +.B \fB\-\-downloaddir\fP +Download directory, default is the current directory (the directory must exist). +.TP +.B \fB\-\-url\fP +Instead of downloading, print list of urls where the rpms can be downloaded. +.TP +.B \fB\-\-urlprotocol\fP +Limit the protocol of the urls output by the \-\-url option. Options are http, https, rsync, ftp. +.TP +.B \fB\-\-resolve\fP +Resolves dependencies of specified packages and downloads missing dependencies in the system. +.TP +.B \fB\-\-alldeps\fP +When used with \fB\-\-resolve\fP, download all dependencies (do not skip already installed ones). +.UNINDENT +.SH EXAMPLES +.INDENT 0.0 +.TP +.B \fBdnf download dnf\fP +Download the latest dnf package to the current directory. +.TP +.B \fBdnf download \-\-url dnf\fP +Just print the remote location url where the dnf rpm can be downloaded from. +.TP +.B \fBdnf download \-\-url \-\-urlprotocols=https \-\-urlprotocols=rsync dnf\fP +Same as above, but limit urls to https or rsync urls. +.TP +.B \fBdnf download dnf \-\-destdir /tmp/dnl\fP +Download the latest dnf package to the /tmp/dnl directory (the directory must exist). +.TP +.B \fBdnf download dnf \-\-source\fP +Download the latest dnf source package to the current directory. +.TP +.B \fBdnf download rpm \-\-debuginfo\fP +Download the latest rpm\-debuginfo package to the current directory. +.TP +.B \fBdnf download btanks \-\-resolve\fP +Download the latest btanks package and the uninstalled dependencies to the current directory. +.UNINDENT +.SH AUTHOR +See AUTHORS in your Core DNF Plugins distribution +.SH COPYRIGHT +2021, Red Hat, Licensed under GPLv2+ +.\" Generated by docutils manpage writer. +. diff --git a/upstream/opensuse-leap-15-6/man8/dnf-generate_completion_cache.8 b/upstream/opensuse-leap-15-6/man8/dnf-generate_completion_cache.8 new file mode 100644 index 00000000..87237b39 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/dnf-generate_completion_cache.8 @@ -0,0 +1,40 @@ +.\" Man page generated from reStructuredText. +. +.TH "DNF-GENERATE_COMPLETION_CACHE" "8" "Nov 03, 2021" "4.0.24" "dnf-plugins-core" +.SH NAME +dnf-generate_completion_cache \- DNF generate_completion_cache Plugin +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.sp +Generates data to speed up shell completion for DNF. The user is not supposed to interact with the plugin in any way. +.SH AUTHOR +See AUTHORS in your Core DNF Plugins distribution +.SH COPYRIGHT +2021, Red Hat, Licensed under GPLv2+ +.\" Generated by docutils manpage writer. +. diff --git a/upstream/opensuse-leap-15-6/man8/dnf-groups-manager.8 b/upstream/opensuse-leap-15-6/man8/dnf-groups-manager.8 new file mode 100644 index 00000000..6a1e9f3a --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/dnf-groups-manager.8 @@ -0,0 +1,105 @@ +.\" Man page generated from reStructuredText. +. +.TH "DNF-GROUPS-MANAGER" "8" "Nov 03, 2021" "4.0.24" "dnf-plugins-core" +.SH NAME +dnf-groups-manager \- DNF groups-manager Plugin +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.sp +Create and edit groups repository metadata files. +.SH SYNOPSIS +.sp +\fBdnf groups\-manager [options] [package\-name\-spec [package\-name\-spec ...]]\fP +.SH DESCRIPTION +.sp +groups\-manager plugin is used to create or edit a group metadata file for a repository. This is often much easier than writing/editing the XML by hand. The groups\-manager can load an entire file of groups metadata and either create a new group or edit an existing group and then write all of the groups metadata back out. +.SH ARGUMENTS +.INDENT 0.0 +.TP +.B \fB<package\-name\-spec>\fP +Package to add to a group or remove from a group. +.UNINDENT +.SH OPTIONS +.sp +All general DNF options are accepted, see \fIOptions\fP in \fBdnf(8)\fP for details. +.INDENT 0.0 +.TP +.B \fB\-\-load=<path_to_comps.xml>\fP +Load the groups metadata information from the specified file before performing any operations. Metadata from all files are merged together if the option is specified multiple times. +.TP +.B \fB\-\-save=<path_to_comps.xml>\fP +Save the result to this file. You can specify the name of a file you are loading from as the data will only be saved when all the operations have been performed. This option can also be specified multiple times. +.TP +.B \fB\-\-merge=<path_to_comps.xml>\fP +This is the same as loading and saving a file, however the "merge" file is loaded before any others and saved last. +.TP +.B \fB\-\-print\fP +Also print the result to stdout. +.TP +.B \fB\-\-id=<id>\fP +The id to lookup/use for the group. If you don\(aqt specify an \fB<id>\fP, but do specify a name that doesn\(aqt refer to an existing group, then an id for the group is generated based on the name. +.TP +.B \fB\-n <name>, \-\-name=<name>\fP +The name to lookup/use for the group. If you specify an existing group id, then the group with that id will have it\(aqs name changed to this value. +.TP +.B \fB\-\-description=<description>\fP +The description to use for the group. +.TP +.B \fB\-\-display\-order=<display_order>\fP +Change the integer which controls the order groups are presented in, for example in \fBdnf grouplist\fP\&. +.TP +.B \fB\-\-translated\-name=<lang:text>\fP +A translation of the group name in the given language. The syntax is \fBlang:text\fP\&. Eg. \fBen:my\-group\-name\-in\-english\fP +.TP +.B \fB\-\-translated\-description=<lang:text>\fP +A translation of the group description in the given language. The syntax is \fBlang:text\fP\&. Eg. \fBen:my\-group\-description\-in\-english\fP\&. +.TP +.B \fB\-\-user\-visible\fP +Make the group visible in \fBdnf grouplist\fP (this is the default). +.TP +.B \fB\-\-not\-user\-visible\fP +Make the group not visible in \fBdnf grouplist\fP\&. +.TP +.B \fB\-\-mandatory\fP +Store the package names specified within the mandatory section of the specified group, the default is to use the default section. +.TP +.B \fB\-\-optional\fP +Store the package names specified within the optional section of the specified group, the default is to use the default section. +.TP +.B \fB\-\-remove\fP +Instead of adding packages remove them. Note that the packages are removed from all sections (default, mandatory and optional). +.TP +.B \fB\-\-dependencies\fP +Also include the names of the direct dependencies for each package specified. +.UNINDENT +.SH AUTHOR +See AUTHORS in your Core DNF Plugins distribution +.SH COPYRIGHT +2021, Red Hat, Licensed under GPLv2+ +.\" Generated by docutils manpage writer. +. diff --git a/upstream/opensuse-leap-15-6/man8/dnf-needs-restarting.8 b/upstream/opensuse-leap-15-6/man8/dnf-needs-restarting.8 new file mode 100644 index 00000000..6133b4b8 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/dnf-needs-restarting.8 @@ -0,0 +1,93 @@ +.\" Man page generated from reStructuredText. +. +.TH "DNF-NEEDS-RESTARTING" "8" "Nov 03, 2021" "4.0.24" "dnf-plugins-core" +.SH NAME +dnf-needs-restarting \- DNF needs_restarting Plugin +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.sp +Check for running processes that should be restarted. +.SH SYNOPSIS +.sp +\fBdnf needs\-restarting [\-u] [\-r]\fP +.SH DESCRIPTION +.sp +\fIneeds\-restarting\fP looks through running processes and tries to detect those that use files from packages that have been updated after the given process started. Such processes are reported by this tool. +.sp +Note that in most cases a process should survive update of its binary and libraries it is using without requiring to be restarted for proper operation. There are however specific cases when this does not apply. Separately, processes often need to be restarted to reflect security updates. +.SH OPTIONS +.sp +All general DNF options are accepted, see \fIOptions\fP in \fBdnf(8)\fP for details. +.sp +\fB\-u, \-\-useronly\fP +.INDENT 0.0 +.INDENT 3.5 +Only consider processes belonging to the running user. +.UNINDENT +.UNINDENT +.sp +\fB\-r, \-\-reboothint\fP +.INDENT 0.0 +.INDENT 3.5 +Only report whether a reboot is required (exit code 1) or not (exit code 0). +.UNINDENT +.UNINDENT +.INDENT 0.0 +.TP +.B \fB\-s, \-\-services\fP +Only list the affected systemd services. +.UNINDENT +.SH CONFIGURATION +.sp +\fB/etc/dnf/plugins/needs\-restarting.d/\fP +.sp +\fB/etc/dnf/plugins/needs\-restarting.d/pkgname.conf\fP +.sp +Packages can be added to \fBneeds\-restarting\fP via conf files in config +directory. Config files need to have \fB\&.conf\fP extension or will be ignored. +.sp +More than one package is allowed in each file (one package per line) although +it is advised to use one file for each package. +.sp +Example: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +echo "dwm" > /etc/dnf/plugins/needs\-restarting.d/dwm.conf +.ft P +.fi +.UNINDENT +.UNINDENT +.SH AUTHOR +See AUTHORS in your Core DNF Plugins distribution +.SH COPYRIGHT +2021, Red Hat, Licensed under GPLv2+ +.\" Generated by docutils manpage writer. +. diff --git a/upstream/opensuse-leap-15-6/man8/dnf-repoclosure.8 b/upstream/opensuse-leap-15-6/man8/dnf-repoclosure.8 new file mode 100644 index 00000000..ca2c0246 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/dnf-repoclosure.8 @@ -0,0 +1,120 @@ +.\" Man page generated from reStructuredText. +. +.TH "DNF-REPOCLOSURE" "8" "Nov 03, 2021" "4.0.24" "dnf-plugins-core" +.SH NAME +dnf-repoclosure \- DNF repoclosure Plugin +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.sp +Display a list of unresolved dependencies for repositories. +.SH SYNOPSIS +.sp +\fBdnf repoclosure [<options>]\fP +.SH DESCRIPTION +.sp +\fIrepoclosure\fP is a program that reads package metadata from one or more repositories, checks all dependencies, and displays a list of packages with unresolved dependencies. +.SS Options +.sp +All general DNF options are accepted, see \fIOptions\fP in \fBdnf(8)\fP for details. +.INDENT 0.0 +.TP +.B \fB\-\-arch <arch>\fP +Query only packages for specified architecture, can be specified multiple times (default is all +compatible architectures with your system). To run repoclosure for arch incompatible with your +system use \fB\-\-forcearch=<arch>\fP option to change basearch. +.TP +.B \fB\-\-best\fP +Check only the newest packages per arch. +.TP +.B \fB\-\-check <repoid>\fP +Specify repo ids to check, can be specified multiple times (default is all enabled). +.TP +.B \fB\-\-newest\fP +Check only the newest packages in the repos. +.TP +.B \fB\-\-pkg <pkg\-spec>\fP +Check closure for this package only. +.TP +.B \fB\-\-repo <repoid>\fP +Specify repo ids to query, can be specified multiple times (default is all enabled). +.UNINDENT +.SH EXAMPLES +.sp +Display list of unresolved dependencies for all enabled repositories: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +dnf repoclosure +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Display list of unresolved dependencies for rawhide repository and packages with architecture noarch and x86_64: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +dnf repoclosure \-\-repo rawhide \-\-arch noarch \-\-arch x86_64 +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Display list of unresolved dependencies for zmap package from rawhide repository: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +dnf repoclosure \-\-repo rawhide \-\-pkg zmap +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Display list of unresolved dependencies for myrepo, an add\-on for the rawhide repository: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +dnf repoclosure \-\-repo rawhide \-\-check myrepo +.ft P +.fi +.UNINDENT +.UNINDENT +.SH AUTHOR +See AUTHORS in your Core DNF Plugins distribution +.SH COPYRIGHT +2021, Red Hat, Licensed under GPLv2+ +.\" Generated by docutils manpage writer. +. diff --git a/upstream/opensuse-leap-15-6/man8/dnf-repodiff.8 b/upstream/opensuse-leap-15-6/man8/dnf-repodiff.8 new file mode 100644 index 00000000..98c915dd --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/dnf-repodiff.8 @@ -0,0 +1,109 @@ +.\" Man page generated from reStructuredText. +. +.TH "DNF-REPODIFF" "8" "Nov 03, 2021" "4.0.24" "dnf-plugins-core" +.SH NAME +dnf-repodiff \- DNF repodiff Plugin +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.sp +Display a list of differences between two or more repositories +.SH SYNOPSIS +.sp +\fBdnf repodiff [<options>]\fP +.SH DESCRIPTION +.sp +\fIrepodiff\fP is a program which will list differences between two sets of repositories. Note that by default only source packages are compared. +.SS Options +.sp +All general DNF options are accepted, see \fIOptions\fP in \fBdnf(8)\fP for details. +.INDENT 0.0 +.TP +.B \fB\-\-repo\-old=<repoid>, \-o <repoid>\fP +Add a \fB<repoid>\fP as an old repository. It is possible to be used in conjunction with \fB\-\-repofrompath\fP option. Can be specified multiple times. +.TP +.B \fB\-\-repo\-new=<repoid>, \-n <repoid>\fP +Add a \fB<repoid>\fP as a new repository. Can be specified multiple times. +.TP +.B \fB\-\-archlist=<arch>, \-a <arch>\fP +Add architectures to change the default from just comparing source packages. Note that you can use a wildcard "*" for all architectures. Can be specified multiple times. +.TP +.B \fB\-\-size, \-s\fP +Output additional data about the size of the changes. +.TP +.B \fB\-\-compare\-arch\fP +Normally packages are just compared based on their name, this flag makes the comparison also use the arch. So foo.noarch and foo.x86_64 are considered to be a different packages. +.TP +.B \fB\-\-simple\fP +Output a simple one line message for modified packages. +.TP +.B \fB\-\-downgrade\fP +Split the data for modified packages between upgraded and downgraded packages. +.UNINDENT +.SH EXAMPLES +.sp +Compare source pkgs in two local repos: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +dnf repodiff \-\-repofrompath=o,/tmp/repo\-old \-\-repofrompath=n,/tmp/repo\-new \-\-repo\-old=o \-\-repo\-new=n +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Compare x86_64 compat. binary pkgs in two remote repos, and two local one: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +dnf repodiff \-\-repofrompath=o,http://example.com/repo\-old \-\-repofrompath=n,http://example.com/repo\-new \-\-repo\-old=o \-\-repo\-new=n \-\-archlist=x86_64 +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Compare x86_64 compat. binary pkgs, but also compare architecture: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +dnf repodiff \-\-repofrompath=o,http://example.com/repo\-old \-\-repofrompath=n,http://example.com/repo\-new \-\-repo\-old=o \-\-repo\-new=n \-\-archlist=x86_64 \-\-compare\-arch +.ft P +.fi +.UNINDENT +.UNINDENT +.SH AUTHOR +See AUTHORS in your Core DNF Plugins distribution +.SH COPYRIGHT +2021, Red Hat, Licensed under GPLv2+ +.\" Generated by docutils manpage writer. +. diff --git a/upstream/opensuse-leap-15-6/man8/dnf-repograph.8 b/upstream/opensuse-leap-15-6/man8/dnf-repograph.8 new file mode 100644 index 00000000..20602605 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/dnf-repograph.8 @@ -0,0 +1,92 @@ +.\" Man page generated from reStructuredText. +. +.TH "DNF-REPOGRAPH" "8" "Nov 03, 2021" "4.0.24" "dnf-plugins-core" +.SH NAME +dnf-repograph \- DNF repograph Plugin +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.sp +Output a full package dependency graph in dot format. +.SH SYNOPSIS +.sp +\fBdnf repograph [<options>]\fP +\fBdnf repo\-graph [<options>]\fP +.SH DESCRIPTION +.sp +\fIrepograph\fP is a program that generates a full package dependency list from a repository and outputs it in dot format. +.SS Options +.sp +All general DNF options are accepted, see \fIOptions\fP in \fBdnf(8)\fP for details. +.INDENT 0.0 +.TP +.B \fB\-\-repo <repoid>\fP +Specify repo ids to query, can be specified multiple times (default is all enabled). +.UNINDENT +.SH EXAMPLES +.sp +Output dependency list from all enabled repositories: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +dnf repograph +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Output dependency list from rawhide repository: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +dnf repograph \-\-repoid rawhide +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Output dependency list from rawhide and koji repository: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +dnf repo\-graph \-\-repoid rawhide \-\-repoid koji +.ft P +.fi +.UNINDENT +.UNINDENT +.SH AUTHOR +See AUTHORS in your Core DNF Plugins distribution +.SH COPYRIGHT +2021, Red Hat, Licensed under GPLv2+ +.\" Generated by docutils manpage writer. +. diff --git a/upstream/opensuse-leap-15-6/man8/dnf-repomanage.8 b/upstream/opensuse-leap-15-6/man8/dnf-repomanage.8 new file mode 100644 index 00000000..0eeb83fd --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/dnf-repomanage.8 @@ -0,0 +1,109 @@ +.\" Man page generated from reStructuredText. +. +.TH "DNF-REPOMANAGE" "8" "Nov 03, 2021" "4.0.24" "dnf-plugins-core" +.SH NAME +dnf-repomanage \- DNF repomanage Plugin +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.sp +Manage a repository or a simple directory of rpm packages. +.SH SYNOPSIS +.sp +\fBdnf repomanage [<optional\-options>] [<options>] <path>\fP +.SH DESCRIPTION +.sp +\fIrepomanage\fP prints newest or older packages in a repository specified by <path> for easy piping to xargs or similar programs. In case <path> doesn\(aqt contain a valid repodata, it is searched for rpm packages which are then used instead. +If the repodata are present, \fIrepomanage\fP uses them as the source of truth, it doesn\(aqt verify that they match the present rpm packages. In fact, \fIrepomanage\fP can run with just the repodata, no rpm packages are needed. +.sp +In order to work correctly with modular packages, <path> has to contain repodata with modular metadata. If modular content is present, \fIrepomanage\fP prints packages from newest or older stream versions in addition to newest or older non\-modular packages. +.SS Options +.sp +All general DNF options are accepted, see \fIOptions\fP in \fBdnf(8)\fP for details. +.sp +The following options set what packages are displayed. These options are mutually exclusive, i.e. only one can be specified. If no option is specified, the newest packages are shown. +.INDENT 0.0 +.TP +.B \fB\-\-old\fP +Show older packages (for a package or a stream show all versions except the newest one). +.TP +.B \fB\-\-new\fP +Show newest packages. +.UNINDENT +.sp +The following options control how packages are displayed in the output: +.INDENT 0.0 +.TP +.B \fB\-s\fP, \fB\-\-space\fP +Print resulting set separated by space instead of newline. +.TP +.B \fB\-k <keep\-number>\fP, \fB\-\-keep <keep\-number>\fP +Limit the resulting set to newest \fB<keep\-number>\fP packages. +.UNINDENT +.SH EXAMPLES +.sp +Display newest packages in current repository (directory): +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +dnf repomanage \-\-new . +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Display 2 newest versions of each package in "home" directory: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +dnf repomanage \-\-new \-\-keep 2 ~/ +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +Display oldest packages separated by space in current repository (directory): +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +dnf repomanage \-\-old \-\-space . +.ft P +.fi +.UNINDENT +.UNINDENT +.SH AUTHOR +See AUTHORS in your Core DNF Plugins distribution +.SH COPYRIGHT +2021, Red Hat, Licensed under GPLv2+ +.\" Generated by docutils manpage writer. +. diff --git a/upstream/opensuse-leap-15-6/man8/dnf-reposync.8 b/upstream/opensuse-leap-15-6/man8/dnf-reposync.8 new file mode 100644 index 00000000..757f2db5 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/dnf-reposync.8 @@ -0,0 +1,109 @@ +.\" Man page generated from reStructuredText. +. +.TH "DNF-REPOSYNC" "8" "Nov 03, 2021" "4.0.24" "dnf-plugins-core" +.SH NAME +dnf-reposync \- DNF reposync Plugin +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.sp +Synchronize packages of a remote DNF repository to a local directory. +.SH SYNOPSIS +.sp +\fBdnf reposync [options]\fP +.SH DESCRIPTION +.sp +\fIreposync\fP makes local copies of remote repositories. Packages that are already present in the local directory are not downloaded again. +.SH OPTIONS +.sp +All general DNF options are accepted. Namely, the \fB\-\-repoid\fP option can be used to specify the repositories to synchronize. See \fIOptions\fP in \fBdnf(8)\fP for details. +.INDENT 0.0 +.TP +.B \fB\-a <architecture>, \-\-arch=<architecture>\fP +Download only packages of given architectures (default is all architectures). Can be used multiple times. +.TP +.B \fB\-\-delete\fP +Delete local packages no longer present in repository. +.TP +.B \fB\-\-download\-metadata\fP +Download all repository metadata. Downloaded copy is instantly usable as a repository, no need to run createrepo_c on it. +.TP +.B \fB\-g, \-\-gpgcheck\fP +Remove packages that fail GPG signature checking after downloading. Exit code is \fB1\fP if at least one package was removed. +Note that for repositories with \fBgpgcheck=0\fP set in their configuration the GPG signature is not checked even with this option used. +.TP +.B \fB\-m, \-\-downloadcomps\fP +Also download and uncompress comps.xml. Consider using \fB\-\-download\-metadata\fP option which will download all available repository metadata. +.TP +.B \fB\-\-metadata\-path\fP +Root path under which the downloaded metadata are stored. It defaults to \fB\-\-download\-path\fP value if not given. +.TP +.B \fB\-n, \-\-newest\-only\fP +Download only newest packages per\-repo. +.TP +.B \fB\-\-norepopath\fP +Don\(aqt add the reponame to the download path. Can only be used when syncing a single repository (default is to add the reponame). +.TP +.B \fB\-p <download\-path>, \-\-download\-path=<download\-path>\fP +Root path under which the downloaded repositories are stored, relative to the current working directory. Defaults to the current working directory. Every downloaded repository has a subdirectory named after its ID under this path. +.TP +.B \fB\-\-remote\-time\fP +Try to set the timestamps of the downloaded files to those on the remote side. +.TP +.B \fB\-\-source\fP +Download only source packages. +.TP +.B \fB\-u, \-\-urls\fP +Just print urls of what would be downloaded, don\(aqt download. +.UNINDENT +.SH EXAMPLES +.INDENT 0.0 +.TP +.B \fBdnf reposync \-\-repoid=the_repo\fP +Synchronize all packages from the repository with id "the_repo". The synchronized copy is saved in "the_repo" subdirectory of the current working directory. +.TP +.B \fBdnf reposync \-p /my/repos/path \-\-repoid=the_repo\fP +Synchronize all packages from the repository with id "the_repo". In this case files are saved in "/my/repos/path/the_repo" directory. +.TP +.B \fBdnf reposync \-\-repoid=the_repo \-\-download\-metadata\fP +Synchronize all packages and metadata from "the_repo" repository. +.UNINDENT +.sp +Repository synchronized with \fB\-\-download\-metadata\fP option can be directly used in DNF for example by using \fB\-\-repofrompath\fP option: +.sp +\fBdnf \-\-repofrompath=syncedrepo,the_repo \-\-repoid=syncedrepo list \-\-available\fP +.SH SEE ALSO +.INDENT 0.0 +.IP \(bu 2 +\fBdnf(8)\fP, DNF Command Reference +.UNINDENT +.SH AUTHOR +See AUTHORS in your Core DNF Plugins distribution +.SH COPYRIGHT +2021, Red Hat, Licensed under GPLv2+ +.\" Generated by docutils manpage writer. +. diff --git a/upstream/opensuse-leap-15-6/man8/drpmsync.8 b/upstream/opensuse-leap-15-6/man8/drpmsync.8 new file mode 100644 index 00000000..163d972e --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/drpmsync.8 @@ -0,0 +1,277 @@ +.\" man page for drpmsync +.\" Copyright (c) 2005 Michael Schroeder <mls@suse.de> +.\" See LICENSE.BSD for license +.TH DRPMSYNC 8 "Jun 2005" +.SH NAME +drpmsync \- sync a file tree with deltarpms + +.SH SYNOPSIS +.B drpmsync +.RB [ -c +.IR config ] +.RI [ source ] +.I dir +.br +.B drpmsync +.RB [ -s | -S ] +.I serverconfig +.br +.B cgi-bin/drpmsync + +.SH DESCRIPTION +Drpmsync keeps a local file system tree in sync with a remote one. +Its intended use is to work with rpm trees; the deltarpm technology +can only save bandwidth if rpms get transmitted. Please use the +rsync program for normal file trees. + +Drpmsync can run in two modes: as a client it connects to a server, +receives a file list and brings the tree up to date, as a server +it answers incoming requests and transmits files and rpms. + +.SH CLIENT MODE +In this mode drpmsync updates the tree in +.IR dir . +It opens the configuration file +.IB dir /drpmsync/config +to get information about which server to use and other settings. +You can specify a different configuration file with the +.B -c +option. +The following settings are understood (the default for the boolean +settings is false): +.sp +.ne 3 +.B source: +.I server1 +.IR server2 ... +.PP +This is a list of servers to connect to. Drpmsync advances through +this list until a working server is found. If a source is specified +on the command line it is used instead of the one from the +configuration. The syntax for the server entries is +"\fIhost\fP[\fB:\fP\fIport\fP]/\fItree\fP". +.sp +.ne 3 +.B log: +.I logfile +.PP +Specifies the name of a logfile. If the name does not start with +a slash, +.IB dir /drpmsync/ +is prepended to it. +.sp +.ne 3 +.B generate_deltas: +.BR true|false +.PP +Controls whether drpmsync generates a delta if it receives a new +version of a rpm and the server doesn't provide a delta. This +is only useful if the local tree is also exported to other clients +via a local drpmsync server. +.sp +.ne 3 +.B generate_delta_compression: +.I comp +.PP +This parameter is forwarded to the makedeltarpm program when +creating deltas. An example would be +.BR gzip,gzip . +.sp +.ne 3 +.B keep_deltas: +.BR true|false +.PP +Tell drpmsync to save received or freshly created deltas to the +.IB dir /drpmsync/delta +directory. Automatically true if +.B generate_deltas +or +.B keep_uncombined +is set to true. +.sp +.ne 3 +.B keep_uncombined: +.BR true|false +.PP +This tells drpmsync to request uncombined deltas from the server instead +of a precombined single delta. This makes sense if you re-export the +tree and want to maximize the number of versions your clients can +update from. +.sp +.ne 3 +.B always_get_rpm: +.BR true|false +.PP +Configures whether drpmsync should request that the full rpm is +always sent along with the delta. Only makes sense if you have a +fast network connection so that applydeltarpm takes longer than +transmitting the ful rpm. +.sp +.ne 3 +.B deltarpmpath: +.I path +.PP +Sets the directory where drpmsync searches for the deltarpm programs. +The default is to search the +.B $PATH +variable. + +.SH SERVER MODE +Drpmsync can wither work as CGI script or as a standalone server. +CGI script mode is automatically selected if the +.B REQUEST_METHOD +environment variable is set. In this mode drpmsync expects the +.B DRPMSYNC_CONFIG +environment variable to contain the path to a server config file. +For apache you can set this with the +.B SetEnv +directive. + +Standalone mode is selected with the +.B -s +or +.B -S +option. In this mode the server configuration must be specified as +an argument to the drpmsync program. The +.B -s +option makes the drpmsync program background itself and exit right +away, while +.B -S +keeps the server in the foreground. + +The server configuration can contain the following settings: +.sp +.ne 3 +.B allow: +.I pattern1 +.IR pattern2 ... +.br +.B deny: +.I pattern1 +.IR pattern2 ... +.PP +This provides the access control for the server. +.I pattern +can either be a simple glob pattern (only +.B * +is supported) or it can be a full regular expression if it is written +as +.BR /RE/ . +The regular expression is automatically anchored at the start and the +end. Examples are +.B 10.10.* +or +.BR /10\e.10\e..*/ +If either the numerical ip address or the domain name of the client +matches any entry of the deny list, access is forbidden. Otherwise +the allow list is searched for a match. If none is found, access +is also denied. The default setting for both lists is empty, so +you have to provide an allow list to allow access for the clients. +.sp +.ne 3 +.B log: +.I logfile +.PP +Specifies the path of a logfile. +.sp +.ne 3 +.B no_combine: +.BR true|false +.PP +If this setting is true the server does not combine deltarpms. +This increases to amount of data that has to be transferred but +reduces the processor load on the server. +.sp +.ne 3 +.B tree: +.I external_path +.I internal_path +.PP +This statements exports the tree located at +.I internal_path +to the clients as directory +.IR external_path . +All of the above settings are saved as settings of this particular +tree, so different trees can use different configurations. This +also means that the configuration directives of a tree must be +above the +.B tree +statement. +.sp +.sp +.ne 3 +The following settings are global and only needed for standalone mode: +.sp +.ne 3 +.B serverlog: +.I logfile +.PP +Specifies the path of a logfile used for logging server events. +.sp +.ne 3 +.B servername: +.IR hostname [: port ] +.PP +The name of the server. If +.I hostname +is empty, the fully qualified domain name is used instead. The port +defaults to port 80. +.sp +.ne 3 +.B serveraddr: +.I addr +.PP +This address is used for binding the server's socket. If not specified, +connections can come from any interface. +.sp +.ne 3 +.BI serveruser: +.I user +.br +.BI servergroup: +.I group +.PP +Configures the user and group the servers swicthes to after binding +the socket to the desired port. Examples are +.B nobody +or +.BR wwwrun . +.sp +.ne 3 +.BI maxclients: +.I num +.PP +This settings limits the maximum number of concurrent connections to +.IR num . +The default value is 10 connections. +.sp +.ne 3 +.B deltarpmpath: +.I path +.PP +Sets the directory where drpmsync searches for the deltarpm programs. +The default is to search the +.B $PATH +variable. + +.SH FILES +.PD 0 +.IP \fIdir\fP/drpmsync/deltas +directory used to store the deltas +.IP \fIdir\fP/drpmsync/lock +lock used to serialize syncrpm calls +.IP \fIdir\fP/drpmsync/wip +temporary storing space for the transmitted objects +.IP \fIdir\fP/drpmsync/cache +md5sum cache to speed up the calculation of the tree state +.IP \fIdir\fP/drpmsync/timstamp +contains the time of the last finished sync and the last time the +remote tree state was requested. + +.SH SEE ALSO +.BR makedeltarpm (8), +.BR combinedeltarpm (8), +.BR applydeltarpm (8), + +.SH AUTHOR +Michael Schroeder <mls@suse.de> diff --git a/upstream/opensuse-leap-15-6/man8/dump-acct.8 b/upstream/opensuse-leap-15-6/man8/dump-acct.8 new file mode 100644 index 00000000..885e1a3f --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/dump-acct.8 @@ -0,0 +1,53 @@ +.\" Copyright (C) 2009 Red Hat, Inc. All Rights Reserved. +.\" Written by Ivana Hutarova Varekova <varekova@redhat.com> +.TH DUMP_ACCT 8 "2009 December 2" "Linux accounting system" + +.SH NAME +dump\-acct \- print an acct/pacct file in human-readable format + +.SH SYNOPSIS +.B dump-acct +[\fB\-r\fR|\fB\-\-reverse\fR] +[\fB\-R\fR|\fB\-\-raw\fR] +[\fB\-n\fR|\fB\-\-num\fR\ \fIrecs\fR] +[\fB\-\-byte\-swap\fR] +[\fB\-\-format\fR] +[\fB\-\-ahz\fR\ \fIfreq\fR] +[\fB\-h\fR|\fB\-\-help\fR] +[\fIfiles\fR] + +.SH DESCRIPTION +The dump-acct command transforms the output \fBfile\fR from the +accton format to the human-readable format: one record per line. +Each record consists of severald fields which are separated by +character "|" (the meaning of concreate field depends on the +version of kernel package - with which the accton file was created). + +.SH OPTIONS +The following options are supported: +.TP +.B -r, --reverse +Print the output in reverse order. +.TP +.B -R, --raw +The records will be printed without any parsing. +.TP +.B -n, --num NUMRECS +Display only the first NUMRECS number of records. +.TP +.B --byteswap +Swap the bytes (relative to your system's native byte order) in --raw output. +.TP +.B --format +Set output format with --raw option. +.TP +.B --ahz FREQ +Set the AHZ (platform dependent frequency in Hertz) to FREQ. +.TP +.B -h, --help +Print a help message and the default location of the process accounting file +and exit. + +.SH SEE ALSO +accton (8), lastcomm (1) + diff --git a/upstream/opensuse-leap-15-6/man8/dump-utmp.8 b/upstream/opensuse-leap-15-6/man8/dump-utmp.8 new file mode 100644 index 00000000..76b13e78 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/dump-utmp.8 @@ -0,0 +1,29 @@ +.\" Copyright (C) 2009 Red Hat, Inc. All Rights Reserved. +.\" Written by Ivana Hutarova Varekova <varekova@redhat.com> +.TH DUMP_UTMP 8 "2009 December 2" "Linux accounting system" + +.SH NAME +dump\-utmp \- print a utmp file in human-readable format + +.SH SYNOPSYS +\fBdump-utmp\fR [\fB-hrR\fR] [\fB-n\fR <\fIrecs\fR>] <\fBfiles\fR> + [\fB--num\fR <\fIrecs\fR>] [\fB--raw\fR] [\fB--reverse\fR] [\fB--help\fR] + +.SH OPTIONS +The following options are supported: +.TP +.B -h, --help +Print a help message and the default location of the process accounting file +and exit. +.TP +.B -r, --reverse +Print the output in reverse order. +.TP +.B -R, --raw +The records will be printed without any parsing. +.TP +.B -n, --num NUMRECS +Display only the first NUMRECS number of records. + +.SH SEE ALSO +accton (8), lastcomm (1), utmp (5) diff --git a/upstream/opensuse-leap-15-6/man8/dumpe2fs.8 b/upstream/opensuse-leap-15-6/man8/dumpe2fs.8 new file mode 100644 index 00000000..e1b15c0c --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/dumpe2fs.8 @@ -0,0 +1,115 @@ +.\" -*- 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 DUMPE2FS 8 "February 2023" "E2fsprogs version 1.47.0" +.SH NAME +dumpe2fs \- dump ext2/ext3/ext4 file system information +.SH SYNOPSIS +.B dumpe2fs +[ +.B \-bfghixV +] +[ +.B \-o superblock=\fIsuperblock +] +[ +.B \-o blocksize=\fIblocksize +] +.I device +.SH DESCRIPTION +.B dumpe2fs +prints the super block and blocks group information for the file system +present on +.I device. +.PP +.B Note: +When used with a mounted file system, the printed +information may be old or inconsistent. +.SH OPTIONS +.TP +.B \-b +print the blocks which are reserved as bad in the file system. +.TP +.B \-o superblock=\fIsuperblock +use the block +.I superblock +when examining the file system. +This option is not usually needed except by a file system wizard who +is examining the remains of a very badly corrupted file system. +.TP +.B \-o blocksize=\fIblocksize +use blocks of +.I blocksize +bytes when examining the file system. +This option is not usually needed except by a file system wizard who +is examining the remains of a very badly corrupted file system. +.TP +.B \-f +force dumpe2fs to display a file system even though it may have some +file system feature flags which dumpe2fs may not understand (and which +can cause some of dumpe2fs's display to be suspect). +.TP +.B \-g +display the group descriptor information in a machine readable colon-separated +value format. The fields displayed are the group number; the number of the +first block in the group; the superblock location (or -1 if not present); the +range of blocks used by the group descriptors (or -1 if not present); the block +bitmap location; the inode bitmap location; and the range of blocks used by the +inode table. +.TP +.B \-h +only display the superblock information and not any of the block +group descriptor detail information. +.TP +.B \-i +display the file system data from an image file created by +.BR e2image , +using +.I device +as the pathname to the image file. +.TP +.B \-m +If the +.B mmp +feature is enabled on the file system, check if +.I device +is in use by another node, see +.BR e2mmpstatus (8) +for full details. If used together with the +.B \-i +option, only the MMP block information is printed. +.TP +.B \-x +print the detailed group information block numbers in hexadecimal format +.TP +.B \-V +print the version number of +.B dumpe2fs +and exit. +.SH EXIT CODE +.B dumpe2fs +exits with a return code of 0 if the operation completed without errors. +It will exit with a non-zero return code if there are any errors, such +as problems reading a valid superblock, bad checksums, or if the device +is in use by another node and +.B -m +is specified. +.SH BUGS +You may need to know the physical file system structure to understand the +output. +.SH AUTHOR +.B dumpe2fs +was written by Remy Card <Remy.Card@linux.org>. It is currently being +maintained by Theodore Ts'o <tytso@alum.mit.edu>. +.SH AVAILABILITY +.B dumpe2fs +is part of the e2fsprogs package and is available from +http://e2fsprogs.sourceforge.net. +.SH SEE ALSO +.BR e2fsck (8), +.BR e2mmpstatus (8), +.BR mke2fs (8), +.BR tune2fs (8). +.BR ext4 (5) + diff --git a/upstream/opensuse-leap-15-6/man8/e2freefrag.8 b/upstream/opensuse-leap-15-6/man8/e2freefrag.8 new file mode 100644 index 00000000..510cbb32 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/e2freefrag.8 @@ -0,0 +1,96 @@ +.\" -*- nroff -*- +.TH E2FREEFRAG 8 "February 2023" "E2fsprogs version 1.47.0" +.SH NAME +e2freefrag \- report free space fragmentation information +.SH SYNOPSIS +.B e2freefrag +[ +.B \-c chunk_kb +] +[ +.B \-h +] +.B filesys + +.SH DESCRIPTION +.B e2freefrag +is used to report free space fragmentation on ext2/3/4 file systems. +.I filesys +is the file system device name (e.g. +.IR /dev/hdc1 ", " /dev/md0 ). +The +.B e2freefrag +program will scan the block bitmap information to check how many free blocks +are present as contiguous and aligned free space. The percentage of contiguous +free blocks of size and of alignment +.I chunk_kb +is reported. It also displays the minimum/maximum/average free chunk size in +the file system, along with a histogram of all free chunks. This information +can be used to gauge the level of free space fragmentation in the file system. +.SH OPTIONS +.TP +.BI \-c " chunk_kb" +If a chunk size is specified, then +.B e2freefrag +will print how many free chunks of size +.I chunk_kb +are available in units of kilobytes (Kb). The chunk size must be a +power of two and be larger than file system block size. +.TP +.B \-h +Print the usage of the program. +.SH EXAMPLE +# e2freefrag /dev/vgroot/lvhome +.br +Device: /dev/vgroot/lvhome +.br +Blocksize: 4096 bytes +.br +Total blocks: 1504085 +.br +Free blocks: 292995 (19.5%) +.br + +Min. free extent: 4 KB +.br +Max. free extent: 24008 KB +.br +Avg. free extent: 252 KB +.br + +HISTOGRAM OF FREE EXTENT SIZES: +.br +Extent Size Range : Free extents Free Blocks Percent +.br + 4K... 8K- : 704 704 0.2% +.br + 8K... 16K- : 810 1979 0.7% +.br + 16K... 32K- : 843 4467 1.5% +.br + 32K... 64K- : 579 6263 2.1% +.br + 64K... 128K- : 493 11067 3.8% +.br + 128K... 256K- : 394 18097 6.2% +.br + 256K... 512K- : 281 25477 8.7% +.br + 512K... 1024K- : 253 44914 15.3% +.br + 1M... 2M- : 143 51897 17.7% +.br + 2M... 4M- : 73 50683 17.3% +.br + 4M... 8M- : 37 52417 17.9% +.br + 8M... 16M- : 7 19028 6.5% +.br + 16M... 32M- : 1 6002 2.0% +.SH AUTHOR +This version of e2freefrag was written by Rupesh Thakare, and modified by +Andreas Dilger <adilger@sun.com>, and Kalpak Shah. +.SH SEE ALSO +.IR debugfs (8), +.IR dumpe2fs (8), +.IR e2fsck (8) diff --git a/upstream/opensuse-leap-15-6/man8/e2fsck.8 b/upstream/opensuse-leap-15-6/man8/e2fsck.8 new file mode 100644 index 00000000..68b867cf --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/e2fsck.8 @@ -0,0 +1,509 @@ +.\" -*- 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 E2FSCK 8 "February 2023" "E2fsprogs version 1.47.0" +.SH NAME +e2fsck \- check a Linux ext2/ext3/ext4 file system +.SH SYNOPSIS +.B e2fsck +[ +.B \-pacnyrdfkvtDFV +] +[ +.B \-b +.I superblock +] +[ +.B \-B +.I blocksize +] +[ +.BR \-l | \-L +.I bad_blocks_file +] +[ +.B \-C +.I fd +] +[ +.B \-j +.I external-journal +] +[ +.B \-E +.I extended_options +] +[ +.B \-z +.I undo_file +] +.I device +.SH DESCRIPTION +.B e2fsck +is used to check the ext2/ext3/ext4 family of file systems. +For ext3 and ext4 file systems that use a journal, if the system has been +shut down uncleanly without any errors, normally, after replaying the +committed transactions in the journal, the file system should be +marked as clean. Hence, for file systems that use journaling, +.B e2fsck +will normally replay the journal and exit, unless its superblock +indicates that further checking is required. +.PP +.I device +is a block device (e.g., +.IR /dev/sdc1 ) +or file containing the file system. +.PP +Note that in general it is not safe to run +.B e2fsck +on mounted file systems. The only exception is if the +.B \-n +option is specified, and +.BR \-c , +.BR \-l , +or +.B -L +options are +.I not +specified. However, even if it is safe to do so, the results printed by +.B e2fsck +are not valid if the file system is mounted. If +.B e2fsck +asks whether or not you should check a file system which is mounted, +the only correct answer is ``no''. Only experts who really know what +they are doing should consider answering this question in any other way. +.PP +If +.B e2fsck +is run in interactive mode (meaning that none of +.BR \-y , +.BR \-n , +or +.BR \-p +are specified), the program will ask the user to fix each problem found in the +file system. A response of 'y' will fix the error; 'n' will leave the error +unfixed; and 'a' will fix the problem and all subsequent problems; pressing +Enter will proceed with the default response, which is printed before the +question mark. Pressing Control-C terminates e2fsck immediately. +.SH OPTIONS +.TP +.B \-a +This option does the same thing as the +.B \-p +option. It is provided for backwards compatibility only; it is +suggested that people use +.B \-p +option whenever possible. +.TP +.BI \-b " superblock" +Instead of using the normal superblock, use an alternative superblock +specified by +.IR superblock . +This option is normally used when the primary superblock has been +corrupted. The location of backup superblocks is dependent on the +file system's blocksize, the number of blocks per group, and features +such as +.BR sparse_super . +.IP +Additional backup superblocks can be determined by using the +.B mke2fs +program using the +.B \-n +option to print out where the superblocks exist, supposing +.B mke2fs +is supplied with arguments that are consistent with the file system's layout +(e.g. blocksize, blocks per group, +.BR sparse_super , +etc.). +.IP +If an alternative superblock is specified and +the file system is not opened read-only, e2fsck will make sure that the +primary superblock is updated appropriately upon completion of the +file system check. +.TP +.BI \-B " blocksize" +Normally, +.B e2fsck +will search for the superblock at various different +block sizes in an attempt to find the appropriate block size. +This search can be fooled in some cases. This option forces +.B e2fsck +to only try locating the superblock at a particular blocksize. +If the superblock is not found, +.B e2fsck +will terminate with a fatal error. +.TP +.B \-c +This option causes +.B e2fsck +to use +.BR badblocks (8) +program to do a read-only scan of the device in order to find any bad +blocks. If any bad blocks are found, they are added to the bad block +inode to prevent them from being allocated to a file or directory. If +this option is specified twice, then the bad block scan will be done +using a non-destructive read-write test. +.TP +.BI \-C " fd" +This option causes +.B e2fsck +to write completion information to the specified file descriptor +so that the progress of the file system +check can be monitored. This option is typically used by programs +which are running +.BR e2fsck . +If the file descriptor number is negative, then absolute value of +the file descriptor will be used, and the progress information will be +suppressed initially. It can later be enabled by sending the +.B e2fsck +process a SIGUSR1 signal. +If the file descriptor specified is 0, +.B e2fsck +will print a completion bar as it goes about its business. This requires +that e2fsck is running on a video console or terminal. +.TP +.B \-d +Print debugging output (useless unless you are debugging +.BR e2fsck ). +.TP +.B \-D +Optimize directories in file system. This option causes e2fsck to +try to optimize all directories, either by re-indexing them if the +file system supports directory indexing, or by sorting and compressing +directories for smaller directories, or for file systems using +traditional linear directories. +.IP +Even without the +.B \-D +option, +.B e2fsck +may sometimes optimize a few directories --- for example, if +directory indexing is enabled and a directory is not indexed and would +benefit from being indexed, or if the index structures are corrupted +and need to be rebuilt. The +.B \-D +option forces all directories in the file system to be optimized. This can +sometimes make them a little smaller and slightly faster to search, but +in practice, you should rarely need to use this option. +.IP +The +.B \-D +option will detect directory entries with duplicate names in a single +directory, which e2fsck normally does not enforce for performance reasons. +.TP +.BI \-E " extended_options" +Set e2fsck extended options. Extended options are comma +separated, and may take an argument using the equals ('=') sign. The +following options are supported: +.RS 1.2i +.TP +.BI ea_ver= extended_attribute_version +Set the version of the extended attribute blocks which +.B e2fsck +will require while checking the file system. The version number may +be 1 or 2. The default extended attribute version format is 2. +.TP +.BI journal_only +Only replay the journal if required, but do not perform any further checks +or repairs. +.TP +.BI fragcheck +During pass 1, print a detailed report of any discontiguous blocks for +files in the file system. +.TP +.BI discard +Attempt to discard free blocks and unused inode blocks after the full +file system check (discarding blocks is useful on solid state devices and sparse +/ thin-provisioned storage). Note that discard is done in pass 5 AFTER the +file system has been fully checked and only if it does not contain recognizable +errors. However there might be cases where +.B e2fsck +does not fully recognize a problem and hence in this case this +option may prevent you from further manual data recovery. +.TP +.BI nodiscard +Do not attempt to discard free blocks and unused inode blocks. This option is +exactly the opposite of discard option. This is set as default. +.TP +.BI no_optimize_extents +Do not offer to optimize the extent tree by eliminating unnecessary +width or depth. This can also be enabled in the options section of +.BR /etc/e2fsck.conf . +.TP +.BI optimize_extents +Offer to optimize the extent tree by eliminating unnecessary +width or depth. This is the default unless otherwise specified in +.BR /etc/e2fsck.conf . +.TP +.BI inode_count_fullmap +Trade off using memory for speed when checking a file system with a +large number of hard-linked files. The amount of memory required is +proportional to the number of inodes in the file system. For large file +systems, this can be gigabytes of memory. (For example, a 40TB file system +with 2.8 billion inodes will consume an additional 5.7 GB memory if this +optimization is enabled.) This optimization can also be enabled in the +options section of +.BR /etc/e2fsck.conf . +.TP +.BI no_inode_count_fullmap +Disable the +.B inode_count_fullmap +optimization. This is the default unless otherwise specified in +.BR /etc/e2fsck.conf . +.TP +.BI readahead_kb +Use this many KiB of memory to pre-fetch metadata in the hopes of reducing +e2fsck runtime. By default, this is set to the size of two block groups' inode +tables (typically 4MiB on a regular ext4 file system); if this amount is more +than 1/50th of total physical memory, readahead is disabled. Set this to zero +to disable readahead entirely. +.TP +.BI bmap2extent +Convert block-mapped files to extent-mapped files. +.TP +.BI fixes_only +Only fix damaged metadata; do not optimize htree directories or compress +extent trees. This option is incompatible with the -D and -E bmap2extent +options. +.TP +.BI check_encoding +Force verification of encoded filenames in case-insensitive directories. +This is the default mode if the file system has the strict flag enabled. +.TP +.BI unshare_blocks +If the file system has shared blocks, with the shared blocks read-only feature +enabled, then this will unshare all shared blocks and unset the read-only +feature bit. If there is not enough free space then the operation will fail. +If the file system does not have the read-only feature bit, but has shared +blocks anyway, then this option will have no effect. Note when using this +option, if there is no free space to clone blocks, there is no prompt to +delete files and instead the operation will fail. +.IP +Note that unshare_blocks implies the "-f" option to ensure that all passes +are run. Additionally, if "-n" is also specified, e2fsck will simulate trying +to allocate enough space to deduplicate. If this fails, the exit code will +be non-zero. +.RE +.TP +.B \-f +Force checking even if the file system seems clean. +.TP +.B \-F +Flush the file system device's buffer caches before beginning. Only +really useful for doing +.B e2fsck +time trials. +.TP +.BI \-j " external-journal" +Set the pathname where the external-journal for this file system can be +found. +.TP +.BI \-k +When combined with the +.B \-c +option, any existing bad blocks in the bad blocks list are preserved, +and any new bad blocks found by running +.BR badblocks (8) +will be added to the existing bad blocks list. +.TP +.BI \-l " filename" +Add the block numbers listed in the file specified by +.I filename +to the list of bad blocks. The format of this file is the same as the +one generated by the +.BR badblocks (8) +program. Note that the block numbers are based on the blocksize +of the file system. Hence, +.BR badblocks (8) +must be given the blocksize of the file system in order to obtain correct +results. As a result, it is much simpler and safer to use the +.B -c +option to +.BR e2fsck , +since it will assure that the correct parameters are passed to the +.B badblocks +program. +.TP +.BI \-L " filename" +Set the bad blocks list to be the list of blocks specified by +.IR filename . +(This option is the same as the +.B \-l +option, except the bad blocks list is cleared before the blocks listed +in the file are added to the bad blocks list.) +.TP +.B \-n +Open the file system read-only, and assume an answer of `no' to all +questions. Allows +.B e2fsck +to be used non-interactively. This option +may not be specified at the same time as the +.B \-p +or +.B \-y +options. +.TP +.B \-p +Automatically repair ("preen") the file system. This option will cause +.B e2fsck +to automatically +fix any file system problems that can be safely fixed without human +intervention. If +.B e2fsck +discovers a problem which may require the system administrator +to take additional corrective action, +.B e2fsck +will print a description of the problem and then exit with the value 4 +logically or'ed into the exit code. (See the \fBEXIT CODE\fR section.) +This option is normally used by the system's boot scripts. It may not +be specified at the same time as the +.B \-n +or +.B \-y +options. +.TP +.B \-r +This option does nothing at all; it is provided only for backwards +compatibility. +.TP +.B \-t +Print timing statistics for +.BR e2fsck . +If this option is used twice, additional timing statistics are printed +on a pass by pass basis. +.TP +.B \-v +Verbose mode. +.TP +.B \-V +Print version information and exit. +.TP +.B \-y +Assume an answer of `yes' to all questions; allows +.B e2fsck +to be used non-interactively. This option +may not be specified at the same time as the +.B \-n +or +.B \-p +options. +.TP +.BI \-z " undo_file" +Before overwriting a file system block, write the old contents of the block to +an undo file. This undo file can be used with e2undo(8) to restore the old +contents of the file system should something go wrong. If the empty string is +passed as the undo_file argument, the undo file will be written to a file named +e2fsck-\fIdevice\fR.e2undo in the directory specified via the +\fIE2FSPROGS_UNDO_DIR\fR environment variable. + +WARNING: The undo file cannot be used to recover from a power or system crash. +.SH EXIT CODE +The exit code returned by +.B e2fsck +is the sum of the following conditions: +.br +\ 0\ \-\ No errors +.br +\ 1\ \-\ File system errors corrected +.br +\ 2\ \-\ File system errors corrected, system should +.br +\ \ \ \ be rebooted +.br +\ 4\ \-\ File system errors left uncorrected +.br +\ 8\ \-\ Operational error +.br +\ 16\ \-\ Usage or syntax error +.br +\ 32\ \-\ E2fsck canceled by user request +.br +\ 128\ \-\ Shared library error +.br +.SH SIGNALS +The following signals have the following effect when sent to +.BR e2fsck . +.TP +.B SIGUSR1 +This signal causes +.B e2fsck +to start displaying a completion bar or emitting progress information. +(See discussion of the +.B \-C +option.) +.TP +.B SIGUSR2 +This signal causes +.B e2fsck +to stop displaying a completion bar or emitting progress information. +.SH REPORTING BUGS +Almost any piece of software will have bugs. If you manage to find a +file system which causes +.B e2fsck +to crash, or which +.B e2fsck +is unable to repair, please report it to the author. +.PP +Please include as much information as possible in your bug report. +Ideally, include a complete transcript of the +.B e2fsck +run, so I can see exactly what error messages are displayed. (Make sure +the messages printed by +.B e2fsck +are in English; if your system has been +configured so that +.BR e2fsck 's +messages have been translated into another language, please set the the +.B LC_ALL +environment variable to +.B C +so that the transcript of e2fsck's output will be useful to me.) +If you +have a writable file system where the transcript can be stored, the +.BR script (1) +program is a handy way to save the output of +.B e2fsck +to a file. +.PP +It is also useful to send the output of +.BR dumpe2fs (8). +If a specific inode or inodes seems to be giving +.B e2fsck +trouble, try running the +.BR debugfs (8) +command and send the output of the +.BR stat (1u) +command run on the relevant inode(s). If the inode is a directory, the +.B debugfs +.I dump +command will allow you to extract the contents of the directory inode, +which can sent to me after being first run through +.BR uuencode (1). +The most useful data you can send to help reproduce +the bug is a compressed raw image dump of the file system, generated using +.BR e2image (8). +See the +.BR e2image (8) +man page for more details. +.PP +Always include the full version string which +.B e2fsck +displays when it is run, so I know which version you are running. +.SH ENVIRONMENT +.TP +.BI E2FSCK_CONFIG +Determines the location of the configuration file (see +.BR e2fsck.conf (5)). +.SH AUTHOR +This version of +.B e2fsck +was written by Theodore Ts'o <tytso@mit.edu>. +.SH SEE ALSO +.BR e2fsck.conf (5), +.BR badblocks (8), +.BR dumpe2fs (8), +.BR debugfs (8), +.BR e2image (8), +.BR mke2fs (8), +.BR tune2fs (8) diff --git a/upstream/opensuse-leap-15-6/man8/e2image.8 b/upstream/opensuse-leap-15-6/man8/e2image.8 new file mode 100644 index 00000000..25673488 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/e2image.8 @@ -0,0 +1,335 @@ +.\" -*- nroff -*- +.\" Copyright 2001 by Theodore Ts'o. All Rights Reserved. +.\" This file may be copied under the terms of the GNU Public License. +.\" +.TH E2IMAGE 8 "February 2023" "E2fsprogs version 1.47.0" +.SH NAME +e2image \- Save critical ext2/ext3/ext4 file system metadata to a file + +.SH SYNOPSIS +.B e2image +.RB [ \-r | \-Q " [" \-af ]] +[ +.B \-b +.I superblock +] +[ +.B \-B +.I blocksize +] +[ +.B \-cnps +] +[ +.B \-o +.I src_offset +] +[ +.B \-O +.I dest_offset +] +.I device +.I image-file +.br +.B e2image +.B \-I +.I device +.I image-file + +.SH DESCRIPTION +The +.B e2image +program will save critical ext2, ext3, or ext4 file system metadata located on +.I device +to a file specified by +.IR image-file . +The image file may be examined by +.B dumpe2fs +and +.BR debugfs , +by using the +.B \-i +option to those programs. This can assist an expert in recovering +catastrophically corrupted file systems. +.PP +It is a very good idea to create image files for all file systems on a +system and save the partition layout (which can be generated using the +.B fdisk \-l +command) at regular intervals --- at boot time, and/or every week or so. +The image file should be stored on some file system other than +the file system whose data it contains, to ensure that this data is +accessible in the case where the file system has been badly damaged. +.PP +To save disk space, +.B e2image +creates the image file as a sparse file, or in QCOW2 format. Hence, if +the sparse image file needs to be copied to another location, it should +either be compressed first or copied using the +.B \-\-sparse=always +option to the GNU version of +.BR cp (1). +This does not apply to the QCOW2 image, which is not sparse. +.PP +The size of an ext2 image file depends primarily on the size of the +file systems and how many inodes are in use. For a typical 10 Gigabyte +file system, with 200,000 inodes in use out of 1.2 million inodes, the image +file will be approximately 35 Megabytes; a 4 Gigabyte file system with 15,000 +inodes in use out of 550,000 inodes will result in a 3 Megabyte image file. +Image files tend to be quite compressible; an image file taking up 32 Megabytes +of space on disk will generally compress down to 3 or 4 Megabytes. +.PP +If +.I image-file +is +.BR \- , +then the output of +.B e2image +will be sent to standard output, so that the output can be piped to +another program, such as +.BR gzip (1). +(Note that this is currently only supported when +creating a raw image file using the +.B \-r +option, since the process of creating a normal image file, or QCOW2 +image currently +requires random access to the file, which cannot be done using a +pipe. + +.SH OPTIONS +.TP +.B \-a +Include file data in the image file. Normally +.B e2image +only includes fs metadata, not regular file data. This option will +produce an image that is suitable to use to clone the entire FS or +for backup purposes. Note that this option only works with the +raw +.RI ( \-r ) +or QCOW2 +.RI ( \-Q ) +formats. In conjunction with the +.B \-r +option it is possible to clone all and only the used blocks of one +file system to another device/image file. +.TP +.BI \-b " superblock" +Get image from partition with broken primary superblock by using +the superblock located at file system block number +.IR superblock . +The partition is copied as-is including broken primary superblock. +.TP +.BI \-B " blocksize" +Set the file system blocksize in bytes. Normally, +.B e2image +will search for the superblock at various different block sizes in an +attempt to find the appropriate blocksize. This search can be fooled in +some cases. This option forces e2fsck to only try locating the superblock +with a particular blocksize. If the superblock is not found, e2image will +terminate with a fatal error. +.TP +.BI \-c +Compare each block to be copied from the source +.I device +to the corresponding block in the target +.IR image-file . +If both are already the same, the write will be skipped. This is +useful if the file system is being cloned to a flash-based storage device +(where reads are very fast and where it is desirable to avoid unnecessary +writes to reduce write wear on the device). +.TP +.B \-f +Override the read-only requirement for the source file system when saving +the image file using the +.B \-r +and +.B \-Q +options. Normally, if the source file system is in use, the resulting image +file is very likely not going to be useful. In some cases where the source +file system is in constant use this may be better than no image at all. +.TP +.B \-I +install the metadata stored in the image file back to the device. +It can be used to restore the file system metadata back to the device +in emergency situations. +.PP +.B WARNING!!!! +The +.B \-I +option should only be used as a desperation measure when other +alternatives have failed. If the file system has changed since the image +file was created, data +.B will +be lost. In general, you should make another full image backup of the +file system first, in case you wish to try other recovery strategies afterward. +.TP +.B \-n +Cause all image writes to be skipped, and instead only print the block +numbers that would have been written. +.TP +.BI \-o " src_offset" +Specify offset of the image to be read from the start of the source +.I device +in bytes. See +.B OFFSETS +for more details. +.TP +.BI \-O " tgt_offset" +Specify offset of the image to be written from the start of the target +.I image-file +in bytes. See +.B OFFSETS +for more details. +.TP +.B \-p +Show progress of image-file creation. +.TP +.B \-Q +Create a QCOW2-format image file instead of a normal image file, suitable +for use by virtual machine images, and other tools that can use the +.B .qcow +image format. See +.B QCOW2 IMAGE FILES +below for details. +.TP +.B \-r +Create a raw image file instead of a normal image file. See +.B RAW IMAGE FILES +below for details. +.TP +.B \-s +Scramble directory entries and zero out unused portions of the directory +blocks in the written image file to avoid revealing information about +the contents of the file system. However, this will prevent analysis of +problems related to hash-tree indexed directories. + +.SH RAW IMAGE FILES +The +.B \-r +option will create a raw image file, which differs +from a normal image file in two ways. First, the file system metadata is +placed in the same relative offset within +.I image-file +as it is in the +.I device +so that +.BR debugfs (8), +.BR dumpe2fs (8), +.BR e2fsck (8), +.BR losetup (8), +etc. and can be run directly on the raw image file. In order to minimize +the amount of disk space consumed by the raw image file, it is +created as a sparse file. (Beware of copying or +compressing/decompressing this file with utilities that don't understand +how to create sparse files; the file will become as large as the +file system itself!) Secondly, the raw image file also includes indirect +blocks and directory blocks, which the standard image file does not have. +.PP +Raw image files are sometimes used when sending file systems to the maintainer +as part of bug reports to e2fsprogs. When used in this capacity, the +recommended command is as follows (replace +.B hda1 +with the appropriate device for your system): +.PP +.br + \fBe2image \-r /dev/hda1 \- | bzip2 > hda1.e2i.bz2\fR +.PP +This will only send the metadata information, without any data blocks. +However, the filenames in the directory blocks can still reveal +information about the contents of the file system that the bug reporter +may wish to keep confidential. To address this concern, the +.B \-s +option can be specified to scramble the filenames in the image. +.PP +Note that this will work even if you substitute +.B /dev/hda1 +for another raw +disk image, or QCOW2 image previously created by +.BR e2image . + +.SH QCOW2 IMAGE FILES +The +.B \-Q +option will create a QCOW2 image file instead of a normal, or raw image file. +A QCOW2 image contains all the information the raw image does, however unlike +the raw image it is not sparse. The QCOW2 image minimize the amount of space +used by the image by storing it in special format which packs data closely +together, hence avoiding holes while still minimizing size. +.PP +In order to send file system to the maintainer as a part of bug report to +e2fsprogs, use following commands (replace +.B hda1 +with the appropriate device for your system): +.PP +.br +\ \fBe2image \-Q /dev/hda1 hda1.qcow2\fR +.br +\ \fBbzip2 -z hda1.qcow2\fR +.PP +This will only send the metadata information, without any data blocks. +As described for +.B RAW IMAGE FILES +the +.B \-s +option can be specified to scramble the file system names in the image. +.PP +Note that the QCOW2 image created by +.B e2image +is a regular QCOW2 image and can be processed by tools aware of QCOW2 format +such as for example +.BR qemu-img . +.PP +You can convert a .qcow2 image into a raw image with: +.PP +.br +\ \fBe2image \-r hda1.qcow2 hda1.raw\fR +.br +.PP +This can be useful to write a QCOW2 image containing all data to a +sparse image file where it can be loop mounted, or to a disk partition. +Note that this may not work with QCOW2 images not generated by e2image. + +.SH OFFSETS +Normally a file system starts at the beginning of a partition, and +.B e2image +is run on the partition. When working with image files, you don't +have the option of using the partition device, so you can specify +the offset where the file system starts directly with the +.B \-o +option. Similarly the +.B \-O +option specifies the offset that should be seeked to in the destination +before writing the file system. +.PP +For example, if you have a +.B dd +image of a whole hard drive that contains an ext2 fs in a partition +starting at 1 MiB, you can clone that image to a block device with: +.PP +.br +\ \fBe2image \-aro 1048576 img /dev/sda1\fR +.br +.PP +Or you can clone a file system from a block device into an image file, +leaving room in the first MiB for a partition table with: +.PP +.br +\ \fBe2image -arO 1048576 /dev/sda1 img\fR +.br +.PP +If you specify at least one offset, and only one file, an in-place +move will be performed, allowing you to safely move the file system +from one offset to another. + +.SH AUTHOR +.B e2image +was written by Theodore Ts'o (tytso@mit.edu). + +.SH AVAILABILITY +.B e2image +is part of the e2fsprogs package and is available from +http://e2fsprogs.sourceforge.net. + +.SH SEE ALSO +.BR dumpe2fs (8), +.BR debugfs (8) +.BR e2fsck (8) diff --git a/upstream/opensuse-leap-15-6/man8/e2label.8 b/upstream/opensuse-leap-15-6/man8/e2label.8 new file mode 100644 index 00000000..29adae7e --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/e2label.8 @@ -0,0 +1,58 @@ +.\" -*- 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 E2LABEL 8 "February 2023" "E2fsprogs version 1.47.0" +.SH NAME +e2label \- Change the label on an ext2/ext3/ext4 file system +.SH SYNOPSIS +.B e2label +.I device +[ +.I volume-label +] +.SH DESCRIPTION +.B e2label +will display or change the volume label on the ext2, ext3, or ext4 +file system located on +.I device. +.PP +If the optional argument +.I volume-label +is not present, +.B e2label +will simply display the current volume label. +.PP +If the optional argument +.I volume-label +is present, then +.B e2label +will set the volume label to be +.IR volume-label . +Ext2 volume labels can be at most 16 characters long; if +.I volume-label +is longer than 16 characters, +.B e2label +will truncate it and print a warning message. For other file systems that +support online label manipulation and are mounted +.B e2label +will work as well, but it will not attempt to truncate the +.I volume-label +at all. +.PP +It is also possible to set the volume label using the +.B \-L +option of +.BR tune2fs (8). +.PP +.SH AUTHOR +.B e2label +was written by Theodore Ts'o (tytso@mit.edu). +.SH AVAILABILITY +.B e2label +is part of the e2fsprogs package and is available from +http://e2fsprogs.sourceforge.net. +.SH SEE ALSO +.BR mke2fs (8), +.BR tune2fs (8) + diff --git a/upstream/opensuse-leap-15-6/man8/e2mmpstatus.8 b/upstream/opensuse-leap-15-6/man8/e2mmpstatus.8 new file mode 100644 index 00000000..47a4624e --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/e2mmpstatus.8 @@ -0,0 +1,59 @@ +.\" -*- nroff -*- +.\" This file may be copied under the terms of the GNU Public License. +.\" +.TH E2MMPSTATUS 8 "February 2023" "E2fsprogs version 1.47.0" +.SH NAME +e2mmpstatus \- Check MMP status of an ext4 file system +.SH SYNOPSIS +.BR e2mmpstatus " [" \-i ] +.RI < file system > +.SH OPTIONS +.TP +.B \-i +prints out the MMP information rather than check it. +.SH DESCRIPTION +.B e2mmpstatus +is used to check Multiple-Mount Protection (MMP) status of an ext4 +file system with the +.B mmp +feature enabled. The specified +.I file system +can be a device name (e.g. +.IR /dev/hdc1 ", " /dev/sdb2 ), +or an ext4 file system label or UUID, for example +.B UUID=8868abf6-88c5-4a83-98b8-bfc24057f7bd +or +.BR LABEL=root . +By default, the +.B e2mmpstatus +program checks whether it is safe to mount the file system without taking +the risk of mounting it more than once. +.PP +MMP (multiple-mount protection) is a feature that adds protection against +the file system being modified simultaneously by more than one node. +It is NOT safe to mount a file system when one of the following conditions +is true: +.br + 1. e2fsck is running on the file system. +.br + 2. the file system is in use by another node. +.br + 3. The MMP block is corrupted or cannot be read for some reason. +.br +The +.B e2mmpstatus +program might wait for some time to see whether the MMP block is being +updated by any node during this period. The time taken depends on how +frequently the MMP block is being written by the other node. +.SH EXIT CODE +The exit code returned by +.B e2mmpstatus +is 0 when it is safe to mount the file system, 1 when the MMP block shows +the file system is in use on another node and it is NOT safe to mount +the file system, and 2 if some other failure occurred that prevents the +check from properly detecting the current MMP status. +.SH SEE ALSO +.BR dumpe2fs (8), +.BR e2fsck (8), +.BR fstab (5), +.BR fsck (8), diff --git a/upstream/opensuse-leap-15-6/man8/e2scrub.8 b/upstream/opensuse-leap-15-6/man8/e2scrub.8 new file mode 100644 index 00000000..6923c679 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/e2scrub.8 @@ -0,0 +1,69 @@ +.TH E2SCRUB 8 "February 2023" "E2fsprogs version 1.47.0" +.SH NAME +e2scrub - check the contents of a mounted ext[234] file system +.SH SYNOPSIS +.B +e2scrub [OPTION] MOUNTPOINT | DEVICE +.SH DESCRIPTION +.B e2scrub +attempts to check (but not repair) all metadata in a mounted ext[234] +file system if the file system resides on an LVM logical volume. +The block device of the LVM logical volume can also be passed in. + +This program snapshots the volume and runs a file system check on the snapshot +to look for corruption errors. +The LVM volume group must have at least 256MiB of unallocated space to +dedicate to the snapshot or the logical volume will be skipped. +The snapshot will be named +.IR lvname ".e2scrub" +and +.B udev +will not create symbolic links to it under +.IR /dev/disk . +Every attempt will be made to remove the snapshots prior to running +.BR e2scrub , +but in a dire situation it may be necessary to remove the snapshot manually. + +If no errors are found, +.B fstrim +can be called on the file system if it is mounted. +If errors are found, the file system will be marked as having errors. +The file system should be taken offline and +.B e2fsck +run as soon as possible, because +.B e2scrub +does not fix corruptions. +If the file system is not repaired, +.B e2fsck +will be run before the next mount. +.SH OPTIONS +.TP +\fB-n\fR +Print what commands +.B e2scrub +would execute to check the file system. (Note: the commands will not +actually be executed; however, since +.B e2scrub +needs to run some commands to query the system to determine what +commands would be executed, it still needs to be run as root.) +.TP +\fB-r\fR +Remove the e2scrub snapshot and exit without checking anything. +.TP +\fB-t\fR +Run +.B +fstrim(1) +on the mounted file system if no errors are found. +.TP +\fB-V\fR +Print version information and exit. +.SH EXIT CODE +The exit codes are the same as in +.BR e2fsck (8) +.SH SEE ALSO +.BR e2fsck (8) +.SH AUTHOR +Darrick J. Wong <darrick.wong@oracle.com> +.SH COPYRIGHT +Copyright \[co]2018 Oracle. License is GPLv2+. <http://www.gnu.org/licenses/gpl-2.0.html> diff --git a/upstream/opensuse-leap-15-6/man8/e2scrub_all.8 b/upstream/opensuse-leap-15-6/man8/e2scrub_all.8 new file mode 100644 index 00000000..a2b962d9 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/e2scrub_all.8 @@ -0,0 +1,47 @@ +.TH E2SCRUB 8 "February 2023" "E2fsprogs version 1.47.0" +.SH NAME +e2scrub_all - check all mounted ext[234] file systems for errors. +.SH SYNOPSIS +.B +e2scrub_all [OPTION] +.SH DESCRIPTION +Searches the system for all LVM logical volumes containing an ext2, ext3, or +ext4 file system, and checks them for problems. +The checking is performed by invoking the +.B e2scrub +tool, which will look for corruptions. +Corrupt file systems will be tagged as having errors so that fsck will be +invoked before the next mount. +If no errors are encountered, +.B fstrim +will be called on the file system if it is mounted. +See the +.B e2scrub +manual page for more information about how the checking is performed. +.SH OPTIONS +.TP +\fB-n\fR +Print what commands +.B e2scrub_all +would execute to initiate the e2scrub operations. +(Note: these commands will not actually be executed; however, since +.B e2scrub_all +needs to run some additional, privileged commands to query the +system to determine which +.B e2scrub +commands would be executed, it still needs to be run as root.) +.TP +\fB-r\fR +Remove e2scrub snapshots but do not check anything. +.TP +\fB-A\fR +Scrub all ext[234] file systems even if they are not mounted. +.TP +\fB-V\fR +Print version information and exit. +.SH SEE ALSO +.BR e2scrub "(8)" +.SH AUTHOR +Darrick J. Wong <darrick.wong@oracle.com> +.SH COPYRIGHT +Copyright \[co]2018 Oracle. License is GPLv2+. <http://www.gnu.org/licenses/gpl-2.0.html> diff --git a/upstream/opensuse-leap-15-6/man8/e2undo.8 b/upstream/opensuse-leap-15-6/man8/e2undo.8 new file mode 100644 index 00000000..8b90f7aa --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/e2undo.8 @@ -0,0 +1,84 @@ +.\" -*- nroff -*- +.\" Copyright 2008 by Theodore Ts'o. All Rights Reserved. +.\" This file may be copied under the terms of the GNU Public License. +.\" +.TH E2UNDO 8 "February 2023" "E2fsprogs version 1.47.0" +.SH NAME +e2undo \- Replay an undo log for an ext2/ext3/ext4 file system +.SH SYNOPSIS +.B e2undo +[ +.B \-f +] +[ +.B \-h +] +[ +.B \-n +] +[ +.B \-o +.I offset +] +[ +.B \-v +] +[ +.B \-z +.I undo_file +] +.I undo_log device +.SH DESCRIPTION +.B e2undo +will replay the undo log +.I undo_log +for an ext2/ext3/ext4 file system found on +.IR device . +This can be +used to undo a failed operation by an e2fsprogs program. +.SH OPTIONS +.TP +.B \-f +Normally, +.B e2undo +will check the file system superblock to make sure the undo log matches +with the file system on the device. If they do not match, +.B e2undo +will refuse to apply the undo log as a safety mechanism. The +.B \-f +option disables this safety mechanism. +.TP +.B \-h +Display a usage message. +.TP +.B \-n +Dry-run; do not actually write blocks back to the file system. +.TP +.BI \-o " offset" +Specify the file system's +.I offset +(in bytes) from the beginning of the device or file. +.TP +.B \-v +Report which block we're currently replaying. +.TP +.BI \-z " undo_file" +Before overwriting a file system block, write the old contents of the block to +an undo file. This undo file can be used with e2undo(8) to restore the old +contents of the file system should something go wrong. If the empty string is +passed as the undo_file argument, the undo file will be written to a file named +e2undo-\fIdevice\fR.e2undo in the directory specified via the +\fIE2FSPROGS_UNDO_DIR\fR environment variable. + +WARNING: The undo file cannot be used to recover from a power or system crash. +.SH AUTHOR +.B e2undo +was written by Aneesh Kumar K.V. (aneesh.kumar@linux.vnet.ibm.com) +.SH AVAILABILITY +.B e2undo +is part of the e2fsprogs package and is available from +http://e2fsprogs.sourceforge.net. +.SH SEE ALSO +.BR mke2fs (8), +.BR tune2fs (8) + diff --git a/upstream/opensuse-leap-15-6/man8/e4crypt.8 b/upstream/opensuse-leap-15-6/man8/e4crypt.8 new file mode 100644 index 00000000..579397f2 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/e4crypt.8 @@ -0,0 +1,74 @@ +.TH E4CRYPT 8 "February 2023" "E2fsprogs version 1.47.0" +.SH NAME +e4crypt \- ext4 file system encryption utility +.SH SYNOPSIS +.B e4crypt add_key -S \fR[\fB -k \fIkeyring\fR ] [\fB-v\fR] [\fB-q\fR] \fR[\fB -p \fIpad\fR ] [ \fIpath\fR ... ] +.br +.B e4crypt new_session +.br +.B e4crypt get_policy \fIpath\fR ... +.br +.B e4crypt set_policy \fR[\fB -p \fIpad\fR ] \fIpolicy path\fR ... +.SH DESCRIPTION +.B e4crypt +performs encryption management for ext4 file systems. +.SH COMMANDS +.TP +.B e4crypt add_key \fR[\fB-vq\fR] [\fB-S\fI salt\fR ] [\fB-k \fIkeyring\fR ] [\fB -p \fIpad\fR ] [ \fIpath\fR ... ] +Prompts the user for a passphrase and inserts it into the specified +keyring. If no keyring is specified, e4crypt will use the session +keyring if it exists or the user session keyring if it does not. +.IP +The +.I salt +argument is interpreted in a number of different ways, depending on how +its prefix value. If the first two characters are "s:", then the rest +of the argument will be used as an text string and used as the salt +value. If the first two characters are "0x", then the rest of the +argument will be parsed as a hex string as used as the salt. If the +first characters are "f:" then the rest of the argument will be +interpreted as a filename from which the salt value will be read. If +the string begins with a '/' character, it will similarly be treated as +filename. Finally, if the +.I salt +argument can be parsed as a valid UUID, then the UUID value will be used +as a salt value. +.IP +The +.I keyring +argument specifies the keyring to which the key should be added. +.IP +The +.I pad +value specifies the number of bytes of padding will be added to +directory names for obfuscation purposes. Valid +.I pad +values are 4, 8, 16, and 32. +.IP +If one or more directory paths are specified, e4crypt will try to +set the policy of those directories to use the key just added by the +.B add_key +command. If a salt was explicitly specified, then it will be used +to derive the encryption key of those directories. Otherwise a +directory-specific default salt will be used. +.TP +.B e4crypt get_policy \fIpath\fR ... +Print the policy for the directories specified on the command line. +.TP +.B e4crypt new_session +Give the invoking process (typically a shell) a new session keyring, +discarding its old session keyring. +.TP +.B e4crypt set_policy \fR[\fB -p \fIpad\fR ] \fIpolicy path\fR ... +Sets the policy for the directories specified on the command line. +All directories must be empty to set the policy; if the directory +already has a policy established, e4crypt will validate that the +policy matches what was specified. A policy is an encryption key +identifier consisting of 16 hexadecimal characters. +.SH AUTHOR +Written by Michael Halcrow <mhalcrow@google.com>, Ildar Muslukhov +<muslukhovi@gmail.com>, and Theodore Ts'o <tytso@mit.edu> +.SH SEE ALSO +.BR keyctl (1), +.BR mke2fs (8), +.BR mount (8). diff --git a/upstream/opensuse-leap-15-6/man8/e4defrag.8 b/upstream/opensuse-leap-15-6/man8/e4defrag.8 new file mode 100644 index 00000000..53d7f17d --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/e4defrag.8 @@ -0,0 +1,90 @@ +.TH E4DEFRAG 8 "May 2009" "e4defrag version 2.0" +.SH NAME +e4defrag \- online defragmenter for ext4 file system +.SH SYNOPSIS +.B e4defrag +[ +.B \-c +] +[ +.B \-v +] +.I target +\&... +.SH DESCRIPTION +.B e4defrag +reduces fragmentation of extent based file. The file targeted by +.B e4defrag +is created on ext4 file system made with "-O extent" option (see +.BR mke2fs (8)). +The targeted file gets more contiguous blocks and improves the file access +speed. +.PP +.I target +is a regular file, a directory, or a device that is mounted as ext4 file system. +If +.I target +is a directory, +.B e4defrag +reduces fragmentation of all files in it. If +.I target +is a device, +.B e4defrag +gets the mount point of it and reduces fragmentation of all files in this mount +point. +.SH OPTIONS +.TP +.B \-c +Get a current fragmentation count and an ideal fragmentation count, and +calculate fragmentation score based on them. By seeing this score, we can +determine whether we should execute +.B e4defrag +to +.IR target . +When used with +.B \-v +option, the current fragmentation count and the ideal fragmentation count are +printed for each file. +.IP +Also this option outputs the average data size in one extent. If you see it, +you'll find the file has ideal extents or not. Note that the maximum extent +size is 131072KB in ext4 file system (if block size is 4KB). +.IP +If this option is specified, +.I target +is never defragmented. +.TP +.B \-v +Print error messages and the fragmentation count before and after defrag for +each file. +.SH NOTES +.B e4defrag +does not support swap file, files in lost+found directory, and files allocated +in indirect blocks. When +.I target +is a device or a mount point, +.B e4defrag +doesn't defragment files in mount point of other device. +.PP +It is safe to run e4defrag on a file while it is actively in use by another +application. Since the contents of file blocks are copied using the +page cache, this can result in a performance slowdown to both e4defrag +and the application due to contention over the system's memory and disk +bandwidth. +.PP +If the file system's free space is fragmented, or if there is +insufficient free space available, e4defrag may not be able +to improve the file's fragmentation. +.PP +Non-privileged users can execute +.B e4defrag +to their own file, but the score is not printed if +.B \-c +option is specified. Therefore, it is desirable to be executed by root user. +.SH AUTHOR +Written by Akira Fujita <a-fujita@rs.jp.nec.com> and Takashi Sato +<t-sato@yk.jp.nec.com>. +.SH SEE ALSO +.BR mke2fs (8), +.BR mount (8). + diff --git a/upstream/opensuse-leap-15-6/man8/ebtables-nft.8 b/upstream/opensuse-leap-15-6/man8/ebtables-nft.8 new file mode 100644 index 00000000..1fa5ad93 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/ebtables-nft.8 @@ -0,0 +1,1116 @@ +.TH EBTABLES 8 "December 2011" +.\" +.\" Man page written by Bart De Schuymer <bdschuym@pandora.be> +.\" It is based on the iptables man page. +.\" +.\" The man page was edited, February 25th 2003, by +.\" Greg Morgan <" dr_kludge_at_users_sourceforge_net > +.\" +.\" Iptables page by Herve Eychenne March 2000. +.\" +.\" This program is free software; you can redistribute it and/or modify +.\" it under the terms of the GNU General Public License as published by +.\" the Free Software Foundation; either version 2 of the License, or +.\" (at your option) any later version. +.\" +.\" This program is distributed in the hope that it will be useful, +.\" but WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.\" GNU General Public License for more details. +.\" +.\" You should have received a copy of the GNU General Public License +.\" along with this program; if not, write to the Free Software +.\" Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. +.\" +.\" +.SH NAME +ebtables \- Ethernet bridge frame table administration (nft-based) +.SH SYNOPSIS +.BR "ebtables " [ -t " table ] " - [ ACDI "] chain rule specification [match extensions] [watcher extensions] target" +.br +.BR "ebtables " [ -t " table ] " -P " chain " ACCEPT " | " DROP " | " RETURN +.br +.BR "ebtables " [ -t " table ] " -F " [chain]" +.br +.BR "ebtables " [ -t " table ] " -Z " [chain]" +.br +.BR "ebtables " [ -t " table ] " -L " [" -Z "] [chain] [ [" --Ln "] | [" --Lx "] ] [" --Lc "] [" --Lmac2 ] +.br +.BR "ebtables " [ -t " table ] " -N " chain [" "-P ACCEPT " | " DROP " | " RETURN" ] +.br +.BR "ebtables " [ -t " table ] " -X " [chain]" +.br +.BR "ebtables " [ -t " table ] " -E " old-chain-name new-chain-name" +.br +.BR "ebtables " [ -t " table ] " --init-table +.br +.BR "ebtables " [ -t " table ] [" --atomic-file " file] " --atomic-commit +.br +.BR "ebtables " [ -t " table ] [" --atomic-file " file] " --atomic-init +.br +.BR "ebtables " [ -t " table ] [" --atomic-file " file] " --atomic-save +.br + +.SH DESCRIPTION +.B ebtables +is an application program used to set up and maintain the +tables of rules (inside the Linux kernel) that inspect +Ethernet frames. +It is analogous to the +.B iptables +application, but less complicated, due to the fact that the Ethernet protocol +is much simpler than the IP protocol. +.SS CHAINS +There are two ebtables tables with built-in chains in the +Linux kernel. These tables are used to divide functionality into +different sets of rules. Each set of rules is called a chain. +Each chain is an ordered list of rules that can match Ethernet frames. If a +rule matches an Ethernet frame, then a processing specification tells +what to do with that matching frame. The processing specification is +called a 'target'. However, if the frame does not match the current +rule in the chain, then the next rule in the chain is examined and so forth. +The user can create new (user-defined) chains that can be used as the 'target' +of a rule. User-defined chains are very useful to get better performance +over the linear traversal of the rules and are also essential for structuring +the filtering rules into well-organized and maintainable sets of rules. +.SS TARGETS +A firewall rule specifies criteria for an Ethernet frame and a frame +processing specification called a target. When a frame matches a rule, +then the next action performed by the kernel is specified by the target. +The target can be one of these values: +.BR ACCEPT , +.BR DROP , +.BR CONTINUE , +.BR RETURN , +an 'extension' (see below) or a jump to a user-defined chain. +.PP +.B ACCEPT +means to let the frame through. +.B DROP +means the frame has to be dropped. +.B CONTINUE +means the next rule has to be checked. This can be handy, f.e., to know how many +frames pass a certain point in the chain, to log those frames or to apply multiple +targets on a frame. +.B RETURN +means stop traversing this chain and resume at the next rule in the +previous (calling) chain. +For the extension targets please refer to the +.B "TARGET EXTENSIONS" +section of this man page. +.SS TABLES +As stated earlier, there are two ebtables tables in the Linux +kernel. The table names are +.BR filter " and " nat . +Of these two tables, +the filter table is the default table that the command operates on. +If you are working with the filter table, then you can drop the '-t filter' +argument to the ebtables command. However, you will need to provide +the -t argument for +.B nat +table. Moreover, the -t argument must be the +first argument on the ebtables command line, if used. +.TP +.B "-t, --table" +.br +.B filter +is the default table and contains three built-in chains: +.B INPUT +(for frames destined for the bridge itself, on the level of the MAC destination address), +.B OUTPUT +(for locally-generated or (b)routed frames) and +.B FORWARD +(for frames being forwarded by the bridge). +.br +.br +.B nat +is mostly used to change the mac addresses and contains three built-in chains: +.B PREROUTING +(for altering frames as soon as they come in), +.B OUTPUT +(for altering locally generated or (b)routed frames before they are bridged) and +.B POSTROUTING +(for altering frames as they are about to go out). A small note on the naming +of chains PREROUTING and POSTROUTING: it would be more accurate to call them +PREFORWARDING and POSTFORWARDING, but for all those who come from the +iptables world to ebtables it is easier to have the same names. Note that you +can change the name +.BR "" ( -E ) +if you don't like the default. +.SH EBTABLES COMMAND LINE ARGUMENTS +After the initial ebtables '-t table' command line argument, the remaining +arguments can be divided into several groups. These groups +are commands, miscellaneous commands, rule specifications, match extensions, +watcher extensions and target extensions. +.SS COMMANDS +The ebtables command arguments specify the actions to perform on the table +defined with the -t argument. If you do not use the -t argument to name +a table, the commands apply to the default filter table. +Only one command may be used on the command line at a time, except when +the commands +.BR -L " and " -Z +are combined, the commands +.BR -N " and " -P +are combined, or when +.B --atomic-file +is used. +.TP +.B "-A, --append" +Append a rule to the end of the selected chain. +.TP +.B "-D, --delete" +Delete the specified rule or rules from the selected chain. There are two ways to +use this command. The first is by specifying an interval of rule numbers +to delete (directly after +.BR -D ). +Syntax: \fIstart_nr\fP[\fI:end_nr\fP] (use +.B -L --Ln +to list the rules with their rule number). When \fIend_nr\fP is omitted, all rules starting +from \fIstart_nr\fP are deleted. Using negative numbers is allowed, for more +details about using negative numbers, see the +.B -I +command. The second usage is by +specifying the complete rule as it would have been specified when it was added. Only +the first encountered rule that is the same as this specified rule, in other +words the matching rule with the lowest (positive) rule number, is deleted. +.TP +.B "-C, --change-counters" +Change the counters of the specified rule or rules from the selected chain. There are two ways to +use this command. The first is by specifying an interval of rule numbers +to do the changes on (directly after +.BR -C ). +Syntax: \fIstart_nr\fP[\fI:end_nr\fP] (use +.B -L --Ln +to list the rules with their rule number). The details are the same as for the +.BR -D " command. The second usage is by" +specifying the complete rule as it would have been specified when it was added. Only +the counters of the first encountered rule that is the same as this specified rule, in other +words the matching rule with the lowest (positive) rule number, are changed. +In the first usage, the counters are specified directly after the interval specification, +in the second usage directly after +.BR -C . +First the packet counter is specified, then the byte counter. If the specified counters start +with a '+', the counter values are added to the respective current counter values. +If the specified counters start with a '-', the counter values are decreased from the respective +current counter values. No bounds checking is done. If the counters don't start with '+' or '-', +the current counters are changed to the specified counters. +.TP +.B "-I, --insert" +Insert the specified rule into the selected chain at the specified rule number. If the +rule number is not specified, the rule is added at the head of the chain. +If the current number of rules equals +.IR N , +then the specified number can be +between +.IR -N " and " N+1 . +For a positive number +.IR i , +it holds that +.IR i " and " i-N-1 +specify the same place in the chain where the rule should be inserted. The rule number +0 specifies the place past the last rule in the chain and using this number is therefore +equivalent to using the +.BR -A " command." +Rule numbers structly smaller than 0 can be useful when more than one rule needs to be inserted +in a chain. +.TP +.B "-P, --policy" +Set the policy for the chain to the given target. The policy can be +.BR ACCEPT ", " DROP " or " RETURN . +.TP +.B "-F, --flush" +Flush the selected chain. If no chain is selected, then every chain will be +flushed. Flushing a chain does not change the policy of the +chain, however. +.TP +.B "-Z, --zero" +Set the counters of the selected chain to zero. If no chain is selected, all the counters +are set to zero. The +.B "-Z" +command can be used in conjunction with the +.B "-L" +command. +When both the +.B "-Z" +and +.B "-L" +commands are used together in this way, the rule counters are printed on the screen +before they are set to zero. +.TP +.B "-L, --list" +List all rules in the selected chain. If no chain is selected, all chains +are listed. +.br +The following options change the output of the +.B "-L" +command. +.br +.B "--Ln" +.br +Places the rule number in front of every rule. This option is incompatible with the +.BR --Lx " option." +.br +.B "--Lc" +.br +Shows the counters at the end of each rule displayed by the +.B "-L" +command. Both a frame counter (pcnt) and a byte counter (bcnt) are displayed. +The frame counter shows how many frames have matched the specific rule, the byte +counter shows the sum of the frame sizes of these matching frames. Using this option +.BR "" "in combination with the " --Lx " option causes the counters to be written out" +.BR "" "in the '" -c " <pcnt> <bcnt>' option format." +.br +.B "--Lx" +.br +Changes the output so that it produces a set of ebtables commands that construct +the contents of the chain, when specified. +If no chain is specified, ebtables commands to construct the contents of the +table are given, including commands for creating the user-defined chains (if any). +You can use this set of commands in an ebtables boot or reload +script. For example the output could be used at system startup. +The +.B "--Lx" +option is incompatible with the +.B "--Ln" +listing option. Using the +.BR --Lx " option together with the " --Lc " option will cause the counters to be written out" +.BR "" "in the '" -c " <pcnt> <bcnt>' option format." +.br +.B "--Lmac2" +.br +Shows all MAC addresses with the same length, adding leading zeroes +if necessary. The default representation omits leading zeroes in the addresses. +.TP +.B "-N, --new-chain" +Create a new user-defined chain with the given name. The number of +user-defined chains is limited only by the number of possible chain names. +A user-defined chain name has a maximum +length of 31 characters. The standard policy of the user-defined chain is +ACCEPT. The policy of the new chain can be initialized to a different standard +target by using the +.B -P +command together with the +.B -N +command. In this case, the chain name does not have to be specified for the +.B -P +command. +.TP +.B "-X, --delete-chain" +Delete the specified user-defined chain. There must be no remaining references (jumps) +to the specified chain, otherwise ebtables will refuse to delete it. If no chain is +specified, all user-defined chains that aren't referenced will be removed. +.TP +.B "-E, --rename-chain" +Rename the specified chain to a new name. Besides renaming a user-defined +chain, you can rename a standard chain to a name that suits your +taste. For example, if you like PREFORWARDING more than PREROUTING, +then you can use the -E command to rename the PREROUTING chain. If you do +rename one of the standard ebtables chain names, please be sure to mention +this fact should you post a question on the ebtables mailing lists. +It would be wise to use the standard name in your post. Renaming a standard +ebtables chain in this fashion has no effect on the structure or functioning +of the ebtables kernel table. +.TP +.B "--init-table" +Replace the current table data by the initial table data. +.TP +.B "--atomic-init" +Copy the kernel's initial data of the table to the specified +file. This can be used as the first action, after which rules are added +to the file. The file can be specified using the +.B --atomic-file +command or through the +.IR EBTABLES_ATOMIC_FILE " environment variable." +.TP +.B "--atomic-save" +Copy the kernel's current data of the table to the specified +file. This can be used as the first action, after which rules are added +to the file. The file can be specified using the +.B --atomic-file +command or through the +.IR EBTABLES_ATOMIC_FILE " environment variable." +.TP +.B "--atomic-commit" +Replace the kernel table data with the data contained in the specified +file. This is a useful command that allows you to load all your rules of a +certain table into the kernel at once, saving the kernel a lot of precious +time and allowing atomic updates of the tables. The file which contains +the table data is constructed by using either the +.B "--atomic-init" +or the +.B "--atomic-save" +command to generate a starting file. After that, using the +.B "--atomic-file" +command when constructing rules or setting the +.IR EBTABLES_ATOMIC_FILE " environment variable" +allows you to extend the file and build the complete table before +committing it to the kernel. This command can be very useful in boot scripts +to populate the ebtables tables in a fast way. +.SS MISCELLANOUS COMMANDS +.TP +.B "-V, --version" +Show the version of the ebtables userspace program. +.TP +.BR "-h, --help " "[\fIlist of module names\fP]" +Give a brief description of the command syntax. Here you can also specify +names of extensions and ebtables will try to write help about those +extensions. E.g. +.IR "ebtables -h snat log ip arp" . +Specify +.I list_extensions +to list all extensions supported by the userspace +utility. +.TP +.BR "-j, --jump " "\fItarget\fP" +The target of the rule. This is one of the following values: +.BR ACCEPT , +.BR DROP , +.BR CONTINUE , +.BR RETURN , +a target extension (see +.BR "TARGET EXTENSIONS" ")" +or a user-defined chain name. +.TP +.B --atomic-file "\fIfile\fP" +Let the command operate on the specified +.IR file . +The data of the table to +operate on will be extracted from the file and the result of the operation +will be saved back into the file. If specified, this option should come +before the command specification. An alternative that should be preferred, +is setting the +.IR EBTABLES_ATOMIC_FILE " environment variable." +.TP +.B -M, --modprobe "\fIprogram\fP" +When talking to the kernel, use this +.I program +to try to automatically load missing kernel modules. +.TP +.B --concurrent +Use a file lock to support concurrent scripts updating the ebtables kernel tables. + +.SS +RULE SPECIFICATIONS +The following command line arguments make up a rule specification (as used +in the add and delete commands). A "!" option before the specification +inverts the test for that specification. Apart from these standard rule +specifications there are some other command line arguments of interest. +See both the +.BR "MATCH EXTENSIONS" +and the +.BR "WATCHER EXTENSIONS" +below. +.TP +.BR "-p, --protocol " "[!] \fIprotocol\fP" +The protocol that was responsible for creating the frame. This can be a +hexadecimal number, above +.IR 0x0600 , +a name (e.g. +.I ARP +) or +.BR LENGTH . +The protocol field of the Ethernet frame can be used to denote the +length of the header (802.2/802.3 networks). When the value of that field is +below or equals +.IR 0x0600 , +the value equals the size of the header and shouldn't be used as a +protocol number. Instead, all frames where the protocol field is used as +the length field are assumed to be of the same 'protocol'. The protocol +name used in ebtables for these frames is +.BR LENGTH . +.br +The file +.B /etc/ethertypes +can be used to show readable +characters instead of hexadecimal numbers for the protocols. For example, +.I 0x0800 +will be represented by +.IR IPV4 . +The use of this file is not case sensitive. +See that file for more information. The flag +.B --proto +is an alias for this option. +.TP +.BR "-i, --in-interface " "[!] \fIname\fP" +The interface (bridge port) via which a frame is received (this option is useful in the +.BR INPUT , +.BR FORWARD , +.BR PREROUTING " and " BROUTING +chains). If the interface name ends with '+', then +any interface name that begins with this name (disregarding '+') will match. +The flag +.B --in-if +is an alias for this option. +.TP +.BR "--logical-in " "[!] \fIname\fP" +The (logical) bridge interface via which a frame is received (this option is useful in the +.BR INPUT , +.BR FORWARD , +.BR PREROUTING " and " BROUTING +chains). +If the interface name ends with '+', then +any interface name that begins with this name (disregarding '+') will match. +.TP +.BR "-o, --out-interface " "[!] \fIname\fP" +The interface (bridge port) via which a frame is going to be sent (this option is useful in the +.BR OUTPUT , +.B FORWARD +and +.B POSTROUTING +chains). If the interface name ends with '+', then +any interface name that begins with this name (disregarding '+') will match. +The flag +.B --out-if +is an alias for this option. +.TP +.BR "--logical-out " "[!] \fIname\fP" +The (logical) bridge interface via which a frame is going to be sent (this option +is useful in the +.BR OUTPUT , +.B FORWARD +and +.B POSTROUTING +chains). +If the interface name ends with '+', then +any interface name that begins with this name (disregarding '+') will match. +.TP +.BR "-s, --source " "[!] \fIaddress\fP[/\fImask\fP]" +The source MAC address. Both mask and address are written as 6 hexadecimal +numbers separated by colons. Alternatively one can specify Unicast, +Multicast, Broadcast or BGA (Bridge Group Address): +.br +.IR "Unicast" "=00:00:00:00:00:00/01:00:00:00:00:00," +.IR "Multicast" "=01:00:00:00:00:00/01:00:00:00:00:00," +.IR "Broadcast" "=ff:ff:ff:ff:ff:ff/ff:ff:ff:ff:ff:ff or" +.IR "BGA" "=01:80:c2:00:00:00/ff:ff:ff:ff:ff:ff." +Note that a broadcast +address will also match the multicast specification. The flag +.B --src +is an alias for this option. +.TP +.BR "-d, --destination " "[!] \fIaddress\fP[/\fImask\fP]" +The destination MAC address. See +.B -s +(above) for more details on MAC addresses. The flag +.B --dst +is an alias for this option. +.TP +.BR "-c, --set-counter " "\fIpcnt bcnt\fP" +If used with +.BR -A " or " -I ", then the packet and byte counters of the new rule will be set to +.IR pcnt ", resp. " bcnt ". +If used with the +.BR -C " or " -D " commands, only rules with a packet and byte count equal to" +.IR pcnt ", resp. " bcnt " will match." + +.SS MATCH EXTENSIONS +Ebtables extensions are dynamically loaded into the userspace tool, +there is therefore no need to explicitly load them with a +-m option like is done in iptables. +These extensions deal with functionality supported by kernel modules supplemental to +the core ebtables code. +.SS 802_3 +Specify 802.3 DSAP/SSAP fields or SNAP type. The protocol must be specified as +.IR "LENGTH " "(see the option " " -p " above). +.TP +.BR "--802_3-sap " "[!] \fIsap\fP" +DSAP and SSAP are two one byte 802.3 fields. The bytes are always +equal, so only one byte (hexadecimal) is needed as an argument. +.TP +.BR "--802_3-type " "[!] \fItype\fP" +If the 802.3 DSAP and SSAP values are 0xaa then the SNAP type field must +be consulted to determine the payload protocol. This is a two byte +(hexadecimal) argument. Only 802.3 frames with DSAP/SSAP 0xaa are +checked for type. +.SS among +Match a MAC address or MAC/IP address pair versus a list of MAC addresses +and MAC/IP address pairs. +A list entry has the following format: +.IR xx:xx:xx:xx:xx:xx[=ip.ip.ip.ip][,] ". Multiple" +list entries are separated by a comma, specifying an IP address corresponding to +the MAC address is optional. Multiple MAC/IP address pairs with the same MAC address +but different IP address (and vice versa) can be specified. If the MAC address doesn't +match any entry from the list, the frame doesn't match the rule (unless "!" was used). +.TP +.BR "--among-dst " "[!] \fIlist\fP" +Compare the MAC destination to the given list. If the Ethernet frame has type +.IR IPv4 " or " ARP , +then comparison with MAC/IP destination address pairs from the +list is possible. +.TP +.BR "--among-src " "[!] \fIlist\fP" +Compare the MAC source to the given list. If the Ethernet frame has type +.IR IPv4 " or " ARP , +then comparison with MAC/IP source address pairs from the list +is possible. +.TP +.BR "--among-dst-file " "[!] \fIfile\fP" +Same as +.BR --among-dst " but the list is read in from the specified file." +.TP +.BR "--among-src-file " "[!] \fIfile\fP" +Same as +.BR --among-src " but the list is read in from the specified file." +.SS arp +Specify (R)ARP fields. The protocol must be specified as +.IR ARP " or " RARP . +.TP +.BR "--arp-opcode " "[!] \fIopcode\fP" +The (R)ARP opcode (decimal or a string, for more details see +.BR "ebtables -h arp" ). +.TP +.BR "--arp-htype " "[!] \fIhardware type\fP" +The hardware type, this can be a decimal or the string +.I Ethernet +(which sets +.I type +to 1). Most (R)ARP packets have Eternet as hardware type. +.TP +.BR "--arp-ptype " "[!] \fIprotocol type\fP" +The protocol type for which the (r)arp is used (hexadecimal or the string +.IR IPv4 , +denoting 0x0800). +Most (R)ARP packets have protocol type IPv4. +.TP +.BR "--arp-ip-src " "[!] \fIaddress\fP[/\fImask\fP]" +The (R)ARP IP source address specification. +.TP +.BR "--arp-ip-dst " "[!] \fIaddress\fP[/\fImask\fP]" +The (R)ARP IP destination address specification. +.TP +.BR "--arp-mac-src " "[!] \fIaddress\fP[/\fImask\fP]" +The (R)ARP MAC source address specification. +.TP +.BR "--arp-mac-dst " "[!] \fIaddress\fP[/\fImask\fP]" +The (R)ARP MAC destination address specification. +.TP +.BR "" "[!]" " --arp-gratuitous" +Checks for ARP gratuitous packets: checks equality of IPv4 source +address and IPv4 destination address inside the ARP header. +.SS ip +Specify IPv4 fields. The protocol must be specified as +.IR IPv4 . +.TP +.BR "--ip-source " "[!] \fIaddress\fP[/\fImask\fP]" +The source IP address. +The flag +.B --ip-src +is an alias for this option. +.TP +.BR "--ip-destination " "[!] \fIaddress\fP[/\fImask\fP]" +The destination IP address. +The flag +.B --ip-dst +is an alias for this option. +.TP +.BR "--ip-tos " "[!] \fItos\fP" +The IP type of service, in hexadecimal numbers. +.BR IPv4 . +.TP +.BR "--ip-protocol " "[!] \fIprotocol\fP" +The IP protocol. +The flag +.B --ip-proto +is an alias for this option. +.TP +.BR "--ip-source-port " "[!] \fIport1\fP[:\fIport2\fP]" +The source port or port range for the IP protocols 6 (TCP), 17 +(UDP), 33 (DCCP) or 132 (SCTP). The +.B --ip-protocol +option must be specified as +.IR TCP ", " UDP ", " DCCP " or " SCTP . +If +.IR port1 " is omitted, " 0:port2 " is used; if " port2 " is omitted but a colon is specified, " port1:65535 " is used." +The flag +.B --ip-sport +is an alias for this option. +.TP +.BR "--ip-destination-port " "[!] \fIport1\fP[:\fIport2\fP]" +The destination port or port range for ip protocols 6 (TCP), 17 +(UDP), 33 (DCCP) or 132 (SCTP). The +.B --ip-protocol +option must be specified as +.IR TCP ", " UDP ", " DCCP " or " SCTP . +If +.IR port1 " is omitted, " 0:port2 " is used; if " port2 " is omitted but a colon is specified, " port1:65535 " is used." +The flag +.B --ip-dport +is an alias for this option. +.SS ip6 +Specify IPv6 fields. The protocol must be specified as +.IR IPv6 . +.TP +.BR "--ip6-source " "[!] \fIaddress\fP[/\fImask\fP]" +The source IPv6 address. +The flag +.B --ip6-src +is an alias for this option. +.TP +.BR "--ip6-destination " "[!] \fIaddress\fP[/\fImask\fP]" +The destination IPv6 address. +The flag +.B --ip6-dst +is an alias for this option. +.TP +.BR "--ip6-tclass " "[!] \fItclass\fP" +The IPv6 traffic class, in hexadecimal numbers. +.TP +.BR "--ip6-protocol " "[!] \fIprotocol\fP" +The IP protocol. +The flag +.B --ip6-proto +is an alias for this option. +.TP +.BR "--ip6-source-port " "[!] \fIport1\fP[:\fIport2\fP]" +The source port or port range for the IPv6 protocols 6 (TCP), 17 +(UDP), 33 (DCCP) or 132 (SCTP). The +.B --ip6-protocol +option must be specified as +.IR TCP ", " UDP ", " DCCP " or " SCTP . +If +.IR port1 " is omitted, " 0:port2 " is used; if " port2 " is omitted but a colon is specified, " port1:65535 " is used." +The flag +.B --ip6-sport +is an alias for this option. +.TP +.BR "--ip6-destination-port " "[!] \fIport1\fP[:\fIport2\fP]" +The destination port or port range for IPv6 protocols 6 (TCP), 17 +(UDP), 33 (DCCP) or 132 (SCTP). The +.B --ip6-protocol +option must be specified as +.IR TCP ", " UDP ", " DCCP " or " SCTP . +If +.IR port1 " is omitted, " 0:port2 " is used; if " port2 " is omitted but a colon is specified, " port1:65535 " is used." +The flag +.B --ip6-dport +is an alias for this option. +.TP +.BR "--ip6-icmp-type " "[!] {\fItype\fP[:\fItype\fP]/\fIcode\fP[:\fIcode\fP]|\fItypename\fP}" +Specify ipv6\-icmp type and code to match. +Ranges for both type and code are supported. Type and code are +separated by a slash. Valid numbers for type and range are 0 to 255. +To match a single type including all valid codes, symbolic names can +be used instead of numbers. The list of known type names is shown by the command +.nf + ebtables \-\-help ip6 +.fi +This option is only valid for \-\-ip6-prococol ipv6-icmp. +.SS limit +This module matches at a limited rate using a token bucket filter. +A rule using this extension will match until this limit is reached. +It can be used with the +.B --log +watcher to give limited logging, for example. Its use is the same +as the limit match of iptables. +.TP +.BR "--limit " "[\fIvalue\fP]" +Maximum average matching rate: specified as a number, with an optional +.IR /second ", " /minute ", " /hour ", or " /day " suffix; the default is " 3/hour . +.TP +.BR "--limit-burst " "[\fInumber\fP]" +Maximum initial number of packets to match: this number gets recharged by +one every time the limit specified above is not reached, up to this +number; the default is +.IR 5 . +.SS mark_m +.TP +.BR "--mark " "[!] [\fIvalue\fP][/\fImask\fP]" +Matches frames with the given unsigned mark value. If a +.IR value " and " mask " are specified, the logical AND of the mark value of the frame and" +the user-specified +.IR mask " is taken before comparing it with the" +user-specified mark +.IR value ". When only a mark " +.IR value " is specified, the packet" +only matches when the mark value of the frame equals the user-specified +mark +.IR value . +If only a +.IR mask " is specified, the logical" +AND of the mark value of the frame and the user-specified +.IR mask " is taken and the frame matches when the result of this logical AND is" +non-zero. Only specifying a +.IR mask " is useful to match multiple mark values." +.SS pkttype +.TP +.BR "--pkttype-type " "[!] \fItype\fP" +Matches on the Ethernet "class" of the frame, which is determined by the +generic networking code. Possible values: +.IR broadcast " (MAC destination is the broadcast address)," +.IR multicast " (MAC destination is a multicast address)," +.IR host " (MAC destination is the receiving network device), or " +.IR otherhost " (none of the above)." +.SS stp +Specify stp BPDU (bridge protocol data unit) fields. The destination +address +.BR "" ( -d ") must be specified as the bridge group address" +.IR "" ( BGA ). +For all options for which a range of values can be specified, it holds that +if the lower bound is omitted (but the colon is not), then the lowest possible lower bound +for that option is used, while if the upper bound is omitted (but the colon again is not), the +highest possible upper bound for that option is used. +.TP +.BR "--stp-type " "[!] \fItype\fP" +The BPDU type (0-255), recognized non-numerical types are +.IR config ", denoting a configuration BPDU (=0), and" +.IR tcn ", denothing a topology change notification BPDU (=128)." +.TP +.BR "--stp-flags " "[!] \fIflag\fP" +The BPDU flag (0-255), recognized non-numerical flags are +.IR topology-change ", denoting the topology change flag (=1), and" +.IR topology-change-ack ", denoting the topology change acknowledgement flag (=128)." +.TP +.BR "--stp-root-prio " "[!] [\fIprio\fP][:\fIprio\fP]" +The root priority (0-65535) range. +.TP +.BR "--stp-root-addr " "[!] [\fIaddress\fP][/\fImask\fP]" +The root mac address, see the option +.BR -s " for more details." +.TP +.BR "--stp-root-cost " "[!] [\fIcost\fP][:\fIcost\fP]" +The root path cost (0-4294967295) range. +.TP +.BR "--stp-sender-prio " "[!] [\fIprio\fP][:\fIprio\fP]" +The BPDU's sender priority (0-65535) range. +.TP +.BR "--stp-sender-addr " "[!] [\fIaddress\fP][/\fImask\fP]" +The BPDU's sender mac address, see the option +.BR -s " for more details." +.TP +.BR "--stp-port " "[!] [\fIport\fP][:\fIport\fP]" +The port identifier (0-65535) range. +.TP +.BR "--stp-msg-age " "[!] [\fIage\fP][:\fIage\fP]" +The message age timer (0-65535) range. +.TP +.BR "--stp-max-age " "[!] [\fIage\fP][:\fIage\fP]" +The max age timer (0-65535) range. +.TP +.BR "--stp-hello-time " "[!] [\fItime\fP][:\fItime\fP]" +The hello time timer (0-65535) range. +.TP +.BR "--stp-forward-delay " "[!] [\fIdelay\fP][:\fIdelay\fP]" +The forward delay timer (0-65535) range. +.\" .SS string +.\" This module matches on a given string using some pattern matching strategy. +.\" .TP +.\" .BR "--string-algo " "\fIalgorithm\fP" +.\" The pattern matching strategy. (bm = Boyer-Moore, kmp = Knuth-Pratt-Morris) +.\" .TP +.\" .BR "--string-from " "\fIoffset\fP" +.\" The lowest offset from which a match can start. (default: 0) +.\" .TP +.\" .BR "--string-to " "\fIoffset\fP" +.\" The highest offset from which a match can start. (default: size of frame) +.\" .TP +.\" .BR "--string " "[!] \fIpattern\fP" +.\" Matches the given pattern. +.\" .TP +.\" .BR "--string-hex " "[!] \fIpattern\fP" +.\" Matches the given pattern in hex notation, e.g. '|0D 0A|', '|0D0A|', 'www|09|netfilter|03|org|00|' +.\" .TP +.\" .BR "--string-icase" +.\" Ignore case when searching. +.SS vlan +Specify 802.1Q Tag Control Information fields. +The protocol must be specified as +.IR 802_1Q " (0x8100)." +.TP +.BR "--vlan-id " "[!] \fIid\fP" +The VLAN identifier field (VID). Decimal number from 0 to 4095. +.TP +.BR "--vlan-prio " "[!] \fIprio\fP" +The user priority field, a decimal number from 0 to 7. +The VID should be set to 0 ("null VID") or unspecified +(in the latter case the VID is deliberately set to 0). +.TP +.BR "--vlan-encap " "[!] \fItype\fP" +The encapsulated Ethernet frame type/length. +Specified as a hexadecimal +number from 0x0000 to 0xFFFF or as a symbolic name +from +.BR /etc/ethertypes . + +.SS WATCHER EXTENSIONS +Watchers only look at frames passing by, they don't modify them nor decide +to accept the frames or not. These watchers only +see the frame if the frame matches the rule, and they see it before the +target is executed. +.SS log +The log watcher writes descriptive data about a frame to the syslog. +.TP +.B "--log" +.br +Log with the default loggin options: log-level= +.IR info , +log-prefix="", no ip logging, no arp logging. +.TP +.B --log-level "\fIlevel\fP" +.br +Defines the logging level. For the possible values, see +.BR "ebtables -h log" . +The default level is +.IR info . +.TP +.BR --log-prefix " \fItext\fP" +.br +Defines the prefix +.I text +to be printed at the beginning of the line with the logging information. +.TP +.B --log-ip +.br +Will log the ip information when a frame made by the ip protocol matches +the rule. The default is no ip information logging. +.TP +.B --log-ip6 +.br +Will log the ipv6 information when a frame made by the ipv6 protocol matches +the rule. The default is no ipv6 information logging. +.TP +.B --log-arp +.br +Will log the (r)arp information when a frame made by the (r)arp protocols +matches the rule. The default is no (r)arp information logging. +.SS nflog +The nflog watcher passes the packet to the loaded logging backend +in order to log the packet. This is usually used in combination with +nfnetlink_log as logging backend, which will multicast the packet +through a +.IR netlink +socket to the specified multicast group. One or more userspace processes +may subscribe to the group to receive the packets. +.TP +.B "--nflog" +.br +Log with the default logging options +.TP +.B --nflog-group "\fInlgroup\fP" +.br +The netlink group (1 - 2^32-1) to which packets are (only applicable for +nfnetlink_log). The default value is 1. +.TP +.B --nflog-prefix "\fIprefix\fP" +.br +A prefix string to include in the log message, up to 30 characters +long, useful for distinguishing messages in the logs. +.TP +.B --nflog-range "\fIsize\fP" +.br +The number of bytes to be copied to userspace (only applicable for +nfnetlink_log). nfnetlink_log instances may specify their own +range, this option overrides it. +.TP +.B --nflog-threshold "\fIsize\fP" +.br +Number of packets to queue inside the kernel before sending them +to userspace (only applicable for nfnetlink_log). Higher values +result in less overhead per packet, but increase delay until the +packets reach userspace. The default value is 1. +.SS ulog +The ulog watcher passes the packet to a userspace +logging daemon using netlink multicast sockets. This differs +from the log watcher in the sense that the complete packet is +sent to userspace instead of a descriptive text and that +netlink multicast sockets are used instead of the syslog. +This watcher enables parsing of packets with userspace programs, the +physical bridge in and out ports are also included in the netlink messages. +The ulog watcher module accepts 2 parameters when the module is loaded +into the kernel (e.g. with modprobe): +.B nlbufsiz +specifies how big the buffer for each netlink multicast +group is. If you say +.IR nlbufsiz=8192 , +for example, up to eight kB of packets will +get accumulated in the kernel until they are sent to userspace. It is +not possible to allocate more than 128kB. Please also keep in mind that +this buffer size is allocated for each nlgroup you are using, so the +total kernel memory usage increases by that factor. The default is 4096. +.B flushtimeout +specifies after how many hundredths of a second the queue should be +flushed, even if it is not full yet. The default is 10 (one tenth of +a second). +.TP +.B "--ulog" +.br +Use the default settings: ulog-prefix="", ulog-nlgroup=1, +ulog-cprange=4096, ulog-qthreshold=1. +.TP +.B --ulog-prefix "\fItext\fP" +.br +Defines the prefix included with the packets sent to userspace. +.TP +.BR --ulog-nlgroup " \fIgroup\fP" +.br +Defines which netlink group number to use (a number from 1 to 32). +Make sure the netlink group numbers used for the iptables ULOG +target differ from those used for the ebtables ulog watcher. +The default group number is 1. +.TP +.BR --ulog-cprange " \fIrange\fP" +.br +Defines the maximum copy range to userspace, for packets matching the +rule. The default range is 0, which means the maximum copy range is +given by +.BR nlbufsiz . +A maximum copy range larger than +128*1024 is meaningless as the packets sent to userspace have an upper +size limit of 128*1024. +.TP +.BR --ulog-qthreshold " \fIthreshold\fP" +.br +Queue at most +.I threshold +number of packets before sending them to +userspace with a netlink socket. Note that packets can be sent to +userspace before the queue is full, this happens when the ulog +kernel timer goes off (the frequency of this timer depends on +.BR flushtimeout ). +.SS TARGET EXTENSIONS +.SS arpreply +The +.B arpreply +target can be used in the +.BR PREROUTING " chain of the " nat " table." +If this target sees an ARP request it will automatically reply +with an ARP reply. The used MAC address for the reply can be specified. +The protocol must be specified as +.IR ARP . +When the ARP message is not an ARP request or when the ARP request isn't +for an IP address on an Ethernet network, it is ignored by this target +.BR "" ( CONTINUE ). +When the ARP request is malformed, it is dropped +.BR "" ( DROP ). +.TP +.BR "--arpreply-mac " "\fIaddress\fP" +Specifies the MAC address to reply with: the Ethernet source MAC and the +ARP payload source MAC will be filled in with this address. +.TP +.BR "--arpreply-target " "\fItarget\fP" +Specifies the standard target. After sending the ARP reply, the rule still +has to give a standard target so ebtables knows what to do with the ARP request. +The default target +.BR "" "is " DROP . +.SS dnat +The +.B dnat +target can only be used in the +.BR PREROUTING " and " OUTPUT " chains of the " nat " table." +It specifies that the destination MAC address has to be changed. +.TP +.BR "--to-destination " "\fIaddress\fP" +.br +Change the destination MAC address to the specified +.IR address . +The flag +.B --to-dst +is an alias for this option. +.TP +.BR "--dnat-target " "\fItarget\fP" +.br +Specifies the standard target. After doing the dnat, the rule still has to +give a standard target so ebtables knows what to do with the dnated frame. +The default target is +.BR ACCEPT . +Making it +.BR CONTINUE " could let you use" +multiple target extensions on the same frame. Making it +.BR DROP " only makes" +sense in the +.BR BROUTING " chain but using the " redirect " target is more logical there. " RETURN " is also allowed. Note that using " RETURN +in a base chain is not allowed (for obvious reasons). +.SS mark +.BR "" "The " mark " target can be used in every chain of every table. It is possible" +to use the marking of a frame/packet in both ebtables and iptables, +if the bridge-nf code is compiled into the kernel. Both put the marking at the +same place. This allows for a form of communication between ebtables and iptables. +.TP +.BR "--mark-set " "\fIvalue\fP" +.br +Mark the frame with the specified non-negative +.IR value . +.TP +.BR "--mark-or " "\fIvalue\fP" +.br +Or the frame with the specified non-negative +.IR value . +.TP +.BR "--mark-and " "\fIvalue\fP" +.br +And the frame with the specified non-negative +.IR value . +.TP +.BR "--mark-xor " "\fIvalue\fP" +.br +Xor the frame with the specified non-negative +.IR value . +.TP +.BR "--mark-target " "\fItarget\fP" +.br +Specifies the standard target. After marking the frame, the rule +still has to give a standard target so ebtables knows what to do. +The default target is +.BR ACCEPT ". Making it " CONTINUE " can let you do other" +things with the frame in subsequent rules of the chain. +.SS redirect +The +.B redirect +target will change the MAC target address to that of the bridge device the +frame arrived on. This target can only be used in the +.BR PREROUTING " chain of the " nat " table." +The MAC address of the bridge is used as destination address." +.TP +.BR "--redirect-target " "\fItarget\fP" +.br +Specifies the standard target. After doing the MAC redirect, the rule +still has to give a standard target so ebtables knows what to do. +The default target is +.BR ACCEPT ". Making it " CONTINUE " could let you use" +multiple target extensions on the same frame. Making it +.BR DROP " in the " BROUTING " chain will let the frames be routed. " RETURN " is also allowed. Note" +.BR "" "that using " RETURN " in a base chain is not allowed." +.SS snat +The +.B snat +target can only be used in the +.BR POSTROUTING " chain of the " nat " table." +It specifies that the source MAC address has to be changed. +.TP +.BR "--to-source " "\fIaddress\fP" +.br +Changes the source MAC address to the specified +.IR address ". The flag" +.B --to-src +is an alias for this option. +.TP +.BR "--snat-target " "\fItarget\fP" +.br +Specifies the standard target. After doing the snat, the rule still has +to give a standard target so ebtables knows what to do. +.BR "" "The default target is " ACCEPT ". Making it " CONTINUE " could let you use" +.BR "" "multiple target extensions on the same frame. Making it " DROP " doesn't" +.BR "" "make sense, but you could do that too. " RETURN " is also allowed. Note" +.BR "" "that using " RETURN " in a base chain is not allowed." +.br +.TP +.BR "--snat-arp " +.br +Also change the hardware source address inside the arp header if the packet is an +arp message and the hardware address length in the arp header is 6 bytes. +.br +.SH FILES +.I /etc/ethertypes +.SH ENVIRONMENT VARIABLES +.I EBTABLES_ATOMIC_FILE +.SH MAILINGLISTS +.BR "" "See " http://netfilter.org/mailinglists.html +.SH BUGS +The version of ebtables this man page ships with does not support the +.B broute +table. Also there is no support for +.B string +match. And finally, this list is probably not complete. +.SH SEE ALSO +.BR xtables-nft "(8), " iptables "(8), " ip (8) +.PP +.BR "" "See " https://wiki.nftables.org diff --git a/upstream/opensuse-leap-15-6/man8/editmap.8 b/upstream/opensuse-leap-15-6/man8/editmap.8 new file mode 100644 index 00000000..db72102a --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/editmap.8 @@ -0,0 +1,106 @@ +.\" Copyright (c) 2000-2001, 2003 Proofpoint, Inc. and its suppliers. +.\" All rights reserved. +.\" +.\" By using this file, you agree to the terms and conditions set +.\" forth in the LICENSE file which can be found at the top level of +.\" the sendmail distribution. +.\" +.\" +.\" $Id: editmap.8,v 1.10 2013-11-22 20:51:26 ca Exp $ +.\" +.TH EDITMAP 8 "$Date: 2013-11-22 20:51:26 $" +.SH NAME +.B editmap +\- query and edit single records in database maps for sendmail +.SH SYNOPSIS +.B editmap +.RB [ \-C +.IR file ] +.RB [ \-N ] +.RB [ \-f ] +.RB [ \-q|\-u|\-x ] +maptype mapname +key [ "value ..." ] +.SH DESCRIPTION +.B Editmap +queries or edits one record in database maps used by the keyed map lookups in +sendmail(8). +Arguments are passed on the command line and output (for queries) is +directed to standard output. +.PP +Depending on how it is compiled, +.B editmap +handles up to three different database formats, +selected using the +.I maptype +parameter. +They may be +.TP +dbm +DBM format maps. +This requires the +ndbm(3) +library. +.TP +btree +B-Tree format maps. +This requires the new Berkeley DB +library. +.TP +hash +Hash format maps. +This also requires the Berkeley DB +library. +.PP +If the +.I TrustedUser +option is set in the sendmail configuration file and +.B editmap +is invoked as root, the generated files will be owned by +the specified +.IR TrustedUser. +.SS Flags +.TP +.B \-C +Use the specified +.B sendmail +configuration file for looking up the TrustedUser option. +.TP +.B \-N +Include the null byte that terminates strings +in the map (for alias maps). +.TP +.B \-f +Normally all upper case letters in the key +are folded to lower case. +This flag disables that behaviour. +This is intended to mesh with the +\-f flag in the +.B K +line in sendmail.cf. +The value is never case folded. +.TP +.B \-q +Query the map for the specified key. If found, print value to standard +output and exit with 0. If not found then print an error +message to stdout and exit with EX_UNAVAILABLE. +.TP +.B \-u +Update the record for +.I key +with +.I value +or inserts a new record if one doesn't exist. Exits with 0 on success +or EX_IOERR on failure. +.TP +.B \-x +Deletes the specific key from the map. Exits with 0 on success or +EX_IOERR on failure. +.TP +.SH SEE ALSO +sendmail(8), +makemap(8) +.SH HISTORY +The +.B editmap +command has no history. diff --git a/upstream/opensuse-leap-15-6/man8/edquota.8 b/upstream/opensuse-leap-15-6/man8/edquota.8 new file mode 100644 index 00000000..85ad762e --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/edquota.8 @@ -0,0 +1,192 @@ +.TH EDQUOTA 8 +.SH NAME +edquota \- edit user quotas +.SH SYNOPSIS +.B edquota +[ +.B \-p +.I protoname +] [ +.BR \-u \ | +.BR \-g \ | +.B \-P +] [ +.B \-rm +] [ +.B \-F +.I format-name +] [ +.B \-f +.I filesystem +] +.IR username \ | +.IR groupname \ | +.IR projectname .\|.\|. +.LP +.B edquota +[ +.BR \-u \ | +.BR \-g \ | +.B \-P +] [ +.B \-F +.I format-name +] [ +.B \-f +.I filesystem +] +.B \-t +.LP +.B edquota +[ +.BR \-u \ | +.BR \-g \ | +.B \-P +] [ +.B \-F +.I format-name +] [ +.B \-f +.I filesystem +] +.B \-T +.IR username \ | +.IR groupname \ | +.IR projectname .\|.\|. +.SH DESCRIPTION +.IX "edquota command" "" "\fLedquota\fP \(em edit user quotas" +.IX edit "user quotas \(em \fLedquota\fP" +.IX "user quotas" "edquota command" "" "\fLedquota\fP \(em edit user quotas" +.IX "disk quotas" "edquota command" "" "\fLedquota\fP \(em edit user quotas" +.IX "quotas" "edquota command" "" "\fLedquota\fP \(em edit user quotas" +.IX "filesystem" "edquota command" "" "\fLedquota\fP \(em edit user quotas" +.B edquota +is a quota editor. One or more users, groups, or projects may be specified +on the command line. If a number is given in the place of user/group/project +name it is treated as an UID/GID/Project ID. For each user, group, or project +a temporary file is created with an +.SM ASCII +representation of the current disk quotas for that user, group, or project and +an editor is then invoked on the file. The quotas may then be modified, new +quotas added, etc. +Setting a quota to zero indicates that no quota should be imposed. +.PP +Block usage and limits are reported and interpreted as multiples of kibibyte +(1024 bytes) blocks by default. Symbols K, M, G, and T can be appended to +numeric value to express kibibytes, mebibytes, gibibytes, and tebibytes. +.PP +Inode usage and limits are interpreted literally. Symbols k, m, g, and t can +be appended to numeric value to express multiples of 10^3, 10^6, 10^9, and +10^12 inodes. +.PP +Users are permitted to exceed their soft limits for a grace period that +may be specified per filesystem. Once the grace period has expired, the +soft limit is enforced as a hard limit. +.PP +The current usage information in the file is for informational purposes; +only the hard and soft limits can be changed. +.PP +Upon leaving the editor, +.B edquota +reads the temporary file and modifies the binary quota files to reflect +the changes made. +.LP +The editor invoked is +.BR vi (1) +unless either the +.SB EDITOR +or the +.SB VISUAL +environment variable specifies otherwise. +.LP +Only the super-user may edit quotas. +.SH OPTIONS +.TP +.B -r, --remote +Edit also non-local quota use rpc.rquotad on remote server to set quota. +This option is available only if quota tools were compiled with enabled +support for setting quotas over RPC. +The +.B -n +option is equivalent, and is maintained for backward compatibility. +.TP +.B -m, --no-mixed-pathnames +Currently, pathnames of NFSv4 mountpoints are sent without leading slash in the path. +.BR rpc.rquotad +uses this to recognize NFSv4 mounts and properly prepend pseudoroot of NFS filesystem +to the path. If you specify this option, +.BR edquota +will always send paths with a leading slash. This can be useful for legacy reasons but +be aware that quota over RPC will stop working if you are using new +.BR rpc.rquotad . +.TP +.B -u, --user +Edit the user quota. This is the default. +.TP +.B -g, --group +Edit the group quota. +.TP +.B -P, --project +Edit the project quota. +.TP +.B -p, --prototype=\f2protoname\f1 +Duplicate the quotas of the prototypical user +specified for each user specified. This is the normal +mechanism used to initialize quotas for groups of users. +.TP +.B --always-resolve +Always try to translate user / group name to uid / gid even if the name +is composed of digits only. +.TP +.B -F, --format=\f2format-name\f1 +Edit quota for specified format (ie. don't perform format autodetection). +Possible format names are: +.B vfsold +Original quota format with 16-bit UIDs / GIDs, +.B vfsv0 +Quota format with 32-bit UIDs / GIDs, 64-bit space usage, 32-bit inode usage and limits, +.B vfsv1 +Quota format with 64-bit quota limits and usage, +.B rpc +(quota over NFS), +.B xfs +(quota on XFS filesystem) +.TP +.B \-f, --filesystem \f2filesystem\f1 +Perform specified operations only for given filesystem (default is to perform +operations for all filesystems with quota). +.TP +.B \-t, --edit-period +Edit the soft time limits for each filesystem. +In old quota format if the time limits are zero, the default time limits in +.B <linux/quota.h> +are used. In new quota format time limits must be specified (there is no default +value set in kernel). Time units of 'seconds', 'minutes', 'hours', and 'days' +are understood. Time limits are printed in the greatest possible time unit such that +the value is greater than or equal to one. +.TP +.B \-T, --edit-times +Edit time for the user/group/project when softlimit is enforced. Possible values +are 'unset' or number and unit. Units are the same as in +.B \-t +option. +.SH FILES +.PD 0 +.TP 20 +.BR aquota.user " or " aquota.group +quota file at the filesystem root (version 2 quota, non-XFS filesystems) +.TP +.BR quota.user " or " quota.group +quota file at the filesystem root (version 1 quota, non-XFS filesystems) +.TP +.B /etc/mtab +mounted filesystems table +.PD +.SH SEE ALSO +.BR quota (1), +.BR vi (1), +.BR quotactl (2), +.BR quotacheck (8), +.BR quotaon (8), +.BR repquota (8), +.BR setquota (8) diff --git a/upstream/opensuse-leap-15-6/man8/exportfs.8 b/upstream/opensuse-leap-15-6/man8/exportfs.8 new file mode 100644 index 00000000..45b6d834 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/exportfs.8 @@ -0,0 +1,311 @@ +.\"@(#)exportfs.8" +.\" +.\" Copyright (C) 1995 Olaf Kirch <okir@monad.swb.de> +.\" Modifications 1999-2003 Neil Brown <neilb@cse.unsw.edu.au> +.\" +.TH exportfs 8 "30 September 2013" +.SH NAME +exportfs \- maintain table of exported NFS file systems +.SH SYNOPSIS +.BI "/usr/sbin/exportfs [-avi] [-o " "options,.." "] [" "client:/path" " ..] +.br +.BI "/usr/sbin/exportfs -r [-v]" +.br +.BI "/usr/sbin/exportfs [-av] -u [" "client:/path" " ..] +.br +.BI "/usr/sbin/exportfs [-v] +.br +.BI "/usr/sbin/exportfs -f" +.br +.BI "/usr/sbin/exportfs -s" +.br +.SH DESCRIPTION +An NFS server maintains a table of local physical file systems +that are accessible to NFS clients. +Each file system in this table is referred to as an +.IR "exported file system" , +or +.IR export , +for short. +.PP +The +.B exportfs +command maintains the current table of exports for the NFS server. +The master export table is kept in a file named +.IR /var/lib/nfs/etab . +This file is read by +.B rpc.mountd +when a client sends an NFS MOUNT request. +.PP +Normally the master export table is initialized with the contents of +.I /etc/exports +and files under +.I /etc/exports.d +by invoking +.BR "exportfs -a" . +However, a system administrator can choose to add or delete +exports without modifying +.I /etc/exports +or files under +.I /etc/exports.d +by using the +.B exportfs +command. +.PP +.B exportfs +and its partner program +.B rpc.mountd +work in one of two modes: a legacy mode which applies to 2.4 and +earlier versions of the Linux kernel, and a new mode which applies to +2.6 and later versions, providing the +.B nfsd +virtual filesystem has been mounted at +.I /proc/fs/nfsd +or +.IR /proc/fs/nfs . +On 2.6 kernels, if this filesystem is not mounted, the legacy mode is used. +.PP +In the new mode, +.B exportfs +does not give any information to the kernel, but provides it only to +.B rpc.mountd +through the +.I /var/lib/nfs/etab +file. +.B rpc.mountd +then manages kernel requests for information about exports, as needed. +.PP +In the legacy mode, +exports which identify a specific host, rather than a subnet or netgroup, +are entered directly into the kernel's export table, +as well as being written to +.IR /var/lib/nfs/etab . +Further, exports listed in +.I /var/lib/nfs/rmtab +which match a non host-specific export request will cause an +appropriate export entry for the host given in +.I rmtab +to be added to the kernel's export table. +.SH OPTIONS +.TP +.B \-d kind " or " \-\-debug kind +Turn on debugging. Valid kinds are: all, auth, call, general and parse. +Debugging can also be turned on by setting +.B debug= +in the +.B [exportfs] +section of +.IR /etc/nfs.conf . + +.TP +.B -a +Export or unexport all directories. +.TP +.BI "-o " options,... +Specify a list of export options in the same manner as in +.BR exports (5). +.TP +.B -i +Ignore the +.I /etc/exports +file and files under +.I /etc/exports.d +directory. Only default options and options given on the command line are used. +.TP +.B -r +Reexport all directories, synchronizing +.I /var/lib/nfs/etab +with +.IR /etc/exports +and files under +.IR /etc/exports.d . +This option removes entries in +.I /var/lib/nfs/etab +which have been deleted from +.I /etc/exports +or files under +.IR /etc/exports.d , +and removes any entries from the +kernel export table which are no longer valid. +.TP +.B -u +Unexport one or more directories. +.TP +.B -f +If +.I /proc/fs/nfsd +or +.I /proc/fs/nfs +is mounted, flush everything out of the kernel's export table. +Fresh entries for active clients are added to the kernel's export table by +.B rpc.mountd +when they make their next NFS mount request. +.TP +.B -v +Be verbose. When exporting or unexporting, show what's going on. When +displaying the current export list, also display the list of export +options. +.TP +.B -s +Display the current export list suitable for /etc/exports. +.SH DISCUSSION +.SS Exporting Directories +The first synopsis shows how to invoke +.B exportfs +when adding new entries to the export table. When using +.BR "exportfs -a" , +all exports listed in +.I /etc/exports +and files under +.I /etc/exports.d +are added to +.IR /var/lib/nfs/etab . +The kernel's export table is also updated as needed. +.PP +The +.I host:/path +argument specifies a local directory to export, +along with the client or clients who are permitted to access it. +See +.B exports(5) +for a description of supported options and access list formats. +.PP +IPv6 presentation addresses contain colons, which are already used +to separate the "host" and "path" command line arguments. +When specifying a client using a raw IPv6 address, +enclose the address in square brackets. +For IPv6 network addresses, place the prefix just after the closing +bracket. +.PP +To export a directory to the world, simply specify +.IR :/path . +.PP +The export options for a particular host/directory pair derive from +several sources. +The default export options are +.BR sync,ro,root_squash,wdelay . +These can be overridden by entries in +.IR /etc/exports +or files under +.IR /etc/exports.d . +.PP +A system administrator may override options from these sources using the +.B -o +command-line option on +.BR exportfs . +This option takes a comma-separated list of options in the same fashion +as one would specify them in +.IR /etc/exports . +In this way +.B exportfs +can be used to modify the export options of an already exported directory. +.SS Unexporting Directories +The third synopsis shows how to unexport a currently exported directory. +When using +.BR "exportfs -ua" , +all entries listed in +.I /var/lib/nfs/etab +are removed from the kernel export tables, and the file is cleared. This +effectively shuts down all NFS activity. +.PP +To remove an export, specify a +.I host:/path +pair. This deletes the specified entry from +.I /var/lib/nfs/etab +and removes the corresponding kernel entry (if any). +.PP +.SS Dumping the Export Table +Invoking +.B exportfs +without options shows the current list of exported file systems. +Adding the +.B -v +option causes +.B exportfs +to display the export options for each export. +.SH EXAMPLES +The following adds all directories listed in +.I /etc/exports +and files under +.I /etc/exports.d +to +.I /var/lib/nfs/etab +and pushes the resulting export entries into the kernel: +.PP +.nf +.B "# exportfs -a +.fi +.PP +To export the +.I /usr/tmp +directory to host +.BR django , +allowing insecure file locking requests from clients: +.PP +.nf +.B "# exportfs -o insecure_locks django:/usr/tmp +.fi +.PP +To unexport the +.I /usr/tmp +directory: +.PP +.nf +.B "# exportfs -u django:/usr/tmp +.fi +.PP +To unexport all exports listed in +.IR /etc/exports +and files under +.IR /etc/exports.d : +.PP +.nf +.B "# exportfs -au +.fi +.PP +To export the +.I /usr/tmp +directory to IPv6 link-local clients: +.PP +.nf +.B "# exportfs [fe80::]/64:/usr/tmp +.fi +.SH USAGE NOTES +Exporting to IP networks or DNS and NIS domains does not enable clients +from these groups to access NFS immediately. +Rather, these sorts of exports are hints to +.BR rpc.mountd (8) +to grant any mount requests from these clients. +This is usually not a problem, because any existing mounts are preserved in +.I rmtab +across reboots. +.PP +When unexporting a network or domain entry, any current exports to members +of this group will be checked against the remaining valid exports and +if they themselves are no longer valid they will be removed. +.SH FILES +.TP 2.5i +.I /etc/exports +input file listing exports, export options, and access control lists +.TP 2.5i +.I /etc/exports.d +directory where extra input files are stored. +.B Note: +only files that end with +.I .exports +are used. +.TP 2.5i +.I /var/lib/nfs/etab +master table of exports +.TP 2.5i +.I /var/lib/nfs/rmtab +table of clients accessing server's exports +.SH SEE ALSO +.BR exports (5), +.BR nfs.conf (5), +.BR rpc.mountd (8), +.BR netgroup (5) +.SH AUTHORS +Olaf Kirch <okir@monad.swb.de> +.br +Neil Brown <neilb@cse.unsw.edu.au> diff --git a/upstream/opensuse-leap-15-6/man8/fatlabel.8 b/upstream/opensuse-leap-15-6/man8/fatlabel.8 new file mode 100644 index 00000000..3f090837 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/fatlabel.8 @@ -0,0 +1,65 @@ +.\" fatlabel.8 - manpage for fatlabel +.\" +.\" Copyright (C) 2006-2014 Daniel Baumann <daniel@debian.org> +.\" +.\" This program is free software: you can redistribute it and/or modify +.\" it under the terms of the GNU General Public License as published by +.\" the Free Software Foundation, either version 3 of the License, or +.\" (at your option) any later version. +.\" +.\" This program is distributed in the hope that it will be useful, +.\" but WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.\" GNU General Public License for more details. +.\" +.\" You should have received a copy of the GNU General Public License +.\" along with this program. If not, see <http://www.gnu.org/licenses/>. +.\" +.\" The complete text of the GNU General Public License +.\" can be found in /usr/share/common-licenses/GPL-3 file. +.\" +.\" +.TH FATLABEL 8 2015\-04\-16 "dosfstools 4.1" +.SH NAME +\fBfatlabel\fR \- set or get MS\-DOS filesystem label +.\" ---------------------------------------------------------------------------- +.SH SYNOPSIS +\fBfatlabel\fR \fIDEVICE\fR [\fILABEL\fR] +.\" ---------------------------------------------------------------------------- +.SH DESCRIPTION +\fBfatlabel\fR set or gets a MS\-DOS filesystem label from a given device. +.PP +If \fILABEL\fR is omitted, then the label name of the specified device is +written on the standard output. +A label can't be longer than 11 bytes. +.\" ---------------------------------------------------------------------------- +.SH OPTIONS +.IP "\fB\-h\fR, \fB\-\-help\fR" 4 +Displays a help message. +.IP "\fB\-V\fR, \fB\-\-version\fR" 4 +Shows version. +.\" ---------------------------------------------------------------------------- +.SH SEE ALSO +\fBfsck.fat\fR(8) +.br +\fBmkfs.fat\fR(8) +.\" ---------------------------------------------------------------------------- +.SH HOMEPAGE +The home for the \fBdosfstools\fR project is its +.UR https://github.com/dosfstools/dosfstools +GitHub project page +.UE . +.\" ---------------------------------------------------------------------------- +.SH AUTHORS +\fBdosfstools\fR were written by +.MT werner.almesberger@\:lrc.di.epfl.ch +Werner Almesberger +.ME , +.MT Roman.Hodek@\:informatik.\:uni-erlangen.de +Roman Hodek +.ME , +and others. +The current maintainer is +.MT aeb@\:debian.org +Andreas Bombe +.ME . diff --git a/upstream/opensuse-leap-15-6/man8/fbtest.8 b/upstream/opensuse-leap-15-6/man8/fbtest.8 new file mode 100644 index 00000000..811a77d8 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/fbtest.8 @@ -0,0 +1,49 @@ +'\" -*- coding: UTF-8 -*- +.\" +.\" Copyright 2008 Werner Fink, 2008 SUSE LINUX Products GmbH, Germany. +.\" +.\" This program is free software; you can redistribute it and/or modify +.\" it under the terms of the GNU General Public License as published by +.\" the Free Software Foundation; either version 2 of the License, or +.\" (at your option) any later version. +.\" +.TH FBTEST 8 "May 6, 2008" "0.42" "International Support" +.SH NAME +fbtest \- test if a virtual console is mapped to a frame buffer devive +.SH SYNOPSIS +.B fbtest +.RB [ \-f \ \fI<fb_device>\fR] +.RB [ \-C \ \fI<vc_device>\fR] +.br +.B fbtest +.B \-\-help +.SH DESCRIPTION +The program +.BR fbtest (8) +is used to test if a virtual console, e.g. +.I /dev/tty1 +is mapped on a frame buffer device. +.SH OPTIONS +.TP +.BR \-f ,\ \-\-fb = \fI<fb_device>\fR +This option specifies an other frame buffer device than +the default +.IR /dev/fb0 . +.TP +.BR \-C ,\ \-\-vc = \fI<vc_device>\fR +This option specifies an other virtual console than the default +.IR /dev/tty1 . +.SH EXIT STATUS +.IP \fB0\fR 5 +The virtual console is mapped onto a frame buffer device. +.IP \fB1\fR 5 +The virtual console is +.B not +mapped onto a frame buffer device. +.PP +.SH FILES +.I /dev/fb0 +.br +.I /dev/tty<1...63> +.SH SEE ALSO +.BR fbset (8). diff --git a/upstream/opensuse-leap-15-6/man8/fdformat.8 b/upstream/opensuse-leap-15-6/man8/fdformat.8 new file mode 100644 index 00000000..c367fc66 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/fdformat.8 @@ -0,0 +1,123 @@ +'\" t +.\" Title: fdformat +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "FDFORMAT" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +fdformat \- low\-level format a floppy disk +.SH "SYNOPSIS" +.sp +\fBfdformat\fP [options] \fIdevice\fP +.SH "DESCRIPTION" +.sp +\fBfdformat\fP does a low\-level format on a floppy disk. \fIdevice\fP is usually one of the following (for floppy devices the major = 2, and the minor is shown for informational purposes only): +.sp +.if n .RS 4 +.nf +.fam C +/dev/fd0d360 (minor = 4) +/dev/fd0h1200 (minor = 8) +/dev/fd0D360 (minor = 12) +/dev/fd0H360 (minor = 12) +/dev/fd0D720 (minor = 16) +/dev/fd0H720 (minor = 16) +/dev/fd0h360 (minor = 20) +/dev/fd0h720 (minor = 24) +/dev/fd0H1440 (minor = 28) +.fam +.fi +.if n .RE +.sp +.if n .RS 4 +.nf +.fam C +/dev/fd1d360 (minor = 5) +/dev/fd1h1200 (minor = 9) +/dev/fd1D360 (minor = 13) +/dev/fd1H360 (minor = 13) +/dev/fd1D720 (minor = 17) +/dev/fd1H720 (minor = 17) +/dev/fd1h360 (minor = 21) +/dev/fd1h720 (minor = 25) +/dev/fd1H1440 (minor = 29) +.fam +.fi +.if n .RE +.sp +The generic floppy devices, \fI/dev/fd0\fP and \fI/dev/fd1\fP, will fail to work with \fBfdformat\fP when a non\-standard format is being used, or if the format has not been autodetected earlier. In this case, use \fBsetfdprm\fP(8) to load the disk parameters. +.SH "OPTIONS" +.sp +\fB\-f\fP, \fB\-\-from\fP \fIN\fP +.RS 4 +Start at the track \fIN\fP (default is 0). +.RE +.sp +\fB\-t\fP, \fB\-\-to\fP \fIN\fP +.RS 4 +Stop at the track \fIN\fP. +.RE +.sp +\fB\-r\fP, \fB\-\-repair\fP \fIN\fP +.RS 4 +Try to repair tracks failed during the verification (max \fIN\fP retries). +.RE +.sp +\fB\-n\fP, \fB\-\-no\-verify\fP +.RS 4 +Skip the verification that is normally performed after the formatting. +.RE +.sp +\fB\-V\fP, \fB\-\-version\fP +.RS 4 +Display version information and exit. +.RE +.sp +\fB\-h\fP, \fB\-\-help\fP +.RS 4 +Display help text and exit. +.RE +.SH "NOTES" +.sp +This utility does not handle USB floppy disk drives. Use \fBufiformat\fP(8) instead. +.SH "AUTHORS" +.sp +.MTO "almesber\(atnessie.cs.id.ethz.ch" "Werner Almesberger" "" +.SH "SEE ALSO" +.sp +\fBfd\fP(4), +\fBemkfs\fP(8), +\fBmkfs\fP(8), +\fBsetfdprm\fP(8), +\fBufiformat\fP(8) +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBfdformat\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/fdisk.8 b/upstream/opensuse-leap-15-6/man8/fdisk.8 new file mode 100644 index 00000000..ab1c5241 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/fdisk.8 @@ -0,0 +1,294 @@ +'\" t +.\" Title: fdisk +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "FDISK" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +fdisk \- manipulate disk partition table +.SH "SYNOPSIS" +.sp +\fBfdisk\fP [options] \fIdevice\fP +.sp +\fBfdisk\fP \fB\-l\fP [\fIdevice\fP...] +.SH "DESCRIPTION" +.sp +\fBfdisk\fP is a dialog\-driven program for creation and manipulation of partition tables. It understands GPT, MBR, Sun, SGI and BSD partition tables. +.sp +Block devices can be divided into one or more logical disks called \fIpartitions\fP. This division is recorded in the \fIpartition table\fP, usually found in sector 0 of the disk. (In the BSD world one talks about `disk slices\(aq and a `disklabel\(aq.) +.sp +All partitioning is driven by device I/O limits (the topology) by default. \fBfdisk\fP is able to optimize the disk layout for a 4K\-sector size and use an alignment offset on modern devices for MBR and GPT. It is always a good idea to follow \fBfdisk\fP\(aqs defaults as the default values (e.g., first and last partition sectors) and partition sizes specified by the +/\-<size>{M,G,...} notation are always aligned according to the device properties. +.sp +CHS (Cylinder\-Head\-Sector) addressing is deprecated and not used by default. Please, do not follow old articles and recommendations with \fBfdisk \-S <n> \-H <n>\fP advices for SSD or 4K\-sector devices. +.sp +Note that \fBpartx\fP(8) provides a rich interface for scripts to print disk layouts, \fBfdisk\fP is mostly designed for humans. Backward compatibility in the output of \fBfdisk\fP is not guaranteed. The input (the commands) should always be backward compatible. +.SH "OPTIONS" +.sp +\fB\-b\fP, \fB\-\-sector\-size\fP \fIsectorsize\fP +.RS 4 +Specify the sector size of the disk. Valid values are 512, 1024, 2048, and 4096. (Recent kernels know the sector size. Use this option only on old kernels or to override the kernel\(cqs ideas.) Since util\-linux\-2.17, \fBfdisk\fP differentiates between logical and physical sector size. This option changes both sector sizes to \fIsectorsize\fP. +.RE +.sp +\fB\-B\fP, \fB\-\-protect\-boot\fP +.RS 4 +Don\(cqt erase the beginning of the first disk sector when creating a new disk label. This feature is supported for GPT and MBR. +.RE +.sp +\fB\-c\fP, \fB\-\-compatibility\fP[=\fImode\fP] +.RS 4 +Specify the compatibility mode, \(aqdos\(aq or \(aqnondos\(aq. The default is non\-DOS mode. For backward compatibility, it is possible to use the option without the \fImode\fP argument \(em then the default is used. Note that the optional \fImode\fP argument cannot be separated from the \fB\-c\fP option by a space, the correct form is for example \fB\-c\fP=\fIdos\fP. +.RE +.sp +\fB\-h\fP, \fB\-\-help\fP +.RS 4 +Display a help text and exit. +.RE +.sp +\fB\-L\fP, \fB\-\-color\fP[=\fIwhen\fP] +.RS 4 +Colorize the output. The optional argument \fIwhen\fP can be \fBauto\fP, \fBnever\fP or \fBalways\fP. If the \fIwhen\fP argument is omitted, it defaults to \fBauto\fP. The colors can be disabled; for the current built\-in default see the \fB\-\-help\fP output. See also the \fBCOLORS\fP section. +.RE +.sp +\fB\-l\fP, \fB\-\-list\fP +.RS 4 +List the partition tables for the specified devices and then exit. +.sp +If no devices are given, the devices mentioned in \fI/proc/partitions\fP (if this file exists) are used. Devices are always listed in the order in which they are specified on the command\-line, or by the kernel listed in \fI/proc/partitions\fP. +.RE +.sp +\fB\-x\fP, \fB\-\-list\-details\fP +.RS 4 +Like \fB\-\-list\fP, but provides more details. +.RE +.sp +\fB\-\-lock\fP[=\fImode\fP] +.RS 4 +Use exclusive BSD lock for device or file it operates. The optional argument \fImode\fP can be \fByes\fP, \fBno\fP (or 1 and 0) or \fBnonblock\fP. If the \fImode\fP argument is omitted, it defaults to \fB"yes"\fP. This option overwrites environment variable \fB$LOCK_BLOCK_DEVICE\fP. The default is not to use any lock at all, but it\(cqs recommended to avoid collisions with udevd or other tools. +.RE +.sp +\fB\-n\fP, \fB\-\-noauto\-pt\fP +.RS 4 +Don\(cqt automatically create a default partition table on empty device. The partition table has to be explicitly created by user (by command like \(aqo\(aq, \(aqg\(aq, etc.). +.RE +.sp +\fB\-o\fP, \fB\-\-output\fP \fIlist\fP +.RS 4 +Specify which output columns to print. Use \fB\-\-help\fP to get a list of all supported columns. +.sp +The default list of columns may be extended if \fIlist\fP is specified in the format \fI+list\fP (e.g., \fB\-o +UUID\fP). +.RE +.sp +\fB\-s\fP, \fB\-\-getsz\fP +.RS 4 +Print the size in 512\-byte sectors of each given block device. This option is DEPRECATED in favour of \fBblockdev\fP(8). +.RE +.sp +\fB\-t\fP, \fB\-\-type\fP \fItype\fP +.RS 4 +Enable support only for disklabels of the specified \fItype\fP, and disable support for all other types. +.RE +.sp +\fB\-u\fP, \fB\-\-units\fP[=\fIunit\fP] +.RS 4 +When listing partition tables, show sizes in \(aqsectors\(aq or in \(aqcylinders\(aq. The default is to show sizes in sectors. For backward compatibility, it is possible to use the option without the \fIunit\fP argument \(em then the default is used. Note that the optional \fIunit\fP argument cannot be separated from the \fB\-u\fP option by a space, the correct form is for example \(aq*\-u=*\fIcylinders\fP\(aq. +.RE +.sp +\fB\-C\fP, \fB\-\-cylinders\fP \fInumber\fP +.RS 4 +Specify the number of cylinders of the disk. I have no idea why anybody would want to do so. +.RE +.sp +\fB\-H\fP, \fB\-\-heads\fP \fInumber\fP +.RS 4 +Specify the number of heads of the disk. (Not the physical number, of course, but the number used for partition tables.) Reasonable values are 255 and 16. +.RE +.sp +\fB\-S\fP, \fB\-\-sectors\fP \fInumber\fP +.RS 4 +Specify the number of sectors per track of the disk. (Not the physical number, of course, but the number used for partition tables.) A reasonable value is 63. +.RE +.sp +\fB\-w\fP, \fB\-\-wipe\fP \fIwhen\fP +.RS 4 +Wipe filesystem, RAID and partition\-table signatures from the device, in order to avoid possible collisions. The argument \fIwhen\fP can be \fBauto\fP, \fBnever\fP or \fBalways\fP. When this option is not given, the default is \fBauto\fP, in which case signatures are wiped only when in interactive mode. In all cases detected signatures are reported by warning messages before a new partition table is created. See also \fBwipefs\fP(8) command. +.RE +.sp +\fB\-W\fP, \fB\-\-wipe\-partitions\fP \fIwhen\fP +.RS 4 +Wipe filesystem, RAID and partition\-table signatures from a newly created partitions, in order to avoid possible collisions. The argument \fIwhen\fP can be \fBauto\fP, \fBnever\fP or \fBalways\fP. When this option is not given, the default is \fBauto\fP, in which case signatures are wiped only when in interactive mode and after confirmation by user. In all cases detected signatures are reported by warning messages before a new partition is created. See also \fBwipefs\fP(8) command. +.RE +.sp +\fB\-V\fP, \fB\-\-version\fP +.RS 4 +Display version information and exit. +.RE +.SH "DEVICES" +.sp +The \fIdevice\fP is usually \fI/dev/sda\fP, \fI/dev/sdb\fP or so. A device name refers to the entire disk. Old systems without libata (a library used inside the Linux kernel to support ATA host controllers and devices) make a difference between IDE and SCSI disks. In such cases the device name will be \fI/dev/hd*\fP (IDE) or \fI/dev/sd*\fP (SCSI). +.sp +The \fIpartition\fP is a device name followed by a partition number. For example, \fI/dev/sda1\fP is the first partition on the first hard disk in the system. See also Linux kernel documentation (the \fIDocumentation/admin\-guide/devices.txt\fP file). +.SH "SIZES" +.sp +The "last sector" dialog accepts partition size specified by number of sectors or by +/\-<size>{K,B,M,G,...} notation. +.sp +If the size is prefixed by \(aq+\(aq then it is interpreted as relative to the partition first sector. If the size is prefixed by \(aq\-\(aq then it is interpreted as relative to the high limit (last available sector for the partition). +.sp +In the case the size is specified in bytes than the number may be followed by the multiplicative suffixes KiB=1024, MiB=1024*1024, and so on for GiB, TiB, PiB, EiB, ZiB and YiB. The "iB" is optional, e.g., "K" has the same meaning as "KiB". +.sp +The relative sizes are always aligned according to device I/O limits. The +/\-<size>{K,B,M,G,...} notation is recommended. +.sp +For backward compatibility fdisk also accepts the suffixes KB=1000, MB=1000*1000, and so on for GB, TB, PB, EB, ZB and YB. These 10^N suffixes are deprecated. +.SH "SCRIPT FILES" +.sp +\fBfdisk\fP allows reading (by \(aqI\(aq command) \fBsfdisk\fP(8) compatible script files. The script is applied to in\-memory partition table, and then it is possible to modify the partition table before you write it to the device. +.sp +And vice\-versa it is possible to write the current in\-memory disk layout to the script file by command \(aqO\(aq. +.sp +The script files are compatible between \fBcfdisk\fP(8), \fBsfdisk\fP(8), \fBfdisk\fP and other libfdisk applications. For more details see \fBsfdisk\fP(8). +.SH "DISK LABELS" +.sp +\fBGPT (GUID Partition Table)\fP +.RS 4 +GPT is modern standard for the layout of the partition table. GPT uses 64\-bit logical block addresses, checksums, UUIDs and names for partitions and an unlimited number of partitions (although the number of partitions is usually restricted to 128 in many partitioning tools). +.sp +Note that the first sector is still reserved for a \fBprotective MBR\fP in the GPT specification. It prevents MBR\-only partitioning tools from mis\-recognizing and overwriting GPT disks. +.sp +GPT is always a better choice than MBR, especially on modern hardware with a UEFI boot loader. +.RE +.sp +\fBDOS\-type (MBR)\fP +.RS 4 +A DOS\-type partition table can describe an unlimited number of partitions. In sector 0 there is room for the description of 4 partitions (called `primary\(aq). One of these may be an extended partition; this is a box holding logical partitions, with descriptors found in a linked list of sectors, each preceding the corresponding logical partitions. The four primary partitions, present or not, get numbers 1\-4. Logical partitions are numbered starting from 5. +.sp +In a DOS\-type partition table the starting offset and the size of each partition is stored in two ways: as an absolute number of sectors (given in 32 bits), and as a \fBCylinders/Heads/Sectors\fP triple (given in 10+8+6 bits). The former is OK \(em with 512\-byte sectors this will work up to 2 TB. The latter has two problems. First, these C/H/S fields can be filled only when the number of heads and the number of sectors per track are known. And second, even if we know what these numbers should be, the 24 bits that are available do not suffice. DOS uses C/H/S only, Windows uses both, Linux never uses C/H/S. The \fBC/H/S addressing is deprecated\fP and may be unsupported in some later \fBfdisk\fP version. +.sp +\fBPlease, read the DOS\-mode section if you want DOS\-compatible partitions.\fP \fBfdisk\fP does not care about cylinder boundaries by default. +.RE +.sp +\fBBSD/Sun\-type\fP +.RS 4 +A BSD/Sun disklabel can describe 8 partitions, the third of which should be a `whole disk\(aq partition. Do not start a partition that actually uses its first sector (like a swap partition) at cylinder 0, since that will destroy the disklabel. Note that a \fBBSD label\fP is usually nested within a DOS partition. +.RE +.sp +\fBIRIX/SGI\-type\fP +.RS 4 +An IRIX/SGI disklabel can describe 16 partitions, the eleventh of which should be an entire `volume\(aq partition, while the ninth should be labeled `volume header\(aq. The volume header will also cover the partition table, i.e., it starts at block zero and extends by default over five cylinders. The remaining space in the volume header may be used by header directory entries. No partitions may overlap with the volume header. Also do not change its type or make some filesystem on it, since you will lose the partition table. Use this type of label only when working with Linux on IRIX/SGI machines or IRIX/SGI disks under Linux. +.sp +A sync() and an ioctl(BLKRRPART) (rereading the partition table from disk) are performed before exiting when the partition table has been updated. +.RE +.SH "DOS MODE AND DOS 6.X WARNING" +.sp +\fBNote that all this is deprecated. You don\(cqt have to care about things like\fP \fBgeometry and cylinders on modern operating systems. If you really want\fP \fBDOS\-compatible partitioning then you have to enable DOS mode and cylinder\fP \fBunits by using the \(aq\-c=dos \-u=cylinders\(aq fdisk command\-line options.\fP +.sp +The DOS 6.x FORMAT command looks for some information in the first sector of the data area of the partition, and treats this information as more reliable than the information in the partition table. DOS FORMAT expects DOS FDISK to clear the first 512 bytes of the data area of a partition whenever a size change occurs. DOS FORMAT will look at this extra information even if the /U flag is given \(em we consider this a bug in DOS FORMAT and DOS FDISK. +.sp +The bottom line is that if you use \fBfdisk\fP or \fBcfdisk\fP to change the size of a DOS partition table entry, then you must also use \fBdd\fP(1) to \fBzero the first 512 bytes\fP of that partition before using DOS FORMAT to format the partition. For example, if you were using \fBfdisk\fP to make a DOS partition table entry for \fI/dev/sda1\fP, then (after exiting \fBfdisk\fP and rebooting Linux so that the partition table information is valid) you would use the command \fBdd if=/dev/zero of=/dev/sda1 bs=512 count=1\fP to zero the first 512 bytes of the partition. +.sp +\fBfdisk\fP usually obtains the disk geometry automatically. This is not necessarily the physical disk geometry (indeed, modern disks do not really have anything like a physical geometry, certainly not something that can be described in the simplistic Cylinders/Heads/Sectors form), but it is the disk geometry that MS\-DOS uses for the partition table. +.sp +Usually all goes well by default, and there are no problems if Linux is the only system on the disk. However, if the disk has to be shared with other operating systems, it is often a good idea to let an \fBfdisk\fP from another operating system make at least one partition. When Linux boots it looks at the partition table, and tries to deduce what (fake) geometry is required for good cooperation with other systems. +.sp +Whenever a partition table is printed out in DOS mode, a consistency check is performed on the partition table entries. This check verifies that the physical and logical start and end points are identical, and that each partition starts and ends on a cylinder boundary (except for the first partition). +.sp +Some versions of MS\-DOS create a first partition which does not begin on a cylinder boundary, but on sector 2 of the first cylinder. Partitions beginning in cylinder 1 cannot begin on a cylinder boundary, but this is unlikely to cause difficulty unless you have OS/2 on your machine. +.sp +For best results, you should always use an OS\-specific partition table program. For example, you should make DOS partitions with the DOS FDISK program and Linux partitions with the Linux \fBfdisk\fP or Linux \fBcfdisk\fP(8) programs. +.SH "COLORS" +.sp +Implicit coloring can be disabled by an empty file \fI/etc/terminal\-colors.d/fdisk.disable\fP. +.sp +See \fBterminal\-colors.d\fP(5) for more details about colorization configuration. The logical color names supported by \fBfdisk\fP are: +.sp +\fBheader\fP +.RS 4 +The header of the output tables. +.RE +.sp +\fBhelp\-title\fP +.RS 4 +The help section titles. +.RE +.sp +\fBwarn\fP +.RS 4 +The warning messages. +.RE +.sp +\fBwelcome\fP +.RS 4 +The welcome message. +.RE +.SH "ENVIRONMENT" +.sp +\fBFDISK_DEBUG\fP=all +.RS 4 +enables fdisk debug output. +.RE +.sp +\fBLIBFDISK_DEBUG\fP=all +.RS 4 +enables libfdisk debug output. +.RE +.sp +\fBLIBBLKID_DEBUG\fP=all +.RS 4 +enables libblkid debug output. +.RE +.sp +\fBLIBSMARTCOLS_DEBUG\fP=all +.RS 4 +enables libsmartcols debug output. +.RE +.sp +\fBLIBSMARTCOLS_DEBUG_PADDING\fP=on +.RS 4 +use visible padding characters. +.RE +.sp +\fBLOCK_BLOCK_DEVICE\fP=<mode> +.RS 4 +use exclusive BSD lock. The mode is "1" or "0". See \fB\-\-lock\fP for more details. +.RE +.SH "AUTHORS" +.sp +.MTO "kzak\(atredhat.com" "Karel Zak" "," +.MTO "dave\(atgnu.org" "Davidlohr Bueso" "" +.sp +The original version was written by Andries E. Brouwer, A. V. Le Blanc and others. +.SH "SEE ALSO" +.sp +\fBcfdisk\fP(8), +\fBmkfs\fP(8), +\fBpartx\fP(8), +\fBsfdisk\fP(8) +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBfdisk\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/filefrag.8 b/upstream/opensuse-leap-15-6/man8/filefrag.8 new file mode 100644 index 00000000..5cfa0523 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/filefrag.8 @@ -0,0 +1,77 @@ +.\" -*- nroff -*- +.TH FILEFRAG 8 "February 2023" "E2fsprogs version 1.47.0" +.SH NAME +filefrag \- report on file fragmentation +.SH SYNOPSIS +.B filefrag +[ +.BI \-b blocksize +] +[ +.B \-BeEkPsvVxX +] +[ +.I files... +] +.SH DESCRIPTION +.B filefrag +reports on how badly fragmented a particular file might be. It makes +allowances for indirect blocks for ext2 and ext3 file systems, but can be +used on files for any file system. +.PP +The +.B filefrag +program initially attempts to get the +extent information using FIEMAP ioctl which is more efficient and faster. +If FIEMAP is not supported then filefrag will fall back to using FIBMAP. +.SH OPTIONS +.TP +.B \-B +Force the use of the older FIBMAP ioctl instead of the FIEMAP ioctl for +testing purposes. +.TP +.BI \-b blocksize +Use +.I blocksize +in bytes, or with [KMG] suffix, up to 1GB for output instead of the +file system blocksize. For compatibility with earlier versions of +.BR filefrag , +if +.I blocksize +is unspecified it defaults to 1024 bytes. Since +.I blocksize +is an optional argument, it must be added without any space after +.BR -b . +.TP +.B \-e +Print output in extent format, even for block-mapped files. +.TP +.B \-E +Display the contents of ext4's extent status cache. This feature is not +supported on all kernels, and is only supported on ext4 file systems. +.TP +.B \-k +Use 1024\-byte blocksize for output (identical to '\-b1024'). +.TP +.B -P +Pre-load the ext4 extent status cache for the file. This is not +supported on all kernels, and is only supported on ext4 file systems. +.TP +.B \-s +Sync the file before requesting the mapping. +.TP +.B \-v +Be verbose when checking for file fragmentation. +.TP +.B \-V +Print version number of program and library. If given twice, also +print the FIEMAP flags that are understood by the current version. +.TP +.B \-x +Display mapping of extended attributes. +.TP +.B \-X +Display extent block numbers in hexadecimal format. +.SH AUTHOR +.B filefrag +was written by Theodore Ts'o <tytso@mit.edu>. diff --git a/upstream/opensuse-leap-15-6/man8/findfs.8 b/upstream/opensuse-leap-15-6/man8/findfs.8 new file mode 100644 index 00000000..7751c208 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/findfs.8 @@ -0,0 +1,113 @@ +'\" t +.\" Title: findfs +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "FINDFS" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +findfs \- find a filesystem by label or UUID +.SH "SYNOPSIS" +.sp +\fBfindfs\fP \fBNAME\fP=\fIvalue\fP +.SH "DESCRIPTION" +.sp +\fBfindfs\fP will search the block devices in the system looking for a filesystem or partition with specified tag. The currently supported tags are: +.sp +\fBLABEL\fP=\fI<label>\fP +.RS 4 +Specifies filesystem label. +.RE +.sp +\fBUUID\fP=\fI<uuid>\fP +.RS 4 +Specifies filesystem UUID. +.RE +.sp +\fBPARTUUID\fP=\fI<uuid>\fP +.RS 4 +Specifies partition UUID. This partition identifier is supported for example for GUID Partition Table (GPT) partition tables. +.RE +.sp +\fBPARTLABEL\fP=\fI<label>\fP +.RS 4 +Specifies partition label (name). The partition labels are supported for example for GUID Partition Table (GPT) or MAC partition tables. +.RE +.sp +If the filesystem or partition is found, the device name will be printed on stdout. +.sp +The complete overview about filesystems and partitions you can get for example by +.RS 3 +.ll -.6i +.sp +\fBlsblk \-\-fs\fP +.sp +\fBpartx \-\-show <disk>\fP +.sp +\fBblkid\fP +.br +.RE +.ll +.SH "EXIT STATUS" +.sp +\fB0\fP +.RS 4 +success +.RE +.sp +\fB1\fP +.RS 4 +label or uuid cannot be found +.RE +.sp +\fB2\fP +.RS 4 +usage error, wrong number of arguments or unknown option +.RE +.SH "ENVIRONMENT" +.sp +LIBBLKID_DEBUG=all +.RS 4 +enables libblkid debug output. +.RE +.SH "AUTHORS" +.sp +\fBfindfs\fP was originally written by \c +.MTO "tytso\(atmit.edu" "Theodore Ts\(cqo" "" +and re\-written for the util\-linux package by +.MTO "kzak\(atredhat.com" "Karel Zak" "." +.SH "SEE ALSO" +.sp +\fBblkid\fP(8), +\fBlsblk\fP(8), +\fBpartx\fP(8) +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBfindfs\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/findmnt.8 b/upstream/opensuse-leap-15-6/man8/findmnt.8 new file mode 100644 index 00000000..4444e3e8 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/findmnt.8 @@ -0,0 +1,361 @@ +'\" t +.\" Title: findmnt +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "FINDMNT" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +findmnt \- find a filesystem +.SH "SYNOPSIS" +.sp +\fBfindmnt\fP [options] +.sp +\fBfindmnt\fP [options] \fIdevice\fP|\fImountpoint\fP +.sp +\fBfindmnt\fP [options] [\fB\-\-source\fP] \fIdevice\fP [\fB\-\-target\fP \fIpath\fP|\fB\-\-mountpoint\fP \fImountpoint\fP] +.SH "DESCRIPTION" +.sp +\fBfindmnt\fP will list all mounted filesystems or search for a filesystem. The \fBfindmnt\fP command is able to search in \fI/etc/fstab\fP, \fI/etc/mtab\fP or \fI/proc/self/mountinfo\fP. If \fIdevice\fP or \fImountpoint\fP is not given, all filesystems are shown. +.sp +The device may be specified by device name, major:minor numbers, filesystem label or UUID, or partition label or UUID. Note that \fBfindmnt\fP follows \fBmount\fP(8) behavior where a device name may be interpreted as a mountpoint (and vice versa) if the \fB\-\-target\fP, \fB\-\-mountpoint\fP or \fB\-\-source\fP options are not specified. +.sp +The command\-line option \fB\-\-target\fP accepts any file or directory and then \fBfindmnt\fP displays the filesystem for the given path. +.sp +The command prints all mounted filesystems in the tree\-like format by default. +.SH "OPTIONS" +.sp +\fB\-A\fP, \fB\-\-all\fP +.RS 4 +Disable all built\-in filters and print all filesystems. +.RE +.sp +\fB\-a\fP, \fB\-\-ascii\fP +.RS 4 +Use ascii characters for tree formatting. +.RE +.sp +\fB\-b\fP, \fB\-\-bytes\fP +.RS 4 +Print the SIZE, USED and AVAIL columns in bytes rather than in a human\-readable format. +.RE +.sp +\fB\-C\fP, \fB\-\-nocanonicalize\fP +.RS 4 +Do not canonicalize paths at all. This option affects the comparing of paths and the evaluation of tags (LABEL, UUID, etc.). +.RE +.sp +\fB\-c\fP, \fB\-\-canonicalize\fP +.RS 4 +Canonicalize all printed paths. +.RE +.sp +\fB\-D\fP, \fB\-\-df\fP +.RS 4 +Imitate the output of \fBdf\fP(1). This option is equivalent to \fB\-o SOURCE,FSTYPE,SIZE,USED,AVAIL,USE%,TARGET\fP but excludes all pseudo filesystems. Use \fB\-\-all\fP to print all filesystems. +.RE +.sp +\fB\-d\fP, \fB\-\-direction\fP \fIword\fP +.RS 4 +The search direction, either \fBforward\fP or \fBbackward\fP. +.RE +.sp +\fB\-e\fP, \fB\-\-evaluate\fP +.RS 4 +Convert all tags (LABEL, UUID, PARTUUID or PARTLABEL) to the corresponding device names. +.RE +.sp +\fB\-F\fP, \fB\-\-tab\-file\fP \fIpath\fP +.RS 4 +Search in an alternative file. If used with \fB\-\-fstab\fP, \fB\-\-mtab\fP or \fB\-\-kernel\fP, then it overrides the default paths. If specified more than once, then tree\-like output is disabled (see the \fB\-\-list\fP option). +.RE +.sp +\fB\-f\fP, \fB\-\-first\-only\fP +.RS 4 +Print the first matching filesystem only. +.RE +.sp +\fB\-h\fP, \fB\-\-help\fP +.RS 4 +Display help text and exit. +.RE +.sp +\fB\-i\fP, \fB\-\-invert\fP +.RS 4 +Invert the sense of matching. +.RE +.sp +\fB\-J\fP, \fB\-\-json\fP +.RS 4 +Use JSON output format. +.RE +.sp +\fB\-k\fP, \fB\-\-kernel\fP +.RS 4 +Search in \fI/proc/self/mountinfo\fP. The output is in the tree\-like format. This is the default. The output contains only mount options maintained by kernel (see also \fB\-\-mtab)\fP. +.RE +.sp +\fB\-l\fP, \fB\-\-list\fP +.RS 4 +Use the list output format. This output format is automatically enabled if the output is restricted by the \fB\-t\fP, \fB\-O\fP, \fB\-S\fP or \fB\-T\fP option and the option \fB\-\-submounts\fP is not used or if more that one source file (the option \fB\-F\fP) is specified. +.RE +.sp +\fB\-M\fP, \fB\-\-mountpoint\fP \fIpath\fP +.RS 4 +Explicitly define the mountpoint file or directory. See also \fB\-\-target\fP. +.RE +.sp +\fB\-m\fP, \fB\-\-mtab\fP +.RS 4 +Search in \fI/etc/mtab\fP. The output is in the list format by default (see \fB\-\-tree\fP). The output may include user space mount options. +.RE +.sp +\fB\-N\fP, \fB\-\-task\fP \fItid\fP +.RS 4 +Use alternative namespace \fI/proc/<tid>/mountinfo\fP rather than the default \fI/proc/self/mountinfo\fP. If the option is specified more than once, then tree\-like output is disabled (see the \fB\-\-list\fP option). See also the \fBunshare\fP(1) command. +.RE +.sp +\fB\-n\fP, \fB\-\-noheadings\fP +.RS 4 +Do not print a header line. +.RE +.sp +\fB\-O\fP, \fB\-\-options\fP \fIlist\fP +.RS 4 +Limit the set of printed filesystems. More than one option may be specified in a comma\-separated list. The \fB\-t\fP and \fB\-O\fP options are cumulative in effect. It is different from \fB\-t\fP in that each option is matched exactly; a leading \fIno\fP at the beginning does not have global meaning. The "no" can used for individual items in the list. The "no" prefix interpretation can be disabled by "+" prefix. +.RE +.sp +\fB\-o\fP, \fB\-\-output\fP \fIlist\fP +.RS 4 +Define output columns. See the \fB\-\-help\fP output to get a list of the currently supported columns. The \fBTARGET\fP column contains tree formatting if the \fB\-\-list\fP or \fB\-\-raw\fP options are not specified. +.sp +The default list of columns may be extended if \fIlist\fP is specified in the format \fI+list\fP (e.g., \fBfindmnt \-o +PROPAGATION\fP). +.RE +.sp +\fB\-\-output\-all\fP +.RS 4 +Output almost all available columns. The columns that require \fB\-\-poll\fP are not included. +.RE +.sp +\fB\-P\fP, \fB\-\-pairs\fP +.RS 4 +Produce output in the form of key="value" pairs. All potentially unsafe value characters are hex\-escaped (\(rsx<code>). The key (variable name) will be modified to contain only characters allowed for a shell variable identifiers, for example, FS_OPTIONS and USE_PCT instead of FS\-OPTIONS and USE%. +.RE +.sp +\fB\-p\fP, \fB\-\-poll\fP[\fI=list\fP] +.RS 4 +Monitor changes in the \fI/proc/self/mountinfo\fP file. Supported actions are: mount, umount, remount and move. More than one action may be specified in a comma\-separated list. All actions are monitored by default. +.sp +The time for which \fB\-\-poll\fP will block can be restricted with the \fB\-\-timeout\fP or \fB\-\-first\-only\fP options. +.sp +The standard columns always use the new version of the information from the mountinfo file, except the umount action which is based on the original information cached by \fBfindmnt\fP. The poll mode allows using extra columns: +.sp +\fBACTION\fP +.RS 4 +mount, umount, move or remount action name; this column is enabled by default +.RE +.sp +\fBOLD\-TARGET\fP +.RS 4 +available for umount and move actions +.RE +.sp +\fBOLD\-OPTIONS\fP +.RS 4 +available for umount and remount actions +.RE +.RE +.sp +\fB\-\-pseudo\fP +.RS 4 +Print only pseudo filesystems. +.RE +.sp +\fB\-\-shadow\fP +.RS 4 +Print only filesystems over\-mounted by another filesystem. +.RE +.sp +\fB\-R\fP, \fB\-\-submounts\fP +.RS 4 +Print recursively all submounts for the selected filesystems. The restrictions defined by options \fB\-t\fP, \fB\-O\fP, \fB\-S\fP, \fB\-T\fP and \fB\-\-direction\fP are not applied to submounts. All submounts are always printed in tree\-like order. The option enables the tree\-like output format by default. This option has no effect for \fB\-\-mtab\fP or \fB\-\-fstab\fP. +.RE +.sp +\fB\-r\fP, \fB\-\-raw\fP +.RS 4 +Use raw output format. All potentially unsafe characters are hex\-escaped (\(rsx<code>). +.RE +.sp +\fB\-\-real\fP +.RS 4 +Print only real filesystems. +.RE +.sp +\fB\-S\fP, \fB\-\-source\fP \fIspec\fP +.RS 4 +Explicitly define the mount source. Supported specifications are \fIdevice\fP, \fImaj\fP\fB:\fP\fImin\fP, \fBLABEL=\fP\fIlabel\fP, \fBUUID=\fP\fIuuid\fP, \fBPARTLABEL=\fP\fIlabel\fP and \fBPARTUUID=\fP\fIuuid\fP. +.RE +.sp +\fB\-s\fP, \fB\-\-fstab\fP +.RS 4 +Search in \fI/etc/fstab\fP. The output is in the list format (see \fB\-\-list\fP). +.RE +.sp +\fB\-T\fP, \fB\-\-target\fP \fIpath\fP +.RS 4 +Define the mount target. If \fIpath\fP is not a mountpoint file or directory, then \fBfindmnt\fP checks the \fIpath\fP elements in reverse order to get the mountpoint (this feature is supported only when searching in kernel files and unsupported for \fB\-\-fstab\fP). It\(cqs recommended to use the option \fB\-\-mountpoint\fP when checks of \fIpath\fP elements are unwanted and \fIpath\fP is a strictly specified mountpoint. +.RE +.sp +\fB\-t\fP, \fB\-\-types\fP \fIlist\fP +.RS 4 +Limit the set of printed filesystems. More than one type may be specified in a comma\-separated list. The list of filesystem types can be prefixed with \fBno\fP to specify the filesystem types on which no action should be taken. For more details see \fBmount\fP(8). +.RE +.sp +\fB\-\-tree\fP +.RS 4 +Enable tree\-like output if possible. The options is silently ignored for tables where is missing child\-parent relation (e.g., fstab). +.RE +.sp +\fB\-\-shadowed\fP +.RS 4 +Print only filesystems over\-mounted by another filesystem. +.RE +.sp +\fB\-U\fP, \fB\-\-uniq\fP +.RS 4 +Ignore filesystems with duplicate mount targets, thus effectively skipping over\-mounted mount points. +.RE +.sp +\fB\-u\fP, \fB\-\-notruncate\fP +.RS 4 +Do not truncate text in columns. The default is to not truncate the \fBTARGET\fP, \fBSOURCE\fP, \fBUUID\fP, \fBLABEL\fP, \fBPARTUUID\fP, \fBPARTLABEL\fP columns. This option disables text truncation also in all other columns. +.RE +.sp +\fB\-v\fP, \fB\-\-nofsroot\fP +.RS 4 +Do not print a [/dir] in the SOURCE column for bind mounts or btrfs subvolumes. +.RE +.sp +\fB\-w\fP, \fB\-\-timeout\fP \fImilliseconds\fP +.RS 4 +Specify an upper limit on the time for which \fB\-\-poll\fP will block, in milliseconds. +.RE +.sp +\fB\-x\fP, \fB\-\-verify\fP +.RS 4 +Check mount table content. The default is to verify \fI/etc/fstab\fP parsability and usability. It\(cqs possible to use this option also with \fB\-\-tab\-file\fP. It\(cqs possible to specify source (device) or target (mountpoint) to filter mount table. The option \fB\-\-verbose\fP forces findmnt to print more details. +.RE +.sp +\fB\-\-verbose\fP +.RS 4 +Force findmnt to print more information (\fB\-\-verify\fP only for now). +.RE +.sp +\fB\-\-vfs\-all\fP +.RS 4 +When used with \fBVFS\-OPTIONS\fP column, print all VFS (fs\-independent) flags. This option is designed for auditing purposes to list also default VFS kernel mount options which are normally not listed. +.RE +.SH "ENVIRONMENT" +.sp +LIBMOUNT_FSTAB=<path> +.RS 4 +overrides the default location of the fstab file +.RE +.sp +LIBMOUNT_MTAB=<path> +.RS 4 +overrides the default location of the mtab file +.RE +.sp +LIBMOUNT_DEBUG=all +.RS 4 +enables libmount debug output +.RE +.sp +LIBSMARTCOLS_DEBUG=all +.RS 4 +enables libsmartcols debug output +.RE +.sp +LIBSMARTCOLS_DEBUG_PADDING=on +.RS 4 +use visible padding characters. +.RE +.SH "EXAMPLES" +.sp +\fBfindmnt \-\-fstab \-t nfs\fP +.RS 4 +Prints all NFS filesystems defined in \fI/etc/fstab\fP. +.RE +.sp +\fBfindmnt \-\-fstab /mnt/foo\fP +.RS 4 +Prints all \fI/etc/fstab\fP filesystems where the mountpoint directory is \fI/mnt/foo\fP. It also prints bind mounts where \fI/mnt/foo\fP is a source. +.RE +.sp +\fBfindmnt \-\-fstab \-\-target /mnt/foo\fP +.RS 4 +Prints all \fI/etc/fstab\fP filesystems where the mountpoint directory is \fI/mnt/foo\fP. +.RE +.sp +\fBfindmnt \-\-fstab \-\-evaluate\fP +.RS 4 +Prints all \fI/etc/fstab\fP filesystems and converts LABEL= and UUID= tags to the real device names. +.RE +.sp +\fBfindmnt \-n \-\-raw \-\-evaluate \-\-output=target LABEL=/boot\fP +.RS 4 +Prints only the mountpoint where the filesystem with label "/boot" is mounted. +.RE +.sp +\fBfindmnt \-\-poll \-\-mountpoint /mnt/foo\fP +.RS 4 +Monitors mount, unmount, remount and move on \fI/mnt/foo\fP. +.RE +.sp +\fBfindmnt \-\-poll=umount \-\-first\-only \-\-mountpoint /mnt/foo\fP +.RS 4 +Waits for \fI/mnt/foo\fP unmount. +.RE +.sp +\fBfindmnt \-\-poll=remount \-t ext3 \-O ro\fP +.RS 4 +Monitors remounts to read\-only mode on all ext3 filesystems. +.RE +.SH "AUTHORS" +.sp +.MTO "kzak\(atredhat.com" "Karel Zak" "" +.SH "SEE ALSO" +.sp +\fBfstab\fP(5), +\fBmount\fP(8) +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBfindmnt\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/fragiso.8 b/upstream/opensuse-leap-15-6/man8/fragiso.8 new file mode 100644 index 00000000..1e3f422a --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/fragiso.8 @@ -0,0 +1,55 @@ +.\" man page for fragiso +.\" Copyright (c) 2007 Michael Schroeder <mls@suse.de> +.\" See LICENSE.BSD for license +.TH FRAGISO 8 "Mar 2007" +.SH NAME +fragiso \- split rpm packages from an iso and reassemble the iso later on + +.SH SYNOPSIS +.B fragiso +.B make +.I iso +.I fiso +.br +.B fragiso +.B list +.I fiso +.br +.B fragiso +.B fill +.RB [ -m ] +.I fiso iso + +.SH DESCRIPTION +fragiso can be used to convert an iso file into a fragment file, which +is a list describing all of the rpms on the iso and a data chunk +containing everything but the rpms. It is used by +.B drpmsync +when an iso needs to be transferred. The idea is that often the rpms +on the iso are already available on the destination host, so it saves +bandwidth to first transfer the fragmented iso, copy the locally +available rpms, transfer the unavailable rpms and reassemble the +iso file. + +.B fragiso +.B make +converts the iso into the fragment iso, +.B fragiso +.B list +can be used to extract the rpm information. This information consists +of the offset and length of all rpms and the lead/signature header +md5sum plus the header/payload md5sum. To reassemble the iso one +has to copy the rpms at the right offset into a new file and then +use +.B fragiso +.B fill +later on to provide all data not contained in the rpms. The +.B -m +option tells fragiso to print the resulting md5sum of the iso to stdout. +It can be used for verification purposes. + +.SH SEE ALSO +.BR drpmsync (8) + +.SH AUTHOR +Michael Schroeder <mls@suse.de> diff --git a/upstream/opensuse-leap-15-6/man8/fsck.8 b/upstream/opensuse-leap-15-6/man8/fsck.8 new file mode 100644 index 00000000..a136f2cb --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/fsck.8 @@ -0,0 +1,250 @@ +'\" t +.\" Title: fsck +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-01-06 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "FSCK" "8" "2022-01-06" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +fsck \- check and repair a Linux filesystem +.SH "SYNOPSIS" +.sp +\fBfsck\fP [\fB\-lsAVRTMNP\fP] [\fB\-r\fP [\fIfd\fP]] [\fB\-C\fP [\fIfd\fP]] [\fB\-t\fP \fIfstype\fP] [\fIfilesystem\fP...] [\fB\-\-\fP] [\fIfs\-specific\-options\fP] +.SH "DESCRIPTION" +.sp +\fBfsck\fP is used to check and optionally repair one or more Linux filesystems. \fIfilesystem\fP can be a device name (e.g., \fI/dev/hdc1\fP, \fI/dev/sdb2\fP), a mount point (e.g., \fI/\fP, \fI/usr\fP, \fI/home\fP), or an filesystem label or UUID specifier (e.g., UUID=8868abf6\-88c5\-4a83\-98b8\-bfc24057f7bd or LABEL=root). Normally, the \fBfsck\fP program will try to handle filesystems on different physical disk drives in parallel to reduce the total amount of time needed to check all of them. +.sp +If no filesystems are specified on the command line, and the \fB\-A\fP option is not specified, \fBfsck\fP will default to checking filesystems in \fI/etc/fstab\fP serially. This is equivalent to the \fB\-As\fP options. +.sp +The exit status returned by \fBfsck\fP is the sum of the following conditions: +.sp +\fB0\fP +.RS 4 +No errors +.RE +.sp +\fB1\fP +.RS 4 +Filesystem errors corrected +.RE +.sp +\fB2\fP +.RS 4 +System should be rebooted +.RE +.sp +\fB4\fP +.RS 4 +Filesystem errors left uncorrected +.RE +.sp +\fB8\fP +.RS 4 +Operational error +.RE +.sp +\fB16\fP +.RS 4 +Usage or syntax error +.RE +.sp +\fB32\fP +.RS 4 +Checking canceled by user request +.RE +.sp +\fB128\fP +.RS 4 +Shared\-library error +.RE +.sp +The exit status returned when multiple filesystems are checked is the bit\-wise OR of the exit statuses for each filesystem that is checked. +.sp +In actuality, \fBfsck\fP is simply a front\-end for the various filesystem checkers (\fBfsck\fP.\fIfstype\fP) available under Linux. The filesystem\-specific checker is searched for in the \fBPATH\fP environment variable. If the \fBPATH\fP is undefined then fallback to \fI/sbin\fP. +.sp +Please see the filesystem\-specific checker manual pages for further details. +.SH "OPTIONS" +.sp +\fB\-l\fP +.RS 4 +Create an exclusive \fBflock\fP(2) lock file (\fI/run/fsck/<diskname>.lock\fP) for whole\-disk device. This option can be used with one device only (this means that \fB\-A\fP and \fB\-l\fP are mutually exclusive). This option is recommended when more \fBfsck\fP instances are executed in the same time. The option is ignored when used for multiple devices or for non\-rotating disks. \fBfsck\fP does not lock underlying devices when executed to check stacked devices (e.g. MD or DM) \- this feature is not implemented yet. +.RE +.sp +\fB\-r\fP [\fIfd\fP] +.RS 4 +Report certain statistics for each fsck when it completes. These statistics include the exit status, the maximum run set size (in kilobytes), the elapsed all\-clock time and the user and system CPU time used by the fsck run. For example: +.sp +\fB/dev/sda1: status 0, rss 92828, real 4.002804, user 2.677592, sys 0.86186\fP +.sp +GUI front\-ends may specify a file descriptor \fIfd\fP, in which case the progress bar information will be sent to that file descriptor in a machine parsable format. For example: +.sp +\fB/dev/sda1 0 92828 4.002804 2.677592 0.86186\fP +.RE +.sp +\fB\-s\fP +.RS 4 +Serialize \fBfsck\fP operations. This is a good idea if you are checking multiple filesystems and the checkers are in an interactive mode. (Note: \fBe2fsck\fP(8) runs in an interactive mode by default. To make \fBe2fsck\fP(8) run in a non\-interactive mode, you must either specify the \fB\-p\fP or \fB\-a\fP option, if you wish for errors to be corrected automatically, or the \fB\-n\fP option if you do not.) +.RE +.sp +\fB\-t\fP \fIfslist\fP +.RS 4 +Specifies the type(s) of filesystem to be checked. When the \fB\-A\fP flag is specified, only filesystems that match \fIfslist\fP are checked. The \fIfslist\fP parameter is a comma\-separated list of filesystems and options specifiers. All of the filesystems in this comma\-separated list may be prefixed by a negation operator \(aq\fBno\fP\(aq or \(aq\fB!\fP\(aq, which requests that only those filesystems not listed in \fIfslist\fP will be checked. If none of the filesystems in \fIfslist\fP is prefixed by a negation operator, then only those listed filesystems will be checked. +.sp +Options specifiers may be included in the comma\-separated \fIfslist\fP. They must have the format \fBopts=\fP\fIfs\-option\fP. If an options specifier is present, then only filesystems which contain \fIfs\-option\fP in their mount options field of \fI/etc/fstab\fP will be checked. If the options specifier is prefixed by a negation operator, then only those filesystems that do not have \fIfs\-option\fP in their mount options field of \fI/etc/fstab\fP will be checked. +.sp +For example, if \fBopts=ro\fP appears in \fIfslist\fP, then only filesystems listed in \fI/etc/fstab\fP with the \fBro\fP option will be checked. +.sp +For compatibility with Mandrake distributions whose boot scripts depend upon an unauthorized UI change to the \fBfsck\fP program, if a filesystem type of \fBloop\fP is found in \fIfslist\fP, it is treated as if \fBopts=loop\fP were specified as an argument to the \fB\-t\fP option. +.sp +Normally, the filesystem type is deduced by searching for \fIfilesys\fP in the \fI/etc/fstab\fP file and using the corresponding entry. If the type cannot be deduced, and there is only a single filesystem given as an argument to the \fB\-t\fP option, \fBfsck\fP will use the specified filesystem type. If this type is not available, then the default filesystem type (currently ext2) is used. +.RE +.sp +\fB\-A\fP +.RS 4 +Walk through the \fI/etc/fstab\fP file and try to check all filesystems in one run. This option is typically used from the \fI/etc/rc\fP system initialization file, instead of multiple commands for checking a single filesystem. +.sp +The root filesystem will be checked first unless the \fB\-P\fP option is specified (see below). After that, filesystems will be checked in the order specified by the \fIfs_passno\fP (the sixth) field in the \fI/etc/fstab\fP file. Filesystems with a \fIfs_passno\fP value of 0 are skipped and are not checked at all. Filesystems with a \fIfs_passno\fP value of greater than zero will be checked in order, with filesystems with the lowest \fIfs_passno\fP number being checked first. If there are multiple filesystems with the same pass number, \fBfsck\fP will attempt to check them in parallel, although it will avoid running multiple filesystem checks on the same physical disk. +.sp +\fBfsck\fP does not check stacked devices (RAIDs, dm\-crypt, ...) in parallel with any other device. See below for \fBFSCK_FORCE_ALL_PARALLEL\fP setting. The \fI/sys\fP filesystem is used to determine dependencies between devices. +.sp +Hence, a very common configuration in \fI/etc/fstab\fP files is to set the root filesystem to have a \fIfs_passno\fP value of 1 and to set all other filesystems to have a \fIfs_passno\fP value of 2. This will allow \fBfsck\fP to automatically run filesystem checkers in parallel if it is advantageous to do so. System administrators might choose not to use this configuration if they need to avoid multiple filesystem checks running in parallel for some reason \- for example, if the machine in question is short on memory so that excessive paging is a concern. +.sp +\fBfsck\fP normally does not check whether the device actually exists before calling a filesystem specific checker. Therefore non\-existing devices may cause the system to enter filesystem repair mode during boot if the filesystem specific checker returns a fatal error. The \fI/etc/fstab\fP mount option \fBnofail\fP may be used to have \fBfsck\fP skip non\-existing devices. \fBfsck\fP also skips non\-existing devices that have the special filesystem type \fBauto\fP. +.RE +.sp +\fB\-C\fP [\fIfd\fP] +.RS 4 +Display completion/progress bars for those filesystem checkers (currently only for ext[234]) which support them. \fBfsck\fP will manage the filesystem checkers so that only one of them will display a progress bar at a time. GUI front\-ends may specify a file descriptor \fIfd\fP, in which case the progress bar information will be sent to that file descriptor. +.RE +.sp +\fB\-M\fP +.RS 4 +Do not check mounted filesystems and return an exit status of 0 for mounted filesystems. +.RE +.sp +\fB\-N\fP +.RS 4 +Don\(cqt execute, just show what would be done. +.RE +.sp +\fB\-P\fP +.RS 4 +When the \fB\-A\fP flag is set, check the root filesystem in parallel with the other filesystems. This is not the safest thing in the world to do, since if the root filesystem is in doubt things like the \fBe2fsck\fP(8) executable might be corrupted! This option is mainly provided for those sysadmins who don\(cqt want to repartition the root filesystem to be small and compact (which is really the right solution). +.RE +.sp +\fB\-R\fP +.RS 4 +When checking all filesystems with the \fB\-A\fP flag, skip the root filesystem. (This is useful in case the root filesystem has already been mounted read\-write.) +.RE +.sp +\fB\-T\fP +.RS 4 +Don\(cqt show the title on startup. +.RE +.sp +\fB\-V\fP +.RS 4 +Produce verbose output, including all filesystem\-specific commands that are executed. +.RE +.sp +\fB\-?\fP, \fB\-\-help\fP +.RS 4 +Display help text and exit. +.RE +.sp +\fB\-\-version\fP +.RS 4 +Display version information and exit. +.RE +.SH "FILESYSTEM SPECIFIC OPTIONS" +.sp +\fBOptions which are not understood by fsck are passed to the filesystem\-specific checker!\fP +.sp +These options \fBmust\fP not take arguments, as there is no way for \fBfsck\fP to be able to properly guess which options take arguments and which don\(cqt. +.sp +Options and arguments which follow the \fB\-\-\fP are treated as filesystem\-specific options to be passed to the filesystem\-specific checker. +.sp +Please note that \fBfsck\fP is not designed to pass arbitrarily complicated options to filesystem\-specific checkers. If you\(cqre doing something complicated, please just execute the filesystem\-specific checker directly. If you pass \fBfsck\fP some horribly complicated options and arguments, and it doesn\(cqt do what you expect, \fBdon\(cqt bother reporting it as a bug.\fP You\(cqre almost certainly doing something that you shouldn\(cqt be doing with \fBfsck\fP. Options to different filesystem\-specific fsck\(cqs are not standardized. +.SH "ENVIRONMENT" +.sp +The \fBfsck\fP program\(cqs behavior is affected by the following environment variables: +.sp +\fBFSCK_FORCE_ALL_PARALLEL\fP +.RS 4 +If this environment variable is set, \fBfsck\fP will attempt to check all of the specified filesystems in parallel, regardless of whether the filesystems appear to be on the same device. (This is useful for RAID systems or high\-end storage systems such as those sold by companies such as IBM or EMC.) Note that the \fIfs_passno\fP value is still used. +.RE +.sp +\fBFSCK_MAX_INST\fP +.RS 4 +This environment variable will limit the maximum number of filesystem checkers that can be running at one time. This allows configurations which have a large number of disks to avoid \fBfsck\fP starting too many filesystem checkers at once, which might overload CPU and memory resources available on the system. If this value is zero, then an unlimited number of processes can be spawned. This is currently the default, but future versions of \fBfsck\fP may attempt to automatically determine how many filesystem checks can be run based on gathering accounting data from the operating system. +.RE +.sp +\fBPATH\fP +.RS 4 +The \fBPATH\fP environment variable is used to find filesystem checkers. +.RE +.sp +\fBFSTAB_FILE\fP +.RS 4 +This environment variable allows the system administrator to override the standard location of the \fI/etc/fstab\fP file. It is also useful for developers who are testing \fBfsck\fP. +.RE +.sp +\fBLIBBLKID_DEBUG=all\fP +.RS 4 +enables libblkid debug output. +.RE +.sp +\fBLIBMOUNT_DEBUG=all\fP +.RS 4 +enables libmount debug output. +.RE +.SH "FILES" +.sp +\fI/etc/fstab\fP +.SH "AUTHORS" +.sp +.MTO "tytso\(atmit.edu>" "Theodore Ts\(cqo" "," +.MTO "kzak\(atredhat.com" "Karel Zak" "" +.SH "SEE ALSO" +.sp +\fBfstab\fP(5), +\fBmkfs\fP(8), +\fBfsck.ext2\fP(8) or \fBfsck.ext3\fP(8) or \fBe2fsck\fP(8), +\fBfsck.cramfs\fP(8), +\fBfsck.jfs\fP(8), +\fBfsck.nfs\fP(8), +\fBfsck.minix\fP(8), +\fBfsck.msdos\fP(8), +\fBfsck.vfat\fP(8), +\fBfsck.xfs\fP(8), +\fBreiserfsck\fP(8) +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBfsck\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/fsck.btrfs.8 b/upstream/opensuse-leap-15-6/man8/fsck.btrfs.8 new file mode 100644 index 00000000..5975f439 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/fsck.btrfs.8 @@ -0,0 +1,74 @@ +.\" Man page generated from reStructuredText. +. +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.TH "FSCK.BTRFS" "8" "Sep 13, 2023" "6.5.1" "BTRFS" +.SH NAME +fsck.btrfs \- do nothing, successfully +.SH SYNOPSIS +.sp +\fBfsck.btrfs\fP [\-aApy] [<device>...] +.SH DESCRIPTION +.sp +\fBfsck.btrfs\fP is a type of utility that should exist for any filesystem and is +called during system setup when the corresponding \fB/etc/fstab\fP entries +contain non\-zero value for \fIfs_passno\fP, see \fBfstab(5)\fP for more. +.sp +Traditional filesystems need to run their respective fsck utility in case the +filesystem was not unmounted cleanly and the log needs to be replayed before +mount. This is not needed for BTRFS. You should set fs_passno to 0. +.sp +If you wish to check the consistency of a BTRFS filesystem or repair a damaged +filesystem, see \fI\%btrfs\-check(8)\fP\&. By default filesystem consistency is checked, +the repair mode is enabled via the \fI\-\-repair\fP option (use with care!). +.SH OPTIONS +.sp +The options are all the same and detect if \fBfsck.btrfs\fP is executed in +non\-interactive mode and exits with success, otherwise prints a message about +btrfs check. +.SH EXIT STATUS +.sp +There are two possible exit codes returned: +.INDENT 0.0 +.TP +.B 0 +No error +.TP +.B 8 +Operational error, e.g. device does not exist +.UNINDENT +.SH FILES +.sp +\fB/etc/fstab\fP +.SH SEE ALSO +.sp +\fI\%btrfs(8)\fP, +\fBfsck(8)\fP, +\fBfstab(5)\fP +.\" Generated by docutils manpage writer. +. diff --git a/upstream/opensuse-leap-15-6/man8/fsck.cramfs.8 b/upstream/opensuse-leap-15-6/man8/fsck.cramfs.8 new file mode 100644 index 00000000..b99968ae --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/fsck.cramfs.8 @@ -0,0 +1,106 @@ +'\" t +.\" Title: fsck.cramfs +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "FSCK.CRAMFS" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +fsck.cramfs \- fsck compressed ROM file system +.SH "SYNOPSIS" +.sp +\fBfsck.cramfs\fP [options] \fIfile\fP +.SH "DESCRIPTION" +.sp +\fBfsck.cramfs\fP is used to check the cramfs file system. +.SH "OPTIONS" +.sp +\fB\-v\fP, \fB\-\-verbose\fP +.RS 4 +Enable verbose messaging. +.RE +.sp +\fB\-b\fP, \fB\-\-blocksize\fP \fIblocksize\fP +.RS 4 +Use this blocksize, defaults to page size. Must be equal to what was set at creation time. Only used for \fB\-\-extract\fP. +.RE +.sp +\fB\-\-extract\fP[=\fIdirectory\fP] +.RS 4 +Test to uncompress the whole file system. Optionally extract contents of the \fIfile\fP to \fIdirectory\fP. +.RE +.sp +\fB\-a\fP +.RS 4 +This option is silently ignored. +.RE +.sp +\fB\-y\fP +.RS 4 +This option is silently ignored. +.RE +.sp +\fB\-V\fP, \fB\-\-version\fP +.RS 4 +Display version information and exit. +.RE +.sp +\fB\-h\fP, \fB\-\-help\fP +.RS 4 +Display help text and exit. +.RE +.SH "EXIT STATUS" +.sp +\fB0\fP +.RS 4 +success +.RE +.sp +\fB4\fP +.RS 4 +file system was left uncorrected +.RE +.sp +\fB8\fP +.RS 4 +operation error, such as unable to allocate memory +.RE +.sp +\fB16\fP +.RS 4 +usage information was printed +.RE +.SH "SEE ALSO" +.sp +\fBmount\fP(8), +\fBmkfs.cramfs\fP(8) +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBfsck.cramfs\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/fsck.ext2.8 b/upstream/opensuse-leap-15-6/man8/fsck.ext2.8 new file mode 100644 index 00000000..68b867cf --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/fsck.ext2.8 @@ -0,0 +1,509 @@ +.\" -*- 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 E2FSCK 8 "February 2023" "E2fsprogs version 1.47.0" +.SH NAME +e2fsck \- check a Linux ext2/ext3/ext4 file system +.SH SYNOPSIS +.B e2fsck +[ +.B \-pacnyrdfkvtDFV +] +[ +.B \-b +.I superblock +] +[ +.B \-B +.I blocksize +] +[ +.BR \-l | \-L +.I bad_blocks_file +] +[ +.B \-C +.I fd +] +[ +.B \-j +.I external-journal +] +[ +.B \-E +.I extended_options +] +[ +.B \-z +.I undo_file +] +.I device +.SH DESCRIPTION +.B e2fsck +is used to check the ext2/ext3/ext4 family of file systems. +For ext3 and ext4 file systems that use a journal, if the system has been +shut down uncleanly without any errors, normally, after replaying the +committed transactions in the journal, the file system should be +marked as clean. Hence, for file systems that use journaling, +.B e2fsck +will normally replay the journal and exit, unless its superblock +indicates that further checking is required. +.PP +.I device +is a block device (e.g., +.IR /dev/sdc1 ) +or file containing the file system. +.PP +Note that in general it is not safe to run +.B e2fsck +on mounted file systems. The only exception is if the +.B \-n +option is specified, and +.BR \-c , +.BR \-l , +or +.B -L +options are +.I not +specified. However, even if it is safe to do so, the results printed by +.B e2fsck +are not valid if the file system is mounted. If +.B e2fsck +asks whether or not you should check a file system which is mounted, +the only correct answer is ``no''. Only experts who really know what +they are doing should consider answering this question in any other way. +.PP +If +.B e2fsck +is run in interactive mode (meaning that none of +.BR \-y , +.BR \-n , +or +.BR \-p +are specified), the program will ask the user to fix each problem found in the +file system. A response of 'y' will fix the error; 'n' will leave the error +unfixed; and 'a' will fix the problem and all subsequent problems; pressing +Enter will proceed with the default response, which is printed before the +question mark. Pressing Control-C terminates e2fsck immediately. +.SH OPTIONS +.TP +.B \-a +This option does the same thing as the +.B \-p +option. It is provided for backwards compatibility only; it is +suggested that people use +.B \-p +option whenever possible. +.TP +.BI \-b " superblock" +Instead of using the normal superblock, use an alternative superblock +specified by +.IR superblock . +This option is normally used when the primary superblock has been +corrupted. The location of backup superblocks is dependent on the +file system's blocksize, the number of blocks per group, and features +such as +.BR sparse_super . +.IP +Additional backup superblocks can be determined by using the +.B mke2fs +program using the +.B \-n +option to print out where the superblocks exist, supposing +.B mke2fs +is supplied with arguments that are consistent with the file system's layout +(e.g. blocksize, blocks per group, +.BR sparse_super , +etc.). +.IP +If an alternative superblock is specified and +the file system is not opened read-only, e2fsck will make sure that the +primary superblock is updated appropriately upon completion of the +file system check. +.TP +.BI \-B " blocksize" +Normally, +.B e2fsck +will search for the superblock at various different +block sizes in an attempt to find the appropriate block size. +This search can be fooled in some cases. This option forces +.B e2fsck +to only try locating the superblock at a particular blocksize. +If the superblock is not found, +.B e2fsck +will terminate with a fatal error. +.TP +.B \-c +This option causes +.B e2fsck +to use +.BR badblocks (8) +program to do a read-only scan of the device in order to find any bad +blocks. If any bad blocks are found, they are added to the bad block +inode to prevent them from being allocated to a file or directory. If +this option is specified twice, then the bad block scan will be done +using a non-destructive read-write test. +.TP +.BI \-C " fd" +This option causes +.B e2fsck +to write completion information to the specified file descriptor +so that the progress of the file system +check can be monitored. This option is typically used by programs +which are running +.BR e2fsck . +If the file descriptor number is negative, then absolute value of +the file descriptor will be used, and the progress information will be +suppressed initially. It can later be enabled by sending the +.B e2fsck +process a SIGUSR1 signal. +If the file descriptor specified is 0, +.B e2fsck +will print a completion bar as it goes about its business. This requires +that e2fsck is running on a video console or terminal. +.TP +.B \-d +Print debugging output (useless unless you are debugging +.BR e2fsck ). +.TP +.B \-D +Optimize directories in file system. This option causes e2fsck to +try to optimize all directories, either by re-indexing them if the +file system supports directory indexing, or by sorting and compressing +directories for smaller directories, or for file systems using +traditional linear directories. +.IP +Even without the +.B \-D +option, +.B e2fsck +may sometimes optimize a few directories --- for example, if +directory indexing is enabled and a directory is not indexed and would +benefit from being indexed, or if the index structures are corrupted +and need to be rebuilt. The +.B \-D +option forces all directories in the file system to be optimized. This can +sometimes make them a little smaller and slightly faster to search, but +in practice, you should rarely need to use this option. +.IP +The +.B \-D +option will detect directory entries with duplicate names in a single +directory, which e2fsck normally does not enforce for performance reasons. +.TP +.BI \-E " extended_options" +Set e2fsck extended options. Extended options are comma +separated, and may take an argument using the equals ('=') sign. The +following options are supported: +.RS 1.2i +.TP +.BI ea_ver= extended_attribute_version +Set the version of the extended attribute blocks which +.B e2fsck +will require while checking the file system. The version number may +be 1 or 2. The default extended attribute version format is 2. +.TP +.BI journal_only +Only replay the journal if required, but do not perform any further checks +or repairs. +.TP +.BI fragcheck +During pass 1, print a detailed report of any discontiguous blocks for +files in the file system. +.TP +.BI discard +Attempt to discard free blocks and unused inode blocks after the full +file system check (discarding blocks is useful on solid state devices and sparse +/ thin-provisioned storage). Note that discard is done in pass 5 AFTER the +file system has been fully checked and only if it does not contain recognizable +errors. However there might be cases where +.B e2fsck +does not fully recognize a problem and hence in this case this +option may prevent you from further manual data recovery. +.TP +.BI nodiscard +Do not attempt to discard free blocks and unused inode blocks. This option is +exactly the opposite of discard option. This is set as default. +.TP +.BI no_optimize_extents +Do not offer to optimize the extent tree by eliminating unnecessary +width or depth. This can also be enabled in the options section of +.BR /etc/e2fsck.conf . +.TP +.BI optimize_extents +Offer to optimize the extent tree by eliminating unnecessary +width or depth. This is the default unless otherwise specified in +.BR /etc/e2fsck.conf . +.TP +.BI inode_count_fullmap +Trade off using memory for speed when checking a file system with a +large number of hard-linked files. The amount of memory required is +proportional to the number of inodes in the file system. For large file +systems, this can be gigabytes of memory. (For example, a 40TB file system +with 2.8 billion inodes will consume an additional 5.7 GB memory if this +optimization is enabled.) This optimization can also be enabled in the +options section of +.BR /etc/e2fsck.conf . +.TP +.BI no_inode_count_fullmap +Disable the +.B inode_count_fullmap +optimization. This is the default unless otherwise specified in +.BR /etc/e2fsck.conf . +.TP +.BI readahead_kb +Use this many KiB of memory to pre-fetch metadata in the hopes of reducing +e2fsck runtime. By default, this is set to the size of two block groups' inode +tables (typically 4MiB on a regular ext4 file system); if this amount is more +than 1/50th of total physical memory, readahead is disabled. Set this to zero +to disable readahead entirely. +.TP +.BI bmap2extent +Convert block-mapped files to extent-mapped files. +.TP +.BI fixes_only +Only fix damaged metadata; do not optimize htree directories or compress +extent trees. This option is incompatible with the -D and -E bmap2extent +options. +.TP +.BI check_encoding +Force verification of encoded filenames in case-insensitive directories. +This is the default mode if the file system has the strict flag enabled. +.TP +.BI unshare_blocks +If the file system has shared blocks, with the shared blocks read-only feature +enabled, then this will unshare all shared blocks and unset the read-only +feature bit. If there is not enough free space then the operation will fail. +If the file system does not have the read-only feature bit, but has shared +blocks anyway, then this option will have no effect. Note when using this +option, if there is no free space to clone blocks, there is no prompt to +delete files and instead the operation will fail. +.IP +Note that unshare_blocks implies the "-f" option to ensure that all passes +are run. Additionally, if "-n" is also specified, e2fsck will simulate trying +to allocate enough space to deduplicate. If this fails, the exit code will +be non-zero. +.RE +.TP +.B \-f +Force checking even if the file system seems clean. +.TP +.B \-F +Flush the file system device's buffer caches before beginning. Only +really useful for doing +.B e2fsck +time trials. +.TP +.BI \-j " external-journal" +Set the pathname where the external-journal for this file system can be +found. +.TP +.BI \-k +When combined with the +.B \-c +option, any existing bad blocks in the bad blocks list are preserved, +and any new bad blocks found by running +.BR badblocks (8) +will be added to the existing bad blocks list. +.TP +.BI \-l " filename" +Add the block numbers listed in the file specified by +.I filename +to the list of bad blocks. The format of this file is the same as the +one generated by the +.BR badblocks (8) +program. Note that the block numbers are based on the blocksize +of the file system. Hence, +.BR badblocks (8) +must be given the blocksize of the file system in order to obtain correct +results. As a result, it is much simpler and safer to use the +.B -c +option to +.BR e2fsck , +since it will assure that the correct parameters are passed to the +.B badblocks +program. +.TP +.BI \-L " filename" +Set the bad blocks list to be the list of blocks specified by +.IR filename . +(This option is the same as the +.B \-l +option, except the bad blocks list is cleared before the blocks listed +in the file are added to the bad blocks list.) +.TP +.B \-n +Open the file system read-only, and assume an answer of `no' to all +questions. Allows +.B e2fsck +to be used non-interactively. This option +may not be specified at the same time as the +.B \-p +or +.B \-y +options. +.TP +.B \-p +Automatically repair ("preen") the file system. This option will cause +.B e2fsck +to automatically +fix any file system problems that can be safely fixed without human +intervention. If +.B e2fsck +discovers a problem which may require the system administrator +to take additional corrective action, +.B e2fsck +will print a description of the problem and then exit with the value 4 +logically or'ed into the exit code. (See the \fBEXIT CODE\fR section.) +This option is normally used by the system's boot scripts. It may not +be specified at the same time as the +.B \-n +or +.B \-y +options. +.TP +.B \-r +This option does nothing at all; it is provided only for backwards +compatibility. +.TP +.B \-t +Print timing statistics for +.BR e2fsck . +If this option is used twice, additional timing statistics are printed +on a pass by pass basis. +.TP +.B \-v +Verbose mode. +.TP +.B \-V +Print version information and exit. +.TP +.B \-y +Assume an answer of `yes' to all questions; allows +.B e2fsck +to be used non-interactively. This option +may not be specified at the same time as the +.B \-n +or +.B \-p +options. +.TP +.BI \-z " undo_file" +Before overwriting a file system block, write the old contents of the block to +an undo file. This undo file can be used with e2undo(8) to restore the old +contents of the file system should something go wrong. If the empty string is +passed as the undo_file argument, the undo file will be written to a file named +e2fsck-\fIdevice\fR.e2undo in the directory specified via the +\fIE2FSPROGS_UNDO_DIR\fR environment variable. + +WARNING: The undo file cannot be used to recover from a power or system crash. +.SH EXIT CODE +The exit code returned by +.B e2fsck +is the sum of the following conditions: +.br +\ 0\ \-\ No errors +.br +\ 1\ \-\ File system errors corrected +.br +\ 2\ \-\ File system errors corrected, system should +.br +\ \ \ \ be rebooted +.br +\ 4\ \-\ File system errors left uncorrected +.br +\ 8\ \-\ Operational error +.br +\ 16\ \-\ Usage or syntax error +.br +\ 32\ \-\ E2fsck canceled by user request +.br +\ 128\ \-\ Shared library error +.br +.SH SIGNALS +The following signals have the following effect when sent to +.BR e2fsck . +.TP +.B SIGUSR1 +This signal causes +.B e2fsck +to start displaying a completion bar or emitting progress information. +(See discussion of the +.B \-C +option.) +.TP +.B SIGUSR2 +This signal causes +.B e2fsck +to stop displaying a completion bar or emitting progress information. +.SH REPORTING BUGS +Almost any piece of software will have bugs. If you manage to find a +file system which causes +.B e2fsck +to crash, or which +.B e2fsck +is unable to repair, please report it to the author. +.PP +Please include as much information as possible in your bug report. +Ideally, include a complete transcript of the +.B e2fsck +run, so I can see exactly what error messages are displayed. (Make sure +the messages printed by +.B e2fsck +are in English; if your system has been +configured so that +.BR e2fsck 's +messages have been translated into another language, please set the the +.B LC_ALL +environment variable to +.B C +so that the transcript of e2fsck's output will be useful to me.) +If you +have a writable file system where the transcript can be stored, the +.BR script (1) +program is a handy way to save the output of +.B e2fsck +to a file. +.PP +It is also useful to send the output of +.BR dumpe2fs (8). +If a specific inode or inodes seems to be giving +.B e2fsck +trouble, try running the +.BR debugfs (8) +command and send the output of the +.BR stat (1u) +command run on the relevant inode(s). If the inode is a directory, the +.B debugfs +.I dump +command will allow you to extract the contents of the directory inode, +which can sent to me after being first run through +.BR uuencode (1). +The most useful data you can send to help reproduce +the bug is a compressed raw image dump of the file system, generated using +.BR e2image (8). +See the +.BR e2image (8) +man page for more details. +.PP +Always include the full version string which +.B e2fsck +displays when it is run, so I know which version you are running. +.SH ENVIRONMENT +.TP +.BI E2FSCK_CONFIG +Determines the location of the configuration file (see +.BR e2fsck.conf (5)). +.SH AUTHOR +This version of +.B e2fsck +was written by Theodore Ts'o <tytso@mit.edu>. +.SH SEE ALSO +.BR e2fsck.conf (5), +.BR badblocks (8), +.BR dumpe2fs (8), +.BR debugfs (8), +.BR e2image (8), +.BR mke2fs (8), +.BR tune2fs (8) diff --git a/upstream/opensuse-leap-15-6/man8/fsck.ext3.8 b/upstream/opensuse-leap-15-6/man8/fsck.ext3.8 new file mode 100644 index 00000000..68b867cf --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/fsck.ext3.8 @@ -0,0 +1,509 @@ +.\" -*- 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 E2FSCK 8 "February 2023" "E2fsprogs version 1.47.0" +.SH NAME +e2fsck \- check a Linux ext2/ext3/ext4 file system +.SH SYNOPSIS +.B e2fsck +[ +.B \-pacnyrdfkvtDFV +] +[ +.B \-b +.I superblock +] +[ +.B \-B +.I blocksize +] +[ +.BR \-l | \-L +.I bad_blocks_file +] +[ +.B \-C +.I fd +] +[ +.B \-j +.I external-journal +] +[ +.B \-E +.I extended_options +] +[ +.B \-z +.I undo_file +] +.I device +.SH DESCRIPTION +.B e2fsck +is used to check the ext2/ext3/ext4 family of file systems. +For ext3 and ext4 file systems that use a journal, if the system has been +shut down uncleanly without any errors, normally, after replaying the +committed transactions in the journal, the file system should be +marked as clean. Hence, for file systems that use journaling, +.B e2fsck +will normally replay the journal and exit, unless its superblock +indicates that further checking is required. +.PP +.I device +is a block device (e.g., +.IR /dev/sdc1 ) +or file containing the file system. +.PP +Note that in general it is not safe to run +.B e2fsck +on mounted file systems. The only exception is if the +.B \-n +option is specified, and +.BR \-c , +.BR \-l , +or +.B -L +options are +.I not +specified. However, even if it is safe to do so, the results printed by +.B e2fsck +are not valid if the file system is mounted. If +.B e2fsck +asks whether or not you should check a file system which is mounted, +the only correct answer is ``no''. Only experts who really know what +they are doing should consider answering this question in any other way. +.PP +If +.B e2fsck +is run in interactive mode (meaning that none of +.BR \-y , +.BR \-n , +or +.BR \-p +are specified), the program will ask the user to fix each problem found in the +file system. A response of 'y' will fix the error; 'n' will leave the error +unfixed; and 'a' will fix the problem and all subsequent problems; pressing +Enter will proceed with the default response, which is printed before the +question mark. Pressing Control-C terminates e2fsck immediately. +.SH OPTIONS +.TP +.B \-a +This option does the same thing as the +.B \-p +option. It is provided for backwards compatibility only; it is +suggested that people use +.B \-p +option whenever possible. +.TP +.BI \-b " superblock" +Instead of using the normal superblock, use an alternative superblock +specified by +.IR superblock . +This option is normally used when the primary superblock has been +corrupted. The location of backup superblocks is dependent on the +file system's blocksize, the number of blocks per group, and features +such as +.BR sparse_super . +.IP +Additional backup superblocks can be determined by using the +.B mke2fs +program using the +.B \-n +option to print out where the superblocks exist, supposing +.B mke2fs +is supplied with arguments that are consistent with the file system's layout +(e.g. blocksize, blocks per group, +.BR sparse_super , +etc.). +.IP +If an alternative superblock is specified and +the file system is not opened read-only, e2fsck will make sure that the +primary superblock is updated appropriately upon completion of the +file system check. +.TP +.BI \-B " blocksize" +Normally, +.B e2fsck +will search for the superblock at various different +block sizes in an attempt to find the appropriate block size. +This search can be fooled in some cases. This option forces +.B e2fsck +to only try locating the superblock at a particular blocksize. +If the superblock is not found, +.B e2fsck +will terminate with a fatal error. +.TP +.B \-c +This option causes +.B e2fsck +to use +.BR badblocks (8) +program to do a read-only scan of the device in order to find any bad +blocks. If any bad blocks are found, they are added to the bad block +inode to prevent them from being allocated to a file or directory. If +this option is specified twice, then the bad block scan will be done +using a non-destructive read-write test. +.TP +.BI \-C " fd" +This option causes +.B e2fsck +to write completion information to the specified file descriptor +so that the progress of the file system +check can be monitored. This option is typically used by programs +which are running +.BR e2fsck . +If the file descriptor number is negative, then absolute value of +the file descriptor will be used, and the progress information will be +suppressed initially. It can later be enabled by sending the +.B e2fsck +process a SIGUSR1 signal. +If the file descriptor specified is 0, +.B e2fsck +will print a completion bar as it goes about its business. This requires +that e2fsck is running on a video console or terminal. +.TP +.B \-d +Print debugging output (useless unless you are debugging +.BR e2fsck ). +.TP +.B \-D +Optimize directories in file system. This option causes e2fsck to +try to optimize all directories, either by re-indexing them if the +file system supports directory indexing, or by sorting and compressing +directories for smaller directories, or for file systems using +traditional linear directories. +.IP +Even without the +.B \-D +option, +.B e2fsck +may sometimes optimize a few directories --- for example, if +directory indexing is enabled and a directory is not indexed and would +benefit from being indexed, or if the index structures are corrupted +and need to be rebuilt. The +.B \-D +option forces all directories in the file system to be optimized. This can +sometimes make them a little smaller and slightly faster to search, but +in practice, you should rarely need to use this option. +.IP +The +.B \-D +option will detect directory entries with duplicate names in a single +directory, which e2fsck normally does not enforce for performance reasons. +.TP +.BI \-E " extended_options" +Set e2fsck extended options. Extended options are comma +separated, and may take an argument using the equals ('=') sign. The +following options are supported: +.RS 1.2i +.TP +.BI ea_ver= extended_attribute_version +Set the version of the extended attribute blocks which +.B e2fsck +will require while checking the file system. The version number may +be 1 or 2. The default extended attribute version format is 2. +.TP +.BI journal_only +Only replay the journal if required, but do not perform any further checks +or repairs. +.TP +.BI fragcheck +During pass 1, print a detailed report of any discontiguous blocks for +files in the file system. +.TP +.BI discard +Attempt to discard free blocks and unused inode blocks after the full +file system check (discarding blocks is useful on solid state devices and sparse +/ thin-provisioned storage). Note that discard is done in pass 5 AFTER the +file system has been fully checked and only if it does not contain recognizable +errors. However there might be cases where +.B e2fsck +does not fully recognize a problem and hence in this case this +option may prevent you from further manual data recovery. +.TP +.BI nodiscard +Do not attempt to discard free blocks and unused inode blocks. This option is +exactly the opposite of discard option. This is set as default. +.TP +.BI no_optimize_extents +Do not offer to optimize the extent tree by eliminating unnecessary +width or depth. This can also be enabled in the options section of +.BR /etc/e2fsck.conf . +.TP +.BI optimize_extents +Offer to optimize the extent tree by eliminating unnecessary +width or depth. This is the default unless otherwise specified in +.BR /etc/e2fsck.conf . +.TP +.BI inode_count_fullmap +Trade off using memory for speed when checking a file system with a +large number of hard-linked files. The amount of memory required is +proportional to the number of inodes in the file system. For large file +systems, this can be gigabytes of memory. (For example, a 40TB file system +with 2.8 billion inodes will consume an additional 5.7 GB memory if this +optimization is enabled.) This optimization can also be enabled in the +options section of +.BR /etc/e2fsck.conf . +.TP +.BI no_inode_count_fullmap +Disable the +.B inode_count_fullmap +optimization. This is the default unless otherwise specified in +.BR /etc/e2fsck.conf . +.TP +.BI readahead_kb +Use this many KiB of memory to pre-fetch metadata in the hopes of reducing +e2fsck runtime. By default, this is set to the size of two block groups' inode +tables (typically 4MiB on a regular ext4 file system); if this amount is more +than 1/50th of total physical memory, readahead is disabled. Set this to zero +to disable readahead entirely. +.TP +.BI bmap2extent +Convert block-mapped files to extent-mapped files. +.TP +.BI fixes_only +Only fix damaged metadata; do not optimize htree directories or compress +extent trees. This option is incompatible with the -D and -E bmap2extent +options. +.TP +.BI check_encoding +Force verification of encoded filenames in case-insensitive directories. +This is the default mode if the file system has the strict flag enabled. +.TP +.BI unshare_blocks +If the file system has shared blocks, with the shared blocks read-only feature +enabled, then this will unshare all shared blocks and unset the read-only +feature bit. If there is not enough free space then the operation will fail. +If the file system does not have the read-only feature bit, but has shared +blocks anyway, then this option will have no effect. Note when using this +option, if there is no free space to clone blocks, there is no prompt to +delete files and instead the operation will fail. +.IP +Note that unshare_blocks implies the "-f" option to ensure that all passes +are run. Additionally, if "-n" is also specified, e2fsck will simulate trying +to allocate enough space to deduplicate. If this fails, the exit code will +be non-zero. +.RE +.TP +.B \-f +Force checking even if the file system seems clean. +.TP +.B \-F +Flush the file system device's buffer caches before beginning. Only +really useful for doing +.B e2fsck +time trials. +.TP +.BI \-j " external-journal" +Set the pathname where the external-journal for this file system can be +found. +.TP +.BI \-k +When combined with the +.B \-c +option, any existing bad blocks in the bad blocks list are preserved, +and any new bad blocks found by running +.BR badblocks (8) +will be added to the existing bad blocks list. +.TP +.BI \-l " filename" +Add the block numbers listed in the file specified by +.I filename +to the list of bad blocks. The format of this file is the same as the +one generated by the +.BR badblocks (8) +program. Note that the block numbers are based on the blocksize +of the file system. Hence, +.BR badblocks (8) +must be given the blocksize of the file system in order to obtain correct +results. As a result, it is much simpler and safer to use the +.B -c +option to +.BR e2fsck , +since it will assure that the correct parameters are passed to the +.B badblocks +program. +.TP +.BI \-L " filename" +Set the bad blocks list to be the list of blocks specified by +.IR filename . +(This option is the same as the +.B \-l +option, except the bad blocks list is cleared before the blocks listed +in the file are added to the bad blocks list.) +.TP +.B \-n +Open the file system read-only, and assume an answer of `no' to all +questions. Allows +.B e2fsck +to be used non-interactively. This option +may not be specified at the same time as the +.B \-p +or +.B \-y +options. +.TP +.B \-p +Automatically repair ("preen") the file system. This option will cause +.B e2fsck +to automatically +fix any file system problems that can be safely fixed without human +intervention. If +.B e2fsck +discovers a problem which may require the system administrator +to take additional corrective action, +.B e2fsck +will print a description of the problem and then exit with the value 4 +logically or'ed into the exit code. (See the \fBEXIT CODE\fR section.) +This option is normally used by the system's boot scripts. It may not +be specified at the same time as the +.B \-n +or +.B \-y +options. +.TP +.B \-r +This option does nothing at all; it is provided only for backwards +compatibility. +.TP +.B \-t +Print timing statistics for +.BR e2fsck . +If this option is used twice, additional timing statistics are printed +on a pass by pass basis. +.TP +.B \-v +Verbose mode. +.TP +.B \-V +Print version information and exit. +.TP +.B \-y +Assume an answer of `yes' to all questions; allows +.B e2fsck +to be used non-interactively. This option +may not be specified at the same time as the +.B \-n +or +.B \-p +options. +.TP +.BI \-z " undo_file" +Before overwriting a file system block, write the old contents of the block to +an undo file. This undo file can be used with e2undo(8) to restore the old +contents of the file system should something go wrong. If the empty string is +passed as the undo_file argument, the undo file will be written to a file named +e2fsck-\fIdevice\fR.e2undo in the directory specified via the +\fIE2FSPROGS_UNDO_DIR\fR environment variable. + +WARNING: The undo file cannot be used to recover from a power or system crash. +.SH EXIT CODE +The exit code returned by +.B e2fsck +is the sum of the following conditions: +.br +\ 0\ \-\ No errors +.br +\ 1\ \-\ File system errors corrected +.br +\ 2\ \-\ File system errors corrected, system should +.br +\ \ \ \ be rebooted +.br +\ 4\ \-\ File system errors left uncorrected +.br +\ 8\ \-\ Operational error +.br +\ 16\ \-\ Usage or syntax error +.br +\ 32\ \-\ E2fsck canceled by user request +.br +\ 128\ \-\ Shared library error +.br +.SH SIGNALS +The following signals have the following effect when sent to +.BR e2fsck . +.TP +.B SIGUSR1 +This signal causes +.B e2fsck +to start displaying a completion bar or emitting progress information. +(See discussion of the +.B \-C +option.) +.TP +.B SIGUSR2 +This signal causes +.B e2fsck +to stop displaying a completion bar or emitting progress information. +.SH REPORTING BUGS +Almost any piece of software will have bugs. If you manage to find a +file system which causes +.B e2fsck +to crash, or which +.B e2fsck +is unable to repair, please report it to the author. +.PP +Please include as much information as possible in your bug report. +Ideally, include a complete transcript of the +.B e2fsck +run, so I can see exactly what error messages are displayed. (Make sure +the messages printed by +.B e2fsck +are in English; if your system has been +configured so that +.BR e2fsck 's +messages have been translated into another language, please set the the +.B LC_ALL +environment variable to +.B C +so that the transcript of e2fsck's output will be useful to me.) +If you +have a writable file system where the transcript can be stored, the +.BR script (1) +program is a handy way to save the output of +.B e2fsck +to a file. +.PP +It is also useful to send the output of +.BR dumpe2fs (8). +If a specific inode or inodes seems to be giving +.B e2fsck +trouble, try running the +.BR debugfs (8) +command and send the output of the +.BR stat (1u) +command run on the relevant inode(s). If the inode is a directory, the +.B debugfs +.I dump +command will allow you to extract the contents of the directory inode, +which can sent to me after being first run through +.BR uuencode (1). +The most useful data you can send to help reproduce +the bug is a compressed raw image dump of the file system, generated using +.BR e2image (8). +See the +.BR e2image (8) +man page for more details. +.PP +Always include the full version string which +.B e2fsck +displays when it is run, so I know which version you are running. +.SH ENVIRONMENT +.TP +.BI E2FSCK_CONFIG +Determines the location of the configuration file (see +.BR e2fsck.conf (5)). +.SH AUTHOR +This version of +.B e2fsck +was written by Theodore Ts'o <tytso@mit.edu>. +.SH SEE ALSO +.BR e2fsck.conf (5), +.BR badblocks (8), +.BR dumpe2fs (8), +.BR debugfs (8), +.BR e2image (8), +.BR mke2fs (8), +.BR tune2fs (8) diff --git a/upstream/opensuse-leap-15-6/man8/fsck.ext4.8 b/upstream/opensuse-leap-15-6/man8/fsck.ext4.8 new file mode 100644 index 00000000..68b867cf --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/fsck.ext4.8 @@ -0,0 +1,509 @@ +.\" -*- 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 E2FSCK 8 "February 2023" "E2fsprogs version 1.47.0" +.SH NAME +e2fsck \- check a Linux ext2/ext3/ext4 file system +.SH SYNOPSIS +.B e2fsck +[ +.B \-pacnyrdfkvtDFV +] +[ +.B \-b +.I superblock +] +[ +.B \-B +.I blocksize +] +[ +.BR \-l | \-L +.I bad_blocks_file +] +[ +.B \-C +.I fd +] +[ +.B \-j +.I external-journal +] +[ +.B \-E +.I extended_options +] +[ +.B \-z +.I undo_file +] +.I device +.SH DESCRIPTION +.B e2fsck +is used to check the ext2/ext3/ext4 family of file systems. +For ext3 and ext4 file systems that use a journal, if the system has been +shut down uncleanly without any errors, normally, after replaying the +committed transactions in the journal, the file system should be +marked as clean. Hence, for file systems that use journaling, +.B e2fsck +will normally replay the journal and exit, unless its superblock +indicates that further checking is required. +.PP +.I device +is a block device (e.g., +.IR /dev/sdc1 ) +or file containing the file system. +.PP +Note that in general it is not safe to run +.B e2fsck +on mounted file systems. The only exception is if the +.B \-n +option is specified, and +.BR \-c , +.BR \-l , +or +.B -L +options are +.I not +specified. However, even if it is safe to do so, the results printed by +.B e2fsck +are not valid if the file system is mounted. If +.B e2fsck +asks whether or not you should check a file system which is mounted, +the only correct answer is ``no''. Only experts who really know what +they are doing should consider answering this question in any other way. +.PP +If +.B e2fsck +is run in interactive mode (meaning that none of +.BR \-y , +.BR \-n , +or +.BR \-p +are specified), the program will ask the user to fix each problem found in the +file system. A response of 'y' will fix the error; 'n' will leave the error +unfixed; and 'a' will fix the problem and all subsequent problems; pressing +Enter will proceed with the default response, which is printed before the +question mark. Pressing Control-C terminates e2fsck immediately. +.SH OPTIONS +.TP +.B \-a +This option does the same thing as the +.B \-p +option. It is provided for backwards compatibility only; it is +suggested that people use +.B \-p +option whenever possible. +.TP +.BI \-b " superblock" +Instead of using the normal superblock, use an alternative superblock +specified by +.IR superblock . +This option is normally used when the primary superblock has been +corrupted. The location of backup superblocks is dependent on the +file system's blocksize, the number of blocks per group, and features +such as +.BR sparse_super . +.IP +Additional backup superblocks can be determined by using the +.B mke2fs +program using the +.B \-n +option to print out where the superblocks exist, supposing +.B mke2fs +is supplied with arguments that are consistent with the file system's layout +(e.g. blocksize, blocks per group, +.BR sparse_super , +etc.). +.IP +If an alternative superblock is specified and +the file system is not opened read-only, e2fsck will make sure that the +primary superblock is updated appropriately upon completion of the +file system check. +.TP +.BI \-B " blocksize" +Normally, +.B e2fsck +will search for the superblock at various different +block sizes in an attempt to find the appropriate block size. +This search can be fooled in some cases. This option forces +.B e2fsck +to only try locating the superblock at a particular blocksize. +If the superblock is not found, +.B e2fsck +will terminate with a fatal error. +.TP +.B \-c +This option causes +.B e2fsck +to use +.BR badblocks (8) +program to do a read-only scan of the device in order to find any bad +blocks. If any bad blocks are found, they are added to the bad block +inode to prevent them from being allocated to a file or directory. If +this option is specified twice, then the bad block scan will be done +using a non-destructive read-write test. +.TP +.BI \-C " fd" +This option causes +.B e2fsck +to write completion information to the specified file descriptor +so that the progress of the file system +check can be monitored. This option is typically used by programs +which are running +.BR e2fsck . +If the file descriptor number is negative, then absolute value of +the file descriptor will be used, and the progress information will be +suppressed initially. It can later be enabled by sending the +.B e2fsck +process a SIGUSR1 signal. +If the file descriptor specified is 0, +.B e2fsck +will print a completion bar as it goes about its business. This requires +that e2fsck is running on a video console or terminal. +.TP +.B \-d +Print debugging output (useless unless you are debugging +.BR e2fsck ). +.TP +.B \-D +Optimize directories in file system. This option causes e2fsck to +try to optimize all directories, either by re-indexing them if the +file system supports directory indexing, or by sorting and compressing +directories for smaller directories, or for file systems using +traditional linear directories. +.IP +Even without the +.B \-D +option, +.B e2fsck +may sometimes optimize a few directories --- for example, if +directory indexing is enabled and a directory is not indexed and would +benefit from being indexed, or if the index structures are corrupted +and need to be rebuilt. The +.B \-D +option forces all directories in the file system to be optimized. This can +sometimes make them a little smaller and slightly faster to search, but +in practice, you should rarely need to use this option. +.IP +The +.B \-D +option will detect directory entries with duplicate names in a single +directory, which e2fsck normally does not enforce for performance reasons. +.TP +.BI \-E " extended_options" +Set e2fsck extended options. Extended options are comma +separated, and may take an argument using the equals ('=') sign. The +following options are supported: +.RS 1.2i +.TP +.BI ea_ver= extended_attribute_version +Set the version of the extended attribute blocks which +.B e2fsck +will require while checking the file system. The version number may +be 1 or 2. The default extended attribute version format is 2. +.TP +.BI journal_only +Only replay the journal if required, but do not perform any further checks +or repairs. +.TP +.BI fragcheck +During pass 1, print a detailed report of any discontiguous blocks for +files in the file system. +.TP +.BI discard +Attempt to discard free blocks and unused inode blocks after the full +file system check (discarding blocks is useful on solid state devices and sparse +/ thin-provisioned storage). Note that discard is done in pass 5 AFTER the +file system has been fully checked and only if it does not contain recognizable +errors. However there might be cases where +.B e2fsck +does not fully recognize a problem and hence in this case this +option may prevent you from further manual data recovery. +.TP +.BI nodiscard +Do not attempt to discard free blocks and unused inode blocks. This option is +exactly the opposite of discard option. This is set as default. +.TP +.BI no_optimize_extents +Do not offer to optimize the extent tree by eliminating unnecessary +width or depth. This can also be enabled in the options section of +.BR /etc/e2fsck.conf . +.TP +.BI optimize_extents +Offer to optimize the extent tree by eliminating unnecessary +width or depth. This is the default unless otherwise specified in +.BR /etc/e2fsck.conf . +.TP +.BI inode_count_fullmap +Trade off using memory for speed when checking a file system with a +large number of hard-linked files. The amount of memory required is +proportional to the number of inodes in the file system. For large file +systems, this can be gigabytes of memory. (For example, a 40TB file system +with 2.8 billion inodes will consume an additional 5.7 GB memory if this +optimization is enabled.) This optimization can also be enabled in the +options section of +.BR /etc/e2fsck.conf . +.TP +.BI no_inode_count_fullmap +Disable the +.B inode_count_fullmap +optimization. This is the default unless otherwise specified in +.BR /etc/e2fsck.conf . +.TP +.BI readahead_kb +Use this many KiB of memory to pre-fetch metadata in the hopes of reducing +e2fsck runtime. By default, this is set to the size of two block groups' inode +tables (typically 4MiB on a regular ext4 file system); if this amount is more +than 1/50th of total physical memory, readahead is disabled. Set this to zero +to disable readahead entirely. +.TP +.BI bmap2extent +Convert block-mapped files to extent-mapped files. +.TP +.BI fixes_only +Only fix damaged metadata; do not optimize htree directories or compress +extent trees. This option is incompatible with the -D and -E bmap2extent +options. +.TP +.BI check_encoding +Force verification of encoded filenames in case-insensitive directories. +This is the default mode if the file system has the strict flag enabled. +.TP +.BI unshare_blocks +If the file system has shared blocks, with the shared blocks read-only feature +enabled, then this will unshare all shared blocks and unset the read-only +feature bit. If there is not enough free space then the operation will fail. +If the file system does not have the read-only feature bit, but has shared +blocks anyway, then this option will have no effect. Note when using this +option, if there is no free space to clone blocks, there is no prompt to +delete files and instead the operation will fail. +.IP +Note that unshare_blocks implies the "-f" option to ensure that all passes +are run. Additionally, if "-n" is also specified, e2fsck will simulate trying +to allocate enough space to deduplicate. If this fails, the exit code will +be non-zero. +.RE +.TP +.B \-f +Force checking even if the file system seems clean. +.TP +.B \-F +Flush the file system device's buffer caches before beginning. Only +really useful for doing +.B e2fsck +time trials. +.TP +.BI \-j " external-journal" +Set the pathname where the external-journal for this file system can be +found. +.TP +.BI \-k +When combined with the +.B \-c +option, any existing bad blocks in the bad blocks list are preserved, +and any new bad blocks found by running +.BR badblocks (8) +will be added to the existing bad blocks list. +.TP +.BI \-l " filename" +Add the block numbers listed in the file specified by +.I filename +to the list of bad blocks. The format of this file is the same as the +one generated by the +.BR badblocks (8) +program. Note that the block numbers are based on the blocksize +of the file system. Hence, +.BR badblocks (8) +must be given the blocksize of the file system in order to obtain correct +results. As a result, it is much simpler and safer to use the +.B -c +option to +.BR e2fsck , +since it will assure that the correct parameters are passed to the +.B badblocks +program. +.TP +.BI \-L " filename" +Set the bad blocks list to be the list of blocks specified by +.IR filename . +(This option is the same as the +.B \-l +option, except the bad blocks list is cleared before the blocks listed +in the file are added to the bad blocks list.) +.TP +.B \-n +Open the file system read-only, and assume an answer of `no' to all +questions. Allows +.B e2fsck +to be used non-interactively. This option +may not be specified at the same time as the +.B \-p +or +.B \-y +options. +.TP +.B \-p +Automatically repair ("preen") the file system. This option will cause +.B e2fsck +to automatically +fix any file system problems that can be safely fixed without human +intervention. If +.B e2fsck +discovers a problem which may require the system administrator +to take additional corrective action, +.B e2fsck +will print a description of the problem and then exit with the value 4 +logically or'ed into the exit code. (See the \fBEXIT CODE\fR section.) +This option is normally used by the system's boot scripts. It may not +be specified at the same time as the +.B \-n +or +.B \-y +options. +.TP +.B \-r +This option does nothing at all; it is provided only for backwards +compatibility. +.TP +.B \-t +Print timing statistics for +.BR e2fsck . +If this option is used twice, additional timing statistics are printed +on a pass by pass basis. +.TP +.B \-v +Verbose mode. +.TP +.B \-V +Print version information and exit. +.TP +.B \-y +Assume an answer of `yes' to all questions; allows +.B e2fsck +to be used non-interactively. This option +may not be specified at the same time as the +.B \-n +or +.B \-p +options. +.TP +.BI \-z " undo_file" +Before overwriting a file system block, write the old contents of the block to +an undo file. This undo file can be used with e2undo(8) to restore the old +contents of the file system should something go wrong. If the empty string is +passed as the undo_file argument, the undo file will be written to a file named +e2fsck-\fIdevice\fR.e2undo in the directory specified via the +\fIE2FSPROGS_UNDO_DIR\fR environment variable. + +WARNING: The undo file cannot be used to recover from a power or system crash. +.SH EXIT CODE +The exit code returned by +.B e2fsck +is the sum of the following conditions: +.br +\ 0\ \-\ No errors +.br +\ 1\ \-\ File system errors corrected +.br +\ 2\ \-\ File system errors corrected, system should +.br +\ \ \ \ be rebooted +.br +\ 4\ \-\ File system errors left uncorrected +.br +\ 8\ \-\ Operational error +.br +\ 16\ \-\ Usage or syntax error +.br +\ 32\ \-\ E2fsck canceled by user request +.br +\ 128\ \-\ Shared library error +.br +.SH SIGNALS +The following signals have the following effect when sent to +.BR e2fsck . +.TP +.B SIGUSR1 +This signal causes +.B e2fsck +to start displaying a completion bar or emitting progress information. +(See discussion of the +.B \-C +option.) +.TP +.B SIGUSR2 +This signal causes +.B e2fsck +to stop displaying a completion bar or emitting progress information. +.SH REPORTING BUGS +Almost any piece of software will have bugs. If you manage to find a +file system which causes +.B e2fsck +to crash, or which +.B e2fsck +is unable to repair, please report it to the author. +.PP +Please include as much information as possible in your bug report. +Ideally, include a complete transcript of the +.B e2fsck +run, so I can see exactly what error messages are displayed. (Make sure +the messages printed by +.B e2fsck +are in English; if your system has been +configured so that +.BR e2fsck 's +messages have been translated into another language, please set the the +.B LC_ALL +environment variable to +.B C +so that the transcript of e2fsck's output will be useful to me.) +If you +have a writable file system where the transcript can be stored, the +.BR script (1) +program is a handy way to save the output of +.B e2fsck +to a file. +.PP +It is also useful to send the output of +.BR dumpe2fs (8). +If a specific inode or inodes seems to be giving +.B e2fsck +trouble, try running the +.BR debugfs (8) +command and send the output of the +.BR stat (1u) +command run on the relevant inode(s). If the inode is a directory, the +.B debugfs +.I dump +command will allow you to extract the contents of the directory inode, +which can sent to me after being first run through +.BR uuencode (1). +The most useful data you can send to help reproduce +the bug is a compressed raw image dump of the file system, generated using +.BR e2image (8). +See the +.BR e2image (8) +man page for more details. +.PP +Always include the full version string which +.B e2fsck +displays when it is run, so I know which version you are running. +.SH ENVIRONMENT +.TP +.BI E2FSCK_CONFIG +Determines the location of the configuration file (see +.BR e2fsck.conf (5)). +.SH AUTHOR +This version of +.B e2fsck +was written by Theodore Ts'o <tytso@mit.edu>. +.SH SEE ALSO +.BR e2fsck.conf (5), +.BR badblocks (8), +.BR dumpe2fs (8), +.BR debugfs (8), +.BR e2image (8), +.BR mke2fs (8), +.BR tune2fs (8) diff --git a/upstream/opensuse-leap-15-6/man8/fsck.fat.8 b/upstream/opensuse-leap-15-6/man8/fsck.fat.8 new file mode 100644 index 00000000..92177a98 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/fsck.fat.8 @@ -0,0 +1,209 @@ +.\" fsck.fat.8 - manpage for fsck.fat +.\" +.\" Copyright (C) 2006-2014 Daniel Baumann <daniel@debian.org> +.\" +.\" This program is free software: you can redistribute it and/or modify +.\" it under the terms of the GNU General Public License as published by +.\" the Free Software Foundation, either version 3 of the License, or +.\" (at your option) any later version. +.\" +.\" This program is distributed in the hope that it will be useful, +.\" but WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.\" GNU General Public License for more details. +.\" +.\" You should have received a copy of the GNU General Public License +.\" along with this program. If not, see <http://www.gnu.org/licenses/>. +.\" +.\" The complete text of the GNU General Public License +.\" can be found in /usr/share/common-licenses/GPL-3 file. +.\" +.\" +.TH FSCK.FAT 8 2015\-04\-16 "dosfstools 4.1" +.SH NAME +\fBfsck.fat\fR \- check and repair MS\-DOS filesystems +.\" ---------------------------------------------------------------------------- +.SH SYNOPSIS +\fBfsck.fat\fR [\fIOPTIONS\fR] \fIDEVICE\fR +.\" ---------------------------------------------------------------------------- +.SH DESCRIPTION +\fBfsck.fat\fR verifies the consistency of MS\-DOS filesystems and optionally +tries to repair them. +.PP +The following filesystem problems can be corrected (in this order): +.IP "*" 4 +FAT contains invalid cluster numbers. +Cluster is changed to EOF. +.IP "*" 4 +File's cluster chain contains a loop. +The loop is broken. +.IP "*" 4 +Bad clusters (read errors). +The clusters are marked bad and they are removed from files owning them. +This check is optional. +.IP "*" 4 +Directories with a large number of bad entries (probably corrupt). +The directory can be deleted. +.IP "*" 4 +Files . and .. are non\-directories. +They can be deleted or renamed. +.IP "*" 4 +Directories . and .. in root directory. +They are deleted. +.IP "*" 4 +Bad filenames. +They can be renamed. +.IP "*" 4 +Duplicate directory entries. +They can be deleted or renamed. +.IP "*" 4 +Directories with non\-zero size field. +Size is set to zero. +.IP "*" 4 +Directory . does not point to parent directory. +The start pointer is adjusted. +.IP "*" 4 +Directory .. does not point to parent of parent directory. +The start pointer is adjusted. +.IP "*" 4 +Start cluster number of a file is invalid. +The file is truncated. +.IP "*" 4 +File contains bad or free clusters. +The file is truncated. +.IP "*" 4 +File's cluster chain is longer than indicated by the size fields. +The file is truncated. +.IP "*" 4 +Two or more files share the same cluster(s). +All but one of the files are truncated. +If the file being truncated is a directory file that has already been read, the +filesystem check is restarted after truncation. +.IP "*" 4 +File's cluster chain is shorter than indicated by the size fields. +The file is truncated. +.IP "*" 4 +Clusters are marked as used but are not owned by a file. +They are marked as free. +.PP +Additionally, the following problems are detected, but not repaired: +.IP "*" 4 +Invalid parameters in boot sector +.IP "*" 4 +Absence of . and .. entries in non\-root directories +.PP +When \fBfsck.fat\fR checks a filesystem, it accumulates all changes in memory +and performs them only after all checks are complete. +This can be disabled with the \fB\-w\fR option. +.\" ---------------------------------------------------------------------------- +.SH OPTIONS +.IP "\fB\-a\fR" 4 +Automatically repair the filesystem. +No user intervention is necessary. +Whenever there is more than one method to solve a problem, the least +destructive approach is used. +.IP "\fB\-A\fR" 4 +Use Atari variation of the MS\-DOS filesystem. +This is default if \fBfsck.fat\fR is run on an Atari, then this option turns +off Atari format. +There are some minor differences in Atari format: +Some boot sector fields are interpreted slightly different, and the special FAT +entries for end\-of\-file and bad cluster can be different. +Under MS\-DOS 0xfff8 is used for EOF and Atari employs 0xffff by default, but +both systems recognize all values from 0xfff8...0xffff as end\-of\-file. +MS\-DOS uses only 0xfff7 for bad clusters, where on Atari values 0xfff0...0xfff7 +are for this purpose (but the standard value is still 0xfff7). +.IP "\fB-b\fR" 4 +Make read-only boot sector check. +.IP "\fB-c\fR \fIPAGE\fR" 4 +Use DOS codepage \fIPAGE\fR to decode short file names. +By default codepage 437 is used. +.IP "\fB\-d\fR \fIPATH\fR" 4 +Delete the specified file. +If more than one file with that name exist, the first one is deleted. +This option can be given more than once. +.IP "\fB\-f\fR" 4 +Salvage unused cluster chains to files. +By default, unused clusters are added to the free disk space except in auto mode +(\fB\-a\fR). +.IP "\fB\-l\fR" 4 +List path names of files being processed. +.IP "\fB\-n\fR" 4 +No\-operation mode: non\-interactively check for errors, but don't write +anything to the filesystem. +.IP "\fB\-p\fR" 4 +Same as \fB\-a\fR, for compatibility with other *fsck. +.IP "\fB\-r\fR" 4 +Interactively repair the filesystem. +The user is asked for advice whenever there is more than one approach to fix an +inconsistency. +This is the default mode and the option is only retained for backwards +compatibility. +.IP "\fB\-t\fR" 4 +Mark unreadable clusters as bad. +.IP "\fB\-u\fR \fIPATH\fR" 4 +Try to undelete the specified file. +\fBfsck.fat\fR tries to allocate a chain of contiguous unallocated clusters +beginning with the start cluster of the undeleted file. +This option can be given more than once. +.IP "\fB\-v\fR" 4 +Verbose mode. +Generates slightly more output. +.IP "\fB\-V\fR" 4 +Perform a verification pass. +The filesystem check is repeated after the first run. +The second pass should never report any fixable errors. +It may take considerably longer than the first pass, because the first pass may +have generated long list of modifications that have to be scanned for each disk +read. +.IP "\fB\-w\fR" 4 +Write changes to disk immediately. +.IP "\fB\-y\fR" 4 +Same as \fB\-a\fR (automatically repair filesystem) for compatibility with other +fsck tools. +.\" ---------------------------------------------------------------------------- +.SH "EXIT STATUS" +.IP "0" 4 +No recoverable errors have been detected. +.IP "1" 4 +Recoverable errors have been detected or \fBfsck.fat\fR has discovered an +internal inconsistency. +.IP "2" 4 +Usage error. +\fBfsck.fat\fR did not access the filesystem. +.\" ---------------------------------------------------------------------------- +.SH FILES +.IP "fsck0000.rec, fsck0001.rec, ..." 4 +When recovering from a corrupted filesystem, \fBfsck.fat\fR dumps recovered data +into files named 'fsckNNNN.rec' in the top level directory of the filesystem. +.\" ---------------------------------------------------------------------------- +.SH BUGS +Does not create . and .. files where necessary. +Does not remove entirely empty directories. +Should give more diagnostic messages. +Undeleting files should use a more sophisticated algorithm. +.\" ---------------------------------------------------------------------------- +.SH SEE ALSO +\fBfatlabel\fR(8) +.br +\fBmkfs.fat\fR(8) +.\" ---------------------------------------------------------------------------- +.SH HOMEPAGE +The home for the \fBdosfstools\fR project is its +.UR https://github.com/dosfstools/dosfstools +GitHub project page +.UE . +.\" ---------------------------------------------------------------------------- +.SH AUTHORS +\fBdosfstools\fR were written by +.MT werner.almesberger@\:lrc.di.epfl.ch +Werner Almesberger +.ME , +.MT Roman.Hodek@\:informatik.\:uni-erlangen.de +Roman Hodek +.ME , +and others. +The current maintainer is +.MT aeb@\:debian.org +Andreas Bombe +.ME . diff --git a/upstream/opensuse-leap-15-6/man8/fsck.minix.8 b/upstream/opensuse-leap-15-6/man8/fsck.minix.8 new file mode 100644 index 00000000..13f5d74f --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/fsck.minix.8 @@ -0,0 +1,199 @@ +'\" t +.\" Title: fsck.minix +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "FSCK.MINIX" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +fsck.minix \- check consistency of Minix filesystem +.SH "SYNOPSIS" +.sp +\fBfsck.minix\fP [options] \fIdevice\fP +.SH "DESCRIPTION" +.sp +\fBfsck.minix\fP performs a consistency check for the Linux MINIX filesystem. +.sp +The program assumes the filesystem is quiescent. \fBfsck.minix\fP should not be used on a mounted device unless you can be sure nobody is writing to it. Remember that the kernel can write to device when it searches for files. +.sp +The \fIdevice\fP name will usually have the following form: +.RS 3 +.ll -.6i +.TS +allbox tab(:); +lt lt. +T{ +.sp +/dev/hda[1\-63] +T}:T{ +.sp +IDE disk 1 +T} +T{ +.sp +/dev/hdb[1\-63] +T}:T{ +.sp +IDE disk 2 +T} +T{ +.sp +/dev/sda[1\-15] +T}:T{ +.sp +SCSI disk 1 +T} +T{ +.sp +/dev/sdb[1\-15] +T}:T{ +.sp +SCSI disk 2 +T} +.TE +.sp +.br +.RE +.ll +.sp +If the filesystem was changed, i.e., repaired, then \fBfsck.minix\fP will print "FILE SYSTEM HAS CHANGED" and will \fBsync\fP(2) three times before exiting. There is \fIno\fP need to reboot after check. +.SH "WARNING" +.sp +\fBfsck.minix\fP should \fBnot\fP be used on a mounted filesystem. Using \fBfsck.minix\fP on a mounted filesystem is very dangerous, due to the possibility that deleted files are still in use, and can seriously damage a perfectly good filesystem! If you absolutely have to run \fBfsck.minix\fP on a mounted filesystem, such as the root filesystem, make sure nothing is writing to the disk, and that no files are "zombies" waiting for deletion. +.SH "OPTIONS" +.sp +\fB\-l\fP, \fB\-\-list\fP +.RS 4 +List all filenames. +.RE +.sp +\fB\-r\fP, \fB\-\-repair\fP +.RS 4 +Perform interactive repairs. +.RE +.sp +\fB\-a\fP, \fB\-\-auto\fP +.RS 4 +Perform automatic repairs. This option implies \fB\-\-repair\fP and serves to answer all of the questions asked with the default. Note that this can be extremely dangerous in the case of extensive filesystem damage. +.RE +.sp +\fB\-v\fP, \fB\-\-verbose\fP +.RS 4 +Be verbose. +.RE +.sp +\fB\-s\fP, \fB\-\-super\fP +.RS 4 +Output super\-block information. +.RE +.sp +\fB\-m\fP, \fB\-\-uncleared\fP +.RS 4 +Activate MINIX\-like "mode not cleared" warnings. +.RE +.sp +\fB\-f\fP, \fB\-\-force\fP +.RS 4 +Force a filesystem check even if the filesystem was marked as valid. Marking is done by the kernel when the filesystem is unmounted. +.RE +.sp +\fB\-V\fP, \fB\-\-version\fP +.RS 4 +Display version information and exit. +.RE +.sp +\fB\-h\fP, \fB\-\-help\fP +.RS 4 +Display help text and exit. +.RE +.SH "DIAGNOSTICS" +.sp +There are numerous diagnostic messages. The ones mentioned here are the most commonly seen in normal usage. +.sp +If the device does not exist, \fBfsck.minix\fP will print "unable to read super block". If the device exists, but is not a MINIX filesystem, \fBfsck.minix\fP will print "bad magic number in super\-block". +.SH "EXIT STATUS" +.sp +The exit status returned by \fBfsck.minix\fP is the sum of the following: +.sp +\fB0\fP +.RS 4 +No errors +.RE +.sp +\fB3\fP +.RS 4 +Filesystem errors corrected, system should be rebooted if filesystem was mounted +.RE +.sp +\fB4\fP +.RS 4 +Filesystem errors left uncorrected +.RE +.sp +\fB7\fP +.RS 4 +Combination of exit statuses 3 and 4 +.RE +.sp +\fB8\fP +.RS 4 +Operational error +.RE +.sp +\fB16\fP +.RS 4 +Usage or syntax error +.RE +.SH "AUTHORS" +.sp +.MTO "torvalds\(atcs.helsinki.fi" "Linus Torvalds" "." +Exit status values by +.MTO "faith\(atcs.unc.edu" "Rik Faith" "" +Added support for filesystem valid flag: +.MTO "greg%wind.uucp\(atplains.nodak.edu" "Dr. Wettstein" "." +Check to prevent fsck of mounted filesystem added by +.MTO "quinlan\(atyggdrasil.com" "Daniel Quinlan" "." +Minix v2 fs support by +.MTO "schwab\(atissan.informatik.uni\-dortmund.de" "Andreas Schwab" "," +updated by +.MTO "janl\(atmath.uio.no" "Nicolai Langfeldt" "." +Portability patch by +.MTO "rmk\(atecs.soton.ac.uk" "Russell King" "." +.SH "SEE ALSO" +.sp +\fBfsck\fP(8), +\fBfsck.ext2\fP(8), +\fBmkfs\fP(8), +\fBmkfs.ext2\fP(8), +\fBmkfs.minix\fP(8), +\fBreboot\fP(8) +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBfsck.minix\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/fsck.xfs.8 b/upstream/opensuse-leap-15-6/man8/fsck.xfs.8 new file mode 100644 index 00000000..a51baf7c --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/fsck.xfs.8 @@ -0,0 +1,38 @@ +.TH fsck.xfs 8 +.SH NAME +fsck.xfs \- do nothing, successfully +.SH SYNOPSIS +.B fsck.xfs +[ +.I filesys +\&... ] +.SH DESCRIPTION +.B fsck.xfs +is called by the generic Linux +.BR fsck (8) +program at startup to check and repair an XFS filesystem. +XFS is a journaling filesystem and performs recovery at +.BR mount (8) +time if necessary, so +.B fsck.xfs +simply exits with a zero exit status. +.PP +If you wish to check the consistency of an XFS filesystem, +or repair a damaged or corrupt XFS filesystem, +see +.BR xfs_repair (8). +.PP +However, the system administrator can force +.B fsck.xfs +to run +.BR xfs_repair (8) +at boot time by creating a /forcefsck file or booting the system with +"fsck.mode=force" on the kernel command line. +. +.SH FILES +.IR /etc/fstab . +.SH SEE ALSO +.BR fsck (8), +.BR fstab (5), +.BR xfs (5), +.BR xfs_repair (8). diff --git a/upstream/opensuse-leap-15-6/man8/fsfreeze.8 b/upstream/opensuse-leap-15-6/man8/fsfreeze.8 new file mode 100644 index 00000000..5647deaf --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/fsfreeze.8 @@ -0,0 +1,88 @@ +'\" t +.\" Title: fsfreeze +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "FSFREEZE" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +fsfreeze \- suspend access to a filesystem (Ext3/4, ReiserFS, JFS, XFS) +.SH "SYNOPSIS" +.sp +\fBfsfreeze\fP \fB\-\-freeze\fP|\fB\-\-unfreeze\fP \fImountpoint\fP +.SH "DESCRIPTION" +.sp +\fBfsfreeze\fP suspends or resumes access to a filesystem. +.sp +\fBfsfreeze\fP halts any new access to the filesystem and creates a stable image on disk. \fBfsfreeze\fP is intended to be used with hardware RAID devices that support the creation of snapshots. +.sp +\fBfsfreeze\fP is unnecessary for \fBdevice\-mapper\fP devices. The device\-mapper (and LVM) automatically freezes a filesystem on the device when a snapshot creation is requested. For more details see the \fBdmsetup\fP(8) man page. +.sp +The \fImountpoint\fP argument is the pathname of the directory where the filesystem is mounted. The filesystem must be mounted to be frozen (see \fBmount\fP(8)). +.sp +Note that access\-time updates are also suspended if the filesystem is mounted with the traditional atime behavior (mount option \fBstrictatime\fP, for more details see \fBmount\fP(8)). +.SH "OPTIONS" +.sp +\fB\-f\fP, \fB\-\-freeze\fP +.RS 4 +This option requests the specified a filesystem to be frozen from new modifications. When this is selected, all ongoing transactions in the filesystem are allowed to complete, new write system calls are halted, other calls which modify the filesystem are halted, and all dirty data, metadata, and log information are written to disk. Any process attempting to write to the frozen filesystem will block waiting for the filesystem to be unfrozen. +.sp +Note that even after freezing, the on\-disk filesystem can contain information on files that are still in the process of unlinking. These files will not be unlinked until the filesystem is unfrozen or a clean mount of the snapshot is complete. +.RE +.sp +\fB\-u\fP, \fB\-\-unfreeze\fP +.RS 4 +This option is used to un\-freeze the filesystem and allow operations to continue. Any filesystem modifications that were blocked by the freeze are unblocked and allowed to complete. +.RE +.sp +\fB\-V\fP, \fB\-\-version\fP +.RS 4 +Display version information and exit. +.RE +.sp +\fB\-h\fP, \fB\-\-help\fP +.RS 4 +Display help text and exit. +.RE +.SH "FILESYSTEM SUPPORT" +.sp +This command will work only if filesystem supports has support for freezing. List of these filesystems include (2016\-12\-18) \fBbtrfs\fP, \fBext2/3/4\fP, \fBf2fs\fP, \fBjfs\fP, \fBnilfs2\fP, \fBreiserfs\fP, and \fBxfs\fP. Previous list may be incomplete, as more filesystems get support. If in doubt easiest way to know if a filesystem has support is create a small loopback mount and test freezing it. +.SH "NOTES" +.sp +This man page is based on \fBxfs_freeze\fP(8). +.SH "AUTHORS" +.sp +Written by Hajime Taira. +.SH "SEE ALSO" +.sp +\fBmount\fP(8) +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBfsfreeze\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/fstrim.8 b/upstream/opensuse-leap-15-6/man8/fstrim.8 new file mode 100644 index 00000000..f67e3691 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/fstrim.8 @@ -0,0 +1,144 @@ +'\" t +.\" Title: fstrim +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "FSTRIM" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +fstrim \- discard unused blocks on a mounted filesystem +.SH "SYNOPSIS" +.sp +\fBfstrim\fP [\fB\-Aa\fP] [\fB\-o\fP \fIoffset\fP] [\fB\-l\fP \fIlength\fP] [\fB\-m\fP \fIminimum\-size\fP] [\fB\-v\fP \fImountpoint\fP] +.SH "DESCRIPTION" +.sp +\fBfstrim\fP is used on a mounted filesystem to discard (or "trim") blocks which are not in use by the filesystem. This is useful for solid\-state drives (SSDs) and thinly\-provisioned storage. +.sp +By default, \fBfstrim\fP will discard all unused blocks in the filesystem. Options may be used to modify this behavior based on range or size, as explained below. +.sp +The \fImountpoint\fP argument is the pathname of the directory where the filesystem is mounted. +.sp +Running \fBfstrim\fP frequently, or even using \fBmount \-o discard\fP, might negatively affect the lifetime of poor\-quality SSD devices. For most desktop and server systems a sufficient trimming frequency is once a week. Note that not all devices support a queued trim, so each trim command incurs a performance penalty on whatever else might be trying to use the disk at the time. +.SH "OPTIONS" +.sp +The \fIoffset\fP, \fIlength\fP, and \fIminimum\-size\fP arguments may be followed by the multiplicative suffixes KiB (=1024), MiB (=1024*1024), and so on for GiB, TiB, PiB, EiB, ZiB and YiB (the "iB" is optional, e.g., "K" has the same meaning as "KiB") or the suffixes KB (=1000), MB (=1000*1000), and so on for GB, TB, PB, EB, ZB and YB. +.sp +\fB\-A, \-\-fstab\fP +.RS 4 +Trim all mounted filesystems mentioned in \fI/etc/fstab\fP on devices that support the discard operation. The root filesystem is determined from kernel command line if missing in the file. The other supplied options, like \fB\-\-offset\fP, \fB\-\-length\fP and \fB\-\-minimum\fP, are applied to all these devices. Errors from filesystems that do not support the discard operation, read\-only devices and read\-only filesystems are silently ignored. +.RE +.sp +\fB\-a, \-\-all\fP +.RS 4 +Trim all mounted filesystems on devices that support the discard operation. The other supplied options, like \fB\-\-offset\fP, \fB\-\-length\fP and \fB\-\-minimum\fP, are applied to all these devices. Errors from filesystems that do not support the discard operation, read\-only devices and read\-only filesystems are silently ignored. +.RE +.sp +\fB\-n, \-\-dry\-run\fP +.RS 4 +This option does everything apart from actually call \fBFITRIM\fP ioctl. +.RE +.sp +\fB\-o, \-\-offset\fP \fIoffset\fP +.RS 4 +Byte offset in the filesystem from which to begin searching for free blocks to discard. The default value is zero, starting at the beginning of the filesystem. +.RE +.sp +\fB\-l, \-\-length\fP \fIlength\fP +.RS 4 +The number of bytes (after the starting point) to search for free blocks to discard. If the specified value extends past the end of the filesystem, \fBfstrim\fP will stop at the filesystem size boundary. The default value extends to the end of the filesystem. +.RE +.sp +\fB\-I, \-\-listed\-in\fP \fIlist\fP +.RS 4 +Specifies a colon\-separated list of files in fstab or kernel mountinfo format. All missing or empty files are silently ignored. The evaluation of the \fIlist\fP stops after first non\-empty file. For example: +.sp +\fB\-\-listed\-in /etc/fstab:/proc/self/mountinfo\fP. +.RE +.sp +\fB\-m, \-\-minimum\fP \fIminimum\-size\fP +.RS 4 +Minimum contiguous free range to discard, in bytes. (This value is internally rounded up to a multiple of the filesystem block size.) Free ranges smaller than this will be ignored and fstrim will adjust the minimum if it\(cqs smaller than the device\(cqs minimum, and report that (fstrim_range.minlen) back to userspace. By increasing this value, the fstrim operation will complete more quickly for filesystems with badly fragmented freespace, although not all blocks will be discarded. The default value is zero, discarding every free block. +.RE +.sp +\fB\-v, \-\-verbose\fP +.RS 4 +Verbose execution. With this option \fBfstrim\fP will output the number of bytes passed from the filesystem down the block stack to the device for potential discard. This number is a maximum discard amount from the storage device\(cqs perspective, because \fIFITRIM\fP ioctl called repeated will keep sending the same sectors for discard repeatedly. +.sp +\fBfstrim\fP will report the same potential discard bytes each time, but only sectors which had been written to between the discards would actually be discarded by the storage device. Further, the kernel block layer reserves the right to adjust the discard ranges to fit raid stripe geometry, non\-trim capable devices in a LVM setup, etc. These reductions would not be reflected in fstrim_range.len (the \fB\-\-length\fP option). +.RE +.sp +\fB\-\-quiet\-unsupported\fP +.RS 4 +Suppress error messages if trim operation (ioctl) is unsupported. This option is meant to be used in systemd service file or in cron scripts to hide warnings that are result of known problems, such as NTFS driver reporting \fIBad file descriptor\fP when device is mounted read\-only, or lack of file system support for ioctl FITRIM call. This option also cleans exit status when unsupported filesystem specified on fstrim command line. +.RE +.sp +\fB\-V\fP, \fB\-\-version\fP +.RS 4 +Display version information and exit. +.RE +.sp +\fB\-h\fP, \fB\-\-help\fP +.RS 4 +Display help text and exit. +.RE +.SH "EXIT STATUS" +.sp +0 +.RS 4 +success +.RE +.sp +1 +.RS 4 +failure +.RE +.sp +32 +.RS 4 +all failed +.RE +.sp +64 +.RS 4 +some filesystem discards have succeeded, some failed +.RE +.sp +The command \fBfstrim \-\-all\fP returns 0 (all succeeded), 32 (all failed) or 64 (some failed, some succeeded). +.SH "AUTHORS" +.sp +.MTO "lczerner\(atredhat.com" "Lukas Czerner" "," +.MTO "kzak\(atredhat.com" "Karel Zak" "" +.SH "SEE ALSO" +.sp +\fBblkdiscard\fP(8), +\fBmount\fP(8) +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBfstrim\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/getkeycodes.8 b/upstream/opensuse-leap-15-6/man8/getkeycodes.8 new file mode 100644 index 00000000..cc9b0255 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/getkeycodes.8 @@ -0,0 +1,16 @@ +.\" @(#)man/man8/getkeycodes.8 1.0 Nov 8 22:30:48 MET 1994 +.TH GETKEYCODES 8 "8 Nov 1994" "kbd" +.SH NAME +getkeycodes \- print kernel scancode-to-keycode mapping table +.SH SYNOPSIS +.B getkeycodes +.SH DESCRIPTION +The +.I getkeycodes +command prints the kernel scancode-to-keycode mapping table. +.SH OPTIONS +None. +.SH "SEE ALSO" +.BR setkeycodes (8) + + diff --git a/upstream/opensuse-leap-15-6/man8/getunimap.8 b/upstream/opensuse-leap-15-6/man8/getunimap.8 new file mode 100644 index 00000000..36df5602 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/getunimap.8 @@ -0,0 +1,65 @@ +.TH GETUNIMAP 8 "2004-01-01" "kbd" + +.SH NAME +getunimap \- dump the unicode map for the current console to stdout + +.SH SYNOPSIS +.B getunimap [ \-s ] [ \-C +.I console +] + +.SH DESCRIPTION +The +.B getunimap +program is old and obsolete. It is now part of +.B setfont (1). +.LP +The +.B getunimap +program outputs the unicode map (also called a "Screen Font Map") +for the current console to standard output. +.LP +The +.B \-C +option may be used with Linux 2.6.1 and later to get the map for +a console different from the current one. Its argument is a pathname. +.LP +The output of +.B getunimap +is of the form +.LP +.RS + 0xAA U+1234 # comment +.RE +.LP +where 0xAA is the font character code and U+1234 is a unicode character, +that if displayed, will be displayed using glyph 0xAA in the font. +Many unicode characters may be mapped to the same glyph. +.br +the Hash symbol +.B # +is used as a comment delimiter; characters after a hash sign (to the end of +the line) are comments. +.P +The +.B \-s +option will sort and merge elements, sorting on font character. +Hence, it will produce output of the form: +.LP +.RS + 0x22 U+1234 U+5678 U+3456 +.br + 0x23 U+0023 +.RE +.LP + etc., listing the multiple unicode characters that map to a font glyph. +.P +The output of +.B getunimap +is of the form accepted by +.B setfont +and +.B psfaddtable +.SH SEE ALSO +.BR psfaddtable (1), +.BR setfont (1). diff --git a/upstream/opensuse-leap-15-6/man8/gpm.8 b/upstream/opensuse-leap-15-6/man8/gpm.8 new file mode 100644 index 00000000..7224e603 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/gpm.8 @@ -0,0 +1,360 @@ +.TH GPM 8 "February 2002" +.UC 4 +.SH NAME +gpm \- a cut and paste utility and mouse server for virtual consoles +.SH SYNOPSIS +.B gpm +[ +.I options +] +.br +.SH DESCRIPTION +This package tries to be a useful +mouse server for applications running on the Linux console. It is +based on the "selection" package, and some of its code +comes from selection itself. This package is intended as a replacement +for "selection" as a cut-and-paste mechanism; it also provides +additional facilities. The "selection" +package offered the first cut-and-paste implementation for Linux using +two mouse buttons, and the cut buffer is still called "selection buffer" +or just "selection" throughout this document. +The information below is extracted from the texinfo file, which is the +preferred source of information. + +.LP +The gpm executable is meant to act like a daemon (thus, gpmd +would be a better name for it). This section is meant to describe the +command-line options for gpm, while its internals are outlined in +the next section. + +.LP +Due to restrictions in the ioctl(TIOCLINUX) system call, gpm must +be run by the superuser. The restrictions have been added in the last 1.1 +kernels to fix a security hole related to selection and screen dumping. + +.LP +The server can be configured to match the user's taste, and any +application using the mouse will inherit the server's +attitude. From release 1.02 up to 1.19.2 is was possible +for any user logged on the system console to change the mouse feeling +using the \-q option. This is no longer possible for security +reasons. + +.LP +As of 0.97 the server program puts itself in the background. To kill +gpm you can just reinvoke it with the \-k cmdline switch, +although killall gpm can be a better choice. + +.LP +.SH SPECIAL COMMANDS + +.LP +Version 1.10 adds the capability to execute special commands on +certain circumstances. Special commands default to rebooting and halting +the system, but the user can specify his/her personal choice. The +capability to invoke commands using the mouse is a handy one for +programmers, because it allows to issue a clean shutdown when the +keyboard is locked and no network is available to restore the system to +a sane state. + +.LP +Special commands are toggled by triple-clicking the left and right button -- +an unlikely event during normal mouse usage. The easiest way to triple-click +is pressing one of the buttons and triple-click the other one. When special +processing is toggled, a message appears on the console (and the speaker +beeps twice, if you have a speaker); if the user releases all the buttons +and presses one of them again within three seconds, then the special +command corresponding to the button is executed. + +.LP +The default special commands are: +.TP +left button +Reboot the system by signalling the init process +.TP +middle button (if any) +Execute /sbin/shutdown \-h now +.TP +right button +Execute /sbin/shutdown \-r now + +.LP +The \-S command line switch enables special command processing and +allows to change the three special commands. To accept the default +commands use \-S "" (i.e., specify an empty argument). To specify +your own commands, use a colon-separated list to specify commands +associated to the left, middle and right button. If any of the commands +is empty, it is interpreted as `send a signal to the init process'. This +particular operation is supported, in addition to executing external +commands, because sometimes bad bugs put the system to the impossibility +to fork; in these rare case the programmer should be able to shutdown +the system anyways, and killing init from a running process is the only +way to do it. + +.LP +As an example, \-S ":telinit 1:/sbin/halt", associates killing +init to the left button, going single user to the middle one, and halting +the system to the right button. + +.LP +System administrators should obviously be careful about special +commands, as gpm runs with superuser permissions. Special commands are +best suited for computers whose mouse can be physically accessed only by +trusted people. + +.LP +.SH COMMAND LINE OPTIONS + +.LP +Available command line options are the following: +.TP +\-a \fBaccel\fP +Set the acceleration value used when a single motion event is +longer than \fBdelta\fP (see \-d\fP). +.TP +\-A[\fBlimit\fP] +Start up with selection pasting disabled. This is intended as a +security measure; a plausible attack on a system seems to be to +stuff a nasty shell command into the selection buffer +(rm \-rf /) including the terminating line break, then all the +victim has to do is click the middle mouse button .. +As of version 1.17.2, this has developed +into a more general aging mechanism; the +gpm daemon can disable (age) selection pasting +automatically after a period of inactivity. To enable this mode +just give the optional \fBlimit\fP parameter (no space in between !) +which is interpreted as the time in seconds for which a selection is +considered valid and pastable. +As of version 1.15.7, a trivial program called +disable-paste is provided. The following makes a good +addition to /etc/profile if you allow multiple users to +work on your console. + +.LP +case $( /usr/bin/tty ) in +.br +/dev/tty[0\-9]*) /usr/bin/disable-paste ;; +.br +esac +.TP +\-b \fBbaud\fP +Set the baud rate. +.TP +\-B \fBsequence\fP +Set the button sequence. 123 is the +normal sequence, 321 can be used by left-handed people, +and 132 can be useful with two-button mice (especially within +Emacs). All the button permutations are allowable. +.TP +\-d \fBdelta\fP +Set the delta value. When a single motion event +is longer than \fBdelta\fP, \fBaccel\fP is used as a multiplying +factor. (Must be 2 or above) +.TP +\-D +Do not automatically enter background operation when started, +and log messages to the standard error stream, not the syslog +mechanism. This is useful for debugging; in previous releases +it was done with a compile-time option. +.TP +\-g \fBnumber\fP +With glidepoint devices, emulate the specified button with tapping. +\fBnumber\fP must be 1\fP, 2\fP, or 3\fP, and refers to the +button number before the \-B button remapping is performed. +This option applies to the mman and ps2 decoding. No button is +emulated by default because the ps2 tapping is incompatible with +some normal ps2 mice +.TP +\-h +Print a summary of command line options. +.TP +\-i \fBinterval\fP +Set \fBinterval\fP to be used as an upper time limit +for multiple clicks. If the interval between button-up and +button-down events is less than \fBlimit\fP, the press is considered +a double or triple click. Time is in milliseconds. +.TP +\-k +Kill a running gpm. This can be used by busmouse users to kill gpm +before running X (unless they use \-R or the single-open +limitation is removed from the kernel). +.TP +\-l \fBcharset\fP +Choose the inword() look up table. The +\fBcharset\fP argument is a list of characters. \-\fP is used to +specify a range and \\ is used to escape the next character +or to provide octal codes. +Only visible character can appear in \fBcharset\fP because control +characters can't appear in text-mode video memory, whence selection +is cut. +.TP +\-m \fBfilename\fP +Choose the mouse file to open. Must be before \-t and \-o. +.TP +\-M +Enable multiple mode. The daemon will read two different mouse devices. +Any subsequent option will refer to the second device, while any +preceding option will be used for the first device. This option +automatically forces the repeater (\-R) option on. +.TP +\-o \fBlist-of-extra-options\fP +The option works similary to the ``\-o'' option of mount; it is +used to specify a list of ``extra options'' that are specific +to each mouse type. The list is comma-separated. The options +dtr, rts or both are used by the serial +initialization to toggle the modem lines like, compatibly with +earlier gpm versions; note however that using \-o dtr +associated with non-plain-serial mouse types may now generate +an error. +And by the way, use \-o after \-m and after \-t. + +.TP +\-p +Forces the pointer to be visible while selecting. This is the +behaviour of selection-1.7, but it is sometimes confusing. +The default is not to show the pointer, which can be confusing as well. +.TP +\-r \fBnumber\fP +Set the responsiveness. A higher responsiveness is used for a faster +cursor motion. +.TP +\-R[\fBname\fP] +Causes gpm to act as a repeater: any mouse data received while +in graphic mode will be produced on the fifo /dev/gpmdata +in protocol \fBname\fP, given as an optional argument (no space in +between !). In principle, you can use the same +names as for the \-t option, although repeating into some +protocols may not be implemented for a while. +In addition, you can specify raw\fP as the \fBname\fP, to repeat +the mouse data byte by byte, without any protocol translation. +If \fBname\fP is omitted, it defaults to msc\fP. +Using gpm in repeater mode, you can configure the X +server to use its fifo as a mouse device. This option is useful for +bus-mouse owners to override the single-open limitation. It is also +an easy way to manage those stupid dual-mode mice which force you +to keep the middle button down while changing video mode. The option +is forced on by the \-M option. +.TP +\-s \fBnumber\fP +Set the sample rate for the mouse device. +.TP +\-S \fBcommands\fP +Enable special-command processing, and optionally specify custom +commands as a colon-separated list. See above for a detailed +description of special commands. +.TP +\-t \fBname\fP +Set the mouse type. Use \-t help to get a list +of allowable types. Since version 1.18.1, the list also shows +which protocols are available as repeaters (see \-R above), +by marking them with an asterisk (``*''). + +Use \-t after you selected the mouse device with \-m. +.TP +\-v +Print version information and exit. +.TP +\-2 +Force two buttons. This means that the middle button, if any, +will be taken as it was the right one. +.TP +\-3 +Force three buttons. By default the +mouse is considered to be a 2-buttons one, until the middle button +is pressed. If three buttons are there, the right one is used +to extend the selection, and the middle one is used to paste it. +Beware: if you use the \-3 option with a 2-buttons mouse, you +won't be able to paste the selection. + +.LP +.SH OPERATION + +.LP +To select text press the left mouse button and drag the mouse. +To paste text in the same or another console, press the middle button. +The right button is used to extend the selection, like in `xterm'. + +.LP +Two-button mice use the right button to paste text. + +.LP +Double and triple clicks select whole word and whole lines. Use of +the `\-p' option is recommended for best visual feedback. + +.LP +If a trailing space after the contents of a line is highlighted, and if +there is no other text on the remainder of the line, the rest of the +line will be selected automatically. If a number of lines are selected, +highlighted trailing spaces on each line will be removed from the +selection buffer. + +.LP +Any output on the virtual console holding the selection will clear the +highlighted selection from the screen, to maintain integrity of the +display, although the contents of the paste buffer will be unaffected. + +.LP +The selection mechanism is disabled if the controlling virtual console +is placed in graphics mode, for example when running X11, and is +re-enabled when text mode is resumed. (But see BUGS section below.) + +.LP +.SH BUGS +The gpm server may have problems interacting with X: if your +mouse is a single-open device (i.e. a bus mouse), you should kill +gpm before starting X, or use the \-R option (see +above). To kill gpm just invoke gpm \-k. This problem doesn't +apply to serial mice. + +.LP +Two instances of gpm can't run on the same system. If you have two mice use +the \-M option (see above). + +.LP +While the current console is in graphic mode, gpm sleeps until +text mode is back (unless \-R is used). Thus, it won't reply to +clients. Anyways, it is unlikely that mouse-eager clients will spur +out in hidden consoles. + +.LP +The clients shipped out with gpm are not updated, thus there are potential +security risks when using them. + +.LP +.SH AUTHORS +.nf +Andrew Haylett <ajh@gec-mrc.co.uk> (the original selection code) +Ian Zimmerman <itz@speakeasy.org> (old maintainer) +Alessandro Rubini <rubini@linux.it> (old maintainer (still helps a lot)) +Nico Schottelius <nico@schottelius.org> (maintainer) + +Many many contributors, to both selection and gpm. +.fi + +.LP +.SH MAINTAINERS + +.LP +The current maintainer is Nico Schottelius. But without the help of +Alessandro Rubini and the mailing list it would be impossible for me to +maintain gpm. The development mailing list can be reached under +gpm@lists.linux.it. More information on the list is in the README file part of +the source distribution of gpm. + +.LP +.SH FILES +.nf +/var/run/gpm.pid The PID of the running gpm +/dev/gpmctl A control socket for clients +/dev/gpmdata The fifo written to by a \fBrepeater\fP (`\-R') daemon. +.fi + +.LP +.SH SEE ALSO +.nf +\fB mev(1)\fP A sample client for the gpm daemon. +\fB gpm-root(1)\fP An handler for Control-Mouse events. + +.fi +The info file about `gpm', which gives more complete information and +explains how to write a gpm client. diff --git a/upstream/opensuse-leap-15-6/man8/grub2-bios-setup.8 b/upstream/opensuse-leap-15-6/man8/grub2-bios-setup.8 new file mode 100644 index 00000000..5f2bc8a3 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/grub2-bios-setup.8 @@ -0,0 +1,75 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.5. +.TH GRUB-BIOS-SETUP "8" "January 2024" "grub-bios-setup (GRUB2) 2.12" "System Administration Utilities" +.SH NAME +grub-bios-setup \- set up a device to boot using GRUB +.SH SYNOPSIS +.B grub-bios-setup +[\fI\,OPTION\/\fR...] \fI\,DEVICE\/\fR +.SH DESCRIPTION +Set up images to boot from DEVICE. +.PP +You should not normally run this program directly. Use grub\-install instead. +.TP +\fB\-a\fR, \fB\-\-allow\-floppy\fR +make the drive also bootable as floppy (default +for fdX devices). May break on some BIOSes. +.TP +\fB\-b\fR, \fB\-\-boot\-image\fR=\fI\,FILE\/\fR +use FILE as the boot image [default=boot.img] +.TP +\fB\-c\fR, \fB\-\-core\-image\fR=\fI\,FILE\/\fR +use FILE as the core image [default=core.img] +.TP +\fB\-d\fR, \fB\-\-directory\fR=\fI\,DIR\/\fR +use GRUB files in the directory DIR +[default=/boot/grub2] +.TP +\fB\-f\fR, \fB\-\-force\fR +install even if problems are detected +.TP +\fB\-m\fR, \fB\-\-device\-map\fR=\fI\,FILE\/\fR +use FILE as the device map +[default=/boot/grub2/device.map] +.TP +\fB\-\-no\-rs\-codes\fR +Do not apply any reed\-solomon codes when +embedding core.img. This option is only available +on x86 BIOS targets. +.TP +\fB\-s\fR, \fB\-\-skip\-fs\-probe\fR +do not probe for filesystems in DEVICE +.TP +\fB\-v\fR, \fB\-\-verbose\fR +print verbose messages. +.TP +\-?, \fB\-\-help\fR +give this help list +.TP +\fB\-\-usage\fR +give a short usage message +.TP +\fB\-V\fR, \fB\-\-version\fR +print program version +.PP +Mandatory or optional arguments to long options are also mandatory or optional +for any corresponding short options. +.PP +DEVICE must be an OS device (e.g. \fI\,/dev/sda\/\fP). +.SH "REPORTING BUGS" +Report bugs to <bug\-grub@gnu.org>. +.SH "SEE ALSO" +.BR grub-install (8), +.BR grub-mkimage (1), +.BR grub-mkrescue (1) +.PP +The full documentation for +.B grub-bios-setup +is maintained as a Texinfo manual. If the +.B info +and +.B grub-bios-setup +programs are properly installed at your site, the command +.IP +.B info grub-bios-setup +.PP +should give you access to the complete manual. diff --git a/upstream/opensuse-leap-15-6/man8/grub2-install.8 b/upstream/opensuse-leap-15-6/man8/grub2-install.8 new file mode 100644 index 00000000..982b42ab --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/grub2-install.8 @@ -0,0 +1,185 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.5. +.TH GRUB-INSTALL "8" "January 2024" "grub-install (GRUB2) 2.12" "System Administration Utilities" +.SH NAME +grub-install \- install GRUB to a device +.SH SYNOPSIS +.B grub-install +[\fI\,OPTION\/\fR...] [\fI\,OPTION\/\fR] [\fI\,INSTALL_DEVICE\/\fR] +.SH DESCRIPTION +Install GRUB on your drive. +.TP +\fB\-\-appended\-signature\-size\fR=\fI\,SIZE\/\fR +Add a note segment reserving SIZE bytes for an +appended signature +.TP +\fB\-\-compress\fR=\fI\,no\/\fR|xz|gz|lzo +compress GRUB files [optional] +.TP +\fB\-\-disable\-shim\-lock\fR +disable shim_lock verifier +.TP +\fB\-\-dtb\fR=\fI\,FILE\/\fR +embed a specific DTB +.TP +\fB\-d\fR, \fB\-\-directory\fR=\fI\,DIR\/\fR +use images and modules under DIR +[default=/usr/share/grub2/<platform>] +.TP +\fB\-\-fonts\fR=\fI\,FONTS\/\fR +install FONTS [default=unicode] +.TP +\fB\-\-install\-modules\fR=\fI\,MODULES\/\fR +install only MODULES and their dependencies +[default=all] +.TP +\fB\-k\fR, \fB\-\-pubkey\fR=\fI\,FILE\/\fR +embed FILE as public key for signature checking +.TP +\fB\-\-locale\-directory\fR=\fI\,DIR\/\fR use translations under DIR +[default=/usr/share/locale] +.TP +\fB\-\-locales\fR=\fI\,LOCALES\/\fR +install only LOCALES [default=all] +.TP +\fB\-\-modules\fR=\fI\,MODULES\/\fR +pre\-load specified modules MODULES +.TP +\fB\-\-sbat\fR=\fI\,FILE\/\fR +SBAT metadata +.TP +\fB\-\-themes\fR=\fI\,THEMES\/\fR +install THEMES [default=starfield] +.TP +\fB\-v\fR, \fB\-\-verbose\fR +print verbose messages. +.TP +\fB\-x\fR, \fB\-\-x509key\fR=\fI\,FILE\/\fR +embed FILE as an x509 certificate for signature +checking +.TP +\fB\-\-allow\-floppy\fR +make the drive also bootable as floppy (default +for fdX devices). May break on some BIOSes. +.TP +\fB\-\-boot\-directory\fR=\fI\,DIR\/\fR +install GRUB images under the directory DIR/grub2 +instead of the boot/grub2 directory +.TP +\fB\-\-bootloader\-id\fR=\fI\,ID\/\fR +the ID of bootloader. This option is only +available on EFI and Macs. +.TP +\fB\-\-core\-compress\fR=\fI\,xz\/\fR|none|auto +choose the compression to use for core image +.TP +\fB\-\-disk\-module\fR=\fI\,MODULE\/\fR +disk module to use (biosdisk or native). This +option is only available on BIOS target. +.TP +\fB\-\-efi\-directory\fR=\fI\,DIR\/\fR +use DIR as the EFI System Partition root. +.TP +\fB\-\-force\fR +install even if problems are detected +.TP +\fB\-\-force\-file\-id\fR +use identifier file even if UUID is available +.TP +\fB\-\-label\-bgcolor\fR=\fI\,COLOR\/\fR +use COLOR for label background +.TP +\fB\-\-label\-color\fR=\fI\,COLOR\/\fR +use COLOR for label +.TP +\fB\-\-label\-font\fR=\fI\,FILE\/\fR +use FILE as font for label +.HP +\fB\-\-macppc\-directory\fR=\fI\,DIR\/\fR use DIR for PPC MAC install. +.TP +\fB\-\-no\-bootsector\fR +do not install bootsector +.TP +\fB\-\-no\-nvram\fR +don't update the `boot\-device'/`Boot*' NVRAM +variables. This option is only available on EFI +and IEEE1275 targets. +.TP +\fB\-\-no\-rs\-codes\fR +Do not apply any reed\-solomon codes when +embedding core.img. This option is only available +on x86 BIOS targets. +.TP +\fB\-\-product\-version\fR=\fI\,STRING\/\fR +use STRING as product version +.TP +\fB\-\-recheck\fR +delete device map if it already exists +.TP +\fB\-\-removable\fR +the installation device is removable. This option +is only available on EFI. +.TP +\fB\-\-suse\-enable\-tpm\fR +install TPM modules +.TP +\fB\-\-suse\-force\-signed\fR +force installation of signed grub.This option is +only available on ARM64 EFI and powerpc targets. +.TP +\fB\-\-suse\-inhibit\-signed\fR +inhibit installation of signed grub. This option +is only available on ARM64 EFI and powerpc +targets. +.TP +\fB\-s\fR, \fB\-\-skip\-fs\-probe\fR +do not probe for filesystems in DEVICE +.TP +\fB\-\-target\fR=\fI\,TARGET\/\fR +install GRUB for TARGET platform +[default=i386\-pc]; available targets: +arm\-coreboot, arm\-efi, arm\-uboot, arm64\-efi, +i386\-coreboot, i386\-efi, i386\-ieee1275, +i386\-multiboot, i386\-pc, i386\-qemu, i386\-xen, +i386\-xen_pvh, ia64\-efi, loongarch64\-efi, +mips\-arc, mips\-qemu_mips, mipsel\-arc, +mipsel\-loongson, mipsel\-qemu_mips, +powerpc\-ieee1275, riscv32\-efi, riscv64\-efi, +s390x\-emu, sparc64\-ieee1275, x86_64\-efi, +x86_64\-xen +.TP +\fB\-\-zipl\-directory\fR=\fI\,DIR\/\fR +use DIR as the zIPL Boot Partition root. +.TP +\-?, \fB\-\-help\fR +give this help list +.TP +\fB\-\-usage\fR +give a short usage message +.TP +\fB\-V\fR, \fB\-\-version\fR +print program version +.PP +Mandatory or optional arguments to long options are also mandatory or optional +for any corresponding short options. +.PP +INSTALL_DEVICE must be system device filename. +grub\-install copies GRUB images into boot/grub2. On some platforms, it may +also install GRUB into the boot sector. +.SH "REPORTING BUGS" +Report bugs to <bug\-grub@gnu.org>. +.SH "SEE ALSO" +.BR grub-mkconfig (8), +.BR grub-mkimage (1), +.BR grub-mkrescue (1) +.PP +The full documentation for +.B grub-install +is maintained as a Texinfo manual. If the +.B info +and +.B grub-install +programs are properly installed at your site, the command +.IP +.B info grub-install +.PP +should give you access to the complete manual. diff --git a/upstream/opensuse-leap-15-6/man8/grub2-macbless.8 b/upstream/opensuse-leap-15-6/man8/grub2-macbless.8 new file mode 100644 index 00000000..55500a02 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/grub2-macbless.8 @@ -0,0 +1,43 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.5. +.TH GRUB-MACBLESS "8" "January 2024" "grub-macbless (GRUB2) 2.12" "System Administration Utilities" +.SH NAME +grub-macbless \- bless a mac file/directory +.SH SYNOPSIS +.B grub-macbless +[\fI\,OPTION\/\fR...] \fI\,--ppc PATH|--x86 FILE\/\fR +.SH DESCRIPTION +Mac\-style bless on HFS or HFS+ +.TP +\fB\-p\fR, \fB\-\-ppc\fR +bless for ppc\-based macs +.TP +\fB\-v\fR, \fB\-\-verbose\fR +print verbose messages. +.TP +\fB\-x\fR, \fB\-\-x86\fR +bless for x86\-based macs +.TP +\-?, \fB\-\-help\fR +give this help list +.TP +\fB\-\-usage\fR +give a short usage message +.TP +\fB\-V\fR, \fB\-\-version\fR +print program version +.SH "REPORTING BUGS" +Report bugs to <bug\-grub@gnu.org>. +.SH "SEE ALSO" +.BR grub-install (1) +.PP +The full documentation for +.B grub-macbless +is maintained as a Texinfo manual. If the +.B info +and +.B grub-macbless +programs are properly installed at your site, the command +.IP +.B info grub-macbless +.PP +should give you access to the complete manual. diff --git a/upstream/opensuse-leap-15-6/man8/grub2-mkconfig.8 b/upstream/opensuse-leap-15-6/man8/grub2-mkconfig.8 new file mode 100644 index 00000000..a5f5dcfa --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/grub2-mkconfig.8 @@ -0,0 +1,34 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.5. +.TH GRUB-MKCONFIG "8" "January 2024" "grub-mkconfig (GRUB2) 2.12" "System Administration Utilities" +.SH NAME +grub-mkconfig \- generate a GRUB configuration file +.SH SYNOPSIS +.B grub-mkconfig +[\fI\,OPTION\/\fR] +.SH DESCRIPTION +Generate a grub config file +.TP +\fB\-o\fR, \fB\-\-output\fR=\fI\,FILE\/\fR +output generated config to FILE [default=stdout] +.TP +\fB\-h\fR, \fB\-\-help\fR +print this message and exit +.TP +\fB\-V\fR, \fB\-\-version\fR +print the version information and exit +.SH "REPORTING BUGS" +Report bugs to <bug\-grub@gnu.org>. +.SH "SEE ALSO" +.BR grub-install (8) +.PP +The full documentation for +.B grub-mkconfig +is maintained as a Texinfo manual. If the +.B info +and +.B grub-mkconfig +programs are properly installed at your site, the command +.IP +.B info grub-mkconfig +.PP +should give you access to the complete manual. diff --git a/upstream/opensuse-leap-15-6/man8/grub2-ofpathname.8 b/upstream/opensuse-leap-15-6/man8/grub2-ofpathname.8 new file mode 100644 index 00000000..06ec60f5 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/grub2-ofpathname.8 @@ -0,0 +1,23 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.5. +.TH GRUB-OFPATHNAME "8" "January 2024" "grub-ofpathname 2.12" "System Administration Utilities" +.SH NAME +grub-ofpathname \- find OpenBOOT path for a device +.SH SYNOPSIS +.B grub-ofpathname +\fI\,DEVICE\/\fR +.SH DESCRIPTION + +.SH "SEE ALSO" +.BR grub-probe (8) +.PP +The full documentation for +.B grub-ofpathname +is maintained as a Texinfo manual. If the +.B info +and +.B grub-ofpathname +programs are properly installed at your site, the command +.IP +.B info grub-ofpathname +.PP +should give you access to the complete manual. diff --git a/upstream/opensuse-leap-15-6/man8/grub2-probe.8 b/upstream/opensuse-leap-15-6/man8/grub2-probe.8 new file mode 100644 index 00000000..e31afc65 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/grub2-probe.8 @@ -0,0 +1,62 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.5. +.TH GRUB-PROBE "8" "January 2024" "grub-probe (GRUB2) 2.12" "System Administration Utilities" +.SH NAME +grub-probe \- probe device information for GRUB +.SH SYNOPSIS +.B grub-probe +[\fI\,OPTION\/\fR...] [\fI\,OPTION\/\fR]... [\fI\,PATH|DEVICE\/\fR] +.SH DESCRIPTION +Probe device information for a given path (or device, if the \fB\-d\fR option is +given). +.TP +\fB\-0\fR +separate items in output using ASCII NUL +characters +.TP +\fB\-d\fR, \fB\-\-device\fR +given argument is a system device, not a path +.TP +\fB\-m\fR, \fB\-\-device\-map\fR=\fI\,FILE\/\fR +use FILE as the device map +[default=/boot/grub2/device.map] +.TP +\fB\-t\fR, \fB\-\-target\fR=\fI\,TARGET\/\fR +print TARGET +available targets: abstraction, arc_hints, +baremetal_hints, bios_hints, compatibility_hint, +cryptodisk_uuid, device, disk, drive, efi_hints, +fs, fs_label, fs_uuid, gpt_parttype, +hints_string, ieee1275_hints, msdos_parttype, +partmap, partuuid, zero_check [default=fs] +.TP +\fB\-v\fR, \fB\-\-verbose\fR +print verbose messages (pass twice to enable +debug printing). +.TP +\-?, \fB\-\-help\fR +give this help list +.TP +\fB\-\-usage\fR +give a short usage message +.TP +\fB\-V\fR, \fB\-\-version\fR +print program version +.PP +Mandatory or optional arguments to long options are also mandatory or optional +for any corresponding short options. +.SH "REPORTING BUGS" +Report bugs to <bug\-grub@gnu.org>. +.SH "SEE ALSO" +.BR grub-fstest (1) +.PP +The full documentation for +.B grub-probe +is maintained as a Texinfo manual. If the +.B info +and +.B grub-probe +programs are properly installed at your site, the command +.IP +.B info grub-probe +.PP +should give you access to the complete manual. diff --git a/upstream/opensuse-leap-15-6/man8/grub2-reboot.8 b/upstream/opensuse-leap-15-6/man8/grub2-reboot.8 new file mode 100644 index 00000000..2cdb2fbd --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/grub2-reboot.8 @@ -0,0 +1,44 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.5. +.TH GRUB-REBOOT "8" "January 2024" "grub-reboot (GRUB2) 2.12" "System Administration Utilities" +.SH NAME +grub-reboot \- set the default boot entry for GRUB, for the next boot only +.SH SYNOPSIS +.B grub-reboot +[\fI\,OPTION\/\fR] \fI\,MENU_ENTRY\/\fR +.SH DESCRIPTION +Set the default boot menu entry for GRUB, for the next boot only. +.TP +\fB\-h\fR, \fB\-\-help\fR +print this message and exit +.TP +\fB\-V\fR, \fB\-\-version\fR +print the version information and exit +.TP +\fB\-\-boot\-directory\fR=\fI\,DIR\/\fR +expect GRUB images under the directory DIR/grub2 +instead of the \fI\,/boot/grub2\/\fP directory +.PP +MENU_ENTRY is a number, a menu item title or a menu item identifier. Please note that menu items in +submenus or sub\-submenus require specifying the submenu components and then the +menu item component. The titles should be separated using the greater\-than +character (>) with no extra spaces. Depending on your shell some characters including > may need escaping. More information about this is available +in the GRUB Manual in the section about the 'default' command. +.PP +NOTE: In cases where GRUB cannot write to the environment block, such as when it is stored on an MDRAID or LVM device, the chosen boot menu entry will remain the default even after reboot. +.SH "REPORTING BUGS" +Report bugs to <bug\-grub@gnu.org>. +.SH "SEE ALSO" +.BR grub-set-default (8), +.BR grub-editenv (1) +.PP +The full documentation for +.B grub-reboot +is maintained as a Texinfo manual. If the +.B info +and +.B grub-reboot +programs are properly installed at your site, the command +.IP +.B info grub-reboot +.PP +should give you access to the complete manual. diff --git a/upstream/opensuse-leap-15-6/man8/grub2-set-default.8 b/upstream/opensuse-leap-15-6/man8/grub2-set-default.8 new file mode 100644 index 00000000..c99167a3 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/grub2-set-default.8 @@ -0,0 +1,39 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.5. +.TH GRUB-SET-DEFAULT "8" "January 2024" "grub-set-default (GRUB2) 2.12" "System Administration Utilities" +.SH NAME +grub-set-default \- set the saved default boot entry for GRUB +.SH SYNOPSIS +.B grub-set-default +[\fI\,OPTION\/\fR] \fI\,MENU_ENTRY\/\fR +.SH DESCRIPTION +Set the default boot menu entry for GRUB. +This requires setting GRUB_DEFAULT=saved in \fI\,/etc/default/grub\/\fP. +.TP +\fB\-h\fR, \fB\-\-help\fR +print this message and exit +.TP +\fB\-V\fR, \fB\-\-version\fR +print the version information and exit +.TP +\fB\-\-boot\-directory\fR=\fI\,DIR\/\fR +expect GRUB images under the directory DIR/grub2 +instead of the \fI\,/boot/grub2\/\fP directory +.PP +MENU_ENTRY is a number, a menu item title or a menu item identifier. +.SH "REPORTING BUGS" +Report bugs to <bug\-grub@gnu.org>. +.SH "SEE ALSO" +.BR grub-reboot (8), +.BR grub-editenv (1) +.PP +The full documentation for +.B grub-set-default +is maintained as a Texinfo manual. If the +.B info +and +.B grub-set-default +programs are properly installed at your site, the command +.IP +.B info grub-set-default +.PP +should give you access to the complete manual. diff --git a/upstream/opensuse-leap-15-6/man8/grub2-sparc64-setup.8 b/upstream/opensuse-leap-15-6/man8/grub2-sparc64-setup.8 new file mode 100644 index 00000000..96a6d237 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/grub2-sparc64-setup.8 @@ -0,0 +1,75 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.5. +.TH GRUB-SPARC64-SETUP "8" "January 2024" "grub-sparc64-setup (GRUB2) 2.12" "System Administration Utilities" +.SH NAME +grub-sparc64-setup \- set up a device to boot using GRUB +.SH SYNOPSIS +.B grub-sparc64-setup +[\fI\,OPTION\/\fR...] \fI\,DEVICE\/\fR +.SH DESCRIPTION +Set up images to boot from DEVICE. +.PP +You should not normally run this program directly. Use grub\-install instead. +.TP +\fB\-a\fR, \fB\-\-allow\-floppy\fR +make the drive also bootable as floppy (default +for fdX devices). May break on some BIOSes. +.TP +\fB\-b\fR, \fB\-\-boot\-image\fR=\fI\,FILE\/\fR +use FILE as the boot image [default=boot.img] +.TP +\fB\-c\fR, \fB\-\-core\-image\fR=\fI\,FILE\/\fR +use FILE as the core image [default=core.img] +.TP +\fB\-d\fR, \fB\-\-directory\fR=\fI\,DIR\/\fR +use GRUB files in the directory DIR +[default=/boot/grub2] +.TP +\fB\-f\fR, \fB\-\-force\fR +install even if problems are detected +.TP +\fB\-m\fR, \fB\-\-device\-map\fR=\fI\,FILE\/\fR +use FILE as the device map +[default=/boot/grub2/device.map] +.TP +\fB\-\-no\-rs\-codes\fR +Do not apply any reed\-solomon codes when +embedding core.img. This option is only available +on x86 BIOS targets. +.TP +\fB\-s\fR, \fB\-\-skip\-fs\-probe\fR +do not probe for filesystems in DEVICE +.TP +\fB\-v\fR, \fB\-\-verbose\fR +print verbose messages. +.TP +\-?, \fB\-\-help\fR +give this help list +.TP +\fB\-\-usage\fR +give a short usage message +.TP +\fB\-V\fR, \fB\-\-version\fR +print program version +.PP +Mandatory or optional arguments to long options are also mandatory or optional +for any corresponding short options. +.PP +DEVICE must be an OS device (e.g. \fI\,/dev/sda\/\fP). +.SH "REPORTING BUGS" +Report bugs to <bug\-grub@gnu.org>. +.SH "SEE ALSO" +.BR grub-install (8), +.BR grub-mkimage (1), +.BR grub-mkrescue (1) +.PP +The full documentation for +.B grub-sparc64-setup +is maintained as a Texinfo manual. If the +.B info +and +.B grub-sparc64-setup +programs are properly installed at your site, the command +.IP +.B info grub-sparc64-setup +.PP +should give you access to the complete manual. diff --git a/upstream/opensuse-leap-15-6/man8/gssd.8 b/upstream/opensuse-leap-15-6/man8/gssd.8 new file mode 100644 index 00000000..87eef024 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/gssd.8 @@ -0,0 +1,367 @@ +.\" +.\" rpc.gssd(8) +.\" +.\" Copyright (C) 2003 J. Bruce Fields <bfields@umich.edu> +.\" +.TH rpc.gssd 8 "20 Feb 2013" +.SH NAME +rpc.gssd \- RPCSEC_GSS daemon +.SH SYNOPSIS +.B rpc.gssd +.RB [ \-DfMnlvr ] +.RB [ \-k +.IR keytab ] +.RB [ \-p +.IR pipefsdir ] +.RB [ \-d +.IR ccachedir ] +.RB [ \-t +.IR timeout ] +.RB [ \-R +.IR realm ] +.SH INTRODUCTION +The RPCSEC_GSS protocol, defined in RFC 5403, is used to provide +strong security for RPC-based protocols such as NFS. +.P +Before exchanging RPC requests using RPCSEC_GSS, an RPC client must +establish a GSS +.IR "security context" . +A security context is shared state on each +end of a network transport that enables GSS-API security services. +.P +Security contexts are established using +.IR "security credentials" . +A credential grants temporary access to a secure network service, +much as a railway ticket grants temporary access to use a rail service. +.P +A user typically obtains a credential by providing a password to the +.BR kinit (1) +command, or via a PAM library at login time. +A credential acquired with a +.I user principal +is known as a +.I user credential +(see +.BR kerberos (1) +for more on principals). +.P +For certain operations, a credential is required +which represents no user, +is otherwise unprivileged, +and is always available. +This is referred to as a +.IR "machine credential" . +.P +Machine credentials are typically established using a +.IR "service principal" , +whose encrypted password, called its +.IR key , +is stored in a file, called a +.IR keytab , +to avoid requiring a user prompt. +A machine credential effectively does not expire because the system +can renew it as needed without user intervention. +.P +Once obtained, credentials are typically stored in local temporary files +with well-known pathnames. +.SH DESCRIPTION +To establish GSS security contexts using these credential files, +the Linux kernel RPC client depends on a userspace daemon called +.BR rpc.gssd . +The +.B rpc.gssd +daemon uses the rpc_pipefs filesystem to communicate with the kernel. +.SS User Credentials +When a user authenticates using a command such as +.BR kinit (1), +the resulting credential is stored in a file with a well-known name +constructed using the user's UID. +.P +To interact with an NFS server +on behalf of a particular Kerberos-authenticated user, +the Linux kernel RPC client requests that +.B rpc.gssd +initialize a security context with the credential +in that user's credential file. +.P +Typically, credential files are placed in +.IR /tmp . +However, +.B rpc.gssd +can search for credential files in more than one directory. +See the description of the +.B -d +option for details. +.SS Machine Credentials +A user credential is established by a user and +is then shared with the kernel and +.BR rpc.gssd . +A machine credential is established by +.B rpc.gssd +for the kernel when there is no user. +Therefore +.B rpc.gssd +must already have the materials on hand to establish this credential +without requiring user intervention. +.P +.B rpc.gssd +searches the local system's keytab for a principal and key to use +to establish the machine credential. +By default, +.B rpc.gssd +assumes the file +.I /etc/krb5.keytab +contains principals and keys that can be used to obtain machine credentials. +.P +.B rpc.gssd +searches in the following order for a principal to use. +The first matching credential is used. +For the search, <hostname> and <REALM> are replaced with the local +system's hostname and Kerberos realm. +.sp + <HOSTNAME>$@<REALM> +.br + root/<hostname>@<REALM> +.br + nfs/<hostname>@<REALM> +.br + host/<hostname>@<REALM> +.br + root/<anyname>@<REALM> +.br + nfs/<anyname>@<REALM> +.br + host/<anyname>@<REALM> +.sp +The <anyname> entries match on the service name and realm, but ignore the hostname. +These can be used if a principal matching the local host's name is not found. +.P +Note that the first principal in the search order is a user principal +that enables Kerberized NFS when the local system is joined +to an Active Directory domain using Samba. +A password for this principal must be provided in the local system's keytab. +.P +You can specify another keytab by using the +.B -k +option if +.I /etc/krb5.keytab +does not exist or does not provide one of these principals. +.SS Credentials for UID 0 +UID 0 is a special case. +By default +.B rpc.gssd +uses the system's machine credentials for UID 0 accesses +that require GSS authentication. +This limits the privileges of the root user +when accessing network resources that require authentication. +.P +Specify the +.B -n +option when starting +.B rpc.gssd +if you'd like to force the root user to obtain a user credential +rather than use the local system's machine credential. +.P +When +.B -n +is specified, +the kernel continues to request a GSS context established +with a machine credential for NFSv4 operations, +such as SETCLIENTID or RENEW, that manage state. +If +.B rpc.gssd +cannot obtain a machine credential (say, the local system has +no keytab), NFSv4 operations that require machine credentials will fail. +.SS Encryption types +A realm administrator can choose to add keys encoded in a number of different +encryption types to the local system's keytab. +For instance, a host/ principal might have keys for the +.BR aes256-cts-hmac-sha1-96 , +.BR aes128-cts-hmac-sha1-96 , +.BR des3-cbc-sha1 ", and" +.BR arcfour-hmac " encryption types." +This permits +.B rpc.gssd +to choose an appropriate encryption type that the target NFS server +supports. +.P +These encryption types are stronger than legacy single-DES encryption types. +To interoperate in environments where servers support +only weak encryption types, +you can restrict your client to use only single-DES encryption types +by specifying the +.B -l +option when starting +.BR rpc.gssd . +.SH OPTIONS +.TP +.B \-D +The server name passed to GSSAPI for authentication is normally the +name exactly as requested. e.g. for NFS +it is the server name in the "servername:/path" mount request. Only if this +servername appears to be an IP address (IPv4 or IPv6) or an +unqualified name (no dots) will a reverse DNS lookup +will be performed to get the canoncial server name. + +If +.B \-D +is present, a reverse DNS lookup will +.I always +be used, even if the server name looks like a canonical name. So it +is needed if partially qualified, or non canonical names are regularly +used. + +Using +.B \-D +can introduce a security vulnerability, so it is recommended that +.B \-D +not be used, and that canonical names always be used when requesting +services. +.TP +.B -f +Runs +.B rpc.gssd +in the foreground and sends output to stderr (as opposed to syslogd) +.TP +.B -n +When specified, UID 0 is forced to obtain user credentials +which are used instead of the local system's machine credentials. +.TP +.BI "-k " keytab +Tells +.B rpc.gssd +to use the keys found in +.I keytab +to obtain machine credentials. +The default value is +.IR /etc/krb5.keytab . +.TP +.B -l +When specified, restricts +.B rpc.gssd +to sessions to weak encryption types such as +.BR des-cbc-crc . +This option is available only when the local system's Kerberos library +supports settable encryption types. +.TP +.BI "-p " path +Tells +.B rpc.gssd +where to look for the rpc_pipefs filesystem. The default value is +.IR /var/lib/nfs/rpc_pipefs . +.TP +.BI "-d " search-path +This option specifies a colon separated list of directories that +.B rpc.gssd +searches for credential files. The default value is +.IR /tmp:/run/user/%U . +The literal sequence "%U" can be specified to substitue the UID +of the user for whom credentials are being searched. +.TP +.B -M +By default, machine credentials are stored in files in the first +directory in the credential directory search path (see the +.B -d +option). When +.B -M +is set, +.B rpc.gssd +stores machine credentials in memory instead. +.TP +.B -v +Increases the verbosity of the output (can be specified multiple times). +.TP +.B -r +If the RPCSEC_GSS library supports setting debug level, +increases the verbosity of the output (can be specified multiple times). +.TP +.BI "-R " realm +Kerberos tickets from this +.I realm +will be preferred when scanning available credentials cache files to be +used to create a context. By default, the default realm, as configured +in the Kerberos configuration file, is preferred. +.TP +.BI "-t " timeout +Timeout, in seconds, for kernel GSS contexts. This option allows you to force +new kernel contexts to be negotiated after +.I timeout +seconds, which allows changing Kerberos tickets and identities frequently. +The default is no explicit timeout, which means the kernel context will live +the lifetime of the Kerberos service ticket used in its creation. +.TP +.B -T timeout +Timeout, in seconds, to create an RPC connection with a server while +establishing an authenticated gss context for a user. +The default timeout is set to 5 seconds. +If you get messages like "WARNING: can't create tcp rpc_clnt to server +%servername% for user with uid %uid%: RPC: Remote system error - +Connection timed out", you should consider an increase of this timeout. +.SH CONFIGURATION FILE +Many of the options that can be set on the command line can also be +controlled through values set in the +.B [gssd] +section of the +.I /etc/nfs.conf +configuration file. Values recognized include: +.TP +.B use-memcache +A Boolean flag equivalent to +.BR -M . +.TP +.B use-machine-creds +A Boolean flag. Setting to +.B false +is equivalent to giving the +.B -n +flag. +.TP +.B avoid-dns +Setting to +.B false +is equivalent to providing the +.B -D +flag. +.TP +.B limit-to-legacy-enctypes +Equivalent to +.BR -l . +.TP +.B context-timeout +Equivalent to +.BR -T . +.TP +.B rpc-timeout +Equivalent to +.BR -t . +.TP +.B pipefs-directory +Equivalent to +.BR -p . +.TP +.B keytab-file +Equivalent to +.BR -k . +.TP +.BR cred-cache-directory +Equivalent to +.BR -d . +.TP +.B preferred-realm +Equivalent to +.BR -R . + +.SH SEE ALSO +.BR rpc.svcgssd (8), +.BR kerberos (1), +.BR kinit (1), +.BR krb5.conf (5) +.SH AUTHORS +.br +Dug Song <dugsong@umich.edu> +.br +Andy Adamson <andros@umich.edu> +.br +Marius Aamodt Eriksen <marius@umich.edu> +.br +J. Bruce Fields <bfields@umich.edu> diff --git a/upstream/opensuse-leap-15-6/man8/hdparm.8 b/upstream/opensuse-leap-15-6/man8/hdparm.8 new file mode 100644 index 00000000..908fa9c1 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/hdparm.8 @@ -0,0 +1,911 @@ +.TH HDPARM 8 "May 2021" "Version 9.62" + +.SH NAME +hdparm \- get/set SATA/IDE device parameters +.SH SYNOPSIS +.B hdparm +[options] [device ...] +.SH DESCRIPTION +.BI hdparm +provides a command line interface to various kernel interfaces +supported by the Linux SATA/PATA/SAS "libata" subsystem +and the older IDE driver subsystem. Many newer (2008 and later) +USB drive enclosures now also support "SAT" (SCSI-ATA Command Translation) +and therefore may also work with hdparm. E.g. recent WD "Passport" models +and recent NexStar-3 enclosures. +Some options may work correctly only with the latest kernels. +.SH OPTIONS +When no options are given, +.B -acdgkmur +is assumed. +For "Get/set" options, a query without the optional parameter (e.g. \-d) will query (get) +the device state, and with a parameter (e.g., \-d0) will set the device state. +.TP +.I -a +Get/set sector count for filesystem (software) read-ahead. +This is used to improve performance in sequential reads of large files, +by prefetching additional +blocks in anticipation of them being needed by the running task. +Many IDE drives also have a separate built-in read-ahead function, +which augments this filesystem (software) read-ahead function. +.TP +.I -A +Get/set the IDE drive\'s read-lookahead feature (usually ON by default). +Usage: +.B -A0 +(disable) or +.B -A1 +(enable). +.TP +.I -b +Get/set bus state. +.TP +.I -B +Get/set Advanced Power Management feature, if the drive supports it. A low value +means aggressive power management and a high value means better performance. +Possible settings range from values 1 through 127 (which permit spin-down), +and values 128 through 254 (which do not permit spin-down). +The highest degree of power management is attained with a setting of 1, +and the highest I/O performance with a setting of 254. +A value of 255 tells hdparm to disable Advanced Power Management altogether +on the drive (not all drives support disabling it, but most do). +.TP +.I -c +Get/set (E)IDE 32-bit I/O support. A numeric parameter can be +used to enable/disable 32-bit I/O support. +Currently supported values include +.B 0 +to disable 32-bit I/O support, +.B 1 +to enable 32-bit data transfers, and +.B 3 +to enable 32-bit data transfers with a special +.B sync +sequence required by many chipsets. The value +.B 3 +works with nearly all +32-bit IDE chipsets, but incurs slightly more overhead. +Note that "32-bit" refers to data transfers across a PCI or VLB bus to the +interface card only; all (E)IDE drives still have only a 16-bit connection +over the ribbon cable from the interface card. +.TP +.I -C +Check the current IDE power mode status, which will always be one of +.B unknown +(drive does not support this command), +.B active/idle +(normal operation), +.B standby +(low power mode, drive has spun down), +or +.B sleeping +(lowest power mode, drive is completely shut down). +The +.B -S, -y, -Y, +and +.B -Z +options can be used to manipulate the IDE power modes. +.TP +.I -d +Get/set the "using_dma" flag for this drive. This option now works +with most combinations of drives and PCI interfaces which support DMA +and which are known to the kernel IDE driver. +It is also a good idea to use the appropriate +.B -X +option in combination with +.B -d1 +to ensure that the drive itself is programmed for the correct DMA mode, +although most BIOSs should do this for you at boot time. +Using DMA nearly always gives the best performance, +with fast I/O throughput and low CPU usage. +But there are at least a few configurations of chipsets and drives +for which DMA does not make much of a difference, or may even slow +things down (on really messed up hardware!). Your mileage may vary. +.TP +.I --dco-freeze +DCO stands for Device Configuration Overlay, a way for vendors to selectively +disable certain features of a drive. The +.B --dco-freeze +option will freeze/lock the current drive configuration, +thereby preventing software (or malware) +from changing any DCO settings until after the next power-on reset. +.TP +.I --dco-identify +Query and dump information regarding drive configuration settings +which can be disabled by the vendor or OEM installer. +These settings show capabilities of the drive which might be disabled +by the vendor for "enhanced compatibility". +When disabled, they are otherwise hidden and will not show in the +.B -I +identify output. For example, system vendors sometimes disable 48_bit +addressing on large drives, for compatibility (and loss of capacity) +with a specific BIOS. In such cases, +.B --dco-identify +will show that the drive is 48_bit capable, but +.B -I +will not show it, and nor will the drive accept 48_bit commands. +.TP +.I --dco-restore +Reset all drive settings, features, and accessible capacities back to factory defaults +and full capabilities. This command will fail if DCO is frozen/locked, +or if a +.B -Np +maximum size restriction has also been set. +This is +.B EXTREMELY DANGEROUS +and will very likely cause massive loss of data. +.B DO NOT USE THIS COMMAND. +.TP +.I --direct +Use the kernel\'s "O_DIRECT" flag when performing a +.B -t +timing test. This bypasses the page cache, causing the reads +to go directly from the drive into hdparm's buffers, using so-called +"raw" I/O. In many cases, this can produce results that appear +much faster than the usual page cache method, giving a better indication +of raw device and driver performance. +.TP +.I --drq-hsm-error +.B VERY DANGEROUS, DON'T EVEN THINK ABOUT USING IT. +This option causes hdparm to issue an IDENTIFY command +to the kernel, but incorrectly marked as a "non-data" command. +This results in the drive being left with its DataReQust(DRQ) line +"stuck" high. This confuses the kernel drivers, and may crash the system +immediately with massive data loss. The option exists to help in testing +and fortifying the kernel against similar real-world drive malfunctions. +.B VERY DANGEROUS, DO NOT USE!! +.TP +.I -D +Enable/disable the on-drive defect management feature, +whereby the drive firmware tries to automatically manage +defective sectors by relocating them to "spare" sectors +reserved by the factory for such. Control of this feature +via the +.B -D +option is not supported for most modern drives +since ATA-4; thus this command may fail. +.TP +.I -E +Set cd/dvd drive speed. This is NOT necessary for regular operation, +as the drive will automatically switch speeds on its own. +But if you want to play with it, just supply a speed number +after the option, usually a number like 2 or 4. +This can be useful in some cases, though, to smooth out DVD video playback. +.TP +.I -f +Sync and flush the buffer cache for the device on exit. +This operation is also performed internally as part of the +.B -t +and +.B -T +timings and other options. +.TP +.I --fallocate +This option currently works only on ext4 and xfs filesystem types. +When used, this must be the only option given. +It requires two parameters: the desired file size in kilo-bytes +(byte count divided by 1024), followed by the pathname for the new file. +It will create a new file of the specified size, +but without actually having to write any data to the file. +This will normally complete very quickly, and without thrashing the storage device. +.IP +E.g. Create a 10KByte file: +.B hdparm --fallocate 10 temp_file +.TP +.I --fibmap +When used, this must be the only option given. +It requires a file path as a parameter, and will print +out a list of the block extents (sector ranges) +occupied by that file on disk. +Sector numbers are given as absolute LBA numbers, +referenced from sector 0 of the physical device rather +than from the partition or filesystem. +This information can then be used for a variety of purposes, +such as examining the degree of fragmenation of larger files, or +determining appropriate sectors to deliberately corrupt +during fault-injection testing procedures. +.IP +This option uses the new FIEMAP (file extent map) ioctl() when available, +and falls back to the older FIBMAP (file block map) ioctl() otherwise. +Note that FIBMAP suffers from a 32-bit block-number interface, +and thus not work beyond 8TB or 16TB. FIBMAP is also very slow, +and does not deal well with preallocated uncommitted extents +in ext4/xfs filesystems, unless a sync() is done before using this option. +.TP +.I --fwdownload +When used, this should be the only option given. +It requires a file path immediately after the +option, indicating where the new drive firmware should be read from. +The contents of this file will be sent to the drive using the +(S)ATA +.B DOWNLOAD MICROCODE +command, using either transfer protocol 7 (entire file at once), +or, if the drive supports it, transfer protocol 3 (segmented download). +This command is +.B EXTREMELY DANGEROUS +and could destroy both the drive and all data on it. +.B DO NOT USE THIS COMMAND. +The +.B --fwdownload-mode3 +, +.B --fwdownload-mode3-max +, and +.B --fwdownload-mode7 +variations on basic +.B --fwdownload +allow overriding automatic protocol detection in favour of +forcing hdparm to use a specific transfer protocol, for testing purposes only. +.TP +.I -F +Flush the on-drive write cache buffer (older drives may not implement this). +.TP +.I -g +Display the drive geometry (cylinders, heads, sectors), +the size (in sectors) of the device, +and the starting offset (in sectors) of the device from +the beginning of the drive. +.TP +.I -h +Display terse usage information (help). +.TP +.I -H +Read the temperature from some (mostly Hitachi) drives. +Also reports if the temperature is within operating condition range +(this may not be reliable). Does not cause the drive to spin up if idle. +.TP +.I -i +Display the identification info which the kernel drivers (IDE, libata) +have stored from boot/configuration time. This may differ from the +current information obtainable directly from the drive itself +with the +.B -I +option. +The data returned may or may not be current, depending on activity +since booting the system. +For a more detailed interpretation of the identification info, +refer to +.I AT Attachment Interface for Disk Drives, +ANSI ASC X3T9.2 working draft, revision 4a, April 19/93, and later editions. +.TP +.I --idle-immediate +Issue an ATA IDLE_IMMEDIATE command, to put the drive into a lower power state. +Usually the device remains spun-up. +.TP +.I --idle-unload +Issue an ATA IDLE_IMMEDIATE_WITH_UNLOAD command, to unload or park the heads +and put the drive into a lower power state. Usually the device remains spun-up. +.TP +.I -I +Request identification info directly from the drive, +which is displayed in a new expanded format with considerably +more detail than with the older +.B -i +option. +.TP +.I --Iraw <pathname> +This option dumps the drive's identify data in raw binary to the specified file. +.TP +.I --Istdin +This is a special variation on the +.B -I +option, +which accepts a drive identification block as standard input +instead of using a /dev/hd* parameter. +The format of this block must be +.B exactly +the same as that found in the /proc/ide/*/hd*/identify "files", +or that produced by the +.B --Istdout +option described below. +This variation is designed for use with collected "libraries" of drive +identification information, and can also be used on ATAPI +drives which may give media errors with the standard mechanism. +When +.B --Istdin +is used, it must be the *only* parameter given. +.TP +.I --Istdout +This option dumps the drive's identify data in hex to stdout, +in a format similar to that from /proc/ide/*/identify, and suitable for +later use with the +.B --Istdin +option. +.TP +.I -J +Get/set the Western Digital (WD) Green Drive's "idle3" timeout value. +This timeout controls how often the drive parks its heads and enters +a low power consumption state. The factory default is eight (8) seconds, +which is a very poor choice for use with Linux. Leaving it at the default +will result in hundreds of thousands of head load/unload cycles in a very +short period of time. The drive mechanism is only rated for 300,000 to 1,000,000 +cycles, so leaving it at the default could result in premature failure, +not to mention the performance impact of the drive often having to wake-up +before doing routine I/O. +.IP +WD supply a WDIDLE3.EXE DOS utility for tweaking this setting, +and you should use that program instead of hdparm +if at all possible. The reverse-engineered implementation in hdparm +is not as complete as the original official program, even though it does +seem to work on at a least a few drives. A full power cycle is required +for any change in setting to take effect, regardless of which program is +used to tweak things. +.IP +A setting of 30 seconds is recommended for Linux use. +Permitted values are from 8 to 12 seconds, and from 30 to 300 seconds +in 30-second increments. +Specify a value of zero (0) to disable the WD idle3 timer completely +(NOT RECOMMENDED!). +.TP +.I -k +Get/set the "keep_settings_over_reset" flag for the drive. +When this flag is set, the drive will preserve the +.B -dmu +settings over a soft reset, (as done during the error recovery sequence). +This option defaults to off, +to prevent drive reset loops which could be caused by combinations of +.B -dmu +settings. The +.B -k +option should therefore only be set after one has achieved confidence in +correct system operation with a chosen set of configuration settings. +In practice, all that is typically necessary to test a configuration +(prior to using \-k) is to verify that the drive can be read/written, +and that no error logs (kernel messages) are generated in the process +(look in /var/log/messages on most systems). +.TP +.I -K +Set the drive\'s "keep_features_over_reset" flag. Setting this enables +the drive to retain the settings for +.B -APSWXZ +over a soft reset (as done during the error recovery sequence). +Not all drives support this feature. +.TP +.I -L +Set the drive\'s doorlock flag. Setting this to +.B 1 +will lock the door mechanism of some removable hard drives +(e.g. Syquest, ZIP, Jazz..), and setting it to +.B 0 +will unlock the door mechanism. Normally, Linux +maintains the door locking mechanism automatically, depending on drive usage +(locked whenever a filesystem is mounted). But on system shutdown, this can +be a nuisance if the root partition is on a removable disk, since the root +partition is left mounted (read-only) after shutdown. So, by using this +command to unlock the door +.B after +the root filesystem is remounted read-only, one can then remove the cartridge +from the drive after shutdown. +.TP +.I -m +Get/set sector count for multiple sector I/O on the drive. A setting of +.B 0 +disables this feature. Multiple sector mode (aka IDE Block Mode), is a feature +of most modern IDE hard drives, permitting the transfer of multiple sectors per +I/O interrupt, rather than the usual one sector per interrupt. When this +feature is enabled, it typically reduces operating system overhead for disk +I/O by 30-50%. On many systems, it also provides increased data throughput +of anywhere from 5% to 50%. Some drives, however +(most notably the WD Caviar series), +seem to run slower with multiple mode enabled. Your mileage may vary. +Most drives support the minimum settings of +2, 4, 8, or 16 (sectors). Larger settings may also be possible, depending on +the drive. A setting of 16 or 32 seems optimal on many systems. +Western Digital recommends lower settings of 4 to 8 on many of their drives, +due tiny (32kB) drive buffers and non-optimized buffering algorithms. +The +.B -i +option can be used to find the maximum setting supported by an installed drive +(look for MaxMultSect in the output). +Some drives claim to support multiple mode, but lose data at some settings. +Under rare circumstances, such failures can result in +.B massive filesystem corruption. +.TP +.I --make-bad-sector +Deliberately create a bad sector (aka. "media error") on the disk. +.B EXCEPTIONALLY DANGEROUS. DO NOT USE THIS OPTION!! +This can be useful for testing of device/RAID error recovery mechanisms. +The sector number is given as a (base10) parameter after the option. +Depending on the device, hdparm will choose one of two possible ATA commands for +corrupting the sector. The WRITE_LONG works on most drives, but only up to the 28-bit +sector boundary. Some very recent drives (2008) may support the new WRITE_UNCORRECTABLE_EXT +command, which works for any LBA48 sector. If available, hdparm will use that in +preference to WRITE_LONG. The WRITE_UNCORRECTABLE_EXT command itself presents a +choice of how the new bad sector should behave. +By default, it will look like any other bad sector, and the drive may take some +time to retry and fail on subsequent READs of the sector. +However, if a single letter +.B f +is prepended immediately in front of the first digit of the sector number parameter, +then hdparm will issue a "flagged" WRITE_UNCORRECTABLE_EXT, which causes the drive +to merely flag the sector as bad (rather than genuinely corrupt it), and subsequent +READs of the sector will fail immediately (rather than after several retries). +Note also that the +.B --repair-sector +option can be used to restore (any) bad sectors when they are no longer needed, +including sectors that were genuinely bad (the drive will likely remap those +to a fresh area on the media). +.TP +.I -M +Get/set Automatic Acoustic Management (AAM) setting. Most modern harddisk drives +have the ability to speed down the head movements to reduce their noise output. +The possible values are between 0 and 254. 128 is the most quiet (and therefore +slowest) setting and 254 the fastest (and loudest). Some drives have only two +levels (quiet / fast), while others may have different levels between 128 and 254. +At the moment, most drives only support 3 options, off, quiet, and fast. +These have been assigned the values 0, 128, and 254 at present, respectively, +but integer space has been incorporated for future expansion, should this change. +.TP +.I -n +Get or set the "ignore_write_errors" flag in the driver. +Do NOT play with this without grokking the driver source code first. +.TP +.I -N +Get/set max visible number of sectors, also known as the +.B Host Protected Area +setting. Without a parameter, +.B -N +displays the current setting, which is reported as two values: the first +gives the current max sectors setting, and the second shows +the native (real) hardware limit for the disk. +The difference between these two values indicates how many sectors of the disk +are currently hidden from the operating system, in the form of a +.B Host Protected Area (HPA). +This area is often used by computer makers to hold diagnostic software, +and/or a copy of the originally provided operating system for recovery purposes. +Another possible use is to hide the true capacity of a very large disk +from a BIOS/system that cannot normally cope with drives of that size +(eg. most current {2010} BIOSs cannot deal with drives larger than 2TB, +so an HPA could be used to cause a 3TB drive to report itself as a 2TB drive). +To change the current max (VERY DANGEROUS, DATA LOSS IS EXTREMELY LIKELY), +a new value should be provided (in base10) immediately +following the +.B -N +option. +This value is specified as a count of sectors, rather than +the "max sector address" of the drive. +Drives have the concept of a temporary (volatile) setting which is +lost on the next hardware reset, as well as a more permanent (non-volatile) +value which survives resets and power cycles. By default, +.B -N +affects only the temporary (volatile) setting. To change the permanent +(non-volatile) value, prepend a leading +.B p +character immediately before the first digit of the value. +Drives are supposed to allow only a single permanent +change per session. A hardware reset (or power cycle) is required +before another permanent +.B -N +operation can succeed. Note that any attempt to set this value +may fail if the disk is being accessed by other software at the same time. +This is because setting the value requires a pair of back-to-back drive commands, +but there is no way to prevent some other command from being inserted between +them by the kernel. So if it fails initially, just try again. +Kernel support for +.B -N +is buggy for many adapter types across many kernel versions, +in that an incorrect (too small) max size value is sometimes reported. +As of the 2.6.27 kernel, this does finally seem to be working on most hardware. +.TP +.I --offset +Offsets to given number of GiB (1024*1024*1024) when performing +.B -t +timings of device reads. +Speed changes (about twice) along many mechanical drives. +Usually the maximum is at the beginning, but not always. +Solid-state drives (SSDs) should show similar timings regardless of offset. +.TP +.I -p +Attempt to reprogram the IDE interface chipset for the specified PIO mode, +or attempt to auto-tune for the "best" PIO mode supported by the drive. +This feature is supported in the kernel for only a few "known" chipsets, +and even then the support is iffy at best. Some IDE chipsets are unable +to alter the PIO mode for a single drive, in which case this option may cause +the PIO mode for +.I both +drives to be set. Many IDE chipsets support either fewer or more than the +standard six (0 to 5) PIO modes, so the exact speed setting that is actually +implemented will vary by chipset/driver sophistication. +.I Use with extreme caution! +This feature includes zero protection for the unwary, +and an unsuccessful outcome may result in +.I severe filesystem corruption! +.TP +.I -P +Set the maximum sector count for the drive\'s internal prefetch mechanism. +Not all drives support this feature, and it was dropped from the official spec +as of ATA-4. +.TP +.I --prefer-ata12 +When using the SAT (SCSI ATA Translation) protocol, hdparm normally prefers +to use the 16-byte command format whenever possible. +But some USB drive enclosures don't work correctly with 16-byte commands. +This option can be used to force use of the smaller 12-byte command format +with such drives. hdparm will still revert to 16-byte commands for things +that cannot be done with the 12-byte format (e.g. sector accesses beyond 28-bits). +.TP +.I -q +Handle the next option quietly, suppressing normal output (but not error messages). +This is useful for reducing screen clutter when running from system startup scripts. +Not applicable to the +.B -i +or +.B -v +or +.B -t +or +.B -T +options. +.TP +.I -Q +Get or set the device's command queue_depth, if supported by the hardware. +This only works with 2.6.xx (or later) kernels, and only with +device and driver combinations which support changing the queue_depth. +For SATA disks, this is the Native Command Queuing (NCQ) queue depth. +.TP +.I -r +Get/set read-only flag for the device. When set, Linux disallows write operations on the device. +.TP +.I -R +Get/set Write-Read-Verify feature, if the drive supports it. +Usage: +.B -R0 +(disable) or +.B -R1 +(enable). This feature is intended to have the drive firmware automatically +read-back any data that is written by software, to verify that the data was +successfully written. This is generally overkill, and can slow down disk +writes by as much as a factor of two (or more). +.TP +.I --read-sector +Reads from the specified sector number, and dumps the contents in hex to standard output. +The sector number must be given (base10) after this option. +hdparm will issue a low-level read (completely bypassing the usual block layer read/write mechanisms) +for the specified sector. This can be used to definitively check whether a given sector is bad +(media error) or not (doing so through the usual mechanisms can sometimes give false positives). +.TP +.I --repair-sector +This is an alias for the +.B --write-sector +option. VERY DANGEROUS. +.TP +.I -s +Enable/disable the power-on in standby feature, if supported by +the drive. +.B VERY DANGEROUS. +Do not use unless you are absolutely certain +that both the system BIOS (or firmware) and the operating system kernel +(Linux >= 2.6.22) support probing for drives that use this feature. +When enabled, the drive is powered-up in the +.B standby +mode to allow the controller to sequence the spin-up of devices, +reducing the instantaneous current draw burden when many drives +share a power supply. Primarily for use in large RAID setups. +This feature is usually disabled and the drive is powered-up in the +.B active +mode (see \-C above). +Note that a drive may also allow enabling this feature by a jumper. +Some SATA drives support the control of this feature by pin 11 of +the SATA power connector. In these cases, this command may be +unsupported or may have no effect. +.TP +.I -S +Put the drive into idle (low-power) mode, and also set the standby +(spindown) timeout for the drive. This timeout value is used +by the drive to determine how long to wait (with no disk activity) +before turning off the spindle motor to save power. Under such +circumstances, the drive may take as long as 30 seconds to respond to +a subsequent disk access, though most drives are much quicker. The +encoding of the timeout value is somewhat peculiar. A value of zero +means "timeouts are disabled": the device will not automatically enter +standby mode. Values from 1 to 240 specify multiples of 5 seconds, +yielding timeouts from 5 seconds to 20 minutes. Values from 241 to +251 specify from 1 to 11 units of 30 minutes, yielding timeouts from +30 minutes to 5.5 hours. A value of 252 signifies a timeout of 21 +minutes. A value of 253 sets a vendor-defined timeout period between 8 +and 12 hours, and the value 254 is reserved. 255 is interpreted as 21 +minutes plus 15 seconds. Note that some older drives may have very +different interpretations of these values. +.TP +.I --set-sector-size +For drives which support reconfiguring of the Logical Sector Size, +this flag can be used to specify the new desired sector size in bytes. +.B VERY DANGEROUS. This most likely will scramble all data on the drive. +The specified size must be one of 512, 520, 528, 4096, 4160, or 4224. +Very few drives support values other than 512 and 4096. Eg. +.B hdparm --set-sector-size 4096 /dev/sdb +.TP +.I -t +Perform timings of device reads for benchmark and comparison purposes. +For meaningful results, this operation should be repeated 2-3 times on +an otherwise inactive system (no other active processes) with at least a +couple of megabytes of free memory. This displays the speed of reading +through the buffer cache to the disk without any prior caching of data. +This measurement is an indication of how fast the drive can sustain +sequential data reads under Linux, without any filesystem overhead. To +ensure accurate measurements, the buffer cache is flushed during the +processing of +.I -t +using the BLKFLSBUF ioctl. +.TP +.I -T +Perform timings of cache reads for benchmark and comparison purposes. +For meaningful results, this operation should be repeated 2-3 times +on an otherwise inactive system (no other active processes) with at +least a couple of megabytes of free memory. This displays the speed +of reading directly from the Linux buffer cache without disk access. +This measurement is essentially an indication of the throughput of the +processor, cache, and memory of the system under test. +.TP +.I --trim-sector-ranges +For Solid State Drives (SSDs). +.B EXCEPTIONALLY DANGEROUS. DO NOT USE THIS OPTION!! +Tells the drive firmware +to discard unneeded data sectors, destroying any data that may have +been present within them. This makes those sectors available for +immediate use by the firmware's garbage collection mechanism, to +improve scheduling for wear-leveling of the flash media. +This option expects one or more sector range pairs immediately after the option: +an LBA starting address, a colon, and a sector count (max 65535), with no intervening spaces. +.B EXCEPTIONALLY DANGEROUS. DO NOT USE THIS OPTION!! +.IP +E.g. +.B hdparm --trim-sector-ranges 1000:4 7894:16 /dev/sdz +.TP +.I --trim-sector-ranges-stdin +Identical to +.B --trim-sector-ranges +above, except the list of lba:count pairs is read from stdin +rather than being specified on the command line. This can be used +to avoid problems with excessively long command lines. It also permits +batching of many more sector ranges into single commands to the drive, +up to the currently configured transfer limit (max_sectors_kb). +.TP +.I -u +Get/set the interrupt-unmask flag for the drive. A setting of +.B 1 +permits the +driver to unmask other interrupts during processing of a disk interrupt, +which greatly improves Linux\'s responsiveness and eliminates "serial port +overrun" errors. +.B Use this feature with caution: +some drive/controller combinations do +not tolerate the increased I/O latencies possible when this feature is enabled, +resulting in +.B massive filesystem corruption. +In particular, +.B CMD-640B +and +.B RZ1000 +(E)IDE interfaces can be +.B unreliable +(due to a hardware flaw) when this option is used with kernel versions earlier +than 2.0.13. Disabling the +.B IDE prefetch +feature of these interfaces (usually a BIOS/CMOS setting) +provides a safe fix for the problem for use with earlier kernels. +.TP +.I -v +Display some basic settings, similar to \-acdgkmur for IDE. +This is also the default behaviour when no options are specified. +.TP +.I -V +Display program version and exit immediately. +.TP +.I --verbose +Display extra diagnostics from some commands. +.TP +.I -w +Perform a device reset +.B (DANGEROUS). +Do NOT use this option. +It exists for unlikely situations where a reboot might otherwise be +required to get a confused drive back into a useable state. +.TP +.I --write-sector +Writes zeros to the specified sector number. VERY DANGEROUS. +The sector number must be given (base10) after this option. +hdparm will issue a low-level write (completely bypassing the usual block layer read/write mechanisms) +to the specified sector. This can be used to force a drive to repair a bad sector (media error). +.TP +.I -W +Get/set the IDE/SATA drive\'s write-caching feature. +.TP +.I -X +Set the IDE transfer mode for (E)IDE/ATA drives. +This is typically used in combination with +.B -d1 +when enabling DMA to/from a drive on a supported interface chipset, where +.B -X mdma2 +is used to select multiword DMA mode2 transfers and +.B -X sdma1 +is used to select simple mode 1 DMA transfers. +With systems which support UltraDMA burst timings, +.B -X udma2 +is used to select UltraDMA mode2 transfers (you\'ll need to prepare +the chipset for UltraDMA beforehand). +Apart from that, use of this option is +.B seldom necessary +since most/all modern IDE drives default to their fastest PIO transfer mode +at power-on. Fiddling with this can be both needless and risky. +On drives which support alternate transfer modes, +.B -X +can be used to switch the mode of the drive +.B only. +Prior to changing the transfer mode, the IDE interface should be jumpered +or programmed (see +.B -p +option) +for the new mode setting to prevent loss and/or corruption of data. +.I Use this with extreme caution! +For the PIO (Programmed Input/Output) +transfer modes used by Linux, this value is simply the desired +PIO mode number plus 8. +Thus, a value of 09 sets PIO mode1, 10 enables PIO mode2, +and 11 selects PIO mode3. +Setting 00 restores the drive\'s "default" PIO mode, and 01 disables IORDY. +For multiword DMA, the value used is the desired DMA mode number +plus 32. for UltraDMA, the value is the desired UltraDMA mode number +plus 64. +.TP +.I -y +Force an IDE drive to immediately enter the low power consumption +.B standby +mode, usually causing it to spin down. +The current power mode status can be checked using the +.B -C +option. +.TP +.I -Y +Force an IDE drive to immediately enter the lowest power consumption +.B sleep +mode, causing it to shut down completely. A hard or soft reset +is required before the drive can be accessed again +(the Linux IDE driver will automatically handle issuing a reset if/when needed). +The current power mode status can be checked using the +.B -C +option. +.TP +.I -z +Force a kernel re-read of the partition table of the specified device(s). +.TP +.I -Z +Disable the automatic power-saving function of certain Seagate drives +(ST3xxx models?), to prevent them from idling/spinning-down +at inconvenient times. +.TP +.SH ATA Security Feature Set +.PP +These switches are +.B DANGEROUS +to experiment with, and might not work with some kernels. +.B USE AT YOUR OWN RISK. +.TP +.I --security-help +Display terse usage info for all of the \--security-* options. +.TP +.I --security-freeze +Freeze the drive\'s security settings. +The drive does not accept any security commands until next power-on reset. +Use this function in combination with \--security-unlock to protect drive +from any attempt to set a new password. Can be used standalone, too. +No other options are permitted on the command line with this one. +.TP +.I --security-prompt-for-password +Prompt for the --security PWD rather than getting from the command line args. +This avoids having passwords show up in shell history or in /proc/self/cmdline during execution. +.TP +.I --security-unlock PWD +Unlock the drive, using password PWD. +Password is given as an ASCII string and is padded with NULs to reach 32 bytes. +The applicable drive password is selected with the \--user-master switch +(default is "user" password). +No other options are permitted on the command line with this one. +.TP +.I --security-set-pass PWD +Lock the drive, using password PWD (Set Password) +.B (DANGEROUS). +Password is given as an ASCII string and is padded with NULs to reach 32 bytes. +Use the special password +.B NULL +to set an empty password. +The applicable drive password is selected with the \--user-master switch +(default is "user" password) +and the applicable security mode with the \--security-mode switch. +No other options are permitted on the command line with this one. +.TP +.I --security-disable PWD +Disable drive locking, using password PWD. +Password is given as an ASCII string and is padded with NULs to reach 32 bytes. +The applicable drive password is selected with the \--user-master switch +(default is "user" password). +No other options are permitted on the command line with this one. +.TP +.I --security-erase PWD +Erase (locked) drive, using password PWD +.B (DANGEROUS). +Password is given as an ASCII string and is padded with NULs to reach 32 bytes. +Use the special password +.B NULL +to represent an empty password. +The applicable drive password is selected with the \--user-master switch +(default is "user" password). +No other options are permitted on the command line with this one. +.TP +.I --security-erase-enhanced PWD +Enhanced erase (locked) drive, using password PWD +.B (DANGEROUS). +Password is given as an ASCII string and is padded with NULs to reach 32 bytes. +The applicable drive password is selected with the \--user-master switch +(default is "user" password). +No other options are permitted on the command line with this one. +.TP +.I --user-master USER +Specifies which password (user/master) to select. +.B Defaults to "user" password. +Only useful in combination with \--security-unlock, \--security-set-pass, +\--security-disable, \--security-erase or \--security-erase-enhanced. + u user password + m master password + +.TP +.I --security-mode MODE +Specifies which security mode (high/maximum) to set. +.B Defaults to high. +Only useful in combination with \--security-set-pass. + h high security + m maximum security + +.B THIS FEATURE IS EXPERIMENTAL AND NOT WELL TESTED. USE AT YOUR OWN RISK. +.SH FILES +/etc/hdparm.conf +.SH BUGS +As noted above, the +.B -m sectcount +and +.B -u 1 +options should be used with caution at first, preferably on a +read-only filesystem. Most drives work well with these features, but +a few drive/controller combinations are not 100% compatible. Filesystem +corruption may result. Backup everything before experimenting! +.PP +Some options (e.g. \-r for SCSI) may not work with old kernels as +necessary ioctl()\'s were not supported. +.PP +Although this utility is intended primarily for use with SATA/IDE hard disk +devices, several of the options are also valid (and permitted) for use with +SCSI hard disk devices and MFM/RLL hard disks with XT interfaces. +.PP +The Linux kernel up until 2.6.12 (and probably later) doesn\'t handle the +security unlock and disable commands gracefully and will segfault and in some +cases even panic. The security commands however might indeed have been executed +by the drive. This poor kernel behaviour makes the PIO data security commands +rather useless at the moment. +.PP +Note that the "security erase" and "security disable" commands have been +implemented as two consecutive PIO data commands and will not succeed on a +locked drive because the second command will not be issued after the segfault. +See the code for hints how patch it to work around this problem. Despite the +segfault it is often still possible to run two instances of hdparm +consecutively and issue the two necessary commands that way. +.SH AUTHOR +.B hdparm +has been written by Mark Lord <mlord@pobox.com>, the original primary +developer and maintainer of the (E)IDE driver for Linux, and current contributor +to the libata subsystem, along with suggestions and patches from many netfolk. +.PP +The disable Seagate auto-powersaving code +is courtesy of Tomi Leppikangas(tomilepp@paju.oulu.fi). +.PP +Security freeze command by Benjamin Benz, 2005. +.PP +PIO data out security commands by Leonard den Ottolander, 2005. +Some other parts by Benjamin Benz and others. +.SH SEE ALSO +.B http://www.t13.org/ +Technical Committee T13 AT Attachment (ATA/ATAPI) Interface. +.PP +.B http://www.serialata.org/ +Serial ATA International Organization. +.PP +.B http://www.compactflash.org/ +CompactFlash Association. diff --git a/upstream/opensuse-leap-15-6/man8/hwclock.8 b/upstream/opensuse-leap-15-6/man8/hwclock.8 new file mode 100644 index 00000000..ba59b326 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/hwclock.8 @@ -0,0 +1,589 @@ +'\" t +.\" Title: hwclock +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "HWCLOCK" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +hwclock \- time clocks utility +.SH "SYNOPSIS" +.sp +\fBhwclock\fP [\fIfunction\fP] [\fIoption\fP...] +.SH "DESCRIPTION" +.sp +\fBhwclock\fP is an administration tool for the time clocks. It can: display the Hardware Clock time; set the Hardware Clock to a specified time; set the Hardware Clock from the System Clock; set the System Clock from the Hardware Clock; compensate for Hardware Clock drift; correct the System Clock timescale; set the kernel\(cqs timezone, NTP timescale, and epoch (Alpha only); and predict future Hardware Clock values based on its drift rate. +.sp +Since v2.26 important changes were made to the \fB\-\-hctosys\fP function and the \fB\-\-directisa\fP option, and a new option \fB\-\-update\-drift\fP was added. See their respective descriptions below. +.SH "FUNCTIONS" +.sp +The following functions are mutually exclusive, only one can be given at a time. If none is given, the default is \fB\-\-show\fP. +.sp +\fB\-a, \-\-adjust\fP +.RS 4 +Add or subtract time from the Hardware Clock to account for systematic drift since the last time the clock was set or adjusted. See the discussion below, under \fBThe Adjust Function\fP. +.RE +.sp +\fB\-\-getepoch\fP; \fB\-\-setepoch\fP +.RS 4 +These functions are for Alpha machines only, and are only available through the Linux kernel RTC driver. +.sp +They are used to read and set the kernel\(cqs Hardware Clock epoch value. Epoch is the number of years into AD to which a zero year value in the Hardware Clock refers. For example, if the machine\(cqs BIOS sets the year counter in the Hardware Clock to contain the number of full years since 1952, then the kernel\(cqs Hardware Clock epoch value must be 1952. +.sp +The \fB\-\-setepoch\fP function requires using the \fB\-\-epoch\fP option to specify the year. For example: +.sp +\fBhwclock \-\-setepoch \-\-epoch=1952\fP +.sp +The RTC driver attempts to guess the correct epoch value, so setting it may not be required. +.sp +This epoch value is used whenever \fBhwclock\fP reads or sets the Hardware Clock on an Alpha machine. For ISA machines the kernel uses the fixed Hardware Clock epoch of 1900. +.RE +.sp +\fB\-\-predict\fP +.RS 4 +Predict what the Hardware Clock will read in the future based upon the time given by the \fB\-\-date\fP option and the information in \fI/etc/adjtime\fP. This is useful, for example, to account for drift when setting a Hardware Clock wakeup (aka alarm). See \fBrtcwake\fP(8). +.sp +Do not use this function if the Hardware Clock is being modified by anything other than the current operating system\(cqs \fBhwclock\fP command, such as \(aq11 minute mode\(aq or from dual\-booting another OS. +.RE +.sp +\fB\-r\fP, \fB\-\-show\fP; \fB\-\-get\fP +.RS 4 +Read the Hardware Clock and print its time to standard output in the \fBISO 8601\fP format. The time shown is always in local time, even if you keep your Hardware Clock in UTC. See the \fB\-\-localtime\fP option. +.sp +Showing the Hardware Clock time is the default when no function is specified. +.sp +The \fB\-\-get\fP function also applies drift correction to the time read, based upon the information in \fI/etc/adjtime\fP. Do not use this function if the Hardware Clock is being modified by anything other than the current operating system\(cqs \fBhwclock\fP command, such as \(aq11 minute mode\(aq or from dual\-booting another OS. +.RE +.sp +\fB\-s\fP, \fB\-\-hctosys\fP +.RS 4 +Set the System Clock from the Hardware Clock. The time read from the Hardware Clock is compensated to account for systematic drift before using it to set the System Clock. See the discussion below, under \fBThe Adjust Function\fP. +.sp +The System Clock must be kept in the UTC timescale for date\-time applications to work correctly in conjunction with the timezone configured for the system. If the Hardware Clock is kept in local time then the time read from it must be shifted to the UTC timescale before using it to set the System Clock. The \fB\-\-hctosys\fP function does this based upon the information in the \fI/etc/adjtime\fP file or the command line arguments \fB\-\-localtime\fP and \fB\-\-utc\fP. Note: no daylight saving adjustment is made. See the discussion below, under \fBLOCAL vs UTC\fP. +.sp +The kernel also keeps a timezone value, the \fB\-\-hctosys\fP function sets it to the timezone configured for the system. The system timezone is configured by the TZ environment variable or the \fI/etc/localtime\fP file, as \fBtzset\fP(3) would interpret them. The obsolete \fItz_dsttime\fP field of the kernel\(cqs timezone value is set to zero. (For details on what this field used to mean, see \fBsettimeofday\fP(2).) +.sp +When used in a startup script, making the \fB\-\-hctosys\fP function the first caller of \fBsettimeofday\fP(2) from boot, it will set the NTP \(aq11 minute mode\(aq timescale via the \fIpersistent_clock_is_local\fP kernel variable. If the Hardware Clock\(cqs timescale configuration is changed then a reboot is required to inform the kernel. See the discussion below, under \fBAutomatic Hardware Clock Synchronization by the Kernel\fP. +.sp +This is a good function to use in one of the system startup scripts before the file systems are mounted read/write. +.sp +This function should never be used on a running system. Jumping system time will cause problems, such as corrupted filesystem timestamps. Also, if something has changed the Hardware Clock, like NTP\(cqs \(aq11 minute mode\(aq, then \fB\-\-hctosys\fP will set the time incorrectly by including drift compensation. +.sp +Drift compensation can be inhibited by setting the drift factor in \fI/etc/adjtime\fP to zero. This setting will be persistent as long as the \fB\-\-update\-drift\fP option is not used with \fB\-\-systohc\fP at shutdown (or anywhere else). Another way to inhibit this is by using the \fB\-\-noadjfile\fP option when calling the \fB\-\-hctosys\fP function. A third method is to delete the \fI/etc/adjtime\fP file. \fBHwclock\fP will then default to using the UTC timescale for the Hardware Clock. If the Hardware Clock is ticking local time it will need to be defined in the file. This can be done by calling \fBhwclock \-\-localtime \-\-adjust\fP; when the file is not present this command will not actually adjust the Clock, but it will create the file with local time configured, and a drift factor of zero. +.sp +A condition under which inhibiting \fBhwclock\fP\(aqs drift correction may be desired is when dual\-booting multiple operating systems. If while this instance of Linux is stopped, another OS changes the Hardware Clock\(cqs value, then when this instance is started again the drift correction applied will be incorrect. +.sp +For \fBhwclock\fP\(aqs drift correction to work properly it is imperative that nothing changes the Hardware Clock while its Linux instance is not running. +.RE +.sp +\fB\-\-set\fP +.RS 4 +Set the Hardware Clock to the time given by the \fB\-\-date\fP option, and update the timestamps in \fI/etc/adjtime\fP. With the \fB\-\-update\-drift\fP option also (re)calculate the drift factor. Try it without the option if \fB\-\-set\fP fails. See \fB\-\-update\-drift\fP below. +.RE +.sp +\fB\-\-systz\fP +.RS 4 +This is an alternate to the \fB\-\-hctosys\fP function that does not read the Hardware Clock nor set the System Clock; consequently there is not any drift correction. It is intended to be used in a startup script on systems with kernels above version 2.6 where you know the System Clock has been set from the Hardware Clock by the kernel during boot. +.sp +It does the following things that are detailed above in the \fB\-\-hctosys\fP function: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +. sp -1 +. IP \(bu 2.3 +.\} +Corrects the System Clock timescale to UTC as needed. Only instead of accomplishing this by setting the System Clock, \fBhwclock\fP simply informs the kernel and it handles the change. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +. sp -1 +. IP \(bu 2.3 +.\} +Sets the kernel\(cqs NTP \(aq11 minute mode\(aq timescale. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +. sp -1 +. IP \(bu 2.3 +.\} +Sets the kernel\(cqs timezone. +.RE +.RE +.sp +The first two are only available on the first call of \fBsettimeofday\fP(2) after boot. Consequently this option only makes sense when used in a startup script. If the Hardware Clocks timescale configuration is changed then a reboot would be required to inform the kernel. +.sp +\fB\-w\fP, \fB\-\-systohc\fP +.RS 4 +Set the Hardware Clock from the System Clock, and update the timestamps in \fI/etc/adjtime\fP. With the \fB\-\-update\-drift\fP option also (re)calculate the drift factor. Try it without the option if \fB\-\-systohc\fP fails. See \fB\-\-update\-drift\fP below. +.RE +.sp +\fB\-V\fP, \fB\-\-version\fP +.RS 4 +Display version information and exit. +.RE +.sp +\fB\-h\fP, \fB\-\-help\fP +.RS 4 +Display help text and exit. +.RE +.SH "OPTIONS" +.sp +\fB\-\-adjfile=\fP\fIfilename\fP +.RS 4 +Override the default \fI/etc/adjtime\fP file path. +.RE +.sp +\fB\-\-date=\fP\fIdate_string\fP +.RS 4 +This option must be used with the \fB\-\-set\fP or \fB\-\-predict\fP functions, otherwise it is ignored. +.sp +\fBhwclock \-\-set \-\-date=\(aq16:45\(aq\fP +.sp +\fBhwclock \-\-predict \-\-date=\(aq2525\-08\-14 07:11:05\(aq\fP +.sp +The argument must be in local time, even if you keep your Hardware Clock in UTC. See the \fB\-\-localtime\fP option. Therefore, the argument should not include any timezone information. It also should not be a relative time like "+5 minutes", because \fBhwclock\fP\(aqs precision depends upon correlation between the argument\(cqs value and when the enter key is pressed. Fractional seconds are silently dropped. This option is capable of understanding many time and date formats, but the previous parameters should be observed. +.RE +.sp +\fB\-\-delay=\fP\fIseconds\fP +.RS 4 +This option can be used to overwrite the internally used delay when setting the clock time. The default is 0.5 (500ms) for rtc_cmos, for another RTC types the delay is 0. If RTC type is impossible to determine (from sysfs) then it defaults also to 0.5 to be backwardly compatible. +.sp +The 500ms default is based on commonly used MC146818A\-compatible (x86) hardware clock. This Hardware Clock can only be set to any integer time plus one half second. The integer time is required because there is no interface to set or get a fractional second. The additional half second delay is because the Hardware Clock updates to the following second precisely 500 ms after setting the new time. Unfortunately, this behavior is hardware specific and in same cases another delay is required. +.RE +.sp +\fB\-D\fP, \fB\-\-debug\fP +.RS 4 +Use \fB\-\-verbose\fP. The \fB\-\-debug\fP option has been deprecated and may be repurposed or removed in a future release. +.RE +.sp +\fB\-\-directisa\fP +.RS 4 +This option is meaningful for ISA compatible machines in the x86 and x86_64 family. For other machines, it has no effect. This option tells \fBhwclock\fP to use explicit I/O instructions to access the Hardware Clock. Without this option, \fBhwclock\fP will use the rtc device file, which it assumes to be driven by the Linux RTC device driver. As of v2.26 it will no longer automatically use directisa when the rtc driver is unavailable; this was causing an unsafe condition that could allow two processes to access the Hardware Clock at the same time. Direct hardware access from userspace should only be used for testing, troubleshooting, and as a last resort when all other methods fail. See the \fB\-\-rtc\fP option. +.RE +.sp +\fB\-\-epoch=\fP\fIyear\fP +.RS 4 +This option is required when using the \fB\-\-setepoch\fP function. The minimum \fIyear\fP value is 1900. The maximum is system dependent (\fBULONG_MAX \- 1\fP). +.RE +.sp +\fB\-f\fP, \fB\-\-rtc=\fP\fIfilename\fP +.RS 4 +Override \fBhwclock\fP\(aqs default rtc device file name. Otherwise it will use the first one found in this order: \fI/dev/rtc0\fP, \fI/dev/rtc\fP, \fI/dev/misc/rtc\fP. For \fBIA\-64:\fP \fI/dev/efirtc\fP \fI/dev/misc/efirtc\fP +.RE +.sp +\fB\-l\fP, \fB\-\-localtime\fP; \fB\-u\fP, \fB\-\-utc\fP +.RS 4 +Indicate which timescale the Hardware Clock is set to. +.sp +The Hardware Clock may be configured to use either the UTC or the local timescale, but nothing in the clock itself says which alternative is being used. The \fB\-\-localtime\fP or \fB\-\-utc\fP options give this information to the \fBhwclock\fP command. If you specify the wrong one (or specify neither and take a wrong default), both setting and reading the Hardware Clock will be incorrect. +.sp +If you specify neither \fB\-\-utc\fP nor \fB\-\-localtime\fP then the one last given with a set function (\fB\-\-set\fP, \fB\-\-systohc\fP, or \fB\-\-adjust\fP), as recorded in \fI/etc/adjtime\fP, will be used. If the adjtime file doesn\(cqt exist, the default is UTC. +.sp +Note: daylight saving time changes may be inconsistent when the Hardware Clock is kept in local time. See the discussion below, under \fBLOCAL vs UTC\fP. +.RE +.sp +\fB\-\-noadjfile\fP +.RS 4 +Disable the facilities provided by \fI/etc/adjtime\fP. \fBhwclock\fP will not read nor write to that file with this option. Either \fB\-\-utc\fP or \fB\-\-localtime\fP must be specified when using this option. +.RE +.sp +\fB\-\-test\fP +.RS 4 +Do not actually change anything on the system, that is, the Clocks or \fI/etc/adjtime\fP (\fB\-\-verbose\fP is implicit with this option). +.RE +.sp +\fB\-\-update\-drift\fP +.RS 4 +Update the Hardware Clock\(cqs drift factor in \fI/etc/adjtime\fP. It can only be used with \fB\-\-set\fP or \fB\-\-systohc\fP. +.sp +A minimum four hour period between settings is required. This is to avoid invalid calculations. The longer the period, the more precise the resulting drift factor will be. +.sp +This option was added in v2.26, because it is typical for systems to call \fBhwclock \-\-systohc\fP at shutdown; with the old behavior this would automatically (re)calculate the drift factor which caused several problems: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +. sp -1 +. IP \(bu 2.3 +.\} +When using NTP with an \(aq11 minute mode\(aq kernel the drift factor would be clobbered to near zero. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +. sp -1 +. IP \(bu 2.3 +.\} +It would not allow the use of \(aqcold\(aq drift correction. With most configurations using \(aqcold\(aq drift will yield favorable results. Cold, means when the machine is turned off which can have a significant impact on the drift factor. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +. sp -1 +. IP \(bu 2.3 +.\} +(Re)calculating drift factor on every shutdown delivers suboptimal results. For example, if ephemeral conditions cause the machine to be abnormally hot the drift factor calculation would be out of range. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +. sp -1 +. IP \(bu 2.3 +.\} +Significantly increased system shutdown times (as of v2.31 when not using \fB\-\-update\-drift\fP the RTC is not read). +.RE +.RE +.sp +Having \fBhwclock\fP calculate the drift factor is a good starting point, but for optimal results it will likely need to be adjusted by directly editing the \fI/etc/adjtime\fP file. For most configurations once a machine\(cqs optimal drift factor is crafted it should not need to be changed. Therefore, the old behavior to automatically (re)calculate drift was changed and now requires this option to be used. See the discussion below, under \fBThe Adjust Function\fP. +.sp +This option requires reading the Hardware Clock before setting it. If it cannot be read, then this option will cause the set functions to fail. This can happen, for example, if the Hardware Clock is corrupted by a power failure. In that case, the clock must first be set without this option. Despite it not working, the resulting drift correction factor would be invalid anyway. +.sp +\fB\-v\fP, \fB\-\-verbose\fP +.RS 4 +Display more details about what \fBhwclock\fP is doing internally. +.RE +.SH "NOTES" +.SS "Clocks in a Linux System" +.sp +There are two types of date\-time clocks: +.sp +\fBThe Hardware Clock:\fP This clock is an independent hardware device, with its own power domain (battery, capacitor, etc), that operates when the machine is powered off, or even unplugged. +.sp +On an ISA compatible system, this clock is specified as part of the ISA standard. A control program can read or set this clock only to a whole second, but it can also detect the edges of the 1 second clock ticks, so the clock actually has virtually infinite precision. +.sp +This clock is commonly called the hardware clock, the real time clock, the RTC, the BIOS clock, and the CMOS clock. Hardware Clock, in its capitalized form, was coined for use by \fBhwclock\fP. The Linux kernel also refers to it as the persistent clock. +.sp +Some non\-ISA systems have a few real time clocks with only one of them having its own power domain. A very low power external I2C or SPI clock chip might be used with a backup battery as the hardware clock to initialize a more functional integrated real\-time clock which is used for most other purposes. +.sp +\fBThe System Clock:\fP This clock is part of the Linux kernel and is driven by a timer interrupt. (On an ISA machine, the timer interrupt is part of the ISA standard.) It has meaning only while Linux is running on the machine. The System Time is the number of seconds since 00:00:00 January 1, 1970 UTC (or more succinctly, the number of seconds since 1969 UTC). The System Time is not an integer, though. It has virtually infinite precision. +.sp +The System Time is the time that matters. The Hardware Clock\(cqs basic purpose is to keep time when Linux is not running so that the System Clock can be initialized from it at boot. Note that in DOS, for which ISA was designed, the Hardware Clock is the only real time clock. +.sp +It is important that the System Time not have any discontinuities such as would happen if you used the \fBdate\fP(1) program to set it while the system is running. You can, however, do whatever you want to the Hardware Clock while the system is running, and the next time Linux starts up, it will do so with the adjusted time from the Hardware Clock. Note: currently this is not possible on most systems because \fBhwclock \-\-systohc\fP is called at shutdown. +.sp +The Linux kernel\(cqs timezone is set by \fBhwclock\fP. But don\(cqt be misled \(em almost nobody cares what timezone the kernel thinks it is in. Instead, programs that care about the timezone (perhaps because they want to display a local time for you) almost always use a more traditional method of determining the timezone: They use the \fBTZ\fP environment variable or the \fI/etc/localtime\fP file, as explained in the man page for \fBtzset\fP(3). However, some programs and fringe parts of the Linux kernel such as filesystems use the kernel\(cqs timezone value. An example is the vfat filesystem. If the kernel timezone value is wrong, the vfat filesystem will report and set the wrong timestamps on files. Another example is the kernel\(cqs NTP \(aq11 minute mode\(aq. If the kernel\(cqs timezone value and/or the \fIpersistent_clock_is_local\fP variable are wrong, then the Hardware Clock will be set incorrectly by \(aq11 minute mode\(aq. See the discussion below, under \fBAutomatic Hardware Clock Synchronization by the Kernel\fP. +.sp +\fBhwclock\fP sets the kernel\(cqs timezone to the value indicated by \fBTZ\fP or \fI/etc/localtime\fP with the \fB\-\-hctosys\fP or \fB\-\-systz\fP functions. +.sp +The kernel\(cqs timezone value actually consists of two parts: 1) a field tz_minuteswest indicating how many minutes local time (not adjusted for DST) lags behind UTC, and 2) a field tz_dsttime indicating the type of Daylight Savings Time (DST) convention that is in effect in the locality at the present time. This second field is not used under Linux and is always zero. See also \fBsettimeofday\fP(2). +.SS "Hardware Clock Access Methods" +.sp +\fBhwclock\fP uses many different ways to get and set Hardware Clock values. The most normal way is to do I/O to the rtc device special file, which is presumed to be driven by the rtc device driver. Also, Linux systems using the rtc framework with udev, are capable of supporting multiple Hardware Clocks. This may bring about the need to override the default rtc device by specifying one with the \fB\-\-rtc\fP option. +.sp +However, this method is not always available as older systems do not have an rtc driver. On these systems, the method of accessing the Hardware Clock depends on the system hardware. +.sp +On an ISA compatible system, \fBhwclock\fP can directly access the "CMOS memory" registers that constitute the clock, by doing I/O to Ports 0x70 and 0x71. It does this with actual I/O instructions and consequently can only do it if running with superuser effective userid. This method may be used by specifying the \fB\-\-directisa\fP option. +.sp +This is a really poor method of accessing the clock, for all the reasons that userspace programs are generally not supposed to do direct I/O and disable interrupts. \fBhwclock\fP provides it for testing, troubleshooting, and because it may be the only method available on ISA systems which do not have a working rtc device driver. +.SS "The Adjust Function" +.sp +The Hardware Clock is usually not very accurate. However, much of its inaccuracy is completely predictable \- it gains or loses the same amount of time every day. This is called systematic drift. \fBhwclock\fP\(aqs \fB\-\-adjust\fP function lets you apply systematic drift corrections to the Hardware Clock. +.sp +It works like this: \fBhwclock\fP keeps a file, \fI/etc/adjtime\fP, that keeps some historical information. This is called the adjtime file. +.sp +Suppose you start with no adjtime file. You issue a \fBhwclock \-\-set\fP command to set the Hardware Clock to the true current time. \fBhwclock\fP creates the adjtime file and records in it the current time as the last time the clock was calibrated. Five days later, the clock has gained 10 seconds, so you issue a \fBhwclock \-\-set \-\-update\-drift\fP command to set it back 10 seconds. \fBhwclock\fP updates the adjtime file to show the current time as the last time the clock was calibrated, and records 2 seconds per day as the systematic drift rate. 24 hours go by, and then you issue a \fBhwclock \-\-adjust\fP command. \fBhwclock\fP consults the adjtime file and sees that the clock gains 2 seconds per day when left alone and that it has been left alone for exactly one day. So it subtracts 2 seconds from the Hardware Clock. It then records the current time as the last time the clock was adjusted. Another 24 hours go by and you issue another \fBhwclock \-\-adjust\fP. \fBhwclock\fP does the same thing: subtracts 2 seconds and updates the adjtime file with the current time as the last time the clock was adjusted. +.sp +When you use the \fB\-\-update\-drift\fP option with \fB\-\-set\fP or \fB\-\-systohc\fP, the systematic drift rate is (re)calculated by comparing the fully drift corrected current Hardware Clock time with the new set time, from that it derives the 24 hour drift rate based on the last calibrated timestamp from the adjtime file. This updated drift factor is then saved in \fI/etc/adjtime\fP. +.sp +A small amount of error creeps in when the Hardware Clock is set, so \fB\-\-adjust\fP refrains from making any adjustment that is less than 1 second. Later on, when you request an adjustment again, the accumulated drift will be more than 1 second and \fB\-\-adjust\fP will make the adjustment including any fractional amount. +.sp +\fBhwclock \-\-hctosys\fP also uses the adjtime file data to compensate the value read from the Hardware Clock before using it to set the System Clock. It does not share the 1 second limitation of \fB\-\-adjust\fP, and will correct sub\-second drift values immediately. It does not change the Hardware Clock time nor the adjtime file. This may eliminate the need to use \fB\-\-adjust\fP, unless something else on the system needs the Hardware Clock to be compensated. +.SS "The Adjtime File" +.sp +While named for its historical purpose of controlling adjustments only, it actually contains other information used by \fBhwclock\fP from one invocation to the next. +.sp +The format of the adjtime file is, in ASCII: +.sp +Line 1: Three numbers, separated by blanks: 1) the systematic drift rate in seconds per day, floating point decimal; 2) the resulting number of seconds since 1969 UTC of most recent adjustment or calibration, decimal integer; 3) zero (for compatibility with \fBclock\fP(8)) as a floating point decimal. +.sp +Line 2: One number: the resulting number of seconds since 1969 UTC of most recent calibration. Zero if there has been no calibration yet or it is known that any previous calibration is moot (for example, because the Hardware Clock has been found, since that calibration, not to contain a valid time). This is a decimal integer. +.sp +Line 3: "UTC" or "LOCAL". Tells whether the Hardware Clock is set to Coordinated Universal Time or local time. You can always override this value with options on the \fBhwclock\fP command line. +.sp +You can use an adjtime file that was previously used with the \fBclock\fP(8) program with \fBhwclock\fP. +.SS "Automatic Hardware Clock Synchronization by the Kernel" +.sp +You should be aware of another way that the Hardware Clock is kept synchronized in some systems. The Linux kernel has a mode wherein it copies the System Time to the Hardware Clock every 11 minutes. This mode is a compile time option, so not all kernels will have this capability. This is a good mode to use when you are using something sophisticated like NTP to keep your System Clock synchronized. (NTP is a way to keep your System Time synchronized either to a time server somewhere on the network or to a radio clock hooked up to your system. See RFC 1305.) +.sp +If the kernel is compiled with the \(aq11 minute mode\(aq option it will be active when the kernel\(cqs clock discipline is in a synchronized state. When in this state, bit 6 (the bit that is set in the mask 0x0040) of the kernel\(cqs \fItime_status\fP variable is unset. This value is output as the \(aqstatus\(aq line of the \fBadjtimex \-\-print\fP or \fBntptime\fP commands. +.sp +It takes an outside influence, like the NTP daemon to put the kernel\(cqs clock discipline into a synchronized state, and therefore turn on \(aq11 minute mode\(aq. It can be turned off by running anything that sets the System Clock the old fashioned way, including \fBhwclock \-\-hctosys\fP. However, if the NTP daemon is still running, it will turn \(aq11 minute mode\(aq back on again the next time it synchronizes the System Clock. +.sp +If your system runs with \(aq11 minute mode\(aq on, it may need to use either \fB\-\-hctosys\fP or \fB\-\-systz\fP in a startup script, especially if the Hardware Clock is configured to use the local timescale. Unless the kernel is informed of what timescale the Hardware Clock is using, it may clobber it with the wrong one. The kernel uses UTC by default. +.sp +The first userspace command to set the System Clock informs the kernel what timescale the Hardware Clock is using. This happens via the \fIpersistent_clock_is_local\fP kernel variable. If \fB\-\-hctosys\fP or \fB\-\-systz\fP is the first, it will set this variable according to the adjtime file or the appropriate command\-line argument. Note that when using this capability and the Hardware Clock timescale configuration is changed, then a reboot is required to notify the kernel. +.sp +\fBhwclock \-\-adjust\fP should not be used with NTP \(aq11 minute mode\(aq. +.SS "ISA Hardware Clock Century value" +.sp +There is some sort of standard that defines CMOS memory Byte 50 on an ISA machine as an indicator of what century it is. \fBhwclock\fP does not use or set that byte because there are some machines that don\(cqt define the byte that way, and it really isn\(cqt necessary anyway, since the year\-of\-century does a good job of implying which century it is. +.sp +If you have a bona fide use for a CMOS century byte, contact the \fBhwclock\fP maintainer; an option may be appropriate. +.sp +Note that this section is only relevant when you are using the "direct ISA" method of accessing the Hardware Clock. ACPI provides a standard way to access century values, when they are supported by the hardware. +.SH "DATE\-TIME CONFIGURATION" +.SS "Keeping Time without External Synchronization" +.sp +This discussion is based on the following conditions: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +. sp -1 +. IP \(bu 2.3 +.\} +Nothing is running that alters the date\-time clocks, such as NTP daemon or a cron job." +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +. sp -1 +. IP \(bu 2.3 +.\} +The system timezone is configured for the correct local time. See below, under \fBPOSIX vs \(aqRIGHT\(aq\fP. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +. sp -1 +. IP \(bu 2.3 +.\} +Early during startup the following are called, in this order: \fBadjtimex \-\-tick\fP \fIvalue\fP \fB\-\-frequency\fP \fIvalue\fP \fBhwclock \-\-hctosys\fP +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +. sp -1 +. IP \(bu 2.3 +.\} +During shutdown the following is called: \fBhwclock \-\-systohc\fP +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +. sp -1 +. IP \(bu 2.3 +.\} +Systems without \fBadjtimex\fP may use \fBntptime\fP. +.RE +.RE +.sp +Whether maintaining precision time with NTP daemon or not, it makes sense to configure the system to keep reasonably good date\-time on its own. +.sp +The first step in making that happen is having a clear understanding of the big picture. There are two completely separate hardware devices running at their own speed and drifting away from the \(aqcorrect\(aq time at their own rates. The methods and software for drift correction are different for each of them. However, most systems are configured to exchange values between these two clocks at startup and shutdown. Now the individual device\(cqs time keeping errors are transferred back and forth between each other. Attempt to configure drift correction for only one of them, and the other\(cqs drift will be overlaid upon it. +.sp +This problem can be avoided when configuring drift correction for the System Clock by simply not shutting down the machine. This, plus the fact that all of \fBhwclock\fP\(aqs precision (including calculating drift factors) depends upon the System Clock\(cqs rate being correct, means that configuration of the System Clock should be done first. +.sp +The System Clock drift is corrected with the \fBadjtimex\fP(8) command\(cqs \fB\-\-tick\fP and \fB\-\-frequency\fP options. These two work together: tick is the coarse adjustment and frequency is the fine adjustment. (For systems that do not have an \fBadjtimex\fP package, \fBntptime \-f\fP \fIppm\fP may be used instead.) +.sp +Some Linux distributions attempt to automatically calculate the System Clock drift with \fBadjtimex\fP\(aqs compare operation. Trying to correct one drifting clock by using another drifting clock as a reference is akin to a dog trying to catch its own tail. Success may happen eventually, but great effort and frustration will likely precede it. This automation may yield an improvement over no configuration, but expecting optimum results would be in error. A better choice for manual configuration would be \fBadjtimex\fP\(aqs \fB\-\-log\fP options. +.sp +It may be more effective to simply track the System Clock drift with \fBsntp\fP, or \fBdate \-Ins\fP and a precision timepiece, and then calculate the correction manually. +.sp +After setting the tick and frequency values, continue to test and refine the adjustments until the System Clock keeps good time. See \fBadjtimex\fP(2) for more information and the example demonstrating manual drift calculations. +.sp +Once the System Clock is ticking smoothly, move on to the Hardware Clock. +.sp +As a rule, cold drift will work best for most use cases. This should be true even for 24/7 machines whose normal downtime consists of a reboot. In that case the drift factor value makes little difference. But on the rare occasion that the machine is shut down for an extended period, then cold drift should yield better results. +.sp +\fBSteps to calculate cold drift:\fP +.sp +1 +.RS 4 +\fBEnsure that NTP daemon will not be launched at startup.\fP +.RE +.sp +2 +.RS 4 +The \fISystem Clock\fP time must be correct at shutdown! +.RE +.sp +3 +.RS 4 +Shut down the system. +.RE +.sp +4 +.RS 4 +Let an extended period pass without changing the Hardware Clock. +.RE +.sp +5 +.RS 4 +Start the system. +.RE +.sp +6 +.RS 4 +Immediately use \fBhwclock\fP to set the correct time, adding the \fB\-\-update\-drift\fP option. +.RE +.sp +Note: if step 6 uses \fB\-\-systohc\fP, then the System Clock must be set correctly (step 6a) just before doing so. +.sp +Having \fBhwclock\fP calculate the drift factor is a good starting point, but for optimal results it will likely need to be adjusted by directly editing the \fI/etc/adjtime\fP file. Continue to test and refine the drift factor until the Hardware Clock is corrected properly at startup. To check this, first make sure that the System Time is correct before shutdown and then use \fBsntp\fP, or \fBdate \-Ins\fP and a precision timepiece, immediately after startup. +.SS "LOCAL vs UTC" +.sp +Keeping the Hardware Clock in a local timescale causes inconsistent daylight saving time results: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +. sp -1 +. IP \(bu 2.3 +.\} +If Linux is running during a daylight saving time change, the time written to the Hardware Clock will be adjusted for the change. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +. sp -1 +. IP \(bu 2.3 +.\} +If Linux is NOT running during a daylight saving time change, the time read from the Hardware Clock will NOT be adjusted for the change. +.RE +.sp +The Hardware Clock on an ISA compatible system keeps only a date and time, it has no concept of timezone nor daylight saving. Therefore, when \fBhwclock\fP is told that it is in local time, it assumes it is in the \(aqcorrect\(aq local time and makes no adjustments to the time read from it. +.sp +Linux handles daylight saving time changes transparently only when the Hardware Clock is kept in the UTC timescale. Doing so is made easy for system administrators as \fBhwclock\fP uses local time for its output and as the argument to the \fB\-\-date\fP option. +.sp +POSIX systems, like Linux, are designed to have the System Clock operate in the UTC timescale. The Hardware Clock\(cqs purpose is to initialize the System Clock, so also keeping it in UTC makes sense. +.sp +Linux does, however, attempt to accommodate the Hardware Clock being in the local timescale. This is primarily for dual\-booting with older versions of MS Windows. From Windows 7 on, the RealTimeIsUniversal registry key is supposed to be working properly so that its Hardware Clock can be kept in UTC. +.SS "POSIX vs \(aqRIGHT\(aq" +.sp +A discussion on date\-time configuration would be incomplete without addressing timezones, this is mostly well covered by \fBtzset\fP(3). One area that seems to have no documentation is the \(aqright\(aq directory of the Time Zone Database, sometimes called tz or zoneinfo. +.sp +There are two separate databases in the zoneinfo system, posix and \(aqright\(aq. \(aqRight\(aq (now named zoneinfo\-leaps) includes leap seconds and posix does not. To use the \(aqright\(aq database the System Clock must be set to (UTC + leap seconds), which is equivalent to (TAI \- 10). This allows calculating the exact number of seconds between two dates that cross a leap second epoch. The System Clock is then converted to the correct civil time, including UTC, by using the \(aqright\(aq timezone files which subtract the leap seconds. Note: this configuration is considered experimental and is known to have issues. +.sp +To configure a system to use a particular database all of the files located in its directory must be copied to the root of \fI/usr/share/zoneinfo\fP. Files are never used directly from the posix or \(aqright\(aq subdirectories, e.g., TZ=\(aq\fIright/Europe/Dublin\fP\(aq. This habit was becoming so common that the upstream zoneinfo project restructured the system\(cqs file tree by moving the posix and \(aqright\(aq subdirectories out of the zoneinfo directory and into sibling directories: +.sp +\fI/usr/share/zoneinfo\fP, \fI/usr/share/zoneinfo\-posix\fP, \fI/usr/share/zoneinfo\-leaps\fP +.sp +Unfortunately, some Linux distributions are changing it back to the old tree structure in their packages. So the problem of system administrators reaching into the \(aqright\(aq subdirectory persists. This causes the system timezone to be configured to include leap seconds while the zoneinfo database is still configured to exclude them. Then when an application such as a World Clock needs the South_Pole timezone file; or an email MTA, or \fBhwclock\fP needs the UTC timezone file; they fetch it from the root of \fI/usr/share/zoneinfo\fP , because that is what they are supposed to do. Those files exclude leap seconds, but the System Clock now includes them, causing an incorrect time conversion. +.sp +Attempting to mix and match files from these separate databases will not work, because they each require the System Clock to use a different timescale. The zoneinfo database must be configured to use either posix or \(aqright\(aq, as described above, or by assigning a database path to the \fITZDIR\fP environment variable. +.SH "EXIT STATUS" +.sp +One of the following exit values will be returned: +.sp +\fBEXIT_SUCCESS\fP (\(aq0\(aq on POSIX systems) +.RS 4 +Successful program execution. +.RE +.sp +\fBEXIT_FAILURE\fP (\(aq1\(aq on POSIX systems) +.RS 4 +The operation failed or the command syntax was not valid. +.RE +.SH "ENVIRONMENT" +.sp +\fBTZ\fP +.RS 4 +If this variable is set its value takes precedence over the system configured timezone. +.RE +.sp +\fBTZDIR\fP +.RS 4 +If this variable is set its value takes precedence over the system configured timezone database directory path. +.RE +.SH "FILES" +.sp +\fI/etc/adjtime\fP +.RS 4 +The configuration and state file for hwclock. +.RE +.sp +\fI/etc/localtime\fP +.RS 4 +The system timezone file. +.RE +.sp +\fI/usr/share/zoneinfo/\fP +.RS 4 +The system timezone database directory. +.RE +.sp +Device files \fBhwclock\fP may try for Hardware Clock access: \fI/dev/rtc0\fP \fI/dev/rtc\fP \fI/dev/misc/rtc\fP \fI/dev/efirtc\fP \fI/dev/misc/efirtc\fP +.SH "SEE ALSO" +.sp +\fBdate\fP(1), +\fBadjtimex\fP(8), +\fBgettimeofday\fP(2), +\fBsettimeofday\fP(2), +\fBcrontab\fP(1p), +\fBtzset\fP(3) +.SH "AUTHORS" +.sp +Written by \c +.MTO "bryanh\(atgiraffe\-data.com" "Bryan Henderson" "," +September 1996, based on work done on the \fBclock\fP(8) program by Charles Hedrick, Rob Hooft, and Harald Koenig. See the source code for complete history and credits. +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBhwclock\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/iconvconfig.8 b/upstream/opensuse-leap-15-6/man8/iconvconfig.8 new file mode 100644 index 00000000..5cbc0c0c --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/iconvconfig.8 @@ -0,0 +1,86 @@ +.\" Copyright (C) 2014 Marko Myllynen <myllynen@redhat.com> +.\" +.\" SPDX-License-Identifier: GPL-2.0-or-later +.\" +.TH iconvconfig 8 2022-10-30 "Linux man-pages 6.04" +.SH NAME +iconvconfig \- create iconv module configuration cache +.SH SYNOPSIS +.B iconvconfig +.RI [ options ] +.RI [ directory ]... +.SH DESCRIPTION +The +.BR iconv (3) +function internally uses +.I gconv +modules to convert to and from a character set. +A configuration file is used to determine the needed modules +for a conversion. +Loading and parsing such a configuration file would slow down +programs that use +.BR iconv (3), +so a caching mechanism is employed. +.PP +The +.B iconvconfig +program reads iconv module configuration files and writes +a fast-loading gconv module configuration cache file. +.PP +In addition to the system provided gconv modules, the user can specify +custom gconv module directories with the environment variable +.BR GCONV_PATH . +However, iconv module configuration caching is used only when +the environment variable +.B GCONV_PATH +is not set. +.SH OPTIONS +.TP +.B "\-\-nostdlib" +Do not search the system default gconv directory, +only the directories provided on the command line. +.TP +.BI \-o " outputfile" ", \-\-output=" outputfile +Use +.I outputfile +for output instead of the system default cache location. +.TP +.BI \-\-prefix= pathname +Set the prefix to be prepended to the system pathnames. +See FILES, below. +By default, the prefix is empty. +Setting the prefix to +.IR foo , +the gconv module configuration would be read from +.I foo/usr/lib/gconv/gconv\-modules +and the cache would be written to +.IR foo/usr/lib/gconv/gconv\-modules.cache . +.TP +.BR \-? ", " \-\-help +Print a usage summary and exit. +.TP +.B "\-\-usage" +Print a short usage summary and exit. +.TP +.BR \-V ", " \-\-version +Print the version number, license, and disclaimer of warranty for +.BR iconv . +.SH EXIT STATUS +Zero on success, nonzero on errors. +.SH FILES +.TP +.I /usr/lib/gconv +Usual default gconv module path. +.TP +.I /usr/lib/gconv/gconv\-modules +Usual system default gconv module configuration file. +.TP +.I /usr/lib/gconv/gconv\-modules.cache +Usual system gconv module configuration cache. +.PP +Depending on the architecture, +the above files may instead be located at directories with the path prefix +.IR /usr/lib64 . +.SH SEE ALSO +.BR iconv (1), +.BR iconv (3) diff --git a/upstream/opensuse-leap-15-6/man8/idmapd.8 b/upstream/opensuse-leap-15-6/man8/idmapd.8 new file mode 100644 index 00000000..d4ab8944 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/idmapd.8 @@ -0,0 +1,115 @@ +.\" $OpenBSD: mdoc.template,v 1.6 2001/02/03 08:22:44 niklas Exp $ +.\" +.\" The following requests are required for all man pages. +.Dd February 3, 2003 +.Dt RPC.IDMAPD 8 +.Os +.Sh NAME +.Nm rpc.idmapd +.Nd NFSv4 ID <-> Name Mapper +.Sh SYNOPSIS +.\" For a program: program [-abc] file ... +.Nm rpc.idmapd +.Op Fl h +.Op Fl f +.Op Fl v +.Op Fl C +.Op Fl S +.Op Fl p Ar path +.Op Fl c Ar path +.Sh DESCRIPTION +.Nm +is the NFSv4 ID <-> name mapping daemon. It provides functionality to +the NFSv4 kernel client and server, to which it communicates via +upcalls, by translating user and group IDs to names, and vice versa. +.Pp +The system derives the +.I user +part of the string by performing a password or group lookup. +The lookup mechanism is configured in +.Pa /etc/idmapd.conf +.Pp +By default, the +.I domain +part of the string is the system's DNS domain name. +It can also be specified in +.Pa /etc/idmapd.conf +if the system is multi-homed, +or if the system's DNS domain name does +not match the name of the system's Kerberos realm. +.Pp +When the domain is not specified in /etc/idmapd.conf +the local DNS server will be queried for the +.Sy _nfsv4idmapdomain +text record. If the record exists +that will be used as the domain. When the record +does not exist, the domain part of the DNS domain +will used. +.Pp +Note that on more recent kernels only the NFSv4 server uses +.Nm . +The NFSv4 client instead uses +.Xr nfsidmap 8 , +and only falls back to +.Nm +if there was a problem running the +.Xr nfsidmap 8 +program. +.Pp +The options are as follows: +.Bl -tag -width Ds_imagedir +.It Fl h +Display usage message. +.It Fl v +Increases the verbosity level (can be specified multiple times). +.It Fl f +Runs +.Nm +in the foreground and prints all output to the terminal. +.It Fl p Ar path +Specifies the location of the RPC pipefs to be +.Ar path . +The default value is \&"/var/lib/nfs/rpc_pipefs\&". +.It Fl c Ar path +Use configuration file +.Ar path . +.It Fl C +Client-only: perform no idmapping for any NFS server, even if one is detected. +.It Fl S +Server-only: perform no idmapping for any NFS client, even if one is detected. +.El +.Sh EXAMPLES +.Cm rpc.idmapd -f -vvv +.Pp +Runs +.Nm +printing all +messages to console, and with a verbosity level of 3. +.\" This next request is for sections 2 and 3 function return values only. +.\" .Sh RETURN VALUES +.\" The next request is for sections 2 and 3 error and signal handling only. +.\" .Sh ERRORS +.\" This next request is for section 4 only. +.\" .Sh DIAGNOSTICS +.\" This next request is for sections 1, 6, 7 & 8 only. +.\" .Sh ENVIRONMENT +.Sh FILES +.Pa /etc/idmapd.conf +.Sh SEE ALSO +.Xr idmapd.conf 5 , +.Xr nfsidmap 8 +.\".Sh SEE ALSO +.\".Xr nylon.conf 4 +.\" .Sh COMPATIBILITY +.\".Sh STANDARDS +.\".Sh ACKNOWLEDGEMENTS +.Sh AUTHORS +The +.Nm +software has been developed by Marius Aamodt Eriksen +.Aq marius@citi.umich.edu . +.\" .Sh HISTORY +.\".Sh BUGS +.\"Please report any bugs to Marius Aamodt Eriksen +.\".Aq marius@monkey.org . +.\" .Sh CAVEATS diff --git a/upstream/opensuse-leap-15-6/man8/ifrename.8 b/upstream/opensuse-leap-15-6/man8/ifrename.8 new file mode 100644 index 00000000..48b6be9d --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/ifrename.8 @@ -0,0 +1,191 @@ +.\" Jean II - HPL - 2004-2007 +.\" ifrename.8 +.\" +.TH IFRENAME 8 "26 February 2007" "wireless-tools" "Linux Programmer's Manual" +.\" +.\" NAME part +.\" +.SH NAME +ifrename \- rename network interfaces based on various static criteria +.\" +.\" SYNOPSIS part +.\" +.SH SYNOPSIS +.B "ifrename [-c configfile] [-p] [-d] [-u] [-v] [-V] [-D] [-C]" +.br +.B "ifrename [-c configfile] [-i interface] [-n newname]" +.\" +.\" DESCRIPTION part +.\" +.SH DESCRIPTION +.B Ifrename +is a tool allowing you to assign a consistent name to each of your +network interface. +.PP +By default, interface names are dynamic, and each network interface is +assigned the first available name +.RI ( eth0 ", " eth1 "...)." +The order network interfaces are created may vary. For built-in +interfaces, the kernel boot time enumeration may vary. For removable +interface, the user may plug them in any order. +.PP +.B Ifrename +allow the user to decide what name a network interface will have. +.B Ifrename +can use a variety of +.I selectors +to specify how interface names match the network interfaces on the +system, the most common selector is the interface +.IR "MAC address" . +.PP +.B Ifrename +must be run before interfaces are brought up, which is why it's mostly +useful in various scripts (init, hotplug) but is seldom used directly +by the user. By default, +.B ifrename +renames all present system interfaces using mappings defined in +.IR /etc/iftab . +.\" +.\" PARAMETER part +.\" +.SH PARAMETERS +.TP +.BI "-c " configfile +Set the configuration file to be used (by default +.IR /etc/iftab ). +The configuration file define the mapping between selectors and +interface names, and is described in +.IR iftab (5). +.br +If +.I configfile +is "-", the configuration is read from stdin. +.TP +.B -p +Probe (load) kernel modules before renaming interfaces. By default +.B ifrename +only check interfaces already loaded, and doesn't auto-load the +required kernel modules. This option enables smooth integration with +system not loading modules before calling +.BR ifrename . +.TP +.B -d +Enable various +.B Debian +specific hacks. Combined with +.BR -p , +only modules for interfaces specified in +.I /etc/network/interface +are loaded. +.TP +.BI "-i " interface +Only rename the specified +.I interface +as opposed to all interfaces on the system. The new interface name is +printed. +.TP +.BI "-n " newname +When used with +.IR -i , +specify the new name of the interface. The list of mappings from the +configuration file is bypassed, the interface specified with +.I -i +is renamed directly to +.IR newname . +The new name may be a wildcard containing a single '*'. +.br +When used without +.IR -i , +rename interfaces by using only mappings that would rename them to +.IR newname . +The new name may not be a wildcard. This use of ifrename is +discouraged, because inefficient +.RI ( -n " without " -i ). +All the interfaces of the system need to be processed at each +invocation, therefore in most case it is not faster than just letting +ifrename renaming all of them (without both +.IR -n " and " -i ). +.TP +.B -t +Enable name takeover support. This allow interface name swapping +between two or more interfaces. +.br +Takeover enable an interface to 'steal' the name of another +interface. This works only with kernel 2.6.X and if the other +interface is down. Consequently, this is not compatible with +Hotplug. The other interface is assigned a random name, but may be +renamed later with 'ifrename'. +.br +The number of takeovers is limited to avoid circular loops, and +therefore some complex multi-way name swapping situations may not be +fully processed. +.br +In any case, name swapping and the use of this feature is discouraged, +and you are invited to choose unique and unambiguous names for your +interfaces... +.TP +.B -u +Enable +.I udev +output mode. This enables proper integration of +.B ifrename +in the +.I udev +framework, +.BR udevd (8) +will use +.B ifrename +to assign interface names present in +.IR /etc/iftab . +In this mode the output of ifrename can be parsed +directly by +.BR udevd (8) +as an IMPORT action. This requires +.I udev +version 107 or later. +.TP +.B -D +Dry-run mode. Ifrename won't change any interface, it will only print +new interface name, if applicable, and return. +.br +In dry-run mode, interface name wildcards are not resolved. New +interface name is printed, even if it is the same as the old name. +.br +Be also aware that some selectors can only be read by root, for +example those based on +.BR ethtool ), +and will fail silently if run by a normal user. In other words, +dry-run mode under a standard user may not give the expected result. +.TP +.B -V +Verbose mode. Ifrename will display internal results of parsing its +configuration file and querying the interfaces selectors. Combined +with the +.I dry-run +option, this is a good way to debug complex configurations or trivial +problems. +.TP +.B -C +Count matching interfaces. Display the number of interface matched, +and return it as the exit status of ifrename. +.br +The number of interfaces matched is the number of interface on the +system for which a mapping was found in the config file (which is +different from the number of interface renamed). +.\" +.\" AUTHOR part +.\" +.SH AUTHOR +Jean Tourrilhes \- jt@hpl.hp.com +.\" +.\" FILES part +.\" +.SH FILES +.I /etc/iftab +.\" +.\" SEE ALSO part +.\" +.SH SEE ALSO +.BR ifconfig (8), +.BR ip (8), +.BR iftab (5). diff --git a/upstream/opensuse-leap-15-6/man8/in.ntalkd.8 b/upstream/opensuse-leap-15-6/man8/in.ntalkd.8 new file mode 100644 index 00000000..ebe8b517 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/in.ntalkd.8 @@ -0,0 +1,86 @@ +.\" Copyright (c) 1983, 1991 The Regents of the University of California. +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. All advertising materials mentioning features or use of this software +.\" must display the following acknowledgement: +.\" This product includes software developed by the University of +.\" California, Berkeley and its contributors. +.\" 4. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" from: @(#)talkd.8 6.5 (Berkeley) 3/16/91 +.\" $Id: talkd.8,v 1.14 2000/07/30 23:57:02 dholland Exp $ +.\" +.Dd March 16, 1991 +.Dt TALKD 8 +.Os "Linux NetKit (0.17)" +.Sh NAME +.Nm talkd +.Nd remote user communication server +.Sh SYNOPSIS +.Nm talkd +.Op Fl dp +.Sh DESCRIPTION +.Nm Talkd +is the server that notifies a user that someone else wants to +initiate a conversation. +It acts a repository of invitations, responding to requests +by clients wishing to rendezvous to hold a conversation. +In normal operation, a client, the caller, +initiates a rendezvous by sending a +.Tn CTL_MSG +to the server of +type +.Tn LOOK_UP +(see +.Aq Pa protocols/talkd.h ) . +This causes the server to search its invitation +tables to check if an invitation currently exists for the caller +(to speak to the callee specified in the message). +If the lookup fails, +the caller then sends an +.Tn ANNOUNCE +message causing the server to +broadcast an announcement on the callee's login ports requesting contact. +When the callee responds, the local server uses the +recorded invitation to respond with the appropriate rendezvous +address and the caller and callee client programs establish a +stream connection through which the conversation takes place. +.Sh OPTIONS +.Op Fl d +Debug mode; writes copious logging and debugging information to +.Pa /var/log/talkd.log . +.Pp +.Op Fl p +Packet logging mode; writes copies of malformed packets to +.Pa /var/log/talkd.packets . +This is useful for debugging interoperability problems. +.Sh SEE ALSO +.Xr talk 1 , +.Xr write 1 +.Sh HISTORY +The +.Nm +command appeared in +.Bx 4.3 . diff --git a/upstream/opensuse-leap-15-6/man8/insmod.8 b/upstream/opensuse-leap-15-6/man8/insmod.8 new file mode 100644 index 00000000..53eed698 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/insmod.8 @@ -0,0 +1,65 @@ +'\" t +.\" Title: insmod +.\" Author: Jon Masters <jcm@jonmasters.org> +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 01/29/2021 +.\" Manual: insmod +.\" Source: kmod +.\" Language: English +.\" +.TH "INSMOD" "8" "01/29/2021" "kmod" "insmod" +.\" ----------------------------------------------------------------- +.\" * 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" +insmod \- Simple program to insert a module into the Linux Kernel +.SH "SYNOPSIS" +.HP \w'\fBinsmod\fR\ 'u +\fBinsmod\fR [\fIfilename\fR] [\fImodule\ options\fR...] +.SH "DESCRIPTION" +.PP +\fBinsmod\fR +is a trivial program to insert a module into the kernel\&. Most users will want to use +\fBmodprobe\fR(8) +instead, which is more clever and can handle module dependencies\&. +.PP +Only the most general of error messages are reported: as the work of trying to link the module is now done inside the kernel, the +\fBdmesg\fR +usually gives more information about errors\&. +.SH "COPYRIGHT" +.PP +This manual page originally Copyright 2002, Rusty Russell, IBM Corporation\&. Maintained by Jon Masters and others\&. +.SH "SEE ALSO" +.PP +\fBmodprobe\fR(8), +\fBrmmod\fR(8), +\fBlsmod\fR(8), +\fBmodinfo\fR(8) +\fBdepmod\fR(8) +.SH "AUTHORS" +.PP +\fBJon Masters\fR <\&jcm@jonmasters\&.org\&> +.RS 4 +Developer +.RE +.PP +\fBLucas De Marchi\fR <\&lucas\&.de\&.marchi@gmail\&.com\&> +.RS 4 +Developer +.RE diff --git a/upstream/opensuse-leap-15-6/man8/intro.8 b/upstream/opensuse-leap-15-6/man8/intro.8 new file mode 100644 index 00000000..2cce0646 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/intro.8 @@ -0,0 +1,29 @@ +.\" Copyright (c) 1993 Michael Haardt (michael@moria.de), +.\" Fri Apr 2 11:32:09 MET DST 1993 +.\" and Copyright (C) 2007 Michael Kerrisk <mtk.manpages@gmail.com> +.\" +.\" SPDX-License-Identifier: GPL-2.0-or-later +.\" +.\" Modified Sat Jul 24 17:35:48 1993 by Rik Faith (faith@cs.unc.edu) +.\" 2007-10-23 mtk: minor rewrites, and added paragraph on exit status +.\" +.TH intro 8 2022-10-30 "Linux man-pages 6.04" +.SH NAME +intro \- introduction to administration and privileged commands +.SH DESCRIPTION +Section 8 of the manual describes commands +which either can be or are used only by the superuser, +like system-administration commands, daemons, +and hardware-related commands. +.PP +As with the commands described in Section 1, the commands described +in this section terminate with an exit status that indicates +whether the command succeeded or failed. +See +.BR intro (1) +for more information. +.SH NOTES +.SS Authors and copyright conditions +Look at the header of the manual page source for the author(s) and copyright +conditions. +Note that these can be different from page to page! diff --git a/upstream/opensuse-leap-15-6/man8/iptables-apply.8 b/upstream/opensuse-leap-15-6/man8/iptables-apply.8 new file mode 100644 index 00000000..9ef19c33 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/iptables-apply.8 @@ -0,0 +1,60 @@ +.\" Title: iptables-apply +.\" Author: Martin F. Krafft, GW +.\" Date: May 10, 2010 +.\" +.TH IPTABLES\-APPLY 8 "" "iptables 1.8.7" "iptables 1.8.7" +.\" disable hyphenation +.nh +.SH NAME +iptables-apply \- a safer way to update iptables remotely +.SH SYNOPSIS +\fBiptables\-apply\fP [\-\fBhV\fP] [\fB-t\fP \fItimeout\fP] [\fB-w\fP \fIsavefile\fP] {[\fIrulesfile]|-c [runcmd]}\fP +.SH "DESCRIPTION" +.PP +iptables\-apply will try to apply a new rulesfile (as output by +iptables-save, read by iptables-restore) or run a command to configure +iptables and then prompt the user whether the changes are okay. If the +new iptables rules cut the existing connection, the user will not be +able to answer affirmatively. In this case, the script rolls back to +the previous working iptables rules after the timeout expires. +.PP +Successfully applied rules can also be written to savefile and later used +to roll back to this state. This can be used to implement a store last good +configuration mechanism when experimenting with an iptables setup script: +iptables-apply \-w /etc/network/iptables.up.rules \-c /etc/network/iptables.up.run +.PP +When called as ip6tables\-apply, the script will use +ip6tables\-save/\-restore and IPv6 default values instead. Default +value for rulesfile is '/etc/network/iptables.up.rules'. +.SH OPTIONS +.TP +\fB\-t\fP \fIseconds\fR, \fB\-\-timeout\fP \fIseconds\fR +Sets the timeout in seconds after which the script will roll back +to the previous ruleset (default: 10). +.TP +\fB\-w\fP \fIsavefile\fR, \fB\-\-write\fP \fIsavefile\fR +Specify the savefile where successfully applied rules will be written to +(default if empty string is given: /etc/network/iptables.up.rules). +.TP +\fB\-c\fP \fIruncmd\fR, \fB\-\-command\fP \fIruncmd\fR +Run command runcmd to configure iptables instead of applying a rulesfile +(default: /etc/network/iptables.up.run). +.TP +\fB\-h\fP, \fB\-\-help\fP +Display usage information. +.TP +\fB\-V\fP, \fB\-\-version\fP +Display version information. +.SH "SEE ALSO" +.PP +\fBiptables-restore\fP(8), \fBiptables-save\fP(8), \fBiptables\fR(8). +.SH LEGALESE +.PP +Original iptables-apply - Copyright 2006 Martin F. Krafft <madduck@madduck.net>. +Version 1.1 - Copyright 2010 GW <gw.2010@tnode.com or http://gw.tnode.com/>. +.PP +This manual page was written by Martin F. Krafft <madduck@madduck.net> and +extended by GW <gw.2010@tnode.com or http://gw.tnode.com/>. +.PP +Permission is granted to copy, distribute and/or modify this document +under the terms of the Artistic License 2.0. diff --git a/upstream/opensuse-leap-15-6/man8/iptables-extensions.8 b/upstream/opensuse-leap-15-6/man8/iptables-extensions.8 new file mode 100644 index 00000000..df607775 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/iptables-extensions.8 @@ -0,0 +1,3010 @@ +.TH iptables-extensions 8 "" "iptables 1.8.7" "iptables 1.8.7" +.SH NAME +iptables-extensions \(em list of extensions in the standard iptables distribution +.SH SYNOPSIS +\fBip6tables\fP [\fB\-m\fP \fIname\fP [\fImodule-options\fP...]] +[\fB\-j\fP \fItarget-name\fP [\fItarget-options\fP...] +.PP +\fBiptables\fP [\fB\-m\fP \fIname\fP [\fImodule-options\fP...]] +[\fB\-j\fP \fItarget-name\fP [\fItarget-options\fP...] +.SH MATCH EXTENSIONS +iptables can use extended packet matching modules +with the \fB\-m\fP or \fB\-\-match\fP +options, followed by the matching module name; after these, various +extra command line options become available, depending on the specific +module. You can specify multiple extended match modules in one line, +and you can use the \fB\-h\fP or \fB\-\-help\fP +options after the module has been specified to receive help specific +to that module. The extended match modules are evaluated in the order +they are specified in the rule. +.PP +If the \fB\-p\fP or \fB\-\-protocol\fP was specified and if and only if an +unknown option is encountered, iptables will try load a match module of the +same name as the protocol, to try making the option available. +.\" @MATCH@ +.SS addrtype +This module matches packets based on their +.B address type. +Address types are used within the kernel networking stack and categorize +addresses into various groups. The exact definition of that group depends on the specific layer three protocol. +.PP +The following address types are possible: +.TP +.BI "UNSPEC" +an unspecified address (i.e. 0.0.0.0) +.TP +.BI "UNICAST" +an unicast address +.TP +.BI "LOCAL" +a local address +.TP +.BI "BROADCAST" +a broadcast address +.TP +.BI "ANYCAST" +an anycast packet +.TP +.BI "MULTICAST" +a multicast address +.TP +.BI "BLACKHOLE" +a blackhole address +.TP +.BI "UNREACHABLE" +an unreachable address +.TP +.BI "PROHIBIT" +a prohibited address +.TP +.BI "THROW" +FIXME +.TP +.BI "NAT" +FIXME +.TP +.BI "XRESOLVE" +.TP +[\fB!\fP] \fB\-\-src\-type\fP \fItype\fP +Matches if the source address is of given type +.TP +[\fB!\fP] \fB\-\-dst\-type\fP \fItype\fP +Matches if the destination address is of given type +.TP +.BI "\-\-limit\-iface\-in" +The address type checking can be limited to the interface the packet is coming +in. This option is only valid in the +.BR PREROUTING , +.B INPUT +and +.B FORWARD +chains. It cannot be specified with the +\fB\-\-limit\-iface\-out\fP +option. +.TP +\fB\-\-limit\-iface\-out\fP +The address type checking can be limited to the interface the packet is going +out. This option is only valid in the +.BR POSTROUTING , +.B OUTPUT +and +.B FORWARD +chains. It cannot be specified with the +\fB\-\-limit\-iface\-in\fP +option. +.SS ah (IPv6-specific) +This module matches the parameters in Authentication header of IPsec packets. +.TP +[\fB!\fP] \fB\-\-ahspi\fP \fIspi\fP[\fB:\fP\fIspi\fP] +Matches SPI. +.TP +[\fB!\fP] \fB\-\-ahlen\fP \fIlength\fP +Total length of this header in octets. +.TP +\fB\-\-ahres\fP +Matches if the reserved field is filled with zero. +.SS ah (IPv4-specific) +This module matches the SPIs in Authentication header of IPsec packets. +.TP +[\fB!\fP] \fB\-\-ahspi\fP \fIspi\fP[\fB:\fP\fIspi\fP] +.SS bpf +Match using Linux Socket Filter. Expects a path to an eBPF object or a cBPF +program in decimal format. +.TP +\fB\-\-object\-pinned\fP \fIpath\fP +Pass a path to a pinned eBPF object. +.PP +Applications load eBPF programs into the kernel with the bpf() system call and +BPF_PROG_LOAD command and can pin them in a virtual filesystem with BPF_OBJ_PIN. +To use a pinned object in iptables, mount the bpf filesystem using +.IP +mount \-t bpf bpf ${BPF_MOUNT} +.PP +then insert the filter in iptables by path: +.IP +iptables \-A OUTPUT \-m bpf \-\-object\-pinned ${BPF_MOUNT}/{PINNED_PATH} \-j ACCEPT +.TP +\fB\-\-bytecode\fP \fIcode\fP +Pass the BPF byte code format as generated by the \fBnfbpf_compile\fP utility. +.PP +The code format is similar to the output of the tcpdump \-ddd command: one line +that stores the number of instructions, followed by one line for each +instruction. Instruction lines follow the pattern 'u16 u8 u8 u32' in decimal +notation. Fields encode the operation, jump offset if true, jump offset if +false and generic multiuse field 'K'. Comments are not supported. +.PP +For example, to read only packets matching 'ip proto 6', insert the following, +without the comments or trailing whitespace: +.IP +4 # number of instructions +.br +48 0 0 9 # load byte ip->proto +.br +21 0 1 6 # jump equal IPPROTO_TCP +.br +6 0 0 1 # return pass (non-zero) +.br +6 0 0 0 # return fail (zero) +.PP +You can pass this filter to the bpf match with the following command: +.IP +iptables \-A OUTPUT \-m bpf \-\-bytecode '4,48 0 0 9,21 0 1 6,6 0 0 1,6 0 0 0' \-j ACCEPT +.PP +Or instead, you can invoke the nfbpf_compile utility. +.IP +iptables \-A OUTPUT \-m bpf \-\-bytecode "`nfbpf_compile RAW 'ip proto 6'`" \-j ACCEPT +.PP +Or use tcpdump -ddd. In that case, generate BPF targeting a device with the +same data link type as the xtables match. Iptables passes packets from the +network layer up, without mac layer. Select a device with data link type RAW, +such as a tun device: +.IP +ip tuntap add tun0 mode tun +.br +ip link set tun0 up +.br +tcpdump -ddd -i tun0 ip proto 6 +.PP +See tcpdump -L -i $dev for a list of known data link types for a given device. +.PP +You may want to learn more about BPF from FreeBSD's bpf(4) manpage. +.SS cgroup +.TP +[\fB!\fP] \fB\-\-path\fP \fIpath\fP +Match cgroup2 membership. + +Each socket is associated with the v2 cgroup of the creating process. +This matches packets coming from or going to all sockets in the +sub-hierarchy of the specified path. The path should be relative to +the root of the cgroup2 hierarchy. +.TP +[\fB!\fP] \fB\-\-cgroup\fP \fIclassid\fP +Match cgroup net_cls classid. + +classid is the marker set through the cgroup net_cls controller. This +option and \-\-path can't be used together. +.PP +Example: +.IP +iptables \-A OUTPUT \-p tcp \-\-sport 80 \-m cgroup ! \-\-path service/http-server \-j DROP +.IP +iptables \-A OUTPUT \-p tcp \-\-sport 80 \-m cgroup ! \-\-cgroup 1 +\-j DROP +.PP +\fBIMPORTANT\fP: when being used in the INPUT chain, the cgroup +matcher is currently only of limited functionality, meaning it +will only match on packets that are processed for local sockets +through early socket demuxing. Therefore, general usage on the +INPUT chain is not advised unless the implications are well +understood. +.PP +Available since Linux 3.14. +.SS cluster +Allows you to deploy gateway and back-end load-sharing clusters without the +need of load-balancers. +.PP +This match requires that all the nodes see the same packets. Thus, the cluster +match decides if this node has to handle a packet given the following options: +.TP +\fB\-\-cluster\-total\-nodes\fP \fInum\fP +Set number of total nodes in cluster. +.TP +[\fB!\fP] \fB\-\-cluster\-local\-node\fP \fInum\fP +Set the local node number ID. +.TP +[\fB!\fP] \fB\-\-cluster\-local\-nodemask\fP \fImask\fP +Set the local node number ID mask. You can use this option instead +of \fB\-\-cluster\-local\-node\fP. +.TP +\fB\-\-cluster\-hash\-seed\fP \fIvalue\fP +Set seed value of the Jenkins hash. +.PP +Example: +.IP +iptables \-A PREROUTING \-t mangle \-i eth1 \-m cluster +\-\-cluster\-total\-nodes 2 \-\-cluster\-local\-node 1 +\-\-cluster\-hash\-seed 0xdeadbeef +\-j MARK \-\-set-mark 0xffff +.IP +iptables \-A PREROUTING \-t mangle \-i eth2 \-m cluster +\-\-cluster\-total\-nodes 2 \-\-cluster\-local\-node 1 +\-\-cluster\-hash\-seed 0xdeadbeef +\-j MARK \-\-set\-mark 0xffff +.IP +iptables \-A PREROUTING \-t mangle \-i eth1 +\-m mark ! \-\-mark 0xffff \-j DROP +.IP +iptables \-A PREROUTING \-t mangle \-i eth2 +\-m mark ! \-\-mark 0xffff \-j DROP +.PP +And the following commands to make all nodes see the same packets: +.IP +ip maddr add 01:00:5e:00:01:01 dev eth1 +.IP +ip maddr add 01:00:5e:00:01:02 dev eth2 +.IP +arptables \-A OUTPUT \-o eth1 \-\-h\-length 6 +\-j mangle \-\-mangle-mac-s 01:00:5e:00:01:01 +.IP +arptables \-A INPUT \-i eth1 \-\-h-length 6 +\-\-destination-mac 01:00:5e:00:01:01 +\-j mangle \-\-mangle\-mac\-d 00:zz:yy:xx:5a:27 +.IP +arptables \-A OUTPUT \-o eth2 \-\-h\-length 6 +\-j mangle \-\-mangle\-mac\-s 01:00:5e:00:01:02 +.IP +arptables \-A INPUT \-i eth2 \-\-h\-length 6 +\-\-destination\-mac 01:00:5e:00:01:02 +\-j mangle \-\-mangle\-mac\-d 00:zz:yy:xx:5a:27 +.PP +\fBNOTE\fP: the arptables commands above use mainstream syntax. If you +are using arptables-jf included in some RedHat, CentOS and Fedora +versions, you will hit syntax errors. Therefore, you'll have to adapt +these to the arptables-jf syntax to get them working. +.PP +In the case of TCP connections, pickup facility has to be disabled +to avoid marking TCP ACK packets coming in the reply direction as +valid. +.IP +echo 0 > /proc/sys/net/netfilter/nf_conntrack_tcp_loose +.SS comment +Allows you to add comments (up to 256 characters) to any rule. +.TP +\fB\-\-comment\fP \fIcomment\fP +.TP +Example: +iptables \-A INPUT \-i eth1 \-m comment \-\-comment "my local LAN" +.SS connbytes +Match by how many bytes or packets a connection (or one of the two +flows constituting the connection) has transferred so far, or by +average bytes per packet. +.PP +The counters are 64-bit and are thus not expected to overflow ;) +.PP +The primary use is to detect long-lived downloads and mark them to be +scheduled using a lower priority band in traffic control. +.PP +The transferred bytes per connection can also be viewed through +`conntrack \-L` and accessed via ctnetlink. +.PP +NOTE that for connections which have no accounting information, the match will +always return false. The "net.netfilter.nf_conntrack_acct" sysctl flag controls +whether \fBnew\fP connections will be byte/packet counted. Existing connection +flows will not be gaining/losing a/the accounting structure when be sysctl flag +is flipped. +.TP +[\fB!\fP] \fB\-\-connbytes\fP \fIfrom\fP[\fB:\fP\fIto\fP] +match packets from a connection whose packets/bytes/average packet +size is more than FROM and less than TO bytes/packets. if TO is +omitted only FROM check is done. "!" is used to match packets not +falling in the range. +.TP +\fB\-\-connbytes\-dir\fP {\fBoriginal\fP|\fBreply\fP|\fBboth\fP} +which packets to consider +.TP +\fB\-\-connbytes\-mode\fP {\fBpackets\fP|\fBbytes\fP|\fBavgpkt\fP} +whether to check the amount of packets, number of bytes transferred or +the average size (in bytes) of all packets received so far. Note that +when "both" is used together with "avgpkt", and data is going (mainly) +only in one direction (for example HTTP), the average packet size will +be about half of the actual data packets. +.TP +Example: +iptables .. \-m connbytes \-\-connbytes 10000:100000 \-\-connbytes\-dir both \-\-connbytes\-mode bytes ... +.SS connlabel +Module matches or adds connlabels to a connection. +connlabels are similar to connmarks, except labels are bit-based; i.e. +all labels may be attached to a flow at the same time. +Up to 128 unique labels are currently supported. +.TP +[\fB!\fP] \fB\-\-label\fP \fBname\fP +matches if label \fBname\fP has been set on a connection. +Instead of a name (which will be translated to a number, see EXAMPLE below), +a number may be used instead. Using a number always overrides connlabel.conf. +.TP +\fB\-\-set\fP +if the label has not been set on the connection, set it. +Note that setting a label can fail. This is because the kernel allocates the +conntrack label storage area when the connection is created, and it only +reserves the amount of memory required by the ruleset that exists at +the time the connection is created. +In this case, the match will fail (or succeed, in case \fB\-\-label\fP +option was negated). +.PP +This match depends on libnetfilter_conntrack 1.0.4 or later. +Label translation is done via the \fB/etc/xtables/connlabel.conf\fP configuration file. +.PP +Example: +.IP +.nf +0 eth0-in +1 eth0-out +2 ppp-in +3 ppp-out +4 bulk-traffic +5 interactive +.fi +.PP +.SS connlimit +Allows you to restrict the number of parallel connections to a server per +client IP address (or client address block). +.TP +\fB\-\-connlimit\-upto\fP \fIn\fP +Match if the number of existing connections is below or equal \fIn\fP. +.TP +\fB\-\-connlimit\-above\fP \fIn\fP +Match if the number of existing connections is above \fIn\fP. +.TP +\fB\-\-connlimit\-mask\fP \fIprefix_length\fP +Group hosts using the prefix length. For IPv4, this must be a number between +(including) 0 and 32. For IPv6, between 0 and 128. If not specified, the +maximum prefix length for the applicable protocol is used. +.TP +\fB\-\-connlimit\-saddr\fP +Apply the limit onto the source group. This is the default if +\-\-connlimit\-daddr is not specified. +.TP +\fB\-\-connlimit\-daddr\fP +Apply the limit onto the destination group. +.PP +Examples: +.TP +# allow 2 telnet connections per client host +iptables \-A INPUT \-p tcp \-\-syn \-\-dport 23 \-m connlimit \-\-connlimit\-above 2 \-j REJECT +.TP +# you can also match the other way around: +iptables \-A INPUT \-p tcp \-\-syn \-\-dport 23 \-m connlimit \-\-connlimit\-upto 2 \-j ACCEPT +.TP +# limit the number of parallel HTTP requests to 16 per class C sized \ +source network (24 bit netmask) +iptables \-p tcp \-\-syn \-\-dport 80 \-m connlimit \-\-connlimit\-above 16 +\-\-connlimit\-mask 24 \-j REJECT +.TP +# limit the number of parallel HTTP requests to 16 for the link local network +(ipv6) +ip6tables \-p tcp \-\-syn \-\-dport 80 \-s fe80::/64 \-m connlimit \-\-connlimit\-above +16 \-\-connlimit\-mask 64 \-j REJECT +.TP +# Limit the number of connections to a particular host: +ip6tables \-p tcp \-\-syn \-\-dport 49152:65535 \-d 2001:db8::1 \-m connlimit +\-\-connlimit-above 100 \-j REJECT +.SS connmark +This module matches the netfilter mark field associated with a connection +(which can be set using the \fBCONNMARK\fP target below). +.TP +[\fB!\fP] \fB\-\-mark\fP \fIvalue\fP[\fB/\fP\fImask\fP] +Matches packets in connections with the given mark value (if a mask is +specified, this is logically ANDed with the mark before the comparison). +.SS conntrack +This module, when combined with connection tracking, allows access to the +connection tracking state for this packet/connection. +.TP +[\fB!\fP] \fB\-\-ctstate\fP \fIstatelist\fP +\fIstatelist\fP is a comma separated list of the connection states to match. +Possible states are listed below. +.TP +[\fB!\fP] \fB\-\-ctproto\fP \fIl4proto\fP +Layer-4 protocol to match (by number or name) +.TP +[\fB!\fP] \fB\-\-ctorigsrc\fP \fIaddress\fP[\fB/\fP\fImask\fP] +.TP +[\fB!\fP] \fB\-\-ctorigdst\fP \fIaddress\fP[\fB/\fP\fImask\fP] +.TP +[\fB!\fP] \fB\-\-ctreplsrc\fP \fIaddress\fP[\fB/\fP\fImask\fP] +.TP +[\fB!\fP] \fB\-\-ctrepldst\fP \fIaddress\fP[\fB/\fP\fImask\fP] +Match against original/reply source/destination address +.TP +[\fB!\fP] \fB\-\-ctorigsrcport\fP \fIport\fP[\fB:\fP\fIport\fP] +.TP +[\fB!\fP] \fB\-\-ctorigdstport\fP \fIport\fP[\fB:\fP\fIport\fP] +.TP +[\fB!\fP] \fB\-\-ctreplsrcport\fP \fIport\fP[\fB:\fP\fIport\fP] +.TP +[\fB!\fP] \fB\-\-ctrepldstport\fP \fIport\fP[\fB:\fP\fIport\fP] +Match against original/reply source/destination port (TCP/UDP/etc.) or GRE key. +Matching against port ranges is only supported in kernel versions above 2.6.38. +.TP +[\fB!\fP] \fB\-\-ctstatus\fP \fIstatelist\fP +\fIstatuslist\fP is a comma separated list of the connection statuses to match. +Possible statuses are listed below. +.TP +[\fB!\fP] \fB\-\-ctexpire\fP \fItime\fP[\fB:\fP\fItime\fP] +Match remaining lifetime in seconds against given value or range of values +(inclusive) +.TP +\fB\-\-ctdir\fP {\fBORIGINAL\fP|\fBREPLY\fP} +Match packets that are flowing in the specified direction. If this flag is not +specified at all, matches packets in both directions. +.PP +States for \fB\-\-ctstate\fP: +.TP +\fBINVALID\fP +The packet is associated with no known connection. +.TP +\fBNEW\fP +The packet has started a new connection or otherwise associated +with a connection which has not seen packets in both directions. +.TP +\fBESTABLISHED\fP +The packet is associated with a connection which has seen packets +in both directions. +.TP +\fBRELATED\fP +The packet is starting a new connection, but is associated with an +existing connection, such as an FTP data transfer or an ICMP error. +.TP +\fBUNTRACKED\fP +The packet is not tracked at all, which happens if you explicitly untrack it +by using \-j CT \-\-notrack in the raw table. +.TP +\fBSNAT\fP +A virtual state, matching if the original source address differs from the reply +destination. +.TP +\fBDNAT\fP +A virtual state, matching if the original destination differs from the reply +source. +.PP +Statuses for \fB\-\-ctstatus\fP: +.TP +\fBNONE\fP +None of the below. +.TP +\fBEXPECTED\fP +This is an expected connection (i.e. a conntrack helper set it up). +.TP +\fBSEEN_REPLY\fP +Conntrack has seen packets in both directions. +.TP +\fBASSURED\fP +Conntrack entry should never be early-expired. +.TP +\fBCONFIRMED\fP +Connection is confirmed: originating packet has left box. +.SS cpu +.TP +[\fB!\fP] \fB\-\-cpu\fP \fInumber\fP +Match cpu handling this packet. cpus are numbered from 0 to NR_CPUS-1 +Can be used in combination with RPS (Remote Packet Steering) or +multiqueue NICs to spread network traffic on different queues. +.PP +Example: +.PP +iptables \-t nat \-A PREROUTING \-p tcp \-\-dport 80 \-m cpu \-\-cpu 0 +\-j REDIRECT \-\-to\-port 8080 +.PP +iptables \-t nat \-A PREROUTING \-p tcp \-\-dport 80 \-m cpu \-\-cpu 1 +\-j REDIRECT \-\-to\-port 8081 +.PP +Available since Linux 2.6.36. +.SS dccp +.TP +[\fB!\fP] \fB\-\-source\-port\fP,\fB\-\-sport\fP \fIport\fP[\fB:\fP\fIport\fP] +.TP +[\fB!\fP] \fB\-\-destination\-port\fP,\fB\-\-dport\fP \fIport\fP[\fB:\fP\fIport\fP] +.TP +[\fB!\fP] \fB\-\-dccp\-types\fP \fImask\fP +Match when the DCCP packet type is one of 'mask'. 'mask' is a comma-separated +list of packet types. Packet types are: +.BR "REQUEST RESPONSE DATA ACK DATAACK CLOSEREQ CLOSE RESET SYNC SYNCACK INVALID" . +.TP +[\fB!\fP] \fB\-\-dccp\-option\fP \fInumber\fP +Match if DCCP option set. +.SS devgroup +Match device group of a packets incoming/outgoing interface. +.TP +[\fB!\fP] \fB\-\-src\-group\fP \fIname\fP +Match device group of incoming device +.TP +[\fB!\fP] \fB\-\-dst\-group\fP \fIname\fP +Match device group of outgoing device +.SS dscp +This module matches the 6 bit DSCP field within the TOS field in the +IP header. DSCP has superseded TOS within the IETF. +.TP +[\fB!\fP] \fB\-\-dscp\fP \fIvalue\fP +Match against a numeric (decimal or hex) value [0-63]. +.TP +[\fB!\fP] \fB\-\-dscp\-class\fP \fIclass\fP +Match the DiffServ class. This value may be any of the +BE, EF, AFxx or CSx classes. It will then be converted +into its according numeric value. +.SS dst (IPv6-specific) +This module matches the parameters in Destination Options header +.TP +[\fB!\fP] \fB\-\-dst\-len\fP \fIlength\fP +Total length of this header in octets. +.TP +\fB\-\-dst\-opts\fP \fItype\fP[\fB:\fP\fIlength\fP][\fB,\fP\fItype\fP[\fB:\fP\fIlength\fP]...] +numeric type of option and the length of the option data in octets. +.SS ecn +This allows you to match the ECN bits of the IPv4/IPv6 and TCP header. ECN is the Explicit Congestion Notification mechanism as specified in RFC3168 +.TP +[\fB!\fP] \fB\-\-ecn\-tcp\-cwr\fP +This matches if the TCP ECN CWR (Congestion Window Received) bit is set. +.TP +[\fB!\fP] \fB\-\-ecn\-tcp\-ece\fP +This matches if the TCP ECN ECE (ECN Echo) bit is set. +.TP +[\fB!\fP] \fB\-\-ecn\-ip\-ect\fP \fInum\fP +This matches a particular IPv4/IPv6 ECT (ECN-Capable Transport). You have to specify +a number between `0' and `3'. +.SS esp +This module matches the SPIs in ESP header of IPsec packets. +.TP +[\fB!\fP] \fB\-\-espspi\fP \fIspi\fP[\fB:\fP\fIspi\fP] +.SS eui64 (IPv6-specific) +This module matches the EUI-64 part of a stateless autoconfigured IPv6 address. +It compares the EUI-64 derived from the source MAC address in Ethernet frame +with the lower 64 bits of the IPv6 source address. But "Universal/Local" +bit is not compared. This module doesn't match other link layer frame, and +is only valid in the +.BR PREROUTING , +.BR INPUT +and +.BR FORWARD +chains. +.SS frag (IPv6-specific) +This module matches the parameters in Fragment header. +.TP +[\fB!\fP] \fB\-\-fragid\fP \fIid\fP[\fB:\fP\fIid\fP] +Matches the given Identification or range of it. +.TP +[\fB!\fP] \fB\-\-fraglen\fP \fIlength\fP +This option cannot be used with kernel version 2.6.10 or later. The length of +Fragment header is static and this option doesn't make sense. +.TP +\fB\-\-fragres\fP +Matches if the reserved fields are filled with zero. +.TP +\fB\-\-fragfirst\fP +Matches on the first fragment. +.TP +\fB\-\-fragmore\fP +Matches if there are more fragments. +.TP +\fB\-\-fraglast\fP +Matches if this is the last fragment. +.SS hashlimit +\fBhashlimit\fP uses hash buckets to express a rate limiting match (like the +\fBlimit\fP match) for a group of connections using a \fBsingle\fP iptables +rule. Grouping can be done per-hostgroup (source and/or destination address) +and/or per-port. It gives you the ability to express "\fIN\fP packets per time +quantum per group" or "\fIN\fP bytes per seconds" (see below for some examples). +.PP +A hash limit option (\fB\-\-hashlimit\-upto\fP, \fB\-\-hashlimit\-above\fP) and +\fB\-\-hashlimit\-name\fP are required. +.TP +\fB\-\-hashlimit\-upto\fP \fIamount\fP[\fB/second\fP|\fB/minute\fP|\fB/hour\fP|\fB/day\fP] +Match if the rate is below or equal to \fIamount\fP/quantum. It is specified either as +a number, with an optional time quantum suffix (the default is 3/hour), or as +\fIamount\fPb/second (number of bytes per second). +.TP +\fB\-\-hashlimit\-above\fP \fIamount\fP[\fB/second\fP|\fB/minute\fP|\fB/hour\fP|\fB/day\fP] +Match if the rate is above \fIamount\fP/quantum. +.TP +\fB\-\-hashlimit\-burst\fP \fIamount\fP +Maximum initial number of packets to match: this number gets recharged by one +every time the limit specified above is not reached, up to this number; the +default is 5. When byte-based rate matching is requested, this option specifies +the amount of bytes that can exceed the given rate. This option should be used +with caution -- if the entry expires, the burst value is reset too. +.TP +\fB\-\-hashlimit\-mode\fP {\fBsrcip\fP|\fBsrcport\fP|\fBdstip\fP|\fBdstport\fP}\fB,\fP... +A comma-separated list of objects to take into consideration. If no +\-\-hashlimit\-mode option is given, hashlimit acts like limit, but at the +expensive of doing the hash housekeeping. +.TP +\fB\-\-hashlimit\-srcmask\fP \fIprefix\fP +When \-\-hashlimit\-mode srcip is used, all source addresses encountered will be +grouped according to the given prefix length and the so-created subnet will be +subject to hashlimit. \fIprefix\fP must be between (inclusive) 0 and 32. Note +that \-\-hashlimit\-srcmask 0 is basically doing the same thing as not specifying +srcip for \-\-hashlimit\-mode, but is technically more expensive. +.TP +\fB\-\-hashlimit\-dstmask\fP \fIprefix\fP +Like \-\-hashlimit\-srcmask, but for destination addresses. +.TP +\fB\-\-hashlimit\-name\fP \fIfoo\fP +The name for the /proc/net/ipt_hashlimit/foo entry. +.TP +\fB\-\-hashlimit\-htable\-size\fP \fIbuckets\fP +The number of buckets of the hash table +.TP +\fB\-\-hashlimit\-htable\-max\fP \fIentries\fP +Maximum entries in the hash. +.TP +\fB\-\-hashlimit\-htable\-expire\fP \fImsec\fP +After how many milliseconds do hash entries expire. +.TP +\fB\-\-hashlimit\-htable\-gcinterval\fP \fImsec\fP +How many milliseconds between garbage collection intervals. +.TP +\fB\-\-hashlimit\-rate\-match\fP +Classify the flow instead of rate-limiting it. This acts like a +true/false match on whether the rate is above/below a certain number +.TP +\fB\-\-hashlimit\-rate\-interval\fP \fIsec\fP +Can be used with \-\-hashlimit\-rate\-match to specify the interval +at which the rate should be sampled +.PP +Examples: +.TP +matching on source host +"1000 packets per second for every host in 192.168.0.0/16" => +\-s 192.168.0.0/16 \-\-hashlimit\-mode srcip \-\-hashlimit\-upto 1000/sec +.TP +matching on source port +"100 packets per second for every service of 192.168.1.1" => +\-s 192.168.1.1 \-\-hashlimit\-mode srcport \-\-hashlimit\-upto 100/sec +.TP +matching on subnet +"10000 packets per minute for every /28 subnet (groups of 8 addresses) +in 10.0.0.0/8" => +\-s 10.0.0.0/8 \-\-hashlimit\-mask 28 \-\-hashlimit\-upto 10000/min +.TP +matching bytes per second +"flows exceeding 512kbyte/s" => +\-\-hashlimit-mode srcip,dstip,srcport,dstport \-\-hashlimit\-above 512kb/s +.TP +matching bytes per second +"hosts that exceed 512kbyte/s, but permit up to 1Megabytes without matching" +\-\-hashlimit-mode dstip \-\-hashlimit\-above 512kb/s \-\-hashlimit-burst 1mb +.SS hbh (IPv6-specific) +This module matches the parameters in Hop-by-Hop Options header +.TP +[\fB!\fP] \fB\-\-hbh\-len\fP \fIlength\fP +Total length of this header in octets. +.TP +\fB\-\-hbh\-opts\fP \fItype\fP[\fB:\fP\fIlength\fP][\fB,\fP\fItype\fP[\fB:\fP\fIlength\fP]...] +numeric type of option and the length of the option data in octets. +.SS helper +This module matches packets related to a specific conntrack-helper. +.TP +[\fB!\fP] \fB\-\-helper\fP \fIstring\fP +Matches packets related to the specified conntrack-helper. +.RS +.PP +string can be "ftp" for packets related to a ftp-session on default port. +For other ports append \-portnr to the value, ie. "ftp\-2121". +.PP +Same rules apply for other conntrack-helpers. +.RE +.SS hl (IPv6-specific) +This module matches the Hop Limit field in the IPv6 header. +.TP +[\fB!\fP] \fB\-\-hl\-eq\fP \fIvalue\fP +Matches if Hop Limit equals \fIvalue\fP. +.TP +\fB\-\-hl\-lt\fP \fIvalue\fP +Matches if Hop Limit is less than \fIvalue\fP. +.TP +\fB\-\-hl\-gt\fP \fIvalue\fP +Matches if Hop Limit is greater than \fIvalue\fP. +.SS icmp (IPv4-specific) +This extension can be used if `\-\-protocol icmp' is specified. It +provides the following option: +.TP +[\fB!\fP] \fB\-\-icmp\-type\fP {\fItype\fP[\fB/\fP\fIcode\fP]|\fItypename\fP} +This allows specification of the ICMP type, which can be a numeric +ICMP type, type/code pair, or one of the ICMP type names shown by the command +.nf + iptables \-p icmp \-h +.fi +.SS icmp6 (IPv6-specific) +This extension can be used if `\-\-protocol ipv6\-icmp' or `\-\-protocol icmpv6' is +specified. It provides the following option: +.TP +[\fB!\fP] \fB\-\-icmpv6\-type\fP \fItype\fP[\fB/\fP\fIcode\fP]|\fItypename\fP +This allows specification of the ICMPv6 type, which can be a numeric +ICMPv6 +.IR type , +.IR type +and +.IR code , +or one of the ICMPv6 type names shown by the command +.nf + ip6tables \-p ipv6\-icmp \-h +.fi +.SS iprange +This matches on a given arbitrary range of IP addresses. +.TP +[\fB!\fP] \fB\-\-src\-range\fP \fIfrom\fP[\fB\-\fP\fIto\fP] +Match source IP in the specified range. +.TP +[\fB!\fP] \fB\-\-dst\-range\fP \fIfrom\fP[\fB\-\fP\fIto\fP] +Match destination IP in the specified range. +.SS ipv6header (IPv6-specific) +This module matches IPv6 extension headers and/or upper layer header. +.TP +\fB\-\-soft\fP +Matches if the packet includes \fBany\fP of the headers specified with +\fB\-\-header\fP. +.TP +[\fB!\fP] \fB\-\-header\fP \fIheader\fP[\fB,\fP\fIheader\fP...] +Matches the packet which EXACTLY includes all specified headers. The headers +encapsulated with ESP header are out of scope. +Possible \fIheader\fP types can be: +.TP +\fBhop\fP|\fBhop\-by\-hop\fP +Hop-by-Hop Options header +.TP +\fBdst\fP +Destination Options header +.TP +\fBroute\fP +Routing header +.TP +\fBfrag\fP +Fragment header +.TP +\fBauth\fP +Authentication header +.TP +\fBesp\fP +Encapsulating Security Payload header +.TP +\fBnone\fP +No Next header which matches 59 in the 'Next Header field' of IPv6 header or +any IPv6 extension headers +.TP +\fBprot\fP +which matches any upper layer protocol header. A protocol name from +/etc/protocols and numeric value also allowed. The number 255 is equivalent to +\fBprot\fP. +.SS ipvs +Match IPVS connection properties. +.TP +[\fB!\fP] \fB\-\-ipvs\fP +packet belongs to an IPVS connection +.TP +Any of the following options implies \-\-ipvs (even negated) +.TP +[\fB!\fP] \fB\-\-vproto\fP \fIprotocol\fP +VIP protocol to match; by number or name, e.g. "tcp" +.TP +[\fB!\fP] \fB\-\-vaddr\fP \fIaddress\fP[\fB/\fP\fImask\fP] +VIP address to match +.TP +[\fB!\fP] \fB\-\-vport\fP \fIport\fP +VIP port to match; by number or name, e.g. "http" +.TP +\fB\-\-vdir\fP {\fBORIGINAL\fP|\fBREPLY\fP} +flow direction of packet +.TP +[\fB!\fP] \fB\-\-vmethod\fP {\fBGATE\fP|\fBIPIP\fP|\fBMASQ\fP} +IPVS forwarding method used +.TP +[\fB!\fP] \fB\-\-vportctl\fP \fIport\fP +VIP port of the controlling connection to match, e.g. 21 for FTP +.SS length +This module matches the length of the layer-3 payload (e.g. layer-4 packet) +of a packet against a specific value +or range of values. +.TP +[\fB!\fP] \fB\-\-length\fP \fIlength\fP[\fB:\fP\fIlength\fP] +.SS limit +This module matches at a limited rate using a token bucket filter. +A rule using this extension will match until this limit is reached. +It can be used in combination with the +.B LOG +target to give limited logging, for example. +.PP +xt_limit has no negation support - you will have to use \-m hashlimit ! +\-\-hashlimit \fIrate\fP in this case whilst omitting \-\-hashlimit\-mode. +.TP +\fB\-\-limit\fP \fIrate\fP[\fB/second\fP|\fB/minute\fP|\fB/hour\fP|\fB/day\fP] +Maximum average matching rate: specified as a number, with an optional +`/second', `/minute', `/hour', or `/day' suffix; the default is +3/hour. +.TP +\fB\-\-limit\-burst\fP \fInumber\fP +Maximum initial number of packets to match: this number gets +recharged by one every time the limit specified above is not reached, +up to this number; the default is 5. +.SS mac +.TP +[\fB!\fP] \fB\-\-mac\-source\fP \fIaddress\fP +Match source MAC address. It must be of the form XX:XX:XX:XX:XX:XX. +Note that this only makes sense for packets coming from an Ethernet device +and entering the +.BR PREROUTING , +.B FORWARD +or +.B INPUT +chains. +.SS mark +This module matches the netfilter mark field associated with a packet +(which can be set using the +.B MARK +target below). +.TP +[\fB!\fP] \fB\-\-mark\fP \fIvalue\fP[\fB/\fP\fImask\fP] +Matches packets with the given unsigned mark value (if a \fImask\fP is +specified, this is logically ANDed with the \fImask\fP before the +comparison). +.SS mh (IPv6-specific) +This extension is loaded if `\-\-protocol ipv6\-mh' or `\-\-protocol mh' is +specified. It provides the following option: +.TP +[\fB!\fP] \fB\-\-mh\-type\fP \fItype\fP[\fB:\fP\fItype\fP] +This allows specification of the Mobility Header(MH) type, which can be +a numeric MH +.IR type , +.IR type +or one of the MH type names shown by the command +.nf + ip6tables \-p mh \-h +.fi +.SS multiport +This module matches a set of source or destination ports. Up to 15 +ports can be specified. A port range (port:port) counts as two +ports. It can only be used in conjunction with one of the +following protocols: +\fBtcp\fP, \fBudp\fP, \fBudplite\fP, \fBdccp\fP and \fBsctp\fP. +.TP +[\fB!\fP] \fB\-\-source\-ports\fP,\fB\-\-sports\fP \fIport\fP[\fB,\fP\fIport\fP|\fB,\fP\fIport\fP\fB:\fP\fIport\fP]... +Match if the source port is one of the given ports. The flag +\fB\-\-sports\fP +is a convenient alias for this option. Multiple ports or port ranges are +separated using a comma, and a port range is specified using a colon. +\fB53,1024:65535\fP would therefore match ports 53 and all from 1024 through +65535. +.TP +[\fB!\fP] \fB\-\-destination\-ports\fP,\fB\-\-dports\fP \fIport\fP[\fB,\fP\fIport\fP|\fB,\fP\fIport\fP\fB:\fP\fIport\fP]... +Match if the destination port is one of the given ports. The flag +\fB\-\-dports\fP +is a convenient alias for this option. +.TP +[\fB!\fP] \fB\-\-ports\fP \fIport\fP[\fB,\fP\fIport\fP|\fB,\fP\fIport\fP\fB:\fP\fIport\fP]... +Match if either the source or destination ports are equal to one of +the given ports. +.SS nfacct +The nfacct match provides the extended accounting infrastructure for iptables. +You have to use this match together with the standalone user-space utility +.B nfacct(8) +.PP +The only option available for this match is the following: +.TP +\fB\-\-nfacct\-name\fP \fIname\fP +This allows you to specify the existing object name that will be use for +accounting the traffic that this rule-set is matching. +.PP +To use this extension, you have to create an accounting object: +.IP +nfacct add http\-traffic +.PP +Then, you have to attach it to the accounting object via iptables: +.IP +iptables \-I INPUT \-p tcp \-\-sport 80 \-m nfacct \-\-nfacct\-name http\-traffic +.IP +iptables \-I OUTPUT \-p tcp \-\-dport 80 \-m nfacct \-\-nfacct\-name http\-traffic +.PP +Then, you can check for the amount of traffic that the rules match: +.IP +nfacct get http\-traffic +.IP +{ pkts = 00000000000000000156, bytes = 00000000000000151786 } = http-traffic; +.PP +You can obtain +.B nfacct(8) +from http://www.netfilter.org or, alternatively, from the git.netfilter.org +repository. +.SS osf +The osf module does passive operating system fingerprinting. This module +compares some data (Window Size, MSS, options and their order, TTL, DF, +and others) from packets with the SYN bit set. +.TP +[\fB!\fP] \fB\-\-genre\fP \fIstring\fP +Match an operating system genre by using a passive fingerprinting. +.TP +\fB\-\-ttl\fP \fIlevel\fP +Do additional TTL checks on the packet to determine the operating system. +\fIlevel\fP can be one of the following values: +.IP \(bu 4 +0 - True IP address and fingerprint TTL comparison. This generally works for +LANs. +.IP \(bu 4 +1 - Check if the IP header's TTL is less than the fingerprint one. Works for +globally-routable addresses. +.IP \(bu 4 +2 - Do not compare the TTL at all. +.TP +\fB\-\-log\fP \fIlevel\fP +Log determined genres into dmesg even if they do not match the desired one. +\fIlevel\fP can be one of the following values: +.IP \(bu 4 +0 - Log all matched or unknown signatures +.IP \(bu 4 +1 - Log only the first one +.IP \(bu 4 +2 - Log all known matched signatures +.PP +You may find something like this in syslog: +.PP +Windows [2000:SP3:Windows XP Pro SP1, 2000 SP3]: 11.22.33.55:4024 -> +11.22.33.44:139 hops=3 Linux [2.5-2.6:] : 1.2.3.4:42624 -> 1.2.3.5:22 hops=4 +.PP +OS fingerprints are loadable using the \fBnfnl_osf\fP program. To load +fingerprints from a file, use: +.PP +\fBnfnl_osf \-f /usr/share/xtables/pf.os\fP +.PP +To remove them again, +.PP +\fBnfnl_osf \-f /usr/share/xtables/pf.os \-d\fP +.PP +The fingerprint database can be downloaded from +http://www.openbsd.org/cgi-bin/cvsweb/src/etc/pf.os . +.SS owner +This module attempts to match various characteristics of the packet creator, +for locally generated packets. This match is only valid in the OUTPUT and +POSTROUTING chains. Forwarded packets do not have any socket associated with +them. Packets from kernel threads do have a socket, but usually no owner. +.TP +[\fB!\fP] \fB\-\-uid\-owner\fP \fIusername\fP +.TP +[\fB!\fP] \fB\-\-uid\-owner\fP \fIuserid\fP[\fB\-\fP\fIuserid\fP] +Matches if the packet socket's file structure (if it has one) is owned by the +given user. You may also specify a numerical UID, or an UID range. +.TP +[\fB!\fP] \fB\-\-gid\-owner\fP \fIgroupname\fP +.TP +[\fB!\fP] \fB\-\-gid\-owner\fP \fIgroupid\fP[\fB\-\fP\fIgroupid\fP] +Matches if the packet socket's file structure is owned by the given group. +You may also specify a numerical GID, or a GID range. +.TP +\fB\-\-suppl\-groups\fP +Causes group(s) specified with \fB\-\-gid-owner\fP to be also checked in the +supplementary groups of a process. +.TP +[\fB!\fP] \fB\-\-socket\-exists\fP +Matches if the packet is associated with a socket. +.SS physdev +This module matches on the bridge port input and output devices enslaved +to a bridge device. This module is a part of the infrastructure that enables +a transparent bridging IP firewall and is only useful for kernel versions +above version 2.5.44. +.TP +[\fB!\fP] \fB\-\-physdev\-in\fP \fIname\fP +Name of a bridge port via which a packet is received (only for +packets entering the +.BR INPUT , +.B FORWARD +and +.B PREROUTING +chains). If the interface name ends in a "+", then any +interface which begins with this name will match. If the packet didn't arrive +through a bridge device, this packet won't match this option, unless '!' is used. +.TP +[\fB!\fP] \fB\-\-physdev\-out\fP \fIname\fP +Name of a bridge port via which a packet is going to be sent (for bridged packets +entering the +.BR FORWARD +and +.B POSTROUTING +chains). If the interface name ends in a "+", then any +interface which begins with this name will match. +.TP +[\fB!\fP] \fB\-\-physdev\-is\-in\fP +Matches if the packet has entered through a bridge interface. +.TP +[\fB!\fP] \fB\-\-physdev\-is\-out\fP +Matches if the packet will leave through a bridge interface. +.TP +[\fB!\fP] \fB\-\-physdev\-is\-bridged\fP +Matches if the packet is being bridged and therefore is not being routed. +This is only useful in the FORWARD and POSTROUTING chains. +.SS pkttype +This module matches the link-layer packet type. +.TP +[\fB!\fP] \fB\-\-pkt\-type\fP {\fBunicast\fP|\fBbroadcast\fP|\fBmulticast\fP} +.SS policy +This module matches the policy used by IPsec for handling a packet. +.TP +\fB\-\-dir\fP {\fBin\fP|\fBout\fP} +Used to select whether to match the policy used for decapsulation or the +policy that will be used for encapsulation. +.B in +is valid in the +.B PREROUTING, INPUT and FORWARD +chains, +.B out +is valid in the +.B POSTROUTING, OUTPUT and FORWARD +chains. +.TP +\fB\-\-pol\fP {\fBnone\fP|\fBipsec\fP} +Matches if the packet is subject to IPsec processing. \fB\-\-pol none\fP +cannot be combined with \fB\-\-strict\fP. +.TP +\fB\-\-strict\fP +Selects whether to match the exact policy or match if any rule of +the policy matches the given policy. +.PP +For each policy element that is to be described, one can use one or more of +the following options. When \fB\-\-strict\fP is in effect, at least one must be +used per element. +.TP +[\fB!\fP] \fB\-\-reqid\fP \fIid\fP +Matches the reqid of the policy rule. The reqid can be specified with +.B setkey(8) +using +.B unique:id +as level. +.TP +[\fB!\fP] \fB\-\-spi\fP \fIspi\fP +Matches the SPI of the SA. +.TP +[\fB!\fP] \fB\-\-proto\fP {\fBah\fP|\fBesp\fP|\fBipcomp\fP} +Matches the encapsulation protocol. +.TP +[\fB!\fP] \fB\-\-mode\fP {\fBtunnel\fP|\fBtransport\fP} +Matches the encapsulation mode. +.TP +[\fB!\fP] \fB\-\-tunnel\-src\fP \fIaddr\fP[\fB/\fP\fImask\fP] +Matches the source end-point address of a tunnel mode SA. +Only valid with \fB\-\-mode tunnel\fP. +.TP +[\fB!\fP] \fB\-\-tunnel\-dst\fP \fIaddr\fP[\fB/\fP\fImask\fP] +Matches the destination end-point address of a tunnel mode SA. +Only valid with \fB\-\-mode tunnel\fP. +.TP +\fB\-\-next\fP +Start the next element in the policy specification. Can only be used with +\fB\-\-strict\fP. +.SS quota +Implements network quotas by decrementing a byte counter with each +packet. The condition matches until the byte counter reaches zero. Behavior +is reversed with negation (i.e. the condition does not match until the +byte counter reaches zero). +.TP +[\fB!\fP] \fB\-\-quota\fP \fIbytes\fP +The quota in bytes. +.SS rateest +The rate estimator can match on estimated rates as collected by the RATEEST +target. It supports matching on absolute bps/pps values, comparing two rate +estimators and matching on the difference between two rate estimators. +.PP +For a better understanding of the available options, these are all possible +combinations: +.\" * Absolute: +.IP \(bu 4 +\fBrateest\fP \fIoperator\fP \fBrateest-bps\fP +.IP \(bu 4 +\fBrateest\fP \fIoperator\fP \fBrateest-pps\fP +.\" * Absolute + Delta: +.IP \(bu 4 +(\fBrateest\fP minus \fBrateest-bps1\fP) \fIoperator\fP \fBrateest-bps2\fP +.IP \(bu 4 +(\fBrateest\fP minus \fBrateest-pps1\fP) \fIoperator\fP \fBrateest-pps2\fP +.\" * Relative: +.IP \(bu 4 +\fBrateest1\fP \fIoperator\fP \fBrateest2\fP \fBrateest-bps\fP(without rate!) +.IP \(bu 4 +\fBrateest1\fP \fIoperator\fP \fBrateest2\fP \fBrateest-pps\fP(without rate!) +.\" * Relative + Delta: +.IP \(bu 4 +(\fBrateest1\fP minus \fBrateest-bps1\fP) \fIoperator\fP +(\fBrateest2\fP minus \fBrateest-bps2\fP) +.IP \(bu 4 +(\fBrateest1\fP minus \fBrateest-pps1\fP) \fIoperator\fP +(\fBrateest2\fP minus \fBrateest-pps2\fP) +.TP +\fB\-\-rateest\-delta\fP +For each estimator (either absolute or relative mode), calculate the difference +between the estimator-determined flow rate and the static value chosen with the +BPS/PPS options. If the flow rate is higher than the specified BPS/PPS, 0 will +be used instead of a negative value. In other words, "max(0, rateest#_rate - +rateest#_bps)" is used. +.TP +[\fB!\fP] \fB\-\-rateest\-lt\fP +Match if rate is less than given rate/estimator. +.TP +[\fB!\fP] \fB\-\-rateest\-gt\fP +Match if rate is greater than given rate/estimator. +.TP +[\fB!\fP] \fB\-\-rateest\-eq\fP +Match if rate is equal to given rate/estimator. +.PP +In the so-called "absolute mode", only one rate estimator is used and compared +against a static value, while in "relative mode", two rate estimators are +compared against another. +.TP +\fB\-\-rateest\fP \fIname\fP +Name of the one rate estimator for absolute mode. +.TP +\fB\-\-rateest1\fP \fIname\fP +.TP +\fB\-\-rateest2\fP \fIname\fP +The names of the two rate estimators for relative mode. +.TP +\fB\-\-rateest\-bps\fP [\fIvalue\fP] +.TP +\fB\-\-rateest\-pps\fP [\fIvalue\fP] +.TP +\fB\-\-rateest\-bps1\fP [\fIvalue\fP] +.TP +\fB\-\-rateest\-bps2\fP [\fIvalue\fP] +.TP +\fB\-\-rateest\-pps1\fP [\fIvalue\fP] +.TP +\fB\-\-rateest\-pps2\fP [\fIvalue\fP] +Compare the estimator(s) by bytes or packets per second, and compare against +the chosen value. See the above bullet list for which option is to be used in +which case. A unit suffix may be used - available ones are: bit, [kmgt]bit, +[KMGT]ibit, Bps, [KMGT]Bps, [KMGT]iBps. +.PP +Example: This is what can be used to route outgoing data connections from an +FTP server over two lines based on the available bandwidth at the time the data +connection was started: +.PP +# Estimate outgoing rates +.PP +iptables \-t mangle \-A POSTROUTING \-o eth0 \-j RATEEST \-\-rateest\-name eth0 +\-\-rateest\-interval 250ms \-\-rateest\-ewma 0.5s +.PP +iptables \-t mangle \-A POSTROUTING \-o ppp0 \-j RATEEST \-\-rateest\-name ppp0 +\-\-rateest\-interval 250ms \-\-rateest\-ewma 0.5s +.PP +# Mark based on available bandwidth +.PP +iptables \-t mangle \-A balance \-m conntrack \-\-ctstate NEW \-m helper \-\-helper ftp +\-m rateest \-\-rateest\-delta \-\-rateest1 eth0 \-\-rateest\-bps1 2.5mbit \-\-rateest\-gt +\-\-rateest2 ppp0 \-\-rateest\-bps2 2mbit \-j CONNMARK \-\-set\-mark 1 +.PP +iptables \-t mangle \-A balance \-m conntrack \-\-ctstate NEW \-m helper \-\-helper ftp +\-m rateest \-\-rateest\-delta \-\-rateest1 ppp0 \-\-rateest\-bps1 2mbit \-\-rateest\-gt +\-\-rateest2 eth0 \-\-rateest\-bps2 2.5mbit \-j CONNMARK \-\-set\-mark 2 +.PP +iptables \-t mangle \-A balance \-j CONNMARK \-\-restore\-mark +.SS realm (IPv4-specific) +This matches the routing realm. Routing realms are used in complex routing +setups involving dynamic routing protocols like BGP. +.TP +[\fB!\fP] \fB\-\-realm\fP \fIvalue\fP[\fB/\fP\fImask\fP] +Matches a given realm number (and optionally mask). If not a number, value +can be a named realm from /etc/iproute2/rt_realms (mask can not be used in +that case). +Both value and mask are four byte unsigned integers and may be specified in +decimal, hex (by prefixing with "0x") or octal (if a leading zero is given). +.SS recent +Allows you to dynamically create a list of IP addresses and then match against +that list in a few different ways. +.PP +For example, you can create a "badguy" list out of people attempting to connect +to port 139 on your firewall and then DROP all future packets from them without +considering them. +.PP +\fB\-\-set\fP, \fB\-\-rcheck\fP, \fB\-\-update\fP and \fB\-\-remove\fP are +mutually exclusive. +.TP +\fB\-\-name\fP \fIname\fP +Specify the list to use for the commands. If no name is given then +\fBDEFAULT\fP will be used. +.TP +[\fB!\fP] \fB\-\-set\fP +This will add the source address of the packet to the list. If the source +address is already in the list, this will update the existing entry. This will +always return success (or failure if \fB!\fP is passed in). +.TP +\fB\-\-rsource\fP +Match/save the source address of each packet in the recent list table. This +is the default. +.TP +\fB\-\-rdest\fP +Match/save the destination address of each packet in the recent list table. +.TP +\fB\-\-mask\fP \fInetmask\fP +Netmask that will be applied to this recent list. +.TP +[\fB!\fP] \fB\-\-rcheck\fP +Check if the source address of the packet is currently in the list. +.TP +[\fB!\fP] \fB\-\-update\fP +Like \fB\-\-rcheck\fP, except it will update the "last seen" timestamp if it +matches. +.TP +[\fB!\fP] \fB\-\-remove\fP +Check if the source address of the packet is currently in the list and if so +that address will be removed from the list and the rule will return true. If +the address is not found, false is returned. +.TP +\fB\-\-seconds\fP \fIseconds\fP +This option must be used in conjunction with one of \fB\-\-rcheck\fP or +\fB\-\-update\fP. When used, this will narrow the match to only happen when the +address is in the list and was seen within the last given number of seconds. +.TP +\fB\-\-reap\fP +This option can only be used in conjunction with \fB\-\-seconds\fP. +When used, this will cause entries older than the last given number of seconds +to be purged. +.TP +\fB\-\-hitcount\fP \fIhits\fP +This option must be used in conjunction with one of \fB\-\-rcheck\fP or +\fB\-\-update\fP. When used, this will narrow the match to only happen when the +address is in the list and packets had been received greater than or equal to +the given value. This option may be used along with \fB\-\-seconds\fP to create +an even narrower match requiring a certain number of hits within a specific +time frame. The maximum value for the hitcount parameter is given by the +"ip_pkt_list_tot" parameter of the xt_recent kernel module. Exceeding this +value on the command line will cause the rule to be rejected. +.TP +\fB\-\-rttl\fP +This option may only be used in conjunction with one of \fB\-\-rcheck\fP or +\fB\-\-update\fP. When used, this will narrow the match to only happen when the +address is in the list and the TTL of the current packet matches that of the +packet which hit the \fB\-\-set\fP rule. This may be useful if you have problems +with people faking their source address in order to DoS you via this module by +disallowing others access to your site by sending bogus packets to you. +.PP +Examples: +.IP +iptables \-A FORWARD \-m recent \-\-name badguy \-\-rcheck \-\-seconds 60 \-j DROP +.IP +iptables \-A FORWARD \-p tcp \-i eth0 \-\-dport 139 \-m recent \-\-name badguy \-\-set \-j DROP +.PP +\fB/proc/net/xt_recent/*\fP are the current lists of addresses and information +about each entry of each list. +.PP +Each file in \fB/proc/net/xt_recent/\fP can be read from to see the current +list or written two using the following commands to modify the list: +.TP +\fBecho +\fP\fIaddr\fP\fB >/proc/net/xt_recent/DEFAULT\fP +to add \fIaddr\fP to the DEFAULT list +.TP +\fBecho \-\fP\fIaddr\fP\fB >/proc/net/xt_recent/DEFAULT\fP +to remove \fIaddr\fP from the DEFAULT list +.TP +\fBecho / >/proc/net/xt_recent/DEFAULT\fP +to flush the DEFAULT list (remove all entries). +.PP +The module itself accepts parameters, defaults shown: +.TP +\fBip_list_tot\fP=\fI100\fP +Number of addresses remembered per table. +.TP +\fBip_pkt_list_tot\fP=\fI20\fP +Number of packets per address remembered. +.TP +\fBip_list_hash_size\fP=\fI0\fP +Hash table size. 0 means to calculate it based on ip_list_tot, default: 512. +.TP +\fBip_list_perms\fP=\fI0644\fP +Permissions for /proc/net/xt_recent/* files. +.TP +\fBip_list_uid\fP=\fI0\fP +Numerical UID for ownership of /proc/net/xt_recent/* files. +.TP +\fBip_list_gid\fP=\fI0\fP +Numerical GID for ownership of /proc/net/xt_recent/* files. +.SS rpfilter +Performs a reverse path filter test on a packet. +If a reply to the packet would be sent via the same interface +that the packet arrived on, the packet will match. +Note that, unlike the in-kernel rp_filter, packets protected +by IPSec are not treated specially. Combine this match with +the policy match if you want this. +Also, packets arriving via the loopback interface are always permitted. +This match can only be used in the PREROUTING chain of the raw or mangle table. +.TP +\fB\-\-loose\fP +Used to specify that the reverse path filter test should match +even if the selected output device is not the expected one. +.TP +\fB\-\-validmark\fP +Also use the packets' nfmark value when performing the reverse path route lookup. +.TP +\fB\-\-accept\-local\fP +This will permit packets arriving from the network with a source address that is also +assigned to the local machine. +.TP +\fB\-\-invert\fP +This will invert the sense of the match. Instead of matching packets that passed the +reverse path filter test, match those that have failed it. +.PP +Example to log and drop packets failing the reverse path filter test: + +iptables \-t raw \-N RPFILTER + +iptables \-t raw \-A RPFILTER \-m rpfilter \-j RETURN + +iptables \-t raw \-A RPFILTER \-m limit \-\-limit 10/minute \-j NFLOG \-\-nflog\-prefix "rpfilter drop" + +iptables \-t raw \-A RPFILTER \-j DROP + +iptables \-t raw \-A PREROUTING \-j RPFILTER + +Example to drop failed packets, without logging: + +iptables \-t raw \-A RPFILTER \-m rpfilter \-\-invert \-j DROP +.SS rt (IPv6-specific) +Match on IPv6 routing header +.TP +[\fB!\fP] \fB\-\-rt\-type\fP \fItype\fP +Match the type (numeric). +.TP +[\fB!\fP] \fB\-\-rt\-segsleft\fP \fInum\fP[\fB:\fP\fInum\fP] +Match the `segments left' field (range). +.TP +[\fB!\fP] \fB\-\-rt\-len\fP \fIlength\fP +Match the length of this header. +.TP +\fB\-\-rt\-0\-res\fP +Match the reserved field, too (type=0) +.TP +\fB\-\-rt\-0\-addrs\fP \fIaddr\fP[\fB,\fP\fIaddr\fP...] +Match type=0 addresses (list). +.TP +\fB\-\-rt\-0\-not\-strict\fP +List of type=0 addresses is not a strict list. +.SS sctp +This module matches Stream Control Transmission Protocol headers. +.TP +[\fB!\fP] \fB\-\-source\-port\fP,\fB\-\-sport\fP \fIport\fP[\fB:\fP\fIport\fP] +.TP +[\fB!\fP] \fB\-\-destination\-port\fP,\fB\-\-dport\fP \fIport\fP[\fB:\fP\fIport\fP] +.TP +[\fB!\fP] \fB\-\-chunk\-types\fP {\fBall\fP|\fBany\fP|\fBonly\fP} \fIchunktype\fP[\fB:\fP\fIflags\fP] [...] +The flag letter in upper case indicates that the flag is to match if set, +in the lower case indicates to match if unset. + +Chunk types: DATA INIT INIT_ACK SACK HEARTBEAT HEARTBEAT_ACK ABORT SHUTDOWN SHUTDOWN_ACK ERROR COOKIE_ECHO COOKIE_ACK ECN_ECNE ECN_CWR SHUTDOWN_COMPLETE ASCONF ASCONF_ACK FORWARD_TSN + +chunk type available flags +.br +DATA I U B E i u b e +.br +ABORT T t +.br +SHUTDOWN_COMPLETE T t + +(lowercase means flag should be "off", uppercase means "on") +.P +Examples: + +iptables \-A INPUT \-p sctp \-\-dport 80 \-j DROP + +iptables \-A INPUT \-p sctp \-\-chunk\-types any DATA,INIT \-j DROP + +iptables \-A INPUT \-p sctp \-\-chunk\-types any DATA:Be \-j ACCEPT +.SS set +This module matches IP sets which can be defined by ipset(8). +.TP +[\fB!\fP] \fB\-\-match\-set\fP \fIsetname\fP \fIflag\fP[\fB,\fP\fIflag\fP]... +where flags are the comma separated list of +.BR "src" +and/or +.BR "dst" +specifications and there can be no more than six of them. Hence the command +.IP + iptables \-A FORWARD \-m set \-\-match\-set test src,dst +.IP +will match packets, for which (if the set type is ipportmap) the source +address and destination port pair can be found in the specified set. If +the set type of the specified set is single dimension (for example ipmap), +then the command will match packets for which the source address can be +found in the specified set. +.TP +\fB\-\-return\-nomatch\fP +If the \fB\-\-return\-nomatch\fP option is specified and the set type +supports the \fBnomatch\fP flag, then the matching is reversed: a match +with an element flagged with \fBnomatch\fP returns \fBtrue\fP, while a +match with a plain element returns \fBfalse\fP. +.TP +\fB!\fP \fB\-\-update\-counters\fP +If the \fB\-\-update\-counters\fP flag is negated, then the packet and +byte counters of the matching element in the set won't be updated. Default +the packet and byte counters are updated. +.TP +\fB!\fP \fB\-\-update\-subcounters\fP +If the \fB\-\-update\-subcounters\fP flag is negated, then the packet and +byte counters of the matching element in the member set of a list type of +set won't be updated. Default the packet and byte counters are updated. +.TP +[\fB!\fP] \fB\-\-packets\-eq\fP \fIvalue\fP +If the packet is matched an element in the set, match only if the +packet counter of the element matches the given value too. +.TP +\fB\-\-packets\-lt\fP \fIvalue\fP +If the packet is matched an element in the set, match only if the +packet counter of the element is less than the given value as well. +.TP +\fB\-\-packets\-gt\fP \fIvalue\fP +If the packet is matched an element in the set, match only if the +packet counter of the element is greater than the given value as well. +.TP +[\fB!\fP] \fB\-\-bytes\-eq\fP \fIvalue\fP +If the packet is matched an element in the set, match only if the +byte counter of the element matches the given value too. +.TP +\fB\-\-bytes\-lt\fP \fIvalue\fP +If the packet is matched an element in the set, match only if the +byte counter of the element is less than the given value as well. +.TP +\fB\-\-bytes\-gt\fP \fIvalue\fP +If the packet is matched an element in the set, match only if the +byte counter of the element is greater than the given value as well. +.PP +The packet and byte counters related options and flags are ignored +when the set was defined without counter support. +.PP +The option \fB\-\-match\-set\fP can be replaced by \fB\-\-set\fP if that does +not clash with an option of other extensions. +.PP +Use of \-m set requires that ipset kernel support is provided, which, for +standard kernels, is the case since Linux 2.6.39. +.SS socket +This matches if an open TCP/UDP socket can be found by doing a socket lookup on the +packet. It matches if there is an established or non\-zero bound listening +socket (possibly with a non\-local address). The lookup is performed using +the \fBpacket\fP tuple of TCP/UDP packets, or the original TCP/UDP header +\fBembedded\fP in an ICMP/ICPMv6 error packet. +.TP +\fB\-\-transparent\fP +Ignore non-transparent sockets. +.TP +\fB\-\-nowildcard\fP +Do not ignore sockets bound to 'any' address. +The socket match won't accept zero\-bound listeners by default, since +then local services could intercept traffic that would otherwise be forwarded. +This option therefore has security implications when used to match traffic being +forwarded to redirect such packets to local machine with policy routing. +When using the socket match to implement fully transparent +proxies bound to non\-local addresses it is recommended to use the \-\-transparent +option instead. +.PP +Example (assuming packets with mark 1 are delivered locally): +.IP +\-t mangle \-A PREROUTING \-m socket \-\-transparent \-j MARK \-\-set\-mark 1 +.TP +\fB\-\-restore\-skmark\fP +Set the packet mark to the matching socket's mark. Can be combined with the +\fB\-\-transparent\fP and \fB\-\-nowildcard\fP options to restrict the sockets +to be matched when restoring the packet mark. +.PP +Example: An application opens 2 transparent (\fBIP_TRANSPARENT\fP) sockets and +sets a mark on them with \fBSO_MARK\fP socket option. We can filter matching packets: +.IP +\-t mangle \-I PREROUTING \-m socket \-\-transparent \-\-restore-skmark \-j action +.IP +\-t mangle \-A action \-m mark \-\-mark 10 \-j action2 +.IP +\-t mangle \-A action \-m mark \-\-mark 11 \-j action3 +.SS state +The "state" extension is a subset of the "conntrack" module. +"state" allows access to the connection tracking state for this packet. +.TP +[\fB!\fP] \fB\-\-state\fP \fIstate\fP +Where state is a comma separated list of the connection states to match. Only a +subset of the states unterstood by "conntrack" are recognized: \fBINVALID\fP, +\fBESTABLISHED\fP, \fBNEW\fP, \fBRELATED\fP or \fBUNTRACKED\fP. For their +description, see the "conntrack" heading in this manpage. +.SS statistic +This module matches packets based on some statistic condition. +It supports two distinct modes settable with the +\fB\-\-mode\fP +option. +.PP +Supported options: +.TP +\fB\-\-mode\fP \fImode\fP +Set the matching mode of the matching rule, supported modes are +.B random +and +.B nth. +.TP +[\fB!\fP] \fB\-\-probability\fP \fIp\fP +Set the probability for a packet to be randomly matched. It only works with the +\fBrandom\fP mode. \fIp\fP must be within 0.0 and 1.0. The supported +granularity is in 1/2147483648th increments. +.TP +[\fB!\fP] \fB\-\-every\fP \fIn\fP +Match one packet every nth packet. It works only with the +.B nth +mode (see also the +\fB\-\-packet\fP +option). +.TP +\fB\-\-packet\fP \fIp\fP +Set the initial counter value (0 <= p <= n\-1, default 0) for the +.B nth +mode. +.SS string +This module matches a given string by using some pattern matching strategy. It requires a linux kernel >= 2.6.14. +.TP +\fB\-\-algo\fP {\fBbm\fP|\fBkmp\fP} +Select the pattern matching strategy. (bm = Boyer-Moore, kmp = Knuth-Pratt-Morris) +.TP +\fB\-\-from\fP \fIoffset\fP +Set the offset from which it starts looking for any matching. If not passed, default is 0. +.TP +\fB\-\-to\fP \fIoffset\fP +Set the offset up to which should be scanned. That is, byte \fIoffset\fP-1 +(counting from 0) is the last one that is scanned. +If not passed, default is the packet size. +.TP +[\fB!\fP] \fB\-\-string\fP \fIpattern\fP +Matches the given pattern. +.TP +[\fB!\fP] \fB\-\-hex\-string\fP \fIpattern\fP +Matches the given pattern in hex notation. +.TP +\fB\-\-icase\fP +Ignore case when searching. +.TP +Examples: +.IP +# The string pattern can be used for simple text characters. +.br +iptables \-A INPUT \-p tcp \-\-dport 80 \-m string \-\-algo bm \-\-string 'GET /index.html' \-j LOG +.IP +# The hex string pattern can be used for non-printable characters, like |0D 0A| or |0D0A|. +.br +iptables \-p udp \-\-dport 53 \-m string \-\-algo bm \-\-from 40 \-\-to 57 \-\-hex\-string '|03|www|09|netfilter|03|org|00|' +.SS tcp +These extensions can be used if `\-\-protocol tcp' is specified. It +provides the following options: +.TP +[\fB!\fP] \fB\-\-source\-port\fP,\fB\-\-sport\fP \fIport\fP[\fB:\fP\fIport\fP] +Source port or port range specification. This can either be a service +name or a port number. An inclusive range can also be specified, +using the format \fIfirst\fP\fB:\fP\fIlast\fP. +If the first port is omitted, "0" is assumed; if the last is omitted, +"65535" is assumed. +The flag +\fB\-\-sport\fP +is a convenient alias for this option. +.TP +[\fB!\fP] \fB\-\-destination\-port\fP,\fB\-\-dport\fP \fIport\fP[\fB:\fP\fIport\fP] +Destination port or port range specification. The flag +\fB\-\-dport\fP +is a convenient alias for this option. +.TP +[\fB!\fP] \fB\-\-tcp\-flags\fP \fImask\fP \fIcomp\fP +Match when the TCP flags are as specified. The first argument \fImask\fP is the +flags which we should examine, written as a comma-separated list, and +the second argument \fIcomp\fP is a comma-separated list of flags which must be +set. Flags are: +.BR "SYN ACK FIN RST URG PSH ALL NONE" . +Hence the command +.nf + iptables \-A FORWARD \-p tcp \-\-tcp\-flags SYN,ACK,FIN,RST SYN +.fi +will only match packets with the SYN flag set, and the ACK, FIN and +RST flags unset. +.TP +[\fB!\fP] \fB\-\-syn\fP +Only match TCP packets with the SYN bit set and the ACK,RST and FIN bits +cleared. Such packets are used to request TCP connection initiation; +for example, blocking such packets coming in an interface will prevent +incoming TCP connections, but outgoing TCP connections will be +unaffected. +It is equivalent to \fB\-\-tcp\-flags SYN,RST,ACK,FIN SYN\fP. +If the "!" flag precedes the "\-\-syn", the sense of the +option is inverted. +.TP +[\fB!\fP] \fB\-\-tcp\-option\fP \fInumber\fP +Match if TCP option set. +.SS tcpmss +This matches the TCP MSS (maximum segment size) field of the TCP header. You can only use this on TCP SYN or SYN/ACK packets, since the MSS is only negotiated during the TCP handshake at connection startup time. +.TP +[\fB!\fP] \fB\-\-mss\fP \fIvalue\fP[\fB:\fP\fIvalue\fP] +Match a given TCP MSS value or range. If a range is given, the second \fIvalue\fP must be greater than or equal to the first \fIvalue\fP. +.SS time +This matches if the packet arrival time/date is within a given range. All +options are optional, but are ANDed when specified. All times are interpreted +as UTC by default. +.TP +\fB\-\-datestart\fP \fIYYYY\fP[\fB\-\fP\fIMM\fP[\fB\-\fP\fIDD\fP[\fBT\fP\fIhh\fP[\fB:\fP\fImm\fP[\fB:\fP\fIss\fP]]]]] +.TP +\fB\-\-datestop\fP \fIYYYY\fP[\fB\-\fP\fIMM\fP[\fB\-\fP\fIDD\fP[\fBT\fP\fIhh\fP[\fB:\fP\fImm\fP[\fB:\fP\fIss\fP]]]]] +Only match during the given time, which must be in ISO 8601 "T" notation. +The possible time range is 1970-01-01T00:00:00 to 2038-01-19T04:17:07. +.IP +If \-\-datestart or \-\-datestop are not specified, it will default to 1970-01-01 +and 2038-01-19, respectively. +.TP +\fB\-\-timestart\fP \fIhh\fP\fB:\fP\fImm\fP[\fB:\fP\fIss\fP] +.TP +\fB\-\-timestop\fP \fIhh\fP\fB:\fP\fImm\fP[\fB:\fP\fIss\fP] +Only match during the given daytime. The possible time range is 00:00:00 to +23:59:59. Leading zeroes are allowed (e.g. "06:03") and correctly interpreted +as base-10. +.TP +[\fB!\fP] \fB\-\-monthdays\fP \fIday\fP[\fB,\fP\fIday\fP...] +Only match on the given days of the month. Possible values are \fB1\fP +to \fB31\fP. Note that specifying \fB31\fP will of course not match +on months which do not have a 31st day; the same goes for 28- or 29-day +February. +.TP +[\fB!\fP] \fB\-\-weekdays\fP \fIday\fP[\fB,\fP\fIday\fP...] +Only match on the given weekdays. Possible values are \fBMon\fP, \fBTue\fP, +\fBWed\fP, \fBThu\fP, \fBFri\fP, \fBSat\fP, \fBSun\fP, or values from \fB1\fP +to \fB7\fP, respectively. You may also use two-character variants (\fBMo\fP, +\fBTu\fP, etc.). +.TP +\fB\-\-contiguous\fP +When \fB\-\-timestop\fP is smaller than \fB\-\-timestart\fP value, match +this as a single time period instead distinct intervals. See EXAMPLES. +.TP +\fB\-\-kerneltz\fP +Use the kernel timezone instead of UTC to determine whether a packet meets the +time regulations. +.PP +About kernel timezones: Linux keeps the system time in UTC, and always does so. +On boot, system time is initialized from a referential time source. Where this +time source has no timezone information, such as the x86 CMOS RTC, UTC will be +assumed. If the time source is however not in UTC, userspace should provide the +correct system time and timezone to the kernel once it has the information. +.PP +Local time is a feature on top of the (timezone independent) system time. Each +process has its own idea of local time, specified via the TZ environment +variable. The kernel also has its own timezone offset variable. The TZ +userspace environment variable specifies how the UTC-based system time is +displayed, e.g. when you run date(1), or what you see on your desktop clock. +The TZ string may resolve to different offsets at different dates, which is +what enables the automatic time-jumping in userspace. when DST changes. The +kernel's timezone offset variable is used when it has to convert between +non-UTC sources, such as FAT filesystems, to UTC (since the latter is what the +rest of the system uses). +.PP +The caveat with the kernel timezone is that Linux distributions may ignore to +set the kernel timezone, and instead only set the system time. Even if a +particular distribution does set the timezone at boot, it is usually does not +keep the kernel timezone offset - which is what changes on DST - up to date. +ntpd will not touch the kernel timezone, so running it will not resolve the +issue. As such, one may encounter a timezone that is always +0000, or one that +is wrong half of the time of the year. As such, \fBusing \-\-kerneltz is highly +discouraged.\fP +.PP +EXAMPLES. To match on weekends, use: +.IP +\-m time \-\-weekdays Sa,Su +.PP +Or, to match (once) on a national holiday block: +.IP +\-m time \-\-datestart 2007\-12\-24 \-\-datestop 2007\-12\-27 +.PP +Since the stop time is actually inclusive, you would need the following stop +time to not match the first second of the new day: +.IP +\-m time \-\-datestart 2007\-01\-01T17:00 \-\-datestop 2007\-01\-01T23:59:59 +.PP +During lunch hour: +.IP +\-m time \-\-timestart 12:30 \-\-timestop 13:30 +.PP +The fourth Friday in the month: +.IP +\-m time \-\-weekdays Fr \-\-monthdays 22,23,24,25,26,27,28 +.PP +(Note that this exploits a certain mathematical property. It is not possible to +say "fourth Thursday OR fourth Friday" in one rule. It is possible with +multiple rules, though.) +.PP +Matching across days might not do what is expected. For instance, +.IP +\-m time \-\-weekdays Mo \-\-timestart 23:00 \-\-timestop 01:00 +Will match Monday, for one hour from midnight to 1 a.m., and then +again for another hour from 23:00 onwards. If this is unwanted, e.g. if you +would like 'match for two hours from Montay 23:00 onwards' you need to also specify +the \-\-contiguous option in the example above. +.SS tos +This module matches the 8-bit Type of Service field in the IPv4 header (i.e. +including the "Precedence" bits) or the (also 8-bit) Priority field in the IPv6 +header. +.TP +[\fB!\fP] \fB\-\-tos\fP \fIvalue\fP[\fB/\fP\fImask\fP] +Matches packets with the given TOS mark value. If a mask is specified, it is +logically ANDed with the TOS mark before the comparison. +.TP +[\fB!\fP] \fB\-\-tos\fP \fIsymbol\fP +You can specify a symbolic name when using the tos match for IPv4. The list of +recognized TOS names can be obtained by calling iptables with \fB\-m tos \-h\fP. +Note that this implies a mask of 0x3F, i.e. all but the ECN bits. +.SS ttl (IPv4-specific) +This module matches the time to live field in the IP header. +.TP +[\fB!\fP] \fB\-\-ttl\-eq\fP \fIttl\fP +Matches the given TTL value. +.TP +\fB\-\-ttl\-gt\fP \fIttl\fP +Matches if TTL is greater than the given TTL value. +.TP +\fB\-\-ttl\-lt\fP \fIttl\fP +Matches if TTL is less than the given TTL value. +.SS u32 +U32 tests whether quantities of up to 4 bytes extracted from a packet have +specified values. The specification of what to extract is general enough to +find data at given offsets from tcp headers or payloads. +.TP +[\fB!\fP] \fB\-\-u32\fP \fItests\fP +The argument amounts to a program in a small language described below. +.IP +tests := location "=" value | tests "&&" location "=" value +.IP +value := range | value "," range +.IP +range := number | number ":" number +.PP +a single number, \fIn\fP, is interpreted the same as \fIn:n\fP. \fIn:m\fP is +interpreted as the range of numbers \fB>=n\fP and \fB<=m\fP. +.IP "" 4 +location := number | location operator number +.IP "" 4 +operator := "&" | "<<" | ">>" | "@" +.PP +The operators \fB&\fP, \fB<<\fP, \fB>>\fP and \fB&&\fP mean the same as in C. +The \fB=\fP is really a set membership operator and the value syntax describes +a set. The \fB@\fP operator is what allows moving to the next header and is +described further below. +.PP +There are currently some artificial implementation limits on the size of the +tests: +.IP " *" +no more than 10 of "\fB=\fP" (and 9 "\fB&&\fP"s) in the u32 argument +.IP " *" +no more than 10 ranges (and 9 commas) per value +.IP " *" +no more than 10 numbers (and 9 operators) per location +.PP +To describe the meaning of location, imagine the following machine that +interprets it. There are three registers: +.IP +A is of type \fBchar *\fP, initially the address of the IP header +.IP +B and C are unsigned 32 bit integers, initially zero +.PP +The instructions are: +.TP +.B number +B = number; +.IP +C = (*(A+B)<<24) + (*(A+B+1)<<16) + (*(A+B+2)<<8) + *(A+B+3) +.TP +.B &number +C = C & number +.TP +.B << number +C = C << number +.TP +.B >> number +C = C >> number +.TP +.B @number +A = A + C; then do the instruction number +.PP +Any access of memory outside [skb\->data,skb\->end] causes the match to fail. +Otherwise the result of the computation is the final value of C. +.PP +Whitespace is allowed but not required in the tests. However, the characters +that do occur there are likely to require shell quoting, so it is a good idea +to enclose the arguments in quotes. +.PP +Example: +.IP +match IP packets with total length >= 256 +.IP +The IP header contains a total length field in bytes 2-3. +.IP +\-\-u32 "\fB0 & 0xFFFF = 0x100:0xFFFF\fP" +.IP +read bytes 0-3 +.IP +AND that with 0xFFFF (giving bytes 2-3), and test whether that is in the range +[0x100:0xFFFF] +.PP +Example: (more realistic, hence more complicated) +.IP +match ICMP packets with icmp type 0 +.IP +First test that it is an ICMP packet, true iff byte 9 (protocol) = 1 +.IP +\-\-u32 "\fB6 & 0xFF = 1 &&\fP ... +.IP +read bytes 6-9, use \fB&\fP to throw away bytes 6-8 and compare the result to +1. Next test that it is not a fragment. (If so, it might be part of such a +packet but we cannot always tell.) N.B.: This test is generally needed if you +want to match anything beyond the IP header. The last 6 bits of byte 6 and all +of byte 7 are 0 iff this is a complete packet (not a fragment). Alternatively, +you can allow first fragments by only testing the last 5 bits of byte 6. +.IP + ... \fB4 & 0x3FFF = 0 &&\fP ... +.IP +Last test: the first byte past the IP header (the type) is 0. This is where we +have to use the @syntax. The length of the IP header (IHL) in 32 bit words is +stored in the right half of byte 0 of the IP header itself. +.IP + ... \fB0 >> 22 & 0x3C @ 0 >> 24 = 0\fP" +.IP +The first 0 means read bytes 0-3, \fB>>22\fP means shift that 22 bits to the +right. Shifting 24 bits would give the first byte, so only 22 bits is four +times that plus a few more bits. \fB&3C\fP then eliminates the two extra bits +on the right and the first four bits of the first byte. For instance, if IHL=5, +then the IP header is 20 (4 x 5) bytes long. In this case, bytes 0-1 are (in +binary) xxxx0101 yyzzzzzz, \fB>>22\fP gives the 10 bit value xxxx0101yy and +\fB&3C\fP gives 010100. \fB@\fP means to use this number as a new offset into +the packet, and read four bytes starting from there. This is the first 4 bytes +of the ICMP payload, of which byte 0 is the ICMP type. Therefore, we simply +shift the value 24 to the right to throw out all but the first byte and compare +the result with 0. +.PP +Example: +.IP +TCP payload bytes 8-12 is any of 1, 2, 5 or 8 +.IP +First we test that the packet is a tcp packet (similar to ICMP). +.IP +\-\-u32 "\fB6 & 0xFF = 6 &&\fP ... +.IP +Next, test that it is not a fragment (same as above). +.IP + ... \fB0 >> 22 & 0x3C @ 12 >> 26 & 0x3C @ 8 = 1,2,5,8\fP" +.IP +\fB0>>22&3C\fP as above computes the number of bytes in the IP header. \fB@\fP +makes this the new offset into the packet, which is the start of the TCP +header. The length of the TCP header (again in 32 bit words) is the left half +of byte 12 of the TCP header. The \fB12>>26&3C\fP computes this length in bytes +(similar to the IP header before). "@" makes this the new offset, which is the +start of the TCP payload. Finally, 8 reads bytes 8-12 of the payload and +\fB=\fP checks whether the result is any of 1, 2, 5 or 8. +.SS udp +These extensions can be used if `\-\-protocol udp' is specified. It +provides the following options: +.TP +[\fB!\fP] \fB\-\-source\-port\fP,\fB\-\-sport\fP \fIport\fP[\fB:\fP\fIport\fP] +Source port or port range specification. +See the description of the +\fB\-\-source\-port\fP +option of the TCP extension for details. +.TP +[\fB!\fP] \fB\-\-destination\-port\fP,\fB\-\-dport\fP \fIport\fP[\fB:\fP\fIport\fP] +Destination port or port range specification. +See the description of the +\fB\-\-destination\-port\fP +option of the TCP extension for details. +.SH TARGET EXTENSIONS +iptables can use extended target modules: the following are included +in the standard distribution. +.\" @TARGET@ +.SS AUDIT +This target creates audit records for packets hitting the target. +It can be used to record accepted, dropped, and rejected packets. See +auditd(8) for additional details. +.TP +\fB\-\-type\fP {\fBaccept\fP|\fBdrop\fP|\fBreject\fP} +Set type of audit record. Starting with linux-4.12, this option has no effect +on generated audit messages anymore. It is still accepted by iptables for +compatibility reasons, but ignored. +.PP +Example: +.IP +iptables \-N AUDIT_DROP +.IP +iptables \-A AUDIT_DROP \-j AUDIT +.IP +iptables \-A AUDIT_DROP \-j DROP +.SS CHECKSUM +This target selectively works around broken/old applications. +It can only be used in the mangle table. +.TP +\fB\-\-checksum\-fill\fP +Compute and fill in the checksum in a packet that lacks a checksum. +This is particularly useful, if you need to work around old applications +such as dhcp clients, that do not work well with checksum offloads, +but don't want to disable checksum offload in your device. +.SS CLASSIFY +This module allows you to set the skb\->priority value (and thus classify the packet into a specific CBQ class). +.TP +\fB\-\-set\-class\fP \fImajor\fP\fB:\fP\fIminor\fP +Set the major and minor class value. The values are always interpreted as +hexadecimal even if no 0x prefix is given. +.SS CLUSTERIP (IPv4-specific) +This module allows you to configure a simple cluster of nodes that share +a certain IP and MAC address without an explicit load balancer in front of +them. Connections are statically distributed between the nodes in this +cluster. +.PP +Please note that CLUSTERIP target is considered deprecated in favour of cluster +match which is more flexible and not limited to IPv4. +.TP +\fB\-\-new\fP +Create a new ClusterIP. You always have to set this on the first rule +for a given ClusterIP. +.TP +\fB\-\-hashmode\fP \fImode\fP +Specify the hashing mode. Has to be one of +\fBsourceip\fP, \fBsourceip\-sourceport\fP, \fBsourceip\-sourceport\-destport\fP. +.TP +\fB\-\-clustermac\fP \fImac\fP +Specify the ClusterIP MAC address. Has to be a link\-layer multicast address +.TP +\fB\-\-total\-nodes\fP \fInum\fP +Number of total nodes within this cluster. +.TP +\fB\-\-local\-node\fP \fInum\fP +Local node number within this cluster. +.TP +\fB\-\-hash\-init\fP \fIrnd\fP +Specify the random seed used for hash initialization. +.SS CONNMARK +This module sets the netfilter mark value associated with a connection. The +mark is 32 bits wide. +.TP +\fB\-\-set\-xmark\fP \fIvalue\fP[\fB/\fP\fImask\fP] +Zero out the bits given by \fImask\fP and XOR \fIvalue\fP into the ctmark. +.TP +\fB\-\-save\-mark\fP [\fB\-\-nfmask\fP \fInfmask\fP] [\fB\-\-ctmask\fP \fIctmask\fP] +Copy the packet mark (nfmark) to the connection mark (ctmark) using the given +masks. The new nfmark value is determined as follows: +.IP +ctmark = (ctmark & ~ctmask) ^ (nfmark & nfmask) +.IP +i.e. \fIctmask\fP defines what bits to clear and \fInfmask\fP what bits of the +nfmark to XOR into the ctmark. \fIctmask\fP and \fInfmask\fP default to +0xFFFFFFFF. +.TP +\fB\-\-restore\-mark\fP [\fB\-\-nfmask\fP \fInfmask\fP] [\fB\-\-ctmask\fP \fIctmask\fP] +Copy the connection mark (ctmark) to the packet mark (nfmark) using the given +masks. The new ctmark value is determined as follows: +.IP +nfmark = (nfmark & ~\fInfmask\fP) ^ (ctmark & \fIctmask\fP); +.IP +i.e. \fInfmask\fP defines what bits to clear and \fIctmask\fP what bits of the +ctmark to XOR into the nfmark. \fIctmask\fP and \fInfmask\fP default to +0xFFFFFFFF. +.IP +\fB\-\-restore\-mark\fP is only valid in the \fBmangle\fP table. +.PP +The following mnemonics are available for \fB\-\-set\-xmark\fP: +.TP +\fB\-\-and\-mark\fP \fIbits\fP +Binary AND the ctmark with \fIbits\fP. (Mnemonic for \fB\-\-set\-xmark +0/\fP\fIinvbits\fP, where \fIinvbits\fP is the binary negation of \fIbits\fP.) +.TP +\fB\-\-or\-mark\fP \fIbits\fP +Binary OR the ctmark with \fIbits\fP. (Mnemonic for \fB\-\-set\-xmark\fP +\fIbits\fP\fB/\fP\fIbits\fP.) +.TP +\fB\-\-xor\-mark\fP \fIbits\fP +Binary XOR the ctmark with \fIbits\fP. (Mnemonic for \fB\-\-set\-xmark\fP +\fIbits\fP\fB/0\fP.) +.TP +\fB\-\-set\-mark\fP \fIvalue\fP[\fB/\fP\fImask\fP] +Set the connection mark. If a mask is specified then only those bits set in the +mask are modified. +.TP +\fB\-\-save\-mark\fP [\fB\-\-mask\fP \fImask\fP] +Copy the nfmark to the ctmark. If a mask is specified, only those bits are +copied. +.TP +\fB\-\-restore\-mark\fP [\fB\-\-mask\fP \fImask\fP] +Copy the ctmark to the nfmark. If a mask is specified, only those bits are +copied. This is only valid in the \fBmangle\fP table. +.SS CONNSECMARK +This module copies security markings from packets to connections +(if unlabeled), and from connections back to packets (also only +if unlabeled). Typically used in conjunction with SECMARK, it is +valid in the +.B security +table (for backwards compatibility with older kernels, it is also +valid in the +.B mangle +table). +.TP +\fB\-\-save\fP +If the packet has a security marking, copy it to the connection +if the connection is not marked. +.TP +\fB\-\-restore\fP +If the packet does not have a security marking, and the connection +does, copy the security marking from the connection to the packet. + +.SS CT +The CT target sets parameters for a packet or its associated +connection. The target attaches a "template" connection tracking entry to +the packet, which is then used by the conntrack core when initializing +a new ct entry. This target is thus only valid in the "raw" table. +.TP +\fB\-\-notrack\fP +Disables connection tracking for this packet. +.TP +\fB\-\-helper\fP \fIname\fP +Use the helper identified by \fIname\fP for the connection. This is more +flexible than loading the conntrack helper modules with preset ports. +.TP +\fB\-\-ctevents\fP \fIevent\fP[\fB,\fP...] +Only generate the specified conntrack events for this connection. Possible +event types are: \fBnew\fP, \fBrelated\fP, \fBdestroy\fP, \fBreply\fP, +\fBassured\fP, \fBprotoinfo\fP, \fBhelper\fP, \fBmark\fP (this refers to +the ctmark, not nfmark), \fBnatseqinfo\fP, \fBsecmark\fP (ctsecmark). +.TP +\fB\-\-expevents\fP \fIevent\fP[\fB,\fP...] +Only generate the specified expectation events for this connection. +Possible event types are: \fBnew\fP. +.TP +\fB\-\-zone-orig\fP {\fIid\fP|\fBmark\fP} +For traffic coming from ORIGINAL direction, assign this packet to zone +\fIid\fP and only have lookups done in that zone. If \fBmark\fP is used +instead of \fIid\fP, the zone is derived from the packet nfmark. +.TP +\fB\-\-zone-reply\fP {\fIid\fP|\fBmark\fP} +For traffic coming from REPLY direction, assign this packet to zone +\fIid\fP and only have lookups done in that zone. If \fBmark\fP is used +instead of \fIid\fP, the zone is derived from the packet nfmark. +.TP +\fB\-\-zone\fP {\fIid\fP|\fBmark\fP} +Assign this packet to zone \fIid\fP and only have lookups done in that zone. +If \fBmark\fP is used instead of \fIid\fP, the zone is derived from the +packet nfmark. By default, packets have zone 0. This option applies to both +directions. +.TP +\fB\-\-timeout\fP \fIname\fP +Use the timeout policy identified by \fIname\fP for the connection. This is +provides more flexible timeout policy definition than global timeout values +available at /proc/sys/net/netfilter/nf_conntrack_*_timeout_*. +.SS DNAT +This target is only valid in the +.B nat +table, in the +.B PREROUTING +and +.B OUTPUT +chains, and user-defined chains which are only called from those +chains. It specifies that the destination address of the packet +should be modified (and all future packets in this connection will +also be mangled), and rules should cease being examined. It takes the +following options: +.TP +\fB\-\-to\-destination\fP [\fIipaddr\fP[\fB\-\fP\fIipaddr\fP]][\fB:\fP\fIport\fP[\fB\-\fP\fIport\fP]] +which can specify a single new destination IP address, an inclusive +range of IP addresses. Optionally a port range, +if the rule also specifies one of the following protocols: +\fBtcp\fP, \fBudp\fP, \fBdccp\fP or \fBsctp\fP. +If no port range is specified, then the destination port will never be +modified. If no IP address is specified then only the destination port +will be modified. +In Kernels up to 2.6.10 you can add several \-\-to\-destination options. For +those kernels, if you specify more than one destination address, either via an +address range or multiple \-\-to\-destination options, a simple round-robin (one +after another in cycle) load balancing takes place between these addresses. +Later Kernels (>= 2.6.11-rc1) don't have the ability to NAT to multiple ranges +anymore. +.TP +\fB\-\-random\fP +If option +\fB\-\-random\fP +is used then port mapping will be randomized (kernel >= 2.6.22). +.TP +\fB\-\-persistent\fP +Gives a client the same source-/destination-address for each connection. +This supersedes the SAME target. Support for persistent mappings is available +from 2.6.29-rc2. +.TP +IPv6 support available since Linux kernels >= 3.7. +.SS DNPT (IPv6-specific) +Provides stateless destination IPv6-to-IPv6 Network Prefix Translation (as +described by RFC 6296). +.PP +You have to use this target in the +.B mangle +table, not in the +.B nat +table. It takes the following options: +.TP +\fB\-\-src\-pfx\fP [\fIprefix/\fP\fIlength] +Set source prefix that you want to translate and length +.TP +\fB\-\-dst\-pfx\fP [\fIprefix/\fP\fIlength] +Set destination prefix that you want to use in the translation and length +.PP +You have to use the SNPT target to undo the translation. Example: +.IP +ip6tables \-t mangle \-I POSTROUTING \-s fd00::/64 \! \-o vboxnet0 +\-j SNPT \-\-src-pfx fd00::/64 \-\-dst-pfx 2001:e20:2000:40f::/64 +.IP +ip6tables \-t mangle \-I PREROUTING \-i wlan0 \-d 2001:e20:2000:40f::/64 +\-j DNPT \-\-src-pfx 2001:e20:2000:40f::/64 \-\-dst-pfx fd00::/64 +.PP +You may need to enable IPv6 neighbor proxy: +.IP +sysctl \-w net.ipv6.conf.all.proxy_ndp=1 +.PP +You also have to use the +.B NOTRACK +target to disable connection tracking for translated flows. +.SS DSCP +This target alters the value of the DSCP bits within the TOS +header of the IPv4 packet. As this manipulates a packet, it can only +be used in the mangle table. +.TP +\fB\-\-set\-dscp\fP \fIvalue\fP +Set the DSCP field to a numerical value (can be decimal or hex) +.TP +\fB\-\-set\-dscp\-class\fP \fIclass\fP +Set the DSCP field to a DiffServ class. +.SS ECN (IPv4-specific) +This target selectively works around known ECN blackholes. +It can only be used in the mangle table. +.TP +\fB\-\-ecn\-tcp\-remove\fP +Remove all ECN bits from the TCP header. Of course, it can only be used +in conjunction with +\fB\-p tcp\fP. +.SS HL (IPv6-specific) +This is used to modify the Hop Limit field in IPv6 header. The Hop Limit field +is similar to what is known as TTL value in IPv4. Setting or incrementing the +Hop Limit field can potentially be very dangerous, so it should be avoided at +any cost. This target is only valid in +.B mangle +table. +.PP +.B Don't ever set or increment the value on packets that leave your local network! +.TP +\fB\-\-hl\-set\fP \fIvalue\fP +Set the Hop Limit to `value'. +.TP +\fB\-\-hl\-dec\fP \fIvalue\fP +Decrement the Hop Limit `value' times. +.TP +\fB\-\-hl\-inc\fP \fIvalue\fP +Increment the Hop Limit `value' times. +.SS HMARK +Like MARK, i.e. set the fwmark, but the mark is calculated from hashing +packet selector at choice. You have also to specify the mark range and, +optionally, the offset to start from. ICMP error messages are inspected +and used to calculate the hashing. +.PP +Existing options are: +.TP +\fB\-\-hmark\-tuple\fP tuple\fI\fP +Possible tuple members are: +.B src +meaning source address (IPv4, IPv6 address), +.B dst +meaning destination address (IPv4, IPv6 address), +.B sport +meaning source port (TCP, UDP, UDPlite, SCTP, DCCP), +.B dport +meaning destination port (TCP, UDP, UDPlite, SCTP, DCCP), +.B spi +meaning Security Parameter Index (AH, ESP), and +.B ct +meaning the usage of the conntrack tuple instead of the packet selectors. +.TP +\fB\-\-hmark\-mod\fP \fIvalue (must be > 0)\fP +Modulus for hash calculation (to limit the range of possible marks) +.TP +\fB\-\-hmark\-offset\fP \fIvalue\fP +Offset to start marks from. +.TP +For advanced usage, instead of using \-\-hmark\-tuple, you can specify custom +prefixes and masks: +.TP +\fB\-\-hmark\-src\-prefix\fP \fIcidr\fP +The source address mask in CIDR notation. +.TP +\fB\-\-hmark\-dst\-prefix\fP \fIcidr\fP +The destination address mask in CIDR notation. +.TP +\fB\-\-hmark\-sport\-mask\fP \fIvalue\fP +A 16 bit source port mask in hexadecimal. +.TP +\fB\-\-hmark\-dport\-mask\fP \fIvalue\fP +A 16 bit destination port mask in hexadecimal. +.TP +\fB\-\-hmark\-spi\-mask\fP \fIvalue\fP +A 32 bit field with spi mask. +.TP +\fB\-\-hmark\-proto\-mask\fP \fIvalue\fP +An 8 bit field with layer 4 protocol number. +.TP +\fB\-\-hmark\-rnd\fP \fIvalue\fP +A 32 bit random custom value to feed hash calculation. +.PP +\fIExamples:\fP +.PP +iptables \-t mangle \-A PREROUTING \-m conntrack \-\-ctstate NEW + \-j HMARK \-\-hmark-tuple ct,src,dst,proto \-\-hmark-offset 10000 +\-\-hmark\-mod 10 \-\-hmark\-rnd 0xfeedcafe +.PP +iptables \-t mangle \-A PREROUTING \-j HMARK \-\-hmark\-offset 10000 +\-\-hmark-tuple src,dst,proto \-\-hmark-mod 10 \-\-hmark\-rnd 0xdeafbeef +.SS IDLETIMER +This target can be used to identify when interfaces have been idle for a +certain period of time. Timers are identified by labels and are created when +a rule is set with a new label. The rules also take a timeout value (in +seconds) as an option. If more than one rule uses the same timer label, the +timer will be restarted whenever any of the rules get a hit. One entry for +each timer is created in sysfs. This attribute contains the timer remaining +for the timer to expire. The attributes are located under the xt_idletimer +class: +.PP +/sys/class/xt_idletimer/timers/<label> +.PP +When the timer expires, the target module sends a sysfs notification to the +userspace, which can then decide what to do (eg. disconnect to save power). +.TP +\fB\-\-timeout\fP \fIamount\fP +This is the time in seconds that will trigger the notification. +.TP +\fB\-\-label\fP \fIstring\fP +This is a unique identifier for the timer. The maximum length for the +label string is 27 characters. +.SS LED +This creates an LED-trigger that can then be attached to system indicator +lights, to blink or illuminate them when certain packets pass through the +system. One example might be to light up an LED for a few minutes every time +an SSH connection is made to the local machine. The following options control +the trigger behavior: +.TP +\fB\-\-led\-trigger\-id\fP \fIname\fP +This is the name given to the LED trigger. The actual name of the trigger +will be prefixed with "netfilter-". +.TP +\fB\-\-led-delay\fP \fIms\fP +This indicates how long (in milliseconds) the LED should be left illuminated +when a packet arrives before being switched off again. The default is 0 +(blink as fast as possible.) The special value \fIinf\fP can be given to +leave the LED on permanently once activated. (In this case the trigger will +need to be manually detached and reattached to the LED device to switch it +off again.) +.TP +\fB\-\-led\-always\-blink\fP +Always make the LED blink on packet arrival, even if the LED is already on. +This allows notification of new packets even with long delay values (which +otherwise would result in a silent prolonging of the delay time.) +.TP +Example: +.TP +Create an LED trigger for incoming SSH traffic: +iptables \-A INPUT \-p tcp \-\-dport 22 \-j LED \-\-led\-trigger\-id ssh +.TP +Then attach the new trigger to an LED: +echo netfilter\-ssh >/sys/class/leds/\fIledname\fP/trigger +.SS LOG +Turn on kernel logging of matching packets. When this option is set +for a rule, the Linux kernel will print some information on all +matching packets (like most IP/IPv6 header fields) via the kernel log +(where it can be read with \fIdmesg(1)\fP or read in the syslog). +.PP +This is a "non-terminating target", i.e. rule traversal continues at +the next rule. So if you want to LOG the packets you refuse, use two +separate rules with the same matching criteria, first using target LOG +then DROP (or REJECT). +.TP +\fB\-\-log\-level\fP \fIlevel\fP +Level of logging, which can be (system-specific) numeric or a mnemonic. +Possible values are (in decreasing order of priority): \fBemerg\fP, +\fBalert\fP, \fBcrit\fP, \fBerror\fP, \fBwarning\fP, \fBnotice\fP, \fBinfo\fP +or \fBdebug\fP. +.TP +\fB\-\-log\-prefix\fP \fIprefix\fP +Prefix log messages with the specified prefix; up to 29 letters long, +and useful for distinguishing messages in the logs. +.TP +\fB\-\-log\-tcp\-sequence\fP +Log TCP sequence numbers. This is a security risk if the log is +readable by users. +.TP +\fB\-\-log\-tcp\-options\fP +Log options from the TCP packet header. +.TP +\fB\-\-log\-ip\-options\fP +Log options from the IP/IPv6 packet header. +.TP +\fB\-\-log\-uid\fP +Log the userid of the process which generated the packet. +.SS MARK +This target is used to set the Netfilter mark value associated with the packet. +It can, for example, be used in conjunction with routing based on fwmark (needs +iproute2). If you plan on doing so, note that the mark needs to be set in +either the PREROUTING or the OUTPUT chain of the mangle table to affect routing. +The mark field is 32 bits wide. +.TP +\fB\-\-set\-xmark\fP \fIvalue\fP[\fB/\fP\fImask\fP] +Zeroes out the bits given by \fImask\fP and XORs \fIvalue\fP into the packet +mark ("nfmark"). If \fImask\fP is omitted, 0xFFFFFFFF is assumed. +.TP +\fB\-\-set\-mark\fP \fIvalue\fP[\fB/\fP\fImask\fP] +Zeroes out the bits given by \fImask\fP and ORs \fIvalue\fP into the packet +mark. If \fImask\fP is omitted, 0xFFFFFFFF is assumed. +.PP +The following mnemonics are available: +.TP +\fB\-\-and\-mark\fP \fIbits\fP +Binary AND the nfmark with \fIbits\fP. (Mnemonic for \fB\-\-set\-xmark +0/\fP\fIinvbits\fP, where \fIinvbits\fP is the binary negation of \fIbits\fP.) +.TP +\fB\-\-or\-mark\fP \fIbits\fP +Binary OR the nfmark with \fIbits\fP. (Mnemonic for \fB\-\-set\-xmark\fP +\fIbits\fP\fB/\fP\fIbits\fP.) +.TP +\fB\-\-xor\-mark\fP \fIbits\fP +Binary XOR the nfmark with \fIbits\fP. (Mnemonic for \fB\-\-set\-xmark\fP +\fIbits\fP\fB/0\fP.) +.SS MASQUERADE +This target is only valid in the +.B nat +table, in the +.B POSTROUTING +chain. It should only be used with dynamically assigned IP (dialup) +connections: if you have a static IP address, you should use the SNAT +target. Masquerading is equivalent to specifying a mapping to the IP +address of the interface the packet is going out, but also has the +effect that connections are +.I forgotten +when the interface goes down. This is the correct behavior when the +next dialup is unlikely to have the same interface address (and hence +any established connections are lost anyway). +.TP +\fB\-\-to\-ports\fP \fIport\fP[\fB\-\fP\fIport\fP] +This specifies a range of source ports to use, overriding the default +.B SNAT +source port-selection heuristics (see above). This is only valid +if the rule also specifies one of the following protocols: +\fBtcp\fP, \fBudp\fP, \fBdccp\fP or \fBsctp\fP. +.TP +\fB\-\-random\fP +Randomize source port mapping +If option +\fB\-\-random\fP +is used then port mapping will be randomized (kernel >= 2.6.21). +Since kernel 5.0, \fB\-\-random\fP is identical to \fB\-\-random-fully\fP. +.TP +\fB\-\-random-fully\fP +Full randomize source port mapping +If option +\fB\-\-random-fully\fP +is used then port mapping will be fully randomized (kernel >= 3.13). +.TP +IPv6 support available since Linux kernels >= 3.7. +.SS NETMAP +This target allows you to statically map a whole network of addresses onto +another network of addresses. It can only be used from rules in the +.B nat +table. +.TP +\fB\-\-to\fP \fIaddress\fP[\fB/\fP\fImask\fP] +Network address to map to. The resulting address will be constructed in the +following way: All 'one' bits in the mask are filled in from the new `address'. +All bits that are zero in the mask are filled in from the original address. +.TP +IPv6 support available since Linux kernels >= 3.7. +.SS NFLOG +This target provides logging of matching packets. When this target is +set for a rule, the Linux kernel will pass the packet to the loaded +logging backend to log the packet. This is usually used in combination +with nfnetlink_log as logging backend, which will multicast the packet +through a +.IR netlink +socket to the specified multicast group. One or more userspace processes +may subscribe to the group to receive the packets. Like LOG, this is a +non-terminating target, i.e. rule traversal continues at the next rule. +.TP +\fB\-\-nflog\-group\fP \fInlgroup\fP +The netlink group (0 - 2^16\-1) to which packets are (only applicable for +nfnetlink_log). The default value is 0. +.TP +\fB\-\-nflog\-prefix\fP \fIprefix\fP +A prefix string to include in the log message, up to 64 characters +long, useful for distinguishing messages in the logs. +.TP +\fB\-\-nflog\-range\fP \fIsize\fP +This option has never worked, use --nflog-size instead +.TP +\fB\-\-nflog\-size\fP \fIsize\fP +The number of bytes to be copied to userspace (only applicable for +nfnetlink_log). nfnetlink_log instances may specify their own +range, this option overrides it. +.TP +\fB\-\-nflog\-threshold\fP \fIsize\fP +Number of packets to queue inside the kernel before sending them +to userspace (only applicable for nfnetlink_log). Higher values +result in less overhead per packet, but increase delay until the +packets reach userspace. The default value is 1. +.BR +.SS NFQUEUE +This target passes the packet to userspace using the +\fBnfnetlink_queue\fP handler. The packet is put into the queue +identified by its 16-bit queue number. Userspace can inspect +and modify the packet if desired. Userspace must then drop or +reinject the packet into the kernel. Please see libnetfilter_queue +for details. +.B +nfnetlink_queue +was added in Linux 2.6.14. The \fBqueue-balance\fP option was added in Linux 2.6.31, +\fBqueue-bypass\fP in 2.6.39. +.TP +\fB\-\-queue\-num\fP \fIvalue\fP +This specifies the QUEUE number to use. Valid queue numbers are 0 to 65535. The default value is 0. +.PP +.TP +\fB\-\-queue\-balance\fP \fIvalue\fP\fB:\fP\fIvalue\fP +This specifies a range of queues to use. Packets are then balanced across the given queues. +This is useful for multicore systems: start multiple instances of the userspace program on +queues x, x+1, .. x+n and use "\-\-queue\-balance \fIx\fP\fB:\fP\fIx+n\fP". +Packets belonging to the same connection are put into the same nfqueue. +.PP +.TP +\fB\-\-queue\-bypass\fP +By default, if no userspace program is listening on an NFQUEUE, then all packets that are to be queued +are dropped. When this option is used, the NFQUEUE rule behaves like ACCEPT instead, and the packet +will move on to the next table. +.PP +.TP +\fB\-\-queue\-cpu-fanout\fP +Available starting Linux kernel 3.10. When used together with +\fB--queue-balance\fP this will use the CPU ID as an index to map packets to +the queues. The idea is that you can improve performance if there's a queue +per CPU. This requires \fB--queue-balance\fP to be specified. +.SS NOTRACK +This extension disables connection tracking for all packets matching that rule. +It is equivalent with \-j CT \-\-notrack. Like CT, NOTRACK can only be used in +the \fBraw\fP table. +.SS RATEEST +The RATEEST target collects statistics, performs rate estimation calculation +and saves the results for later evaluation using the \fBrateest\fP match. +.TP +\fB\-\-rateest\-name\fP \fIname\fP +Count matched packets into the pool referred to by \fIname\fP, which is freely +choosable. +.TP +\fB\-\-rateest\-interval\fP \fIamount\fP{\fBs\fP|\fBms\fP|\fBus\fP} +Rate measurement interval, in seconds, milliseconds or microseconds. +.TP +\fB\-\-rateest\-ewmalog\fP \fIvalue\fP +Rate measurement averaging time constant. +.SS REDIRECT +This target is only valid in the +.B nat +table, in the +.B PREROUTING +and +.B OUTPUT +chains, and user-defined chains which are only called from those +chains. It redirects the packet to the machine itself by changing the +destination IP to the primary address of the incoming interface +(locally-generated packets are mapped to the localhost address, +127.0.0.1 for IPv4 and ::1 for IPv6, and packets arriving on +interfaces that don't have an IP address configured are dropped). +.TP +\fB\-\-to\-ports\fP \fIport\fP[\fB\-\fP\fIport\fP] +This specifies a destination port or range of ports to use: without +this, the destination port is never altered. This is only valid +if the rule also specifies one of the following protocols: +\fBtcp\fP, \fBudp\fP, \fBdccp\fP or \fBsctp\fP. +.TP +\fB\-\-random\fP +If option +\fB\-\-random\fP +is used then port mapping will be randomized (kernel >= 2.6.22). +.TP +IPv6 support available starting Linux kernels >= 3.7. +.SS REJECT (IPv6-specific) +This is used to send back an error packet in response to the matched +packet: otherwise it is equivalent to +.B DROP +so it is a terminating TARGET, ending rule traversal. +This target is only valid in the +.BR INPUT , +.B FORWARD +and +.B OUTPUT +chains, and user-defined chains which are only called from those +chains. The following option controls the nature of the error packet +returned: +.TP +\fB\-\-reject\-with\fP \fItype\fP +The type given can be +\fBicmp6\-no\-route\fP, +\fBno\-route\fP, +\fBicmp6\-adm\-prohibited\fP, +\fBadm\-prohibited\fP, +\fBicmp6\-addr\-unreachable\fP, +\fBaddr\-unreach\fP, or +\fBicmp6\-port\-unreachable\fP, +which return the appropriate ICMPv6 error message (\fBicmp6\-port\-unreachable\fP is +the default). Finally, the option +\fBtcp\-reset\fP +can be used on rules which only match the TCP protocol: this causes a +TCP RST packet to be sent back. This is mainly useful for blocking +.I ident +(113/tcp) probes which frequently occur when sending mail to broken mail +hosts (which won't accept your mail otherwise). +\fBtcp\-reset\fP +can only be used with kernel versions 2.6.14 or later. +.PP +\fIWarning:\fP You should not indiscriminately apply the REJECT target to +packets whose connection state is classified as INVALID; instead, you should +only DROP these. +.PP +Consider a source host transmitting a packet P, with P experiencing so much +delay along its path that the source host issues a retransmission, P_2, with +P_2 being successful in reaching its destination and advancing the connection +state normally. It is conceivable that the late-arriving P may be considered +not to be associated with any connection tracking entry. Generating a reject +response for a packet so classed would then terminate the healthy connection. +.PP +So, instead of: +.PP +-A INPUT ... -j REJECT +.PP +do consider using: +.PP +-A INPUT ... -m conntrack --ctstate INVALID -j DROP +-A INPUT ... -j REJECT +.SS REJECT (IPv4-specific) +This is used to send back an error packet in response to the matched +packet: otherwise it is equivalent to +.B DROP +so it is a terminating TARGET, ending rule traversal. +This target is only valid in the +.BR INPUT , +.B FORWARD +and +.B OUTPUT +chains, and user-defined chains which are only called from those +chains. The following option controls the nature of the error packet +returned: +.TP +\fB\-\-reject\-with\fP \fItype\fP +The type given can be +\fBicmp\-net\-unreachable\fP, +\fBicmp\-host\-unreachable\fP, +\fBicmp\-port\-unreachable\fP, +\fBicmp\-proto\-unreachable\fP, +\fBicmp\-net\-prohibited\fP, +\fBicmp\-host\-prohibited\fP, or +\fBicmp\-admin\-prohibited\fP (*), +which return the appropriate ICMP error message (\fBicmp\-port\-unreachable\fP is +the default). The option +\fBtcp\-reset\fP +can be used on rules which only match the TCP protocol: this causes a +TCP RST packet to be sent back. This is mainly useful for blocking +.I ident +(113/tcp) probes which frequently occur when sending mail to broken mail +hosts (which won't accept your mail otherwise). +.IP +(*) Using icmp\-admin\-prohibited with kernels that do not support it will result in a plain DROP instead of REJECT +.PP +\fIWarning:\fP You should not indiscriminately apply the REJECT target to +packets whose connection state is classified as INVALID; instead, you should +only DROP these. +.PP +Consider a source host transmitting a packet P, with P experiencing so much +delay along its path that the source host issues a retransmission, P_2, with +P_2 being successful in reaching its destination and advancing the connection +state normally. It is conceivable that the late-arriving P may be considered +not to be associated with any connection tracking entry. Generating a reject +response for a packet so classed would then terminate the healthy connection. +.PP +So, instead of: +.PP +-A INPUT ... -j REJECT +.PP +do consider using: +.PP +-A INPUT ... -m conntrack --ctstate INVALID -j DROP +-A INPUT ... -j REJECT +.SS SECMARK +This is used to set the security mark value associated with the +packet for use by security subsystems such as SELinux. It is +valid in the +.B security +table (for backwards compatibility with older kernels, it is also +valid in the +.B mangle +table). The mark is 32 bits wide. +.TP +\fB\-\-selctx\fP \fIsecurity_context\fP +.SS SET +This module adds and/or deletes entries from IP sets which can be defined +by ipset(8). +.TP +\fB\-\-add\-set\fP \fIsetname\fP \fIflag\fP[\fB,\fP\fIflag\fP...] +add the address(es)/port(s) of the packet to the set +.TP +\fB\-\-del\-set\fP \fIsetname\fP \fIflag\fP[\fB,\fP\fIflag\fP...] +delete the address(es)/port(s) of the packet from the set +.TP +\fB\-\-map\-set\fP \fIsetname\fP \fIflag\fP[\fB,\fP\fIflag\fP...] +[\-\-map\-mark] [\-\-map\-prio] [\-\-map\-queue] +map packet properties (firewall mark, tc priority, hardware queue) +.IP +where \fIflag\fP(s) are +.BR "src" +and/or +.BR "dst" +specifications and there can be no more than six of them. +.TP +\fB\-\-timeout\fP \fIvalue\fP +when adding an entry, the timeout value to use instead of the default +one from the set definition +.TP +\fB\-\-exist\fP +when adding an entry if it already exists, reset the timeout value +to the specified one or to the default from the set definition +.TP +\fB\-\-map\-set\fP \fIset\-name\fP +the set-name should be created with --skbinfo option +\fB\-\-map\-mark\fP +map firewall mark to packet by lookup of value in the set +\fB\-\-map\-prio\fP +map traffic control priority to packet by lookup of value in the set +\fB\-\-map\-queue\fP +map hardware NIC queue to packet by lookup of value in the set +.IP +The +\fB\-\-map\-set\fP +option can be used from the mangle table only. The +\fB\-\-map\-prio\fP +and +\fB\-\-map\-queue\fP +flags can be used in the OUTPUT, FORWARD and POSTROUTING chains. +.PP +Use of \-j SET requires that ipset kernel support is provided, which, for +standard kernels, is the case since Linux 2.6.39. +.SS SNAT +This target is only valid in the +.B nat +table, in the +.B POSTROUTING +and +.B INPUT +chains, and user-defined chains which are only called from those +chains. It specifies that the source address of the packet should be +modified (and all future packets in this connection will also be +mangled), and rules should cease being examined. It takes the +following options: +.TP +\fB\-\-to\-source\fP [\fIipaddr\fP[\fB\-\fP\fIipaddr\fP]][\fB:\fP\fIport\fP[\fB\-\fP\fIport\fP]] +which can specify a single new source IP address, an inclusive range +of IP addresses. Optionally a port range, +if the rule also specifies one of the following protocols: +\fBtcp\fP, \fBudp\fP, \fBdccp\fP or \fBsctp\fP. +If no port range is specified, then source ports below 512 will be +mapped to other ports below 512: those between 512 and 1023 inclusive +will be mapped to ports below 1024, and other ports will be mapped to +1024 or above. Where possible, no port alteration will occur. +In Kernels up to 2.6.10, you can add several \-\-to\-source options. For those +kernels, if you specify more than one source address, either via an address +range or multiple \-\-to\-source options, a simple round-robin (one after another +in cycle) takes place between these addresses. +Later Kernels (>= 2.6.11-rc1) don't have the ability to NAT to multiple ranges +anymore. +.TP +\fB\-\-random\fP +If option +\fB\-\-random\fP +is used then port mapping will be randomized through a hash-based algorithm (kernel >= 2.6.21). +.TP +\fB\-\-random-fully\fP +If option +\fB\-\-random-fully\fP +is used then port mapping will be fully randomized through a PRNG (kernel >= 3.14). +.TP +\fB\-\-persistent\fP +Gives a client the same source-/destination-address for each connection. +This supersedes the SAME target. Support for persistent mappings is available +from 2.6.29-rc2. +.PP +Kernels prior to 2.6.36-rc1 don't have the ability to +.B SNAT +in the +.B INPUT +chain. +.TP +IPv6 support available since Linux kernels >= 3.7. +.SS SNPT (IPv6-specific) +Provides stateless source IPv6-to-IPv6 Network Prefix Translation (as described +by RFC 6296). +.PP +You have to use this target in the +.B mangle +table, not in the +.B nat +table. It takes the following options: +.TP +\fB\-\-src\-pfx\fP [\fIprefix/\fP\fIlength] +Set source prefix that you want to translate and length +.TP +\fB\-\-dst\-pfx\fP [\fIprefix/\fP\fIlength] +Set destination prefix that you want to use in the translation and length +.PP +You have to use the DNPT target to undo the translation. Example: +.IP +ip6tables \-t mangle \-I POSTROUTING \-s fd00::/64 \! \-o vboxnet0 +\-j SNPT \-\-src-pfx fd00::/64 \-\-dst-pfx 2001:e20:2000:40f::/64 +.IP +ip6tables \-t mangle \-I PREROUTING \-i wlan0 \-d 2001:e20:2000:40f::/64 +\-j DNPT \-\-src-pfx 2001:e20:2000:40f::/64 \-\-dst-pfx fd00::/64 +.PP +You may need to enable IPv6 neighbor proxy: +.IP +sysctl \-w net.ipv6.conf.all.proxy_ndp=1 +.PP +You also have to use the +.B NOTRACK +target to disable connection tracking for translated flows. +.SS SYNPROXY +This target will process TCP three-way-handshake parallel in netfilter +context to protect either local or backend system. This target requires +connection tracking because sequence numbers need to be translated. +The kernels ability to absorb SYNFLOOD was greatly improved starting with +Linux 4.4, so this target should not be needed anymore to protect Linux servers. +.TP +\fB\-\-mss\fP \fImaximum segment size\fP +Maximum segment size announced to clients. This must match the backend. +.TP +\fB\-\-wscale\fP \fIwindow scale\fP +Window scale announced to clients. This must match the backend. +.TP +\fB\-\-sack\-perm\fP +Pass client selective acknowledgement option to backend (will be disabled +if not present). +.TP +\fB\-\-timestamps\fP +Pass client timestamp option to backend (will be disabled if not present, +also needed for selective acknowledgement and window scaling). +.PP +Example: +.PP +Determine tcp options used by backend, from an external system +.IP +tcpdump -pni eth0 -c 1 'tcp[tcpflags] == (tcp-syn|tcp-ack)' +.br + port 80 & +.br +telnet 192.0.2.42 80 +.br +18:57:24.693307 IP 192.0.2.42.80 > 192.0.2.43.48757: +.br + Flags [S.], seq 360414582, ack 788841994, win 14480, +.br + options [mss 1460,sackOK, +.br + TS val 1409056151 ecr 9690221, +.br + nop,wscale 9], +.br + length 0 +.PP +Switch tcp_loose mode off, so conntrack will mark out\-of\-flow +packets as state INVALID. +.IP +echo 0 > /proc/sys/net/netfilter/nf_conntrack_tcp_loose +.PP +Make SYN packets untracked +.IP +iptables \-t raw \-A PREROUTING \-i eth0 \-p tcp \-\-dport 80 + \-\-syn \-j CT \-\-notrack +.PP +Catch UNTRACKED (SYN packets) and INVALID (3WHS ACK packets) states +and send them to SYNPROXY. This rule will respond to SYN packets with +SYN+ACK syncookies, create ESTABLISHED for valid client response (3WHS ACK +packets) and drop incorrect cookies. Flags combinations not expected +during 3WHS will not match and continue (e.g. SYN+FIN, SYN+ACK). +.IP +iptables \-A INPUT \-i eth0 \-p tcp \-\-dport 80 + \-m state \-\-state UNTRACKED,INVALID \-j SYNPROXY + \-\-sack\-perm \-\-timestamp \-\-mss 1460 \-\-wscale 9 +.PP +Drop invalid packets, this will be out\-of\-flow packets that were not +matched by SYNPROXY. +.IP +iptables \-A INPUT \-i eth0 \-p tcp \-\-dport 80 \-m state \-\-state INVALID \-j DROP +.SS TCPMSS +This target alters the MSS value of TCP SYN packets, to control +the maximum size for that connection (usually limiting it to your +outgoing interface's MTU minus 40 for IPv4 or 60 for IPv6, respectively). +Of course, it can only be used +in conjunction with +\fB\-p tcp\fP. +.PP +This target is used to overcome criminally braindead ISPs or servers +which block "ICMP Fragmentation Needed" or "ICMPv6 Packet Too Big" +packets. The symptoms of this +problem are that everything works fine from your Linux +firewall/router, but machines behind it can never exchange large +packets: +.IP 1. 4 +Web browsers connect, then hang with no data received. +.IP 2. 4 +Small mail works fine, but large emails hang. +.IP 3. 4 +ssh works fine, but scp hangs after initial handshaking. +.PP +Workaround: activate this option and add a rule to your firewall +configuration like: +.IP + iptables \-t mangle \-A FORWARD \-p tcp \-\-tcp\-flags SYN,RST SYN + \-j TCPMSS \-\-clamp\-mss\-to\-pmtu +.TP +\fB\-\-set\-mss\fP \fIvalue\fP +Explicitly sets MSS option to specified value. If the MSS of the packet is +already lower than \fIvalue\fP, it will \fBnot\fP be increased (from Linux +2.6.25 onwards) to avoid more problems with hosts relying on a proper MSS. +.TP +\fB\-\-clamp\-mss\-to\-pmtu\fP +Automatically clamp MSS value to (path_MTU \- 40 for IPv4; \-60 for IPv6). +This may not function as desired where asymmetric routes with differing +path MTU exist \(em the kernel uses the path MTU which it would use to send +packets from itself to the source and destination IP addresses. Prior to +Linux 2.6.25, only the path MTU to the destination IP address was +considered by this option; subsequent kernels also consider the path MTU +to the source IP address. +.PP +These options are mutually exclusive. +.SS TCPOPTSTRIP +This target will strip TCP options off a TCP packet. (It will actually replace +them by NO-OPs.) As such, you will need to add the \fB\-p tcp\fP parameters. +.TP +\fB\-\-strip\-options\fP \fIoption\fP[\fB,\fP\fIoption\fP...] +Strip the given option(s). The options may be specified by TCP option number or +by symbolic name. The list of recognized options can be obtained by calling +iptables with \fB\-j TCPOPTSTRIP \-h\fP. +.SS TEE +The \fBTEE\fP target will clone a packet and redirect this clone to another +machine on the \fBlocal\fP network segment. In other words, the nexthop +must be the target, or you will have to configure the nexthop to forward it +further if so desired. +.TP +\fB\-\-gateway\fP \fIipaddr\fP +Send the cloned packet to the host reachable at the given IP address. +Use of 0.0.0.0 (for IPv4 packets) or :: (IPv6) is invalid. +.PP +To forward all incoming traffic on eth0 to an Network Layer logging box: +.PP +\-t mangle \-A PREROUTING \-i eth0 \-j TEE \-\-gateway 2001:db8::1 +.SS TOS +This module sets the Type of Service field in the IPv4 header (including the +"precedence" bits) or the Priority field in the IPv6 header. Note that TOS +shares the same bits as DSCP and ECN. The TOS target is only valid in the +\fBmangle\fP table. +.TP +\fB\-\-set\-tos\fP \fIvalue\fP[\fB/\fP\fImask\fP] +Zeroes out the bits given by \fImask\fP (see NOTE below) and XORs \fIvalue\fP +into the TOS/Priority field. If \fImask\fP is omitted, 0xFF is assumed. +.TP +\fB\-\-set\-tos\fP \fIsymbol\fP +You can specify a symbolic name when using the TOS target for IPv4. It implies +a mask of 0xFF (see NOTE below). The list of recognized TOS names can be +obtained by calling iptables with \fB\-j TOS \-h\fP. +.PP +The following mnemonics are available: +.TP +\fB\-\-and\-tos\fP \fIbits\fP +Binary AND the TOS value with \fIbits\fP. (Mnemonic for \fB\-\-set\-tos +0/\fP\fIinvbits\fP, where \fIinvbits\fP is the binary negation of \fIbits\fP. +See NOTE below.) +.TP +\fB\-\-or\-tos\fP \fIbits\fP +Binary OR the TOS value with \fIbits\fP. (Mnemonic for \fB\-\-set\-tos\fP +\fIbits\fP\fB/\fP\fIbits\fP. See NOTE below.) +.TP +\fB\-\-xor\-tos\fP \fIbits\fP +Binary XOR the TOS value with \fIbits\fP. (Mnemonic for \fB\-\-set\-tos\fP +\fIbits\fP\fB/0\fP. See NOTE below.) +.PP +NOTE: In Linux kernels up to and including 2.6.38, with the exception of +longterm releases 2.6.32 (>=.42), 2.6.33 (>=.15), and 2.6.35 (>=.14), there is +a bug whereby IPv6 TOS mangling does not behave as documented and differs from +the IPv4 version. The TOS mask indicates the bits one wants to zero out, so it +needs to be inverted before applying it to the original TOS field. However, the +aformentioned kernels forgo the inversion which breaks \-\-set\-tos and its +mnemonics. +.SS TPROXY +This target is only valid in the \fBmangle\fP table, in the \fBPREROUTING\fP +chain and user-defined chains which are only called from this chain. It +redirects the packet to a local socket without changing the packet header in +any way. It can also change the mark value which can then be used in advanced +routing rules. +It takes three options: +.TP +\fB\-\-on\-port\fP \fIport\fP +This specifies a destination port to use. It is a required option, 0 means the +new destination port is the same as the original. This is only valid if the +rule also specifies \fB\-p tcp\fP or \fB\-p udp\fP. +.TP +\fB\-\-on\-ip\fP \fIaddress\fP +This specifies a destination address to use. By default the address is the IP +address of the incoming interface. This is only valid if the rule also +specifies \fB\-p tcp\fP or \fB\-p udp\fP. +.TP +\fB\-\-tproxy\-mark\fP \fIvalue\fP[\fB/\fP\fImask\fP] +Marks packets with the given value/mask. The fwmark value set here can be used +by advanced routing. (Required for transparent proxying to work: otherwise +these packets will get forwarded, which is probably not what you want.) +.SS TRACE +This target marks packets so that the kernel will log every rule which match +the packets as those traverse the tables, chains, rules. It can only be used in +the +.BR raw +table. +.PP +With iptables-legacy, a logging backend, such as ip(6)t_LOG or nfnetlink_log, +must be loaded for this to be visible. +The packets are logged with the string prefix: +"TRACE: tablename:chainname:type:rulenum " where type can be "rule" for +plain rule, "return" for implicit rule at the end of a user defined chain +and "policy" for the policy of the built in chains. +.PP +With iptables-nft, the target is translated into nftables' +.B "meta nftrace" +expression. Hence the kernel sends trace events via netlink to userspace where +they may be displayed using +.B "xtables-monitor --trace" +command. For details, refer to +.BR xtables-monitor (8). +.SS TTL (IPv4-specific) +This is used to modify the IPv4 TTL header field. The TTL field determines +how many hops (routers) a packet can traverse until it's time to live is +exceeded. +.PP +Setting or incrementing the TTL field can potentially be very dangerous, +so it should be avoided at any cost. This target is only valid in +.B mangle +table. +.PP +.B Don't ever set or increment the value on packets that leave your local network! +.TP +\fB\-\-ttl\-set\fP \fIvalue\fP +Set the TTL value to `value'. +.TP +\fB\-\-ttl\-dec\fP \fIvalue\fP +Decrement the TTL value `value' times. +.TP +\fB\-\-ttl\-inc\fP \fIvalue\fP +Increment the TTL value `value' times. +.SS ULOG (IPv4-specific) +This is the deprecated ipv4-only predecessor of the NFLOG target. +It provides userspace logging of matching packets. When this +target is set for a rule, the Linux kernel will multicast this packet +through a +.IR netlink +socket. One or more userspace processes may then subscribe to various +multicast groups and receive the packets. +Like LOG, this is a "non-terminating target", i.e. rule traversal +continues at the next rule. +.TP +\fB\-\-ulog\-nlgroup\fP \fInlgroup\fP +This specifies the netlink group (1-32) to which the packet is sent. +Default value is 1. +.TP +\fB\-\-ulog\-prefix\fP \fIprefix\fP +Prefix log messages with the specified prefix; up to 32 characters +long, and useful for distinguishing messages in the logs. +.TP +\fB\-\-ulog\-cprange\fP \fIsize\fP +Number of bytes to be copied to userspace. A value of 0 always copies +the entire packet, regardless of its size. Default is 0. +.TP +\fB\-\-ulog\-qthreshold\fP \fIsize\fP +Number of packet to queue inside kernel. Setting this value to, e.g. 10 +accumulates ten packets inside the kernel and transmits them as one +netlink multipart message to userspace. Default is 1 (for backwards +compatibility). +.br diff --git a/upstream/opensuse-leap-15-6/man8/iptables-restore.8 b/upstream/opensuse-leap-15-6/man8/iptables-restore.8 new file mode 100644 index 00000000..e4d1bb9e --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/iptables-restore.8 @@ -0,0 +1,94 @@ +.TH IPTABLES-RESTORE 8 "" "iptables 1.8.7" "iptables 1.8.7" +.\" +.\" Man page written by Harald Welte <laforge@gnumonks.org> +.\" It is based on the iptables man page. +.\" +.\" This program is free software; you can redistribute it and/or modify +.\" it under the terms of the GNU General Public License as published by +.\" the Free Software Foundation; either version 2 of the License, or +.\" (at your option) any later version. +.\" +.\" This program is distributed in the hope that it will be useful, +.\" but WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.\" GNU General Public License for more details. +.\" +.\" You should have received a copy of the GNU General Public License +.\" along with this program; if not, write to the Free Software +.\" Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. +.\" +.\" +.SH NAME +iptables-restore \(em Restore IP Tables +.P +ip6tables-restore \(em Restore IPv6 Tables +.SH SYNOPSIS +\fBiptables\-restore\fP [\fB\-chntvV\fP] [\fB\-w\fP \fIsecs\fP] +[\fB\-W\fP \fIusecs\fP] [\fB\-M\fP \fImodprobe\fP] [\fB\-T\fP \fIname\fP] +[\fBfile\fP] +.P +\fBip6tables\-restore\fP [\fB\-chntvV\fP] [\fB\-w\fP \fIsecs\fP] +[\fB\-W\fP \fIusecs\fP] [\fB\-M\fP \fImodprobe\fP] [\fB\-T\fP \fIname\fP] +[\fBfile\fP] +.SH DESCRIPTION +.PP +.B iptables-restore +and +.B ip6tables-restore +are used to restore IP and IPv6 Tables from data specified on STDIN or in +\fIfile\fP. Use I/O redirection provided by your shell to read from a file or +specify \fIfile\fP as an argument. +.TP +\fB\-c\fR, \fB\-\-counters\fR +restore the values of all packet and byte counters +.TP +\fB\-h\fP, \fB\-\-help\fP +Print a short option summary. +.TP +\fB\-n\fR, \fB\-\-noflush\fR +don't flush the previous contents of the table. If not specified, +both commands flush (delete) all previous contents of the respective table. +.TP +\fB\-t\fP, \fB\-\-test\fP +Only parse and construct the ruleset, but do not commit it. +.TP +\fB\-v\fP, \fB\-\-verbose\fP +Print additional debug info during ruleset processing. +.TP +\fB\-V\fP, \fB\-\-version\fP +Print the program version number. +.TP +\fB\-w\fP, \fB\-\-wait\fP [\fIseconds\fP] +Wait for the xtables lock. +To prevent multiple instances of the program from running concurrently, +an attempt will be made to obtain an exclusive lock at launch. By default, +the program will exit if the lock cannot be obtained. This option will +make the program wait (indefinitely or for optional \fIseconds\fP) until +the exclusive lock can be obtained. +.TP +\fB\-W\fP, \fB\-\-wait-interval\fP \fImicroseconds\fP +Interval to wait per each iteration. +When running latency sensitive applications, waiting for the xtables lock +for extended durations may not be acceptable. This option will make each +iteration take the amount of time specified. The default interval is +1 second. This option only works with \fB\-w\fP. +.TP +\fB\-M\fP, \fB\-\-modprobe\fP \fImodprobe_program\fP +Specify the path to the modprobe program. By default, iptables-restore will +inspect /proc/sys/kernel/modprobe to determine the executable's path. +.TP +\fB\-T\fP, \fB\-\-table\fP \fIname\fP +Restore only the named table even if the input stream contains other ones. +.SH BUGS +None known as of iptables-1.2.1 release +.SH AUTHORS +Harald Welte <laforge@gnumonks.org> wrote iptables-restore based on code +from Rusty Russell. +.br +Andras Kis-Szabo <kisza@sch.bme.hu> contributed ip6tables-restore. +.SH SEE ALSO +\fBiptables\-apply\fP(8),\fBiptables\-save\fP(8), \fBiptables\fP(8) +.PP +The iptables-HOWTO, which details more iptables usage, the NAT-HOWTO, +which details NAT, and the netfilter-hacking-HOWTO which details the +internals. diff --git a/upstream/opensuse-leap-15-6/man8/iptables-save.8 b/upstream/opensuse-leap-15-6/man8/iptables-save.8 new file mode 100644 index 00000000..403f232d --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/iptables-save.8 @@ -0,0 +1,69 @@ +.TH IPTABLES-SAVE 8 "" "iptables 1.8.7" "iptables 1.8.7" +.\" +.\" Man page written by Harald Welte <laforge@gnumonks.org> +.\" It is based on the iptables man page. +.\" +.\" This program is free software; you can redistribute it and/or modify +.\" it under the terms of the GNU General Public License as published by +.\" the Free Software Foundation; either version 2 of the License, or +.\" (at your option) any later version. +.\" +.\" This program is distributed in the hope that it will be useful, +.\" but WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.\" GNU General Public License for more details. +.\" +.\" You should have received a copy of the GNU General Public License +.\" along with this program; if not, write to the Free Software +.\" Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. +.\" +.\" +.SH NAME +iptables-save \(em dump iptables rules +.P +ip6tables-save \(em dump iptables rules +.SH SYNOPSIS +\fBiptables\-save\fP [\fB\-M\fP \fImodprobe\fP] [\fB\-c\fP] +[\fB\-t\fP \fItable\fP] [\fB\-f\fP \fIfilename\fP] +.P +\fBip6tables\-save\fP [\fB\-M\fP \fImodprobe\fP] [\fB\-c\fP] +[\fB\-t\fP \fItable\fP] [\fB\-f\fP \fIfilename\fP] +.SH DESCRIPTION +.PP +.B iptables-save +and +.B ip6tables-save +are used to dump the contents of IP or IPv6 Table in easily parseable format +either to STDOUT or to a specified file. +.TP +\fB\-M\fR, \fB\-\-modprobe\fR \fImodprobe_program\fP +Specify the path to the modprobe program. By default, iptables-save will +inspect /proc/sys/kernel/modprobe to determine the executable's path. +.TP +\fB\-f\fR, \fB\-\-file\fR \fIfilename\fP +Specify a filename to log the output to. If not specified, iptables-save +will log to STDOUT. +.TP +\fB\-c\fR, \fB\-\-counters\fR +include the current values of all packet and byte counters in the output +.TP +\fB\-t\fR, \fB\-\-table\fR \fItablename\fP +restrict output to only one table. If the kernel is configured with automatic +module loading, an attempt will be made to load the appropriate module for +that table if it is not already there. +.br +If not specified, output includes all available tables. +.SH BUGS +None known as of iptables-1.2.1 release +.SH AUTHORS +Harald Welte <laforge@gnumonks.org> +.br +Rusty Russell <rusty@rustcorp.com.au> +.br +Andras Kis-Szabo <kisza@sch.bme.hu> contributed ip6tables-save. +.SH SEE ALSO +\fBiptables\-apply\fP(8),\fBiptables\-restore\fP(8), \fBiptables\fP(8) +.PP +The iptables-HOWTO, which details more iptables usage, the NAT-HOWTO, +which details NAT, and the netfilter-hacking-HOWTO which details the +internals. diff --git a/upstream/opensuse-leap-15-6/man8/iptables.8 b/upstream/opensuse-leap-15-6/man8/iptables.8 new file mode 100644 index 00000000..73027065 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/iptables.8 @@ -0,0 +1,486 @@ +.TH IPTABLES 8 "" "iptables 1.8.7" "iptables 1.8.7" +.\" +.\" Man page written by Herve Eychenne <rv@wallfire.org> (May 1999) +.\" It is based on ipchains page. +.\" TODO: add a word for protocol helpers (FTP, IRC, SNMP-ALG) +.\" +.\" ipchains page by Paul ``Rusty'' Russell March 1997 +.\" Based on the original ipfwadm man page by Jos Vos <jos@xos.nl> +.\" +.\" This program is free software; you can redistribute it and/or modify +.\" it under the terms of the GNU General Public License as published by +.\" the Free Software Foundation; either version 2 of the License, or +.\" (at your option) any later version. +.\" +.\" This program is distributed in the hope that it will be useful, +.\" but WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.\" GNU General Public License for more details. +.\" +.\" You should have received a copy of the GNU General Public License +.\" along with this program; if not, write to the Free Software +.\" Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. +.\" +.\" +.SH NAME +iptables/ip6tables \(em administration tool for IPv4/IPv6 packet filtering and NAT +.SH SYNOPSIS +\fBiptables\fP [\fB\-t\fP \fItable\fP] {\fB\-A\fP|\fB\-C\fP|\fB\-D\fP} +\fIchain\fP \fIrule-specification\fP +.P +\fBip6tables\fP [\fB\-t\fP \fItable\fP] {\fB\-A\fP|\fB\-C\fP|\fB\-D\fP} +\fIchain rule-specification\fP +.PP +\fBiptables\fP [\fB\-t\fP \fItable\fP] \fB\-I\fP \fIchain\fP [\fIrulenum\fP] \fIrule-specification\fP +.PP +\fBiptables\fP [\fB\-t\fP \fItable\fP] \fB\-R\fP \fIchain rulenum rule-specification\fP +.PP +\fBiptables\fP [\fB\-t\fP \fItable\fP] \fB\-D\fP \fIchain rulenum\fP +.PP +\fBiptables\fP [\fB\-t\fP \fItable\fP] \fB\-S\fP [\fIchain\fP [\fIrulenum\fP]] +.PP +\fBiptables\fP [\fB\-t\fP \fItable\fP] {\fB\-F\fP|\fB\-L\fP|\fB\-Z\fP} [\fIchain\fP [\fIrulenum\fP]] [\fIoptions...\fP] +.PP +\fBiptables\fP [\fB\-t\fP \fItable\fP] \fB\-N\fP \fIchain\fP +.PP +\fBiptables\fP [\fB\-t\fP \fItable\fP] \fB\-X\fP [\fIchain\fP] +.PP +\fBiptables\fP [\fB\-t\fP \fItable\fP] \fB\-P\fP \fIchain target\fP +.PP +\fBiptables\fP [\fB\-t\fP \fItable\fP] \fB\-E\fP \fIold-chain-name new-chain-name\fP +.PP +rule-specification = [\fImatches...\fP] [\fItarget\fP] +.PP +match = \fB\-m\fP \fImatchname\fP [\fIper-match-options\fP] +.PP +target = \fB\-j\fP \fItargetname\fP [\fIper\-target\-options\fP] +.SH DESCRIPTION +\fBIptables\fP and \fBip6tables\fP are used to set up, maintain, and inspect the +tables of IPv4 and IPv6 packet +filter rules in the Linux kernel. Several different tables +may be defined. Each table contains a number of built-in +chains and may also contain user-defined chains. +.PP +Each chain is a list of rules which can match a set of packets. Each +rule specifies what to do with a packet that matches. This is called +a `target', which may be a jump to a user-defined chain in the same +table. +.SH TARGETS +A firewall rule specifies criteria for a packet and a target. If the +packet does not match, the next rule in the chain is examined; if +it does match, then the next rule is specified by the value of the +target, which can be the name of a user-defined chain, one of the targets +described in \fBiptables\-extensions\fP(8), or one of the +special values \fBACCEPT\fP, \fBDROP\fP or \fBRETURN\fP. +.PP +\fBACCEPT\fP means to let the packet through. +\fBDROP\fP means to drop the packet on the floor. +\fBRETURN\fP means stop traversing this chain and resume at the next +rule in the +previous (calling) chain. If the end of a built-in chain is reached +or a rule in a built-in chain with target \fBRETURN\fP +is matched, the target specified by the chain policy determines the +fate of the packet. +.SH TABLES +There are currently five independent tables (which tables are present +at any time depends on the kernel configuration options and which +modules are present). +.TP +\fB\-t\fP, \fB\-\-table\fP \fItable\fP +This option specifies the packet matching table which the command +should operate on. If the kernel is configured with automatic module +loading, an attempt will be made to load the appropriate module for +that table if it is not already there. + +The tables are as follows: +.RS +.TP .4i +\fBfilter\fP: +This is the default table (if no \-t option is passed). It contains +the built-in chains \fBINPUT\fP (for packets destined to local sockets), +\fBFORWARD\fP (for packets being routed through the box), and +\fBOUTPUT\fP (for locally-generated packets). +.TP +\fBnat\fP: +This table is consulted when a packet that creates a new +connection is encountered. It consists of four built-ins: \fBPREROUTING\fP +(for altering packets as soon as they come in), \fBINPUT\fP (for altering +packets destined for local sockets), \fBOUTPUT\fP +(for altering locally-generated packets before routing), and \fBPOSTROUTING\fP +(for altering packets as they are about to go out). +IPv6 NAT support is available since kernel 3.7. +.TP +\fBmangle\fP: +This table is used for specialized packet alteration. Until kernel +2.4.17 it had two built-in chains: \fBPREROUTING\fP +(for altering incoming packets before routing) and \fBOUTPUT\fP +(for altering locally-generated packets before routing). +Since kernel 2.4.18, three other built-in chains are also supported: +\fBINPUT\fP (for packets coming into the box itself), \fBFORWARD\fP +(for altering packets being routed through the box), and \fBPOSTROUTING\fP +(for altering packets as they are about to go out). +.TP +\fBraw\fP: +This table is used mainly for configuring exemptions from connection +tracking in combination with the NOTRACK target. It registers at the netfilter +hooks with higher priority and is thus called before ip_conntrack, or any other +IP tables. It provides the following built-in chains: \fBPREROUTING\fP +(for packets arriving via any network interface) \fBOUTPUT\fP +(for packets generated by local processes) +.TP +\fBsecurity\fP: +This table is used for Mandatory Access Control (MAC) networking rules, such +as those enabled by the \fBSECMARK\fP and \fBCONNSECMARK\fP targets. +Mandatory Access Control is implemented by Linux Security Modules such as +SELinux. The security table is called after the filter table, allowing any +Discretionary Access Control (DAC) rules in the filter table to take effect +before MAC rules. This table provides the following built-in chains: +\fBINPUT\fP (for packets coming into the box itself), +\fBOUTPUT\fP (for altering locally-generated packets before routing), and +\fBFORWARD\fP (for altering packets being routed through the box). +.RE +.SH OPTIONS +The options that are recognized by +\fBiptables\fP and \fBip6tables\fP can be divided into several different groups. +.SS COMMANDS +These options specify the desired action to perform. Only one of them +can be specified on the command line unless otherwise stated +below. For long versions of the command and option names, you +need to use only enough letters to ensure that +\fBiptables\fP can differentiate it from all other options. +.TP +\fB\-A\fP, \fB\-\-append\fP \fIchain rule-specification\fP +Append one or more rules to the end of the selected chain. +When the source and/or destination names resolve to more than one +address, a rule will be added for each possible address combination. +.TP +\fB\-C\fP, \fB\-\-check\fP \fIchain rule-specification\fP +Check whether a rule matching the specification does exist in the +selected chain. This command uses the same logic as \fB\-D\fP to +find a matching entry, but does not alter the existing iptables +configuration and uses its exit code to indicate success or failure. +.TP +\fB\-D\fP, \fB\-\-delete\fP \fIchain rule-specification\fP +.ns +.TP +\fB\-D\fP, \fB\-\-delete\fP \fIchain rulenum\fP +Delete one or more rules from the selected chain. There are two +versions of this command: the rule can be specified as a number in the +chain (starting at 1 for the first rule) or a rule to match. +.TP +\fB\-I\fP, \fB\-\-insert\fP \fIchain\fP [\fIrulenum\fP] \fIrule-specification\fP +Insert one or more rules in the selected chain as the given rule +number. So, if the rule number is 1, the rule or rules are inserted +at the head of the chain. This is also the default if no rule number +is specified. +.TP +\fB\-R\fP, \fB\-\-replace\fP \fIchain rulenum rule-specification\fP +Replace a rule in the selected chain. If the source and/or +destination names resolve to multiple addresses, the command will +fail. Rules are numbered starting at 1. +.TP +\fB\-L\fP, \fB\-\-list\fP [\fIchain\fP] +List all rules in the selected chain. If no chain is selected, all +chains are listed. Like every other iptables command, it applies to the +specified table (filter is the default), so NAT rules get listed by +.nf + iptables \-t nat \-n \-L +.fi +Please note that it is often used with the \fB\-n\fP +option, in order to avoid long reverse DNS lookups. +It is legal to specify the \fB\-Z\fP +(zero) option as well, in which case the chain(s) will be atomically +listed and zeroed. The exact output is affected by the other +arguments given. The exact rules are suppressed until you use +.nf + iptables \-L \-v +.fi +or +\fBiptables\-save\fP(8). +.TP +\fB\-S\fP, \fB\-\-list\-rules\fP [\fIchain\fP] +Print all rules in the selected chain. If no chain is selected, all +chains are printed like iptables-save. Like every other iptables command, +it applies to the specified table (filter is the default). +.TP +\fB\-F\fP, \fB\-\-flush\fP [\fIchain\fP] +Flush the selected chain (all the chains in the table if none is given). +This is equivalent to deleting all the rules one by one. +.TP +\fB\-Z\fP, \fB\-\-zero\fP [\fIchain\fP [\fIrulenum\fP]] +Zero the packet and byte counters in all chains, or only the given chain, +or only the given rule in a chain. It is legal to +specify the +\fB\-L\fP, \fB\-\-list\fP +(list) option as well, to see the counters immediately before they are +cleared. (See above.) +.TP +\fB\-N\fP, \fB\-\-new\-chain\fP \fIchain\fP +Create a new user-defined chain by the given name. There must be no +target of that name already. +.TP +\fB\-X\fP, \fB\-\-delete\-chain\fP [\fIchain\fP] +Delete the optional user-defined chain specified. There must be no references +to the chain. If there are, you must delete or replace the referring rules +before the chain can be deleted. The chain must be empty, i.e. not contain +any rules. If no argument is given, it will attempt to delete every +non-builtin chain in the table. +.TP +\fB\-P\fP, \fB\-\-policy\fP \fIchain target\fP +Set the policy for the built-in (non-user-defined) chain to the given target. +The policy target must be either \fBACCEPT\fP or \fBDROP\fP. +.TP +\fB\-E\fP, \fB\-\-rename\-chain\fP \fIold\-chain new\-chain\fP +Rename the user specified chain to the user supplied name. This is +cosmetic, and has no effect on the structure of the table. +.TP +\fB\-h\fP +Help. +Give a (currently very brief) description of the command syntax. +.SS PARAMETERS +The following parameters make up a rule specification (as used in the +add, delete, insert, replace and append commands). +.TP +\fB\-4\fP, \fB\-\-ipv4\fP +This option has no effect in iptables and iptables-restore. +If a rule using the \fB\-4\fP option is inserted with (and only with) +ip6tables-restore, it will be silently ignored. Any other uses will throw an +error. This option allows IPv4 and IPv6 rules in a single rule file +for use with both iptables-restore and ip6tables-restore. +.TP +\fB\-6\fP, \fB\-\-ipv6\fP +If a rule using the \fB\-6\fP option is inserted with (and only with) +iptables-restore, it will be silently ignored. Any other uses will throw an +error. This option allows IPv4 and IPv6 rules in a single rule file +for use with both iptables-restore and ip6tables-restore. +This option has no effect in ip6tables and ip6tables-restore. +.TP +[\fB!\fP] \fB\-p\fP, \fB\-\-protocol\fP \fIprotocol\fP +The protocol of the rule or of the packet to check. +The specified protocol can be one of \fBtcp\fP, \fBudp\fP, \fBudplite\fP, +\fBicmp\fP, \fBicmpv6\fP,\fBesp\fP, \fBah\fP, \fBsctp\fP, \fBmh\fP or the special keyword "\fBall\fP", +or it can be a numeric value, representing one of these protocols or a +different one. A protocol name from /etc/protocols is also allowed. +A "!" argument before the protocol inverts the +test. The number zero is equivalent to \fBall\fP. "\fBall\fP" +will match with all protocols and is taken as default when this +option is omitted. +Note that, in ip6tables, IPv6 extension headers except \fBesp\fP are not allowed. +\fBesp\fP and \fBipv6\-nonext\fP +can be used with Kernel version 2.6.11 or later. +The number zero is equivalent to \fBall\fP, which means that you cannot +test the protocol field for the value 0 directly. To match on a HBH header, +even if it were the last, you cannot use \fB\-p 0\fP, but always need +\fB\-m hbh\fP. +.TP +[\fB!\fP] \fB\-s\fP, \fB\-\-source\fP \fIaddress\fP[\fB/\fP\fImask\fP][\fB,\fP\fI...\fP] +Source specification. \fIAddress\fP +can be either a network name, a hostname, a network IP address (with +\fB/\fP\fImask\fP), or a plain IP address. Hostnames will +be resolved once only, before the rule is submitted to the kernel. +Please note that specifying any name to be resolved with a remote query such as +DNS is a really bad idea. +The \fImask\fP +can be either an ipv4 network mask (for iptables) or a plain number, +specifying the number of 1's at the left side of the network mask. +Thus, an iptables mask of \fI24\fP is equivalent to \fI255.255.255.0\fP. +A "!" argument before the address specification inverts the sense of +the address. The flag \fB\-\-src\fP is an alias for this option. +Multiple addresses can be specified, but this will \fBexpand to multiple +rules\fP (when adding with \-A), or will cause multiple rules to be +deleted (with \-D). +.TP +[\fB!\fP] \fB\-d\fP, \fB\-\-destination\fP \fIaddress\fP[\fB/\fP\fImask\fP][\fB,\fP\fI...\fP] +Destination specification. +See the description of the \fB\-s\fP +(source) flag for a detailed description of the syntax. The flag +\fB\-\-dst\fP is an alias for this option. +.TP +\fB\-m\fP, \fB\-\-match\fP \fImatch\fP +Specifies a match to use, that is, an extension module that tests for a +specific property. The set of matches make up the condition under which a +target is invoked. Matches are evaluated first to last as specified on the +command line and work in short-circuit fashion, i.e. if one extension yields +false, evaluation will stop. +.TP +\fB\-j\fP, \fB\-\-jump\fP \fItarget\fP +This specifies the target of the rule; i.e., what to do if the packet +matches it. The target can be a user-defined chain (other than the +one this rule is in), one of the special builtin targets which decide +the fate of the packet immediately, or an extension (see \fBEXTENSIONS\fP +below). If this +option is omitted in a rule (and \fB\-g\fP +is not used), then matching the rule will have no +effect on the packet's fate, but the counters on the rule will be +incremented. +.TP +\fB\-g\fP, \fB\-\-goto\fP \fIchain\fP +This specifies that the processing should continue in a user +specified chain. Unlike the \-\-jump option return will not continue +processing in this chain but instead in the chain that called us via +\-\-jump. +.TP +[\fB!\fP] \fB\-i\fP, \fB\-\-in\-interface\fP \fIname\fP +Name of an interface via which a packet was received (only for +packets entering the \fBINPUT\fP, \fBFORWARD\fP and \fBPREROUTING\fP +chains). When the "!" argument is used before the interface name, the +sense is inverted. If the interface name ends in a "+", then any +interface which begins with this name will match. If this option is +omitted, any interface name will match. +.TP +[\fB!\fP] \fB\-o\fP, \fB\-\-out\-interface\fP \fIname\fP +Name of an interface via which a packet is going to be sent (for packets +entering the \fBFORWARD\fP, \fBOUTPUT\fP and \fBPOSTROUTING\fP +chains). When the "!" argument is used before the interface name, the +sense is inverted. If the interface name ends in a "+", then any +interface which begins with this name will match. If this option is +omitted, any interface name will match. +.TP +[\fB!\fP] \fB\-f\fP, \fB\-\-fragment\fP +This means that the rule only refers to second and further IPv4 fragments +of fragmented packets. Since there is no way to tell the source or +destination ports of such a packet (or ICMP type), such a packet will +not match any rules which specify them. When the "!" argument +precedes the "\-f" flag, the rule will only match head fragments, or +unfragmented packets. This option is IPv4 specific, it is not available +in ip6tables. +.TP +\fB\-c\fP, \fB\-\-set\-counters\fP \fIpackets bytes\fP +This enables the administrator to initialize the packet and byte +counters of a rule (during \fBINSERT\fP, \fBAPPEND\fP, \fBREPLACE\fP +operations). +.SS "OTHER OPTIONS" +The following additional options can be specified: +.TP +\fB\-v\fP, \fB\-\-verbose\fP +Verbose output. This option makes the list command show the interface +name, the rule options (if any), and the TOS masks. The packet and +byte counters are also listed, with the suffix 'K', 'M' or 'G' for +1000, 1,000,000 and 1,000,000,000 multipliers respectively (but see +the \fB\-x\fP flag to change this). +For appending, insertion, deletion and replacement, this causes +detailed information on the rule or rules to be printed. \fB\-v\fP may be +specified multiple times to possibly emit more detailed debug statements. +.TP +\fB\-w\fP, \fB\-\-wait\fP [\fIseconds\fP] +Wait for the xtables lock. +To prevent multiple instances of the program from running concurrently, +an attempt will be made to obtain an exclusive lock at launch. By default, +the program will exit if the lock cannot be obtained. This option will +make the program wait (indefinitely or for optional \fIseconds\fP) until +the exclusive lock can be obtained. +.TP +\fB\-W\fP, \fB\-\-wait-interval\fP \fImicroseconds\fP +Interval to wait per each iteration. +When running latency sensitive applications, waiting for the xtables lock +for extended durations may not be acceptable. This option will make each +iteration take the amount of time specified. The default interval is +1 second. This option only works with \fB\-w\fP. +.TP +\fB\-n\fP, \fB\-\-numeric\fP +Numeric output. +IP addresses and port numbers will be printed in numeric format. +By default, the program will try to display them as host names, +network names, or services (whenever applicable). +.TP +\fB\-x\fP, \fB\-\-exact\fP +Expand numbers. +Display the exact value of the packet and byte counters, +instead of only the rounded number in K's (multiples of 1000) +M's (multiples of 1000K) or G's (multiples of 1000M). This option is +only relevant for the \fB\-L\fP command. +.TP +\fB\-\-line\-numbers\fP +When listing rules, add line numbers to the beginning of each rule, +corresponding to that rule's position in the chain. +.TP +\fB\-\-modprobe=\fP\fIcommand\fP +When adding or inserting rules into a chain, use \fIcommand\fP +to load any necessary modules (targets, match extensions, etc). + +.SH LOCK FILE +iptables uses the \fI/run/xtables.lock\fP file to take an exclusive lock at +launch. + +The \fBXTABLES_LOCKFILE\fP environment variable can be used to override +the default setting. + +.SH MATCH AND TARGET EXTENSIONS +.PP +iptables can use extended packet matching and target modules. +A list of these is available in the \fBiptables\-extensions\fP(8) manpage. +.SH DIAGNOSTICS +Various error messages are printed to standard error. The exit code +is 0 for correct functioning. Errors which appear to be caused by +invalid or abused command line parameters cause an exit code of 2, and +other errors cause an exit code of 1. +.SH BUGS +Bugs? What's this? ;-) +Well, you might want to have a look at http://bugzilla.netfilter.org/ +.SH COMPATIBILITY WITH IPCHAINS +This \fBiptables\fP +is very similar to ipchains by Rusty Russell. The main difference is +that the chains \fBINPUT\fP and \fBOUTPUT\fP +are only traversed for packets coming into the local host and +originating from the local host respectively. Hence every packet only +passes through one of the three chains (except loopback traffic, which +involves both INPUT and OUTPUT chains); previously a forwarded packet +would pass through all three. +.PP +The other main difference is that \fB\-i\fP refers to the input interface; +\fB\-o\fP refers to the output interface, and both are available for packets +entering the \fBFORWARD\fP chain. +.PP +The various forms of NAT have been separated out; \fBiptables\fP +is a pure packet filter when using the default `filter' table, with +optional extension modules. This should simplify much of the previous +confusion over the combination of IP masquerading and packet filtering +seen previously. So the following options are handled differently: +.nf + \-j MASQ + \-M \-S + \-M \-L +.fi +There are several other changes in iptables. +.SH SEE ALSO +\fBiptables\-apply\fP(8), +\fBiptables\-save\fP(8), +\fBiptables\-restore\fP(8), +\fBiptables\-extensions\fP(8), +.PP +The packet-filtering-HOWTO details iptables usage for +packet filtering, the NAT-HOWTO details NAT, +the netfilter-extensions-HOWTO details the extensions that are +not in the standard distribution, +and the netfilter-hacking-HOWTO details the netfilter internals. +.br +See +.BR "http://www.netfilter.org/" . +.SH AUTHORS +Rusty Russell originally wrote iptables, in early consultation with Michael +Neuling. +.PP +Marc Boucher made Rusty abandon ipnatctl by lobbying for a generic packet +selection framework in iptables, then wrote the mangle table, the owner match, +the mark stuff, and ran around doing cool stuff everywhere. +.PP +James Morris wrote the TOS target, and tos match. +.PP +Jozsef Kadlecsik wrote the REJECT target. +.PP +Harald Welte wrote the ULOG and NFQUEUE target, the new libiptc, as well as the TTL, DSCP, ECN matches and targets. +.PP +The Netfilter Core Team is: Jozsef Kadlecsik, Pablo Neira Ayuso, +Eric Leblond, Florian Westphal and Arturo Borrero Gonzalez. +Emeritus Core Team members are: Marc +Boucher, Martin Josefsson, Yasuyuki Kozakai, James Morris, Harald Welte and +Rusty Russell. +.PP +Man page originally written by Herve Eychenne <rv@wallfire.org>. +.\" .. and did I mention that we are incredibly cool people? +.\" .. sexy, too .. +.\" .. witty, charming, powerful .. +.\" .. and most of all, modest .. +.SH VERSION +.PP +This manual page applies to iptables/ip6tables 1.8.7. diff --git a/upstream/opensuse-leap-15-6/man8/iptraf-ng.8 b/upstream/opensuse-leap-15-6/man8/iptraf-ng.8 new file mode 100644 index 00000000..ca574fd6 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/iptraf-ng.8 @@ -0,0 +1,98 @@ +.TH IPTRAF-NG 8 "IPTraf-ng Help Page" +.SH NAME +iptraf \- Interactive Colorful IP LAN Monitor +.SH SYNOPSIS +.BR iptraf-ng " { [ " \-f " ] [ { " \-i +.IR iface " | " +.BR \-g " | " \-d +.IR iface " | " +.BR \-s +.IR iface " | " +.BR \-z +.IR iface " | " +.BR \-l +.IR iface " } [ " +.BR \-t +.IR timeout " ] [ " +.BR \-B " [ " +.BR \-L +.IR logfile " ] ] ] | [ " +.BR \-h " ] }" +.br +.SH DESCRIPTION +.B iptraf-ng +is an ncurses-based IP LAN monitor that generates various network statistics including TCP info, UDP counts, ICMP and OSPF information, Ethernet load info, node stats, IP checksum errors, and others. +.PP +If the +.B iptraf-ng +command is issued without any command-line options, the program comes up in interactive mode, with the various facilities accessed through the main menu. + +.SH OPTIONS +These options can also be supplied to the command: +.TP +.BI "\-i " iface +immediately start the IP traffic monitor on the specified interface, or +all interfaces if "\-i all" is specified +.TP +.B "\-g" +immediately start the general interface statistics +.TP +.BI "\-d " iface +allows you to immediately start the detailed on the indicated interface (iface) +.TP +.BI "\-s " iface +allows you to immediately monitor TCP and UDP traffic on the specified interface (iface) +.TP +.BI "\-z " iface +shows packet counts by size on the specified interface +.TP +.BI "\-l " iface +start the LAN station monitor on the specified interface, or all LAN +interfaces if "\-l all" is specified +.TP +.BI "\-t " timeout +tells IPTraf-ng to run the specified facility for only +.I timeout +minutes. This option is used only with one of the above parameters. +.TP +.B "\-B" +redirect standard output to /dev/null, closes standard input, and forks +the program into the background. Can be used only with one of the +facility invocation parameters above. Send the backgrounded process a +USR2 signal to terminate. +.TP +.B "\-L logfile" +allows you to specify an alternate log file name. The default log file +name is based on either the interface selected (detailed interface +statistics, TCP/UDP service statistics, packet size breakdown), or the +instance of the facility (IP traffic monitor, LAN station monitor). If a +path is not specified, the log file is placed in +.B /var/log/iptraf-ng +.TP +.B "\-f" +clears all locks and counters, causing this instance of IPTraf-ng to think +it's the first one running. This should only be used to recover from +an abnormal termination or system crash. +.TP +.B "\-h" +shows a command summary +.SH SIGNALS + + SIGUSR1 - rotates log files while program is running + SIGUSR2 - terminates an IPTraf-ng process running in the background. + +.SH FILES + /var/log/iptraf-ng/*.log - log file + /var/lib/iptraf-ng/* - important IPTraf-ng data files + +.SH SEE ALSO + Documentation/* - complete documentation written by the author + +.SH AUTHOR +Gerard Paul Java (riker@mozcom.com) + +.SH MANUAL AUTHOR +Frederic Peters (fpeters@debian.org), using iptraf-ng \-h +General manual page modifications by Gerard Paul Java (riker@mozcom.com), +Phil Cameron (pcameron@redhat.com) + diff --git a/upstream/opensuse-leap-15-6/man8/isodebug.8 b/upstream/opensuse-leap-15-6/man8/isodebug.8 new file mode 100644 index 00000000..5fa4d79a --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/isodebug.8 @@ -0,0 +1,107 @@ +.\" @(#)isodebug.8 1.6 15/11/02 Copyr 2006-2015 J. Schilling +.\" Manual page for isodebug +.\" +.if t .ds a \v'-0.55m'\h'0.00n'\z.\h'0.40n'\z.\v'0.55m'\h'-0.40n'a +.if t .ds o \v'-0.55m'\h'0.00n'\z.\h'0.45n'\z.\v'0.55m'\h'-0.45n'o +.if t .ds u \v'-0.55m'\h'0.00n'\z.\h'0.40n'\z.\v'0.55m'\h'-0.40n'u +.if t .ds A \v'-0.77m'\h'0.25n'\z.\h'0.45n'\z.\v'0.77m'\h'-0.70n'A +.if t .ds O \v'-0.77m'\h'0.25n'\z.\h'0.45n'\z.\v'0.77m'\h'-0.70n'O +.if t .ds U \v'-0.77m'\h'0.30n'\z.\h'0.45n'\z.\v'0.77m'\h'-0.75n'U +.if t .ds s \\(*b +.if t .ds S SS +.if n .ds a ae +.if n .ds o oe +.if n .ds u ue +.if n .ds s sz +.TH ISODEBUG 1L "Version 3.02 2015/11/02" "J\*org Schilling" "Schily\'s USER COMMANDS" +.SH NAME +isodebug \- print mkisofs debug info from ISO-9660 image +.SH SYNOPSIS +.B +isodebug +[ +.I options +] +[ +.I file +] +.SH DESCRIPTION +.B Isodebug +reads the debug info written by +.BR mkisofs (8) +from within a ISO-9660 file system image and prints them. +. \" .SH RETURNS +. \" .SH ERRORS +.SH OPTIONS +.TP +.B \-help +Prints a short summary of the +.B isodebug +options and exists. +.TP +.B \-version +Prints the +.B isodebug +version number string and exists. +.TP +.BI \-i " filename +Filename to read ISO-9660 image from. +.TP +.BI \-ignore\-error +Ignore errors. +.B isodebug +by default aborts on several errors, such as read errors. With this option in effect, +.B isodebug +tries to continue. +Use with care. +.TP +.BI dev= target +SCSI target to use as CD/DVD-Recorder. +See +.BR cdrecord (1) +for more information on now to use this option. +.SH EXAMPLES +.SH ENVIRONMENT +.SH FILES +.SH "SEE ALSO" +.BR cdrecord (1), +.BR scg (7), +.BR mkisofs (8). +.SH DIAGNOSTICS +.SH NOTES +.SH BUGS +.SH AUTHOR +.nf +J\*org Schilling +Seestr. 110 +D-13353 Berlin +Germany +.fi +.PP +Additional information can be found on: +.br +http://cdrecord.org/private/cdrecord.html +.PP +If you have support questions, send them to: +.PP +.B +cdrtools-support@lists.sourceforge.net + +.PP +If you have definitely found a bug, send a mail to: +.PP +.B +cdrtools-developers@lists.sourceforge.net +.br +or +.B +joerg.schilling@fokus.fraunhofer.de +.PP +To subscribe, use: +.PP +.B +https://lists.sourceforge.net/lists/listinfo/cdrtools-developers +.br +or +.B +https://lists.sourceforge.net/lists/listinfo/cdrtools-support diff --git a/upstream/opensuse-leap-15-6/man8/isoinfo.8 b/upstream/opensuse-leap-15-6/man8/isoinfo.8 new file mode 100644 index 00000000..47180d07 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/isoinfo.8 @@ -0,0 +1,400 @@ +.\" +.\" @(#)isoinfo.8 1.16 15/11/02 joerg +.\" +.\" -*- nroff -*- +.if t .ds a \v'-0.55m'\h'0.00n'\z.\h'0.40n'\z.\v'0.55m'\h'-0.40n'a +.if t .ds o \v'-0.55m'\h'0.00n'\z.\h'0.45n'\z.\v'0.55m'\h'-0.45n'o +.if t .ds u \v'-0.55m'\h'0.00n'\z.\h'0.40n'\z.\v'0.55m'\h'-0.40n'u +.if t .ds A \v'-0.77m'\h'0.25n'\z.\h'0.45n'\z.\v'0.77m'\h'-0.70n'A +.if t .ds O \v'-0.77m'\h'0.25n'\z.\h'0.45n'\z.\v'0.77m'\h'-0.70n'O +.if t .ds U \v'-0.77m'\h'0.30n'\z.\h'0.45n'\z.\v'0.77m'\h'-0.75n'U +.if t .ds s \\(*b +.if t .ds S SS +.if n .ds a ae +.if n .ds o oe +.if n .ds u ue +.if n .ds s sz +.TH ISOINFO 8 "2015/11/02" "Version 3.02" +.SH NAME +devdump, isoinfo, isovfy, isodump \- Utility programs for dumping and verifying iso9660 +images. +.SH SYNOPSIS +.B devdump +.I isoimage +.PP +.B isodump +.I isoimage +.PP +.B isoinfo +[ +.I options +] +[ +.B\-find +[ +.I find expression +]] +.PP +.B isovfy +.I isoimage +.SH DESCRIPTION +.B devdump +is a crude utility to interactively display the contents of device or +filesystem images. +The initial screen is a display of the first 256 bytes of the first 2048 byte +sector. +The commands are the same as with +.BR isodump . +.PP +.B isodump +is a crude utility to interactively display the contents of iso9660 images +in order to verify directory integrity. +The initial screen is a display of the first part of the root directory, +and the prompt shows you the extent number and offset in the extent. +.RS +.PP +You can use the 'a' and 'b' +commands to move backwards and forwards within the image. The 'g' command +allows you to goto an arbitrary extent, and the 'f' command specifies +a search string to be used. The '+' command searches forward for the next +instance of the search string, and the 'q' command exits +.B devdump +or +.BR isodump . +.RE +.PP +.B isoinfo +is a utility to perform directory like listings of iso9660 images. +.PP +.B isovfy +is a utility to verify the integrity of an iso9660 image. Most of the tests +in +.B isovfy +were added after bugs were discovered in early versions of +.B mkisofs. +It isn't all that clear how useful this is anymore, but it doesn't hurt to +have this around. + +.SH OPTIONS +The options common to all programs are +.BR \-help , \-h , \-version , +.BI i =name, dev =name. +The +.B isoinfo +program has additional command line options. The options are: +.TP +.B \-help +.TP +.B \-h +print a summary of all options. +.TP +.B \-d +Print information from the primary volume descriptor (PVD) of the iso9660 +image. This includes information about Rock Ridge, Joliet extensions +and Eltorito boot information +if present. +.TP +.B \-f +generate output as if a 'find . -print' command had been run on the iso9660 +image. You should not use the +.B -l +image with the +.B -f +option. +The same output is created by calling +.I isoinfo +with +.B \-find \-print +.TP +.BI \-find " find expression +This option acts a separator. If it is used, all +.B isoinfo +options must be to the left of the +.B \-find +option. To the right of the +.B \-find +option, mkisofs accepts the find command line syntax only. +If the find expression includes a +.B \-print +or +.B \-ls +promary, the +.B \-l to +.B isoinfo +is ignored. +If the find expression evaluates as true, the selected action (e.g. +list the ISO-9660 directory) is performed. +.TP +.B \-i iso_image +Specifies the path of the iso9660 image that we wish to examine. +The options +.B \-i +and +.BI dev= target +are mutual exclusive. +.TP +.BI \-ignore\-error +Ignore errors. +The commands +by default aborts on several errors, such as read errors. With this option in effect, +the commands try to continue. +Use with care. +.TP +.BI dev= target +Sets the SCSI target for the drive, see notes above. +A typical device specification is +.BI dev= 6,0 +\&. +If a filename must be provided together with the numerical target +specification, the filename is implementation specific. +The correct filename in this case can be found in the system specific +manuals of the target operating system. +On a +.I FreeBSD +system without +.I CAM +support, you need to use the control device (e.g. +.IR /dev/rcd0.ctl ). +A correct device specification in this case may be +.BI dev= /dev/rcd0.ctl:@ +\&. +.sp +On Linux, drives connected to a parallel port adapter are mapped +to a virtual SCSI bus. Different adapters are mapped to different +targets on this virtual SCSI bus. +.sp +If no +.I dev +option is present, the program +will try to get the device from the +.B CDR_DEVICE +environment. +.sp +If the argument to the +.B dev= +option does not contain the characters ',', '/', '@' or ':', +it is interpreted as an label name that may be found in the file +/etc/default/cdrecord (see FILES section). +.sp +The options +.B \-i +and +.BI dev= target +are mutual exclusive. +.TP +.B \-debug +Print additional debug information. This enables e.g. printing +of all directory entries if a file has more than one directory entry +and printing of more information from the primary volume descriptor. +.sp +In debug mode, Rock Ridge information is parsed with +.B \-R +even if it is not standard compliant. +.TP +.B \-l +generate output as if a 'ls -lR' command had been run on the iso9660 image. +You should not use the +.B -f +image with the +.B -l +option. +.sp +The numbers in square brackets are the starting sector number as decimal +number (based on 2048 bytes per sector) and the iso9660 directory flags +as hexadecimal number as follows: +.RS +.TP +.B 0x00 +A plain file (not really a flag). +.TP +.B 0x01 +Hide the file name from directory listings. +.TP +.B 0x02 +A directory. +.TP +.B 0x04 +An accociated file (e.g. an Apple resource fork). +.TP +.B 0x08 +Record format in extended attributes is used. +.TP +.B 0x10 +No read/execute permission in extended attributes. +.TP +.B 0x20 +reserved +.TP +.B 0x40 +reserved +.TP +.B 0x80 +Not the final entry of a multi extent file. +.RE +.TP +.B \-N sector +Quick hack to help examine single session disc files that are to be written to +a multi-session disc. The sector number specified is the sector number at +which the iso9660 image should be written when send to the cd-writer. Not +used for the first session on the disc. +.TP +.B \-p +Print path table information. +.TP +.B \-R +Extract information from Rock Ridge extensions (if present) for permissions, +file names and ownerships. +.TP +.B \-s +Print file size infos in multiples of sector size (2048 bytes). +.TP +.B \-J +Extract information from Joliet extensions (if present) for file names. +.TP +.B \-j charset +Convert Joliet file names (if present) to the supplied charset. See +.BR mkisofs (8) +for details. +.TP +.B \-T sector +Quick hack to help examine multi-session images that have already been burned +to a multi-session disc. The sector number specified is the sector number for +the start of the session we wish to display. +.TP +.B \-X +Extract files from the image and put them into the filesystem. +If the +.B \-find +option is not used, all files are extracted. +.sp +The +.B isoinfo +program supports to extract all files, even multi extent +files (files > 4 GB). +.sp +Before extracting files using the +.B \-X +option, it is recommended to change the current directory +to an empty directory in order to prevent to clobber existing files. +.TP +.B \-x pathname +Extract specified file to stdout. +The +.B pathname +needs to start with a shlash ('/') and in case of iso9660 names, must match +the full pathname of the file inluding the version number (usually ';1'). +If the option +.B \-R +has been specified and the filesystem carries Rock Ridge attributes, the +.B pathname +must match the full Rock Ridge pathname of the file. +.SH AUTHOR +The author of the original sources (1993 .\|.\|. 1998) is +Eric Youngdale <ericy@gnu.ai.mit.edu> or <eric@andante.jic.com> is to blame +for these shoddy hacks. +J\*org Schilling wrote the SCSI transport library and its adaptation layer to +the programs and newer parts (starting from 1999) of the utilities, this makes +them +Copyright (C) 1999-2004 J\*org Schilling. +Patches to improve general usability would be gladly accepted. +.SH BUGS +The user interface really sucks. +.SH FUTURE IMPROVEMENTS +These utilities are really quick hacks, which are very useful for debugging +problems in mkisofs or in an iso9660 filesystem. In the long run, it would +be nice to have a daemon that would NFS export a iso9660 image. +.PP +The isoinfo program is probably the program that is of the most use to +the general user. +.SH AVAILABILITY +These utilities come with the +.B cdrtools +package, and the primary download site +is https://sourceforge.net/projects/cdrtools/files/ and many other mirror +sites. Despite the name, the software is not beta. + +.SH ENVIRONMENT +.TP +.B CDR_DEVICE +This may either hold a device identifier that is suitable to the open +call of the SCSI transport library or a label in the file /etc/default/cdrecord. +.TP +.B RSH +If the +.B RSH +environment is present, the remote connection will not be created via +.BR rcmd (3) +but by calling the program pointed to by +.BR RSH . +Use e.g. +.BR RSH= /usr/bin/ssh +to create a secure shell connection. +.sp +Note that this forces the program +to create a pipe to the +.B rsh(1) +program and disallows the program +to directly access the network socket to the remote server. +This makes it impossible to set up performance parameters and slows down +the connection compared to a +.B root +initiated +.B rcmd(3) +connection. +.TP +.B RSCSI +If the +.B RSCSI +environment is present, the remote SCSI server will not be the program +.B /opt/schily/sbin/rscsi +but the program pointed to by +.BR RSCSI . +Note that the remote SCSI server program name will be ignored if you log in +using an account that has been created with a remote SCSI server program as +login shell. + +.SH FILES +.TP +/etc/default/cdrecord +Default values can be set for the following options in /etc/default/cdrecord. +.RS +.TP +CDR_DEVICE +This may either hold a device identifier that is suitable to the open +call of the SCSI transport library or a label in the file /etc/default/cdrecord +that allows to identify a specific drive on the system. +.TP +Any other label +is an identifier for a specific drive on the system. +Such an identifier may not contain the characters ',', '/', '@' or ':'. +.sp +Each line that follows a label contains a TAB separated list of items. +Currently, four items are recognized: the SCSI ID of the drive, the +default speed that should be used for this drive, the default FIFO size +that should be used for this drive and drive specific options. The values for +.I speed +and +.I fifosize +may be set to -1 to tell the program to use the global defaults. +The value for driveropts may be set to "" if no driveropts are used. +A typical line may look this way: +.sp +teac1= 0,5,0 4 8m "" +.sp +yamaha= 1,6,0 -1 -1 burnfree +.sp +This tells the program +that a drive named +.I teac1 +is at scsibus 0, target 5, lun 0 and should be used with speed 4 and +a FIFO size of 8 MB. +A second drive may be found at scsibus 1, target 6, lun 0 and uses the +default speed and the default FIFO size. +.RE +.SH SEE ALSO +.BR mkisofs (8), +.BR cdrecord (1), +.BR readcd (1), +.BR scg (7), +.BR rcmd (3), +.BR ssh (1). diff --git a/upstream/opensuse-leap-15-6/man8/isosize.8 b/upstream/opensuse-leap-15-6/man8/isosize.8 new file mode 100644 index 00000000..4b80cd62 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/isosize.8 @@ -0,0 +1,79 @@ +'\" t +.\" Title: isosize +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "ISOSIZE" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +isosize \- output the length of an iso9660 filesystem +.SH "SYNOPSIS" +.sp +\fBisosize\fP [options] \fIiso9660_image_file\fP +.SH "DESCRIPTION" +.sp +This command outputs the length of an iso9660 filesystem that is contained in the specified file. This file may be a normal file or a block device (e.g. \fI/dev/hdd\fP or \fI/dev/sr0\fP). In the absence of any options (and errors), it will output the size of the iso9660 filesystem in bytes. This can now be a large number (>> 4 GB). +.SH "OPTIONS" +.sp +\fB\-x\fP, \fB\-\-sectors\fP +.RS 4 +Show the block count and block size in human\-readable form. The output uses the term "sectors" for "blocks". +.RE +.sp +\fB\-d\fP, \fB\-\-divisor\fP \fInumber\fP +.RS 4 +Only has an effect when \fB\-x\fP is not given. The value shown (if no errors) is the iso9660 file size in bytes divided by \fInumber\fP. So if \fInumber\fP is the block size then the shown value will be the block count. +.sp +The size of the file (or block device) holding an iso9660 filesystem can be marginally larger than the actual size of the iso9660 filesystem. One reason for this is that cd writers are allowed to add "run out" sectors at the end of an iso9660 image. +.RE +.SH "EXIT STATUS" +.sp +\fB0\fP +.RS 4 +success +.RE +.sp +\fB1\fP +.RS 4 +generic failure, such as invalid usage +.RE +.sp +\fB32\fP +.RS 4 +all failed +.RE +.sp +\fB64\fP +.RS 4 +some failed +.RE +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBisosize\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/iwconfig.8 b/upstream/opensuse-leap-15-6/man8/iwconfig.8 new file mode 100644 index 00000000..1585ec23 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/iwconfig.8 @@ -0,0 +1,609 @@ +.\" Jean II - HPLB - 1996 => HPL - 2004 +.\" iwconfig.8 +.\" +.TH IWCONFIG 8 "30 March 2006" "wireless-tools" "Linux Programmer's Manual" +.\" +.\" NAME part +.\" +.SH NAME +iwconfig \- configure a wireless network interface +.\" +.\" SYNOPSIS part +.\" +.SH SYNOPSIS +.BI "iwconfig [" interface ] +.br +.BI "iwconfig " interface " [essid " X "] [nwid " N "] [mode " M "] [freq " F "] +.br +.BI " [channel " C ] [sens " S "] [ap " A "] [nick " NN ] +.br +.BI " [rate " R "] [rts " RT "] [frag " FT "] [txpower " T ] +.br +.BI " [enc " E "] [key " K "] [power " P "] [retry " R ] +.br +.BI " [modu " M "] [commit] +.br +.BI "iwconfig --help" +.br +.BI "iwconfig --version" +.\" +.\" DESCRIPTION part +.\" +.SH DESCRIPTION +.B Iwconfig +is similar to +.IR ifconfig (8), +but is dedicated to the wireless interfaces. It is used to set the +parameters of the network interface which are specific to the wireless +operation (for example : the frequency). +.B Iwconfig +may also be used to display those parameters, and the wireless +statistics (extracted from +.IR /proc/net/wireless ). +.PP +All these parameters and statistics are device dependent. Each driver +will provide only some of them depending on hardware support, and the +range of values may change. Please refer to the man page of each +device for details. +.\" +.\" PARAMETER part +.\" +.SH PARAMETERS +.TP +.B essid +Set the ESSID (or Network Name - in some products it may also be +called Domain ID). The ESSID is used to identify cells which are part +of the same virtual network. +.br +As opposed to the AP Address or NWID which define a single cell, the +ESSID defines a group of cells connected via repeaters or +infrastructure, where the user may roam transparently. +.br +With some cards, you may disable the ESSID checking (ESSID +promiscuous) with +.IR off " or " any " (and " on +to reenable it). +.br +If the ESSID of your network is one of the special keywords +.RI ( off ", " on " or " any ), +you should use +.I -- +to escape it. +.br +.B Examples : +.br +.I " iwconfig eth0 essid any" +.br +.I " iwconfig eth0 essid ""My Network"" +.br +.I " iwconfig eth0 essid -- ""ANY"" +.TP +.BR nwid +Set the Network ID. As all adjacent wireless networks share the same +medium, this parameter is used to differentiate them (create logical +colocated networks) and identify nodes belonging to the same cell. +.br +This parameter is only used for pre-802.11 hardware, the 802.11 +protocol uses the ESSID and AP Address for this function. +.br +With some cards, you may disable the Network ID checking (NWID +promiscuous) with +.IR off " (and " on +to reenable it). +.br +.B Examples : +.br +.I " iwconfig eth0 nwid AB34 +.br +.I " iwconfig eth0 nwid off" +.TP +.BR nick [name] +Set the nickname, or the station name. Some 802.11 products do define +it, but this is not used as far as the protocols (MAC, IP, TCP) are +concerned and completely useless as far as configuration goes. Only +some wireless diagnostic tools may use it. +.br +.B Example : +.br +.I " iwconfig eth0 nickname ""My Linux Node"" +.TP +.B mode +Set the operating mode of the device, which depends on the network +topology. The mode can be +.I Ad-Hoc +(network composed of only one cell and without Access Point), +.I Managed +(node connects to a network composed of many Access Points, with roaming), +.I Master +(the node is the synchronisation master or acts as an Access Point), +.I Repeater +(the node forwards packets between other wireless nodes), +.I Secondary +(the node acts as a backup master/repeater), +.I Monitor +(the node is not associated with any cell and passively monitor all +packets on the frequency) or +.IR Auto . +.br +.B Example : +.br +.I " iwconfig eth0 mode Managed" +.br +.I " iwconfig eth0 mode Ad-Hoc" +.TP +.BR freq / channel +Set the operating frequency or channel in the device. A value below +1000 indicates a channel number, a value greater than 1000 is a +frequency in Hz. You may append the suffix k, M or G to the value (for +example, "2.46G" for 2.46 GHz frequency), or add enough '0'. +.br +Channels are usually numbered starting at 1, and you may use +.IR iwlist (8) +to get the total number of channels, list the available frequencies, +and display the current frequency as a channel. Depending on +regulations, some frequencies/channels may not be available. +.br +When using Managed mode, most often the Access Point dictates the +channel and the driver may refuse the setting of the frequency. In +Ad-Hoc mode, the frequency setting may only be used at initial cell +creation, and may be ignored when joining an existing cell. +.br +You may also use +.I off +or +.I auto +to let the card pick up the best channel (when supported). +.br +.B Examples : +.br +.I " iwconfig eth0 freq 2422000000" +.br +.I " iwconfig eth0 freq 2.422G" +.br +.I " iwconfig eth0 channel 3" +.br +.I " iwconfig eth0 channel auto" +.TP +.B ap +Force the card to register to the Access Point given by the address, +if it is possible. This address is the cell identity of the Access +Point, as reported by wireless scanning, which may be different from +its network MAC address. If the wireless link is point to point, set +the address of the other end of the link. If the link is ad-hoc, set +the cell identity of the ad-hoc network. +.br +When the quality of the connection goes too low, the driver may revert +back to automatic mode (the card selects the best Access Point in +range). +.br +You may also use +.I off +to re-enable automatic mode without changing the current Access Point, +or you may use +.I any +or +.I auto +to force the card to reassociate with the currently best Access Point. +.br +.B Example : +.br +.I " iwconfig eth0 ap 00:60:1D:01:23:45" +.br +.I " iwconfig eth0 ap any" +.br +.I " iwconfig eth0 ap off" +.TP +.BR rate / bit [rate] +For cards supporting multiple bit rates, set the bit-rate in b/s. The +bit-rate is the speed at which bits are transmitted over the medium, +the user speed of the link is lower due to medium sharing and +various overhead. +.br +You may append the suffix k, M or G to the value (decimal multiplier : +10^3, 10^6 and 10^9 b/s), or add enough '0'. Values below 1000 are +card specific, usually an index in the bit-rate list. Use +.I auto +to select automatic bit-rate mode (fallback to lower rate on noisy +channels), which is the default for most cards, and +.I fixed +to revert back to fixed setting. If you specify a bit-rate value and append +.IR auto , +the driver will use all bit-rates lower and equal than this value. +.br +.B Examples : +.br +.I " iwconfig eth0 rate 11M" +.br +.I " iwconfig eth0 rate auto" +.br +.I " iwconfig eth0 rate 5.5M auto" +.TP +.BR txpower +For cards supporting multiple transmit powers, sets the transmit power +in dBm. If +.I W +is the power in Watt, the power in dBm is +.IR "P = 30 + 10.log(W)" . +If the value is postfixed by +.IR mW , +it will be automatically converted to dBm. +.br +In addition, +.IR on " and " off +enable and disable the radio, and +.IR auto " and " fixed +enable and disable power control (if those features are available). +.br +.B Examples : +.br +.I " iwconfig eth0 txpower 15" +.br +.I " iwconfig eth0 txpower 30mW" +.br +.I " iwconfig eth0 txpower auto" +.br +.I " iwconfig eth0 txpower off" +.TP +.B sens +Set the sensitivity threshold. This define how sensitive is the card +to poor operating conditions (low signal, interference). Positive +values are assumed to be the raw value used by the hardware or a +percentage, negative values are assumed to be dBm. Depending on the +hardware implementation, this parameter may control various functions. +.br +On modern cards, this parameter usually control handover/roaming +threshold, the lowest signal level for which the hardware remains +associated with the current Access Point. When the signal level goes +below this threshold the card starts looking for a new/better Access +Point. Some cards may use the number of missed beacons to trigger +this. For high density of Access Points, a higher threshold make sure +the card is always associated with the best AP, for low density of +APs, a lower threshold minimise the number of failed handoffs. +.br +On more ancient card this parameter usually controls the defer +threshold, the lowest signal level for which the hardware considers +the channel busy. Signal levels above this threshold make the hardware +inhibits its own transmission whereas signals weaker than this are +ignored and the hardware is free to transmit. This is usually strongly +linked to the receive threshold, the lowest signal level for which the +hardware attempts packet reception. Proper setting of these thresholds +prevent the card to waste time on background noise while still +receiving weak transmissions. Modern designs seems to control those +thresholds automatically. +.br +.br +.B Example : +.br +.I " iwconfig eth0 sens -80" +.br +.I " iwconfig eth0 sens 2" +.TP +.BR retry +Most cards have MAC retransmissions, and some allow to set the +behaviour of the retry mechanism. +.br +To set the maximum number of retries, enter +.IR "limit `value'" . +This is an absolute value (without unit), and the default (when +nothing is specified). +To set the maximum length of time the MAC should retry, enter +.IR "lifetime `value'" . +By defaults, this value is in seconds, append the suffix m or u to +specify values in milliseconds or microseconds. +.br +You can also add the +.IR short ", " long ", " min " and " max +modifiers. If the card supports automatic mode, they define the bounds +of the limit or lifetime. Some other cards define different values +depending on packet size, for example in 802.11 +.I min limit +is the short retry limit (non RTS/CTS packets). +.br +.B Examples : +.br +.I " iwconfig eth0 retry 16" +.br +.I " iwconfig eth0 retry lifetime 300m" +.br +.I " iwconfig eth0 retry short 12" +.br +.I " iwconfig eth0 retry min limit 8" +.TP +.BR rts [_threshold] +RTS/CTS adds a handshake before each packet transmission to make sure +that the channel is clear. This adds overhead, but increases +performance in case of hidden nodes or a large number of active +nodes. This parameter sets the size of the smallest packet for which +the node sends RTS ; a value equal to the maximum packet size disables +the mechanism. You may also set this parameter to +.IR auto ", " fixed " or " off . +.br +.B Examples : +.br +.I " iwconfig eth0 rts 250" +.br +.I " iwconfig eth0 rts off" +.TP +.BR frag [mentation_threshold] +Fragmentation allows to split an IP packet in a burst of smaller +fragments transmitted on the medium. In most cases this adds overhead, +but in a very noisy environment this reduces the error penalty and +allow packets to get through interference bursts. This parameter sets +the maximum fragment size which is always lower than the maximum +packet size. +.br +This parameter may also control Frame Bursting available on some +cards, the ability to send multiple IP packets together. This +mechanism would be enabled if the fragment size is larger than the +maximum packet size. +.br +You may also set this parameter to +.IR auto ", " fixed " or " off . +.br +.B Examples : +.br +.I " iwconfig eth0 frag 512" +.br +.I " iwconfig eth0 frag off" +.TP +.BR key / enc [ryption] +Used to manipulate encryption or scrambling keys and security mode. +.br +To set the current encryption key, just enter the key in hex digits as +.IR XXXX-XXXX-XXXX-XXXX " or " XXXXXXXX . +To set a key other than the current key, prepend or append +.I [index] +to the key itself (this won't change which is the active key). You can +also enter the key as an ASCII string by using the +.I s: +prefix. Passphrase is currently not supported. +.br +To change which key is the currently active key, just enter +.I [index] +(without entering any key value). +.br +.IR off " and " on +disable and reenable encryption. +.br +The security mode may be +.I open +or +.IR restricted , +and its meaning depends on the card used. With most cards, in +.I open +mode no authentication is used and the card may also accept +non-encrypted sessions, whereas in +.I restricted +mode only encrypted sessions are accepted and the card will use +authentication if available. +.br +If you need to set multiple keys, or set a key and change the active +key, you need to use multiple +.B key +directives. Arguments can be put in any order, the last one will take +precedence. +.br +.B Examples : +.br +.I " iwconfig eth0 key 0123-4567-89" +.br +.I " iwconfig eth0 key [3] 0123-4567-89" +.br +.I " iwconfig eth0 key s:password [2]" +.br +.I " iwconfig eth0 key [2]" +.br +.I " iwconfig eth0 key open" +.br +.I " iwconfig eth0 key off" +.br +.I " iwconfig eth0 key restricted [3] 0123456789" +.br +.I " iwconfig eth0 key 01-23 key 45-67 [4] key [4]" +.TP +.BR power +Used to manipulate power management scheme parameters and mode. +.br +To set the period between wake ups, enter +.IR "period `value'" . +To set the timeout before going back to sleep, enter +.IR "timeout `value'" . +To set the generic level of power saving, enter +.IR "saving `value'" . +You can also add the +.IR min " and " max +modifiers. By default, those values are in seconds, append the suffix +m or u to specify values in milliseconds or microseconds. Sometimes, +those values are without units (number of beacon periods, dwell, +percentage or similar). +.br +.IR off " and " on +disable and reenable power management. Finally, you may set the power +management mode to +.I all +(receive all packets), +.I unicast +(receive unicast packets only, discard multicast and broadcast) and +.I multicast +(receive multicast and broadcast only, discard unicast packets). +.br +.B Examples : +.br +.I " iwconfig eth0 power period 2" +.br +.I " iwconfig eth0 power 500m unicast" +.br +.I " iwconfig eth0 power timeout 300u all" +.br +.I " iwconfig eth0 power saving 3" +.br +.I " iwconfig eth0 power off" +.br +.I " iwconfig eth0 power min period 2 power max period 4" +.TP +.BR modu [lation] +Force the card to use a specific set of modulations. Modern cards +support various modulations, some which are standard, such as 802.11b +or 802.11g, and some proprietary. This command force the card to only +use the specific set of modulations listed on the command line. This +can be used to fix interoperability issues. +.br +The list of available modulations depend on the card/driver and can be +displayed using +.IR "iwlist modulation" . +Note that some card/driver may not be able to select each modulation +listed independently, some may come as a group. You may also set this +parameter to +.IR auto +let the card/driver do its best. +.br +.B Examples : +.br +.I " iwconfig eth0 modu 11g" +.br +.I " iwconfig eth0 modu CCK OFDMa" +.br +.I " iwconfig eth0 modu auto" +.TP +.BR commit +Some cards may not apply changes done through Wireless Extensions +immediately (they may wait to aggregate the changes or apply it only +when the card is brought up via +.IR ifconfig ). +This command (when available) forces the card to apply all pending +changes. +.br +This is normally not needed, because the card will eventually apply +the changes, but can be useful for debugging. +.\" +.\" DISPLAY part +.\" +.SH DISPLAY +For each device which supports wireless extensions, +.I iwconfig +will display the name of the +.B MAC protocol +used (name of device for proprietary protocols), the +.B ESSID +(Network Name), the +.BR NWID , +the +.B frequency +(or channel), the +.BR sensitivity , +the +.B mode +of operation, the +.B Access Point +address, the +.BR bit-rate , +the +.BR "RTS threshold" ", the " "fragmentation threshold" , +the +.B encryption key +and the +.B power management +settings (depending on availability). +.PP +The parameters displayed have the same meaning and values as the +parameters you can set, please refer to the previous part for a +detailed explanation of them. +.br +Some parameters are only displayed in short/abbreviated form (such as +encryption). You may use +.IR iwlist (8) +to get all the details. +.br +Some parameters have two modes (such as bitrate). If the value is +prefixed by +.RB ` = ', +it means that the parameter is fixed and forced to that value, if it +is prefixed by +.RB ` : ', +the parameter is in automatic mode and the current value is shown (and +may change). +.TP +.BR "Access Point" / Cell +An address equal to 00:00:00:00:00:00 means that the card failed to +associate with an Access Point (most likely a configuration +issue). The +.B Access Point +parameter will be shown as +.B Cell +in ad-hoc mode (for obvious reasons), but otherwise works the same. +.PP +If +.I /proc/net/wireless +exists, +.I iwconfig +will also display its content. Note that those values will depend on +the driver and the hardware specifics, so you need to refer to your +driver documentation for proper interpretation of those values. +.TP +.B Link quality +Overall quality of the link. May be based on the level of contention +or interference, the bit or frame error rate, how good the received +signal is, some timing synchronisation, or other hardware metric. This +is an aggregate value, and depends totally on the driver and hardware. +.TP +.B Signal level +Received signal strength (RSSI - how strong the received signal +is). May be arbitrary units or dBm, +.I iwconfig +uses driver meta information to interpret the raw value given by +.I /proc/net/wireless +and display the proper unit or maximum value (using 8 bit arithmetic). In +.I Ad-Hoc +mode, this may be undefined and you should use +.IR iwspy . +.TP +.B Noise level +Background noise level (when no packet is transmitted). Similar +comments as for +.BR "Signal level" . +.TP +.B Rx invalid nwid +Number of packets received with a different NWID or ESSID. Used to +detect configuration problems or adjacent network existence (on the +same frequency). +.TP +.B Rx invalid crypt +Number of packets that the hardware was unable to decrypt. This can be +used to detect invalid encryption settings. +.TP +.B Rx invalid frag +Number of packets for which the hardware was not able to properly +re-assemble the link layer fragments (most likely one was missing). +.TP +.B Tx excessive retries +Number of packets that the hardware failed to deliver. Most MAC +protocols will retry the packet a number of times before giving up. +.TP +.B Invalid misc +Other packets lost in relation with specific wireless operations. +.TP +.B Missed beacon +Number of periodic beacons from the Cell or the Access Point we have +missed. Beacons are sent at regular intervals to maintain the cell +coordination, failure to receive them usually indicates that the card +is out of range. +.\" +.\" AUTHOR part +.\" +.SH AUTHOR +Jean Tourrilhes \- jt@hpl.hp.com +.\" +.\" FILES part +.\" +.SH FILES +.I /proc/net/wireless +.\" +.\" SEE ALSO part +.\" +.SH SEE ALSO +.BR ifconfig (8), +.BR iwspy (8), +.BR iwlist (8), +.BR iwevent (8), +.BR iwpriv (8), +.BR wireless (7). diff --git a/upstream/opensuse-leap-15-6/man8/iwevent.8 b/upstream/opensuse-leap-15-6/man8/iwevent.8 new file mode 100644 index 00000000..02a98e07 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/iwevent.8 @@ -0,0 +1,112 @@ +.\" Jean Tourrilhes - HPL - 2002 - 2004 +.\" iwevent.8 +.\" +.TH IWEVENT 8 "23 June 2004" "net-tools" "Linux Programmer's Manual" +.\" +.\" NAME part +.\" +.SH NAME +iwevent \- Display Wireless Events generated by drivers and setting changes +.\" +.\" SYNOPSIS part +.\" +.SH SYNOPSIS +.BI "iwevent " +.br +.\" +.\" DESCRIPTION part +.\" +.SH DESCRIPTION +.B iwevent +displays Wireless Events received through the RTNetlink socket. Each +line displays the specific Wireless Event which describes what has +happened on the specified wireless interface. +.br +This command doesn't take any arguments. +.\" +.\" DISPLAY part +.\" +.SH DISPLAY +There are two classes of Wireless Events. +.PP +The first class is events related to a change of wireless settings on +the interface (typically done through +.B iwconfig +or a script calling +.BR iwconfig ). +Only settings that could result in a disruption of connectivity are +reported. The events currently reported are changing one of the +following setting : +.br +.I " Network ID" +.br +.I " ESSID" +.br +.I " Frequency" +.br +.I " Mode" +.br +.I " Encryption" +.br +All those events will be generated on all wireless interfaces by the +kernel wireless subsystem (but only if the driver has been converted +to the new driver API). +.PP +The second class of events are events generated by the hardware, when +something happens or a task has been finished. Those events include : +.TP +.B New Access Point/Cell address +The interface has joined a new Access Point or Ad-Hoc Cell, or lost +its association with it. This is the same address that is reported +by +.BR iwconfig . +.TP +.B Scan request completed +A scanning request has been completed, results of the scan are +available (see +.BR iwlist ). +.TP +.B Tx packet dropped +A packet directed at this address has been dropped because the +interface believes this node doesn't answer anymore (usually maximum +of MAC level retry exceeded). This is usually an early indication that +the node may have left the cell or gone out of range, but it may be +due to fading or excessive contention. +.TP +.B Custom driver event +Event specific to the driver. Please check the driver documentation. +.TP +.B Registered node +The interface has successfully registered a new wireless +client/peer. Will be generated mostly when the interface acts as an +Access Point (mode Master). +.TP +.B Expired node +The registration of the client/peer on this interface has +expired. Will be generated mostly when the interface acts as an Access +Point (mode Master). +.TP +.B Spy threshold crossed +The signal strength for one of the addresses in the spy list went +under the low threshold or went above the high threshold. +.PP +Most wireless drivers generate only a subset of those events, not all +of them, the exact list depends on the specific hardware/driver +combination. Please refer to driver documentation for details on when +they are generated, and use +.IR iwlist (8) +to check what the driver supports. +.\" +.\" AUTHOR part +.\" +.SH AUTHOR +Jean Tourrilhes \- jt@hpl.hp.com +.\" +.\" SEE ALSO part +.\" +.SH SEE ALSO +.BR iwconfig (8), +.BR iwlist (8), +.BR iwspy (8), +.BR iwpriv (8), +.BR wireless (7). diff --git a/upstream/opensuse-leap-15-6/man8/iwgetid.8 b/upstream/opensuse-leap-15-6/man8/iwgetid.8 new file mode 100644 index 00000000..4d4090a0 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/iwgetid.8 @@ -0,0 +1,115 @@ +.\" Guus Sliepen - 2001 +.\" Completed and fixed up by Jean Tourrilhes - 2002-2003 +.\" iwgetid.8 +.\" +.TH IWGETID 8 "02 December 2003" "wireless-tools" "Linux Programmer's Manual" +.\" +.\" NAME part +.\" +.SH NAME +iwgetid \- Report ESSID, NWID or AP/Cell Address of wireless network +.\" +.\" SYNOPSIS part +.\" +.SH SYNOPSIS +.BI "iwgetid " [interface] " [--raw] [--scheme] [--ap] [--freq]" +.br +.BI " [--mode] [--protocol] [--channel] +.br +.\" +.\" DESCRIPTION part +.\" +.SH DESCRIPTION +.B iwgetid +is used to find out the NWID, ESSID or AP/Cell Address of the wireless +network that is currently used. The information reported is the same +as the one shown by +.BR iwconfig ", but " iwgetid +is easier to integrate in various scripts. +.br +By default, +.B iwgetid +will print the +.I ESSID +of the device, and if the device doesn't have any ESSID it will print +its +.IR NWID . +.br +The default formatting output is pretty-print. +.\" +.\" OPTIONS part +.\" +.SH OPTIONS +.TP +.B --raw +This option disables pretty-printing of the information. This option +is orthogonal to the other options (except +.BR --scheme ), +so with the appropriate combination of options you can print the raw +ESSID, AP Address or Mode. +.br +This format is ideal when storing the result of iwgetid as a +variable in +.I Shell +or +.I Perl +scripts or to pass the result as an argument on the command line of +.BR iwconfig . +.TP +.B --scheme +This option is similar to the previous one, it disables +pretty-printing of the information and removes all characters that are +not alphanumerics (like space, punctuation and control characters). +.br +The resulting output is a valid Pcmcia scheme identifier (that may be +used as an argument of the command +.BR "cardctl scheme" ). +This format is also ideal when using the result of iwgetid as a +selector in +.I Shell +or +.I Perl +scripts, or as a file name. +.TP +.B --ap +Display the MAC address of the Wireless +.I Access Point +or the +.IR Cell . +.TP +.B --freq +Display the current +.I frequency +or +.I channel +used by the interface. +.TP +.B --channel +Display the current +.I channel +used by the interface. The channel is determined using the current +frequency and the frequency list provided by the interface. +.TP +.B --mode +Display the current +.I mode +of the interface. +.TP +.B --protocol +Display the +.I protocol name +of the interface. This allows to identify all the cards that are +compatible with each other and accept the same type of configuration. +.br +This can also be used to +.I check Wireless Extension support +on the interface, as this is the only attribute that all drivers +supporting Wireless Extension are mandated to support. +.\" +.\" SEE ALSO part +.\" +.SH SEE ALSO +.BR iwconfig (8), +.BR ifconfig (8), +.BR iwspy (8), +.BR iwpriv (8). diff --git a/upstream/opensuse-leap-15-6/man8/iwlist.8 b/upstream/opensuse-leap-15-6/man8/iwlist.8 new file mode 100644 index 00000000..aa842797 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/iwlist.8 @@ -0,0 +1,152 @@ +.\" Jean II - HPLB - 96 +.\" iwlist.8 +.\" +.TH IWLIST 8 "13 April 2006" "wireless-tools" "Linux Programmer's Manual" +.\" +.\" NAME part +.\" +.SH NAME +iwlist \- Get more detailed wireless information from a wireless interface +.\" +.\" SYNOPSIS part +.\" +.SH SYNOPSIS +.BI "iwlist [" interface "] scanning" +.br +.BI "iwlist [" interface "] frequency" +.br +.BI "iwlist [" interface "] rate" +.br +.BI "iwlist [" interface "] keys" +.br +.BI "iwlist [" interface "] power" +.br +.BI "iwlist [" interface "] txpower" +.br +.BI "iwlist [" interface "] retry" +.br +.BI "iwlist [" interface "] event" +.br +.BI "iwlist [" interface "] auth" +.br +.BI "iwlist [" interface "] wpakeys" +.br +.BI "iwlist [" interface "] genie" +.br +.BI "iwlist [" interface "] modulation" +.br +.BI "iwlist --help" +.br +.BI "iwlist --version" +.\" +.\" DESCRIPTION part +.\" +.SH DESCRIPTION +.B Iwlist +is used to display some additional information from a wireless network +interface that is not displayed by +.IR iwconfig (8). +The main argument is used +to select a category of information, +.B iwlist +displays in detailed form all information related to this category, +including information already shown by +.IR iwconfig (8). +.\" +.\" PARAMETER part +.\" +.SH PARAMETERS +.TP +.BR scan [ning] +Give the list of Access Points and Ad-Hoc cells in range, and +optionally a whole bunch of information about them (ESSID, Quality, +Frequency, Mode...). The type of information returned depends on what +the card supports. +.br +Triggering scanning is a privileged operation +.RI ( root +only) and normal users can only read left-over scan results. By +default, the way scanning is done (the scope of the scan) is dependant +on the card and card settings. +.br +This command takes optional arguments, however most drivers will ignore +those. The option +.B essid +is used to specify a scan on a specific ESSID. With some card/driver, +this enables to see hidden networks. The option +.B last +does not trigger a scan and read left-over scan results. +.TP +.BR freq [uency]/ channel +Give the list of available frequencies in the device and the number of +defined channels. Please note that usually the driver returns the +total number of channels and only the frequencies available in the +present locale, so there is no one-to-one mapping between frequencies +displayed and channel numbers. +.TP +.BR rate / bit [rate] +List the bit-rates supported by the device. +.TP +.BR keys / enc [ryption] +List the encryption key sizes supported and list all the encryption +keys set in the device. +.TP +.B power +List the various Power Management attributes and modes of the device. +.TP +.B txpower +List the various Transmit Powers available on the device. +.TP +.B retry +List the transmit retry limits and retry lifetime on the device. +.TP +.BR ap / accesspoint / peers +Give the list of Access Points in range, and optionally the quality of +link to them. This feature is +.B obsolete +and now deprecated in favor of scanning support (above), and most +drivers don't support it. +.br +Some drivers may use this command to return a specific list of Peers +or Access Points, such as the list of Peers associated/registered with +the card. See your driver documentation for details. +.TP +.B event +List the wireless events supported by the device. +.TP +.B auth +List the WPA authentication parametes curently set. +.TP +.BR wpa [keys] +List all the WPA encryption keys set in the device. +.TP +.B genie +List the Generic Information Elements set in the device (used for WPA +support). +.TP +.BR modu [lation] +List the modulations supported by the device and the modulations +currently enabled. +.TP +.B --version +Display the version of the tools, as well as the recommended and +current Wireless Extensions version for the tool and the various +wireless interfaces. +.TP +.B --help +Display short help message. +.\" +.\" FILES part +.\" +.SH FILES +.I /proc/net/wireless +.\" +.\" SEE ALSO part +.\" +.SH SEE ALSO +.BR iwconfig (8), +.BR iwspy (8). +.BR iwevent (8), +.BR iwpriv (8), +.BR wireless (7). + diff --git a/upstream/opensuse-leap-15-6/man8/iwpriv.8 b/upstream/opensuse-leap-15-6/man8/iwpriv.8 new file mode 100644 index 00000000..11244a7b --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/iwpriv.8 @@ -0,0 +1,118 @@ +.\" Jean II - HPLB - 96 +.\" iwpriv.8 +.\" +.TH IWPRIV 8 "31 October 1996" "net-tools" "Linux Programmer's Manual" +.\" +.\" NAME part +.\" +.SH NAME +iwpriv \- configure optionals (private) parameters of a wireless +network interface +.\" +.\" SYNOPSIS part +.\" +.SH SYNOPSIS +.BI "iwpriv [" interface ] +.br +.BI "iwpriv " "interface private-command " "[" private-parameters ] +.br +.BI "iwpriv " "interface private-command " [ I "] [" private-parameters ] +.br +.BI "iwpriv " interface " --all" +.\" +.\" DESCRIPTION part +.\" +.SH DESCRIPTION +.B Iwpriv +is the companion tool to +.IR iwconfig (8). +.B Iwpriv +deals with parameters and setting specific to each driver (as opposed to +.I iwconfig +which deals with generic ones). +.PP +Without any argument, +.B iwpriv +list the available private commands available on each interface, and +the parameters that they require. Using this information, the user may +apply those interface specific commands on the specified interface. +.PP +In theory, the documentation of each device driver should indicate how +to use those interface specific commands and their effect. +.\" +.\" PARAMETER part +.\" +.SH PARAMETERS +.TP +.IR private-command " [" private-parameters ] +Execute the specified +.I private-command +on the interface. +.br +The command may optionally take or require arguments, and may display +information. Therefore, the command line parameters may or may not be +needed and should match the command expectations. The list of commands +that +.B iwpriv +displays (when called without argument) should give you some hints +about those parameters. +.br +However you should refer to the device driver documentation for +information on how to properly use the command and the effect. +.TP +.IR "private-command " [ I "] [" private-parameters ] +Idem, except that +.I I +(an integer) is passed to the command as a +.IR "Token Index" . +Only some command will use the Token Index (most will ignore it), and +the driver documentation should tell you when it's needed. +.TP +.BR -a / --all +Execute and display all the private commands that don't take any +arguments (i.e. read only). +.\" +.\" DISPLAY part +.\" +.SH DISPLAY +For each device which support private commands, +.I iwpriv +will display the list of private commands available. +.PP +This include the name of the private command, the number or arguments +that may be set and their type, and the number or arguments that may +be display and their type. +.PP +For example, you may have the following display : +.br +.B "eth0 Available private ioctl :" +.br +.B " setqualthr (89F0) : set 1 byte & get 0" +.br +.B " gethisto (89F7) : set 0 & get 16 int" +.PP +This indicate that you may set the quality threshold and display an +histogram of up to 16 values with the following commands : +.br +.I " iwpriv eth0 setqualthr 20" +.br +.I " iwpriv eth0 gethisto" +.\" +.\" AUTHOR part +.\" +.SH AUTHOR +Jean Tourrilhes \- jt@hpl.hp.com +.\" +.\" FILES part +.\" +.SH FILES +.I /proc/net/wireless +.\" +.\" SEE ALSO part +.\" +.SH SEE ALSO +.BR iwconfig (8), +.BR iwlist (8), +.BR iwevent (8), +.BR iwspy (8), +.BR wireless (7). diff --git a/upstream/opensuse-leap-15-6/man8/iwspy.8 b/upstream/opensuse-leap-15-6/man8/iwspy.8 new file mode 100644 index 00000000..fb148f50 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/iwspy.8 @@ -0,0 +1,111 @@ +.\" Jean II - HPLB - 96 +.\" iwspy.8 +.\" +.TH IWSPY 8 "31 October 1996" "net-tools" "Linux Programmer's Manual" +.\" +.\" NAME part +.\" +.SH NAME +iwspy \- Get wireless statistics from specific nodes +.\" +.\" SYNOPSIS part +.\" +.SH SYNOPSIS +.BI "iwspy [" interface ] +.br +.BI "iwspy " interface " [+] " DNSNAME " | " IPADDR " | " HWADDR " [...]" +.br +.BI "iwspy " interface " off" +.br +.BI "iwspy " interface " setthr " "low high" +.br +.BI "iwspy " interface " getthr" +.\" +.\" DESCRIPTION part +.\" +.SH DESCRIPTION +.B Iwspy +is used to set a list of addresses to monitor in a wireless network +interface and to read back quality of link information for each of +those. This information is the same as the one available in +.I /proc/net/wireless +: quality of the link, signal strength and noise level. +.PP +This information is updated each time a new packet is received, so +each address of the list adds some overhead in the driver. +.PP +Note that this functionality works only for nodes part of the current +wireless cell, you can not monitor Access Points you are not +associated with (you can use Scanning for that) and nodes in other +cells. In Managed mode, in most case packets are relayed by the Access +Point, in this case you will get the signal strength of the Access +Point. For those reasons this functionality is mostly useful in Ad-Hoc +and Master mode. +.\" +.\" PARAMETER part +.\" +.SH PARAMETERS +You may set any number of addresses up to 8. +.TP +.BR DNSNAME " | " IPADDR +Set an IP address, or in some cases a DNS name (using the name +resolver). As the hardware works with hardware addresses, +.B iwspy +will translate this IP address through +.IR ARP . +In some case, this address might not be in the ARP cache and +.B iwspy +will fail. In those case, +.IR ping (8) +this name/address and retry. +.TP +.B HWADDR +Set a hardware (MAC) address (this address is not translated & checked +like the IP one). The address must contain a colon +.RB ( : ) +to be recognised as a hardware address. +.TP +.B + +Add the new set of addresses at the end of the current list instead of +replacing it. The address list is unique for each device, so each user +should use this option to avoid conflicts. +.TP +.B off +Remove the current list of addresses and disable the spy functionality +.TP +.B setthr +Set the +.I low +and +.I high +signal strength threshold for the iwspy event (for drivers that +support it). +.br +Every time the signal strength for any of the address monitored +with iwspy goes lower than the low threshold or goes higher than the +high threshold, a Wireless Event will be generated. +.br +This can be used to monitor link outages without having to run iwspy +periodically. +.TP +.B getthr +Retrieve the current +.I low +and +.I high +signal strength threshold for the iwspy event. +\" +.\" FILES part +.\" +.SH FILES +.I /proc/net/wireless +.\" +.\" SEE ALSO part +.\" +.SH SEE ALSO +.BR iwconfig (8), +.BR iwlist (8), +.BR iwevent (8), +.BR iwpriv (8), +.BR wireless (7). + diff --git a/upstream/opensuse-leap-15-6/man8/kbdrate.8 b/upstream/opensuse-leap-15-6/man8/kbdrate.8 new file mode 100644 index 00000000..300844ce --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/kbdrate.8 @@ -0,0 +1,71 @@ +.\" Copyright 1992, 1994 Rickard E. Faith (faith@cs.unc.edu) +.\" May be distributed under the GNU General Public License +.\" Updated Wed Jun 22 21:09:43 1994, faith@cs.unc.edu +.\" +.TH KBDRATE 8 "22 June 1994" "kbd" +.SH NAME +kbdrate \- reset the keyboard repeat rate and delay time +.SH SYNOPSIS +.B kbdrate +[\fI\,options\/\fR...] +.SH DESCRIPTION +.B kbdrate +is used to change the keyboard repeat rate and delay time. The delay +is the amount of time that a key must be depressed before it will start to +repeat. + +Using +.B kbdrate +without any options will reset the repeat rate to 10.9 characters per second (cps) +and the delay to 250 milliseconds (ms) for Intel- and M68K-based systems. +These are the IBM defaults. On SPARC-based systems it will reset the repeat rate +to 5 cps and the delay to 200 ms. + +.SH OPTIONS +.TP +\fB\-r\fR, \fB\-\-rate\fR=\fI\,NUMBER\/\fR +Change the keyboard repeat rate to +.I NUMBER +cps. For Intel-based systems, the allowable range is from 2.0 to 30.0 cps. +Only certain, specific values are possible, and the program will select the +nearest possible value to the one specified. The possible values are given, +in characters per second, as follows: 2.0, 2.1, 2.3, 2.5, 2.7, 3.0, 3.3, 3.7, +4.0, 4.3, 4.6, 5.0, 5.5, 6.0, 6.7, 7.5, 8.0, 8.6, 9.2, 10.0, 10.9, 12.0, 13.3, +15.0, 16.0, 17.1, 18.5, 20.0, 21.8, 24.0, 26.7, 30.0. +For SPARC-based systems, the allowable range is from 0 (no repeat) to 50 cps. +.TP +\fB\-d\fR, \fB\-\-delay\fR=\fI\,NUMBER\/\fR +Change the delay to +.I NUMBER +milliseconds. +For Intel-based systems, the allowable range is from 250 to 1000 ms, +in 250 ms steps. For SPARC systems, possible values are between 10 ms and 1440 ms, +in 10 ms steps. +.TP +\fB\-s\fR, \fB\-\-silent\fR +Silent. No messages are printed. +.TP +\fB\-h\fR, \fB\-\-help\fR +Display a help text. +.TP +\fB\-V\fR, \fB\-\-version\fR +Display a version number and exit. +.SH BUGS +Not all keyboards support all rates. +.PP +Not all keyboards have the rates mapped in the same way. +.PP +Setting the repeat rate on the Gateway AnyKey keyboard does not work. If +someone with a Gateway figures out how to program the keyboard, please send +mail to util-linux@math.uio.no. +.PP +All this is very architecture dependent. +Nowadays +.B kbdrate +first tries the KDKBDREP and KIOCSRATE ioctls. +(The former usually works on an m68k/i386 machine, the latter for SPARC.) +When these ioctls fail an ioport interface. +.SH FILES +.I /etc/rc.local +.br +.I /dev/port diff --git a/upstream/opensuse-leap-15-6/man8/kmod.8 b/upstream/opensuse-leap-15-6/man8/kmod.8 new file mode 100644 index 00000000..5a249cb9 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/kmod.8 @@ -0,0 +1,82 @@ +'\" t +.\" Title: kmod +.\" Author: Lucas De Marchi <lucas.de.marchi@gmail.com> +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 01/29/2021 +.\" Manual: kmod +.\" Source: kmod +.\" Language: English +.\" +.TH "KMOD" "8" "01/29/2021" "kmod" "kmod" +.\" ----------------------------------------------------------------- +.\" * 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" +kmod \- Program to manage Linux Kernel modules +.SH "SYNOPSIS" +.HP \w'\fBkmod\fR\ 'u +\fBkmod\fR [\fBOPTIONS\fR...] [\fICOMMAND\fR] [\fBCOMMAND_OPTIONS\fR...] +.SH "DESCRIPTION" +.PP +\fBkmod\fR +is a multi\-call binary which implements the programs used to control Linux Kernel modules\&. Most users will only run it using its other names\&. +.SH "OPTIONS" +.PP +\fB\-V\fR \fB\-\-version\fR +.RS 4 +Show the program version and exit\&. +.RE +.PP +\fB\-h\fR \fB\-\-help\fR +.RS 4 +Show the help message\&. +.RE +.SH "COMMANDS" +.PP +\fBhelp\fR +.RS 4 +Show the help message\&. +.RE +.PP +\fBlist\fR +.RS 4 +List the currently loaded modules\&. +.RE +.PP +\fBstatic\-nodes\fR +.RS 4 +Output the static device nodes information provided by the modules of the currently running kernel version\&. +.RE +.SH "COPYRIGHT" +.PP +This manual page originally Copyright 2014, Marco d\*(AqItri\&. Maintained by Lucas De Marchi and others\&. +.SH "SEE ALSO" +.PP +\fBlsmod\fR(8), +\fBrmmod\fR(8), +\fBinsmod\fR(8), +\fBmodinfo\fR(8), +\fBmodprobe\fR(8), +\fBdepmod\fR(8) +.SH "AUTHOR" +.PP +\fBLucas De Marchi\fR <\&lucas\&.de\&.marchi@gmail\&.com\&> +.RS 4 +Developer +.RE diff --git a/upstream/opensuse-leap-15-6/man8/ld.so.8 b/upstream/opensuse-leap-15-6/man8/ld.so.8 new file mode 100644 index 00000000..3cf7651a --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/ld.so.8 @@ -0,0 +1,843 @@ +.\" %%%LICENSE_START(PUBLIC_DOMAIN) +.\" This is in the public domain +.\" %%%LICENSE_END +.\" Various parts: +.\" Copyright (C) 2007-9, 2013, 2016 Michael Kerrisk <mtk.manpages@gmail.com> +.\" +.TH ld.so 8 2023-02-05 "Linux man-pages 6.04" +.SH NAME +ld.so, ld\-linux.so \- dynamic linker/loader +.SH SYNOPSIS +The dynamic linker can be run either indirectly by running some +dynamically linked program or shared object +(in which case no command-line options +to the dynamic linker can be passed and, in the ELF case, the dynamic linker +which is stored in the +.B .interp +section of the program is executed) or directly by running: +.PP +.I /lib/ld\-linux.so.* +[OPTIONS] [PROGRAM [ARGUMENTS]] +.SH DESCRIPTION +The programs +.B ld.so +and +.B ld\-linux.so* +find and load the shared objects (shared libraries) needed by a program, +prepare the program to run, and then run it. +.PP +Linux binaries require dynamic linking (linking at run time) +unless the +.B \-static +option was given to +.BR ld (1) +during compilation. +.PP +The program +.B ld.so +handles a.out binaries, a binary format used long ago. +The program +.B ld\-linux.so* +(\fI/lib/ld\-linux.so.1\fP for libc5, \fI/lib/ld\-linux.so.2\fP for glibc2) +handles binaries that are in the more modern ELF format. +Both programs have the same behavior, and use the same +support files and programs +.RB ( ldd (1), +.BR ldconfig (8), +and +.IR /etc/ld.so.conf ). +.PP +When resolving shared object dependencies, +the dynamic linker first inspects each dependency +string to see if it contains a slash (this can occur if +a shared object pathname containing slashes was specified at link time). +If a slash is found, then the dependency string is interpreted as +a (relative or absolute) pathname, +and the shared object is loaded using that pathname. +.PP +If a shared object dependency does not contain a slash, +then it is searched for in the following order: +.IP (1) 5 +Using the directories specified in the +DT_RPATH dynamic section attribute +of the binary if present and DT_RUNPATH attribute does not exist. +Use of DT_RPATH is deprecated. +.IP (2) +Using the environment variable +.BR LD_LIBRARY_PATH , +unless the executable is being run in secure-execution mode (see below), +in which case this variable is ignored. +.IP (3) +Using the directories specified in the +DT_RUNPATH dynamic section attribute +of the binary if present. +Such directories are searched only to +find those objects required by DT_NEEDED (direct dependencies) entries +and do not apply to those objects' children, +which must themselves have their own DT_RUNPATH entries. +This is unlike DT_RPATH, which is applied +to searches for all children in the dependency tree. +.IP (4) +From the cache file +.IR /etc/ld.so.cache , +which contains a compiled list of candidate shared objects previously found +in the augmented library path. +If, however, the binary was linked with the +.B \-z nodeflib +linker option, shared objects in the default paths are skipped. +Shared objects installed in hardware capability directories (see below) +are preferred to other shared objects. +.IP (5) +In the default path +.IR /lib , +and then +.IR /usr/lib . +(On some 64-bit architectures, the default paths for 64-bit shared objects are +.IR /lib64 , +and then +.IR /usr/lib64 .) +If the binary was linked with the +.B \-z nodeflib +linker option, this step is skipped. +.\" +.SS Dynamic string tokens +In several places, the dynamic linker expands dynamic string tokens: +.IP \[bu] 3 +In the environment variables +.BR LD_LIBRARY_PATH , +.BR LD_PRELOAD , +and +.BR LD_AUDIT , +.IP \[bu] +inside the values of the dynamic section tags +.BR DT_NEEDED , +.BR DT_RPATH , +.BR DT_RUNPATH , +.BR DT_AUDIT , +and +.B DT_DEPAUDIT +of ELF binaries, +.IP \[bu] +in the arguments to the +.B ld.so +command line options +.BR \-\-audit , +.BR \-\-library\-path , +and +.B \-\-preload +(see below), and +.IP \[bu] +in the filename arguments to the +.BR dlopen (3) +and +.BR dlmopen (3) +functions. +.PP +The substituted tokens are as follows: +.TP +.IR $ORIGIN " (or equivalently " ${ORIGIN} ) +This expands to +the directory containing the program or shared object. +Thus, an application located in +.I somedir/app +could be compiled with +.IP +.in +4n +.EX +gcc \-Wl,\-rpath,\[aq]$ORIGIN/../lib\[aq] +.EE +.in +.IP +so that it finds an associated shared object in +.I somedir/lib +no matter where +.I somedir +is located in the directory hierarchy. +This facilitates the creation of "turn-key" applications that +do not need to be installed into special directories, +but can instead be unpacked into any directory +and still find their own shared objects. +.TP +.IR $LIB " (or equivalently " ${LIB} ) +This expands to +.I lib +or +.I lib64 +depending on the architecture +(e.g., on x86-64, it expands to +.I lib64 +and +on x86-32, it expands to +.IR lib ). +.TP +.IR $PLATFORM " (or equivalently " ${PLATFORM} ) +This expands to a string corresponding to the processor type +of the host system (e.g., "x86_64"). +On some architectures, the Linux kernel doesn't provide a platform +string to the dynamic linker. +The value of this string is taken from the +.B AT_PLATFORM +value in the auxiliary vector (see +.BR getauxval (3)). +.\" To get an idea of the places that $PLATFORM would match, +.\" look at the output of the following: +.\" +.\" mkdir /tmp/d +.\" LD_LIBRARY_PATH=/tmp/d strace -e open /bin/date 2>&1 | grep /tmp/d +.\" +.\" ld.so lets names be abbreviated, so $O will work for $ORIGIN; +.\" Don't do this!! +.PP +Note that the dynamic string tokens have to be quoted properly when +set from a shell, +to prevent their expansion as shell or environment variables. +.SH OPTIONS +.TP +.BR \-\-argv0 " \fIstring\fP (since glibc 2.33)" +Set +.I argv[0] +to the value +.I string +before running the program. +.TP +.BI \-\-audit " list" +Use objects named in +.I list +as auditors. +The objects in +.I list +are delimited by colons. +.TP +.B \-\-inhibit\-cache +Do not use +.IR /etc/ld.so.cache . +.TP +.BI \-\-library\-path " path" +Use +.I path +instead of +.B LD_LIBRARY_PATH +environment variable setting (see below). +The names +.IR ORIGIN , +.IR LIB , +and +.I PLATFORM +are interpreted as for the +.B LD_LIBRARY_PATH +environment variable. +.TP +.BI \-\-inhibit\-rpath " list" +Ignore RPATH and RUNPATH information in object names in +.IR list . +This option is ignored when running in secure-execution mode (see below). +The objects in +.I list +are delimited by colons or spaces. +.TP +.B \-\-list +List all dependencies and how they are resolved. +.TP +.BR \-\-list\-tunables " (since glibc 2.33)" +Print the names and values of all tunables, +along with the minimum and maximum allowed values. +.TP +.BR \-\-preload " \fIlist\fP (since glibc 2.30)" +Preload the objects specified in +.IR list . +The objects in +.I list +are delimited by colons or spaces. +The objects are preloaded as explained in the description of the +.B LD_PRELOAD +environment variable below. +.IP +By contrast with +.BR LD_PRELOAD , +the +.B \-\-preload +option provides a way to perform preloading for a single executable +without affecting preloading performed in any child process that executes +a new program. +.TP +.B \-\-verify +Verify that program is dynamically linked and this dynamic linker can handle +it. +.SH ENVIRONMENT +Various environment variables influence the operation of the dynamic linker. +.\" +.SS Secure-execution mode +For security reasons, +if the dynamic linker determines that a binary should be +run in secure-execution mode, +the effects of some environment variables are voided or modified, +and furthermore those environment variables are stripped from the environment, +so that the program does not even see the definitions. +Some of these environment variables affect the operation of +the dynamic linker itself, and are described below. +Other environment variables treated in this way include: +.BR GCONV_PATH , +.BR GETCONF_DIR , +.BR HOSTALIASES , +.BR LOCALDOMAIN , +.BR LOCPATH , +.BR MALLOC_TRACE , +.BR NIS_PATH , +.BR NLSPATH , +.BR RESOLV_HOST_CONF , +.BR RES_OPTIONS , +.BR TMPDIR , +and +.BR TZDIR . +.PP +A binary is executed in secure-execution mode if the +.B AT_SECURE +entry in the auxiliary vector (see +.BR getauxval (3)) +has a nonzero value. +This entry may have a nonzero value for various reasons, including: +.IP \[bu] 3 +The process's real and effective user IDs differ, +or the real and effective group IDs differ. +This typically occurs as a result of executing +a set-user-ID or set-group-ID program. +.IP \[bu] +A process with a non-root user ID executed a binary that +conferred capabilities to the process. +.IP \[bu] +A nonzero value may have been set by a Linux Security Module. +.\" +.SS Environment variables +Among the more important environment variables are the following: +.TP +.BR LD_ASSUME_KERNEL " (since glibc 2.2.3)" +Each shared object can inform the dynamic linker of the minimum kernel ABI +version that it requires. +(This requirement is encoded in an ELF note section that is viewable via +.I readelf\~\-n +as a section labeled +.BR NT_GNU_ABI_TAG .) +At run time, +the dynamic linker determines the ABI version of the running kernel and +will reject loading shared objects that specify minimum ABI versions +that exceed that ABI version. +.IP +.B LD_ASSUME_KERNEL +can be used to +cause the dynamic linker to assume that it is running on a system with +a different kernel ABI version. +For example, the following command line causes the +dynamic linker to assume it is running on Linux 2.2.5 when loading +the shared objects required by +.IR myprog : +.IP +.in +4n +.EX +$ \fBLD_ASSUME_KERNEL=2.2.5 ./myprog\fP +.EE +.in +.IP +On systems that provide multiple versions of a shared object +(in different directories in the search path) that have +different minimum kernel ABI version requirements, +.B LD_ASSUME_KERNEL +can be used to select the version of the object that is used +(dependent on the directory search order). +.IP +Historically, the most common use of the +.B LD_ASSUME_KERNEL +feature was to manually select the older +LinuxThreads POSIX threads implementation on systems that provided both +LinuxThreads and NPTL +(which latter was typically the default on such systems); +see +.BR pthreads (7). +.TP +.BR LD_BIND_NOW " (since glibc 2.1.1)" +If set to a nonempty string, +causes the dynamic linker to resolve all symbols +at program startup instead of deferring function call resolution to the point +when they are first referenced. +This is useful when using a debugger. +.TP +.B LD_LIBRARY_PATH +A list of directories in which to search for +ELF libraries at execution time. +The items in the list are separated by either colons or semicolons, +and there is no support for escaping either separator. +A zero-length directory name indicates the current working directory. +.IP +This variable is ignored in secure-execution mode. +.IP +Within the pathnames specified in +.BR LD_LIBRARY_PATH , +the dynamic linker expands the tokens +.IR $ORIGIN , +.IR $LIB , +and +.I $PLATFORM +(or the versions using curly braces around the names) +as described above in +.IR "Dynamic string tokens" . +Thus, for example, +the following would cause a library to be searched for in either the +.I lib +or +.I lib64 +subdirectory below the directory containing the program to be executed: +.IP +.in +4n +.EX +$ \fBLD_LIBRARY_PATH=\[aq]$ORIGIN/$LIB\[aq] prog\fP +.EE +.in +.IP +(Note the use of single quotes, which prevent expansion of +.I $ORIGIN +and +.I $LIB +as shell variables!) +.TP +.B LD_PRELOAD +A list of additional, user-specified, ELF shared +objects to be loaded before all others. +This feature can be used to selectively override functions +in other shared objects. +.IP +The items of the list can be separated by spaces or colons, +and there is no support for escaping either separator. +The objects are searched for using the rules given under DESCRIPTION. +Objects are searched for and added to the link map in the left-to-right +order specified in the list. +.IP +In secure-execution mode, +preload pathnames containing slashes are ignored. +Furthermore, shared objects are preloaded only +from the standard search directories and only +if they have set-user-ID mode bit enabled (which is not typical). +.IP +Within the names specified in the +.B LD_PRELOAD +list, the dynamic linker understands the tokens +.IR $ORIGIN , +.IR $LIB , +and +.I $PLATFORM +(or the versions using curly braces around the names) +as described above in +.IR "Dynamic string tokens" . +(See also the discussion of quoting under the description of +.BR LD_LIBRARY_PATH .) +.\" Tested with the following: +.\" +.\" LD_PRELOAD='$LIB/libmod.so' LD_LIBRARY_PATH=. ./prog +.\" +.\" which will preload the libmod.so in 'lib' or 'lib64', using it +.\" in preference to the version in '.'. +.IP +There are various methods of specifying libraries to be preloaded, +and these are handled in the following order: +.RS +.IP (1) 5 +The +.B LD_PRELOAD +environment variable. +.IP (2) +The +.B \-\-preload +command-line option when invoking the dynamic linker directly. +.IP (3) +The +.I /etc/ld.so.preload +file (described below). +.RE +.TP +.B LD_TRACE_LOADED_OBJECTS +If set (to any value), causes the program to list its dynamic +dependencies, as if run by +.BR ldd (1), +instead of running normally. +.PP +Then there are lots of more or less obscure variables, +many obsolete or only for internal use. +.TP +.BR LD_AUDIT " (since glibc 2.4)" +A list of user-specified, ELF shared objects +to be loaded before all others in a separate linker namespace +(i.e., one that does not intrude upon the normal symbol bindings that +would occur in the process) +These objects can be used to audit the operation of the dynamic linker. +The items in the list are colon-separated, +and there is no support for escaping the separator. +.IP +.B LD_AUDIT +is ignored in secure-execution mode. +.IP +The dynamic linker will notify the audit +shared objects at so-called auditing checkpoints\[em]for example, +loading a new shared object, resolving a symbol, +or calling a symbol from another shared object\[em]by +calling an appropriate function within the audit shared object. +For details, see +.BR rtld\-audit (7). +The auditing interface is largely compatible with that provided on Solaris, +as described in its +.IR "Linker and Libraries Guide" , +in the chapter +.IR "Runtime Linker Auditing Interface" . +.IP +Within the names specified in the +.B LD_AUDIT +list, the dynamic linker understands the tokens +.IR $ORIGIN , +.IR $LIB , +and +.I $PLATFORM +(or the versions using curly braces around the names) +as described above in +.IR "Dynamic string tokens" . +(See also the discussion of quoting under the description of +.BR LD_LIBRARY_PATH .) +.IP +Since glibc 2.13, +.\" commit 8e9f92e9d5d7737afdacf79b76d98c4c42980508 +in secure-execution mode, +names in the audit list that contain slashes are ignored, +and only shared objects in the standard search directories that +have the set-user-ID mode bit enabled are loaded. +.TP +.BR LD_BIND_NOT " (since glibc 2.1.95)" +If this environment variable is set to a nonempty string, +do not update the GOT (global offset table) and PLT (procedure linkage table) +after resolving a function symbol. +By combining the use of this variable with +.B LD_DEBUG +(with the categories +.I bindings +and +.IR symbols ), +one can observe all run-time function bindings. +.TP +.BR LD_DEBUG " (since glibc 2.1)" +Output verbose debugging information about operation of the dynamic linker. +The content of this variable is one of more of the following categories, +separated by colons, commas, or (if the value is quoted) spaces: +.RS +.TP 12 +.I help +Specifying +.I help +in the value of this variable does not run the specified program, +and displays a help message about which categories can be specified in this +environment variable. +.TP +.I all +Print all debugging information (except +.I statistics +and +.IR unused ; +see below). +.TP +.I bindings +Display information about which definition each symbol is bound to. +.TP +.I files +Display progress for input file. +.TP +.I libs +Display library search paths. +.TP +.I reloc +Display relocation processing. +.TP +.I scopes +Display scope information. +.TP +.I statistics +Display relocation statistics. +.TP +.I symbols +Display search paths for each symbol look-up. +.TP +.I unused +Determine unused DSOs. +.TP +.I versions +Display version dependencies. +.RE +.IP +Since glibc 2.3.4, +.B LD_DEBUG +is ignored in secure-execution mode, unless the file +.I /etc/suid\-debug +exists (the content of the file is irrelevant). +.TP +.BR LD_DEBUG_OUTPUT " (since glibc 2.1)" +By default, +.B LD_DEBUG +output is written to standard error. +If +.B LD_DEBUG_OUTPUT +is defined, then output is written to the pathname specified by its value, +with the suffix "." (dot) followed by the process ID appended to the pathname. +.IP +.B LD_DEBUG_OUTPUT +is ignored in secure-execution mode. +.TP +.BR LD_DYNAMIC_WEAK " (since glibc 2.1.91)" +By default, when searching shared libraries to resolve a symbol reference, +the dynamic linker will resolve to the first definition it finds. +.IP +Old glibc versions (before glibc 2.2), provided a different behavior: +if the linker found a symbol that was weak, +it would remember that symbol and +keep searching in the remaining shared libraries. +If it subsequently found a strong definition of the same symbol, +then it would instead use that definition. +(If no further symbol was found, +then the dynamic linker would use the weak symbol that it initially found.) +.IP +The old glibc behavior was nonstandard. +(Standard practice is that the distinction between +weak and strong symbols should have effect only at static link time.) +In glibc 2.2, +.\" More precisely 2.1.92 +.\" See weak handling +.\" https://www.sourceware.org/ml/libc-hacker/2000-06/msg00029.html +.\" To: GNU libc hacker <libc-hacker at sourceware dot cygnus dot com> +.\" Subject: weak handling +.\" From: Ulrich Drepper <drepper at redhat dot com> +.\" Date: 07 Jun 2000 20:08:12 -0700 +.\" Reply-To: drepper at cygnus dot com (Ulrich Drepper) +the dynamic linker was modified to provide the current behavior +(which was the behavior that was provided by most other implementations +at that time). +.IP +Defining the +.B LD_DYNAMIC_WEAK +environment variable (with any value) provides +the old (nonstandard) glibc behavior, +whereby a weak symbol in one shared library may be overridden by +a strong symbol subsequently discovered in another shared library. +(Note that even when this variable is set, +a strong symbol in a shared library will not override +a weak definition of the same symbol in the main program.) +.IP +Since glibc 2.3.4, +.B LD_DYNAMIC_WEAK +is ignored in secure-execution mode. +.TP +.BR LD_HWCAP_MASK " (since glibc 2.1)" +Mask for hardware capabilities. +.TP +.BR LD_ORIGIN_PATH " (since glibc 2.1)" +Path where the binary is found. +.\" Used only if $ORIGIN can't be determined by normal means +.\" (from the origin path saved at load time, or from /proc/self/exe)? +.IP +Since glibc 2.4, +.B LD_ORIGIN_PATH +is ignored in secure-execution mode. +.TP +.BR LD_POINTER_GUARD " (from glibc 2.4 to glibc 2.22)" +Set to 0 to disable pointer guarding. +Any other value enables pointer guarding, which is also the default. +Pointer guarding is a security mechanism whereby some pointers to code +stored in writable program memory (return addresses saved by +.BR setjmp (3) +or function pointers used by various glibc internals) are mangled +semi-randomly to make it more difficult for an attacker to hijack +the pointers for use in the event of a buffer overrun or +stack-smashing attack. +Since glibc 2.23, +.\" commit a014cecd82b71b70a6a843e250e06b541ad524f7 +.B LD_POINTER_GUARD +can no longer be used to disable pointer guarding, +which is now always enabled. +.TP +.BR LD_PROFILE " (since glibc 2.1)" +The name of a (single) shared object to be profiled, +specified either as a pathname or a soname. +Profiling output is appended to the file whose name is: +"\fI$LD_PROFILE_OUTPUT\fP/\fI$LD_PROFILE\fP.profile". +.IP +Since glibc 2.2.5, +.B LD_PROFILE +is ignored in secure-execution mode. +.TP +.BR LD_PROFILE_OUTPUT " (since glibc 2.1)" +Directory where +.B LD_PROFILE +output should be written. +If this variable is not defined, or is defined as an empty string, +then the default is +.IR /var/tmp . +.IP +.B LD_PROFILE_OUTPUT +is ignored in secure-execution mode; instead +.I /var/profile +is always used. +(This detail is relevant only before glibc 2.2.5, +since in later glibc versions, +.B LD_PROFILE +is also ignored in secure-execution mode.) +.TP +.BR LD_SHOW_AUXV " (since glibc 2.1)" +If this environment variable is defined (with any value), +show the auxiliary array passed up from the kernel (see also +.BR getauxval (3)). +.IP +Since glibc 2.3.4, +.B LD_SHOW_AUXV +is ignored in secure-execution mode. +.TP +.BR LD_TRACE_PRELINKING " (since glibc 2.4)" +If this environment variable is defined, +trace prelinking of the object whose name is assigned to +this environment variable. +(Use +.BR ldd (1) +to get a list of the objects that might be traced.) +If the object name is not recognized, +.\" (This is what seems to happen, from experimenting) +then all prelinking activity is traced. +.TP +.BR LD_USE_LOAD_BIAS " (since glibc 2.3.3)" +.\" http://sources.redhat.com/ml/libc-hacker/2003-11/msg00127.html +.\" Subject: [PATCH] Support LD_USE_LOAD_BIAS +.\" Jakub Jelinek +By default (i.e., if this variable is not defined), +executables and prelinked +shared objects will honor base addresses of their dependent shared objects +and (nonprelinked) position-independent executables (PIEs) +and other shared objects will not honor them. +If +.B LD_USE_LOAD_BIAS +is defined with the value 1, both executables and PIEs +will honor the base addresses. +If +.B LD_USE_LOAD_BIAS +is defined with the value 0, +neither executables nor PIEs will honor the base addresses. +.IP +Since glibc 2.3.3, this variable is ignored in secure-execution mode. +.TP +.BR LD_VERBOSE " (since glibc 2.1)" +If set to a nonempty string, +output symbol versioning information about the +program if the +.B LD_TRACE_LOADED_OBJECTS +environment variable has been set. +.TP +.BR LD_WARN " (since glibc 2.1.3)" +If set to a nonempty string, warn about unresolved symbols. +.TP +.BR LD_PREFER_MAP_32BIT_EXEC " (x86-64 only; since glibc 2.23)" +According to the Intel Silvermont software optimization guide, for 64-bit +applications, branch prediction performance can be negatively impacted +when the target of a branch is more than 4\ GB away from the branch. +If this environment variable is set (to any value), +the dynamic linker +will first try to map executable pages using the +.BR mmap (2) +.B MAP_32BIT +flag, and fall back to mapping without that flag if that attempt fails. +NB: MAP_32BIT will map to the low 2\ GB (not 4\ GB) of the address space. +.IP +Because +.B MAP_32BIT +reduces the address range available for address space layout +randomization (ASLR), +.B LD_PREFER_MAP_32BIT_EXEC +is always disabled in secure-execution mode. +.SH FILES +.TP +.I /lib/ld.so +a.out dynamic linker/loader +.TP +.IR /lib/ld\-linux.so. { 1 , 2 } +ELF dynamic linker/loader +.TP +.I /etc/ld.so.cache +File containing a compiled list of directories in which to search for +shared objects and an ordered list of candidate shared objects. +See +.BR ldconfig (8). +.TP +.I /etc/ld.so.preload +File containing a whitespace-separated list of ELF shared objects to +be loaded before the program. +See the discussion of +.B LD_PRELOAD +above. +If both +.B LD_PRELOAD +and +.I /etc/ld.so.preload +are employed, the libraries specified by +.B LD_PRELOAD +are preloaded first. +.I /etc/ld.so.preload +has a system-wide effect, +causing the specified libraries to be preloaded for +all programs that are executed on the system. +(This is usually undesirable, +and is typically employed only as an emergency remedy, for example, +as a temporary workaround to a library misconfiguration issue.) +.TP +.I lib*.so* +shared objects +.SH NOTES +.SS Hardware capabilities +Some shared objects are compiled using hardware-specific instructions which do +not exist on every CPU. +Such objects should be installed in directories whose names define the +required hardware capabilities, such as +.IR /usr/lib/sse2/ . +The dynamic linker checks these directories against the hardware of the +machine and selects the most suitable version of a given shared object. +Hardware capability directories can be cascaded to combine CPU features. +The list of supported hardware capability names depends on the CPU. +The following names are currently recognized: +.\" Presumably, this info comes from sysdeps/i386/dl-procinfo.c and +.\" similar files +.TP +.B Alpha +ev4, ev5, ev56, ev6, ev67 +.TP +.B MIPS +loongson2e, loongson2f, octeon, octeon2 +.TP +.B PowerPC +4xxmac, altivec, arch_2_05, arch_2_06, booke, cellbe, dfp, efpdouble, efpsingle, +fpu, ic_snoop, mmu, notb, pa6t, power4, power5, power5+, power6x, ppc32, ppc601, +ppc64, smt, spe, ucache, vsx +.TP +.B SPARC +flush, muldiv, stbar, swap, ultra3, v9, v9v, v9v2 +.TP +.B s390 +dfp, eimm, esan3, etf3enh, g5, highgprs, hpage, ldisp, msa, stfle, +z900, z990, z9-109, z10, zarch +.TP +.B x86 (32-bit only) +acpi, apic, clflush, cmov, cx8, dts, fxsr, ht, i386, i486, i586, i686, mca, mmx, +mtrr, pat, pbe, pge, pn, pse36, sep, ss, sse, sse2, tm +.SH SEE ALSO +.BR ld (1), +.BR ldd (1), +.BR pldd (1), +.BR sprof (1), +.BR dlopen (3), +.BR getauxval (3), +.BR elf (5), +.BR capabilities (7), +.BR rtld\-audit (7), +.BR ldconfig (8), +.BR sln (8) +.\" .SH AUTHORS +.\" ld.so: David Engel, Eric Youngdale, Peter MacDonald, Hongjiu Lu, Linus +.\" Torvalds, Lars Wirzenius and Mitch D'Souza +.\" ld\-linux.so: Roland McGrath, Ulrich Drepper and others. +.\" +.\" In the above, (libc5) stands for David Engel's ld.so/ld\-linux.so. diff --git a/upstream/opensuse-leap-15-6/man8/ldattach.8 b/upstream/opensuse-leap-15-6/man8/ldattach.8 new file mode 100644 index 00000000..0fbbcae1 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/ldattach.8 @@ -0,0 +1,198 @@ +'\" t +.\" Title: ldattach +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "LDATTACH" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +ldattach \- attach a line discipline to a serial line +.SH "SYNOPSIS" +.sp +\fBldattach\fP [\fB\-1278denoVh\fP] [\fB\-i\fP \fIiflag\fP] [\fB\-s\fP \fIspeed\fP] \fIldisc device\fP +.SH "DESCRIPTION" +.sp +The \fBldattach\fP daemon opens the specified \fIdevice\fP file (which should refer to a serial device) and attaches the line discipline \fIldisc\fP to it for processing of the sent and/or received data. It then goes into the background keeping the device open so that the line discipline stays loaded. +.sp +The line discipline \fIldisc\fP may be specified either by name or by number. +.sp +In order to detach the line discipline, \fBkill\fP(1) the \fBldattach\fP process. +.sp +With no arguments, \fBldattach\fP prints usage information. +.SH "LINE DISCIPLINES" +.sp +Depending on the kernel release, the following line disciplines are supported: +.sp +\fBTTY\fP(\fB0\fP) +.RS 4 +The default line discipline, providing transparent operation (raw mode) as well as the habitual terminal line editing capabilities (cooked mode). +.RE +.sp +\fBSLIP\fP(\fB1\fP) +.RS 4 +Serial Line IP (SLIP) protocol processor for transmitting TCP/IP packets over serial lines. +.RE +.sp +\fBMOUSE\fP(\fB2\fP) +.RS 4 +Device driver for RS232 connected pointing devices (serial mice). +.RE +.sp +\fBPPP\fP(\fB3\fP) +.RS 4 +Point to Point Protocol (PPP) processor for transmitting network packets over serial lines. +.RE +.sp +\fBSTRIP\fP(\fB4\fP); \fBAX25\fP(\fB5\fP); \fBX25\fP(\fB6\fP) +.RS 4 +Line driver for transmitting X.25 packets over asynchronous serial lines. +.RE +.sp +\fB6PACK\fP(\fB7\fP); \fBR3964\fP(\fB9\fP) +.RS 4 +Driver for Simatic R3964 module. +.RE +.sp +\fBIRDA\fP(\fB11\fP) +.RS 4 +Linux IrDa (infrared data transmission) driver \- see \c +.URL "http://irda.sourceforge.net/" "" "" +.RE +.sp +\fBHDLC\fP(\fB13\fP) +.RS 4 +Synchronous HDLC driver. +.RE +.sp +\fBSYNC_PPP\fP(\fB14\fP) +.RS 4 +Synchronous PPP driver. +.RE +.sp +\fBHCI\fP(\fB15\fP) +.RS 4 +Bluetooth HCI UART driver. +.RE +.sp +\fBGIGASET_M101\fP(\fB16\fP) +.RS 4 +Driver for Siemens Gigaset M101 serial DECT adapter. +.RE +.sp +\fBPPS\fP(\fB18\fP) +.RS 4 +Driver for serial line Pulse Per Second (PPS) source. +.RE +.sp +\fBGSM0710\fP(\fB21\fP) +.RS 4 +Driver for GSM 07.10 multiplexing protocol modem (CMUX). +.RE +.SH "OPTIONS" +.sp +\fB\-1\fP, \fB\-\-onestopbit\fP +.RS 4 +Set the number of stop bits of the serial line to one. +.RE +.sp +\fB\-2\fP, \fB\-\-twostopbits\fP +.RS 4 +Set the number of stop bits of the serial line to two. +.RE +.sp +\fB\-7\fP, \fB\-\-sevenbits\fP +.RS 4 +Set the character size of the serial line to 7 bits. +.RE +.sp +\fB\-8\fP, \fB\-\-eightbits\fP +.RS 4 +Set the character size of the serial line to 8 bits. +.RE +.sp +\fB\-d\fP, \fB\-\-debug\fP +.RS 4 +Keep \fBldattach\fP in the foreground so that it can be interrupted or debugged, and to print verbose messages about its progress to standard error output. +.RE +.sp +\fB\-e\fP, \fB\-\-evenparity\fP +.RS 4 +Set the parity of the serial line to even. +.RE +.sp +\fB\-i\fP, \fB\-\-iflag\fP \fIvalue\fP... +.RS 4 +Set the specified bits in the c_iflag word of the serial line. The given \fIvalue\fP may be a number or a symbolic name. If \fIvalue\fP is prefixed by a minus sign, the specified bits are cleared instead. Several comma\-separated values may be given in order to set and clear multiple bits. +.RE +.sp +\fB\-n\fP, \fB\-\-noparity\fP +.RS 4 +Set the parity of the serial line to none. +.RE +.sp +\fB\-o\fP, \fB\-\-oddparity\fP +.RS 4 +Set the parity of the serial line to odd. +.RE +.sp +\fB\-s\fP, \fB\-\-speed\fP \fIvalue\fP +.RS 4 +Set the speed (the baud rate) of the serial line to the specified \fIvalue\fP. +.RE +.sp +\fB\-c\fP, \fB\-\-intro\-command\fP \fIstring\fP +.RS 4 +Define an intro command that is sent through the serial line before the invocation of ldattach. E.g. in conjunction with line discipline GSM0710, the command \(aqAT+CMUX=0\(rsr\(aq is commonly suitable to switch the modem into the CMUX mode. +.RE +.sp +\fB\-p\fP, \fB\-\-pause\fP \fIvalue\fP +.RS 4 +Sleep for \fIvalue\fP seconds before the invocation of ldattach. Default is one second. +.RE +.sp +\fB\-V\fP, \fB\-\-version\fP +.RS 4 +Display version information and exit. +.RE +.sp +\fB\-h\fP, \fB\-\-help\fP +.RS 4 +Display help text and exit. +.RE +.SH "AUTHORS" +.sp +.MTO "tilman\(atimap.cc" "Tilman Schmidt" "" +.SH "SEE ALSO" +.sp +\fBinputattach\fP(1), +\fBttys\fP(4) +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBldattach\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/ldconfig.8 b/upstream/opensuse-leap-15-6/man8/ldconfig.8 new file mode 100644 index 00000000..2e00e4b2 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/ldconfig.8 @@ -0,0 +1,204 @@ +.\" Copyright 1999 SuSE GmbH Nuernberg, Germany +.\" Author: Thorsten Kukuk <kukuk@suse.de> +.\" +.\" SPDX-License-Identifier: GPL-2.0-or-later +.\" +.\" Modified, 6 May 2002, Michael Kerrisk, <mtk.manpages@gmail.com> +.\" Change listed order of /usr/lib and /lib +.TH ldconfig 8 2023-03-11 "Linux man-pages 6.04" +.SH NAME +ldconfig \- configure dynamic linker run-time bindings +.SH SYNOPSIS +.SY /sbin/ldconfig +.\" TODO?: -c, --format, -i, --ignore-aux-cache, --print-cache, +.\" --verbose, -V, --version, -?, --help, --usage +.RB [ \-nNvVX ] +.RB [ \-C\~\c +.IR cache ] +.RB [ \-f\~\c +.IR conf ] +.RB [ \-r\~\c +.IR root ] +.IR directory \~.\|.\|. +.YS +.SY /sbin/ldconfig +.B \-l +.RB [ \-v ] +.IR library \~.\|.\|. +.YS +.SY /sbin/ldconfig +.B \-p +.YS +.SH DESCRIPTION +.B \%ldconfig +creates the necessary links and cache to the most recent shared +libraries found in the directories specified on the command line, +in the file +.IR /etc/ld.so.conf , +and in the trusted directories, +.I /lib +and +.IR /usr/lib . +On some 64-bit architectures such as x86-64, +.I /lib +and +.I /usr/lib +are the trusted directories for 32-bit libraries, +while +.I /lib64 +and +.I /usr/lib64 +are used for 64-bit libraries. +.PP +The cache is used by the run-time linker, +.I ld.so +or +.IR ld\-linux.so . +.B \%ldconfig +checks the header and filenames of the libraries it encounters when +determining which versions should have their links updated. +.\" Support for libc4 and libc5 dropped in +.\" 8ee878592c4a642937152c8308b8faef86bcfc40 (2022-07-14) as "obsolete +.\" for over twenty years". +.B \%ldconfig +should normally be run by the superuser as it may require write +permission on some root owned directories and files. +.PP +.B \%ldconfig +will look only at files that are named +.I lib*.so* +(for regular shared objects) or +.I ld\-*.so* +(for the dynamic loader itself). +Other files will be ignored. +Also, +.B \%ldconfig +expects a certain pattern to how the symbolic links are set up, +like this example, +where the middle file +.RB ( libfoo.so.1 +here) is the SONAME for the library: +.PP +.in +4n +.EX +libfoo.so \-> libfoo.so.1 \-> libfoo.so.1.12 +.EE +.in +.PP +Failure to follow this pattern may result in compatibility issues +after an upgrade. +.SH OPTIONS +.TP +.BI \-c\~ fmt +.TQ +.BI \-\-format= fmt +(Since glibc 2.2) +.\" commit 45eca4d141c047950db48c69c8941163d0a61fcd +Use cache format +.IR fmt , +which is one of +.BR old , +.BR new , +or +.BR \%compat . +Since glibc 2.32, +the default is +.BR new . +.\" commit cad64f778aced84efdaa04ae64f8737b86f063ab +Before that, +it was +.BR \%compat . +.TP +.BI \-C\~ cache +Use +.I cache +instead of +.IR /etc/ld.so.cache . +.TP +.BI \-f\~ conf +Use +.I conf +instead of +.IR /etc/ld.so.conf . +.TP +.B \-i +.TQ +.B \-\-ignore\-aux\-cache +(Since glibc 2.7) +.\" commit 27d9ffda17df4d2388687afd12897774fde39bcc +Ignore auxiliary cache file. +.TP +.B \-l +(Since glibc 2.2) +Interpret each operand as a library name and configure its links. +Intended for use only by experts. +.TP +.B \-n +Process only the directories specified on the command line; +don't process the trusted directories, +nor those specified in +.IR /etc/ld.so.conf . +Implies +.BR \-N . +.TP +.B \-N +Don't rebuild the cache. +Unless +.B \-X +is also specified, +links are still updated. +.TP +.B \-p +.TQ +.B \-\-print\-cache +Print the lists of directories and candidate libraries stored in +the current cache. +.TP +.BI \-r\~ root +Change to and use +.I root +as the root directory. +.TP +.B \-v +.TQ +.B \-\-verbose +Verbose mode. +Print current version number, +the name of each directory as it is scanned, +and any links that are created. +Overrides quiet mode. +.TP +.B \-V +.TQ +.B \-\-version +Print program version. +.TP +.B \-X +Don't update links. +Unless +.B \-N +is also specified, +the cache is still rebuilt. +.SH FILES +.\" FIXME Since glibc-2.3.4, "include" directives are supported in ld.so.conf +.\" +.\" FIXME Since glibc-2.4, "hwcap" directives are supported in ld.so.conf +.PD 0 +.TP +.I /lib/ld.so +is the run-time linker/loader. +.TP +.I /etc/ld.so.conf +contains a list of directories, +one per line, +in which to search for libraries. +.TP +.I /etc/ld.so.cache +contains an ordered list of libraries found in the directories +specified in +.IR /etc/ld.so.conf , +as well as those found in the trusted directories. +.PD +.SH SEE ALSO +.BR ldd (1), +.BR ld.so (8) diff --git a/upstream/opensuse-leap-15-6/man8/loadunimap.8 b/upstream/opensuse-leap-15-6/man8/loadunimap.8 new file mode 100644 index 00000000..4571ab02 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/loadunimap.8 @@ -0,0 +1,58 @@ +.\" @(#)loadunimap.8 1.0 970317 aeb +.TH LOADUNIMAP 8 "2004-01-01" "kbd" +.SH NAME +loadunimap \- load the kernel unicode-to-font mapping table +.SH SYNOPSIS +.B loadunimap +[ +.B \-C +.I console +] [ +.B \-o +.I oldmap +] [ +.I map +] +.SH DESCRIPTION +The +.B loadunimap +command is obsolete - its function is now built-in into +.BR setfont (8). +However, for backwards compatibility it is still available +as a separate command. +.LP +The program +.B loadunimap +loads the specified map in the kernel unicode-to-font mapping table. +If no map is given +.I def +mapping table is assumed. +The default extension (that can be omitted) is +.IR .uni . +.LP +If the +.B -o +.I oldmap +option is given, the old map is saved in the file specified. +.LP +On Linux 2.6.1 and later one can specify the console device using the +.B \-C +option. +.LP +Usually one does not call +.B loadunimap +directly - its function is also built into +.BR setfont (8). +.SH FILES +.TP +.I /usr/share/kbd/unimaps +The default directory for unicode mappings. +.LP +.TP +.I /usr/share/kbd/unimaps/def.uni +The default mapping file. +.LP +.SH "SEE ALSO" +.BR mapscrn (8), +.BR setfont (8) + diff --git a/upstream/opensuse-leap-15-6/man8/logsave.8 b/upstream/opensuse-leap-15-6/man8/logsave.8 new file mode 100644 index 00000000..76536731 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/logsave.8 @@ -0,0 +1,61 @@ +.\" -*- nroff -*- +.\" Copyright 2003 by Theodore Ts'o. All Rights Reserved. +.\" This file may be copied under the terms of the GNU Public License. +.\" +.TH LOGSAVE 8 "February 2023" "E2fsprogs version 1.47.0" +.SH NAME +logsave \- save the output of a command in a logfile +.SH SYNOPSIS +.B logsave +[ +.B \-asv +] +.I logfile cmd_prog [ ... ] +.SH DESCRIPTION +The +.B logsave +program will execute +.I cmd_prog +with the specified argument(s), and save a copy of its output to +.IR logfile . +If the containing directory for +.I logfile +does not exist, +.B logsave +will accumulate the output in memory until it can be written out. +A copy of the output will also be written to standard output. +.PP +If +.I cmd_prog +is a single hyphen ('-'), then instead of executing a program, +.B logsave +will take its input from standard input and save it in +.I logfile +.PP +.B logsave +is useful for saving the output of initial boot scripts +until the /var partition is mounted, so the output can be written to +/var/log. +.SH OPTIONS +.TP +.B \-a +This option will cause the output to be appended to +.IR logfile , +instead of replacing its current contents. +.TP +.B \-s +This option will cause +.B logsave +to skip writing to the log file text which is bracketed with a control-A +(ASCII 001 or Start of Header) and control-B (ASCII 002 or Start of +Text). This allows progress bar information to be visible to the user +on the console, while not being written to the log file. +.TP +.B \-v +This option will make +.B logsave +to be more verbose in its output to the user. +.SH AUTHOR +Theodore Ts'o (tytso@mit.edu) +.SH SEE ALSO +.BR fsck (8) diff --git a/upstream/opensuse-leap-15-6/man8/losetup.8 b/upstream/opensuse-leap-15-6/man8/losetup.8 new file mode 100644 index 00000000..c75f3aac --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/losetup.8 @@ -0,0 +1,240 @@ +'\" t +.\" Title: losetup +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "LOSETUP" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +losetup \- set up and control loop devices +.SH "SYNOPSIS" +.sp +Get info: +.sp +\fBlosetup\fP [\fIloopdev\fP] +.sp +\fBlosetup\fP \fB\-l\fP [\fB\-a\fP] +.sp +\fBlosetup\fP \fB\-j\fP \fIfile\fP [\fB\-o\fP \fIoffset\fP] +.sp +Detach a loop device: +.sp +\fBlosetup\fP \fB\-d\fP \fIloopdev\fP ... +.sp +Detach all associated loop devices: +.sp +\fBlosetup\fP \fB\-D\fP +.sp +Set up a loop device: +.sp +\fBlosetup\fP [\fB\-o\fP \fIoffset\fP] [\fB\-\-sizelimit\fP \fIsize\fP] [\fB\-\-sector\-size\fP \fIsize\fP] [\fB\-Pr\fP] [\fB\-\-show\fP] \fB\-f\fP \fIloopdev file\fP +.sp +Resize a loop device: +.sp +\fBlosetup\fP \fB\-c\fP \fIloopdev\fP +.SH "DESCRIPTION" +.sp +\fBlosetup\fP is used to associate loop devices with regular files or block devices, to detach loop devices, and to query the status of a loop device. If only the \fIloopdev\fP argument is given, the status of the corresponding loop device is shown. If no option is given, all loop devices are shown. +.sp +Note that the old output format (i.e., \fBlosetup \-a\fP) with comma\-delimited strings is deprecated in favour of the \fB\-\-list\fP output format. +.sp +It\(cqs possible to create more independent loop devices for the same backing file. \fBThis setup may be dangerous, can cause data loss, corruption and overwrites.\fP Use \fB\-\-nooverlap\fP with \fB\-\-find\fP during setup to avoid this problem. +.sp +The loop device setup is not an atomic operation when used with \fB\-\-find\fP, and \fBlosetup\fP does not protect this operation by any lock. The number of attempts is internally restricted to a maximum of 16. It is recommended to use for example flock1 to avoid a collision in heavily parallel use cases. +.SH "OPTIONS" +.sp +The \fIsize\fP and \fIoffset\fP arguments may be followed by the multiplicative suffixes KiB (=1024), MiB (=1024*1024), and so on for GiB, TiB, PiB, EiB, ZiB and YiB (the "iB" is optional, e.g., "K" has the same meaning as "KiB") or the suffixes KB (=1000), MB (=1000*1000), and so on for GB, TB, PB, EB, ZB and YB. +.sp +\fB\-a\fP, \fB\-\-all\fP +.RS 4 +Show the status of all loop devices. Note that not all information is accessible for non\-root users. See also \fB\-\-list\fP. The old output format (as printed without \fB\-\-list)\fP is deprecated. +.RE +.sp +\fB\-d\fP, \fB\-\-detach\fP \fIloopdev\fP... +.RS 4 +Detach the file or device associated with the specified loop device(s). Note that since Linux v3.7 kernel uses "lazy device destruction". The detach operation does not return \fBEBUSY\fP error anymore if device is actively used by system, but it is marked by autoclear flag and destroyed later. +.RE +.sp +\fB\-D\fP, \fB\-\-detach\-all\fP +.RS 4 +Detach all associated loop devices. +.RE +.sp +\fB\-f\fP, \fB\-\-find\fP [\fIfile\fP] +.RS 4 +Find the first unused loop device. If a \fIfile\fP argument is present, use the found device as loop device. Otherwise, just print its name. +.RE +.sp +\fB\-\-show\fP +.RS 4 +Display the name of the assigned loop device if the \fB\-f\fP option and a \fIfile\fP argument are present. +.RE +.sp +\fB\-L\fP, \fB\-\-nooverlap\fP +.RS 4 +Check for conflicts between loop devices to avoid situation when the same backing file is shared between more loop devices. If the file is already used by another device then re\-use the device rather than a new one. The option makes sense only with \fB\-\-find\fP. +.RE +.sp +\fB\-j\fP, \fB\-\-associated\fP \fIfile\fP [\fB\-o\fP \fIoffset\fP] +.RS 4 +Show the status of all loop devices associated with the given \fIfile\fP. +.RE +.sp +\fB\-o\fP, \fB\-\-offset\fP \fIoffset\fP +.RS 4 +The data start is moved \fIoffset\fP bytes into the specified file or device. The \fIoffset\fP may be followed by the multiplicative suffixes; see above. +.RE +.sp +\fB\-\-sizelimit\fP \fIsize\fP +.RS 4 +The data end is set to no more than \fIsize\fP bytes after the data start. The \fIsize\fP may be followed by the multiplicative suffixes; see above. +.RE +.sp +\fB\-b\fP, \fB\-\-sector\-size\fP \fIsize\fP +.RS 4 +Set the logical sector size of the loop device in bytes (since Linux 4.14). The option may be used when create a new loop device as well as stand\-alone command to modify sector size of the already existing loop device. +.RE +.sp +\fB\-c\fP, \fB\-\-set\-capacity\fP \fIloopdev\fP +.RS 4 +Force the loop driver to reread the size of the file associated with the specified loop device. +.RE +.sp +\fB\-P\fP, \fB\-\-partscan\fP +.RS 4 +Force the kernel to scan the partition table on a newly created loop device. Note that the partition table parsing depends on sector sizes. The default is sector size is 512 bytes, otherwise you need to use the option \fB\-\-sector\-size\fP together with \fB\-\-partscan\fP. +.RE +.sp +\fB\-r\fP, \fB\-\-read\-only\fP +.RS 4 +Set up a read\-only loop device. +.RE +.sp +\fB\-\-direct\-io\fP[\fB=on\fP|\fBoff\fP] +.RS 4 +Enable or disable direct I/O for the backing file. The optional argument can be either \fBon\fP or \fBoff\fP. If the argument is omitted, it defaults to \fBoff\fP. +.RE +.sp +\fB\-v\fP, \fB\-\-verbose\fP +.RS 4 +Verbose mode. +.RE +.sp +\fB\-l\fP, \fB\-\-list\fP +.RS 4 +If a loop device or the \fB\-a\fP option is specified, print the default columns for either the specified loop device or all loop devices; the default is to print info about all devices. See also \fB\-\-output\fP, \fB\-\-noheadings\fP, \fB\-\-raw\fP, and \fB\-\-json\fP. +.RE +.sp +\fB\-O\fP, \fB\-\-output\fP \fIcolumn\fP[,\fIcolumn\fP]... +.RS 4 +Specify the columns that are to be printed for the \fB\-\-list\fP output. Use \fB\-\-help\fP to get a list of all supported columns. +.RE +.sp +\fB\-\-output\-all\fP +.RS 4 +Output all available columns. +.RE +.sp +\fB\-n\fP, \fB\-\-noheadings\fP +.RS 4 +Don\(cqt print headings for \fB\-\-list\fP output format. +.RE +.sp +\fB\-\-raw\fP +.RS 4 +Use the raw \fB\-\-list\fP output format. +.RE +.sp +\fB\-J\fP, \fB\-\-json\fP +.RS 4 +Use JSON format for \fB\-\-list\fP output. +.RE +.sp +\fB\-V\fP, \fB\-\-version\fP +.RS 4 +Display version information and exit. +.RE +.sp +\fB\-h\fP, \fB\-\-help\fP +.RS 4 +Display help text and exit. +.RE +.SH "ENCRYPTION" +.sp +\fBCryptoloop is no longer supported in favor of dm\-crypt.\fP For more details see \fBcryptsetup\fP(8). +.SH "EXIT STATUS" +.sp +\fBlosetup\fP returns 0 on success, nonzero on failure. When \fBlosetup\fP displays the status of a loop device, it returns 1 if the device is not configured and 2 if an error occurred which prevented determining the status of the device. +.SH "NOTES" +.sp +Since version 2.37 \fBlosetup\fP uses \fBLOOP_CONFIGURE\fP ioctl to setup a new loop device by one ioctl call. The old versions use \fBLOOP_SET_FD\fP and \fBLOOP_SET_STATUS64\fP ioctls to do the same. +.SH "ENVIRONMENT" +.sp +LOOPDEV_DEBUG=all +.RS 4 +enables debug output. +.RE +.SH "FILES" +.sp +\fI/dev/loop[0..N]\fP +.RS 4 +loop block devices +.RE +.sp +\fI/dev/loop\-control\fP +.RS 4 +loop control device +.RE +.SH "EXAMPLE" +.sp +The following commands can be used as an example of using the loop device. +.sp +.if n .RS 4 +.nf +.fam C +# dd if=/dev/zero of=~/file.img bs=1024k count=10 +# losetup \-\-find \-\-show ~/file.img +/dev/loop0 +# mkfs \-t ext2 /dev/loop0 +# mount /dev/loop0 /mnt +\&... +# umount /dev/loop0 +# losetup \-\-detach /dev/loop0 +.fam +.fi +.if n .RE +.SH "AUTHORS" +.sp +.MTO "kzak\(atredhat.com" "Karel Zak" "," +based on the original version from +.MTO "tytso\(atathena.mit.edu" "Theodore Ts\(cqo" "." +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBlosetup\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/lsblk.8 b/upstream/opensuse-leap-15-6/man8/lsblk.8 new file mode 100644 index 00000000..9b51a995 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/lsblk.8 @@ -0,0 +1,266 @@ +'\" t +.\" Title: lsblk +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "LSBLK" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +lsblk \- list block devices +.SH "SYNOPSIS" +.sp +\fBlsblk\fP [options] [\fIdevice\fP...] +.SH "DESCRIPTION" +.sp +\fBlsblk\fP lists information about all available or the specified block devices. The \fBlsblk\fP command reads the \fBsysfs\fP filesystem and \fBudev db\fP to gather information. If the udev db is not available or \fBlsblk\fP is compiled without udev support, then it tries to read LABELs, UUIDs and filesystem types from the block device. In this case root permissions are necessary. +.sp +The command prints all block devices (except RAM disks) in a tree\-like format by default. Use \fBlsblk \-\-help\fP to get a list of all available columns. +.sp +The default output, as well as the default output from options like \fB\-\-fs\fP and \fB\-\-topology\fP, is subject to change. So whenever possible, you should avoid using default outputs in your scripts. Always explicitly define expected columns by using \fB\-\-output\fP \fIcolumns\-list\fP and \fB\-\-list\fP in environments where a stable output is required. +.sp +Note that \fBlsblk\fP might be executed in time when \fBudev\fP does not have all information about recently added or modified devices yet. In this case it is recommended to use \fBudevadm settle\fP before \fBlsblk\fP to synchronize with udev. +.sp +The relationship between block devices and filesystems is not always one\-to\-one. The filesystem may use more block devices, or the same filesystem may be accessible by more paths. This is the reason why \fBlsblk\fP provides MOUNTPOINT and MOUNTPOINTS (pl.) columns. The column MOUNTPOINT displays only one mount point (usually the last mounted instance of the filesystem), and the column MOUNTPOINTS displays by multi\-line cell all mount points associated with the device. +.SH "OPTIONS" +.sp +\fB\-a\fP, \fB\-\-all\fP +.RS 4 +Also list empty devices and RAM disk devices. +.RE +.sp +\fB\-b\fP, \fB\-\-bytes\fP +.RS 4 +Print the SIZE column in bytes rather than in a human\-readable format. +.RE +.sp +\fB\-D\fP, \fB\-\-discard\fP +.RS 4 +Print information about the discarding capabilities (TRIM, UNMAP) for each device. +.RE +.sp +\fB\-d\fP, \fB\-\-nodeps\fP +.RS 4 +Do not print holder devices or slaves. For example, \fBlsblk \-\-nodeps /dev/sda\fP prints information about the sda device only. +.RE +.sp +\fB\-E\fP, \fB\-\-dedup\fP \fIcolumn\fP +.RS 4 +Use \fIcolumn\fP as a de\-duplication key to de\-duplicate output tree. If the key is not available for the device, or the device is a partition and parental whole\-disk device provides the same key than the device is always printed. +.sp +The usual use case is to de\-duplicate output on system multi\-path devices, for example by \fB\-E WWN\fP. +.RE +.sp +\fB\-e\fP, \fB\-\-exclude\fP \fIlist\fP +.RS 4 +Exclude the devices specified by the comma\-separated \fIlist\fP of major device numbers. Note that RAM disks (major=1) are excluded by default if \fB\-\-all\fP is not specified. The filter is applied to the top\-level devices only. This may be confusing for \fB\-\-list\fP output format where hierarchy of the devices is not obvious. +.RE +.sp +\fB\-f\fP, \fB\-\-fs\fP +.RS 4 +Output info about filesystems. This option is equivalent to \fB\-o NAME,FSTYPE,FSVER,LABEL,UUID,FSAVAIL,FSUSE%,MOUNTPOINTS\fP. The authoritative information about filesystems and raids is provided by the \fBblkid\fP(8) command. +.RE +.sp +\fB\-h\fP, \fB\-\-help\fP +.RS 4 +Display help text and exit. +.RE +.sp +\fB\-I\fP, \fB\-\-include\fP \fIlist\fP +.RS 4 +Include devices specified by the comma\-separated \fIlist\fP of major device numbers. The filter is applied to the top\-level devices only. This may be confusing for \fB\-\-list\fP output format where hierarchy of the devices is not obvious. +.RE +.sp +\fB\-i\fP, \fB\-\-ascii\fP +.RS 4 +Use ASCII characters for tree formatting. +.RE +.sp +\fB\-J\fP, \fB\-\-json\fP +.RS 4 +Use JSON output format. It\(cqs strongly recommended to use \fB\-\-output\fP and also \fB\-\-tree\fP if necessary. +.RE +.sp +\fB\-l\fP, \fB\-\-list\fP +.RS 4 +Produce output in the form of a list. The output does not provide information about relationships between devices and since version 2.34 every device is printed only once if \fB\-\-pairs\fP or \fB\-\-raw\fP not specified (the parsable outputs are maintained in backwardly compatible way). +.RE +.sp +\fB\-M\fP, \fB\-\-merge\fP +.RS 4 +Group parents of sub\-trees to provide more readable output for RAIDs and Multi\-path devices. The tree\-like output is required. +.RE +.sp +\fB\-m\fP, \fB\-\-perms\fP +.RS 4 +Output info about device owner, group and mode. This option is equivalent to \fB\-o NAME,SIZE,OWNER,GROUP,MODE\fP. +.RE +.sp +\fB\-n\fP, \fB\-\-noheadings\fP +.RS 4 +Do not print a header line. +.RE +.sp +\fB\-o\fP, \fB\-\-output\fP \fIlist\fP +.RS 4 +Specify which output columns to print. Use \fB\-\-help\fP to get a list of all supported columns. The columns may affect tree\-like output. The default is to use tree for the column \(aqNAME\(aq (see also \fB\-\-tree\fP). +.sp +The default list of columns may be extended if \fIlist\fP is specified in the format \fI+list\fP (e.g., \fBlsblk \-o +UUID\fP). +.RE +.sp +\fB\-O\fP, \fB\-\-output\-all\fP +.RS 4 +Output all available columns. +.RE +.sp +\fB\-P\fP, \fB\-\-pairs\fP +.RS 4 +Produce output in the form of key="value" pairs. The output lines are still ordered by dependencies. All potentially unsafe value characters are hex\-escaped (\(rsx<code>). The key (variable name) will be modified to contain only characters allowed for a shell variable identifiers, for example, MIN_IO and FSUSE_PCT instead of MIN\-IO and FSUSE%. +.RE +.sp +\fB\-p\fP, \fB\-\-paths\fP +.RS 4 +Print full device paths. +.RE +.sp +\fB\-r\fP, \fB\-\-raw\fP +.RS 4 +Produce output in raw format. The output lines are still ordered by dependencies. All potentially unsafe characters are hex\-escaped (\(rsx<code>) in the NAME, KNAME, LABEL, PARTLABEL and MOUNTPOINT columns. +.RE +.sp +\fB\-S\fP, \fB\-\-scsi\fP +.RS 4 +Output info about SCSI devices only. All partitions, slaves and holder devices are ignored. +.RE +.sp +\fB\-s\fP, \fB\-\-inverse\fP +.RS 4 +Print dependencies in inverse order. If the \fB\-\-list\fP output is requested then the lines are still ordered by dependencies. +.RE +.sp +\fB\-T\fP, \fB\-\-tree\fP[\fB=\fP\fIcolumn\fP] +.RS 4 +Force tree\-like output format. If \fIcolumn\fP is specified, then a tree is printed in the column. The default is NAME column. +.RE +.sp +\fB\-t\fP, \fB\-\-topology\fP +.RS 4 +Output info about block\-device topology. This option is equivalent to +.sp +\fB\-o NAME,ALIGNMENT,MIN\-IO,OPT\-IO,PHY\-SEC,LOG\-SEC,ROTA,SCHED,RQ\-SIZE,RA,WSAME\fP. +.RE +.sp +\fB\-V\fP, \fB\-\-version\fP +.RS 4 +Display version information and exit. +.RE +.sp +\fB\-w\fP, \fB\-\-width\fP \fInumber\fP +.RS 4 +Specifies output width as a number of characters. The default is the number of the terminal columns, and if not executed on a terminal, then output width is not restricted at all by default. This option also forces \fBlsblk\fP to assume that terminal control characters and unsafe characters are not allowed. The expected use\-case is for example when \fBlsblk\fP is used by the \fBwatch\fP(1) command. +.RE +.sp +\fB\-x\fP, \fB\-\-sort\fP \fIcolumn\fP +.RS 4 +Sort output lines by \fIcolumn\fP. This option enables \fB\-\-list\fP output format by default. It is possible to use the option \fB\-\-tree\fP to force tree\-like output and than the tree branches are sorted by the \fIcolumn\fP. +.RE +.sp +\fB\-z\fP, \fB\-\-zoned\fP +.RS 4 +Print the zone model for each device. +.RE +.sp +\fB\-\-sysroot\fP \fIdirectory\fP +.RS 4 +Gather data for a Linux instance other than the instance from which the \fBlsblk\fP command is issued. The specified directory is the system root of the Linux instance to be inspected. The real device nodes in the target directory can be replaced by text files with udev attributes. +.RE +.SH "EXIT STATUS" +.sp +0 +.RS 4 +success +.RE +.sp +1 +.RS 4 +failure +.RE +.sp +32 +.RS 4 +none of specified devices found +.RE +.sp +64 +.RS 4 +some specified devices found, some not found +.RE +.SH "ENVIRONMENT" +.sp +LSBLK_DEBUG=all +.RS 4 +enables \fBlsblk\fP debug output. +.RE +.sp +LIBBLKID_DEBUG=all +.RS 4 +enables \fBlibblkid\fP debug output. +.RE +.sp +LIBMOUNT_DEBUG=all +.RS 4 +enables \fBlibmount\fP debug output. +.RE +.sp +LIBSMARTCOLS_DEBUG=all +.RS 4 +enables \fBlibsmartcols\fP debug output. +.RE +.sp +LIBSMARTCOLS_DEBUG_PADDING=on +.RS 4 +use visible padding characters. +.RE +.SH "NOTES" +.sp +For partitions, some information (e.g., queue attributes) is inherited from the parent device. +.sp +The \fBlsblk\fP command needs to be able to look up each block device by major:minor numbers, which is done by using \fI/sys/dev/block\fP. This sysfs block directory appeared in kernel 2.6.27 (October 2008). In case of problems with a new enough kernel, check that CONFIG_SYSFS was enabled at the time of the kernel build. +.SH "AUTHORS" +.sp +.MTO "mbroz\(atredhat.com" "Milan Broz" "," +.MTO "kzak\(atredhat.com" "Karel Zak" "" +.SH "SEE ALSO" +.sp +\fBls\fP(1), +\fBblkid\fP(8), +\fBfindmnt\fP(8) +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBlsblk\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/lslocks.8 b/upstream/opensuse-leap-15-6/man8/lslocks.8 new file mode 100644 index 00000000..a42c8363 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/lslocks.8 @@ -0,0 +1,169 @@ +'\" t +.\" Title: lslocks +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "LSLOCKS" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +lslocks \- list local system locks +.SH "SYNOPSIS" +.sp +\fBlslocks\fP [options] +.SH "DESCRIPTION" +.sp +\fBlslocks\fP lists information about all the currently held file locks in a Linux system. +.sp +Note that lslocks also lists OFD (Open File Description) locks, these locks are not associated with any process (PID is \-1). OFD locks are associated with the open file description on which they are acquired. This lock type is available since Linux 3.15, see \fBfcntl\fP(2) for more details. +.SH "OPTIONS" +.sp +\fB\-b\fP, \fB\-\-bytes\fP +.RS 4 +Print the SIZE column in bytes rather than in a human\-readable format. +.RE +.sp +\fB\-i\fP, \fB\-\-noinaccessible\fP +.RS 4 +Ignore lock files which are inaccessible for the current user. +.RE +.sp +\fB\-J\fP, \fB\-\-json\fP +.RS 4 +Use JSON output format. +.RE +.sp +\fB\-n\fP, \fB\-\-noheadings\fP +.RS 4 +Do not print a header line. +.RE +.sp +\fB\-o\fP, \fB\-\-output\fP \fIlist\fP +.RS 4 +Specify which output columns to print. Use \fB\-\-help\fP to get a list of all supported columns. +.sp +The default list of columns may be extended if \fIlist\fP is specified in the format \fI+list\fP (e.g., \fBlslocks \-o +BLOCKER\fP). +.RE +.sp +\fB\-\-output\-all\fP +.RS 4 +Output all available columns. +.RE +.sp +\fB\-p\fP, \fB\-\-pid\fP \fIpid\fP +.RS 4 +Display only the locks held by the process with this \fIpid\fP. +.RE +.sp +\fB\-r\fP, \fB\-\-raw\fP +.RS 4 +Use the raw output format. +.RE +.sp +\fB\-u\fP, \fB\-\-notruncate\fP +.RS 4 +Do not truncate text in columns. +.RE +.sp +\fB\-V\fP, \fB\-\-version\fP +.RS 4 +Display version information and exit. +.RE +.sp +\fB\-h\fP, \fB\-\-help\fP +.RS 4 +Display help text and exit. +.RE +.SH "OUTPUT" +.sp +COMMAND +.RS 4 +The command name of the process holding the lock. +.RE +.sp +PID +.RS 4 +The process ID of the process which holds the lock or \-1 for OFDLCK. +.RE +.sp +TYPE +.RS 4 +The type of lock; can be FLOCK (created with \fBflock\fP(2)), POSIX (created with \fBfcntl\fP(2) and \fBlockf\fP(3)) or OFDLCK (created with \fBfcntl\fP(2)). +.RE +.sp +SIZE +.RS 4 +Size of the locked file. +.RE +.sp +MODE +.RS 4 +The lock\(cqs access permissions (read, write). If the process is blocked and waiting for the lock, then the mode is postfixed with an \(aq*\(aq (asterisk). +.RE +.sp +M +.RS 4 +Whether the lock is mandatory; 0 means no (meaning the lock is only advisory), 1 means yes. (See \fBfcntl\fP(2).) +.RE +.sp +START +.RS 4 +Relative byte offset of the lock. +.RE +.sp +END +.RS 4 +Ending offset of the lock. +.RE +.sp +PATH +.RS 4 +Full path of the lock. If none is found, or there are no permissions to read the path, it will fall back to the device\(cqs mountpoint and "..." is appended to the path. The path might be truncated; use \fB\-\-notruncate\fP to get the full path. +.RE +.sp +BLOCKER +.RS 4 +The PID of the process which blocks the lock. +.RE +.SH "NOTES" +.sp +The \fBlslocks\fP command is meant to replace the \fBlslk\fP(8) command, originally written by \c +.MTO "abe\(atpurdue.edu" "Victor A. Abell" "" +and unmaintained since 2001. +.SH "AUTHORS" +.sp +.MTO "dave\(atgnu.org" "Davidlohr Bueso" "" +.SH "SEE ALSO" +.sp +\fBflock\fP(1), +\fBfcntl\fP(2), +\fBlockf\fP(3) +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBlslocks\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/lsmod.8 b/upstream/opensuse-leap-15-6/man8/lsmod.8 new file mode 100644 index 00000000..a45c0f2f --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/lsmod.8 @@ -0,0 +1,59 @@ +'\" t +.\" Title: lsmod +.\" Author: Jon Masters <jcm@jonmasters.org> +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 01/29/2021 +.\" Manual: lsmod +.\" Source: kmod +.\" Language: English +.\" +.TH "LSMOD" "8" "01/29/2021" "kmod" "lsmod" +.\" ----------------------------------------------------------------- +.\" * 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" +lsmod \- Show the status of modules in the Linux Kernel +.SH "SYNOPSIS" +.HP \w'\fBlsmod\fR\ 'u +\fBlsmod\fR +.SH "DESCRIPTION" +.PP +\fBlsmod\fR +is a trivial program which nicely formats the contents of the +/proc/modules, showing what kernel modules are currently loaded\&. +.SH "COPYRIGHT" +.PP +This manual page originally Copyright 2002, Rusty Russell, IBM Corporation\&. Maintained by Jon Masters and others\&. +.SH "SEE ALSO" +.PP +\fBinsmod\fR(8), +\fBmodprobe\fR(8), +\fBmodinfo\fR(8) +\fBdepmod\fR(8) +.SH "AUTHORS" +.PP +\fBJon Masters\fR <\&jcm@jonmasters\&.org\&> +.RS 4 +Developer +.RE +.PP +\fBLucas De Marchi\fR <\&lucas\&.de\&.marchi@gmail\&.com\&> +.RS 4 +Developer +.RE diff --git a/upstream/opensuse-leap-15-6/man8/lsns.8 b/upstream/opensuse-leap-15-6/man8/lsns.8 new file mode 100644 index 00000000..9a2875cf --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/lsns.8 @@ -0,0 +1,124 @@ +'\" t +.\" Title: lsns +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "LSNS" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +lsns \- list namespaces +.SH "SYNOPSIS" +.sp +\fBlsns\fP [options] \fInamespace\fP +.SH "DESCRIPTION" +.sp +\fBlsns\fP lists information about all the currently accessible namespaces or about the given \fInamespace\fP. The \fInamespace\fP identifier is an inode number. +.sp +The default output is subject to change. So whenever possible, you should avoid using default outputs in your scripts. Always explicitly define expected columns by using the \fB\-\-output\fP option together with a columns list in environments where a stable output is required. +.sp +The \fBNSFS\fP column, printed when \fBnet\fP is specified for the \fB\-\-type\fP option, is special; it uses multi\-line cells. Use the option \fB\-\-nowrap\fP to switch to ","\-separated single\-line representation. +.sp +Note that \fBlsns\fP reads information directly from the \fI/proc\fP filesystem and for non\-root users it may return incomplete information. The current \fI/proc\fP filesystem may be unshared and affected by a PID namespace (see \fBunshare \-\-mount\-proc\fP for more details). \fBlsns\fP is not able to see persistent namespaces without processes where the namespace instance is held by a bind mount to /proc/\fIpid\fP/ns/\fItype\fP. +.SH "OPTIONS" +.sp +\fB\-J\fP, \fB\-\-json\fP +.RS 4 +Use JSON output format. +.RE +.sp +\fB\-l\fP, \fB\-\-list\fP +.RS 4 +Use list output format. +.RE +.sp +\fB\-n\fP, \fB\-\-noheadings\fP +.RS 4 +Do not print a header line. +.RE +.sp +\fB\-o\fP, \fB\-\-output\fP \fIlist\fP +.RS 4 +Specify which output columns to print. Use \fB\-\-help\fP to get a list of all supported columns. +.sp +The default list of columns may be extended if \fIlist\fP is specified in the format \fB+\fP\fIlist\fP (e.g., \fBlsns \-o +PATH\fP). +.RE +.sp +\fB\-\-output\-all\fP +.RS 4 +Output all available columns. +.RE +.sp +\fB\-p\fP, \fB\-\-task\fP \fIPID\fP +.RS 4 +Display only the namespaces held by the process with this \fIPID\fP. +.RE +.sp +\fB\-r\fP, \fB\-\-raw\fP +.RS 4 +Use the raw output format. +.RE +.sp +\fB\-t\fP, \fB\-\-type\fP \fItype\fP +.RS 4 +Display the specified \fItype\fP of namespaces only. The supported types are \fBmnt\fP, \fBnet\fP, \fBipc\fP, \fBuser\fP, \fBpid\fP, \fButs\fP, \fBcgroup\fP and \fBtime\fP. This option may be given more than once. +.RE +.sp +\fB\-u\fP, \fB\-\-notruncate\fP +.RS 4 +Do not truncate text in columns. +.RE +.sp +\fB\-W\fP, \fB\-\-nowrap\fP +.RS 4 +Do not use multi\-line text in columns. +.RE +.sp +\fB\-V\fP, \fB\-\-version\fP +.RS 4 +Display version information and exit. +.RE +.sp +\fB\-h\fP, \fB\-\-help\fP +.RS 4 +Display help text and exit. +.RE +.SH "AUTHORS" +.sp +.MTO "kzak\(atredhat.com" "Karel Zak" "" +.SH "SEE ALSO" +.sp +\fBnsenter\fP(1), +\fBunshare\fP(1), +\fBclone\fP(2), +\fBnamespaces\fP(7), +\fBioctl_ns(2)\fP +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBlsns\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/lspci.8 b/upstream/opensuse-leap-15-6/man8/lspci.8 new file mode 100644 index 00000000..3701d9fb --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/lspci.8 @@ -0,0 +1,357 @@ +.TH lspci 8 "17 November 2017" "pciutils-3.5.6" "The PCI Utilities" +.SH NAME +lspci \- list all PCI devices +.SH SYNOPSIS +.B lspci +.RB [ options ] +.SH DESCRIPTION +.B lspci +is a utility for displaying information about PCI buses in the system and +devices connected to them. + +By default, it shows a brief list of devices. Use the options described +below to request either a more verbose output or output intended for +parsing by other programs. + +If you are going to report bugs in PCI device drivers or in +.I lspci +itself, please include output of "lspci -vvx" or even better "lspci -vvxxx" +(however, see below for possible caveats). + +Some parts of the output, especially in the highly verbose modes, are probably +intelligible only to experienced PCI hackers. For exact definitions of +the fields, please consult either the PCI specifications or the +.B header.h +and +.B /usr/include/linux/pci.h +include files. + +Access to some parts of the PCI configuration space is restricted to root +on many operating systems, so the features of +.I lspci +available to normal users are limited. However, +.I lspci +tries its best to display as much as available and mark all other +information with +.I <access denied> +text. + +.SH OPTIONS + +.SS Basic display modes +.TP +.B -m +Dump PCI device data in a backward-compatible machine readable form. +See below for details. +.TP +.B -mm +Dump PCI device data in a machine readable form for easy parsing by scripts. +See below for details. +.TP +.B -t +Show a tree-like diagram containing all buses, bridges, devices and connections +between them. + +.SS Display options +.TP +.B -v +Be verbose and display detailed information about all devices. +.TP +.B -vv +Be very verbose and display more details. This level includes everything deemed +useful. +.TP +.B -vvv +Be even more verbose and display everything we are able to parse, +even if it doesn't look interesting at all (e.g., undefined memory regions). +.TP +.B -k +Show kernel drivers handling each device and also kernel modules capable of handling it. +Turned on by default when +.B -v +is given in the normal mode of output. +(Currently works only on Linux with kernel 2.6 or newer.) +.TP +.B -x +Show hexadecimal dump of the standard part of the configuration space (the first +64 bytes or 128 bytes for CardBus bridges). +.TP +.B -xxx +Show hexadecimal dump of the whole PCI configuration space. It is available only to root +as several PCI devices +.B crash +when you try to read some parts of the config space (this behavior probably +doesn't violate the PCI standard, but it's at least very stupid). However, such +devices are rare, so you needn't worry much. +.TP +.B -xxxx +Show hexadecimal dump of the extended (4096-byte) PCI configuration space available +on PCI-X 2.0 and PCI Express buses. +.TP +.B -b +Bus-centric view. Show all IRQ numbers and addresses as seen by the cards on the +PCI bus instead of as seen by the kernel. +.TP +.B -D +Always show PCI domain numbers. By default, lspci suppresses them on machines which +have only domain 0. + +.SS Options to control resolving ID's to names +.TP +.B -n +Show PCI vendor and device codes as numbers instead of looking them up in the +PCI ID list. +.TP +.B -nn +Show PCI vendor and device codes as both numbers and names. +.TP +.B -q +Use DNS to query the central PCI ID database if a device is not found in the local +.B pci.ids +file. If the DNS query succeeds, the result is cached in +.B ~/.pciids-cache +and it is recognized in subsequent runs even if +.B -q +is not given any more. Please use this switch inside automated scripts only +with caution to avoid overloading the database servers. +.TP +.B -qq +Same as +.BR -q , +but the local cache is reset. +.TP +.B -Q +Query the central database even for entries which are recognized locally. +Use this if you suspect that the displayed entry is wrong. + +.SS Options for selection of devices +.TP +.B -s [[[[<domain>]:]<bus>]:][<device>][.[<func>]] +Show only devices in the specified domain (in case your machine has several host bridges, +they can either share a common bus number space or each of them can address a PCI domain +of its own; domains are numbered from 0 to ffff), bus (0 to ff), device (0 to 1f) and function (0 to 7). +Each component of the device address can be omitted or set to "*", both meaning "any value". All numbers are +hexadecimal. E.g., "0:" means all devices on bus 0, "0" means all functions of device 0 +on any bus, "0.3" selects third function of device 0 on all buses and ".4" shows only +the fourth function of each device. +.TP +.B -d [<vendor>]:[<device>][:<class>] +Show only devices with specified vendor, device and class ID. The ID's are +given in hexadecimal and may be omitted or given as "*", both meaning +"any value". + +.SS Other options +.TP +.B -i <file> +Use +.B +<file> +as the PCI ID list instead of /usr/share/pci.ids. +.TP +.B -p <file> +Use +.B +<file> +as the map of PCI ID's handled by kernel modules. By default, lspci uses +.RI /lib/modules/ kernel_version /modules.pcimap. +Applies only to Linux systems with recent enough module tools. +.TP +.B -M +Invoke bus mapping mode which performs a thorough scan of all PCI devices, including +those behind misconfigured bridges, etc. This option gives meaningful results only +with a direct hardware access mode, which usually requires root privileges. +Please note that the bus mapper only scans PCI domain 0. +.TP +.B --version +Shows +.I lspci +version. This option should be used stand-alone. + +.SS PCI access options +.PP +The PCI utilities use the PCI library to talk to PCI devices (see +\fBpcilib\fP(7) for details). You can use the following options to +influence its behavior: +.TP +.B -A <method> +The library supports a variety of methods to access the PCI hardware. +By default, it uses the first access method available, but you can use +this option to override this decision. See \fB-A help\fP for a list of +available methods and their descriptions. +.TP +.B -O <param>=<value> +The behavior of the library is controlled by several named parameters. +This option allows to set the value of any of the parameters. Use \fB-O help\fP +for a list of known parameters and their default values. +.TP +.B -H1 +Use direct hardware access via Intel configuration mechanism 1. +(This is a shorthand for \fB-A intel-conf1\fP.) +.TP +.B -H2 +Use direct hardware access via Intel configuration mechanism 2. +(This is a shorthand for \fB-A intel-conf2\fP.) +.TP +.B -F <file> +Instead of accessing real hardware, read the list of devices and values of their +configuration registers from the given file produced by an earlier run of lspci -x. +This is very useful for analysis of user-supplied bug reports, because you can display +the hardware configuration in any way you want without disturbing the user with +requests for more dumps. +.TP +.B -G +Increase debug level of the library. + +.SH MACHINE READABLE OUTPUT +If you intend to process the output of lspci automatically, please use one of the +machine-readable output formats +.RB ( -m , +.BR -vm , +.BR -vmm ) +described in this section. All other formats are likely to change +between versions of lspci. + +.P +All numbers are always printed in hexadecimal. If you want to process numeric ID's instead of +names, please add the +.B -n +switch. + +.SS Simple format (-m) + +In the simple format, each device is described on a single line, which is +formatted as parameters suitable for passing to a shell script, i.e., values +separated by whitespaces, quoted and escaped if necessary. +Some of the arguments are positional: slot, class, vendor name, device name, +subsystem vendor name and subsystem name (the last two are empty if +the device has no subsystem); the remaining arguments are option-like: + +.TP +.BI -r rev +Revision number. + +.TP +.BI -p progif +Programming interface. + +.P +The relative order of positional arguments and options is undefined. +New options can be added in future versions, but they will always +have a single argument not separated from the option by any spaces, +so they can be easily ignored if not recognized. + +.SS Verbose format (-vmm) + +The verbose output is a sequence of records separated by blank lines. +Each record describes a single device by a sequence of lines, each line +containing a single +.RI ` tag : +.IR value ' +pair. The +.I tag +and the +.I value +are separated by a single tab character. +Neither the records nor the lines within a record are in any particular order. +Tags are case-sensitive. + +.P +The following tags are defined: + +.TP +.B Slot +The name of the slot where the device resides +.RI ([ domain :] bus : device . function ). +This tag is always the first in a record. + +.TP +.B Class +Name of the class. + +.TP +.B Vendor +Name of the vendor. + +.TP +.B Device +Name of the device. + +.TP +.B SVendor +Name of the subsystem vendor (optional). + +.TP +.B SDevice +Name of the subsystem (optional). + +.TP +.B PhySlot +The physical slot where the device resides (optional, Linux only). + +.TP +.B Rev +Revision number (optional). + +.TP +.B ProgIf +Programming interface (optional). + +.TP +.B Driver +Kernel driver currently handling the device (optional, Linux only). + +.TP +.B Module +Kernel module reporting that it is capable of handling the device +(optional, Linux only). + +.TP +.B NUMANode +NUMA node this device is connected to (optional, Linux only). + +.P +New tags can be added in future versions, so you should silently ignore any tags you don't recognize. + +.SS Backward-compatible verbose format (-vm) + +In this mode, lspci tries to be perfectly compatible with its old versions. +It's almost the same as the regular verbose format, but the +.B +Device +tag is used for both the slot and the device name, so it occurs twice +in a single record. Please avoid using this format in any new code. + +.SH FILES +.TP +.B /usr/share/pci.ids +A list of all known PCI ID's (vendors, devices, classes and subclasses). Maintained +at http://pciids.sourceforge.net/, use the +.B update-pciids +utility to download the most recent version. +.TP +.B /usr/share/pci.ids.gz +If lspci is compiled with support for compression, this file is tried before pci.ids. +.TP +.B ~/.pciids-cache +All ID's found in the DNS query mode are cached in this file. + +.SH BUGS + +Sometimes, lspci is not able to decode the configuration registers completely. +This usually happens when not enough documentation was available to the authors. +In such cases, it at least prints the +.B <?> +mark to signal that there is potentially something more to say. If you know +the details, patches will be of course welcome. + +Access to the extended configuration space is currently supported only by the +.B linux_sysfs +back-end. + +.SH SEE ALSO +.BR setpci (8), +.BR update-pciids (8), +.BR pcilib (7) + +.SH AUTHOR +The PCI Utilities are maintained by Martin Mares <mj@ucw.cz>. diff --git a/upstream/opensuse-leap-15-6/man8/lsusb.8 b/upstream/opensuse-leap-15-6/man8/lsusb.8 new file mode 100644 index 00000000..ed689051 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/lsusb.8 @@ -0,0 +1,66 @@ +.\"SPDX-License-Identifier: GPL-2.0-only +.\"Copyright (c) 1999 Thomas Sailer <sailer@ife.ee.ethz.ch> +.TH lsusb 8 "11 February 2019" "usbutils-014" "Linux USB Utilities" +.IX lsusb +.SH NAME +lsusb \- list USB devices +.SH SYNOPSIS +.B lsusb +[ +.I options +] +.SH DESCRIPTION +.B lsusb +is a utility for displaying information about USB buses in the system and +the devices connected to them. It uses udev's hardware database to +associate a full human-readable name to the vendor ID and the product ID. + +.SH OPTIONS +.TP +.BR \-v ", " \-\-verbose +Tells +.I lsusb +to be verbose and display detailed information about the devices shown. +This includes configuration descriptors for the device's current speed. +Class descriptors will be shown, when available, for USB device classes +including hub, audio, HID, communications, and chipcard. Can be used with the +\fBt\fP option. +.TP +\fB\-s\fP [[\fIbus\fP]\fB:\fP][\fIdevnum\fP] +Show only devices in specified +.I bus +and/or +.IR devnum . +Both IDs are given in decimal and may be omitted. +.TP +\fB\-d\fP [\fIvendor\fP]\fB:\fP[\fIproduct\fP] +Show only devices with the specified vendor and product ID. +Both IDs are given in hexadecimal. +.TP +.B \-D \fIdevice\fP +Do not scan the /dev/bus/usb directory, +instead display only information +about the device whose device file is given. +The device file should be something like /dev/bus/usb/001/001. +This option displays detailed information like the \fBv\fP option; +you must be root to do this. +.TP +.BR \-t ", " \-\-tree +Tells +.I lsusb +to dump the physical USB device hierarchy as a tree. Verbosity can be increased twice with the +\fBv\fP option. +.TP +.BR \-V ", " \-\-version +Print version information on standard output, +then exit successfully. + +.SH RETURN VALUE +If the specified device is not found, a non-zero exit code is returned. + +.SH SEE ALSO +.BR lspci (8), +.BR usbview (8). + +.SH AUTHOR +Thomas Sailer, <sailer@ife.ee.ethz.ch>. diff --git a/upstream/opensuse-leap-15-6/man8/mail.local.8 b/upstream/opensuse-leap-15-6/man8/mail.local.8 new file mode 100644 index 00000000..182fe59a --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/mail.local.8 @@ -0,0 +1,152 @@ +.\" Copyright (c) 1998-2001, 2003 Proofpoint, Inc. and its suppliers. +.\" All rights reserved. +.\" Copyright (c) 1990, 1993 +.\" The Regents of the University of California. All rights reserved. +.\" +.\" By using this file, you agree to the terms and conditions set +.\" forth in the LICENSE file which can be found at the top level of +.\" the sendmail distribution. +.\" +.\" +.\" $Id: mail.local.8,v 8.26 2013-11-22 20:51:51 ca Exp $ +.\" +.TH MAIL.LOCAL 8 "$Date: 2013-11-22 20:51:51 $" +.SH NAME +mail.local +\- store mail in a mailbox +.SH SYNOPSIS +.B mail.local +.RB [ \-7 "] [" \-b "] [" \-d "] [" \-D +.IR mbdb ] +.RB [ \-l "] [" \-f +\fIfrom\fR|\fB\-r\fR +.IR from ] +.RB [ \-h +\fIfilename\fR ] +.I "user ..." +.SH DESCRIPTION +.B Mail.local +reads the standard input up to an end-of-file and appends it to each +.I user's +.B mail +file. The +.I user +must be a valid user name. +.PP +The options are as follows: +.TP 1i +.B \-7 +Do not advertise 8BITMIME support in LMTP mode. +.TP +.B \-b +Return a permanent error instead of a temporary error +if a mailbox exceeds quota. +.TP +.B \-d +Specify this is a delivery (for backward compatibility). +This option has no effect. +.TP +.BI \-D " mbdb" +Specify the name of the mailbox database +which is used to look up local recipient names. +This option defaults to "pw", which means use getpwnam(). +.TP +.BI \-f " from" +Specify the sender's name. +.TP +.B \-l +Turn on LMTP mode. +.TP +.BI \-r " from" +Specify the sender's name (for backward compatibility). +Same as \-f. +.TP +.BI \-h " filename" +Store incoming mail in \fIfilename\fR in the user's home directory instead +of a system mail spool directory. +.PP +The next options are only available if +.B mail.local +has been compiled with -DHASHSPOOL. +.TP +.BI \-H " hashtypehashdepth" +Select hashed mail directories. +Valid hash types are +.B u +for user name and +.B m +for MD5 (requires compilation with -DHASHSPOOLMD5). +Example: +.BI \-H " u2" +selects user name hashing with a hash depth of 2. +Note: there must be no space between the hash type and the depth. +.TP +.BI \-p " path" +Specify an alternate mail spool path. +.TP +.BI \-n +Specify that the domain part of recipient addresses in LMTP mode +should not be stripped. +.PP +Individual mail messages in the mailbox are delimited by an empty +line followed by a line beginning with the string ``From ''. +A line containing the string ``From '', the sender's name and a time stamp +is prepended to each delivered mail message. +A blank line is appended to each message. +A greater-than character (``>'') is prepended to any line in the message +which could be mistaken for a ``From '' delimiter line +(that is, +a line beginning with the five characters +``From '' following a blank line). +.PP +The mail files are exclusively locked with +flock(2) +while mail is appended, +and a +.B user.lock +file also is created while the mailbox is locked +for compatibility with older MUAs. +.PP +If the ``biff'' service is returned by +getservbyname(3), +the biff server is notified of delivered mail. +.PP +The +.B mail.local +utility exits 0 on success, and >0 if an error occurs. +.SH ENVIRONMENT +.IP TZ +Used to set the appropriate time zone on the timestamp. +.SH FILES +.PD 0.2v +.TP 2.2i +/tmp/local.XXXXXX +temporary files +.TP +/var/spool/mail/user +user's default mailbox directory +.TP +/var/spool/mail/user.lock +lock file for a user's default mailbox +.PD +.SH SEE ALSO +mail(1), +xsend(1), +flock(2), +getservbyname(3), +comsat(8), +sendmail(8) +.SH WARNING +.B mail.local +escapes only "^From " lines that follow an empty line. +If all lines starting with "From " should be escaped, +use the 'E' flag for the local mailer in the +sendmail.cf file. +.SH HISTORY +A superset of +.B mail.local +(handling mailbox reading as well as mail delivery) +appeared in +Version 7 AT&T UNIX +as the program +.BR mail . diff --git a/upstream/opensuse-leap-15-6/man8/mailstats.8 b/upstream/opensuse-leap-15-6/man8/mailstats.8 new file mode 100644 index 00000000..576074d9 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/mailstats.8 @@ -0,0 +1,121 @@ +.\" Copyright (c) 1998-2002 Proofpoint, Inc. and its suppliers. +.\" All rights reserved. +.\" +.\" By using this file, you agree to the terms and conditions set +.\" forth in the LICENSE file which can be found at the top level of +.\" the sendmail distribution. +.\" +.\" +.\" $Id: mailstats.8,v 8.32 2013-11-22 20:51:51 ca Exp $ +.\" +.TH MAILSTATS 8 "$Date: 2013-11-22 20:51:51 $" +.SH NAME +mailstats +\- display mail statistics +.SH SYNOPSIS +.B mailstats +.RB [ \-c "] [" \-o "] [" \-p "] [" \-P ] +.RB [ \-C +.IR cffile ] +.RB [ \-f +.IR stfile ] +.SH DESCRIPTION +The +.B mailstats +utility displays the current mail statistics. +.PP +First, the time at which statistics started being kept is displayed, +in the format specified by +ctime(3). +Then, +the statistics for each mailer are displayed on a single line, +each with the following white space separated fields: +.sp +.RS +.PD 0.2v +.TP 1.2i +.B M +The mailer number. +.TP +.B msgsfr +Number of messages from the mailer. +.TP +.B bytes_from +Kbytes from the mailer. +.TP +.B msgsto +Number of messages to the mailer. +.TP +.B bytes_to +Kbytes to the mailer. +.TP +.B msgsrej +Number of messages rejected. +.TP +.B msgsdis +Number of messages discarded. +.TP +.B msgsqur +Number of messages quarantined. +.TP +.B Mailer +The name of the mailer. +.PD +.RE +.PP +After this display, a line totaling the values for all of the mailers +is displayed (preceded with a ``T''), +separated from the previous information by a line containing only equals +(``='') +characters. +Another line preceded with a ``C'' lists the number of TCP connections. +.PP +The options are as follows: +.TP +.B \-C +Read the specified file instead of the default +.B sendmail +configuration file. +.TP +.B \-c +Try to use submit.cf instead of the default +.B sendmail +configuration file. +.TP +.B \-f +Read the specified statistics file instead of the statistics file +specified in the +.B sendmail +configuration file. +.TP +.B \-P +Output information in program-readable mode without clearing statistics. +.TP +.B \-p +Output information in program-readable mode and clear statistics. +.TP +.B \-o +Don't display the name of the mailer in the output. +.PP +The +.B mailstats +utility exits 0 on success, and >0 if an error occurs. +.SH FILES +.PD 0.2v +.TP 2.5i +/etc/mail/sendmail.cf +The default +.B sendmail +configuration file. +.TP +/var/lib/sendmail/statistics +The default +.B sendmail +statistics file. +.TP +/etc/mail/statistics +The symbolic link to the statistics file. +.PD +.SH SEE ALSO +mailq(1), +sendmail(8) diff --git a/upstream/opensuse-leap-15-6/man8/makedeltaiso.8 b/upstream/opensuse-leap-15-6/man8/makedeltaiso.8 new file mode 100644 index 00000000..817857da --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/makedeltaiso.8 @@ -0,0 +1,26 @@ +.\" man page for makedeltaiso +.\" Copyright (c) 2005 Michael Schroeder <mls@suse.de> +.\" See LICENSE.BSD for license +.TH MAKEDELTAISO 8 "Feb 2005" +.SH NAME +makedeltaiso \- create a deltaiso from two isos + +.SH SYNOPSIS +.B makedeltaiso +.I oldiso +.I newiso +.I deltaiso + +.SH DESCRIPTION +makedeltaiso creates a deltaiso from two isos. + +Do not specify a device (such as /dev/dvd) for either +.I oldiso +or +.IR newiso . + +.SH SEE ALSO +.BR applydeltaiso (8) + +.SH AUTHOR +Michael Schroeder <mls@suse.de> diff --git a/upstream/opensuse-leap-15-6/man8/makedeltarpm.8 b/upstream/opensuse-leap-15-6/man8/makedeltarpm.8 new file mode 100644 index 00000000..233e4aa1 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/makedeltarpm.8 @@ -0,0 +1,101 @@ +.\" man page for makedeltarpm +.\" Copyright (c) 2010 Michael Schroeder <mls@suse.de> +.\" See LICENSE.BSD for license +.TH MAKEDELTARPM 8 "Jul 2010" +.SH NAME +makedeltarpm \- create a deltarpm from two rpms + +.SH SYNOPSIS +.B makedeltarpm +.RB [ -v ] +.RB [ -V +.IR version ] +.RB [ -z +.IR compression ] +.RB [ -m +.IR mbytes ] +.RB [ -s +.IR seqfile ] +.RB [ -r ] +.RB [ -u ] +.I oldrpm +.I newrpm +.I deltarpm +.br +.B makedeltarpm +.RB [ -v ] +.RB [ -V +.IR version ] +.RB [ -z +.IR compression ] +.RB [ -s +.IR seqfile ] +.RB [ -u ] +.B -p +.I oldrpmprint +.IR oldpatchrpm +.I oldrpm +.I newrpm +.I deltarpm + +.SH DESCRIPTION +makedeltarpm creates a deltarpm from two rpms. The deltarpm can +later be used to recreate the new rpm from either filesystem data +or the old rpm. Use the +.B -v +option to make makedeltarpm more verbose about its work (use it +twice to make it even more verbose). +.PP +If you want to create a +smaller and faster to combine "rpm-only" deltarpm which does not +work with filesystem data, specify the +.B -r +option. +.PP +makedeltarpm normally produces +a V3 format deltarpm, use the +.B -V +option to specify a different version if desired. The +.B -z +option can be used to specify a different compression method, the +default is to use the same compression method as used in the +new rpm. +.PP +The +.B -s +option makes makedeltarpm write out the sequence id to the specified +file +.IR seqfile . + +If you also use patch rpms you should use the +.B -p +option to specify the rpm-print of +.I oldrpm +and the created +patch rpm. This option tells makedeltarpm to exclude the files that +were not included in the patch rpm but are not byteswise identical +to the ones in oldrpm. +.PP +makedeltarpm can also create an "identity" deltarpm by adding the +.B -u +switch. In this case only one rpm has to be specified. An identity +deltarpm can be useful to just replace the signature header of a +rpm or to reconstruct a rpm from the filesystem. + +.SH MEMORY CONSIDERATIONS +makedeltarpm normally needs about three to four times the size +of the rpm's uncompressed payload. You can use the +.B -m +option to enable a sliding block algorithm that needs +.IR mbytes +megabytes of memory. This trades memory usage with the size of +the created deltarpm. Furthermore, the uncompressed deltarpm +payload is currently also stored in memory when this option is +used, but it tends to be small in most cases. + +.SH SEE ALSO +.BR applydeltarpm (8) +.BR combinedeltarpm (8) + +.SH AUTHOR +Michael Schroeder <mls@suse.de> diff --git a/upstream/opensuse-leap-15-6/man8/makemap.8 b/upstream/opensuse-leap-15-6/man8/makemap.8 new file mode 100644 index 00000000..d110882c --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/makemap.8 @@ -0,0 +1,166 @@ +.\" Copyright (c) 1998-2002 Proofpoint, Inc. and its suppliers. +.\" All rights reserved. +.\" Copyright (c) 1988, 1991, 1993 +.\" The Regents of the University of California. All rights reserved. +.\" +.\" By using this file, you agree to the terms and conditions set +.\" forth in the LICENSE file which can be found at the top level of +.\" the sendmail distribution. +.\" +.\" +.\" $Id: makemap.8,v 8.32 2013-11-22 20:51:52 ca Exp $ +.\" +.TH MAKEMAP 8 "$Date: 2013-11-22 20:51:52 $" +.SH NAME +makemap +\- create database maps for sendmail +.SH SYNOPSIS +.B makemap +.RB [ \-C +.IR file ] +.RB [ \-N ] +.RB [ \-c +.IR cachesize ] +.RB [ \-d ] +.RB [ \-D +.IR commentchar ] +.RB [ \-e ] +.RB [ \-f ] +.RB [ \-l ] +.RB [ \-o ] +.RB [ \-r ] +.RB [ \-s ] +.RB [ \-t +.IR delim ] +.RB [ \-u ] +.RB [ \-v ] +.I +maptype mapnam +.SH DESCRIPTION +.B Makemap +creates the database maps used by the keyed map lookups in +sendmail(8). +It reads input from the standard input +and outputs them to the indicated +.I mapname. +.PP +.B makemap +handles two different database formats, +selected using the +.I maptype +parameter. +They may be +.TP +btree +B-Tree format maps. +This requires the new Berkeley DB +library. +.TP +hash +Hash format maps. +This also requires the Berkeley DB +library. +.PP +In all cases, +.B makemap +reads lines from the standard input consisting of two +words separated by white space. +The first is the database key, +the second is the value. +The value may contain +``%\fIn\fP'' +strings to indicate parameter substitution. +Literal percents should be doubled +(``%%''). +Blank lines and lines beginning with ``#'' are ignored. +.PP +Notice: do +.B not +use +.B makemap +to create the aliases data base, but +.B newaliases +which puts a special token into the data base that is required by +.B sendmail. +.PP +If the +.I TrustedUser +option is set in the sendmail configuration file and +.B makemap +is invoked as root, the generated files will be owned by +the specified +.IR TrustedUser. +.SS Flags +.TP +.B \-C +Use the specified +.B sendmail +configuration file for looking up the TrustedUser option. +.TP +.B \-N +Include the null byte that terminates strings +in the map. +This must match the \-N flag in the sendmail.cf +``K'' line. +.TP +.B \-c +Use the specified hash and B-Tree cache size. +.TP +.B \-D +Use to specify the character to use to indicate a comment (which is ignored) +instead of the default of '#'. +.TP +.B \-d +Allow duplicate keys in the map. +This is only allowed on B-Tree format maps. +If two identical keys are read, +they will both be inserted into the map. +.TP +.B \-e +Allow empty value (right hand side). +.TP +.B \-f +Normally all upper case letters in the key +are folded to lower case. +This flag disables that behaviour. +This is intended to mesh with the +\-f flag in the +.B K +line in sendmail.cf. +The value is never case folded. +.TP +.B \-l +List supported map types. +.TP +.B \-o +Append to an old file. +This allows you to augment an existing file. +.TP +.B \-r +Allow replacement of existing keys. +Normally +.B makemap +complains if you repeat a key, +and does not do the insert. +.TP +.B \-s +Ignore safety checks on maps being created. +This includes checking for hard or symbolic +links in world writable directories. +.TP +.B \-t +Use the specified delimiter instead of white space +(also for dumping a map). +.TP +.B \-u +dump (unmap) the content of the database to standard output. +.TP +.B \-v +Verbosely print what it is doing. +.SH SEE ALSO +sendmail(8), newaliases(1) +.SH HISTORY +The +.B makemap +command appeared in +4.4BSD. diff --git a/upstream/opensuse-leap-15-6/man8/mapscrn.8 b/upstream/opensuse-leap-15-6/man8/mapscrn.8 new file mode 100644 index 00000000..9881c250 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/mapscrn.8 @@ -0,0 +1,118 @@ +.\" @(#)man/man8/mapscrn.8 1.0 3/19/93 17:04:00 +.TH MAPSCRN 8 "20 March 1993" "kbd" +.SH NAME +mapscrn \- load screen output mapping table +.SH SYNOPSIS +.BR mapscrn " [" -V "] [" -v "] [" -o +.IR map.orig ] +.I mapfile +.SH DESCRIPTION +The +.B mapscrn +command is obsolete - its function is now built-in into setfont. +However, for backwards compatibility it is still available +as a separate command. +.LP +The +.I mapscrn +command loads a user defined output character mapping table into the +console driver. The console driver may be later put into +.B use user-defined mapping table +mode by outputting a special escape sequence to the console device. +This sequence is +.I <esc>(K +for the +.B G0 +character set and +.I <esc>)K +for the +.B G1 +character set. +When the +.I -o +option is given, the old map is saved in +.I map.orig. +.SH USE +There are two kinds of mapping tables: direct-to-font tables, +that give a font position for each user byte value, and user-to-unicode +tables that give a unicode value for each user byte. The corresponding +glyph is now found using the unicode index of the font. +The command +.RS +mapscrn trivial +.RE +sets up a one-to-one direct-to-font table where user bytes +directly address the font. This is useful for fonts that are +in the same order as the character set one uses. +A command like +.RS +mapscrn 8859-2 +.RE +sets up a user-to-unicode table that assumes that the user +uses ISO 8859-2. +.SH "INPUT FORMAT" +The +.I mapscrn +command can read the map in either of two formats: +.br +1. 256 or 512 bytes binary data +.br +2. two-column text file +.br +Format (1) is a direct image of the translation +.I table. The 256-bytes tables are direct-to-font, +the 512-bytes tables are user-to-unicode tables. +Format (2) is used to fill the +.I table +as follows: cell with offset mentioned in the first column is filled +with the value mentioned in the second column. +When values larger than 255 occur, or values are written using +the U+xxxx notation, the table is assumed to be a user-to-unicode +table, otherwise it is a direct-to-font table. +.PP +Values in the file may be specified in one of several +.B formats: +.br +.B 1. Decimal: +String of decimal digits not starting with '0' +.br +.B 2. Octal: +String of octal digits beginning with '0'. +.br +.B 3. Hexadecimal: +String of hexadecimal digits preceded by "0x". +.br +.B 4. Unicode: +String of four hexadecimal digits preceded by "U+". +.br +.B 5. Character: +Single character enclosed in single quotes. (And the binary value is used.) +Note that blank, comma, tab character and '#' cannot be specified +with this format. +.br +.B 6. UTF-8 Character: +Single (possibly multi-byte) UTF-8 character, enclosed in single quotes. +.PP +Note that control characters (with codes < 32) cannot be re-mapped with +.I mapscrn +because they have special meaning for the driver. +.SH OTHER OPTIONS +.TP +.B \-V +Prints version number and exits. +.TP +.B \-v +Be verbose. +.SH FILES +.TP +.I /usr/share/kbd/consoletrans +The default directory for screen mappings. +.LP +.SH "SEE ALSO" +.IR setfont (8) +.SH AUTHOR +Copyright (C) 1993 Eugene G. Crosser +.br +<crosser@pccross.msk.su> +.br +This software and documentation may be distributed freely. diff --git a/upstream/opensuse-leap-15-6/man8/mingetty.8 b/upstream/opensuse-leap-15-6/man8/mingetty.8 new file mode 100644 index 00000000..9661580f --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/mingetty.8 @@ -0,0 +1,207 @@ +.\" +.TH MINGETTY 8 "29 May 2007" "SuSE" "Linux Programmer's Manual" +.SH NAME +mingetty \- minimal getty for consoles +.SH SYNOPSIS +.B /sbin/mingetty +.RB [ \-\-noclear ] +.RB [ \-\-nonewline ] +.RB [ \-\-noissue ] +.RB [ \-\-nohangup ] +.RB [ \-\-noreset ] +.RB [ \-\-no\-hostname ] +.RB [ \-\-long-hostname ] +.RB [ \-\-login\ \fIlogin_binary\fP ] +.RB [ \-\-logopts\ \fI"login_options"\fP ] +.RB [ \-\-nice\ \fInumber\fP ] +.RB [ \-\-delay\ \fInumber\fP ] +.RB [ \-\-chdir\ \fI/home\fP ] +.RB [ \-\-chroot\ \fI/chroot\fP ] +.RB [ \-\-autologin\ \fIuser\fP ] +.RB [ \-\-loginpause ] +.RB [ \-\-old ] +.I tty +.RI [ term ] +.PP +.SH DESCRIPTION +.B mingetty +is a minimal getty for use on virtual consoles. +Unlike +.BR agetty (8), +.B mingetty +is not suitable for serial lines. +For this purpose the usage of +.BR mgetty (8) +is recommend. +.PP +.SH OPTIONS +.TP +.B \-\-noclear +Do not clear the screen before prompting for the login name (the screen +is normally cleared). +.TP +.B \-\-noreset +By default the terminal settings will be initialized to some +sane default values. With this option the terminal settings +will not be changed. +.TP +.B \-\-nonewline +Do not print a newline before writing out /etc/issue. +.TP +.B \-\-noissue +Do not output /etc/issue. +.TP +.B \-\-nohangup +Do not call vhangup() to disable writing to this tty by +other applications. +.TP +.B \-\-no\-hostname +By default the hostname will be printed. +With this option enabled, no hostname at all will be shown. +.TP +.B \-\-long\-hostname +By default the hostname is only printed until the first dot. +With this option enabled, the full text from gethostname() is shown. +.TP +.B \-\-login \fIlogin_binary\fP +Use the \fIlogin_binary\fP to log in instead of the default +.IR /bin/login . +.TP +.B \-\-logopts \fI"login_options"\fP +Options that are passed to the login program. +\\\\u +is replaced by the login +name. Defaults to "\-\- \\\\u", which is suitable for +.IR /bin/login . +Please read the SECURITY NOTICE below if you want to use this. +.TP +.B \-\-nice 10 +Change the priority by calling nice(). +.TP +.B \-\-delay 5 +Sleep this many seconds after startup of mingetty. +.TP +.B \-\-chdir /home +Change into this directory before calling the login prog. +.TP +.B \-\-chroot /chroot +Call chroot() with this directory name. +.TP +.B \-\-autologin username +Log the specified user automatically in without asking for +a login name and password. Check the \-f option from +.B /bin/login +for this. +.TP +.B \-\-loginpause +Wait for any key before dropping to the login prompt. +Can be combined with \fB\-\-autologin\fR to save memory by lazily spawning +shells. +.TP +.B \-\-old +Do not reset the terminal line to standard settings and +do not hangup the +.I /dev/vcs +and +.I /dev/vcsa +virtual console memory devices which may remain from a former session. +This hangup requires access to the +.I /proc +file system because the linux kernel does not have a +.B revoke() +system call. +Please read the SECURITY NOTICE below if you want to use this. +.PP +.SH SECURITY NOTICE +If you use the +.B \-\-login +and +.B \-\-logopts +options, be aware that a malicious user +may try to enter lognames with embedded options, which then get passed to +the used login program. +.B mingetty +does check for a leading +\- +and makes sure the logname gets passed as one +parameter (so embedded spaces will not create yet another parameter), but +depending on how the login binary parses the command line that might not be +sufficient. Check that the used login program can not be abused this way. +.PP +Some programs use +\-\- +to indicate that the rest of the commandline should not be interpreted as +options. Use this feature if available by passing +\-\- +before the username gets passed by +\\\\u. +.PP +If you use the +.B \-\-old +be aware that remaining opened or memory mapped +.IB /dev/vcs <#> +or +.IB /dev/vcsa <#> +virtual console memory devices provide all infomation of the +corresponding terminal line +.I /dev/tty<#> +to a possible attacker. +.SH "ISSUE ESCAPES" +.B mingetty +recognizes the following escapes sequences which might be embedded in the +.I /etc/issue +file: +.IP \fB\ed\fP +insert current day (localtime), +.IP \fB\el\fP +insert line on which +.B mingetty +is running, +.IP \fB\em\fP +inserts machine architecture (uname \-m), +.IP \fB\en\fP +inserts machine's network node hostname (uname \-n), +.IP \fB\eo\fP +inserts domain name, +.IP \fB\er\fP +inserts operating system release (uname \-r), +.IP \fB\et\fP +insert current time (localtime), +.IP \fB\es\fP +inserts operating system name, +.IP \fB\eu\fP +resp. \fB\eU\fP +the current number of users which are currently logged in. +\\U inserts "\fIn\fP users", where as \\u only inserts "\fIn\fP". +.IP \fB\ev\fP +inserts operating system version (uname -v). +.PP +.SH EXAMPLE +"\fBLinux\ eos\ i386\ #1\ Tue\ Mar\ 19\ 21:54:09\ MET\ 1996\fP" was produced +by putting "\fB\\s\ \\n\ \\m\ \\v\fP" into +.IR /etc/issue . +.PP +.SH FILES +.IR /etc/issue , +.br +.IR /var/run/utmp , +.br +.IR /etc/inittab . +.br +.PP +.SH "SEE ALSO" +.BR mgetty (8), +.br +.BR agetty (8), +.br +.BR inittab (5), +.br +.BR vcs (8). +.PP +.SH AUTHOR +Copyright \(co 1996 Florian La Roche <florian@suse.de> +or <florian@jurix.jura.uni\-sb.de>. +.br +Copyright \(co 1999-2002 Werner Fink <feedback@suse.de>. +Man-page written by David Frey <David.Frey@eos.lugs.ch>, +Florian La Roche, and updated by Werner Fink. diff --git a/upstream/opensuse-leap-15-6/man8/mk_modmap.8 b/upstream/opensuse-leap-15-6/man8/mk_modmap.8 new file mode 100644 index 00000000..b35944f7 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/mk_modmap.8 @@ -0,0 +1,42 @@ +.\" @(#)mk_modmap.8 2002-02-22 mckinstry@computer.org +.TH MK_MODMAP 8 "2002-02-22" "kbd" + +.SH NAME +mk_modmap \- translate a Linux keytable file into an xmodmap file + +.SH SYNOPSIS +.B mk_modmap +[ +.B -v +] +keymap_file + +.SH DESCRIPTION +The +.B mk_modmap +command tries to translate a Linux console keytable file into +a file that can be parsed by xmodmap, and used within X. +It outputs the results to standard out. +.P +If the +.B -v +flag is used, verbose output is given. +.P +It requires the X header files to be installed. +(In Debian, these are in the "xlibs-dev" package). +.SH NOTES +Since XFree version 2.1, X initialises its keymap using the Linux +keymap, so xmodmap will often be superflous. + +.SH SEE ALSO +.BR dumpkeys (1), +.BR keymaps (5), +.BR xmodmap (1) + + +.\" .SH AUTHORS +.\" Kjetil T. Homme <kjetilho@ifi.uio.no> +.\" .br +.\" Pablo Saratxaga <pablo@mandrakesoft.com> +.\" .br +.\" Manpage by Alastair McKinstry, <mckinstry@computer.org> diff --git a/upstream/opensuse-leap-15-6/man8/mke2fs.8 b/upstream/opensuse-leap-15-6/man8/mke2fs.8 new file mode 100644 index 00000000..d39c024b --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/mke2fs.8 @@ -0,0 +1,891 @@ +.\" -*- 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 MKE2FS 8 "February 2023" "E2fsprogs version 1.47.0" +.SH NAME +mke2fs \- create an ext2/ext3/ext4 file system +.SH SYNOPSIS +.B mke2fs +[ +.B \-c +| +.B \-l +.I filename +] +[ +.B \-b +.I block-size +] +[ +.B \-C +.I cluster-size +] +[ +.B \-d +.I root-directory +] +[ +.B \-D +] +[ +.B \-g +.I blocks-per-group +] +[ +.B \-G +.I number-of-groups +] +[ +.B \-i +.I bytes-per-inode +] +[ +.B \-I +.I inode-size +] +[ +.B \-j +] +[ +.B \-J +.I journal-options +] +[ +.B \-N +.I number-of-inodes +] +[ +.B \-n +] +[ +.B \-m +.I reserved-blocks-percentage +] +[ +.B \-o +.I creator-os +] +[ +.B \-O +[^]\fIfeature\fR[,...] +] +[ +.B \-q +] +[ +.B \-r +.I fs-revision-level +] +[ +.B \-E +.I extended-options +] +[ +.B \-v +] +[ +.B \-F +] +[ +.B \-L +.I volume-label +] +[ +.B \-M +.I last-mounted-directory +] +[ +.B \-S +] +[ +.B \-t +.I fs-type +] +[ +.B \-T +.I usage-type +] +[ +.B \-U +.I UUID +] +[ +.B \-V +] +[ +.B \-e +.I errors-behavior +] +[ +.B \-z +.I undo_file +] +.I device +[ +.I fs-size +] +.sp +.B "mke2fs \-O journal_dev" +[ +.B \-b +.I block-size +] +.\" No external-journal specific journal options yet (size is ignored) +.\" [ +.\" .B \-J +.\" .I journal-options +.\" ] +[ +.B \-L +.I volume-label +] +[ +.B \-n +] +[ +.B \-q +] +[ +.B \-v +] +.I external-journal +[ +.I fs-size +] +.SH DESCRIPTION +.B mke2fs +is used to create an ext2, ext3, or ext4 file system, usually in a disk +partition (or file) named by +.IR device . +.PP +The file system size is specified by +.IR fs-size . +If +.I fs-size +does not have a suffix, it is interpreted as power-of-two kilobytes, +unless the +.B \-b +.I blocksize +option is specified, in which case +.I fs-size +is interpreted as the number of +.I blocksize +blocks. If the fs-size is suffixed by 'k', 'm', 'g', 't' +(either upper-case or lower-case), then it is interpreted in +power-of-two kilobytes, megabytes, gigabytes, terabytes, etc. +If +.I fs-size +is omitted, +.B mke2fs +will create the file system based on the device size. +.PP +If +.B mke2fs +is run as +.B mkfs.XXX +(i.e., +.BR mkfs.ext2 , +.BR mkfs.ext3 , +or +.BR mkfs.ext4 ) +the option +.B \-t +.I XXX +is implied; so +.B mkfs.ext3 +will create a file system for use with ext3, +.B mkfs.ext4 +will create a file system for use with ext4, and so on. +.PP +The defaults of the parameters for the newly created file system, if not +overridden by the options listed below, are controlled by the +.B /etc/mke2fs.conf +configuration file. See the +.BR mke2fs.conf (5) +manual page for more details. +.SH OPTIONS +.TP +.BI \-b " block-size" +Specify the size of blocks in bytes. Valid block-size values are powers of two +from 1024 up to 65536 (however note that the kernel is able to mount only +file systems with block-size smaller or equal to the system page size - 4k on +x86 systems, up to 64k on ppc64 or aarch64 depending on kernel configuration). +If omitted, block-size is heuristically determined by the file system size and +the expected usage of the file system (see the +.B \-T +option). In most common cases, the default block size is 4k. If +.I block-size +is preceded by a negative sign ('-'), then +.B mke2fs +will use heuristics to determine the +appropriate block size, with the constraint that the block size will be +at least +.I block-size +bytes. This is useful for certain hardware devices which require that +the blocksize be a multiple of 2k. +.TP +.B \-c +Check the device for bad blocks before creating the file system. If +this option is specified twice, then a slower read-write +test is used instead of a fast read-only test. +.TP +.B \-C " cluster-size" +Specify the size of cluster in bytes for file systems using the bigalloc +feature. Valid cluster-size values are from 2048 to 256M bytes per +cluster. This can only be specified if the bigalloc feature is +enabled. (See the +.B ext4 (5) +man page for more details about bigalloc.) The default cluster size if +bigalloc is enabled is 16 times the block size. +.TP +.BI \-d " root-directory" +Copy the contents of the given directory into the root directory of the +file system. +.TP +.B \-D +Use direct I/O when writing to the disk. This avoids mke2fs dirtying a +lot of buffer cache memory, which may impact other applications running +on a busy server. This option will cause mke2fs to run much more +slowly, however, so there is a tradeoff to using direct I/O. +.TP +.BI \-e " error-behavior" +Change the behavior of the kernel code when errors are detected. +In all cases, a file system error will cause +.BR e2fsck (8) +to check the file system on the next boot. +.I error-behavior +can be one of the following: +.RS 1.2i +.TP 1.2i +.B continue +Continue normal execution. +.TP +.B remount-ro +Remount file system read-only. +.TP +.B panic +Cause a kernel panic. +.RE +.TP +.BI \-E " extended-options" +Set extended options for the file system. Extended options are comma +separated, and may take an argument using the equals ('=') sign. The +.B \-E +option used to be +.B \-R +in earlier versions of +.BR mke2fs . +The +.B \-R +option is still accepted for backwards compatibility, but is deprecated. +The following extended options are supported: +.RS 1.2i +.TP +.BI encoding= encoding-name +Enable the +.I casefold +feature in the super block and set +.I encoding-name +as the encoding to be used. If +.I encoding-name +is not specified, the encoding defined in +.BR mke2fs.conf (5) +is used. +.TP +.BI encoding_flags= encoding-flags +Define parameters for file name character encoding operations. If a +flag is not changed using this parameter, its default value is used. +.I encoding-flags +should be a comma-separated lists of flags to be enabled. To disable a +flag, add it to the list with the prefix "no". + +The only flag that can be set right now is +.I strict +which means that invalid strings should be rejected by the file system. +In the default configuration, the +.I strict +flag is disabled. +.TP +.BI mmp_update_interval= interval +Adjust the initial MMP update interval to +.I interval +seconds. Specifying an +.I interval +of 0 means to use the default interval. The specified interval must +be less than 300 seconds. Requires that the +.B mmp +feature be enabled. +.TP +.BI stride= stride-size +Configure the file system for a RAID array with +.I stride-size +file system blocks. This is the number of blocks read or written to disk +before moving to the next disk, which is sometimes referred to as the +.I chunk size. +This mostly affects placement of file system metadata like bitmaps at +.B mke2fs +time to avoid placing them on a single disk, which can hurt performance. +It may also be used by the block allocator. +.TP +.BI stripe_width= stripe-width +Configure the file system for a RAID array with +.I stripe-width +file system blocks per stripe. This is typically stride-size * N, where +N is the number of data-bearing disks in the RAID (e.g. for RAID 5 there is one +parity disk, so N will be the number of disks in the array minus 1). +This allows the block allocator to prevent read-modify-write of the +parity in a RAID stripe if possible when the data is written. +.TP +.BI offset= offset +Create the file system at an offset from the beginning of the device or +file. This can be useful when creating disk images for virtual machines. +.TP +.BI resize= max-online-resize +Reserve enough space so that the block group descriptor table can grow +to support a file system that has +.I max-online-resize +blocks. +.TP +.B lazy_itable_init\fR[\fB= \fI<0 to disable, 1 to enable>\fR] +If enabled and the uninit_bg feature is enabled, the inode table will +not be fully initialized by +.BR mke2fs . +This speeds up file system +initialization noticeably, but it requires the kernel to finish +initializing the file system in the background when the file system is +first mounted. If the option value is omitted, it defaults to 1 to +enable lazy inode table zeroing. +.TP +.B lazy_journal_init\fR[\fB= \fI<0 to disable, 1 to enable>\fR] +If enabled, the journal inode will not be fully zeroed out by +.BR mke2fs . +This speeds up file system initialization noticeably, but carries some +small risk if the system crashes before the journal has been overwritten +entirely one time. If the option value is omitted, it defaults to 1 to +enable lazy journal inode zeroing. +.TP +.B assume_storage_prezeroed\fR[\fB= \fI<0 to disable, 1 to enable>\fR] +If enabled, +.BR mke2fs +assumes that the storage device has been prezeroed, skips zeroing the journal +and inode tables, and annotates the block group flags to signal that the inode +table has been zeroed. +.TP +.B no_copy_xattrs +Normally +.B mke2fs +will copy the extended attributes of the files in the directory +hierarchy specified via the (optional) +.B \-d +option. This will disable the copy and leaves the files in the newly +created file system without any extended attributes. +.TP +.BI num_backup_sb= <0|1|2> +If the +.B sparse_super2 +file system feature is enabled this option controls whether there will +be 0, 1, or 2 backup superblocks created in the file system. +.TP +.B packed_meta_blocks\fR[\fB= \fI<0 to disable, 1 to enable>\fR] +Place the allocation bitmaps and the inode table at the beginning of the +disk. This option requires that the flex_bg file system feature to be +enabled in order for it to have effect, and will also create the journal +at the beginning of the file system. This option is useful for flash +devices that use SLC flash at the beginning of the disk. +It also maximizes the range of contiguous data blocks, which +can be useful for certain specialized use cases, such as supported +Shingled Drives. +.TP +.BI root_owner [=uid:gid] +Specify the numeric user and group ID of the root directory. If no UID:GID +is specified, use the user and group ID of the user running \fBmke2fs\fR. +In \fBmke2fs\fR 1.42 and earlier the UID and GID of the root directory were +set by default to the UID and GID of the user running the mke2fs command. +The \fBroot_owner=\fR option allows explicitly specifying these values, +and avoid side-effects for users that do not expect the contents of the +file system to change based on the user running \fBmke2fs\fR. +.TP +.B test_fs +Set a flag in the file system superblock indicating that it may be +mounted using experimental kernel code, such as the ext4dev file system. +.TP +.BI orphan_file_size= size +Set size of the file for tracking unlinked but still open inodes and inodes +with truncate in progress. Larger file allows for better scalability, reserving +a few blocks per cpu is ideal. +.TP +.B discard +Attempt to discard blocks at mkfs time (discarding blocks initially is useful +on solid state devices and sparse / thin-provisioned storage). When the device +advertises that discard also zeroes data (any subsequent read after the discard +and before write returns zero), then mark all not-yet-zeroed inode tables as +zeroed. This significantly speeds up file system initialization. This is set +as default. +.TP +.B nodiscard +Do not attempt to discard blocks at mkfs time. +.TP +.B quotatype +Specify the which quota types (usrquota, grpquota, prjquota) which +should be enabled in the created file system. The argument of this +extended option should be a colon separated list. This option has +effect only if the +.B quota +feature is set. The default quota types to be initialized if this +option is not specified is both user and group quotas. If the project +feature is enabled that project quotas will be initialized as well. +.RE +.TP +.B \-F +Force +.B mke2fs +to create a file system, even if the specified device is not a partition +on a block special device, or if other parameters do not make sense. +In order to force +.B mke2fs +to create a file system even if the file system appears to be in use +or is mounted (a truly dangerous thing to do), this option must be +specified twice. +.TP +.BI \-g " blocks-per-group" +Specify the number of blocks in a block group. There is generally no +reason for the user to ever set this parameter, as the default is optimal +for the file system. (For administrators who are creating +file systems on RAID arrays, it is preferable to use the +.I stride +RAID parameter as part of the +.B \-E +option rather than manipulating the number of blocks per group.) +This option is generally used by developers who +are developing test cases. +.IP +If the bigalloc feature is enabled, the +.B \-g +option will specify the number of clusters in a block group. +.TP +.BI \-G " number-of-groups" +Specify the number of block groups that will be packed together to +create a larger virtual block group (or "flex_bg group") in an +ext4 file system. This improves meta-data locality and performance +on meta-data heavy workloads. The number of groups must be a power +of 2 and may only be specified if the +.B flex_bg +file system feature is enabled. +.TP +.BI \-i " bytes-per-inode" +Specify the bytes/inode ratio. +.B mke2fs +creates an inode for every +.I bytes-per-inode +bytes of space on the disk. The larger the +.I bytes-per-inode +ratio, the fewer inodes will be created. This value generally shouldn't +be smaller than the blocksize of the file system, since in that case more +inodes would be made than can ever be used. Be warned that it is not +possible to change this ratio on a file system after it is created, so be +careful deciding the correct value for this parameter. Note that resizing +a file system changes the number of inodes to maintain this ratio. +.TP +.BI \-I " inode-size" +Specify the size of each inode in bytes. +The +.I inode-size +value must be a power of 2 larger or equal to 128. The larger the +.I inode-size +the more space the inode table will consume, and this reduces the usable +space in the file system and can also negatively impact performance. +It is not +possible to change this value after the file system is created. +.IP +File systems with an inode size of 128 bytes do not support timestamps +beyond January 19, 2038. Inodes which are 256 bytes or larger will +support extended timestamps, project id's, and the ability to store some +extended attributes in the inode table for improved performance. +.IP +The default inode size is controlled by the +.BR mke2fs.conf (5) +file. In the +.B mke2fs.conf +file shipped with e2fsprogs, the default inode size is 256 bytes for +most file systems, except for small file systems where the inode size +will be 128 bytes. +.TP +.B \-j +Create the file system with an ext3 journal. If the +.B \-J +option is not specified, the default journal parameters will be used to +create an appropriately sized journal (given the size of the file system) +stored within the file system. Note that you must be using a kernel +which has ext3 support in order to actually make use of the journal. +.TP +.BI \-J " journal-options" +Create the ext3 journal using options specified on the command-line. +Journal options are comma +separated, and may take an argument using the equals ('=') sign. +The following journal options are supported: +.RS 1.2i +.TP +.BI size= journal-size +Create an internal journal (i.e., stored inside the file system) of size +.I journal-size +megabytes. +The size of the journal must be at least 1024 file system blocks +(i.e., 1MB if using 1k blocks, 4MB if using 4k blocks, etc.) +and may be no more than 10,240,000 file system blocks or half the total +file system size (whichever is smaller) +.TP +.BI fast_commit_size= fast-commit-size +Create an additional fast commit journal area of size +.I fast-commit-size +kilobytes. +This option is only valid if +.B fast_commit +feature is enabled +on the file system. If this option is not specified and if +.B fast_commit +feature is turned on, fast commit area size defaults to +.I journal-size +/ 64 megabytes. The total size of the journal with +.B fast_commit +feature set is +.I journal-size ++ ( +.I fast-commit-size +* 1024) megabytes. The total journal size may be no more than +10,240,000 file system blocks or half the total file system size +(whichever is smaller). +.TP +.BI location =journal-location +Specify the location of the journal. The argument +.I journal-location +can either be specified as a block number, or if the number has a units +suffix (e.g., 'M', 'G', etc.) interpret it as the offset from the +beginning of the file system. +.TP +.BI device= external-journal +Attach the file system to the journal block device located on +.IR external-journal . +The external +journal must already have been created using the command +.IP +.B mke2fs -O journal_dev +.I external-journal +.IP +Note that +.I external-journal +must have been created with the +same block size as the new file system. +In addition, while there is support for attaching +multiple file systems to a single external journal, +the Linux kernel and +.BR e2fsck (8) +do not currently support shared external journals yet. +.IP +Instead of specifying a device name directly, +.I external-journal +can also be specified by either +.BI LABEL= label +or +.BI UUID= UUID +to locate the external journal by either the volume label or UUID +stored in the ext2 superblock at the start of the journal. Use +.BR dumpe2fs (8) +to display a journal device's volume label and UUID. See also the +.B -L +option of +.BR tune2fs (8). +.RE +.IP +Only one of the +.BR size " or " device +options can be given for a file system. +.TP +.BI \-l " filename" +Read the bad blocks list from +.IR filename . +Note that the block numbers in the bad block list must be generated +using the same block size as used by +.BR mke2fs . +As a result, the +.B \-c +option to +.B mke2fs +is a much simpler and less error-prone method of checking a disk for bad +blocks before formatting it, as +.B mke2fs +will automatically pass the correct parameters to the +.B badblocks +program. +.TP +.BI \-L " new-volume-label" +Set the volume label for the file system to +.IR new-volume-label . +The maximum length of the +volume label is 16 bytes. +.TP +.BI \-m " reserved-blocks-percentage" +Specify the percentage of the file system blocks reserved for +the super-user. This avoids fragmentation, and allows root-owned +daemons, such as +.BR syslogd (8), +to continue to function correctly after non-privileged processes are +prevented from writing to the file system. The default percentage +is 5%. +.TP +.BI \-M " last-mounted-directory" +Set the last mounted directory for the file system. This might be useful +for the sake of utilities that key off of the last mounted directory to +determine where the file system should be mounted. +.TP +.B \-n +Causes +.B mke2fs +to not actually create a file system, but display what it +would do if it were to create a file system. This can be used to +determine the location of the backup superblocks for a particular +file system, so long as the +.B mke2fs +parameters that were passed when the +file system was originally created are used again. (With the +.B \-n +option added, of course!) +.TP +.BI \-N " number-of-inodes" +Overrides the default calculation of the number of inodes that should be +reserved for the file system (which is based on the number of blocks and +the +.I bytes-per-inode +ratio). This allows the user to specify the number +of desired inodes directly. +.TP +.BI \-o " creator-os" +Overrides the default value of the "creator operating system" field of the +file system. The creator field is set by default to the name of the OS the +.B mke2fs +executable was compiled for. +.TP +.B "\-O \fR[^]\fIfeature\fR[,...]" +Create a file system with the given features (file system options), +overriding the default file system options. The features that are +enabled by default are specified by the +.I base_features +relation, either in the +.I [defaults] +section in the +.B /etc/mke2fs.conf +configuration file, +or in the +.I [fs_types] +subsections for the usage types as specified by the +.B \-T +option, further modified by the +.I features +relation found in the +.I [fs_types] +subsections for the file system and usage types. See the +.BR mke2fs.conf (5) +manual page for more details. +The file system type-specific configuration setting found in the +.I [fs_types] +section will override the global default found in +.IR [defaults] . +.sp +The file system feature set will be further edited +using either the feature set specified by this option, +or if this option is not given, by the +.I default_features +relation for the file system type being created, or in the +.I [defaults] +section of the configuration file. +.sp +The file system feature set is comprised of a list of features, separated +by commas, that are to be enabled. To disable a feature, simply +prefix the feature name with a caret ('^') character. +Features with dependencies will not be removed successfully. +The pseudo-file system feature "none" will clear all file system features. +.TP +For more information about the features which can be set, please see +the manual page +.BR ext4 (5). +.TP +.B \-q +Quiet execution. Useful if +.B mke2fs +is run in a script. +.TP +.BI \-r " revision" +Set the file system revision for the new file system. Note that 1.2 +kernels only support revision 0 file systems. The default is to +create revision 1 file systems. +.TP +.B \-S +Write superblock and group descriptors only. This is an extreme +measure to be taken only in the very unlikely case that all of +the superblock and backup superblocks are corrupted, and a last-ditch +recovery method is desired by experienced users. It causes +.B mke2fs +to reinitialize the superblock and group descriptors, while not +touching the inode table and the block and inode bitmaps. The +.B e2fsck +program should be run immediately after this option is used, and there +is no guarantee that any data will be salvageable. Due to the wide +variety of possible options to +.B mke2fs +that affect the on-disk layout, it is critical to specify exactly +the same format options, such as blocksize, fs-type, feature flags, and +other tunables when using this option, or the file system will be further +corrupted. In some cases, such as file systems that have been resized, +or have had features enabled after format time, it is impossible to +overwrite all of the superblocks correctly, and at least some file system +corruption will occur. It is best to run this on a full copy of the +file system so other options can be tried if this doesn't work. +.\" .TP +.\" .BI \-t " test" +.\" Check the device for bad blocks before creating the file system +.\" using the specified test. +.TP +.BI \-t " fs-type" +Specify the file system type (i.e., ext2, ext3, ext4, etc.) that is +to be created. +If this option is not specified, +.B mke2fs +will pick a default either via how +the command was run (for example, using a name of the form mkfs.ext2, +mkfs.ext3, etc.) or via a default as defined by the +.B /etc/mke2fs.conf +file. This option controls which file system options are used by +default, based on the +.B fstypes +configuration stanza in +.BR /etc/mke2fs.conf . +.sp +If the +.B \-O +option is used to explicitly add or remove file system options that +should be set in the newly created file system, the +resulting file system may not be supported by the requested +.IR fs-type . +(e.g., "\fBmke2fs \-t ext3 \-O extent /dev/sdXX\fR" will create a +file system that is not supported by the ext3 implementation as found in +the Linux kernel; and "\fBmke2fs \-t ext3 \-O ^has_journal /dev/hdXX\fR" +will create a file system that does not have a journal and hence will not +be supported by the ext3 file system code in the Linux kernel.) +.TP +.BI \-T " usage-type[,...]" +Specify how the file system is going to be used, so that +.B mke2fs +can choose optimal file system parameters for that use. The usage +types that are supported are defined in the configuration file +.BR /etc/mke2fs.conf . +The user may specify one or more usage types +using a comma separated list. +.sp +If this option is is not specified, +.B mke2fs +will pick a single default usage type based on the size of the file system to +be created. If the file system size is less than 3 megabytes, +.B mke2fs +will use the file system type +.IR floppy . +If the file system size is greater than or equal to 3 but less than +512 megabytes, +.BR mke2fs (8) +will use the file system type +.IR small . +If the file system size is greater than or equal to 4 terabytes but less than +16 terabytes, +.BR mke2fs (8) +will use the file system type +.IR big . +If the file system size is greater than or equal to 16 terabytes, +.BR mke2fs (8) +will use the file system type +.IR huge . +Otherwise, +.BR mke2fs (8) +will use the default file system type +.IR default . +.TP +.BI \-U " UUID" +Set the universally unique identifier (UUID) of the file system to +.IR UUID . +The format of the UUID is a series of hex digits separated by hyphens, +like this: +"c1b9d5a2-f162-11cf-9ece-0020afc76f16". +The +.I UUID +parameter may also be one of the following: +.RS 1.2i +.TP +.I clear +clear the file system UUID +.TP +.I random +generate a new randomly-generated UUID +.TP +.I time +generate a new time-based UUID +.RE +.TP +.B \-v +Verbose execution. +.TP +.B \-V +Print the version number of +.B mke2fs +and exit. +.TP +.BI \-z " undo_file" +Before overwriting a file system block, write the old contents of the block to +an undo file. This undo file can be used with e2undo(8) to restore the old +contents of the file system should something go wrong. If the empty string is +passed as the undo_file argument, the undo file will be written to a file named +mke2fs-\fIdevice\fR.e2undo in the directory specified via the +\fIE2FSPROGS_UNDO_DIR\fR environment variable or the \fIundo_dir\fR directive +in the configuration file. + +WARNING: The undo file cannot be used to recover from a power or system crash. +.SH ENVIRONMENT +.TP +.B MKE2FS_SYNC +If set to non-zero integer value, its value is used to determine how often +.BR sync (2) +is called during inode table initialization. +.TP +.B MKE2FS_CONFIG +Determines the location of the configuration file (see +.BR mke2fs.conf (5)). +.TP +.B MKE2FS_FIRST_META_BG +If set to non-zero integer value, its value is used to determine first meta +block group. This is mostly for debugging purposes. +.TP +.B MKE2FS_DEVICE_SECTSIZE +If set to non-zero integer value, its value is used to determine logical +sector size of the +.IR device . +.TP +.B MKE2FS_DEVICE_PHYS_SECTSIZE +If set to non-zero integer value, its value is used to determine physical +sector size of the +.IR device . +.TP +.B MKE2FS_SKIP_CHECK_MSG +If set, do not show the message of file system automatic check caused by +mount count or check interval. +.SH AUTHOR +This version of +.B mke2fs +has been written by Theodore Ts'o <tytso@mit.edu>. +.SH AVAILABILITY +.B mke2fs +is part of the e2fsprogs package and is available from +http://e2fsprogs.sourceforge.net. +.SH SEE ALSO +.BR mke2fs.conf (5), +.BR badblocks (8), +.BR dumpe2fs (8), +.BR e2fsck (8), +.BR tune2fs (8), +.BR ext4 (5) diff --git a/upstream/opensuse-leap-15-6/man8/mkfs.8 b/upstream/opensuse-leap-15-6/man8/mkfs.8 new file mode 100644 index 00000000..c73300c6 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/mkfs.8 @@ -0,0 +1,102 @@ +'\" t +.\" Title: mkfs +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "MKFS" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +mkfs \- build a Linux filesystem +.SH "SYNOPSIS" +.sp +\fBmkfs\fP [options] [\fB\-t\fP \fItype\fP] [\fIfs\-options\fP] \fIdevice\fP [\fIsize\fP] +.SH "DESCRIPTION" +.sp +\fBThis mkfs frontend is deprecated in favour of filesystem specific mkfs.<type> utils.\fP +.sp +\fBmkfs\fP is used to build a Linux filesystem on a device, usually a hard disk partition. The \fIdevice\fP argument is either the device name (e.g., \fI/dev/hda1\fP, \fI/dev/sdb2\fP), or a regular file that shall contain the filesystem. The \fIsize\fP argument is the number of blocks to be used for the filesystem. +.sp +The exit status returned by \fBmkfs\fP is 0 on success and 1 on failure. +.sp +In actuality, \fBmkfs\fP is simply a front\-end for the various filesystem builders (\fBmkfs.\fP\fIfstype\fP) available under Linux. The filesystem\-specific builder is searched for via your \fBPATH\fP environment setting only. Please see the filesystem\-specific builder manual pages for further details. +.SH "OPTIONS" +.sp +\fB\-t\fP, \fB\-\-type\fP \fItype\fP +.RS 4 +Specify the \fItype\fP of filesystem to be built. If not specified, the default filesystem type (currently ext2) is used. +.RE +.sp +\fIfs\-options\fP +.RS 4 +Filesystem\-specific options to be passed to the real filesystem builder. +.RE +.sp +\fB\-V\fP, \fB\-\-verbose\fP +.RS 4 +Produce verbose output, including all filesystem\-specific commands that are executed. Specifying this option more than once inhibits execution of any filesystem\-specific commands. This is really only useful for testing. +.RE +.sp +\fB\-V\fP, \fB\-\-version\fP +.RS 4 +Display version information and exit. (Option \fB\-V\fP will display version information only when it is the only parameter, otherwise it will work as \fB\-\-verbose\fP.) +.RE +.sp +\fB\-h\fP, \fB\-\-help\fP +.RS 4 +Display help text and exit. +.RE +.SH "BUGS" +.sp +All generic options must precede and not be combined with filesystem\-specific options. Some filesystem\-specific programs do not automatically detect the device size and require the \fIsize\fP parameter to be specified. +.SH "AUTHORS" +.sp +.MTO "david\(atods.com" "David Engel" "," +.MTO "waltje\(atuwalt.nl.mugnet.org" "Fred N. van Kempen" "," +.MTO "sommel\(atsci.kun.nl" "Ron Sommeling" "." +.sp +The manual page was shamelessly adapted from Remy Card\(cqs version for the ext2 filesystem. +.SH "SEE ALSO" +.sp +\fBfs\fP(5), +\fBbadblocks\fP(8), +\fBfsck\fP(8), +\fBmkdosfs\fP(8), +\fBmke2fs\fP(8), +\fBmkfs.bfs\fP(8), +\fBmkfs.ext2\fP(8), +\fBmkfs.ext3\fP(8), +\fBmkfs.ext4\fP(8), +\fBmkfs.minix\fP(8), +\fBmkfs.msdos\fP(8), +\fBmkfs.vfat\fP(8), +\fBmkfs.xfs\fP(8) +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBmkfs\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/mkfs.bfs.8 b/upstream/opensuse-leap-15-6/man8/mkfs.bfs.8 new file mode 100644 index 00000000..b95d359f --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/mkfs.bfs.8 @@ -0,0 +1,94 @@ +'\" t +.\" Title: mkfs.bfs +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "MKFS.BFS" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +mkfs.bfs \- make an SCO bfs filesystem +.SH "SYNOPSIS" +.sp +\fBmkfs.bfs\fP [options] \fIdevice\fP [\fIblock\-count\fP] +.SH "DESCRIPTION" +.sp +\fBmkfs.bfs\fP creates an SCO bfs filesystem on a block device (usually a disk partition or a file accessed via the loop device). +.sp +The \fIblock\-count\fP parameter is the desired size of the filesystem, in blocks. If nothing is specified, the entire partition will be used. +.SH "OPTIONS" +.sp +\fB\-N\fP, \fB\-\-inodes\fP \fInumber\fP +.RS 4 +Specify the desired \fInumber\fP of inodes (at most 512). If nothing is specified, some default number in the range 48\-512 is picked depending on the size of the partition. +.RE +.sp +\fB\-V\fP, \fB\-\-vname\fP \fIlabel\fP +.RS 4 +Specify the volume \fIlabel\fP. I have no idea if/where this is used. +.RE +.sp +\fB\-F\fP, \fB\-\-fname\fP \fIname\fP +.RS 4 +Specify the filesystem \fIname\fP. I have no idea if/where this is used. +.RE +.sp +\fB\-v\fP, \fB\-\-verbose\fP +.RS 4 +Explain what is being done. +.RE +.sp +\fB\-c\fP +.RS 4 +This option is silently ignored. +.RE +.sp +\fB\-l\fP +.RS 4 +This option is silently ignored. +.RE +.sp +\fB\-h\fP, \fB\-\-help\fP +.RS 4 +Display help text and exit. +.RE +.sp +\fB\-V\fP, \fB\-\-version\fP +.RS 4 +Display version information and exit. Option \fB\-V\fP only works as \fB\-\-version\fP when it is the only option. +.RE +.SH "EXIT STATUS" +.sp +The exit status returned by \fBmkfs.bfs\fP is 0 when all went well, and 1 when something went wrong. +.SH "SEE ALSO" +.sp +\fBmkfs\fP(8) +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBmkfs.bfs\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/mkfs.btrfs.8 b/upstream/opensuse-leap-15-6/man8/mkfs.btrfs.8 new file mode 100644 index 00000000..d83791dc --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/mkfs.btrfs.8 @@ -0,0 +1,971 @@ +.\" Man page generated from reStructuredText. +. +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.TH "MKFS.BTRFS" "8" "Sep 13, 2023" "6.5.1" "BTRFS" +.SH NAME +mkfs.btrfs \- create a btrfs filesystem +.SH SYNOPSIS +.sp +\fBmkfs.btrfs\fP [options] <device> [<device>...] +.SH DESCRIPTION +.sp +\fBmkfs.btrfs\fP is used to create the btrfs filesystem on a single or multiple +devices. The \fIdevice\fP is typically a block device but can be a file\-backed image +as well. Multiple devices are grouped by UUID of the filesystem. +.sp +Before mounting such filesystem, the kernel module must know all the devices +either via preceding execution of \fBbtrfs device scan\fP or using the \fIdevice\fP +mount option. See section \fI\%MULTIPLE DEVICES\fP +for more details. +.sp +The default block group profiles for data and metadata depend on number of +devices and possibly other factors. It\(aqs recommended to use specific profiles +but the defaults should be OK and allowing future conversions to other profiles. +Please see options \fI\-d\fP and \fI\-m\fP for further details and \fI\%btrfs\-balance(8)\fP for +the profile conversion post mkfs. +.SH OPTIONS +.INDENT 0.0 +.TP +.B \-b|\-\-byte\-count <size> +Specify the size of each device as seen by the filesystem. If not set, +the entire device size is used. The total filesystem size will be sum +of all device sizes, for a single device filesystem the option +effectively specifies the size of the filesystem. +.UNINDENT +.INDENT 0.0 +.TP +.BI \-\-csum \ <type>\fR,\fB \ \-\-checksum \ <type> +Specify the checksum algorithm. Default is \fIcrc32c\fP\&. Valid values are \fIcrc32c\fP, +\fIxxhash\fP, \fIsha256\fP or \fIblake2\fP\&. To mount such filesystem kernel must support the +checksums as well. See section \fI\%CHECKSUM ALGORITHMS\fP +in \fI\%btrfs(5)\fP\&. +.UNINDENT +.INDENT 0.0 +.TP +.B \-d|\-\-data <profile> +Specify the profile for the data block groups. Valid values are \fIraid0\fP, +\fIraid1\fP, \fIraid1c3\fP, \fIraid1c4\fP, \fIraid5\fP, \fIraid6\fP, \fIraid10\fP or \fIsingle\fP or \fIdup\fP +(case does not matter). +.sp +See section \fI\%DUP PROFILES ON A SINGLE DEVICE\fP +for more details. +.sp +On multiple devices, the default was \fIraid0\fP until version 5.7, while it is +\fIsingle\fP since version 5.8. You can still select \fIraid0\fP manually, but it was not +suitable as default. +.TP +.B \-m|\-\-metadata <profile> +Specify the profile for the metadata block groups. +Valid values are \fIraid0\fP, \fIraid1\fP, \fIraid1c3\fP, \fIraid1c4\fP, \fIraid5\fP, \fIraid6\fP, +\fIraid10\fP, \fIsingle\fP or \fIdup\fP (case does not matter). +.sp +Default on a single device filesystem is \fIDUP\fP and is recommended for metadata +in general. The duplication might not be necessary in some use cases and it\(aqs +up to the user to changed that at mkfs time or later. This depends on hardware +that could potentially deduplicate the blocks again but this cannot be detected +at mkfs time. +.sp +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +Up to version 5.14 there was a detection of a SSD device (more precisely +if it\(aqs a rotational device, determined by the contents of file +\fB/sys/block/DEV/queue/rotational\fP) that used to select \fIsingle\fP\&. This has +changed in version 5.15 to be always \fIdup\fP\&. +.sp +Note that the rotational status can be arbitrarily set by the underlying block +device driver and may not reflect the true status (network block device, memory\-backed +SCSI devices, real block device behind some additional device mapper layer, +etc). It\(aqs recommended to always set the options \fI\-\-data/\-\-metadata\fP to avoid +confusion and unexpected results. +.sp +See section \fI\%DUP PROFILES ON A SINGLE DEVICE\fP +for more details. +.UNINDENT +.UNINDENT +.sp +On multiple devices the default is \fIraid1\fP\&. +.UNINDENT +.INDENT 0.0 +.TP +.B \-M|\-\-mixed +Normally the data and metadata block groups are isolated. The \fImixed\fP mode +will remove the isolation and store both types in the same block group type. +This helps to utilize the free space regardless of the purpose and is suitable +for small devices. The separate allocation of block groups leads to a situation +where the space is reserved for the other block group type, is not available for +allocation and can lead to ENOSPC state. +.sp +The recommended size for the mixed mode is for filesystems less than 1GiB. The +soft recommendation is to use it for filesystems smaller than 5GiB. The mixed +mode may lead to degraded performance on larger filesystems, but is otherwise +usable, even on multiple devices. +.sp +The \fInodesize\fP and \fIsectorsize\fP must be equal, and the block group types must +match. +.sp +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +Versions up to 4.2.x forced the mixed mode for devices smaller than 1GiB. +This has been removed in 4.3+ as it caused some usability issues. +.sp +Mixed profile cannot be used together with other profiles. It can only +be set at creation time. Conversion to or from mixed profile is not +implemented. +.UNINDENT +.UNINDENT +.TP +.B \-n|\-\-nodesize <size> +Specify the nodesize, the tree block size in which btrfs stores metadata. The +default value is 16KiB (16384) or the page size, whichever is bigger. Must be a +multiple of the sectorsize and a power of 2, but not larger than 64KiB (65536). +Leafsize always equals nodesize and the options are aliases. +.sp +Smaller node size increases fragmentation but leads to taller b\-trees which in +turn leads to lower locking contention. Higher node sizes give better packing +and less fragmentation at the cost of more expensive memory operations while +updating the metadata blocks. +.sp +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +Versions up to 3.11 set the nodesize to 4KiB. +.UNINDENT +.UNINDENT +.TP +.B \-s|\-\-sectorsize <size> +Specify the sectorsize, the minimum data block allocation unit. +.sp +The default value is the page size and is autodetected. If the sectorsize +differs from the page size, the created filesystem may not be mountable by the +running kernel. Therefore it is not recommended to use this option unless you +are going to mount it on a system with the appropriate page size. +.TP +.B \-L|\-\-label <string> +Specify a label for the filesystem. The \fIstring\fP should be less than 256 +bytes and must not contain newline characters. +.TP +.B \-K|\-\-nodiscard +Do not perform whole device TRIM operation on devices that are capable of that. +This does not affect discard/trim operation when the filesystem is mounted. +Please see the mount option \fIdiscard\fP for that in \fI\%btrfs(5)\fP\&. +.TP +.B \-r|\-\-rootdir <rootdir> +Populate the toplevel subvolume with files from \fIrootdir\fP\&. This does not +require root permissions to write the new files or to mount the filesystem. +.sp +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +This option may enlarge the image or file to ensure it\(aqs big enough to +contain the files from \fIrootdir\fP\&. Since version 4.14.1 the filesystem size is +not minimized. Please see option \fI\-\-shrink\fP if you need that functionality. +.UNINDENT +.UNINDENT +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-shrink +Shrink the filesystem to its minimal size, only works with \fI\-\-rootdir\fP option. +.sp +If the destination block device is a regular file, this option will also +truncate the file to the minimal size. Otherwise it will reduce the filesystem +available space. Extra space will not be usable unless the filesystem is +mounted and resized using \fBbtrfs filesystem resize\fP\&. +.sp +\fBNOTE:\fP +.INDENT 7.0 +.INDENT 3.5 +Prior to version 4.14.1, the shrinking was done automatically. +.UNINDENT +.UNINDENT +.UNINDENT +.INDENT 0.0 +.TP +.B \-O|\-\-features <feature1>[,<feature2>...] +A list of filesystem features turned on at mkfs time. Not all features are +supported by old kernels. To disable a feature, prefix it with \fI^\fP\&. +.sp +See section \fI\%FILESYSTEM FEATURES\fP +for more details. To see all available features that +\fBmkfs.btrfs\fP supports run: +.INDENT 7.0 +.INDENT 3.5 +.sp +.nf +.ft C +$ mkfs.btrfs \-O list\-all +.ft P +.fi +.UNINDENT +.UNINDENT +.TP +.B \-f|\-\-force +Forcibly overwrite the block devices when an existing filesystem is detected. +By default, \fBmkfs.btrfs\fP will utilize \fIlibblkid\fP to check for any known +filesystem on the devices. Alternatively you can use the \fBwipefs\fP utility +to clear the devices. +.TP +.B \-q|\-\-quiet +Print only error or warning messages. Options \fI\-\-features\fP or \fI\-\-help\fP are unaffected. +Resets any previous effects of \fI\-\-verbose\fP\&. +.TP +.B \-U|\-\-uuid <UUID> +Create the filesystem with the given \fIUUID\fP\&. The UUID must not exist on any +filesystem currently present. +.TP +.B \-v|\-\-verbose +Increase verbosity level, default is 1. +.TP +.B \-V|\-\-version +Print the \fBmkfs.btrfs\fP version and exit. +.UNINDENT +.INDENT 0.0 +.TP +.B \-\-help +Print help. +.UNINDENT +.INDENT 0.0 +.TP +.B \-l|\-\-leafsize <size> +Removed in 6.0, used to be alias for \fI\-\-nodesize\fP\&. +.TP +.B \-R|\-\-runtime\-features <feature1>[,<feature2>...] +Removed in 6.3, was used to specify features not affecting on\-disk format. +Now all such features are merged into \fI\-O|\-\-features\fP option. The option +\-R will stay for backward compatibility. +.UNINDENT +.SH SIZE UNITS +.sp +The default unit is \fIbyte\fP\&. All size parameters accept suffixes in the 1024 +base. The recognized suffixes are: \fIk\fP, \fIm\fP, \fIg\fP, \fIt\fP, \fIp\fP, \fIe\fP, both uppercase +and lowercase. +.SH MULTIPLE DEVICES +.sp +Before mounting a multiple device filesystem, the kernel module must know the +association of the block devices that are attached to the filesystem UUID. +.sp +There is typically no action needed from the user. On a system that utilizes a +udev\-like daemon, any new block device is automatically registered. The rules +call \fBbtrfs device scan\fP\&. +.sp +The same command can be used to trigger the device scanning if the btrfs kernel +module is reloaded (naturally all previous information about the device +registration is lost). +.sp +Another possibility is to use the mount options \fIdevice\fP to specify the list of +devices to scan at the time of mount. +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +# mount \-o device=/dev/sdb,device=/dev/sdc /dev/sda /mnt +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +\fBNOTE:\fP +.INDENT 0.0 +.INDENT 3.5 +This means only scanning, if the devices do not exist in the system, +mount will fail anyway. This can happen on systems without initramfs/initrd and +root partition created with RAID1/10/5/6 profiles. The mount action can happen +before all block devices are discovered. The waiting is usually done on the +initramfs/initrd systems. +.UNINDENT +.UNINDENT +.sp +\fBWARNING:\fP +.INDENT 0.0 +.INDENT 3.5 +RAID5/6 has known problems and should not be used in production. +.UNINDENT +.UNINDENT +.SH FILESYSTEM FEATURES +.sp +Features that can be enabled during creation time. See also \fI\%btrfs(5)\fP section +\fI\%FILESYSTEM FEATURES\fP\&. +.INDENT 0.0 +.TP +.B mixed\-bg +(kernel support since 2.6.37) +.sp +mixed data and metadata block groups, also set by option \fI\-\-mixed\fP +.UNINDENT +.INDENT 0.0 +.TP +.B extref +(default since btrfs\-progs 3.12, kernel support since 3.7) +.sp +increased hardlink limit per file in a directory to 65536, older kernels +supported a varying number of hardlinks depending on the sum of all file name +sizes that can be stored into one metadata block +.TP +.B raid56 +(kernel support since 3.9) +.sp +extended format for RAID5/6, also enabled if RAID5 or RAID6 block groups +are selected +.UNINDENT +.INDENT 0.0 +.TP +.B skinny\-metadata +(default since btrfs\-progs 3.18, kernel support since 3.10) +.sp +reduced\-size metadata for extent references, saves a few percent of metadata +.UNINDENT +.INDENT 0.0 +.TP +.B no\-holes +(default since btrfs\-progs 5.15, kernel support since 3.14) +.sp +improved representation of file extents where holes are not explicitly +stored as an extent, saves a few percent of metadata if sparse files are used +.TP +.B zoned +(kernel support since 5.12) +.sp +zoned mode, data allocation and write friendly to zoned/SMR/ZBC/ZNS devices, +see \fI\%ZONED MODE\fP in +\fI\%btrfs(5)\fP, the mode is automatically selected when a +zoned device is detected +.TP +.B quota +(kernel support since 3.4) +.sp +Enable quota support (qgroups). The qgroup accounting will be consistent, +can be used together with \fI\-\-rootdir\fP\&. See also \fI\%btrfs\-quota(8)\fP\&. +.UNINDENT +.INDENT 0.0 +.TP +.B free\-space\-tree +(default since btrfs\-progs 5.15, kernel support since 4.5) +.sp +Enable the free space tree (mount option \fIspace_cache=v2\fP) for persisting the +free space cache in a b\-tree. This is built on top of the COW mechanism +and has better performance than v1. +.sp +Offline conversion from filesystems that don\(aqt have this feature +enabled at \fImkfs\fP time is possible, see \fI\%btrfstune(8)\fP\&. +.sp +Online conversion can be done by mounting with \fBspace_cache=v2\fP, this +is sufficient to be done one time. +.UNINDENT +.INDENT 0.0 +.TP +.B block\-group\-tree +(kernel support since 6.1) +.sp +Enable a dedicated b\-tree for block group items, this greatly reduces +mount time for large filesystems due to better data locality that +avoids seeking. On rotational devices the \fIlarge\fP size is considered +starting from the 2\-4TiB. Can be used on other types of devices (SSD, +NVMe, ...) as well. +.sp +Offline conversion from filesystems that don\(aqt have this feature +enabled at \fImkfs\fP time is possible, see \fI\%btrfstune(8)\fP\&. Online +conversion is not possible. +.UNINDENT +.SH BLOCK GROUPS, CHUNKS, RAID +.sp +The highlevel organizational units of a filesystem are block groups of three types: +data, metadata and system. +.INDENT 0.0 +.TP +.B DATA +store data blocks and nothing else +.TP +.B METADATA +store internal metadata in b\-trees, can store file data if they fit into the +inline limit +.TP +.B SYSTEM +store structures that describe the mapping between the physical devices and the +linear logical space representing the filesystem +.UNINDENT +.sp +Other terms commonly used: +.INDENT 0.0 +.TP +.B block group, chunk +a logical range of space of a given profile, stores data, metadata or both; +sometimes the terms are used interchangeably +.sp +A typical size of metadata block group is 256MiB (filesystem smaller than +50GiB) and 1GiB (larger than 50GiB), for data it\(aqs 1GiB. The system block group +size is a few megabytes. +.TP +.B RAID +a block group profile type that utilizes RAID\-like features on multiple +devices: striping, mirroring, parity +.TP +.B profile +when used in connection with block groups refers to the allocation strategy +and constraints, see the section \fI\%PROFILES\fP for more details +.UNINDENT +.SH PROFILES +.sp +There are the following block group types available: +.TS +center; +|l|l|l|l|l|l|. +_ +T{ +Profiles +T} T{ +Redundancy +.sp +Copies +T} T{ +Redundancy +.sp +Parity +T} T{ +Redundancy +.sp +Striping +T} T{ +Space utilization +T} T{ +Min/max devices +T} +_ +T{ +single +T} T{ +1 +T} T{ +T} T{ +T} T{ +100% +T} T{ +1/any +T} +_ +T{ +DUP +T} T{ +2 / 1 device +T} T{ +T} T{ +T} T{ +50% +T} T{ +1/any (see note 1) +T} +_ +T{ +RAID0 +T} T{ +1 +T} T{ +T} T{ +1 to N +T} T{ +100% +T} T{ +1/any (see note 5) +T} +_ +T{ +RAID1 +T} T{ +2 +T} T{ +T} T{ +T} T{ +50% +T} T{ +2/any +T} +_ +T{ +RAID1C3 +T} T{ +3 +T} T{ +T} T{ +T} T{ +33% +T} T{ +3/any +T} +_ +T{ +RAID1C4 +T} T{ +4 +T} T{ +T} T{ +T} T{ +25% +T} T{ +4/any +T} +_ +T{ +RAID10 +T} T{ +2 +T} T{ +T} T{ +1 to N +T} T{ +50% +T} T{ +2/any (see note 5) +T} +_ +T{ +RAID5 +T} T{ +1 +T} T{ +1 +T} T{ +2 to N\-1 +T} T{ +(N\-1)/N +T} T{ +2/any (see note 2) +T} +_ +T{ +RAID6 +T} T{ +1 +T} T{ +2 +T} T{ +3 to N\-2 +T} T{ +(N\-2)/N +T} T{ +3/any (see note 3) +T} +_ +.TE +.sp +\fBWARNING:\fP +.INDENT 0.0 +.INDENT 3.5 +It\(aqs not recommended to create filesystems with RAID0/1/10/5/6 +profiles on partitions from the same device. Neither redundancy nor +performance will be improved. +.UNINDENT +.UNINDENT +.sp +\fINote 1:\fP DUP may exist on more than 1 device if it starts on a single device and +another one is added. Since version 4.5.1, \fBmkfs.btrfs\fP will let you create DUP +on multiple devices without restrictions. +.sp +\fINote 2:\fP It\(aqs not recommended to use 2 devices with RAID5. In that case, +parity stripe will contain the same data as the data stripe, making RAID5 +degraded to RAID1 with more overhead. +.sp +\fINote 3:\fP It\(aqs also not recommended to use 3 devices with RAID6, unless you +want to get effectively 3 copies in a RAID1\-like manner (but not exactly that). +.sp +\fINote 4:\fP Since kernel 5.5 it\(aqs possible to use RAID1C3 as replacement for +RAID6, higher space cost but reliable. +.sp +\fINote 5:\fP Since kernel 5.15 it\(aqs possible to use (mount, convert profiles) +RAID0 on one device and RAID10 on two devices. +.SS PROFILE LAYOUT +.sp +For the following examples, assume devices numbered by 1, 2, 3 and 4, data or +metadata blocks A, B, C, D, with possible stripes e.g. A1, A2 that would be +logically A, etc. For parity profiles PA and QA are parity and syndrome, +associated with the given stripe. The simple layouts single or DUP are left +out. Actual physical block placement on devices depends on current state of +the free/allocated space and may appear random. All devices are assumed to be +present at the time of the blocks would have been written. +.SS RAID1 +.TS +center; +|l|l|l|l|. +_ +T{ +device 1 +T} T{ +device 2 +T} T{ +device 3 +T} T{ +device 4 +T} +_ +T{ +A +T} T{ +D +T} T{ +T} T{ +T} +_ +T{ +B +T} T{ +T} T{ +T} T{ +C +T} +_ +T{ +C +T} T{ +T} T{ +T} T{ +T} +_ +T{ +D +T} T{ +A +T} T{ +B +T} T{ +T} +_ +.TE +.SS RAID1C3 +.TS +center; +|l|l|l|l|. +_ +T{ +device 1 +T} T{ +device 2 +T} T{ +device 3 +T} T{ +device 4 +T} +_ +T{ +A +T} T{ +A +T} T{ +D +T} T{ +T} +_ +T{ +B +T} T{ +T} T{ +B +T} T{ +T} +_ +T{ +C +T} T{ +T} T{ +A +T} T{ +C +T} +_ +T{ +D +T} T{ +D +T} T{ +C +T} T{ +B +T} +_ +.TE +.SS RAID0 +.TS +center; +|l|l|l|l|. +_ +T{ +device 1 +T} T{ +device 2 +T} T{ +device 3 +T} T{ +device 4 +T} +_ +T{ +A2 +T} T{ +C3 +T} T{ +A3 +T} T{ +C2 +T} +_ +T{ +B1 +T} T{ +A1 +T} T{ +D2 +T} T{ +B3 +T} +_ +T{ +C1 +T} T{ +D3 +T} T{ +B4 +T} T{ +D1 +T} +_ +T{ +D4 +T} T{ +B2 +T} T{ +C4 +T} T{ +A4 +T} +_ +.TE +.SS RAID5 +.TS +center; +|l|l|l|l|. +_ +T{ +device 1 +T} T{ +device 2 +T} T{ +device 3 +T} T{ +device 4 +T} +_ +T{ +A2 +T} T{ +C3 +T} T{ +A3 +T} T{ +C2 +T} +_ +T{ +B1 +T} T{ +A1 +T} T{ +D2 +T} T{ +B3 +T} +_ +T{ +C1 +T} T{ +D3 +T} T{ +PB +T} T{ +D1 +T} +_ +T{ +PD +T} T{ +B2 +T} T{ +PC +T} T{ +PA +T} +_ +.TE +.SS RAID6 +.TS +center; +|l|l|l|l|. +_ +T{ +device 1 +T} T{ +device 2 +T} T{ +device 3 +T} T{ +device 4 +T} +_ +T{ +A2 +T} T{ +QC +T} T{ +QA +T} T{ +C2 +T} +_ +T{ +B1 +T} T{ +A1 +T} T{ +D2 +T} T{ +QB +T} +_ +T{ +C1 +T} T{ +QD +T} T{ +PB +T} T{ +D1 +T} +_ +T{ +PD +T} T{ +B2 +T} T{ +PC +T} T{ +PA +T} +_ +.TE +.SH DUP PROFILES ON A SINGLE DEVICE +.sp +The mkfs utility will let the user create a filesystem with profiles that write +the logical blocks to 2 physical locations. Whether there are really 2 +physical copies highly depends on the underlying device type. +.sp +For example, a SSD drive can remap the blocks internally to a single copy\-\-thus +deduplicating them. This negates the purpose of increased redundancy and just +wastes filesystem space without providing the expected level of redundancy. +.sp +The duplicated data/metadata may still be useful to statistically improve the +chances on a device that might perform some internal optimizations. The actual +details are not usually disclosed by vendors. For example we could expect that +not all blocks get deduplicated. This will provide a non\-zero probability of +recovery compared to a zero chance if the single profile is used. The user +should make the tradeoff decision. The deduplication in SSDs is thought to be +widely available so the reason behind the mkfs default is to not give a false +sense of redundancy. +.sp +As another example, the widely used USB flash or SD cards use a translation +layer between the logical and physical view of the device. The data lifetime +may be affected by frequent plugging. The memory cells could get damaged, +hopefully not destroying both copies of particular data in case of DUP. +.sp +The wear levelling techniques can also lead to reduced redundancy, even if the +device does not do any deduplication. The controllers may put data written in +a short timespan into the same physical storage unit (cell, block etc). In case +this unit dies, both copies are lost. BTRFS does not add any artificial delay +between metadata writes. +.sp +The traditional rotational hard drives usually fail at the sector level. +.sp +In any case, a device that starts to misbehave and repairs from the DUP copy +should be replaced! \fBDUP is not backup\fP\&. +.SH KNOWN ISSUES +.sp +\fBSMALL FILESYSTEMS AND LARGE NODESIZE\fP +.sp +The combination of small filesystem size and large nodesize is not recommended +in general and can lead to various ENOSPC\-related issues during mount time or runtime. +.sp +Since mixed block group creation is optional, we allow small +filesystem instances with differing values for \fIsectorsize\fP and \fInodesize\fP +to be created and could end up in the following situation: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +# mkfs.btrfs \-f \-n 65536 /dev/loop0 +btrfs\-progs v3.19\-rc2\-405\-g976307c +See https://btrfs.readthedocs.io for more information. + +Performing full device TRIM (512.00MiB) ... +Label: (null) +UUID: 49fab72e\-0c8b\-466b\-a3ca\-d1bfe56475f0 +Node size: 65536 +Sector size: 4096 +Filesystem size: 512.00MiB +Block group profiles: + Data: single 8.00MiB + Metadata: DUP 40.00MiB + System: DUP 12.00MiB +SSD detected: no +Incompat features: extref, skinny\-metadata +Number of devices: 1 +Devices: + ID SIZE PATH + 1 512.00MiB /dev/loop0 + +# mount /dev/loop0 /mnt/ +mount: mount /dev/loop0 on /mnt failed: No space left on device +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +The ENOSPC occurs during the creation of the UUID tree. This is caused +by large metadata blocks and space reservation strategy that allocates more +than can fit into the filesystem. +.SH AVAILABILITY +.sp +\fBbtrfs\fP is part of btrfs\-progs. Please refer to the documentation at +\fI\%https://btrfs.readthedocs.io\fP\&. +.SH SEE ALSO +.sp +\fI\%btrfs(5)\fP, +\fI\%btrfs(8)\fP, +\fI\%btrfs\-balance(8)\fP, +\fBwipefs(8)\fP +.\" Generated by docutils manpage writer. +. diff --git a/upstream/opensuse-leap-15-6/man8/mkfs.cramfs.8 b/upstream/opensuse-leap-15-6/man8/mkfs.cramfs.8 new file mode 100644 index 00000000..da550c2d --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/mkfs.cramfs.8 @@ -0,0 +1,132 @@ +'\" t +.\" Title: mkfs.cramfs +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "MKFS.CRAMFS" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +mkfs.cramfs \- make compressed ROM file system +.SH "SYNOPSIS" +.sp +\fBmkfs.cramfs\fP [options] \fIdirectory file\fP +.SH "DESCRIPTION" +.sp +Files on cramfs file systems are zlib\-compressed one page at a time to allow random read access. The metadata is not compressed, but is expressed in a terse representation that is more space\-efficient than conventional file systems. +.sp +The file system is intentionally read\-only to simplify its design; random write access for compressed files is difficult to implement. cramfs ships with a utility (\fBmkcramfs\fP(8)) to pack files into new cramfs images. +.sp +File sizes are limited to less than 16 MB. +.sp +Maximum file system size is a little under 272 MB. (The last file on the file system must begin before the 256 MB block, but can extend past it.) +.SH "ARGUMENTS" +.sp +The \fIdirectory\fP is simply the root of the directory tree that we want to generate a compressed filesystem out of. +.sp +The \fIfile\fP will contain the cram file system, which later can be mounted. +.SH "OPTIONS" +.sp +\fB\-v\fP +.RS 4 +Enable verbose messaging. +.RE +.sp +\fB\-E\fP +.RS 4 +Treat all warnings as errors, which are reflected as command exit status. +.RE +.sp +\fB\-b\fP \fIblocksize\fP +.RS 4 +Use defined block size, which has to be divisible by page size. +.RE +.sp +\fB\-e\fP \fIedition\fP +.RS 4 +Use defined file system edition number in superblock. +.RE +.sp +\fB\-N\fP \fIbig, little, host\fP +.RS 4 +Use defined endianness. Value defaults to \fIhost\fP. +.RE +.sp +\fB\-i\fP \fIfile\fP +.RS 4 +Insert a \fIfile\fP to cramfs file system. +.RE +.sp +\fB\-n\fP \fIname\fP +.RS 4 +Set name of the cramfs file system. +.RE +.sp +\fB\-p\fP +.RS 4 +Pad by 512 bytes for boot code. +.RE +.sp +\fB\-s\fP +.RS 4 +This option is ignored. Originally the \fB\-s\fP turned on directory entry sorting. +.RE +.sp +\fB\-z\fP +.RS 4 +Make explicit holes. +.RE +.sp +\fB\-h\fP, \fB\-\-help\fP +.RS 4 +Display help text and exit. +.RE +.sp +\fB\-V\fP, \fB\-\-version\fP +.RS 4 +Display version information and exit. +.RE +.SH "EXIT STATUS" +.sp +\fB0\fP +.RS 4 +success +.RE +.sp +\fB8\fP +.RS 4 +operation error, such as unable to allocate memory +.RE +.SH "SEE ALSO" +.sp +\fBfsck.cramfs\fP(8), +\fBmount\fP(8) +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBmkfs.cramfs\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/mkfs.ext2.8 b/upstream/opensuse-leap-15-6/man8/mkfs.ext2.8 new file mode 100644 index 00000000..d39c024b --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/mkfs.ext2.8 @@ -0,0 +1,891 @@ +.\" -*- 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 MKE2FS 8 "February 2023" "E2fsprogs version 1.47.0" +.SH NAME +mke2fs \- create an ext2/ext3/ext4 file system +.SH SYNOPSIS +.B mke2fs +[ +.B \-c +| +.B \-l +.I filename +] +[ +.B \-b +.I block-size +] +[ +.B \-C +.I cluster-size +] +[ +.B \-d +.I root-directory +] +[ +.B \-D +] +[ +.B \-g +.I blocks-per-group +] +[ +.B \-G +.I number-of-groups +] +[ +.B \-i +.I bytes-per-inode +] +[ +.B \-I +.I inode-size +] +[ +.B \-j +] +[ +.B \-J +.I journal-options +] +[ +.B \-N +.I number-of-inodes +] +[ +.B \-n +] +[ +.B \-m +.I reserved-blocks-percentage +] +[ +.B \-o +.I creator-os +] +[ +.B \-O +[^]\fIfeature\fR[,...] +] +[ +.B \-q +] +[ +.B \-r +.I fs-revision-level +] +[ +.B \-E +.I extended-options +] +[ +.B \-v +] +[ +.B \-F +] +[ +.B \-L +.I volume-label +] +[ +.B \-M +.I last-mounted-directory +] +[ +.B \-S +] +[ +.B \-t +.I fs-type +] +[ +.B \-T +.I usage-type +] +[ +.B \-U +.I UUID +] +[ +.B \-V +] +[ +.B \-e +.I errors-behavior +] +[ +.B \-z +.I undo_file +] +.I device +[ +.I fs-size +] +.sp +.B "mke2fs \-O journal_dev" +[ +.B \-b +.I block-size +] +.\" No external-journal specific journal options yet (size is ignored) +.\" [ +.\" .B \-J +.\" .I journal-options +.\" ] +[ +.B \-L +.I volume-label +] +[ +.B \-n +] +[ +.B \-q +] +[ +.B \-v +] +.I external-journal +[ +.I fs-size +] +.SH DESCRIPTION +.B mke2fs +is used to create an ext2, ext3, or ext4 file system, usually in a disk +partition (or file) named by +.IR device . +.PP +The file system size is specified by +.IR fs-size . +If +.I fs-size +does not have a suffix, it is interpreted as power-of-two kilobytes, +unless the +.B \-b +.I blocksize +option is specified, in which case +.I fs-size +is interpreted as the number of +.I blocksize +blocks. If the fs-size is suffixed by 'k', 'm', 'g', 't' +(either upper-case or lower-case), then it is interpreted in +power-of-two kilobytes, megabytes, gigabytes, terabytes, etc. +If +.I fs-size +is omitted, +.B mke2fs +will create the file system based on the device size. +.PP +If +.B mke2fs +is run as +.B mkfs.XXX +(i.e., +.BR mkfs.ext2 , +.BR mkfs.ext3 , +or +.BR mkfs.ext4 ) +the option +.B \-t +.I XXX +is implied; so +.B mkfs.ext3 +will create a file system for use with ext3, +.B mkfs.ext4 +will create a file system for use with ext4, and so on. +.PP +The defaults of the parameters for the newly created file system, if not +overridden by the options listed below, are controlled by the +.B /etc/mke2fs.conf +configuration file. See the +.BR mke2fs.conf (5) +manual page for more details. +.SH OPTIONS +.TP +.BI \-b " block-size" +Specify the size of blocks in bytes. Valid block-size values are powers of two +from 1024 up to 65536 (however note that the kernel is able to mount only +file systems with block-size smaller or equal to the system page size - 4k on +x86 systems, up to 64k on ppc64 or aarch64 depending on kernel configuration). +If omitted, block-size is heuristically determined by the file system size and +the expected usage of the file system (see the +.B \-T +option). In most common cases, the default block size is 4k. If +.I block-size +is preceded by a negative sign ('-'), then +.B mke2fs +will use heuristics to determine the +appropriate block size, with the constraint that the block size will be +at least +.I block-size +bytes. This is useful for certain hardware devices which require that +the blocksize be a multiple of 2k. +.TP +.B \-c +Check the device for bad blocks before creating the file system. If +this option is specified twice, then a slower read-write +test is used instead of a fast read-only test. +.TP +.B \-C " cluster-size" +Specify the size of cluster in bytes for file systems using the bigalloc +feature. Valid cluster-size values are from 2048 to 256M bytes per +cluster. This can only be specified if the bigalloc feature is +enabled. (See the +.B ext4 (5) +man page for more details about bigalloc.) The default cluster size if +bigalloc is enabled is 16 times the block size. +.TP +.BI \-d " root-directory" +Copy the contents of the given directory into the root directory of the +file system. +.TP +.B \-D +Use direct I/O when writing to the disk. This avoids mke2fs dirtying a +lot of buffer cache memory, which may impact other applications running +on a busy server. This option will cause mke2fs to run much more +slowly, however, so there is a tradeoff to using direct I/O. +.TP +.BI \-e " error-behavior" +Change the behavior of the kernel code when errors are detected. +In all cases, a file system error will cause +.BR e2fsck (8) +to check the file system on the next boot. +.I error-behavior +can be one of the following: +.RS 1.2i +.TP 1.2i +.B continue +Continue normal execution. +.TP +.B remount-ro +Remount file system read-only. +.TP +.B panic +Cause a kernel panic. +.RE +.TP +.BI \-E " extended-options" +Set extended options for the file system. Extended options are comma +separated, and may take an argument using the equals ('=') sign. The +.B \-E +option used to be +.B \-R +in earlier versions of +.BR mke2fs . +The +.B \-R +option is still accepted for backwards compatibility, but is deprecated. +The following extended options are supported: +.RS 1.2i +.TP +.BI encoding= encoding-name +Enable the +.I casefold +feature in the super block and set +.I encoding-name +as the encoding to be used. If +.I encoding-name +is not specified, the encoding defined in +.BR mke2fs.conf (5) +is used. +.TP +.BI encoding_flags= encoding-flags +Define parameters for file name character encoding operations. If a +flag is not changed using this parameter, its default value is used. +.I encoding-flags +should be a comma-separated lists of flags to be enabled. To disable a +flag, add it to the list with the prefix "no". + +The only flag that can be set right now is +.I strict +which means that invalid strings should be rejected by the file system. +In the default configuration, the +.I strict +flag is disabled. +.TP +.BI mmp_update_interval= interval +Adjust the initial MMP update interval to +.I interval +seconds. Specifying an +.I interval +of 0 means to use the default interval. The specified interval must +be less than 300 seconds. Requires that the +.B mmp +feature be enabled. +.TP +.BI stride= stride-size +Configure the file system for a RAID array with +.I stride-size +file system blocks. This is the number of blocks read or written to disk +before moving to the next disk, which is sometimes referred to as the +.I chunk size. +This mostly affects placement of file system metadata like bitmaps at +.B mke2fs +time to avoid placing them on a single disk, which can hurt performance. +It may also be used by the block allocator. +.TP +.BI stripe_width= stripe-width +Configure the file system for a RAID array with +.I stripe-width +file system blocks per stripe. This is typically stride-size * N, where +N is the number of data-bearing disks in the RAID (e.g. for RAID 5 there is one +parity disk, so N will be the number of disks in the array minus 1). +This allows the block allocator to prevent read-modify-write of the +parity in a RAID stripe if possible when the data is written. +.TP +.BI offset= offset +Create the file system at an offset from the beginning of the device or +file. This can be useful when creating disk images for virtual machines. +.TP +.BI resize= max-online-resize +Reserve enough space so that the block group descriptor table can grow +to support a file system that has +.I max-online-resize +blocks. +.TP +.B lazy_itable_init\fR[\fB= \fI<0 to disable, 1 to enable>\fR] +If enabled and the uninit_bg feature is enabled, the inode table will +not be fully initialized by +.BR mke2fs . +This speeds up file system +initialization noticeably, but it requires the kernel to finish +initializing the file system in the background when the file system is +first mounted. If the option value is omitted, it defaults to 1 to +enable lazy inode table zeroing. +.TP +.B lazy_journal_init\fR[\fB= \fI<0 to disable, 1 to enable>\fR] +If enabled, the journal inode will not be fully zeroed out by +.BR mke2fs . +This speeds up file system initialization noticeably, but carries some +small risk if the system crashes before the journal has been overwritten +entirely one time. If the option value is omitted, it defaults to 1 to +enable lazy journal inode zeroing. +.TP +.B assume_storage_prezeroed\fR[\fB= \fI<0 to disable, 1 to enable>\fR] +If enabled, +.BR mke2fs +assumes that the storage device has been prezeroed, skips zeroing the journal +and inode tables, and annotates the block group flags to signal that the inode +table has been zeroed. +.TP +.B no_copy_xattrs +Normally +.B mke2fs +will copy the extended attributes of the files in the directory +hierarchy specified via the (optional) +.B \-d +option. This will disable the copy and leaves the files in the newly +created file system without any extended attributes. +.TP +.BI num_backup_sb= <0|1|2> +If the +.B sparse_super2 +file system feature is enabled this option controls whether there will +be 0, 1, or 2 backup superblocks created in the file system. +.TP +.B packed_meta_blocks\fR[\fB= \fI<0 to disable, 1 to enable>\fR] +Place the allocation bitmaps and the inode table at the beginning of the +disk. This option requires that the flex_bg file system feature to be +enabled in order for it to have effect, and will also create the journal +at the beginning of the file system. This option is useful for flash +devices that use SLC flash at the beginning of the disk. +It also maximizes the range of contiguous data blocks, which +can be useful for certain specialized use cases, such as supported +Shingled Drives. +.TP +.BI root_owner [=uid:gid] +Specify the numeric user and group ID of the root directory. If no UID:GID +is specified, use the user and group ID of the user running \fBmke2fs\fR. +In \fBmke2fs\fR 1.42 and earlier the UID and GID of the root directory were +set by default to the UID and GID of the user running the mke2fs command. +The \fBroot_owner=\fR option allows explicitly specifying these values, +and avoid side-effects for users that do not expect the contents of the +file system to change based on the user running \fBmke2fs\fR. +.TP +.B test_fs +Set a flag in the file system superblock indicating that it may be +mounted using experimental kernel code, such as the ext4dev file system. +.TP +.BI orphan_file_size= size +Set size of the file for tracking unlinked but still open inodes and inodes +with truncate in progress. Larger file allows for better scalability, reserving +a few blocks per cpu is ideal. +.TP +.B discard +Attempt to discard blocks at mkfs time (discarding blocks initially is useful +on solid state devices and sparse / thin-provisioned storage). When the device +advertises that discard also zeroes data (any subsequent read after the discard +and before write returns zero), then mark all not-yet-zeroed inode tables as +zeroed. This significantly speeds up file system initialization. This is set +as default. +.TP +.B nodiscard +Do not attempt to discard blocks at mkfs time. +.TP +.B quotatype +Specify the which quota types (usrquota, grpquota, prjquota) which +should be enabled in the created file system. The argument of this +extended option should be a colon separated list. This option has +effect only if the +.B quota +feature is set. The default quota types to be initialized if this +option is not specified is both user and group quotas. If the project +feature is enabled that project quotas will be initialized as well. +.RE +.TP +.B \-F +Force +.B mke2fs +to create a file system, even if the specified device is not a partition +on a block special device, or if other parameters do not make sense. +In order to force +.B mke2fs +to create a file system even if the file system appears to be in use +or is mounted (a truly dangerous thing to do), this option must be +specified twice. +.TP +.BI \-g " blocks-per-group" +Specify the number of blocks in a block group. There is generally no +reason for the user to ever set this parameter, as the default is optimal +for the file system. (For administrators who are creating +file systems on RAID arrays, it is preferable to use the +.I stride +RAID parameter as part of the +.B \-E +option rather than manipulating the number of blocks per group.) +This option is generally used by developers who +are developing test cases. +.IP +If the bigalloc feature is enabled, the +.B \-g +option will specify the number of clusters in a block group. +.TP +.BI \-G " number-of-groups" +Specify the number of block groups that will be packed together to +create a larger virtual block group (or "flex_bg group") in an +ext4 file system. This improves meta-data locality and performance +on meta-data heavy workloads. The number of groups must be a power +of 2 and may only be specified if the +.B flex_bg +file system feature is enabled. +.TP +.BI \-i " bytes-per-inode" +Specify the bytes/inode ratio. +.B mke2fs +creates an inode for every +.I bytes-per-inode +bytes of space on the disk. The larger the +.I bytes-per-inode +ratio, the fewer inodes will be created. This value generally shouldn't +be smaller than the blocksize of the file system, since in that case more +inodes would be made than can ever be used. Be warned that it is not +possible to change this ratio on a file system after it is created, so be +careful deciding the correct value for this parameter. Note that resizing +a file system changes the number of inodes to maintain this ratio. +.TP +.BI \-I " inode-size" +Specify the size of each inode in bytes. +The +.I inode-size +value must be a power of 2 larger or equal to 128. The larger the +.I inode-size +the more space the inode table will consume, and this reduces the usable +space in the file system and can also negatively impact performance. +It is not +possible to change this value after the file system is created. +.IP +File systems with an inode size of 128 bytes do not support timestamps +beyond January 19, 2038. Inodes which are 256 bytes or larger will +support extended timestamps, project id's, and the ability to store some +extended attributes in the inode table for improved performance. +.IP +The default inode size is controlled by the +.BR mke2fs.conf (5) +file. In the +.B mke2fs.conf +file shipped with e2fsprogs, the default inode size is 256 bytes for +most file systems, except for small file systems where the inode size +will be 128 bytes. +.TP +.B \-j +Create the file system with an ext3 journal. If the +.B \-J +option is not specified, the default journal parameters will be used to +create an appropriately sized journal (given the size of the file system) +stored within the file system. Note that you must be using a kernel +which has ext3 support in order to actually make use of the journal. +.TP +.BI \-J " journal-options" +Create the ext3 journal using options specified on the command-line. +Journal options are comma +separated, and may take an argument using the equals ('=') sign. +The following journal options are supported: +.RS 1.2i +.TP +.BI size= journal-size +Create an internal journal (i.e., stored inside the file system) of size +.I journal-size +megabytes. +The size of the journal must be at least 1024 file system blocks +(i.e., 1MB if using 1k blocks, 4MB if using 4k blocks, etc.) +and may be no more than 10,240,000 file system blocks or half the total +file system size (whichever is smaller) +.TP +.BI fast_commit_size= fast-commit-size +Create an additional fast commit journal area of size +.I fast-commit-size +kilobytes. +This option is only valid if +.B fast_commit +feature is enabled +on the file system. If this option is not specified and if +.B fast_commit +feature is turned on, fast commit area size defaults to +.I journal-size +/ 64 megabytes. The total size of the journal with +.B fast_commit +feature set is +.I journal-size ++ ( +.I fast-commit-size +* 1024) megabytes. The total journal size may be no more than +10,240,000 file system blocks or half the total file system size +(whichever is smaller). +.TP +.BI location =journal-location +Specify the location of the journal. The argument +.I journal-location +can either be specified as a block number, or if the number has a units +suffix (e.g., 'M', 'G', etc.) interpret it as the offset from the +beginning of the file system. +.TP +.BI device= external-journal +Attach the file system to the journal block device located on +.IR external-journal . +The external +journal must already have been created using the command +.IP +.B mke2fs -O journal_dev +.I external-journal +.IP +Note that +.I external-journal +must have been created with the +same block size as the new file system. +In addition, while there is support for attaching +multiple file systems to a single external journal, +the Linux kernel and +.BR e2fsck (8) +do not currently support shared external journals yet. +.IP +Instead of specifying a device name directly, +.I external-journal +can also be specified by either +.BI LABEL= label +or +.BI UUID= UUID +to locate the external journal by either the volume label or UUID +stored in the ext2 superblock at the start of the journal. Use +.BR dumpe2fs (8) +to display a journal device's volume label and UUID. See also the +.B -L +option of +.BR tune2fs (8). +.RE +.IP +Only one of the +.BR size " or " device +options can be given for a file system. +.TP +.BI \-l " filename" +Read the bad blocks list from +.IR filename . +Note that the block numbers in the bad block list must be generated +using the same block size as used by +.BR mke2fs . +As a result, the +.B \-c +option to +.B mke2fs +is a much simpler and less error-prone method of checking a disk for bad +blocks before formatting it, as +.B mke2fs +will automatically pass the correct parameters to the +.B badblocks +program. +.TP +.BI \-L " new-volume-label" +Set the volume label for the file system to +.IR new-volume-label . +The maximum length of the +volume label is 16 bytes. +.TP +.BI \-m " reserved-blocks-percentage" +Specify the percentage of the file system blocks reserved for +the super-user. This avoids fragmentation, and allows root-owned +daemons, such as +.BR syslogd (8), +to continue to function correctly after non-privileged processes are +prevented from writing to the file system. The default percentage +is 5%. +.TP +.BI \-M " last-mounted-directory" +Set the last mounted directory for the file system. This might be useful +for the sake of utilities that key off of the last mounted directory to +determine where the file system should be mounted. +.TP +.B \-n +Causes +.B mke2fs +to not actually create a file system, but display what it +would do if it were to create a file system. This can be used to +determine the location of the backup superblocks for a particular +file system, so long as the +.B mke2fs +parameters that were passed when the +file system was originally created are used again. (With the +.B \-n +option added, of course!) +.TP +.BI \-N " number-of-inodes" +Overrides the default calculation of the number of inodes that should be +reserved for the file system (which is based on the number of blocks and +the +.I bytes-per-inode +ratio). This allows the user to specify the number +of desired inodes directly. +.TP +.BI \-o " creator-os" +Overrides the default value of the "creator operating system" field of the +file system. The creator field is set by default to the name of the OS the +.B mke2fs +executable was compiled for. +.TP +.B "\-O \fR[^]\fIfeature\fR[,...]" +Create a file system with the given features (file system options), +overriding the default file system options. The features that are +enabled by default are specified by the +.I base_features +relation, either in the +.I [defaults] +section in the +.B /etc/mke2fs.conf +configuration file, +or in the +.I [fs_types] +subsections for the usage types as specified by the +.B \-T +option, further modified by the +.I features +relation found in the +.I [fs_types] +subsections for the file system and usage types. See the +.BR mke2fs.conf (5) +manual page for more details. +The file system type-specific configuration setting found in the +.I [fs_types] +section will override the global default found in +.IR [defaults] . +.sp +The file system feature set will be further edited +using either the feature set specified by this option, +or if this option is not given, by the +.I default_features +relation for the file system type being created, or in the +.I [defaults] +section of the configuration file. +.sp +The file system feature set is comprised of a list of features, separated +by commas, that are to be enabled. To disable a feature, simply +prefix the feature name with a caret ('^') character. +Features with dependencies will not be removed successfully. +The pseudo-file system feature "none" will clear all file system features. +.TP +For more information about the features which can be set, please see +the manual page +.BR ext4 (5). +.TP +.B \-q +Quiet execution. Useful if +.B mke2fs +is run in a script. +.TP +.BI \-r " revision" +Set the file system revision for the new file system. Note that 1.2 +kernels only support revision 0 file systems. The default is to +create revision 1 file systems. +.TP +.B \-S +Write superblock and group descriptors only. This is an extreme +measure to be taken only in the very unlikely case that all of +the superblock and backup superblocks are corrupted, and a last-ditch +recovery method is desired by experienced users. It causes +.B mke2fs +to reinitialize the superblock and group descriptors, while not +touching the inode table and the block and inode bitmaps. The +.B e2fsck +program should be run immediately after this option is used, and there +is no guarantee that any data will be salvageable. Due to the wide +variety of possible options to +.B mke2fs +that affect the on-disk layout, it is critical to specify exactly +the same format options, such as blocksize, fs-type, feature flags, and +other tunables when using this option, or the file system will be further +corrupted. In some cases, such as file systems that have been resized, +or have had features enabled after format time, it is impossible to +overwrite all of the superblocks correctly, and at least some file system +corruption will occur. It is best to run this on a full copy of the +file system so other options can be tried if this doesn't work. +.\" .TP +.\" .BI \-t " test" +.\" Check the device for bad blocks before creating the file system +.\" using the specified test. +.TP +.BI \-t " fs-type" +Specify the file system type (i.e., ext2, ext3, ext4, etc.) that is +to be created. +If this option is not specified, +.B mke2fs +will pick a default either via how +the command was run (for example, using a name of the form mkfs.ext2, +mkfs.ext3, etc.) or via a default as defined by the +.B /etc/mke2fs.conf +file. This option controls which file system options are used by +default, based on the +.B fstypes +configuration stanza in +.BR /etc/mke2fs.conf . +.sp +If the +.B \-O +option is used to explicitly add or remove file system options that +should be set in the newly created file system, the +resulting file system may not be supported by the requested +.IR fs-type . +(e.g., "\fBmke2fs \-t ext3 \-O extent /dev/sdXX\fR" will create a +file system that is not supported by the ext3 implementation as found in +the Linux kernel; and "\fBmke2fs \-t ext3 \-O ^has_journal /dev/hdXX\fR" +will create a file system that does not have a journal and hence will not +be supported by the ext3 file system code in the Linux kernel.) +.TP +.BI \-T " usage-type[,...]" +Specify how the file system is going to be used, so that +.B mke2fs +can choose optimal file system parameters for that use. The usage +types that are supported are defined in the configuration file +.BR /etc/mke2fs.conf . +The user may specify one or more usage types +using a comma separated list. +.sp +If this option is is not specified, +.B mke2fs +will pick a single default usage type based on the size of the file system to +be created. If the file system size is less than 3 megabytes, +.B mke2fs +will use the file system type +.IR floppy . +If the file system size is greater than or equal to 3 but less than +512 megabytes, +.BR mke2fs (8) +will use the file system type +.IR small . +If the file system size is greater than or equal to 4 terabytes but less than +16 terabytes, +.BR mke2fs (8) +will use the file system type +.IR big . +If the file system size is greater than or equal to 16 terabytes, +.BR mke2fs (8) +will use the file system type +.IR huge . +Otherwise, +.BR mke2fs (8) +will use the default file system type +.IR default . +.TP +.BI \-U " UUID" +Set the universally unique identifier (UUID) of the file system to +.IR UUID . +The format of the UUID is a series of hex digits separated by hyphens, +like this: +"c1b9d5a2-f162-11cf-9ece-0020afc76f16". +The +.I UUID +parameter may also be one of the following: +.RS 1.2i +.TP +.I clear +clear the file system UUID +.TP +.I random +generate a new randomly-generated UUID +.TP +.I time +generate a new time-based UUID +.RE +.TP +.B \-v +Verbose execution. +.TP +.B \-V +Print the version number of +.B mke2fs +and exit. +.TP +.BI \-z " undo_file" +Before overwriting a file system block, write the old contents of the block to +an undo file. This undo file can be used with e2undo(8) to restore the old +contents of the file system should something go wrong. If the empty string is +passed as the undo_file argument, the undo file will be written to a file named +mke2fs-\fIdevice\fR.e2undo in the directory specified via the +\fIE2FSPROGS_UNDO_DIR\fR environment variable or the \fIundo_dir\fR directive +in the configuration file. + +WARNING: The undo file cannot be used to recover from a power or system crash. +.SH ENVIRONMENT +.TP +.B MKE2FS_SYNC +If set to non-zero integer value, its value is used to determine how often +.BR sync (2) +is called during inode table initialization. +.TP +.B MKE2FS_CONFIG +Determines the location of the configuration file (see +.BR mke2fs.conf (5)). +.TP +.B MKE2FS_FIRST_META_BG +If set to non-zero integer value, its value is used to determine first meta +block group. This is mostly for debugging purposes. +.TP +.B MKE2FS_DEVICE_SECTSIZE +If set to non-zero integer value, its value is used to determine logical +sector size of the +.IR device . +.TP +.B MKE2FS_DEVICE_PHYS_SECTSIZE +If set to non-zero integer value, its value is used to determine physical +sector size of the +.IR device . +.TP +.B MKE2FS_SKIP_CHECK_MSG +If set, do not show the message of file system automatic check caused by +mount count or check interval. +.SH AUTHOR +This version of +.B mke2fs +has been written by Theodore Ts'o <tytso@mit.edu>. +.SH AVAILABILITY +.B mke2fs +is part of the e2fsprogs package and is available from +http://e2fsprogs.sourceforge.net. +.SH SEE ALSO +.BR mke2fs.conf (5), +.BR badblocks (8), +.BR dumpe2fs (8), +.BR e2fsck (8), +.BR tune2fs (8), +.BR ext4 (5) diff --git a/upstream/opensuse-leap-15-6/man8/mkfs.ext3.8 b/upstream/opensuse-leap-15-6/man8/mkfs.ext3.8 new file mode 100644 index 00000000..d39c024b --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/mkfs.ext3.8 @@ -0,0 +1,891 @@ +.\" -*- 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 MKE2FS 8 "February 2023" "E2fsprogs version 1.47.0" +.SH NAME +mke2fs \- create an ext2/ext3/ext4 file system +.SH SYNOPSIS +.B mke2fs +[ +.B \-c +| +.B \-l +.I filename +] +[ +.B \-b +.I block-size +] +[ +.B \-C +.I cluster-size +] +[ +.B \-d +.I root-directory +] +[ +.B \-D +] +[ +.B \-g +.I blocks-per-group +] +[ +.B \-G +.I number-of-groups +] +[ +.B \-i +.I bytes-per-inode +] +[ +.B \-I +.I inode-size +] +[ +.B \-j +] +[ +.B \-J +.I journal-options +] +[ +.B \-N +.I number-of-inodes +] +[ +.B \-n +] +[ +.B \-m +.I reserved-blocks-percentage +] +[ +.B \-o +.I creator-os +] +[ +.B \-O +[^]\fIfeature\fR[,...] +] +[ +.B \-q +] +[ +.B \-r +.I fs-revision-level +] +[ +.B \-E +.I extended-options +] +[ +.B \-v +] +[ +.B \-F +] +[ +.B \-L +.I volume-label +] +[ +.B \-M +.I last-mounted-directory +] +[ +.B \-S +] +[ +.B \-t +.I fs-type +] +[ +.B \-T +.I usage-type +] +[ +.B \-U +.I UUID +] +[ +.B \-V +] +[ +.B \-e +.I errors-behavior +] +[ +.B \-z +.I undo_file +] +.I device +[ +.I fs-size +] +.sp +.B "mke2fs \-O journal_dev" +[ +.B \-b +.I block-size +] +.\" No external-journal specific journal options yet (size is ignored) +.\" [ +.\" .B \-J +.\" .I journal-options +.\" ] +[ +.B \-L +.I volume-label +] +[ +.B \-n +] +[ +.B \-q +] +[ +.B \-v +] +.I external-journal +[ +.I fs-size +] +.SH DESCRIPTION +.B mke2fs +is used to create an ext2, ext3, or ext4 file system, usually in a disk +partition (or file) named by +.IR device . +.PP +The file system size is specified by +.IR fs-size . +If +.I fs-size +does not have a suffix, it is interpreted as power-of-two kilobytes, +unless the +.B \-b +.I blocksize +option is specified, in which case +.I fs-size +is interpreted as the number of +.I blocksize +blocks. If the fs-size is suffixed by 'k', 'm', 'g', 't' +(either upper-case or lower-case), then it is interpreted in +power-of-two kilobytes, megabytes, gigabytes, terabytes, etc. +If +.I fs-size +is omitted, +.B mke2fs +will create the file system based on the device size. +.PP +If +.B mke2fs +is run as +.B mkfs.XXX +(i.e., +.BR mkfs.ext2 , +.BR mkfs.ext3 , +or +.BR mkfs.ext4 ) +the option +.B \-t +.I XXX +is implied; so +.B mkfs.ext3 +will create a file system for use with ext3, +.B mkfs.ext4 +will create a file system for use with ext4, and so on. +.PP +The defaults of the parameters for the newly created file system, if not +overridden by the options listed below, are controlled by the +.B /etc/mke2fs.conf +configuration file. See the +.BR mke2fs.conf (5) +manual page for more details. +.SH OPTIONS +.TP +.BI \-b " block-size" +Specify the size of blocks in bytes. Valid block-size values are powers of two +from 1024 up to 65536 (however note that the kernel is able to mount only +file systems with block-size smaller or equal to the system page size - 4k on +x86 systems, up to 64k on ppc64 or aarch64 depending on kernel configuration). +If omitted, block-size is heuristically determined by the file system size and +the expected usage of the file system (see the +.B \-T +option). In most common cases, the default block size is 4k. If +.I block-size +is preceded by a negative sign ('-'), then +.B mke2fs +will use heuristics to determine the +appropriate block size, with the constraint that the block size will be +at least +.I block-size +bytes. This is useful for certain hardware devices which require that +the blocksize be a multiple of 2k. +.TP +.B \-c +Check the device for bad blocks before creating the file system. If +this option is specified twice, then a slower read-write +test is used instead of a fast read-only test. +.TP +.B \-C " cluster-size" +Specify the size of cluster in bytes for file systems using the bigalloc +feature. Valid cluster-size values are from 2048 to 256M bytes per +cluster. This can only be specified if the bigalloc feature is +enabled. (See the +.B ext4 (5) +man page for more details about bigalloc.) The default cluster size if +bigalloc is enabled is 16 times the block size. +.TP +.BI \-d " root-directory" +Copy the contents of the given directory into the root directory of the +file system. +.TP +.B \-D +Use direct I/O when writing to the disk. This avoids mke2fs dirtying a +lot of buffer cache memory, which may impact other applications running +on a busy server. This option will cause mke2fs to run much more +slowly, however, so there is a tradeoff to using direct I/O. +.TP +.BI \-e " error-behavior" +Change the behavior of the kernel code when errors are detected. +In all cases, a file system error will cause +.BR e2fsck (8) +to check the file system on the next boot. +.I error-behavior +can be one of the following: +.RS 1.2i +.TP 1.2i +.B continue +Continue normal execution. +.TP +.B remount-ro +Remount file system read-only. +.TP +.B panic +Cause a kernel panic. +.RE +.TP +.BI \-E " extended-options" +Set extended options for the file system. Extended options are comma +separated, and may take an argument using the equals ('=') sign. The +.B \-E +option used to be +.B \-R +in earlier versions of +.BR mke2fs . +The +.B \-R +option is still accepted for backwards compatibility, but is deprecated. +The following extended options are supported: +.RS 1.2i +.TP +.BI encoding= encoding-name +Enable the +.I casefold +feature in the super block and set +.I encoding-name +as the encoding to be used. If +.I encoding-name +is not specified, the encoding defined in +.BR mke2fs.conf (5) +is used. +.TP +.BI encoding_flags= encoding-flags +Define parameters for file name character encoding operations. If a +flag is not changed using this parameter, its default value is used. +.I encoding-flags +should be a comma-separated lists of flags to be enabled. To disable a +flag, add it to the list with the prefix "no". + +The only flag that can be set right now is +.I strict +which means that invalid strings should be rejected by the file system. +In the default configuration, the +.I strict +flag is disabled. +.TP +.BI mmp_update_interval= interval +Adjust the initial MMP update interval to +.I interval +seconds. Specifying an +.I interval +of 0 means to use the default interval. The specified interval must +be less than 300 seconds. Requires that the +.B mmp +feature be enabled. +.TP +.BI stride= stride-size +Configure the file system for a RAID array with +.I stride-size +file system blocks. This is the number of blocks read or written to disk +before moving to the next disk, which is sometimes referred to as the +.I chunk size. +This mostly affects placement of file system metadata like bitmaps at +.B mke2fs +time to avoid placing them on a single disk, which can hurt performance. +It may also be used by the block allocator. +.TP +.BI stripe_width= stripe-width +Configure the file system for a RAID array with +.I stripe-width +file system blocks per stripe. This is typically stride-size * N, where +N is the number of data-bearing disks in the RAID (e.g. for RAID 5 there is one +parity disk, so N will be the number of disks in the array minus 1). +This allows the block allocator to prevent read-modify-write of the +parity in a RAID stripe if possible when the data is written. +.TP +.BI offset= offset +Create the file system at an offset from the beginning of the device or +file. This can be useful when creating disk images for virtual machines. +.TP +.BI resize= max-online-resize +Reserve enough space so that the block group descriptor table can grow +to support a file system that has +.I max-online-resize +blocks. +.TP +.B lazy_itable_init\fR[\fB= \fI<0 to disable, 1 to enable>\fR] +If enabled and the uninit_bg feature is enabled, the inode table will +not be fully initialized by +.BR mke2fs . +This speeds up file system +initialization noticeably, but it requires the kernel to finish +initializing the file system in the background when the file system is +first mounted. If the option value is omitted, it defaults to 1 to +enable lazy inode table zeroing. +.TP +.B lazy_journal_init\fR[\fB= \fI<0 to disable, 1 to enable>\fR] +If enabled, the journal inode will not be fully zeroed out by +.BR mke2fs . +This speeds up file system initialization noticeably, but carries some +small risk if the system crashes before the journal has been overwritten +entirely one time. If the option value is omitted, it defaults to 1 to +enable lazy journal inode zeroing. +.TP +.B assume_storage_prezeroed\fR[\fB= \fI<0 to disable, 1 to enable>\fR] +If enabled, +.BR mke2fs +assumes that the storage device has been prezeroed, skips zeroing the journal +and inode tables, and annotates the block group flags to signal that the inode +table has been zeroed. +.TP +.B no_copy_xattrs +Normally +.B mke2fs +will copy the extended attributes of the files in the directory +hierarchy specified via the (optional) +.B \-d +option. This will disable the copy and leaves the files in the newly +created file system without any extended attributes. +.TP +.BI num_backup_sb= <0|1|2> +If the +.B sparse_super2 +file system feature is enabled this option controls whether there will +be 0, 1, or 2 backup superblocks created in the file system. +.TP +.B packed_meta_blocks\fR[\fB= \fI<0 to disable, 1 to enable>\fR] +Place the allocation bitmaps and the inode table at the beginning of the +disk. This option requires that the flex_bg file system feature to be +enabled in order for it to have effect, and will also create the journal +at the beginning of the file system. This option is useful for flash +devices that use SLC flash at the beginning of the disk. +It also maximizes the range of contiguous data blocks, which +can be useful for certain specialized use cases, such as supported +Shingled Drives. +.TP +.BI root_owner [=uid:gid] +Specify the numeric user and group ID of the root directory. If no UID:GID +is specified, use the user and group ID of the user running \fBmke2fs\fR. +In \fBmke2fs\fR 1.42 and earlier the UID and GID of the root directory were +set by default to the UID and GID of the user running the mke2fs command. +The \fBroot_owner=\fR option allows explicitly specifying these values, +and avoid side-effects for users that do not expect the contents of the +file system to change based on the user running \fBmke2fs\fR. +.TP +.B test_fs +Set a flag in the file system superblock indicating that it may be +mounted using experimental kernel code, such as the ext4dev file system. +.TP +.BI orphan_file_size= size +Set size of the file for tracking unlinked but still open inodes and inodes +with truncate in progress. Larger file allows for better scalability, reserving +a few blocks per cpu is ideal. +.TP +.B discard +Attempt to discard blocks at mkfs time (discarding blocks initially is useful +on solid state devices and sparse / thin-provisioned storage). When the device +advertises that discard also zeroes data (any subsequent read after the discard +and before write returns zero), then mark all not-yet-zeroed inode tables as +zeroed. This significantly speeds up file system initialization. This is set +as default. +.TP +.B nodiscard +Do not attempt to discard blocks at mkfs time. +.TP +.B quotatype +Specify the which quota types (usrquota, grpquota, prjquota) which +should be enabled in the created file system. The argument of this +extended option should be a colon separated list. This option has +effect only if the +.B quota +feature is set. The default quota types to be initialized if this +option is not specified is both user and group quotas. If the project +feature is enabled that project quotas will be initialized as well. +.RE +.TP +.B \-F +Force +.B mke2fs +to create a file system, even if the specified device is not a partition +on a block special device, or if other parameters do not make sense. +In order to force +.B mke2fs +to create a file system even if the file system appears to be in use +or is mounted (a truly dangerous thing to do), this option must be +specified twice. +.TP +.BI \-g " blocks-per-group" +Specify the number of blocks in a block group. There is generally no +reason for the user to ever set this parameter, as the default is optimal +for the file system. (For administrators who are creating +file systems on RAID arrays, it is preferable to use the +.I stride +RAID parameter as part of the +.B \-E +option rather than manipulating the number of blocks per group.) +This option is generally used by developers who +are developing test cases. +.IP +If the bigalloc feature is enabled, the +.B \-g +option will specify the number of clusters in a block group. +.TP +.BI \-G " number-of-groups" +Specify the number of block groups that will be packed together to +create a larger virtual block group (or "flex_bg group") in an +ext4 file system. This improves meta-data locality and performance +on meta-data heavy workloads. The number of groups must be a power +of 2 and may only be specified if the +.B flex_bg +file system feature is enabled. +.TP +.BI \-i " bytes-per-inode" +Specify the bytes/inode ratio. +.B mke2fs +creates an inode for every +.I bytes-per-inode +bytes of space on the disk. The larger the +.I bytes-per-inode +ratio, the fewer inodes will be created. This value generally shouldn't +be smaller than the blocksize of the file system, since in that case more +inodes would be made than can ever be used. Be warned that it is not +possible to change this ratio on a file system after it is created, so be +careful deciding the correct value for this parameter. Note that resizing +a file system changes the number of inodes to maintain this ratio. +.TP +.BI \-I " inode-size" +Specify the size of each inode in bytes. +The +.I inode-size +value must be a power of 2 larger or equal to 128. The larger the +.I inode-size +the more space the inode table will consume, and this reduces the usable +space in the file system and can also negatively impact performance. +It is not +possible to change this value after the file system is created. +.IP +File systems with an inode size of 128 bytes do not support timestamps +beyond January 19, 2038. Inodes which are 256 bytes or larger will +support extended timestamps, project id's, and the ability to store some +extended attributes in the inode table for improved performance. +.IP +The default inode size is controlled by the +.BR mke2fs.conf (5) +file. In the +.B mke2fs.conf +file shipped with e2fsprogs, the default inode size is 256 bytes for +most file systems, except for small file systems where the inode size +will be 128 bytes. +.TP +.B \-j +Create the file system with an ext3 journal. If the +.B \-J +option is not specified, the default journal parameters will be used to +create an appropriately sized journal (given the size of the file system) +stored within the file system. Note that you must be using a kernel +which has ext3 support in order to actually make use of the journal. +.TP +.BI \-J " journal-options" +Create the ext3 journal using options specified on the command-line. +Journal options are comma +separated, and may take an argument using the equals ('=') sign. +The following journal options are supported: +.RS 1.2i +.TP +.BI size= journal-size +Create an internal journal (i.e., stored inside the file system) of size +.I journal-size +megabytes. +The size of the journal must be at least 1024 file system blocks +(i.e., 1MB if using 1k blocks, 4MB if using 4k blocks, etc.) +and may be no more than 10,240,000 file system blocks or half the total +file system size (whichever is smaller) +.TP +.BI fast_commit_size= fast-commit-size +Create an additional fast commit journal area of size +.I fast-commit-size +kilobytes. +This option is only valid if +.B fast_commit +feature is enabled +on the file system. If this option is not specified and if +.B fast_commit +feature is turned on, fast commit area size defaults to +.I journal-size +/ 64 megabytes. The total size of the journal with +.B fast_commit +feature set is +.I journal-size ++ ( +.I fast-commit-size +* 1024) megabytes. The total journal size may be no more than +10,240,000 file system blocks or half the total file system size +(whichever is smaller). +.TP +.BI location =journal-location +Specify the location of the journal. The argument +.I journal-location +can either be specified as a block number, or if the number has a units +suffix (e.g., 'M', 'G', etc.) interpret it as the offset from the +beginning of the file system. +.TP +.BI device= external-journal +Attach the file system to the journal block device located on +.IR external-journal . +The external +journal must already have been created using the command +.IP +.B mke2fs -O journal_dev +.I external-journal +.IP +Note that +.I external-journal +must have been created with the +same block size as the new file system. +In addition, while there is support for attaching +multiple file systems to a single external journal, +the Linux kernel and +.BR e2fsck (8) +do not currently support shared external journals yet. +.IP +Instead of specifying a device name directly, +.I external-journal +can also be specified by either +.BI LABEL= label +or +.BI UUID= UUID +to locate the external journal by either the volume label or UUID +stored in the ext2 superblock at the start of the journal. Use +.BR dumpe2fs (8) +to display a journal device's volume label and UUID. See also the +.B -L +option of +.BR tune2fs (8). +.RE +.IP +Only one of the +.BR size " or " device +options can be given for a file system. +.TP +.BI \-l " filename" +Read the bad blocks list from +.IR filename . +Note that the block numbers in the bad block list must be generated +using the same block size as used by +.BR mke2fs . +As a result, the +.B \-c +option to +.B mke2fs +is a much simpler and less error-prone method of checking a disk for bad +blocks before formatting it, as +.B mke2fs +will automatically pass the correct parameters to the +.B badblocks +program. +.TP +.BI \-L " new-volume-label" +Set the volume label for the file system to +.IR new-volume-label . +The maximum length of the +volume label is 16 bytes. +.TP +.BI \-m " reserved-blocks-percentage" +Specify the percentage of the file system blocks reserved for +the super-user. This avoids fragmentation, and allows root-owned +daemons, such as +.BR syslogd (8), +to continue to function correctly after non-privileged processes are +prevented from writing to the file system. The default percentage +is 5%. +.TP +.BI \-M " last-mounted-directory" +Set the last mounted directory for the file system. This might be useful +for the sake of utilities that key off of the last mounted directory to +determine where the file system should be mounted. +.TP +.B \-n +Causes +.B mke2fs +to not actually create a file system, but display what it +would do if it were to create a file system. This can be used to +determine the location of the backup superblocks for a particular +file system, so long as the +.B mke2fs +parameters that were passed when the +file system was originally created are used again. (With the +.B \-n +option added, of course!) +.TP +.BI \-N " number-of-inodes" +Overrides the default calculation of the number of inodes that should be +reserved for the file system (which is based on the number of blocks and +the +.I bytes-per-inode +ratio). This allows the user to specify the number +of desired inodes directly. +.TP +.BI \-o " creator-os" +Overrides the default value of the "creator operating system" field of the +file system. The creator field is set by default to the name of the OS the +.B mke2fs +executable was compiled for. +.TP +.B "\-O \fR[^]\fIfeature\fR[,...]" +Create a file system with the given features (file system options), +overriding the default file system options. The features that are +enabled by default are specified by the +.I base_features +relation, either in the +.I [defaults] +section in the +.B /etc/mke2fs.conf +configuration file, +or in the +.I [fs_types] +subsections for the usage types as specified by the +.B \-T +option, further modified by the +.I features +relation found in the +.I [fs_types] +subsections for the file system and usage types. See the +.BR mke2fs.conf (5) +manual page for more details. +The file system type-specific configuration setting found in the +.I [fs_types] +section will override the global default found in +.IR [defaults] . +.sp +The file system feature set will be further edited +using either the feature set specified by this option, +or if this option is not given, by the +.I default_features +relation for the file system type being created, or in the +.I [defaults] +section of the configuration file. +.sp +The file system feature set is comprised of a list of features, separated +by commas, that are to be enabled. To disable a feature, simply +prefix the feature name with a caret ('^') character. +Features with dependencies will not be removed successfully. +The pseudo-file system feature "none" will clear all file system features. +.TP +For more information about the features which can be set, please see +the manual page +.BR ext4 (5). +.TP +.B \-q +Quiet execution. Useful if +.B mke2fs +is run in a script. +.TP +.BI \-r " revision" +Set the file system revision for the new file system. Note that 1.2 +kernels only support revision 0 file systems. The default is to +create revision 1 file systems. +.TP +.B \-S +Write superblock and group descriptors only. This is an extreme +measure to be taken only in the very unlikely case that all of +the superblock and backup superblocks are corrupted, and a last-ditch +recovery method is desired by experienced users. It causes +.B mke2fs +to reinitialize the superblock and group descriptors, while not +touching the inode table and the block and inode bitmaps. The +.B e2fsck +program should be run immediately after this option is used, and there +is no guarantee that any data will be salvageable. Due to the wide +variety of possible options to +.B mke2fs +that affect the on-disk layout, it is critical to specify exactly +the same format options, such as blocksize, fs-type, feature flags, and +other tunables when using this option, or the file system will be further +corrupted. In some cases, such as file systems that have been resized, +or have had features enabled after format time, it is impossible to +overwrite all of the superblocks correctly, and at least some file system +corruption will occur. It is best to run this on a full copy of the +file system so other options can be tried if this doesn't work. +.\" .TP +.\" .BI \-t " test" +.\" Check the device for bad blocks before creating the file system +.\" using the specified test. +.TP +.BI \-t " fs-type" +Specify the file system type (i.e., ext2, ext3, ext4, etc.) that is +to be created. +If this option is not specified, +.B mke2fs +will pick a default either via how +the command was run (for example, using a name of the form mkfs.ext2, +mkfs.ext3, etc.) or via a default as defined by the +.B /etc/mke2fs.conf +file. This option controls which file system options are used by +default, based on the +.B fstypes +configuration stanza in +.BR /etc/mke2fs.conf . +.sp +If the +.B \-O +option is used to explicitly add or remove file system options that +should be set in the newly created file system, the +resulting file system may not be supported by the requested +.IR fs-type . +(e.g., "\fBmke2fs \-t ext3 \-O extent /dev/sdXX\fR" will create a +file system that is not supported by the ext3 implementation as found in +the Linux kernel; and "\fBmke2fs \-t ext3 \-O ^has_journal /dev/hdXX\fR" +will create a file system that does not have a journal and hence will not +be supported by the ext3 file system code in the Linux kernel.) +.TP +.BI \-T " usage-type[,...]" +Specify how the file system is going to be used, so that +.B mke2fs +can choose optimal file system parameters for that use. The usage +types that are supported are defined in the configuration file +.BR /etc/mke2fs.conf . +The user may specify one or more usage types +using a comma separated list. +.sp +If this option is is not specified, +.B mke2fs +will pick a single default usage type based on the size of the file system to +be created. If the file system size is less than 3 megabytes, +.B mke2fs +will use the file system type +.IR floppy . +If the file system size is greater than or equal to 3 but less than +512 megabytes, +.BR mke2fs (8) +will use the file system type +.IR small . +If the file system size is greater than or equal to 4 terabytes but less than +16 terabytes, +.BR mke2fs (8) +will use the file system type +.IR big . +If the file system size is greater than or equal to 16 terabytes, +.BR mke2fs (8) +will use the file system type +.IR huge . +Otherwise, +.BR mke2fs (8) +will use the default file system type +.IR default . +.TP +.BI \-U " UUID" +Set the universally unique identifier (UUID) of the file system to +.IR UUID . +The format of the UUID is a series of hex digits separated by hyphens, +like this: +"c1b9d5a2-f162-11cf-9ece-0020afc76f16". +The +.I UUID +parameter may also be one of the following: +.RS 1.2i +.TP +.I clear +clear the file system UUID +.TP +.I random +generate a new randomly-generated UUID +.TP +.I time +generate a new time-based UUID +.RE +.TP +.B \-v +Verbose execution. +.TP +.B \-V +Print the version number of +.B mke2fs +and exit. +.TP +.BI \-z " undo_file" +Before overwriting a file system block, write the old contents of the block to +an undo file. This undo file can be used with e2undo(8) to restore the old +contents of the file system should something go wrong. If the empty string is +passed as the undo_file argument, the undo file will be written to a file named +mke2fs-\fIdevice\fR.e2undo in the directory specified via the +\fIE2FSPROGS_UNDO_DIR\fR environment variable or the \fIundo_dir\fR directive +in the configuration file. + +WARNING: The undo file cannot be used to recover from a power or system crash. +.SH ENVIRONMENT +.TP +.B MKE2FS_SYNC +If set to non-zero integer value, its value is used to determine how often +.BR sync (2) +is called during inode table initialization. +.TP +.B MKE2FS_CONFIG +Determines the location of the configuration file (see +.BR mke2fs.conf (5)). +.TP +.B MKE2FS_FIRST_META_BG +If set to non-zero integer value, its value is used to determine first meta +block group. This is mostly for debugging purposes. +.TP +.B MKE2FS_DEVICE_SECTSIZE +If set to non-zero integer value, its value is used to determine logical +sector size of the +.IR device . +.TP +.B MKE2FS_DEVICE_PHYS_SECTSIZE +If set to non-zero integer value, its value is used to determine physical +sector size of the +.IR device . +.TP +.B MKE2FS_SKIP_CHECK_MSG +If set, do not show the message of file system automatic check caused by +mount count or check interval. +.SH AUTHOR +This version of +.B mke2fs +has been written by Theodore Ts'o <tytso@mit.edu>. +.SH AVAILABILITY +.B mke2fs +is part of the e2fsprogs package and is available from +http://e2fsprogs.sourceforge.net. +.SH SEE ALSO +.BR mke2fs.conf (5), +.BR badblocks (8), +.BR dumpe2fs (8), +.BR e2fsck (8), +.BR tune2fs (8), +.BR ext4 (5) diff --git a/upstream/opensuse-leap-15-6/man8/mkfs.ext4.8 b/upstream/opensuse-leap-15-6/man8/mkfs.ext4.8 new file mode 100644 index 00000000..d39c024b --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/mkfs.ext4.8 @@ -0,0 +1,891 @@ +.\" -*- 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 MKE2FS 8 "February 2023" "E2fsprogs version 1.47.0" +.SH NAME +mke2fs \- create an ext2/ext3/ext4 file system +.SH SYNOPSIS +.B mke2fs +[ +.B \-c +| +.B \-l +.I filename +] +[ +.B \-b +.I block-size +] +[ +.B \-C +.I cluster-size +] +[ +.B \-d +.I root-directory +] +[ +.B \-D +] +[ +.B \-g +.I blocks-per-group +] +[ +.B \-G +.I number-of-groups +] +[ +.B \-i +.I bytes-per-inode +] +[ +.B \-I +.I inode-size +] +[ +.B \-j +] +[ +.B \-J +.I journal-options +] +[ +.B \-N +.I number-of-inodes +] +[ +.B \-n +] +[ +.B \-m +.I reserved-blocks-percentage +] +[ +.B \-o +.I creator-os +] +[ +.B \-O +[^]\fIfeature\fR[,...] +] +[ +.B \-q +] +[ +.B \-r +.I fs-revision-level +] +[ +.B \-E +.I extended-options +] +[ +.B \-v +] +[ +.B \-F +] +[ +.B \-L +.I volume-label +] +[ +.B \-M +.I last-mounted-directory +] +[ +.B \-S +] +[ +.B \-t +.I fs-type +] +[ +.B \-T +.I usage-type +] +[ +.B \-U +.I UUID +] +[ +.B \-V +] +[ +.B \-e +.I errors-behavior +] +[ +.B \-z +.I undo_file +] +.I device +[ +.I fs-size +] +.sp +.B "mke2fs \-O journal_dev" +[ +.B \-b +.I block-size +] +.\" No external-journal specific journal options yet (size is ignored) +.\" [ +.\" .B \-J +.\" .I journal-options +.\" ] +[ +.B \-L +.I volume-label +] +[ +.B \-n +] +[ +.B \-q +] +[ +.B \-v +] +.I external-journal +[ +.I fs-size +] +.SH DESCRIPTION +.B mke2fs +is used to create an ext2, ext3, or ext4 file system, usually in a disk +partition (or file) named by +.IR device . +.PP +The file system size is specified by +.IR fs-size . +If +.I fs-size +does not have a suffix, it is interpreted as power-of-two kilobytes, +unless the +.B \-b +.I blocksize +option is specified, in which case +.I fs-size +is interpreted as the number of +.I blocksize +blocks. If the fs-size is suffixed by 'k', 'm', 'g', 't' +(either upper-case or lower-case), then it is interpreted in +power-of-two kilobytes, megabytes, gigabytes, terabytes, etc. +If +.I fs-size +is omitted, +.B mke2fs +will create the file system based on the device size. +.PP +If +.B mke2fs +is run as +.B mkfs.XXX +(i.e., +.BR mkfs.ext2 , +.BR mkfs.ext3 , +or +.BR mkfs.ext4 ) +the option +.B \-t +.I XXX +is implied; so +.B mkfs.ext3 +will create a file system for use with ext3, +.B mkfs.ext4 +will create a file system for use with ext4, and so on. +.PP +The defaults of the parameters for the newly created file system, if not +overridden by the options listed below, are controlled by the +.B /etc/mke2fs.conf +configuration file. See the +.BR mke2fs.conf (5) +manual page for more details. +.SH OPTIONS +.TP +.BI \-b " block-size" +Specify the size of blocks in bytes. Valid block-size values are powers of two +from 1024 up to 65536 (however note that the kernel is able to mount only +file systems with block-size smaller or equal to the system page size - 4k on +x86 systems, up to 64k on ppc64 or aarch64 depending on kernel configuration). +If omitted, block-size is heuristically determined by the file system size and +the expected usage of the file system (see the +.B \-T +option). In most common cases, the default block size is 4k. If +.I block-size +is preceded by a negative sign ('-'), then +.B mke2fs +will use heuristics to determine the +appropriate block size, with the constraint that the block size will be +at least +.I block-size +bytes. This is useful for certain hardware devices which require that +the blocksize be a multiple of 2k. +.TP +.B \-c +Check the device for bad blocks before creating the file system. If +this option is specified twice, then a slower read-write +test is used instead of a fast read-only test. +.TP +.B \-C " cluster-size" +Specify the size of cluster in bytes for file systems using the bigalloc +feature. Valid cluster-size values are from 2048 to 256M bytes per +cluster. This can only be specified if the bigalloc feature is +enabled. (See the +.B ext4 (5) +man page for more details about bigalloc.) The default cluster size if +bigalloc is enabled is 16 times the block size. +.TP +.BI \-d " root-directory" +Copy the contents of the given directory into the root directory of the +file system. +.TP +.B \-D +Use direct I/O when writing to the disk. This avoids mke2fs dirtying a +lot of buffer cache memory, which may impact other applications running +on a busy server. This option will cause mke2fs to run much more +slowly, however, so there is a tradeoff to using direct I/O. +.TP +.BI \-e " error-behavior" +Change the behavior of the kernel code when errors are detected. +In all cases, a file system error will cause +.BR e2fsck (8) +to check the file system on the next boot. +.I error-behavior +can be one of the following: +.RS 1.2i +.TP 1.2i +.B continue +Continue normal execution. +.TP +.B remount-ro +Remount file system read-only. +.TP +.B panic +Cause a kernel panic. +.RE +.TP +.BI \-E " extended-options" +Set extended options for the file system. Extended options are comma +separated, and may take an argument using the equals ('=') sign. The +.B \-E +option used to be +.B \-R +in earlier versions of +.BR mke2fs . +The +.B \-R +option is still accepted for backwards compatibility, but is deprecated. +The following extended options are supported: +.RS 1.2i +.TP +.BI encoding= encoding-name +Enable the +.I casefold +feature in the super block and set +.I encoding-name +as the encoding to be used. If +.I encoding-name +is not specified, the encoding defined in +.BR mke2fs.conf (5) +is used. +.TP +.BI encoding_flags= encoding-flags +Define parameters for file name character encoding operations. If a +flag is not changed using this parameter, its default value is used. +.I encoding-flags +should be a comma-separated lists of flags to be enabled. To disable a +flag, add it to the list with the prefix "no". + +The only flag that can be set right now is +.I strict +which means that invalid strings should be rejected by the file system. +In the default configuration, the +.I strict +flag is disabled. +.TP +.BI mmp_update_interval= interval +Adjust the initial MMP update interval to +.I interval +seconds. Specifying an +.I interval +of 0 means to use the default interval. The specified interval must +be less than 300 seconds. Requires that the +.B mmp +feature be enabled. +.TP +.BI stride= stride-size +Configure the file system for a RAID array with +.I stride-size +file system blocks. This is the number of blocks read or written to disk +before moving to the next disk, which is sometimes referred to as the +.I chunk size. +This mostly affects placement of file system metadata like bitmaps at +.B mke2fs +time to avoid placing them on a single disk, which can hurt performance. +It may also be used by the block allocator. +.TP +.BI stripe_width= stripe-width +Configure the file system for a RAID array with +.I stripe-width +file system blocks per stripe. This is typically stride-size * N, where +N is the number of data-bearing disks in the RAID (e.g. for RAID 5 there is one +parity disk, so N will be the number of disks in the array minus 1). +This allows the block allocator to prevent read-modify-write of the +parity in a RAID stripe if possible when the data is written. +.TP +.BI offset= offset +Create the file system at an offset from the beginning of the device or +file. This can be useful when creating disk images for virtual machines. +.TP +.BI resize= max-online-resize +Reserve enough space so that the block group descriptor table can grow +to support a file system that has +.I max-online-resize +blocks. +.TP +.B lazy_itable_init\fR[\fB= \fI<0 to disable, 1 to enable>\fR] +If enabled and the uninit_bg feature is enabled, the inode table will +not be fully initialized by +.BR mke2fs . +This speeds up file system +initialization noticeably, but it requires the kernel to finish +initializing the file system in the background when the file system is +first mounted. If the option value is omitted, it defaults to 1 to +enable lazy inode table zeroing. +.TP +.B lazy_journal_init\fR[\fB= \fI<0 to disable, 1 to enable>\fR] +If enabled, the journal inode will not be fully zeroed out by +.BR mke2fs . +This speeds up file system initialization noticeably, but carries some +small risk if the system crashes before the journal has been overwritten +entirely one time. If the option value is omitted, it defaults to 1 to +enable lazy journal inode zeroing. +.TP +.B assume_storage_prezeroed\fR[\fB= \fI<0 to disable, 1 to enable>\fR] +If enabled, +.BR mke2fs +assumes that the storage device has been prezeroed, skips zeroing the journal +and inode tables, and annotates the block group flags to signal that the inode +table has been zeroed. +.TP +.B no_copy_xattrs +Normally +.B mke2fs +will copy the extended attributes of the files in the directory +hierarchy specified via the (optional) +.B \-d +option. This will disable the copy and leaves the files in the newly +created file system without any extended attributes. +.TP +.BI num_backup_sb= <0|1|2> +If the +.B sparse_super2 +file system feature is enabled this option controls whether there will +be 0, 1, or 2 backup superblocks created in the file system. +.TP +.B packed_meta_blocks\fR[\fB= \fI<0 to disable, 1 to enable>\fR] +Place the allocation bitmaps and the inode table at the beginning of the +disk. This option requires that the flex_bg file system feature to be +enabled in order for it to have effect, and will also create the journal +at the beginning of the file system. This option is useful for flash +devices that use SLC flash at the beginning of the disk. +It also maximizes the range of contiguous data blocks, which +can be useful for certain specialized use cases, such as supported +Shingled Drives. +.TP +.BI root_owner [=uid:gid] +Specify the numeric user and group ID of the root directory. If no UID:GID +is specified, use the user and group ID of the user running \fBmke2fs\fR. +In \fBmke2fs\fR 1.42 and earlier the UID and GID of the root directory were +set by default to the UID and GID of the user running the mke2fs command. +The \fBroot_owner=\fR option allows explicitly specifying these values, +and avoid side-effects for users that do not expect the contents of the +file system to change based on the user running \fBmke2fs\fR. +.TP +.B test_fs +Set a flag in the file system superblock indicating that it may be +mounted using experimental kernel code, such as the ext4dev file system. +.TP +.BI orphan_file_size= size +Set size of the file for tracking unlinked but still open inodes and inodes +with truncate in progress. Larger file allows for better scalability, reserving +a few blocks per cpu is ideal. +.TP +.B discard +Attempt to discard blocks at mkfs time (discarding blocks initially is useful +on solid state devices and sparse / thin-provisioned storage). When the device +advertises that discard also zeroes data (any subsequent read after the discard +and before write returns zero), then mark all not-yet-zeroed inode tables as +zeroed. This significantly speeds up file system initialization. This is set +as default. +.TP +.B nodiscard +Do not attempt to discard blocks at mkfs time. +.TP +.B quotatype +Specify the which quota types (usrquota, grpquota, prjquota) which +should be enabled in the created file system. The argument of this +extended option should be a colon separated list. This option has +effect only if the +.B quota +feature is set. The default quota types to be initialized if this +option is not specified is both user and group quotas. If the project +feature is enabled that project quotas will be initialized as well. +.RE +.TP +.B \-F +Force +.B mke2fs +to create a file system, even if the specified device is not a partition +on a block special device, or if other parameters do not make sense. +In order to force +.B mke2fs +to create a file system even if the file system appears to be in use +or is mounted (a truly dangerous thing to do), this option must be +specified twice. +.TP +.BI \-g " blocks-per-group" +Specify the number of blocks in a block group. There is generally no +reason for the user to ever set this parameter, as the default is optimal +for the file system. (For administrators who are creating +file systems on RAID arrays, it is preferable to use the +.I stride +RAID parameter as part of the +.B \-E +option rather than manipulating the number of blocks per group.) +This option is generally used by developers who +are developing test cases. +.IP +If the bigalloc feature is enabled, the +.B \-g +option will specify the number of clusters in a block group. +.TP +.BI \-G " number-of-groups" +Specify the number of block groups that will be packed together to +create a larger virtual block group (or "flex_bg group") in an +ext4 file system. This improves meta-data locality and performance +on meta-data heavy workloads. The number of groups must be a power +of 2 and may only be specified if the +.B flex_bg +file system feature is enabled. +.TP +.BI \-i " bytes-per-inode" +Specify the bytes/inode ratio. +.B mke2fs +creates an inode for every +.I bytes-per-inode +bytes of space on the disk. The larger the +.I bytes-per-inode +ratio, the fewer inodes will be created. This value generally shouldn't +be smaller than the blocksize of the file system, since in that case more +inodes would be made than can ever be used. Be warned that it is not +possible to change this ratio on a file system after it is created, so be +careful deciding the correct value for this parameter. Note that resizing +a file system changes the number of inodes to maintain this ratio. +.TP +.BI \-I " inode-size" +Specify the size of each inode in bytes. +The +.I inode-size +value must be a power of 2 larger or equal to 128. The larger the +.I inode-size +the more space the inode table will consume, and this reduces the usable +space in the file system and can also negatively impact performance. +It is not +possible to change this value after the file system is created. +.IP +File systems with an inode size of 128 bytes do not support timestamps +beyond January 19, 2038. Inodes which are 256 bytes or larger will +support extended timestamps, project id's, and the ability to store some +extended attributes in the inode table for improved performance. +.IP +The default inode size is controlled by the +.BR mke2fs.conf (5) +file. In the +.B mke2fs.conf +file shipped with e2fsprogs, the default inode size is 256 bytes for +most file systems, except for small file systems where the inode size +will be 128 bytes. +.TP +.B \-j +Create the file system with an ext3 journal. If the +.B \-J +option is not specified, the default journal parameters will be used to +create an appropriately sized journal (given the size of the file system) +stored within the file system. Note that you must be using a kernel +which has ext3 support in order to actually make use of the journal. +.TP +.BI \-J " journal-options" +Create the ext3 journal using options specified on the command-line. +Journal options are comma +separated, and may take an argument using the equals ('=') sign. +The following journal options are supported: +.RS 1.2i +.TP +.BI size= journal-size +Create an internal journal (i.e., stored inside the file system) of size +.I journal-size +megabytes. +The size of the journal must be at least 1024 file system blocks +(i.e., 1MB if using 1k blocks, 4MB if using 4k blocks, etc.) +and may be no more than 10,240,000 file system blocks or half the total +file system size (whichever is smaller) +.TP +.BI fast_commit_size= fast-commit-size +Create an additional fast commit journal area of size +.I fast-commit-size +kilobytes. +This option is only valid if +.B fast_commit +feature is enabled +on the file system. If this option is not specified and if +.B fast_commit +feature is turned on, fast commit area size defaults to +.I journal-size +/ 64 megabytes. The total size of the journal with +.B fast_commit +feature set is +.I journal-size ++ ( +.I fast-commit-size +* 1024) megabytes. The total journal size may be no more than +10,240,000 file system blocks or half the total file system size +(whichever is smaller). +.TP +.BI location =journal-location +Specify the location of the journal. The argument +.I journal-location +can either be specified as a block number, or if the number has a units +suffix (e.g., 'M', 'G', etc.) interpret it as the offset from the +beginning of the file system. +.TP +.BI device= external-journal +Attach the file system to the journal block device located on +.IR external-journal . +The external +journal must already have been created using the command +.IP +.B mke2fs -O journal_dev +.I external-journal +.IP +Note that +.I external-journal +must have been created with the +same block size as the new file system. +In addition, while there is support for attaching +multiple file systems to a single external journal, +the Linux kernel and +.BR e2fsck (8) +do not currently support shared external journals yet. +.IP +Instead of specifying a device name directly, +.I external-journal +can also be specified by either +.BI LABEL= label +or +.BI UUID= UUID +to locate the external journal by either the volume label or UUID +stored in the ext2 superblock at the start of the journal. Use +.BR dumpe2fs (8) +to display a journal device's volume label and UUID. See also the +.B -L +option of +.BR tune2fs (8). +.RE +.IP +Only one of the +.BR size " or " device +options can be given for a file system. +.TP +.BI \-l " filename" +Read the bad blocks list from +.IR filename . +Note that the block numbers in the bad block list must be generated +using the same block size as used by +.BR mke2fs . +As a result, the +.B \-c +option to +.B mke2fs +is a much simpler and less error-prone method of checking a disk for bad +blocks before formatting it, as +.B mke2fs +will automatically pass the correct parameters to the +.B badblocks +program. +.TP +.BI \-L " new-volume-label" +Set the volume label for the file system to +.IR new-volume-label . +The maximum length of the +volume label is 16 bytes. +.TP +.BI \-m " reserved-blocks-percentage" +Specify the percentage of the file system blocks reserved for +the super-user. This avoids fragmentation, and allows root-owned +daemons, such as +.BR syslogd (8), +to continue to function correctly after non-privileged processes are +prevented from writing to the file system. The default percentage +is 5%. +.TP +.BI \-M " last-mounted-directory" +Set the last mounted directory for the file system. This might be useful +for the sake of utilities that key off of the last mounted directory to +determine where the file system should be mounted. +.TP +.B \-n +Causes +.B mke2fs +to not actually create a file system, but display what it +would do if it were to create a file system. This can be used to +determine the location of the backup superblocks for a particular +file system, so long as the +.B mke2fs +parameters that were passed when the +file system was originally created are used again. (With the +.B \-n +option added, of course!) +.TP +.BI \-N " number-of-inodes" +Overrides the default calculation of the number of inodes that should be +reserved for the file system (which is based on the number of blocks and +the +.I bytes-per-inode +ratio). This allows the user to specify the number +of desired inodes directly. +.TP +.BI \-o " creator-os" +Overrides the default value of the "creator operating system" field of the +file system. The creator field is set by default to the name of the OS the +.B mke2fs +executable was compiled for. +.TP +.B "\-O \fR[^]\fIfeature\fR[,...]" +Create a file system with the given features (file system options), +overriding the default file system options. The features that are +enabled by default are specified by the +.I base_features +relation, either in the +.I [defaults] +section in the +.B /etc/mke2fs.conf +configuration file, +or in the +.I [fs_types] +subsections for the usage types as specified by the +.B \-T +option, further modified by the +.I features +relation found in the +.I [fs_types] +subsections for the file system and usage types. See the +.BR mke2fs.conf (5) +manual page for more details. +The file system type-specific configuration setting found in the +.I [fs_types] +section will override the global default found in +.IR [defaults] . +.sp +The file system feature set will be further edited +using either the feature set specified by this option, +or if this option is not given, by the +.I default_features +relation for the file system type being created, or in the +.I [defaults] +section of the configuration file. +.sp +The file system feature set is comprised of a list of features, separated +by commas, that are to be enabled. To disable a feature, simply +prefix the feature name with a caret ('^') character. +Features with dependencies will not be removed successfully. +The pseudo-file system feature "none" will clear all file system features. +.TP +For more information about the features which can be set, please see +the manual page +.BR ext4 (5). +.TP +.B \-q +Quiet execution. Useful if +.B mke2fs +is run in a script. +.TP +.BI \-r " revision" +Set the file system revision for the new file system. Note that 1.2 +kernels only support revision 0 file systems. The default is to +create revision 1 file systems. +.TP +.B \-S +Write superblock and group descriptors only. This is an extreme +measure to be taken only in the very unlikely case that all of +the superblock and backup superblocks are corrupted, and a last-ditch +recovery method is desired by experienced users. It causes +.B mke2fs +to reinitialize the superblock and group descriptors, while not +touching the inode table and the block and inode bitmaps. The +.B e2fsck +program should be run immediately after this option is used, and there +is no guarantee that any data will be salvageable. Due to the wide +variety of possible options to +.B mke2fs +that affect the on-disk layout, it is critical to specify exactly +the same format options, such as blocksize, fs-type, feature flags, and +other tunables when using this option, or the file system will be further +corrupted. In some cases, such as file systems that have been resized, +or have had features enabled after format time, it is impossible to +overwrite all of the superblocks correctly, and at least some file system +corruption will occur. It is best to run this on a full copy of the +file system so other options can be tried if this doesn't work. +.\" .TP +.\" .BI \-t " test" +.\" Check the device for bad blocks before creating the file system +.\" using the specified test. +.TP +.BI \-t " fs-type" +Specify the file system type (i.e., ext2, ext3, ext4, etc.) that is +to be created. +If this option is not specified, +.B mke2fs +will pick a default either via how +the command was run (for example, using a name of the form mkfs.ext2, +mkfs.ext3, etc.) or via a default as defined by the +.B /etc/mke2fs.conf +file. This option controls which file system options are used by +default, based on the +.B fstypes +configuration stanza in +.BR /etc/mke2fs.conf . +.sp +If the +.B \-O +option is used to explicitly add or remove file system options that +should be set in the newly created file system, the +resulting file system may not be supported by the requested +.IR fs-type . +(e.g., "\fBmke2fs \-t ext3 \-O extent /dev/sdXX\fR" will create a +file system that is not supported by the ext3 implementation as found in +the Linux kernel; and "\fBmke2fs \-t ext3 \-O ^has_journal /dev/hdXX\fR" +will create a file system that does not have a journal and hence will not +be supported by the ext3 file system code in the Linux kernel.) +.TP +.BI \-T " usage-type[,...]" +Specify how the file system is going to be used, so that +.B mke2fs +can choose optimal file system parameters for that use. The usage +types that are supported are defined in the configuration file +.BR /etc/mke2fs.conf . +The user may specify one or more usage types +using a comma separated list. +.sp +If this option is is not specified, +.B mke2fs +will pick a single default usage type based on the size of the file system to +be created. If the file system size is less than 3 megabytes, +.B mke2fs +will use the file system type +.IR floppy . +If the file system size is greater than or equal to 3 but less than +512 megabytes, +.BR mke2fs (8) +will use the file system type +.IR small . +If the file system size is greater than or equal to 4 terabytes but less than +16 terabytes, +.BR mke2fs (8) +will use the file system type +.IR big . +If the file system size is greater than or equal to 16 terabytes, +.BR mke2fs (8) +will use the file system type +.IR huge . +Otherwise, +.BR mke2fs (8) +will use the default file system type +.IR default . +.TP +.BI \-U " UUID" +Set the universally unique identifier (UUID) of the file system to +.IR UUID . +The format of the UUID is a series of hex digits separated by hyphens, +like this: +"c1b9d5a2-f162-11cf-9ece-0020afc76f16". +The +.I UUID +parameter may also be one of the following: +.RS 1.2i +.TP +.I clear +clear the file system UUID +.TP +.I random +generate a new randomly-generated UUID +.TP +.I time +generate a new time-based UUID +.RE +.TP +.B \-v +Verbose execution. +.TP +.B \-V +Print the version number of +.B mke2fs +and exit. +.TP +.BI \-z " undo_file" +Before overwriting a file system block, write the old contents of the block to +an undo file. This undo file can be used with e2undo(8) to restore the old +contents of the file system should something go wrong. If the empty string is +passed as the undo_file argument, the undo file will be written to a file named +mke2fs-\fIdevice\fR.e2undo in the directory specified via the +\fIE2FSPROGS_UNDO_DIR\fR environment variable or the \fIundo_dir\fR directive +in the configuration file. + +WARNING: The undo file cannot be used to recover from a power or system crash. +.SH ENVIRONMENT +.TP +.B MKE2FS_SYNC +If set to non-zero integer value, its value is used to determine how often +.BR sync (2) +is called during inode table initialization. +.TP +.B MKE2FS_CONFIG +Determines the location of the configuration file (see +.BR mke2fs.conf (5)). +.TP +.B MKE2FS_FIRST_META_BG +If set to non-zero integer value, its value is used to determine first meta +block group. This is mostly for debugging purposes. +.TP +.B MKE2FS_DEVICE_SECTSIZE +If set to non-zero integer value, its value is used to determine logical +sector size of the +.IR device . +.TP +.B MKE2FS_DEVICE_PHYS_SECTSIZE +If set to non-zero integer value, its value is used to determine physical +sector size of the +.IR device . +.TP +.B MKE2FS_SKIP_CHECK_MSG +If set, do not show the message of file system automatic check caused by +mount count or check interval. +.SH AUTHOR +This version of +.B mke2fs +has been written by Theodore Ts'o <tytso@mit.edu>. +.SH AVAILABILITY +.B mke2fs +is part of the e2fsprogs package and is available from +http://e2fsprogs.sourceforge.net. +.SH SEE ALSO +.BR mke2fs.conf (5), +.BR badblocks (8), +.BR dumpe2fs (8), +.BR e2fsck (8), +.BR tune2fs (8), +.BR ext4 (5) diff --git a/upstream/opensuse-leap-15-6/man8/mkfs.fat.8 b/upstream/opensuse-leap-15-6/man8/mkfs.fat.8 new file mode 100644 index 00000000..c094ec47 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/mkfs.fat.8 @@ -0,0 +1,189 @@ +.\" mkfs.fat.8 - manpage for fs.fatck +.\" +.\" Copyright (C) 2006-2014 Daniel Baumann <daniel@debian.org> +.\" Copyright (C) 2016 Andreas Bombe <aeb@debian.org> +.\" +.\" This program is free software: you can redistribute it and/or modify +.\" it under the terms of the GNU General Public License as published by +.\" the Free Software Foundation, either version 3 of the License, or +.\" (at your option) any later version. +.\" +.\" This program is distributed in the hope that it will be useful, +.\" but WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.\" GNU General Public License for more details. +.\" +.\" You should have received a copy of the GNU General Public License +.\" along with this program. If not, see <http://www.gnu.org/licenses/>. +.\" +.\" The complete text of the GNU General Public License +.\" can be found in /usr/share/common-licenses/GPL-3 file. +.\" +.\" +.TH MKFS.FAT 8 2016\-01\-25 "dosfstools 4.1" +.SH NAME +\fBmkfs.fat\fR \- create an MS-DOS filesystem under Linux +.\" ---------------------------------------------------------------------------- +.SH SYNOPSIS +\fBmkfs.fat\fR [\fIOPTIONS\fR] \fIDEVICE\fR [\fIBLOCK-COUNT\fR] +.\" ---------------------------------------------------------------------------- +.SH DESCRIPTION +\fBmkfs.fat\fR is used to create an MS-DOS filesystem under Linux on a device +(usually a disk partition). +\fIDEVICE\fR is the special file corresponding to the device (e.g. /dev/sdXX). +\fIBLOCK-COUNT\fR is the number of blocks on the device. +If omitted, \fBmkfs.fat\fR automatically determines the filesystem size. +.\" ---------------------------------------------------------------------------- +.SH OPTIONS +.IP "\fB\-a\fR" 4 +Normally, for any filesystem except very small ones, \fBmkfs.fat\fR will align +all the data structures to cluster size, to make sure that as long as the +partition is properly aligned, so will all the data structures in the +filesystem. +This option disables alignment; this may provide a handful of additional +clusters of storage at the expense of a significant performance degradation on +RAIDs, flash media or large-sector hard disks. +.IP "\fB \-A\fR" 4 +Use Atari variation of the MS-DOS filesystem. +This is default if \fBmkfs.fat\fR is run on an Atari, then this option turns off +Atari format. +There are some differences when using Atari format: +If not directed otherwise by the user, \fBmkfs.fat\fR will always use 2 sectors +per cluster, since GEMDOS doesn't like other values very much. +It will also obey the maximum number of sectors GEMDOS can handle. +Larger filesystems are managed by raising the logical sector size. +Under Atari format, an Atari-compatible serial number for the filesystem is +generated, and a 12 bit FAT is used only for filesystems that have one of the +usual floppy sizes (720k, 1.2M, 1.44M, 2.88M), a 16 bit FAT otherwise. +This can be overridden with the \fB\-F\fR option. +Some PC-specific boot sector fields aren't written, and a boot message (option +\fB\-m\fR) is ignored. +.IP "\fB\-b\fR \fISECTOR-OF-BACKUP\fR" 4 +Selects the location of the backup boot sector for FAT32. +Default depends on number of reserved sectors, but usually is sector 6. +The backup must be within the range of reserved sectors. +.IP "\fB\-c" 4 +Check the device for bad blocks before creating the filesystem. +.IP "\fB\-C\fR" 4 +Create the file given as \fIDEVICE\fR on the command line, and write the +to-be-created filesystem to it. +This can be used to create the new filesystem in a file instead of on a real +device, and to avoid using \fBdd\fR in advance to create a file of appropriate +size. +With this option, the \fIBLOCK-COUNT\fR must be given, because otherwise the +intended size of the filesystem wouldn't be known. +The file created is a sparse file, which actually only contains the meta-data +areas (boot sector, FATs, and root directory). +The data portions won't be stored on the disk, but the file nevertheless will +have the correct size. +The resulting file can be copied later to a floppy disk or other device, or +mounted through a loop device. +.IP "\fB\-D\fR \fIDRIVE-NUMBER\fR" 4 +Specify the BIOS drive number to be stored in the FAT boot sector. +This value is usually 0x80 for hard disks and 0x00 for floppy devices or +partitions to be used for floppy emulation. +.IP "\fB\-f\fR \fINUMBER-OF-FATS\fR" 4 +Specify the number of file allocation tables in the filesystem. +The default is 2. +.IP "\fB\-F\fR \fIFAT-SIZE\fR" 4 +Specifies the type of file allocation tables used (12, 16 or 32 bit). +If nothing is specified, \fBmkfs.fat\fR will automatically select between 12, 16 +and 32 bit, whatever fits better for the filesystem size. +.IP "\fB\-g\fR \fIHEADS\fR/\fISECTORS-PER-TRACK\fR" 4 +Specify \fIHEADS\fR and \fISECTORS-PER-TRACK\fR numbers which represents +disk geometry of \fIDEVICE\fR. Both numbers are stored into the FAT boot sector. +Number \fISECTORS-PER-TRACK\fR is used also for aligning the total count of FAT +sectors. By default disk geometry is read from \fIDEVICE\fR itself. If it is not +available then \fILBA-Assist Translation\fR and translation table from the +\fISD Card Part 2 File System Specification\fR based on total number of disk +sectors is used. +.IP "\fB\-h\fR \fINUMBER-OF-HIDDEN-SECTORS\fR" 4 +Select the number of hidden sectors in the volume. +Apparently some digital cameras get indigestion if you feed them a CF card +without such hidden sectors, this option allows you to satisfy them. +.IP "\fB\-i\fR \fIVOLUME-ID\fR" 4 +Sets the volume ID of the newly created filesystem; \fIVOLUME-ID\fR is a 32-bit +hexadecimal number (for example, 2e24ec82). +The default is a number which depends on the filesystem creation time. +.IP "\fB\-I\fR" 4 +It is typical for fixed disk devices to be partitioned so, by default, you are +not permitted to create a filesystem across the entire device. +\fBmkfs.fat\fR will complain and tell you that it refuses to work. +This is different when using MO disks. +One doesn't always need partitions on MO disks. +The filesystem can go directly to the whole disk. +Under other OSes this is known as the 'superfloppy' format. +This switch will force \fBmkfs.fat\fR to work properly. +.IP "\fB\-l\fR \fIFILENAME\fR" 4 +Read the bad blocks list from \fIFILENAME\fR. +.IP "\fB\-m\fR \fIMESSAGE-FILE\fR" 4 +Sets the message the user receives on attempts to boot this filesystem without +having properly installed an operating system. +The message file must not exceed 418 bytes once line feeds have been converted +to carriage return-line feed combinations, and tabs have been expanded. +If the filename is a hyphen (-), the text is taken from standard input. +.IP "\fB\-M\fR \fIFAT-MEDIA-TYPE\fR" 4 +Specify the media type to be stored in the FAT boot sector. +This value is usually 0xF8 for hard disks and is 0xF0 or a value from 0xF9 to +0xFF for floppies or partitions to be used for floppy emulation. +.IP "\fB\-n\fR \fIVOLUME-NAME\fR" 4 +Sets the volume name (label) of the filesystem. +The volume name can be up to 11 characters long. +The default is no label. +.IP "\fB\-r\fR \fIROOT-DIR-ENTRIES\fR" 4 +Select the number of entries available in the root directory. +The default is 112 or 224 for floppies and 512 for hard disks. +.IP "\fB\-R\fR \fINUMBER-OF-RESERVED-SECTORS\fR" 4 +Select the number of reserved sectors. +With FAT32 format at least 2 reserved sectors are needed, the default is 32. +Otherwise the default is 1 (only the boot sector). +.IP "\fB\-s\fR \fISECTORS-PER-CLUSTER\fR" 4 +Specify the number of disk sectors per cluster. +Must be a power of 2, i.e. 1, 2, 4, 8, ... 128. +.IP "\fB\-S\fR \fILOGICAL-SECTOR-SIZE\fR" 4 +Specify the number of bytes per logical sector. +Must be a power of 2 and greater than or equal to 512, i.e. 512, 1024, 2048, +4096, 8192, 16384, or 32768. +Values larger than 4096 are not conforming to the FAT file system specification +and may not work everywhere. +.IP "\fB\-v\fR" 4 +Verbose execution. +.IP "\fB\-\-invariant\fR" 4 +Use constants for normally randomly generated or time based data such as +volume ID and creation time. +Multiple runs of \fBmkfs.fat\fR on the same device create identical results +with this option. +Its main purpose is testing \fBmkfs.fat\fR. +.IP "\fB\-\-help\fR" 4 +Display option summary and exit. +.\" ---------------------------------------------------------------------------- +.SH BUGS +\fBmkfs.fat\fR can not create boot-able filesystems. +This isn't as easy as you might think at first glance for various reasons and +has been discussed a lot already. +\fBmkfs.fat\fR simply will not support it ;) +.\" ---------------------------------------------------------------------------- +.SH SEE ALSO +\fBfatlabel\fR(8) +.br +\fBfsck.fat\fR(8) +.\" ---------------------------------------------------------------------------- +.SH HOMEPAGE +The home for the \fBdosfstools\fR project is its +.UR https://github.com/dosfstools/dosfstools +GitHub project page +.UE . +.\" ---------------------------------------------------------------------------- +.SH AUTHORS +\fBdosfstools\fR were written by +.MT werner.almesberger@\:lrc.di.epfl.ch +Werner Almesberger +.ME , +.MT Roman.Hodek@\:informatik.\:uni-erlangen.de +Roman Hodek +.ME , +and others. +The current maintainer is +.MT aeb@\:debian.org +Andreas Bombe +.ME . diff --git a/upstream/opensuse-leap-15-6/man8/mkfs.minix.8 b/upstream/opensuse-leap-15-6/man8/mkfs.minix.8 new file mode 100644 index 00000000..8faafa4a --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/mkfs.minix.8 @@ -0,0 +1,142 @@ +'\" t +.\" Title: mkfs.minix +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "MKFS.MINIX" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +mkfs.minix \- make a Minix filesystem +.SH "SYNOPSIS" +.sp +\fBmkfs.minix\fP [options] \fIdevice\fP [\fIsize\-in\-blocks\fP] +.SH "DESCRIPTION" +.sp +\fBmkfs.minix\fP creates a Linux MINIX filesystem on a device (usually a disk partition). +.sp +The \fIdevice\fP is usually of the following form: +.sp +.if n .RS 4 +.nf +.fam C +/dev/hda[1\-8] (IDE disk 1) +/dev/hdb[1\-8] (IDE disk 2) +/dev/sda[1\-8] (SCSI disk 1) +/dev/sdb[1\-8] (SCSI disk 2) +.fam +.fi +.if n .RE +.sp +The device may be a block device or an image file of one, but this is not enforced. Expect not much fun on a character device :\-). +.sp +The \fIsize\-in\-blocks\fP parameter is the desired size of the file system, in blocks. It is present only for backwards compatibility. If omitted the size will be determined automatically. Only block counts strictly greater than 10 and strictly less than 65536 are allowed. +.SH "OPTIONS" +.sp +\fB\-c\fP, \fB\-\-check\fP +.RS 4 +Check the device for bad blocks before creating the filesystem. If any are found, the count is printed. +.RE +.sp +\fB\-n\fP, \fB\-\-namelength\fP \fIlength\fP +.RS 4 +Specify the maximum length of filenames. Currently, the only allowable values are 14 and 30 for file system versions 1 and 2. Version 3 allows only value 60. The default is 30. +.RE +.sp +\fB\-\-lock\fP[=\fImode\fP] +.RS 4 +Use exclusive BSD lock for device or file it operates. The optional argument \fImode\fP can be \fByes\fP, \fBno\fP (or 1 and 0) or \fBnonblock\fP. If the \fImode\fP argument is omitted, it defaults to \fB"yes"\fP. This option overwrites environment variable \fB$LOCK_BLOCK_DEVICE\fP. The default is not to use any lock at all, but it\(cqs recommended to avoid collisions with udevd or other tools. +.RE +.sp +\fB\-i\fP, \fB\-\-inodes\fP \fInumber\fP +.RS 4 +Specify the number of inodes for the filesystem. +.RE +.sp +\fB\-l\fP, \fB\-\-badblocks\fP \fIfilename\fP +.RS 4 +Read the list of bad blocks from \fIfilename\fP. The file has one bad\-block number per line. The count of bad blocks read is printed. +.RE +.sp +\fB\-1\fP +.RS 4 +Make a Minix version 1 filesystem. This is the default. +.RE +.sp +\fB\-2\fP, \fB\-v\fP +.RS 4 +Make a Minix version 2 filesystem. +.RE +.sp +\fB\-3\fP +.RS 4 +Make a Minix version 3 filesystem. +.RE +.sp +\fB\-V\fP, \fB\-\-version\fP +.RS 4 +Display version information and exit. The long option cannot be combined with other options. +.RE +.sp +\fB\-h\fP, \fB\-\-help\fP +.RS 4 +Display help text and exit. +.RE +.SH "ENVIRONMENT" +.sp +LOCK_BLOCK_DEVICE=<mode> +.RS 4 +use exclusive BSD lock. The mode is "1" or "0". See \fB\-\-lock\fP for more details. +.RE +.SH "EXIT STATUS" +.sp +The exit status returned by \fBmkfs.minix\fP is one of the following: +.sp +0 +.RS 4 +No errors +.RE +.sp +8 +.RS 4 +Operational error +.RE +.sp +16 +.RS 4 +Usage or syntax error +.RE +.SH "SEE ALSO" +.sp +\fBfsck\fP(8), +\fBmkfs\fP(8), +\fBreboot\fP(8) +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBmkfs.minix\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/mkfs.xfs.8 b/upstream/opensuse-leap-15-6/man8/mkfs.xfs.8 new file mode 100644 index 00000000..891570d0 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/mkfs.xfs.8 @@ -0,0 +1,1147 @@ +.TH mkfs.xfs 8 +.SH NAME +mkfs.xfs \- construct an XFS filesystem +.SH SYNOPSIS +.B mkfs.xfs +[ +.B \-b +.I block_size_options +] [ +.B \-c +.I config_file_options +] [ +.B \-m +.I global_metadata_options +] [ +.B \-d +.I data_section_options +] [ +.B \-f +] [ +.B \-i +.I inode_options +] [ +.B \-l +.I log_section_options +] [ +.B \-n +.I naming_options +] [ +.B \-p +.I protofile_options +] [ +.B \-q +] [ +.B \-r +.I realtime_section_options +] [ +.B \-s +.I sector_size_options +] [ +.B \-L +.I label +] [ +.B \-N +] [ +.B \-K +] +.I device +.br +.B mkfs.xfs \-V +.SH DESCRIPTION +.B mkfs.xfs +constructs an XFS filesystem by writing on a special +file using the values found in the arguments of the command line. +It is invoked automatically by +.BR mkfs (8) +when it is given the +.B \-t xfs +option. +.PP +In its simplest (and most commonly used form), the size of the +filesystem is determined from the disk driver. As an example, to make +a filesystem with an internal log on the first partition on the first +SCSI disk, use: +.IP +.B mkfs.xfs /dev/sda1 +.PP +The metadata log can be placed on another device to reduce the number +of disk seeks. To create a filesystem on the first partition on the +first SCSI disk with a 100MiB log located on the first partition +on the second SCSI disk, use: +.RS +.HP +.B mkfs.xfs\ \-l\ logdev=/dev/sdb1,size=100m /dev/sda1 +.RE +.PP +Each of the +.I option +elements in the argument list above can be given as multiple comma-separated +suboptions if multiple suboptions apply to the same option. +Equivalently, each main option can be given multiple times with +different suboptions. +For example, +.B \-l internal,size=100m +and +.B \-l internal \-l size=100m +are equivalent. +.PP +In the descriptions below, sizes are given in sectors, bytes, blocks, +kilobytes, megabytes, gigabytes, etc. +Sizes are treated as hexadecimal if prefixed by 0x or 0X, +octal if prefixed by 0, or decimal otherwise. +The following lists possible multiplication suffixes: +.RS +.PD 0 +.HP +.BR s "\ \-\ multiply by sector size (default = 512, see " \-s +option below). +.HP +.BR b "\ \-\ multiply by filesystem block size (default = 4K, see " \-b +option below). +.HP +.BR k "\ \-\ multiply by one kilobyte (1,024 bytes)." +.HP +.BR m "\ \-\ multiply by one megabyte (1,048,576 bytes)." +.HP +.BR g "\ \-\ multiply by one gigabyte (1,073,741,824 bytes)." +.HP +.BR t "\ \-\ multiply by one terabyte (1,099,511,627,776 bytes)." +.HP +.BR p "\ \-\ multiply by one petabyte (1,024 terabytes)." +.HP +.BR e "\ \-\ multiply by one exabyte (1,048,576 terabytes)." +.PD +.RE +.PP +When specifying parameters in units of sectors or filesystem blocks, the +.B \-s +option or the +.B \-b +option may be used to specify the size of the sector or block. +If the size of the block or sector is not specified, the default sizes +(block: 4KiB, sector: 512B) will be used. +.PP +Many feature options allow an optional argument of 0 or 1, to explicitly +disable or enable the functionality. + +The correctness of the crc32c checksum implementation will be tested +before formatting the filesystem. +If the test fails, the format will abort. +.SH OPTIONS +Options may be specified either on the command line or in a configuration file. +Not all command line options can be specified in configuration files; only the +command line options followed by a +.B [section] +label can be used in a configuration file. +.PP +Options that can be used in configuration files are grouped into related +sections containing multiple options. +The command line options and configuration files use the same option +sections and grouping. +Configuration file section names are listed in the command line option +sections below. +Option names and values are the same for both command line +and configuration file specification. +.PP +Options specified are the combined set of command line parameters and +configuration file parameters. +Duplicated options will result in a respecification error, regardless of the +location they were specified at. +.TP +.BI \-c " configuration_file_option" +This option specifies the files that mkfs configuration will be obtained from. +The valid +.I configuration_file_option +is: +.RS 1.2i +.TP +.BI options= name +The configuration options will be sourced from the file specified by the +.I name +option string. +This option can be use either an absolute or relative path to the configuration +file to be read. +Sample configuration files can be found in /usr/share/xfsprogs/mkfs. +.RE +.PP +.PD 0 +.BI \-b " block_size_options" +.TP +.BI "Section Name: " [block] +.PD +This option specifies the fundamental block size of the filesystem. +The valid +.I block_size_option +is: +.RS 1.2i +.TP +.BI size= value +The filesystem block size is specified with a +.I value +in bytes. The default value is 4096 bytes (4 KiB), the minimum is 512, and the +maximum is 65536 (64 KiB). +.IP +Although +.B mkfs.xfs +will accept any of these values and create a valid filesystem, +XFS on Linux can only mount filesystems with pagesize or smaller blocks. +.RE +.PP +.PD 0 +.BI \-m " global_metadata_options" +.TP +.BI "Section Name: " [metadata] +.PD +These options specify metadata format options that either apply to the entire +filesystem or aren't easily characterised by a specific functionality group. The +valid +.I global_metadata_options +are: +.RS 1.2i +.TP +.BI bigtime= value +This option enables filesystems that can handle inode timestamps from December +1901 to July 2486, and quota timer expirations from January 1970 to July 2486. +The value is either 0 to disable the feature, or 1 to enable large timestamps. +.IP +If this feature is not enabled, the filesystem can only handle timestamps from +December 1901 to January 2038, and quota timers from January 1970 to February +2106. +.IP +By default, +.B mkfs.xfs +will enable this feature. +If the option +.B \-m crc=0 +is used, the large timestamp feature is not supported and is disabled. +.TP +.BI crc= value +This is used to create a filesystem which maintains and checks CRC information +in all metadata objects on disk. The value is either 0 to disable the feature, +or 1 to enable the use of CRCs. +.IP +CRCs enable enhanced error detection due to hardware issues, whilst the format +changes also improves crash recovery algorithms and the ability of various tools +to validate and repair metadata corruptions when they are found. The CRC +algorithm used is CRC32c, so the overhead is dependent on CPU architecture as +some CPUs have hardware acceleration of this algorithm. Typically the overhead +of calculating and checking the CRCs is not noticeable in normal operation. +.IP +By default, +.B mkfs.xfs +will enable metadata CRCs. +.IP +Formatting a filesystem without CRCs selects the V4 format, which is deprecated +and will be removed from upstream in September 2030. +Distributors may choose to withdraw support for the V4 format earlier than +this date. +Several other options, noted below, are only tunable on V4 formats, and will +be removed along with the V4 format itself. +.TP +.BI finobt= value +This option enables the use of a separate free inode btree index in each +allocation group. The value is either 0 to disable the feature, or 1 to create +a free inode btree in each allocation group. +.IP +The free inode btree mirrors the existing allocated inode btree index which +indexes both used and free inodes. The free inode btree does not index used +inodes, allowing faster, more consistent inode allocation performance as +filesystems age. +.IP +By default, +.B mkfs.xfs +will create free inode btrees for filesystems created with the (default) +.B \-m crc=1 +option set. When the option +.B \-m crc=0 +is used, the free inode btree feature is not supported and is disabled. +.TP +.BI inobtcount= value +This option causes the filesystem to record the number of blocks used by +the inode btree and the free inode btree. +This can be used to reduce mount times when the free inode btree is enabled. +.IP +By default, +.B mkfs.xfs +will enable this option. +This feature is only available for filesystems created with the (default) +.B \-m finobt=1 +option set. +When the option +.B \-m finobt=0 +is used, the inode btree counter feature is not supported and is disabled. +.TP +.BI uuid= value +Use the given value as the filesystem UUID for the newly created filesystem. +The default is to generate a random UUID. +.TP +.BI rmapbt= value +This option enables the creation of a reverse-mapping btree index in each +allocation group. The value is either 0 to disable the feature, or 1 to +create the btree. +.IP +The reverse mapping btree maps filesystem blocks to the owner of the +filesystem block. Most of the mappings will be to an inode number and an +offset, though there will also be mappings to filesystem metadata. This +secondary metadata can be used to validate the primary metadata or to +pinpoint exactly which data has been lost when a disk error occurs. +.IP +By default, +.B mkfs.xfs +will create reverse mapping btrees when possible. +This feature is only available for filesystems created with the (default) +.B \-m crc=1 +option set. When the option +.B \-m crc=0 +is used, the reverse mapping btree feature is not supported and is disabled. +.TP +.BI reflink= value +This option enables the use of a separate reference count btree index in each +allocation group. The value is either 0 to disable the feature, or 1 to create +a reference count btree in each allocation group. +.IP +The reference count btree enables the sharing of physical extents between +the data forks of different files, which is commonly known as "reflink". +Unlike traditional Unix filesystems which assume that every inode and +logical block pair map to a unique physical block, a reflink-capable +XFS filesystem removes the uniqueness requirement, allowing up to four +billion arbitrary inode/logical block pairs to map to a physical block. +If a program tries to write to a multiply-referenced block in a file, the write +will be redirected to a new block, and that file's logical-to-physical +mapping will be changed to the new block ("copy on write"). This feature +enables the creation of per-file snapshots and deduplication. It is only +available for the data forks of regular files. +.IP +By default, +.B mkfs.xfs +will create reference count btrees and therefore will enable the +reflink feature. This feature is only available for filesystems created with +the (default) +.B \-m crc=1 +option set. When the option +.B \-m crc=0 +is used, the reference count btree feature is not supported and reflink is +disabled. +.RE +.PP +.PD 0 +.BI \-d " data_section_options" +.TP +.BI "Section Name: " [data] +.PD +These options specify the location, size, and other parameters of the +data section of the filesystem. The valid +.I data_section_options +are: +.RS 1.2i +.TP +.BI agcount= value +This is used to specify the number of allocation groups. The data section +of the filesystem is divided into allocation groups to improve the +performance of XFS. More allocation groups imply that more parallelism +can be achieved when allocating blocks and inodes. The minimum +allocation group size is 16 MiB; the maximum size is just under 1 TiB. +The data section of the filesystem is divided into +.I value +allocation groups (default value is scaled automatically based +on the underlying device size). +.TP +.BI agsize= value +This is an alternative to using the +.B agcount +suboption. The +.I value +is the desired size of the allocation group expressed in bytes +(usually using the +.BR m " or " g +suffixes). +This value must be a multiple of the filesystem block size, and +must be at least 16MiB, and no more than 1TiB, and may +be automatically adjusted to properly align with the stripe geometry. +The +.B agcount +and +.B agsize +suboptions are mutually exclusive. +.TP +.BI cowextsize= value +Set the copy-on-write extent size hint on all inodes created by +.BR mkfs.xfs "." +The value must be provided in units of filesystem blocks. +If the value is zero, the default value (currently 32 blocks) will be used. +Directories will pass on this hint to newly created regular files and +directories. +.TP +.BI name= value +This can be used to specify the name of the special file containing +the filesystem. In this case, the log section must be specified as +.B internal +(with a size, see the +.B \-l +option below) and there can be no real-time section. +.TP +.BI file[= value ] +This is used to specify that the file given by the +.B name +suboption is a regular file. The +.I value +is either 0 or 1, with 1 signifying that the file is regular. This +suboption is used only to make a filesystem image. If the +.I value +is omitted then 1 is assumed. +.TP +.BI size= value +This is used to specify the size of the data section. This suboption +is required if +.B \-d file[=1] +is given. Otherwise, it is only needed if the filesystem should occupy +less space than the size of the special file. + +The data section must be at least 300MB in size. +.TP +.BI sunit= value +This is used to specify the stripe unit for a RAID device or a +logical volume. The +.I value +has to be specified in 512-byte block units. Use the +.B su +suboption to specify the stripe unit size in bytes. This suboption +ensures that data allocations will be stripe unit aligned when the +current end of file is being extended and the file size is larger +than 512KiB. Also inode allocations and the internal log will be +stripe unit aligned. +.TP +.BI su= value +This is an alternative to using +.B sunit. +The +.B su +suboption is used to specify the stripe unit for a RAID device or a +striped logical volume. The +.I value +has to be specified in bytes, (usually using the +.BR m " or " g +suffixes). This +.I value +must be a multiple of the filesystem block size. +.TP +.BI swidth= value +This is used to specify the stripe width for a RAID device or a +striped logical volume. The +.I value +has to be specified in 512-byte block units. Use the +.B sw +suboption to specify the stripe width size in bytes. +This suboption is required if +.B \-d sunit +has been specified and it has to be a multiple of the +.B \-d sunit +suboption. +.TP +.BI sw= value +suboption is an alternative to using +.B swidth. +The +.B sw +suboption is used to specify the stripe width for a RAID device or +striped logical volume. The +.I value +is expressed as a multiplier of the stripe unit, +usually the same as the number of stripe members in the logical +volume configuration, or data disks in a RAID device. +.IP +When a filesystem is created on a block device, +.B mkfs.xfs +will automatically query the block device for appropriate +.B sunit +and +.B swidth +values if the block device and the filesystem size would be larger than 1GB. +.TP +.BI noalign +This option disables automatic geometry detection and creates the filesystem +without stripe geometry alignment even if the underlying storage device provides +this information. +.TP +.BI rtinherit= value +If +.I value +is set to 1, all inodes created by +.B mkfs.xfs +will be created with the realtime flag set. +The default is 0. +Directories will pass on this flag to newly created regular files and +directories. +.TP +.BI projinherit= value +All inodes created by +.B mkfs.xfs +will be assigned the project quota id provided in +.I value. +Directories will pass on the project id to newly created regular files and +directories. +.TP +.BI extszinherit= value +All inodes created by +.B mkfs.xfs +will have this +.I value +extent size hint applied. +The value must be provided in units of filesystem blocks. +Directories will pass on this hint to newly created regular files and +directories. +.TP +.BI daxinherit= value +If +.I value +is set to 1, all inodes created by +.B mkfs.xfs +will be created with the DAX flag set. +The default is 0. +Directories will pass on this flag to newly created regular files and +directories. +By default, +.B mkfs.xfs +will not enable DAX mode. +.RE +.TP +.B \-f +Force overwrite when an existing filesystem is detected on the device. +By default, +.B mkfs.xfs +will not write to the device if it suspects that there is a filesystem +or partition table on the device already. +.PP +.PD 0 +.BI \-i " inode_options" +.TP +.BI "Section Name: " [inode] +.PD +This option specifies the inode size of the filesystem, and other +inode allocation parameters. +The XFS inode contains a fixed-size part and a variable-size part. +The variable-size part, whose size is affected by this option, can contain: +directory data, for small directories; +attribute data, for small attribute sets; +symbolic link data, for small symbolic links; +the extent list for the file, for files with a small number of extents; +and the root of a tree describing the location of extents for the file, +for files with a large number of extents. +.IP +The valid +.I inode_options +are: +.RS 1.2i +.TP +.BI size= value " | perblock=" value +The inode size is specified either as a +.I value +in bytes with +.BR size= +or as the number fitting in a filesystem block with +.BR perblock= . +The minimum (and default) +.I value +is 256 bytes without crc, 512 bytes with crc enabled. +The maximum +.I value +is 2048 (2 KiB) subject to the restriction that +the inode size cannot exceed one half of the filesystem block size. +.IP +XFS uses 64-bit inode numbers internally; however, the number of +significant bits in an inode number +is affected by filesystem geometry. In +practice, filesystem size and inode size are the predominant factors. +The Linux kernel (on 32 bit hardware platforms) and most applications +cannot currently handle inode numbers greater than 32 significant bits, +so if no inode size is given on the command line, +.B mkfs.xfs +will attempt to choose a size +such that inode numbers will be < 32 bits. If an inode size +is specified, or if a filesystem is sufficiently large, +.B mkfs.xfs +will warn if this will create inode numbers > 32 significant +bits. +.TP +.BI maxpct= value +This specifies the maximum percentage of space in the filesystem that +can be allocated to inodes. The default +.I value +is 25% for filesystems under 1TB, 5% for filesystems under 50TB and 1% +for filesystems over 50TB. +.IP +Setting the value to 0 means that essentially all of the filesystem +can become inode blocks (subject to possible +.B inode32 +mount option restrictions, see +.BR xfs (5) +for details.) +.IP +This value can be modified with +.BR xfs_growfs (8). +.TP +.BI align[= value ] +This is used to specify that inode allocation is or is not aligned. The +.I value +is either 0 or 1, with 1 signifying that inodes are allocated aligned. +If the +.I value +is omitted, 1 is assumed. The default is that inodes are aligned. +Aligned inode access is normally more efficient than unaligned access; +alignment must be established at the time the filesystem is created, +since inodes are allocated at that time. +This option can be used to turn off inode alignment when the +filesystem needs to be mountable by a version of IRIX +that does not have the inode alignment feature +(any release of IRIX before 6.2, and IRIX 6.2 without XFS patches). +.IP +This option is only tunable on the deprecated V4 format. +.TP +.BI attr= value +This is used to specify the version of extended attribute inline +allocation policy to be used. By default, this is 2, which uses an +efficient algorithm for managing the available inline inode space +between attribute and extent data. +.IP +The previous version 1, which has fixed regions for attribute and +extent data, is kept for backwards compatibility with kernels older +than version 2.6.16. +.IP +This option is only tunable on the deprecated V4 format. +.TP +.BI projid32bit[= value ] +This is used to enable 32bit quota project identifiers. The +.I value +is either 0 or 1, with 1 signifying that 32bit projid are to be enabled. +If the value is omitted, 1 is assumed. (This default changed +in release version 3.2.0.) +.IP +This option is only tunable on the deprecated V4 format. +.TP +.BI sparse[= value ] +Enable sparse inode chunk allocation. The +.I value +is either 0 or 1, with 1 signifying that sparse allocation is enabled. +If the value is omitted, 1 is assumed. Sparse inode allocation is +enabled by default. This feature is only available for filesystems +formatted with +.B \-m crc=1. +.IP +When enabled, sparse inode allocation allows the filesystem to allocate +smaller than the standard 64-inode chunk when free space is severely +limited. This feature is useful for filesystems that might fragment free +space over time such that no free extents are large enough to +accommodate a chunk of 64 inodes. Without this feature enabled, inode +allocations can fail with out of space errors under severe fragmented +free space conditions. +.TP +.BI nrext64[= value] +Extend maximum values of inode data and attr fork extent counters from 2^31 - +1 and 2^15 - 1 to 2^48 - 1 and 2^32 - 1 respectively. +If the value is omitted, 1 is assumed. +This feature will be enabled when possible. +This feature is only available for filesystems formatted with -m crc=1. +.TP +.RE +.PP +.PD 0 +.BI \-l " log_section_options" +.TP +.BI "Section Name: " [log] +.PD +These options specify the location, size, and other parameters of the +log section of the filesystem. The valid +.I log_section_options +are: +.RS 1.2i +.TP +.BI agnum= value +If the log is internal, allocate it in this AG. +.TP +.BI internal[= value ] +This is used to specify that the log section is a piece of the data +section instead of being another device or logical volume. The +.I value +is either 0 or 1, with 1 signifying that the log is internal. If the +.I value +is omitted, 1 is assumed. +.TP +.BI logdev= device +This is used to specify that the log section should reside on the +.I device +separate from the data section. The +.B internal=1 +and +.B logdev +options are mutually exclusive. +.TP +.BI size= value +This is used to specify the size of the log section. +.IP +If the log is contained within the data section and +.B size +isn't specified, +.B mkfs.xfs +will try to select a suitable log size depending +on the size of the filesystem. The actual logsize depends on the +filesystem block size and the directory block size. +.IP +Otherwise, the +.B size +suboption is only needed if the log section of the filesystem +should occupy less space than the size of the special file. The +.I value +is specified in bytes or blocks, with a +.B b +suffix meaning multiplication by the filesystem block size, as +described above. The overriding minimum value for size is 512 blocks. +With some combinations of filesystem block size, inode size, +and directory block size, the minimum log size is larger than 512 blocks. + +The log must be at least 64MB in size. +The log cannot be more than 2GB in size. +.TP +.BI version= value +This specifies the version of the log. The current default is 2, +which allows for larger log buffer sizes, as well as supporting +stripe-aligned log writes (see the sunit and su options, below). +.IP +The previous version 1, which is limited to 32k log buffers and does +not support stripe-aligned writes, is kept for backwards compatibility +with very old 2.4 kernels. +.IP +This option is only tunable on the deprecated V4 format. +.TP +.BI sunit= value +This specifies the alignment to be used for log writes. The +.I value +has to be specified in 512-byte block units. Use the +.B su +suboption to specify the log stripe unit size in bytes. +Log writes will be aligned on this boundary, +and rounded up to this boundary. +This gives major improvements in performance on some configurations +such as software RAID5 when the +.B sunit +is specified as the filesystem block size. +The equivalent byte value must be a multiple of the filesystem block +size. Version 2 logs are automatically selected if the log +.B sunit +suboption is specified. +.IP +The +.B su +suboption is an alternative to using +.B sunit. +.TP +.BI su= value +This is used to specify the log stripe. The +.I value +has to be specified in bytes, (usually using the +.BR s " or " b +suffixes). This value must be a multiple of the filesystem block size. +Version 2 logs are automatically selected if the log +.B su +suboption is specified. +.TP +.BI lazy-count= value +This changes the method of logging various persistent counters +in the superblock. Under metadata intensive workloads, these +counters are updated and logged frequently enough that the superblock +updates become a serialization point in the filesystem. The +.I value +can be either 0 or 1. +.IP +With +.BR lazy-count=1 , +the superblock is not modified or logged on every change of the +persistent counters. Instead, enough information is kept in +other parts of the filesystem to be able to maintain the persistent +counter values without needed to keep them in the superblock. +This gives significant improvements in performance on some configurations. +The default +.I value +is 1 (on) so you must specify +.B lazy-count=0 +if you want to disable this feature for older kernels which don't support +it. +.IP +This option is only tunable on the deprecated V4 format. +.RE +.PP +.PD 0 +.BI \-n " naming_options" +.TP +.BI "Section Name: " [naming] +.PD +These options specify the version and size parameters for the naming +(directory) area of the filesystem. The valid +.I naming_options +are: +.RS 1.2i +.TP +.BI size= value +The directory block size is specified with a +.I value +in bytes. The block size must be a power of 2 and cannot be less than the +filesystem block size. +The default size +.I value +for version 2 directories is 4096 bytes (4 KiB), +unless the filesystem block size is larger than 4096, +in which case the default +.I value +is the filesystem block size. +For version 1 directories the block size is the same as the +filesystem block size. +.TP +.BI version= value +The naming (directory) version +.I value +can be either 2 or 'ci', defaulting to 2 if unspecified. +With version 2 directories, the directory block size can be +any power of 2 size from the filesystem block size up to 65536. +.IP +If the +.B version=ci +option is specified, the kernel will transform certain bytes in filenames +before performing lookup-related operations. +The byte sequence given to create a directory entry is persisted without +alterations. +The lookup transformations are defined as follows: + + 0x41-0x5a -> 0x61-0x7a + + 0xc0-0xd6 -> 0xe0-0xf6 + + 0xd8-0xde -> 0xf8-0xfe + +This transformation roughly corresponds to case insensitivity in ISO +8859-1. +The transformations are not compatible with other encodings (e.g. UTF8). +Do not enable this feature unless your entire environment has been coerced +to ISO 8859-1. +This feature is deprecated and will be removed in September 2030. +.IP +Note: Version 1 directories are not supported. +.TP +.BI ftype= value +This feature allows the inode type to be stored in the directory +structure so that the +.BR readdir (3) +and +.BR getdents (2) +do not need to look up the inode to determine the inode type. + +The +.I value +is either 0 or 1, with 1 signifying that filetype information +will be stored in the directory structure. The default value is 1. + +When CRCs are enabled (the default), the ftype functionality is always +enabled, and cannot be turned off. +.IP +In other words, this option is only tunable on the deprecated V4 format. +.RE +.PP +.PD 0 +.TP +.BI \-p " protofile_options" +.TP +.BI "Section Name: " [proto] +.PD +These options specify the protofile parameters for populating the filesystem. +The valid +.I protofile_options +are: +.RS 1.2i +.TP +.BI [file=] protofile +The +.B file= +prefix is not required for this CLI argument for legacy reasons. +If specified as a config file directive, the prefix is required. + +If the optional +.PD +.I protofile +argument is given, +.B mkfs.xfs +uses +.I protofile +as a prototype file and takes its directions from that file. +The blocks and inodes specifiers in the +.I protofile +are provided for backwards compatibility, but are otherwise unused. +The syntax of the protofile is defined by a number of tokens separated +by spaces or newlines. Note that the line numbers are not part of the +syntax but are meant to help you in the following discussion of the file +contents. +.nf +.sp .8v +.in +5 +\f71 /stand/\f1\f2diskboot\f1\f7 +2 4872 110 +3 d\-\-777 3 1 +4 usr d\-\-777 3 1 +5 sh \-\-\-755 3 1 /bin/sh +6 ken d\-\-755 6 1 +7 $ +8 b0 b\-\-644 3 1 0 0 +9 c0 c\-\-644 3 1 0 0 +10 fifo p\-\-644 3 1 +11 slink l\-\-644 3 1 /a/symbolic/link +12 : This is a comment line +13 $ +14 $\f1 +.in -5 +.fi +.IP +Line 1 is a dummy string. +(It was formerly the bootfilename.) +It is present for backward +compatibility; boot blocks are not used on SGI systems. +.IP +Note that some string of characters must be present as the first line of +the proto file to cause it to be parsed correctly; the value +of this string is immaterial since it is ignored. +.IP +Line 2 contains two numeric values (formerly the numbers of blocks and inodes). +These are also merely for backward compatibility: two numeric values must +appear at this point for the proto file to be correctly parsed, +but their values are immaterial since they are ignored. +.IP +The lines 3 through 11 specify the files and directories you want to +include in this filesystem. Line 3 defines the +root directory. Other directories and +files that you want in the filesystem +are indicated by lines 4 through 6 and +lines 8 through 10. Line 11 contains +symbolic link syntax. +.IP +Notice the dollar sign +.RB ( $ ) +syntax on line 7. This syntax directs the +.B mkfs.xfs +command to terminate the branch of the filesystem it +is currently on and then continue +from the directory specified by +the next line, in this case line 8. +It must be the last character +on a line. +The colon +on line 12 introduces a comment; all characters up until the +following newline are ignored. +Note that this means you cannot +have a file in a prototype file whose name contains a colon. +The +.B $ +on lines 13 and 14 end the process, since no additional +specifications follow. +.IP +File specifications provide the following: +.IP + * file mode +.br + * user ID +.br + * group ID +.br + * the file's beginning contents +.P +.IP +A 6-character string defines the mode for +a file. The first character of this string +defines the file type. The character range +for this first character is +.B \-bcdpl. +A file may be a regular file, a block special file, +a character special file, directory files, named +pipes (first-in, first out files), and symbolic +links. +The second character of the mode string is +used to specify setuserID mode, in which case +it is +.BR u . +If setuserID mode is not specified, the second character is +.BR \- . +The third character of the mode string is +used to specify the setgroupID mode, in which +case it is +.BR g . +If setgroupID mode is not specified, the third character is +.BR \- . +The remaining characters of the mode string are +a three digit octal number. This octal number +defines the owner, group, and other read, write, +and execute permissions for the file, respectively. +For more information on file permissions, see the +.BR chmod (1) +command. +.IP +Following the mode character string are two +decimal number tokens that specify the user and group IDs +of the file's owner. +.IP +In a regular file, the next token specifies the +pathname from which the contents and size of the +file are copied. +In a block or character special file, the next token +are two decimal numbers that specify the major and minor +device numbers. +When a file is a symbolic link, the next token +specifies the contents of the link. + +When the file is a directory, the +.B mkfs.xfs +command creates the entries +.B dot +(.) and +.B dot-dot +(..) and then reads the list of names and file specifications +in a recursive manner for all of the entries +in the directory. A scan of the protofile is +always terminated with the dollar ( +.B $ +) token. +.TP +.BI slashes_are_spaces= value +If set to 1, slashes ("/") in the first token of each line of the protofile +are converted to spaces. +This enables the creation of a filesystem containing filenames with spaces. +By default, this is set to 0. +.RE +.TP +.B \-q +Quiet option. Normally +.B mkfs.xfs +prints the parameters of the filesystem +to be constructed; +the +.B \-q +flag suppresses this. +.PP +.PD 0 +.BI \-r " realtime_section_options" +.TP +.BI "Section Name: " [realtime] +.PD +These options specify the location, size, and other parameters of the +real-time section of the filesystem. The valid +.I realtime_section_options +are: +.RS 1.2i +.TP +.BI rtdev= device +This is used to specify the +.I device +which should contain the real-time section of the filesystem. +The suboption value is the name of a block device. +.TP +.BI extsize= value +This is used to specify the size of the blocks in the real-time +section of the filesystem. This +.I value +must be a multiple of the filesystem block size. The minimum allowed +size is the filesystem block size or 4 KiB (whichever is larger); the +default size is the stripe width for striped volumes or 64 KiB for +non-striped volumes; the maximum allowed size is 1 GiB. The real-time +extent size should be carefully chosen to match the parameters of the +physical media used. +.TP +.BI size= value +This is used to specify the size of the real-time section. +This suboption is only needed if the real-time section of the +filesystem should occupy less space than the size of the partition +or logical volume containing the section. +.TP +.BI noalign +This option disables stripe size detection, enforcing a realtime device with no +stripe geometry. +.RE +.PP +.PD 0 +.BI \-s " sector_size_options" +.TP +.BI "Section Name: " [sector] +.PD +This option specifies the fundamental sector size of the filesystem. +The valid +.I sector_size_option +is: +.RS 1.2i +.TP +.BI size= value +The sector size is specified with a +.I value +in bytes. The default +.I sector_size +is 512 bytes. The minimum value for sector size is +512; the maximum is 32768 (32 KiB). The +.I sector_size +must be a power of 2 size and cannot be made larger than the +filesystem block size. +.RE +.TP +.BI \-L " label" +Set the filesystem +.IR label . +XFS filesystem labels can be at most 12 characters long; if +.I label +is longer than 12 characters, +.B mkfs.xfs +will not proceed with creating the filesystem. Refer to the +.BR mount "(8) and " xfs_admin (8) +manual entries for additional information. +.TP +.B \-N +Causes the file system parameters to be printed out without really +creating the file system. +.TP +.B \-K +Do not attempt to discard blocks at mkfs time. +.TP +.B \-V +Prints the version number and exits. +.SH Configuration File Format +The configuration file uses a basic INI format to specify sections and options +within a section. +Section and option names are case sensitive. +Section names must not contain whitespace. +Options are name-value pairs, ended by the first whitespace in the line. +Option names cannot contain whitespace. +Full line comments can be added by starting a line with a # symbol. +If values contain whitespace, then it must be quoted. +.PP +The following example configuration file sets the block size to 4096 bytes, +turns on reverse mapping btrees and sets the inode size to 2048 bytes. +.PP +.PD 0 +# Example mkfs.xfs configuration file +.HP +.HP +[block] +.HP +size=4k +.HP +.HP +[metadata] +.HP +rmapbt=1 +.HP +.HP +[inode] +.HP +size=2048 +.HP +.PD +.PP +.SH SEE ALSO +.BR xfs (5), +.BR mkfs (8), +.BR mount (8), +.BR xfs_info (8), +.BR xfs_admin (8). +.SH BUGS +With a prototype file, it is not possible to specify hard links. diff --git a/upstream/opensuse-leap-15-6/man8/mkisofs.8 b/upstream/opensuse-leap-15-6/man8/mkisofs.8 new file mode 100644 index 00000000..67578b75 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/mkisofs.8 @@ -0,0 +1,3708 @@ +'\" t +.\" To print, first run through tbl +.\" -*- nroff -*- +.\" @(#)mkisofs.8 1.160 17/12/10 Copyright 1997-2015 J. Schilling +.\"@@C@@ +.\" +.if t .ds a \v'-0.55m'\h'0.00n'\z.\h'0.40n'\z.\v'0.55m'\h'-0.40n'a +.if t .ds o \v'-0.55m'\h'0.00n'\z.\h'0.45n'\z.\v'0.55m'\h'-0.45n'o +.if t .ds u \v'-0.55m'\h'0.00n'\z.\h'0.40n'\z.\v'0.55m'\h'-0.40n'u +.if t .ds A \v'-0.77m'\h'0.25n'\z.\h'0.45n'\z.\v'0.77m'\h'-0.70n'A +.if t .ds O \v'-0.77m'\h'0.25n'\z.\h'0.45n'\z.\v'0.77m'\h'-0.70n'O +.if t .ds U \v'-0.77m'\h'0.30n'\z.\h'0.45n'\z.\v'0.77m'\h'-0.75n'U +.if t .ds s \\(*b +.if t .ds S SS +.if n .ds a ae +.if n .ds o oe +.if n .ds u ue +.if n .ds s sz +.TH MKISOFS 8 "2017/12/10" "Version 3.02" +.SH NAME +mkisofs \- create an hybrid ISO-9660/JOLIET/HFS/UDF filesystem-image with optional Rock Ridge attributes. +.SH SYNOPSIS +.B mkisofs +[ +.I options +] +[ +.B \-o +.I filename +] +.I pathspec [pathspec ...] +.br +.B mkisofs +[ +.I options +] +[ +.B \-o +.I filename +] +.B \-find +.I [find expression] +.br +.SH DESCRIPTION +.B mkisofs +is effectively a pre-mastering program to generate an ISO-9660/JOLIET/HFS/UDF hybrid +filesystem. +.PP +ISO-9660/JOLIET/UDF filesystems are limited to a maximum size of 8\ TB. +The maximum size of a single file is 8\ TB (single files in UDF are currently +limited to aprox. 200\ GB). +If you like to have files +larger than 2 \GB, you need to specify +.B \-iso\-level 3 +or above. +If a HFS hybrid is created, the maximum +file size for files in the HFS hybrid is 2\ GB in any case. +.SS "Hybrid filesystem support +.PP +.B mkisofs +is capable of generating the +.B "System Use Sharing Protocol records (SUSP) +specified +by the +.B "Rock Ridge Interchange Protocol. +This is used to further describe the +files in the ISO-9660 filesystem to a UNIX host, and provides information such +as longer filenames, uid/gid, posix permissions, symbolic links, hard links, +block and character devices. +.PP +If Joliet, HFS or UDF hybrid command line options are specified, +.B mkisofs +will create additional separate filesystem meta data for Joliet, HFS or UDF. +The file content in this case refers to the same data blocks on the media. +It +will generate a pure ISO-9660 filesystem unless the Joliet, HFS or UDF hybrid command +line options are given. +.PP +.B mkisofs +can generate a +.I true +(or +.IR shared ) +HFS hybrid filesystem. The same files are seen as HFS files when +accessed from a Macintosh and as ISO-9660 files when accessed from other +machines. HFS stands for +.I Hierarchical File System +and is the native file system used on Macintosh computers up to Mac\ OS\ 9. +.PP +As an alternative, +.B mkisofs +can generate the +.I "Apple Extensions to ISO-9660 +or +.I UDF +for each file. These extensions provide each file with CREATOR, TYPE and +certain Finder Flags when accessed from a Macintosh. See the +.B HFS MACINTOSH FILE FORMATS +section below. +.SS "Functional description +.PP +.B mkisofs +takes a snapshot of a given directory tree, and generates a +binary image which will correspond to an ISO-9660 or Joliet/HFS/UDF filesystem when +written to a block device. +.PP +Each file written to the ISO-9660 filesystem must have a filename in the 8.3 +format (8 characters, period, 3 characters, all upper case), even if Rock Ridge +attributes are in use. This filename is used on systems that are not able to make use of +the Rock Ridge extensions (such as MS-DOS), and each filename in each directory +must be different from the other filenames in the same directory. +.B mkisofs +generally tries to form correct names by forcing the UNIX filename to upper +case and truncating as required, but often times this yields unsatisfactory +results when there are cases where the +truncated names are not all unique. +.B mkisofs +assigns weightings to each filename, and if two names that are otherwise the +same are found the name with the lower priority is renamed to have a 3 digit +number as an extension (where the number is guaranteed to be unique). An +example of this would be the files foo.bar and +foo.bar.~1~ - the file foo.bar.~1~ would be written as FOO000.BAR;1 and the file +foo.bar would be written as FOO.BAR;1 +.PP +When used with various HFS or UDF options, +.B mkisofs +will attempt to recognise files stored in a number of Apple/Unix file formats +and will copy the data and resource forks as well as any +relevant finder information. See the +.B HFS MACINTOSH FILE FORMATS +section below for more about formats +.B mkisofs +supports. +.PP +Note that +.B mkisofs +is not designed to communicate with writers for optical media directly. +Most writers +have proprietary command sets which vary from one manufacturer to +another, and you need a specialized tool like +.B cdrecord +to actually burn the disk. +.PP +The +.B cdrecord +utility is a utility capable of burning an actual disc. The latest version +of +.B cdrecord +is available from +.B https://sourceforge.net/projects/cdrtools/files/ +or +.B https://sourceforge.net/projects/cdrtools/files/alpha/ +.PP +Also you should know that most CD writers are very particular about timing. +Once you start to burn a disc, you cannot let their buffer empty before you +are done, or you will end up with a corrupt disc. Thus it is critical +that you be able to maintain an uninterrupted data stream to the writer +for the entire time that the disc is being written. +.SS "Dealing with path names +.PP +.B pathspec +is the path of the directory tree to be copied into the ISO-9660 filesystem. +Multiple paths can be specified, and +.B +mkisofs +will merge the files found in all of the specified path components to form the cdrom +image. +.PP +If the option +.B \-graft\-points +has been specified, +it is possible to graft the paths at points other than the root +directory, and it is possible to graft files or directories onto the +cdrom image with names different than what they have in the source filesystem. This is +easiest to illustrate with a couple of examples. Let's start by assuming that a local +file ../old.lis exists, and you wish to include it in the cdrom image. + + + foo/bar/=../old.lis + +will include the file old.lis in the cdrom image at /foo/bar/old.lis, while + + foo/bar/xxx=../old.lis + +will include the file old.lis in the cdrom image at /foo/bar/xxx. The +same sort of syntax can be used with directories as well. +.B mkisofs +will create any directories required such that the graft +points exist on the cdrom image - the directories do not need to +appear in one of the paths. By default, any directories that are created on +the fly like this will have permissions 0555 and appear to be owned by the +person running mkisofs. If you wish other permissions or owners of +the intermediate directories, see +.BR \-uid , +.BR \-gid , +.BR \-dir\-mode , +.BR \-file\-mode " and +.BR \-new\-dir\-mode . +.PP +.B mkisofs +will also run on Win9\fIx\fP/NT\fIx\fP machines when compiled with Cygnus' cygwin +(available from http://sourceware.cygnus.com/cygwin/). Therefore most +references in this man page to +.I Unix +also apply to +.I Win32 +or +.IR Win64 . + +.SH OPTIONS +.TP +.BI \-abstract " FILE +Specifies the abstract file name in the primary volume descriptor. +There is space on the disc for 37 characters of information. +The related Joliet entry is limited to 18 characters. +This parameter can also be set in the file +.B \&.m\&kisofsrc +with ABST=filename. +If specified in both places, the command line version is used. +.sp +It is up to the user of +.B mkisofs +to include a file with the apropriate name in the created filesystem tree. +.TP +.BI \-A " application_id +.TP +.BI \-appid " application_id +Specifies a text string that will be written into the volume header. +This should describe the application that will be on the disc. There +is space on the disc for 128 characters of information. +The related Joliet entry is limited to 64 characters. +This parameter can +also be set in the file +.B \&.m\&kisofsrc +with APPI=id. +If specified in both places, the command line version is used. +.TP +.B \-allow\-leading\-dots +.TP +.B \-ldots +Allow ISO-9660 filenames to begin with a period. Usually, a leading dot is +replaced with an underscore in order to maintain MS-DOS compatibility. +.br +This violates the ISO-9660 standard, but it happens to work on many systems. +Use with caution. +.TP +.B \-allow\-lowercase +This options allows lower case characters to appear in ISO-9660 filenames. +.br +This violates the ISO-9660 standard, but it happens to work on some systems. +Use with caution. +.TP +.B \-no\-allow\-lowercase +This resets the effect of +.B \-allow\-lowercase +and even works when +.BR \-U , +.B \-untranslated\-filenames +or +.B \-iso\-level 4 +have been used to allow lowercase filenames. +.TP +.B \-allow\-multidot +This options allows more than one dot to appear in ISO-9660 filenames. +A leading dot is not affected by this option, it +may be allowed separately using the +.B \-allow\-leading\-dots +option. +.br +This violates the ISO-9660 standard, but it happens to work on many systems. +Use with caution. +.TP +.BI \-biblio " FILE +Specifies the bibliographic file name in the primary volume descriptor. +There is space on the disc for 37 characters of information. +The related Joliet entry is limited to 18 characters. +This parameter can also be set in the file +.B \&.m\&kisofsrc +with BIBLO=filename. +If specified in both places, the command line version is used. +.sp +It is up to the user of +.B mkisofs +to include a file with the apropriate name in the created filesystem tree. +.TP +.B \-cache\-inodes +Cache inode and device numbers to find hard links to files. +If +.B mkisofs +finds a hard link (a file with multiple names), then the file will only +appear once on the CD. This helps to save space on the CD. +The option +.B \-cache\-inodes +is default on UNIX like operating systems. +Be careful when using this option on a filesystem without unique +inode numbers as it may result in files containing the wrong content on CD. +.sp +See the option +.B \-duplicates\-once +for a method that works on filesystems without unique inode numbers. +.sp +If inodes are not cached, +.B mkisofs +will revert to the old Rrip Version-1.10 (see +.BR \-rrip110 ) +and +.B mkisofs +will not be able to create +.B "correct inode numbers +for zero sized files. +.TP +.B \-no\-cache\-inodes +Do not cache inode and device numbers. +This option is needed whenever a filesystem does not have unique +inode numbers. It is the default on old +.B Cygwin +versions. +As the Microsoft operating system that runs below +.B Cygwin +uses 64 bit inode numbers for NTFS, it does not have unique inode numbers +in the 32 bit range. +Old Cygwin versions create fake 32-bit inode numbers from a hash algorithm +and thus create non-unique numbers. +If +.B mkisofs +would cache inodes on old Cygwin versions, it would believe that some files are +identical although they are not. The result in this case are files +that contain the wrong content if a significant amount of different +files (> ~5000) is in inside the tree that is to be archived. +This does not happen when the +.B \-no\-cache\-inodes +is used, but the disadvantage is that +.B mkisofs +cannot detect hardlinks anymore and the resulting CD image may be larger +than expected. +.sp +If inodes are not cached, +.B mkisofs +will revert to the old Rrip Version-1.10 (see +.BR \-rrip110 ) +and +.B mkisofs +will not be able to create +.B "correct inode numbers +for zero sized files. +.TP +.B \-duplicates\-once +Tells +.B mkisofs +to use a message digest checksum to identify identical files as +apparently hard linked files. +This allows +.B mkisofs +to archive inode numbers and hard links even when it is run on +non-POSIX platforms like +.BR DOS . +.TP +.BI \-b " eltorito_boot_image +.TP +.BI \-eltorito\-boot " eltorito_boot_image +Specifies the path and filename of the boot image to be used when making +an "El Torito" bootable CD. The pathname must be relative to the source +path and inside the source tree specified to +.B mkisofs. +This option is required to make an "El Torito" bootable CD. +The boot image must be exactly the size of either a 1200, 1440, or a 2880 +kB floppy, and +.B mkisofs +will use this size when creating the output ISO-9660 +filesystem. It is assumed that the first 512 byte sector should be read +from the boot image (it is essentially emulating a normal floppy drive). +This will work, for example, if the boot image is a boot floppy. +.sp +If the boot image is not an image of a floppy, you need to add one of the +options: +.BR \-hard\-disk\-boot " or " \-no\-emul\-boot . +If the system should not boot off the emulated disk, use +.BR \-no\-boot . +.sp +More than one boot entry may be specified, see +.B \-eltorito\-platform +and +.B \-eltorito\-alt\-boot +on how to specify more boot entries. +The first boot entry is the +.BR "default boot entry" . +Additional boot entries are members for a multi boot configuration. +.sp +If the +.B \-sort +option has not been specified, the boot images are sorted +with low priority (+2) to the beginning of the medium. +If you don't like this, you need to specify a sort weight of 0 for the boot images. +.TP +.B \-eltorito\-alt\-boot +Start with a new set of "El Torito" boot parameters. +This allows to have more than one El Torito boot entry on a CD. +A maximum of 63 El Torito boot entries may be put on a single CD. +.sp +The +.B \-eltorito\-alt\-boot +option starts a new boot entry with the same +.I platform id +but no new boot section except when it appears +past the first boot entry which is the default boot entry. +.TP +.BI \-eltorito\-platform " id +Set the "El Torito" platform id for a boot record or a section of boot records. +The. +.I id +parameter may be either: +.RS +.TP +.B x86 +This is the default +.I platform id +value and specifies entries for the PC platform. +If no +.B \-eltorito\-platform +option appears before the first +.B \-eltorito\-boot +option, the default boot entry becomes an entry for the x86 PC platform. +.TP +.B PPC +Boot entries for the Power PC platform. +.TP +.B Mac +Boot entries for the Apple Mac platform. +.TP +.B efi +Boot entries for EFI based PCs. +.TP +.B # +A numeric value specifying any platform id. +.LP +If the option +.B \-eltorito\-platform +appears before the first +.B \-eltorito\-boot +option, it sets the +.I platform id +for the default boot entry. +.LP +If the option +.B \-eltorito\-platform +appears after an +.B \-eltorito\-boot +option and sets the +.I platform id +to a value different from the previous value, +it starts a new set of boot entries. +.LP +The second boot entry and any new +.I platform id +creates a new section header and reduces the number of boot +entries per CD by one. + +.RE +.TP +.BI errctl= " name +.TP +.BI errctl= " error control spec +Add the content from file +.I name +to the error control definitions or add +.I error control spec +to the error control definitions. +More than one error control file and more than one +.I error control spec +as well as a mixture of both forms is possible. +.sp +The reason for using error control is to make +.B mkisofs +quiet about error conditions that are known to be irrelevant on the quality +of the created filesystem or to tell +.B mkisofs +to abort on certain error conditions instead of trying to continue +with the filesystem. +.sp +.ne 6 +A typical reason to use error control is to +suppress warnings about growing log files while doing a backup on a +live file system. +Another typical reason to use error control is to tell +.B mkisofs +to abort if e.g. a file could not be archived instead of continuing +to archive other files from a list. +.sp +The error control file contains a set of lines, each starting with a list +of error conditions to be ignored followed by white space followed by a +file name pattern (see +.BR match (1) +or +.BR patmatch (3) +for more information). +The +.I error control spec +uses the same syntax as a single line from the error control file. +If the file name pattern needs to start with white space, use a backslash +to escape the start of the file name. It is not possible to have new line +characters in the file name pattern. +Whenever an error situation is encountered, +.B mkisofs +checks the lines in the error control file starting from the top. +If the current error condition is listed on a line in the error control file, +then +.B mkisofs +checks whether the pattern on the rest of the line matches the current file name. +If this is the case, +.B mkisofs +uses the current error control specification to +control the current error condition. +.sp +The list of error conditions to be handled may use one or more (in this case +separated by a '|' character) identifiers from the list below: +.RS +.TP 12 +.B ABORT +If this meta condition is included in an error condition, +.B mkisofs +aborts (exits) as soon as possible after this error condition has been +seen instead of making +.B mkisofs +quiet about the condition. +This error condition flag may only be used together with at another +error condition or a list of error conditions +(separated by a '|' character). +.TP 12 +.B WARN +If this meta condition is included in an error condition, +.B mkisofs +prints the warning about the error condition but the error condition +does not affect the exit code of +.B mkisofs +and the error statistics (which is printed to the end) does not +include the related errors. +This error condition flag may only be used together with at another +error condition or a list of error conditions +(separated by a '|' character). +The +.B WARN +meta condition has a lower precedence than +.BR ABORT . +.TP 12 +.B ALL +This is a shortcut for all error conditions below. +.TP 12 +.B STAT +Suppress warnings that +.B mkisofs +could not +.BR stat (2) +a file. +.TP +.B GETACL +Suppress warnings about files on which +.B mkisofs +had problems to retrieve the ACL information. +.TP +.B OPEN +Suppress warnings about files that could not be opened. +.TP +.B READ +Suppress warnings read errors on files. +.TP +.B WRITE +Suppress warnings write errors on files. +.TP +.B READLINK +Suppress warnings +.BR readlink (2) +errors on symbolic links. +.TP +.B GROW +Suppress warnings about files that did grow while they have been +archived. +.TP +.B SHRINK +Suppress warnings about files that did shrink while they have been +archived. +.TP +.B MISSLINK +Suppress warnings about files for which +.B mkisofs +was unable to archive all hard links. +.TP +.B NAMETOOLONG +Suppress warnings about files that could not be archived because the name of +the file is too long for the archive format. +.TP +.B FILETOOBIG +Suppress warnings about files that could not be archived because the size of +the file is too big for the archive format. +.TP +.B SPECIALFILE +Suppress warnings about files that could not be archived because the file type +is not supported by the archive format. +.TP +.B GETXATTR +Suppress warnings about files on that +.B mkisofs +could not retrieve the extended file attribute information. +.TP +.B SETTIME +Suppress warnings about files on that +.B mkisofs +could not set the time information during extraction. +.TP +.B SETMODE +Suppress warnings about files on that +.B mkisofs +could not set the access modes during extraction. +.TP +.B SECURITY +Suppress warnings about files that +have been skipped on extraction because they have been considered to be a +security risk. +This currently applies to all files that have a '/../' sequence inside +when +.B \-.. +has not been specified. +.TP +.B LSECURITY +Suppress warnings about links that +have been skipped on extraction because they have been considered to be a +security risk. +This currently applies to all link names that start with '/' or +have a '/../' sequence inside when +.B \-secure\-links +has been specified. +In this case, +.B mkisofs +tries to match the link name against the pattern in the error control file. +.TP +.B SAMEFILE +Suppress warnings about links that +have been skipped on extraction because source and target of the link +are pointing to the same file. +If +.B mkisofs +would not skip these files, it would end up with removing the file completely. +In this case, +.B mkisofs +tries to match the link name against the pattern in the error control file. +.TP +.B BADACL +Suppress warnings access control list conversion problems. +.TP +.B SETACL +Suppress warnings about files on that +.B mkisofs +could not set the ACL information during extraction. +.TP +.B SETXATTR +Suppress warnings about files on that +.B mkisofs +could not set the extended file attribute information during extraction. +.RE +.sp +If a specific error condition is ignored, then the error condition is not +only handled in a silent way but also excluded from the error statistics +that are printed at the end of the +.B mkisofs +run. +.sp +Be very careful when using error control as you may ignore any error condition. +If you ignore the wrong error conditions, you may not be able to see real +problems anymore. +.sp +Note that currently only the tags +.BR OPEN , +.BR READ , +.BR GROW , +.BR SHRINK , +are checked from +.BR mkisofs . + +.TP +.BI \-B " img_sun4,img_sun4c,img_sun4m,img_sun4d,img_sun4e +.TP +.BI \-sparc\-boot " img_sun4,img_sun4c,img_sun4m,img_sun4d,img_sun4e +Specifies a comma separated list of boot images that are needed to make +a bootable CD for sparc systems. +Partition 0 is used for the ISO-9660 image, the first image file is mapped +to partition 1. +There may be empty fields in the comma separated list. +The maximum number of possible partitions is 8 so it is impossible to specify +more than 7 partition images. +This option is required to make a bootable CD for Sun sparc systems. +If the +.B \-B +or +.B \-sparc\-boot +option has been specified, the first sector of the resulting image will +contain a Sun disk label. This disk label specifies slice 0 for the +ISO-9660 image and slice 1 .\|.\|. slice 7 for the boot images that +have been specified with this option. Byte offset 512 .\|.\|. 8191 +within each of the additional boot images must contain a primary boot +that works for the appropriate sparc architecture. The rest of each +of the images usually contains an ufs filesystem that is used primary +kernel boot stage. +.sp +The implemented boot method is the boot method found with SunOS 4.x and SunOS 5.x. +However, it does not depend on SunOS internals but only on properties of +the Open Boot prom. For this reason, it should be usable for any OS +that boots off a sparc system. +.sp +For more information also see the +.B NOTES +section below. +.sp +If the special filename +.B "..." +is used, the actual and all following boot partitions are mapped to the +previous partition. If +.B mkisofs +is called with +.BI "\-G " image " \-B " ... +all boot partitions are mapped to the partition that contains the ISO-9660 +filesystem image and the generic boot image that is located in the first +16 sectors of the disk is used for all architectures. +.TP +.BI \-G " generic_boot_image +Specifies the path and filename of the generic boot image to be used when making +a generic bootable CD. +The +.B generic_boot_image +will be placed on the first 16 sectors of the CD. The first 16 sectors +are the sectors that are located before the ISO-9660 primary volume descriptor. +If this option is used together with the +.B \-sparc\-boot +option, the Sun disk label will overlay the first 512 bytes of the generic +boot image. +.TP +.BI \-hard\-disk\-boot +Specifies that the boot image used to create "El Torito" bootable CDs is +a hard disk image. The hard disk image must begin with a master boot +record that contains a single partition. +.TP +.BI \-ignore\-error +Ignore errors. +.B mkisofs +by default aborts on several errors, such as read errors. With this option in effect, +.B mkisofs +tries to continue. +Use with care. +.TP +.BI \-no\-emul\-boot +Specifies that the boot image used to create "El Torito" bootable CDs is +a 'no emulation' image. The system will load and execute this image without +performing any disk emulation. +.TP +.BI \-no\-boot +Specifies that the created "El Torito" CD should be marked as not bootable. The +system will provide an emulated drive for the image, but will boot off +a standard boot device. +.TP +.BI \-boot\-load\-seg " segment_address +Specifies the load segment address of the boot image for no-emulation +"El Torito" CDs. +.TP +.BI \-boot\-load\-size " load_sectors +Specifies the number of "virtual" (512-byte) sectors to load in +no-emulation mode. The default is to load the entire boot file. Some +BIOSes may have problems if this is not a multiple of 4. +.TP +.BI \-boot\-info\-table +Specifies that a 56-byte table with information of the CD-ROM layout +will be patched in at offset 8 in the boot file. If this option is +given, the boot file is modified in the source filesystem, so make +sure to make a copy if this file cannot be easily regenerated! See +the +.B "EL TORITO BOOT INFO TABLE +section for a description of this table. +.TP +.BI \-C " last_sess_start,next_sess_start +.TP +.BI \-cdrecord\-params " last_sess_start,next_sess_start +This option is needed when +.B mkisofs +is used to create a CDextra or the image of a second session or a +higher level session for a multi session disk. +The option +.B \-C +takes a pair of two numbers separated by a comma. The first number is the +sector number of the first sector in the last session of the disk +that should be appended to. +The second number is the starting sector number of the new session. +The expected pair of numbers may be retrieved by calling +.B "cdrecord \-msinfo ... +If the +.B \-C +option is used in conjunction with the +.B \-M +option, +.B mkisofs +will create a filesystem image that is intended to be a continuation +of the previous session. +If the +.B \-C +option is used without the +.B \-M +option, +.B mkisofs +will create a filesystem image that is intended to be used for a second +session on a CDextra. This is a multi session CD that holds audio data +in the first session and a ISO-9660 filesystem in the second session. +.TP +.BI \-c " boot_catalog +.TP +.BI \-eltorito\-catalog " boot_catalog +Specifies the path and filename of the boot catalog to be used when making +an "El Torito" bootable CD. The pathname must be relative to the source +path specified to +.B mkisofs. +This option is required to make a bootable CD. +This file will be inserted into the output tree and not created +in the source filesystem, so be +sure the specified filename does not conflict with an existing file, as +it will be excluded. Usually a name like "boot.catalog" is +chosen. +.sp +If the +.B \-sort +option has not been specified, the boot catalog sorted +with low priority (+1) to the beginning of the medium. +If you don't like this, you need to specify a sort weight of 0 for the boot catalog. +.TP +.B \-check\-oldnames +Check all filenames imported from old session for compliance with +actual +.B mkisofs +ISO-9660 file naming rules. +It his option is not present, only names with a length > 31 are checked +as these files are a hard violation of the ISO-9660 standard. +.TP +.BI \-check\-session " FILE +Check all old sessions for compliance with +actual +.B mkisofs +ISO-9660 file naming rules. +This is a high level option that is a combination of the options: +.BI \-M " FILE " "\-C 0,0 \-check\-oldnames +For the parameter +.I FILE +see description of +.B \-M +option. +.TP +.BI \-copyright " FILE +Specifies the Copyright file name in the primary volume descriptor. +There is space on the disc for 37 characters of information. +The related Joliet entry is limited to 18 characters. +This parameter can also be set in the file +.B \&.m\&kisofsrc +with COPY=filename. +If specified in both places, the command line version is used. +.sp +It is up to the user of +.B mkisofs +to include a file with the apropriate name in the created filesystem tree. +.TP +.B \-d +.TP +.B \-omit\-period +Omit trailing period from files that do not have a period. +.br +This violates the ISO-9660 standard, but it happens to work on many systems. +Use with caution. +.TP +.B \-D +.TP +.B \-disable\-deep\-relocation +Do not use +.B Rock Ridge +deep directory relocation, and instead just pack directories in the +way they are in the master directory tree. +.sp +This option was needed with old +.B mkisofs +versions to avoid a visible directory +.BR rr_moved . +Since August 2006, +.B mkisofs +correctly hides the +.B rr_moved +directory from the +.B Rock Ridge +filesystem. +.sp +If ISO-9660:1999 has not been selected, +this violates the ISO-9660 standard, but it happens to work on many systems. +Use with caution. +.TP +.B \-data\-change\-warn +If the size of a file changes while the file is being archived, treat this +condition as a warning only that does not cause +.B mkisofs +to abort. +A warning message is still written if the condition is not otherwise +ignored by another rule from an +.B errctl= +option. +The +.B \-data\-change\-warn +option works as if the last error control option was +.sp + \fBerrctl=\fP\fI"WARN|GROW|SHRINK *"\fP +.sp +.TP +.B \-debug +Increment debug value by one. +.TP +.BI \-dir\-mode " mode +Overrides the mode of directories used to create the image to +.IR mode . +See +.B \-new\-dir\-mode +on how to specify a different +.I mode +that is used for directories that do not exist +in the tree specified by the source-path. +Specifying the +.B \-dir\-mode +option automatically enables Rock Ridge extensions. +.br +.ne 4 +.TP +.B \-dvd\-audio +Generate DVD-Audio compliant UDF file system. This is done by sorting the +order of the content of the appropriate files. +.\" Audio is currently not sorted +.\" and by adding padding between the files if needed. +Sorting only works if the DVD-Audio filenames include upper case +characters only. +.sp +Note that in order to get a DVD-Audio compliant filesystem image, you need +to prepare a DVD-Audio compliant directory tree. This means you need to +have a directory AUDIO_TS (all caps) in the root directory of the resulting DVD +and you should have a directory VIDEO_TS. The directory AUDIO_TS needs to +include all needed files (file names must be all caps) for a compliant DVD-Audio +filesystem. +.TP +.B \-dvd\-hybrid +Equivalent to selecting both -dvd-audio and -dvd-video +.TP +.B \-dvd\-video +Generate DVD-Video compliant UDF file system. This is done by sorting the +order of the content of the appropriate files and by adding padding +between the files if needed. +Sorting only works if the DVD-Video filenames include upper case +characters only. +.sp +Note that in order to get a DVD-Video compliant filesystem image, you need +to prepare a DVD-Video compliant directory tree. This means you need to +have a directory VIDEO_TS (all caps) in the root directory of the resulting DVD +and you should have a directory AUDIO_TS. The directory VIDEO_TS needs to +include all needed files (file names must be all caps) for a compliant DVD-Video +filesystem. +.TP +.B \-f +.TP +.B \-follow\-links +Follow all symbolic links when generating the filesystem. When this option is not +in use, symbolic links will be entered using Rock Ridge if enabled, otherwise +the file will be ignored. +.sp +See also +.B \-posix\-L +option. +.TP +.BI \-file\-mode " mode +Overrides the mode of regular files used to create the image to +.IR mode . +Specifying this option automatically enables Rock Ridge extensions. +.TP +.B \-find +This option acts a separator. +If it is used, all +.B mkisofs +options must be to the left of the +.B \-find +option. To the right of the +.B \-find +option, +.B mkisofs +accepts the +.B find +command line syntax only. +.sp +The +.B find +expression acts as a filter between the source of file names and the +consumer, which is archiving engine. +If the +.B find +expression evaluated as TRUE, then the related file is selected for +processing, otherwise it is omited. +.sp +In order to make the evaluation of the +.B find +expression more convenient, +.B mkisofs +implements additional +.B "find primaries +that have side effects on the file meta data. +.B Mkisofs +implements the following additional +.B find +primaries: +.RS +.TP +.B \-help +Lists the available +.BR find (1) +syntax. +.TP +.BI \-chgrp " gname +The primary always evaluates as true; +it sets the group of the file to +.IR gname . +.TP +.BI \-chmod " mode +The primary always evaluates as true; +it sets the permissions of the file to +.IR mode . +Octal and symbolic permissions are accepted for +.I mode +as with +.BR chmod (1). +.TP +.BI \-chown " uname +The primary always evaluates as true; +it sets the owner of the file to +.IR uname . +.TP +.B \-false +The primary always evaluates as false; +it allows to make the result of the full expression different from +the result of a part of the expression. +.TP +.B \-true +The primary always evaluates as true; +it allows to make the result of the full expression different from +the result of a part of the expression. +.PP +The command line: +.PP +.B "mkisofs -o o.iso -find . ( -type d -ls -o false ) -o ! -type d +.PP +lists all directories and puts all non-directories to the image +.BR o.iso . +.PP +The command line: +.PP +.B "mkisofs -o o.iso -find . ( -type d -chown root -o true ) +.PP +archives all directories so they appear to be owned by root in the archive, +all non-directories are archived as they are in the file system. +.PP +Note that the +.BR \-ls , +.B \-exec +and the +.B \-ok +primary cannot be used if +.B stdin +or +stdout +has not been redirected. +.RE +.TP +.BI \-gid " gid +Overrides the gid read from the source files to the value of +.IR gid . +Specifying this option automatically enables Rock Ridge extensions. +.TP +.B \-gui +Switch the behaviour for a GUI. This currently makes the output more verbose +but may have other effects in future. +.TP +.B \-graft\-points +Allow to use graft points for filenames. If this option is used, all filenames +are checked for graft points. The filename is divided at the first unescaped +equal sign. All occurrences of '\e\e' and '=' characters must be escaped with '\e\e' +if +.I \-graft\-points +has been specified. +.TP +.BI \-hide " glob +Hide +.I glob +from being seen on the ISO-9660 or Rock Ridge directory. +.I glob +is a shell wild-card-style pattern that must match any part of the filename +or path. +Multiple globs may be hidden. +If +.I glob +matches a directory, then the contents of that directory will be hidden. +In order to match a directory name, make sure the pathname does not include +a trailing '/' character. +All the hidden files will still be written to the output CD image file. +Should be used with the +.B \-hide\-joliet +option. See README.hide for more details. +.TP +.BI \-hide\-list " file +A file containing a list of +.I globs +to be hidden as above. +.TP +.BI \-hidden " glob +Add the hidden (existence) ISO-9660 directory attribute for +.IR glob . +This attribute will prevent +.I glob +from being listed on DOS based systems if the /A flag is not used for the listing. +.I glob +is a shell wild-card-style pattern that must match any part of the filename +or path. +In order to match a directory name, make sure the pathname does not include +a trailing '/' character. +Multiple globs may be hidden. +.TP +.BI \-hidden\-list " file +A file containing a list of +.I globs +to get the hidden attribute as above. +.TP +.BI \-hide\-joliet " glob +Hide +.I glob +from being seen on the Joliet directory. +.I glob +is a shell wild-card-style pattern that must match any part of the filename +or path. +Multiple globs may be hidden. +If +.I glob +matches a directory, then the contents of that directory will be hidden. +In order to match a directory name, make sure the pathname does not include +a trailing '/' character. +All the hidden files will still be written to the output CD image file. +Should be used with the +.B \-hide +option. See README.hide for more details. +.TP +.BI \-hide\-joliet\-list " file +A file containing a list of +.I globs +to be hidden as above. +.TP +.B \-hide\-joliet\-trans\-tbl +Hide the +.B TRANS.TBL +files from the Joliet tree. +These files usually don't make sense in the Joliet World as they list +the real name and the ISO-9660 name which may both be different from the +Joliet name. +.TP +.B \-hide\-rr\-moved +Rename the directory +.B RR_MOVED +to +.B .rr_moved +in the Rock Ridge tree. +This option has been introduced when +.B mkisofs +was not able to hide the directory in the Rock Ridge tree. +This version of +.B mkisofs +always automatically hides the +.B RR_MOVED +directory in the Rock Ridge tree. +If you need to have no +.B RR_MOVED +directory at all (even in the ISO-9660 tree), you should use the +.B \-D +option. Note that in case that the +.B \-D +option has been specified, the resulting filesystem is not ISO-9660 +level-1 compliant and will not be readable on MS-DOS. +See also +.B NOTES +section for more information on the +.B RR_MOVED +directory. + +.TP +.BI \-hide\-udf " glob +Hide +.I glob +from being seen on the UDF directory. +.I glob +is a shell wild-card-style pattern that must match any part of the filename +or path. +Multiple globs may be hidden. +If +.I glob +matches a directory, then the contents of that directory will be hidden. +In order to match a directory name, make sure the pathname does not include +a trailing '/' character. +All the hidden files will still be written to the output CD image file. +Should be used with the +.B \-hide +option. See README.hide for more details. +.TP +.BI \-hide\-udf\-list " file +A file containing a list of +.I globs +to be hidden as above. + +.PD 0 +.TP +.B \-hide\-ignorecase +.TP +.B \-exclude\-ignorecase +.PD +Ignore the case of the filenames with the +.B \-hide* +options +and with the +.B \-exclude\-list +option. + +.TP +.BI \-input\-charset " charset +Set up the input charset that defines the characters used in local file names. +To get a list of valid charset names, call +.B "mkisofs \-input\-charset help. +To get a 1:1 mapping, you may use +.B default +as charset name. If the input charset has not been set up from the +locale in the environment, the default initial values are +.I cp437 +on DOS based systems and +.I iso8859-1 +on all other systems. +See +.B "CHARACTER SETS +section below for more details. +.sp +If +.B \-input\-charset +has not been specified, it will be set up from the locale in the +environment. If you like to disable this automatic setup, use +the empty string as locale name. +.TP +.BI \-output\-charset " charset +Set up the output charset that defines the characters that will be used in Rock Ridge +file names. Defaults to the input charset. See +.B "CHARACTER SETS +section below for more details. +.TP +.BI \-iso\-level " level +Set the ISO-9660 conformance level. Valid numbers are 1..3 and 4. +.sp +With level 1, files may only consist of one section and filenames are +restricted to 8.3 characters. +.sp +With level 2, files may only consist of one section. +.sp +With level 3, no restrictions (other than ISO-9660:1988) do apply. +Starting with this level, mkisofs also allows files to be larger than 4 GB +by implementing ISO-9660 multi-extent files. +.sp +With all ISO-9660 levels from 1..3, all filenames are restricted to upper +case letters, numbers and the underscore (_). The maximum filename +length is restricted to 31 characters, the directory nesting level +is restricted to 8 and the maximum path length is limited to 255 characters. +.sp +Level 4 officially does not exists but +.B mkisofs +maps it to ISO-9660:1999 which is ISO-9660 version 2. +.sp +With level 4, an enhanced volume descriptor with version number +and file structure version number set to 2 is emitted. +There may be more than 8 levels of directory nesting, +there is no need for a file to contain a dot and the dot has no +more special meaning, +file names do not have version numbers, +.\" (f XXX ??? The character used for filling byte positions which are +.\" specified to be characters is subject to agreement between the +.\" originator and the recipient of the volume), +the maximum length for files and directory is raised to 207. +If Rock Ridge is used, the maximum ISO-9660 name length is reduced to 197. +.sp +When creating Version 2 images, +.B mkisofs +emits an enhanced volume descriptor which looks similar to a primary volume +descriptor but is slightly different. Be careful not to use broken software +to make ISO-9660 images bootable by assuming a second PVD copy and patching +this putative PVD copy into an El Torito VD. +.TP +.B \-J +Generate Joliet directory records in addition to regular ISO-9660 file +names. This is primarily useful when the discs are to be used on Windows-NT +or Windows-95 machines. The Joliet filenames are specified in Unicode and +each path component can be up to 64 Unicode characters long. +Note that Joliet is no standard - CD's that use only Joliet extensions but no +standard Rock Ridge extensions may usually only be used on Microsoft Win32 +systems. Furthermore, the fact that the filenames are limited to 64 characters +and the fact that Joliet uses the UTF-16 coding for Unicode characters causes +interoperability problems. +.TP +.B \-joliet\-long +Allow Joliet filenames to be up to 103 Unicode characters. This breaks the +Joliet specification - but appears to work. Use with caution. The number +103 is derived from: the maximum Directory Record Length (254), minus the +length of Directory Record (33), minus CD-ROM XA System Use Extension +Information (14), divided by the UTF-16 character size (2). +.TP +.BI \-jcharset " charset +Same as using +.B \-input\-charset +.I charset +and +.B \-J +options. See +.B "CHARACTER SETS +section below for more details. +.TP +.B \-l +.TP +.B \-full\-iso9660\-filenames +Allow full 31 character filenames. Normally the ISO-9660 filename will be in an +8.3 format which is compatible with MS-DOS, even though the ISO-9660 standard +allows filenames of up to 31 characters. If you use this option, the disc may +be difficult to use on a MS-DOS system, but this comes in handy on some other +systems (such as the Amiga). +Use with caution. +.TP +.B \-L +Outdated option reserved by POSIX.1-2001, use +.B \-allow\-leading\-dots +instead. +This option will get POSIX.1-2001 semantics with mkisofs-3.02. +.TP +.BI \-log\-file " log_file +Redirect all error, warning and informational messages to +.I log_file +instead of the standard error. +.TP +.B \-long\-rr\-time +Use the long ISO-9660 time format for the file time stamps used in Rock Ridge. +This time format allows to represent year 0 .. year 9999 with a granularity of 10ms. +.sp +The short ISO-9660 time format only allows to represent year 1900 .. year 2155 +with a granularity of 1s. +.TP +.BI \-m " glob +Exclude +.I glob +from being written to CDROM. +.I glob +is a shell wild-card-style pattern that must match part of the filename (not +the path as with option +.BR \-x ). +Technically +.I glob +is matched against the +.I d->d_name +part of the directory entry. +Multiple globs may be excluded. +Example: + +mkisofs \-o rom \-m '*.o' \-m core \-m foobar + +would exclude all files ending in ".o", called "core" or "foobar" to be +copied to CDROM. Note that if you had a directory called "foobar" it too (and +of course all its descendants) would be excluded. +.sp +NOTE: The +.B \-m +and +.B \-x +option description should both be updated, they are wrong. +Both now work identical and use filename globbing. A file is excluded if either +the last component matches or the whole path matches. +.TP +.BI \-exclude\-list " file +A file containing a list of +.I globs +to be excluded as above. +.TP +.B \-max\-iso9660\-filenames +Allow 37 chars in ISO-9660 filenames. +This option forces the +.B \-N +option as the extra name space is taken from the space reserved for +ISO-9660 version numbers. +.br +This violates the ISO-9660 standard, but it happens to work on many systems. +Although a conforming application needs to provide a buffer space of at +least 37 characters, disks created with this option may cause a buffer +overflow in the reading operating system. Use with extreme care. +.TP +.BI \-M " path +or +.TP +.BI \-M " device +or +.TP +.BI \-dev " device +Specifies path to existing ISO-9660 image to be merged. The alternate form +takes a SCSI device specifier that uses the same syntax as the +.B "dev= +parameter of +.B cdrecord. +The output of +.B mkisofs +will be a new session which should get written to the end of the +image specified in \-M. Typically this requires multi-session capability +for the recorder and cdrom drive that you are attempting to write this +image to. +This option may only be used in conjunction with the +.B \-C +option. +.TP +.BI \-modification\-date " date-spec +Set the +.B modification date +in the primary volume descriptor (PVD) to a value different from the current +time. +This allows e.g. to set up an intentional UUID for +.BR grub . +.sp +.ne 3 +The format of +.I date-spec +is: +.sp +.nf + \fIyyyy\fR[\fImm\fR[\fIdd\fR[\fIhh\fR[\fImm\fR[\fIss\fR]\|]\|]\|]\|][.\fIhh\fR][+-\fIghgm\fR] +.fi +.sp +The fields are +.BR year , +.BR month , +.BR "day of month" , +.BR hour , +.BR minute , +.BR second , +.BR "hundreds of a second" , +.BR "GMT offset in hours and minutes" . +The time is interpreted as local time. +.sp +Year and the GMT offset are four digit fields, all other fields take two digits. +The GMT offset may be between -12 and +13 hours in 15 minute steps. Locations +east to Greenwich have positive values. The value is the sum of the time zone offset +and the effects from daylight saving time. +Omited values are replaced by the minimal possible values. +If the GMT offset is omited, it is computed from the local time value that has been +supplied. +.sp +Between year and month as well as between month and day of month, a separator chosen +from '/' and '-' may appear. In this case, the year may be a two digit number with +values 69..99 representing 1969..1999 and values 00..68 representing 2000..2068. +Between date and time spec, an optional space is permitted. Between hours and minutes +as well as between minutes and seconds, an optional ':' separator is permitted. +This allows +.B mkisofs +to parse the popular POSIX date format created by: +.sp +.nf + \fBdate "+%Y-%m-%d %H:%M:%S %z"\fR +.fi +.sp +Note that the possible range for +.I date-spec +for 32 bit programs is limited to values up to 2038 Jan 19 04:14:07 GMT. +.TP +.B \-N +.TP +.B \-omit\-version\-number +Omit version numbers from ISO-9660 file names. +.br +This violates the ISO-9660 standard, but no one really uses the +version numbers anyway. +Use with caution. +.TP +.BI \-new\-dir\-mode " mode +Mode to use when creating new directories in the iso fs image. The default +mode in the absence of a +.B \-dir\-mode +option is 0555. +.TP +.B \-nobak +.TP +.B \-no\-bak +Do not include backup files files on the ISO-9660 filesystem. +If the +.B \-no\-bak +option is specified, files that contain the characters '~' or '#' +or end in '.bak' will not be included (these are typically backup files +for editors under UNIX). +.TP +.B \-no\-limit\-pathtables +A ISO-9660 filesystem contains path tables that contain a list of directories. +This list may contain many directories but only 65535 of them may be parent +directories. +When +.B \-no\-limit\-pathtables +is in use, further parent directories will be folded to the root directory +and the resulting filesystem will no longer be usable on +.BR DOS . +.TP +.B \-no\-long\-rr\-time +Use the short ISO-9660 time format for the file time stamps used in Rock Ridge. +This time format allows to represent year 1990 .. year 2155 with a granularity of one second. +.TP +.B \-force\-rr +Do not use the automatic Rock Ridge attributes recognition for previous sessions. +This helps to show rotten ISO-9660 extension records as e.g. created by NERO burning ROM. +.TP +.B \-no\-rr +Do not use the Rock Ridge attributes from previous sessions. +This may help to avoid getting into trouble when +.B mkisofs +finds illegal Rock Ridge signatures on an old session. +.TP +.B \-no\-split\-symlink\-components +Don't split the SL components, but begin a new Continuation Area (CE) +instead. This may waste some space, but the SunOS 4.1.4 cdrom driver +has a bug in reading split SL components (link_size = component_size +instead of link_size += component_size). +.sp +Note that this option has been introduced by Eric Youngdale in 1997. +It is questionable whether it makes sense at all. +When it has been introduced, +.B mkisofs +did have a serious bug that did create defective CE signatures if +a symlink contained `/../'. +This CE signature bug in +.B mkisofs +has been fixed in May 2003. +.TP +.B \-no\-split\-symlink\-fields +Don't split the SL fields, but begin a new Continuation Area (CE) +instead. This may waste some space, but the SunOS 4.1.4 and +Solaris 2.5.1 cdrom driver have a bug in reading split SL fields +(a `/' can be dropped). +.sp +Note that this option has been introduced by Eric Youngdale in 1997. +It is questionable whether it makes sense at all. +When it has been introduced, +.B mkisofs +did have a serious bug that did create defective CE signatures if +a symlink contained `/../'. +This CE signature bug in +.B mkisofs +has been fixed in May 2003. +.TP +.BI \-o " filename +is the name of the file to which the ISO-9660 filesystem image should be +written. This can be a disk file, a tape drive, or it can correspond directly +to the device name of the optical disc writer. If not specified, stdout is +used. Note that the output can also be a block special device for a regular +disk drive, in which case the disk partition can be mounted and examined to +ensure that the premastering was done correctly. +.TP +.B \-pad +Pad the end of the whole image by 150 sectors (300 kB). +If the option +.B \-B +is used, then there is a padding at the end of the ISO-9660 partition +and before the beginning of the boot partitions. +The size of this padding is chosen to make the first boot partition start +on a sector number that is a multiple of 16. +.sp +The padding is needed as many operating systems (e.g. Linux) +implement read ahead bugs in their filesystem I/O. These bugs result in read +errors on one or more files that are located at the end of a track. They are +usually present when the CD is written in Track at Once mode or when +the disk is written as mixed mode CD where an audio track follows the +data track. +.sp +To avoid problems with I/O error on the last file on the filesystem, +the +.B \-pad +option has been made the default. +.TP +.B \-no\-pad +Do not Pad the end by 150 sectors (300 kB) and do not make the the boot partitions +start on a multiple of 16 sectors. +.TP +.BI \-path\-list " file +A file containing a list of +.I pathspec +directories and filenames to be added to the ISO-9660 filesystem. This list +of pathspecs are processed after any that appear on the command line. If the +argument is +.IR \- , +then the list is read from the standard input. +.TP +.B \-P +Outdated option reserved by POSIX.1-2001, use +.B \-publisher +instead. +This option will get POSIX.1-2001 semantics with mkisofs-3.02. +.TP +.BI \-publisher " publisher_id +Specifies a text string that will be written into the volume header. +This should describe the publisher of the CDROM, usually with a +mailing address and phone number. There is space on the disc for 128 +characters of information. +The related Joliet entry is limited to 64 characters. +This parameter can also be set in the file +.B \&.m\&kisofsrc +with PUBL=. +If specified in both places, the command line version is used. +.TP +.BI \-p " preparer_id +.TP +.BI \-preparer " preparer_id +Specifies a text string that will be written into the volume header. +This should describe the preparer of the CDROM, usually with a mailing +address and phone number. There is space on the disc for 128 +characters of information. +The related Joliet entry is limited to 64 characters. +This parameter can also be set in the file +.B \&.m\&kisofsrc +with PREP=. +If specified in both places, the command line version is used. +.TP +.B \-posix\-H +Follow all symbolic links encountered on command line when generating the filesystem. +.TP +.B \-posix\-L +Follow all symbolic links when generating the filesystem. +When this option is not in use, symbolic links will be entered using +Rock Ridge if enabled, otherwise the file will be ignored. +.TP +.B \-posix\-P +Do not follow symbolic links when generating the filesystem (this is the default). +If +.B \-posix\-P +is specified after +.B \-posix\-H +or +.BR \-posix\-L , +the effect of these options will be reset. +.TP +.B \-print\-size +Print estimated filesystem size in multiples of the sector size (2048 bytes) +and exit. This option is needed for +Disk At Once mode and with some CD-R drives when piping directly into +.B cdrecord. +In this case it is needed to know the size of the filesystem before the +actual CD-creation is done. +The option \-print\-size allows to get this size from a "dry-run" before +the CD is actually written. +Old versions of +.B mkisofs +did write this information (among other information) to +.IR stderr . +As this turns out to be hard to parse, the number without any other information +is now printed on +.B stdout +too. +If you like to write a simple shell script, redirect +.B stderr +and catch the number from +.BR stdout . +This may be done with: +.sp +.B "cdblocks=` mkisofs \-print\-size \-quiet .\|.\|. ` +.sp +.B "mkisofs .\|.\|. | cdrecord .\|.\|. tsize=${cdblocks}s -" +.TP +.B \-quiet +This makes +.B mkisofs +even less verbose. No progress output will be provided. +.TP +.B \-R +.TP +.B \-rock +Generate SUSP and RR records using the Rock Ridge protocol to further describe +the files on the ISO-9660 filesystem. +The Rock Ridge protocol is needed in order to add POSIX like file meta data +like permissions, extended time stamps, user/group is'd, link counts, inode numbers +and symbolic links. The Rock Ridge protocol allows to archive hierarchy trees +with unlimited depth. +.TP +.B \-r +.TP +.B \-rational\-rock +This is like the \-R option, but file ownership and modes are set to +more useful values. The uid and gid are set to zero, because they are +usually only useful on the author's system, and not useful to the +client. All the file read bits are set true, so that files and +directories are globally readable on the client. If any execute bit is +set for a file, set all of the execute bits, so that executables are +globally executable on the client. If any search bit is set for a +directory, set all of the search bits, so that directories are globally +searchable on the client. All write bits are cleared, because the +CD-Rom will be mounted read-only in any case. If any of the special +mode bits are set, clear them, because file locks are not useful on a +read-only file system, and set-id bits are not desirable for uid 0 or +gid 0. +When used on Win32, the execute bit is set on +.I all +files. This is a result of the lack of file permissions on Win32 and the +Cygwin POSIX emulation layer. See also \-uid \-gid, \-dir\-mode, \-file\-mode +and \-new\-dir\-mode. +.TP +.B \-relaxed\-filenames +The option +.B \-relaxed\-filenames +allows ISO-9660 filenames to include digits, upper case characters +and all other 7 bit ASCII characters (resp. anything except lowercase +characters). +.br +This violates the ISO-9660 standard, but it happens to work on many systems. +Use with caution. +.TP +.BI \-root " dir +Moves all files and directories into +.I dir +in the image. This is essentially the +same as using +.B -graft-points +and adding +.I dir +in front of every pathspec, but is easier to use. + +.I dir +may actually be several levels deep. It is +created with the same permissions as other graft points. +.TP +.B \-rrip110 +Create ISO-9660 file system images that follow the old Rrip Version-1.10 standard +from 1993. This option may be needed if you know of systems that do not implement +the Rrip protocol correctly and like the file system to be read by such a system. +Currently no such system is known. +.sp +If a file system has been created with +.BR \-rrip110 , +the Rock Ridge attributes do not include inode number information. +.TP +.B \-rrip112 +Create ISO-9660 file system images that follow the new Rrip Version-1.12 standard +from 1994, this is the default. +.TP +.BI \-old-root " dir +This option is necessary when writing a multisession +image and the previous (or even older) session was written with +.BI -root " dir. +Using a directory name not found in the previous session +causes +.B mkisofs +to abort with an error. + +Without this option, +.B mkisofs +would not be able to find unmodified files and would +be forced to write their data into the image once more. + +.B \-root +and +.B \-old-root +are meant to be used together to do incremental backups. +The initial session would e.g. use: +.BI "mkisofs \-root backup_1 " dirs\f0. +The next incremental backup with +.BI "mkisofs \-root backup_2 \-old-root backup_1 " dirs\f0. +would take another snapshot of these directories. The first +snapshot would be found in +.BR backup_1 , +the second one in +.BR backup_2 , +but only modified or new files need to be written +into the second session. + +Without these options, new files would be added and old ones would be +preserved. But old ones would be overwritten if the file was +modified. Recovering the files by copying the whole directory back +from CD would also restore files that were deleted +intentionally. Accessing several older versions of a file requires +support by the operating system to choose which sessions are to be +mounted. +.br +.ne 8 +.TP +.B \-short\-rr\-time +Use the short ISO-9660 time format for the file time stamps used in Rock Ridge. +This time format allows to represent year 1990 .. year 2155 with a granularity of one second. +.TP +.BI \-s " sector type +.TP +.BI \-sectype " sector type +Set the +.I sector type +to be used for the output file with the ISO-9660 filesystem. +The +.I sector type +may be one of: +.RS +.TP +.B data +This is the default. It results in standard CD-ROM data sectors with +2048 bytes per sector. +.TP +.B xa1 +This sets the sector type to CD-ROM XA mode 1 with 2056 bytes per sector. +This sector type is the official sector type for multi-session CDs, it +should be used together with the +.B \-XA +option of mkisofs. +It is required to write Kodak Photo CDs and Kodak Picture CDs. +Use the +.B \-xa1 +option from +.B cdrecord +to tell +.B cdrecord +to write CD-ROM XA mode 1 sectors. +Do not use for DVD or BluRay media. +.br +.ne 6 +.TP +.B raw +This sets the sector type to raw audio sectors with 2352 bytes per sector. +This is reserved for future enhancements. +Do not use for DVD or BluRay media. +.RE +.TP +.BI \-sort " sort file +Sort file locations on the media. Sorting is controlled by a file that +contains pairs of filenames and sorting offset weighting. +If the weighting is higher, the file will be located closer to the +beginning of the media, if the weighting is lower, the file will be located +closer to the end of the media. There must be only one space or tabs +character between the filename and the +weight and the weight must be the last characters on a line. The filename +is taken to include all the characters up to, but not including the last +space or tab character on a line. This is to allow for space characters to +be in, or at the end of a filename. +This option does +.B not +sort the order of the file names that appear +in the ISO-9660 directory. It sorts the order in which the file data is +written to the CD image - which may be useful in order to optimize the +data layout on a CD. See README.sort for more details. +.TP +.BI \-isort " sort file +Similiar to +.B \-sort +but the case if the filenames in the +.B sort file +is ignored. +.TP +.BI \-sparc\-boot " img_sun4,img_sun4c,img_sun4m,img_sun4d,img_sun4e +See +.B \-B +option above. +.TP +.BI \-sparc\-label " label +Set the Sun disk label name for the Sun disk label that is created with the +.B \-sparc-boot +option. +.TP +.B \-split\-output +Split the output image into several files of approximately 1 GB. +This helps to create DVD sized ISO-9660 images on operating systems without +large file support. +Cdrecord will concatenate more than one file into a single track if writing +to a DVD. +To make +.B \-split\-output +work, the +.BI \-o " filename" +option must be specified. The resulting output images will be named: +.IR filename_00 , filename_01, filename_02 ... +.TP +.BI \-stream\-media\-size " # +Select streaming operation and set the media size to # sectors. +This allows you to pipe the output of the tar program into mkisofs +and to create a ISO-9660 filesystem without the need of an intermediate +tar archive file. +If this option has been specified, +.B mkisofs +reads from +.B stdin +and creates a file with the name +.BR STREAM.IMG . +The maximum size of the file (with padding) is 200 sectors less than the +specified media size. If +.B \-no\-pad +has been specified, the file size is 50 sectors less than the specified media size. +If the file is smaller, then mkisofs will write padding. This may take a while. +.sp +The option +.B \-stream\-media\-size +creates simple ISO-9660 filesystems only and may not used together with multi-session +or hybrid filesystem options. +.TP +.BI \-stream\-file\-name " name +Set the file name used with +.BI \-stream\-media\-size " # +to a value different from +.BR STREAM.IMG . +If this option is used, the filesystem is created as if +.BR \-iso\-level " 4 +has been specified. +.TP +.BI \-sunx86\-boot " UFS-img,,,AUX1-img +Specifies a comma separated list of filesystem images that are needed to make +a bootable CD for Solaris x86 systems. +.sp +Note that partition 1 is used for the ISO-9660 image and that partition 2 is +the whole disk, so partition 1 and 2 may not be used by external partition data. +The first image file is mapped to partition 0. +There may be empty fields in the comma separated list, +and list entries for partition 1 and 2 must be empty. +The maximum number of supported partitions is 8 (although the Solaris x86 +partition table could support up to 16 partitions), so it is impossible +to specify more than 6 partition images. +This option is required to make a bootable CD for Solaris x86 systems. +.sp +If the +.B \-sunx86\-boot +option has been specified, the first sector of the resulting image will +contain a PC fdisk label with a Solaris type 0x82 fdisk partition that +starts at offset 512 and spans the whole CD. +In addition, for the Solaris type 0x82 fdisk partition, there is a +SVr4 disk label at offset 1024 in the first sector of the CD. +This disk label specifies slice 0 for the first (usually UFS type) +filesystem image that is used to boot the PC and slice 1 for +the ISO-9660 image. +Slice 2 spans the whole CD slice 3 .\|.\|. slice 7 may be used for additional +filesystem images that have been specified with this option. +.sp +A Solaris x86 boot CD uses a 1024 byte sized primary boot that uses the +.B "El-Torito no-emulation +boot mode and a secondary generic boot that is in CD sectors 1\|.\|.15. +For this reason, both +.BI "-b " bootimage " -no\-emul\-boot +and +.BI \-G " genboot +must be specified. +.TP +.BI \-sunx86\-label " label +Set the SVr4 disk label name for the SVr4 disk label that is created with the +.B \-sunx86-boot +option. +.TP +.BI \-sysid " ID +Specifies the system ID. +There is space on the disc for 32 characters of information. +This parameter can also be set in the file +.B \&.m\&kisofsrc +with SYSI=system_id. +If specified in both places, the command line version is used. +.TP +.B \-T +.TP +.B \-translation\-table +Generate a file TRANS.TBL in each directory on the CDROM, which can be used +on non-Rock Ridge capable systems to help establish the correct file names. +There is also information present in the file that indicates the major and +minor numbers for block and character devices, and each symlink has the name of +the link file given. +.TP +.BI \-table\-name " TABLE_NAME +Alternative translation table file name (see above). Implies the +.B \-T +option. +If you are creating a multi-session image you must use the same name +as in the previous session. +.TP +.BI \-ucs\-level " level +Set Unicode conformance level in the Joliet SVD. The default level is 3. +It may be set to 1..3 using this option. +.TP +.B \-UDF +Include a +.B UDF +hybrid in the generated filesystem image. +As +.B mkisofs +always creates a ISO-9660 filesystem, +it is not possible to create UDF only images. +Note that +.B UDF +wastes the space from sector ~20 to sector 256 at the beginning of the disk +in addition to the space needed for real +.B UDF +data structures. +.TP +.B \-udf +Rationalized UDF with user and group set to 0 and with simplified permissions. +See +.B \-r +option for more information. +.TP +.B \-udf\-symlinks +Support symlinks in +.B UDF +filesystems. This is the default. +.TP +.B \-no\-udf\-symlinks +Do not support symlinks in +.B UDF +filesystems. +.TP +.BI \-uid " uid +Overrides the uid read from the source files to the value of +.IR uid . +Specifying this option automatically enables Rock Ridge extensions. +.TP +.B \-use\-fileversion +The option +.B \-use\-fileversion +allows mkisofs to use file version numbers from the filesystem. +If the option is not specified, +.B mkisofs +creates a version number of 1 for all files. +File versions are strings in the range +.I ";1" +to +.I ";32767" +This option is the default on VMS. +.TP +.B \-U +.TP +.B \-untranslated\-filenames +Allows "Untranslated" filenames, completely violating the ISO-9660 standards +described above. Forces on the \-d, \-l, \-N, \-allow\-leading\-dots, +\-relaxed\-filenames, +\-allow\-lowercase, \-allow\-multidot and \-no\-iso\-translate +flags. It allows more +than one '.' character in the filename, as well as mixed case filenames. +This is useful on HP-UX system, where the built-in CDFS filesystem does +not recognize ANY extensions. Use with extreme caution. +.TP +.B \-no\-iso\-translate +Do not translate the characters '#' and '~' which are invalid for ISO-9660 filenames. +These characters are though invalid often used by Microsoft systems. +.br +This violates the ISO-9660 standard, but it happens to work on many systems. +Use with caution. +.TP +.BI \-V " volid +Specifies the volume ID (volume name or label) to be written into the +master block. +There is space on the disc for 32 characters of information. +This parameter can also be set in the file +.B \&.m\&kisofsrc +with VOLI=id. +If specified in both places, the command line version is used. Note that +if you assign a volume ID, this is the name that will be used as the mount +point used by the Solaris volume management system and the name that is +assigned to the disc on a Microsoft Win32 or Apple Mac platform. +.TP +.BI \-volset " ID +Specifies the volset ID. +There is space on the disc for 128 characters of information. +The related Joliet entry is limited to 64 characters. +This parameter can also be set in the file +.B \&.m\&kisofsrc +with VOLS=volset_id. +If specified in both places, the command line version is used. +.TP +.BI \-volset\-size " # +Sets the volume set size to #. +The volume set size is the number of CD's that are in a CD volume set. +A volume set is a collection of one or more volumes, on which a set of +files is recorded. +.sp +Volume Sets are not intended to be used to create a set numbered CD's +that are part of e.g. a Operation System installation set of CD's. +Volume Sets are rather used to record a big directory tree that would not +fit on a single volume. +Each volume of a Volume Set contains a description of all the directories +and files that are recorded on the volumes where the sequence numbers +are less than, or equal to, the assigned Volume Set Size of the current +volume. +.sp +.B Mkisofs +currently does not support a +.B \-volset\-size +that is larger than 1. +.sp +The option +.B \-volset\-size +must be specified before +.B \-volset\-seqno +on each command line. +.TP +.BI \-volset\-seqno " # +Sets the volume set sequence number to #. +The volume set sequence number is the index number of the current +CD in a CD set. +The option +.B \-volset\-size +must be specified before +.B \-volset\-seqno +on each command line. +.TP +.B \-v +.TP +.B \-verbose +Verbose execution. If given twice on the command line, extra debug information +will be printed. +.TP +.BI \-x " path +Exclude +.I path +from being written to CDROM. +.I path +must be the complete pathname that results from concatenating the pathname +given as command line argument and the path relative to this directory. +Multiple paths may be excluded. +Example: + +mkisofs \-o cd \-x /local/dir1 \-x /local/dir2 /local +.sp +NOTE: The +.B \-m +and +.B \-x +option description should both be updated, they are wrong. +Both now work identical and use filename globbing. A file is excluded if either +the last component matches or the whole path matches. +.TP +.B \-XA +Generate XA iso-directory attributes with original owner and mode information. +This option is required to create conforming multi session CDs as used by the +Kodak Photo CD and the Kodak Picture CD. +A conforming XA CD uses CD-ROM XA mode 1 sectors, see the +.BI \-sector " xa2 +option for more information. +.TP +.B \-xa +Generate XA iso-directory attributes with rationalized owner and mode information. +User ID and group ID are set to 0. +See +.B \-XA +for more information. +.TP +.B \-z +Generate special RRIP records for transparently compressed files. +This is only of use and interest for hosts that support transparent +decompression, such as Linux 2.4.14 or later. You must specify the +.B \-R +or +.B \-r +options to enable RockRidge, and generate compressed files using the +.B mkzftree +utility before running +.BR mkisofs . +Note that transparent compression is a nonstandard Rock Ridge extension. +The resulting disks are only transparently readable if used on Linux. +On other operating systems you will need to call +.B mkzftree +by hand to decompress the files. + +.SH "HFS OPTIONS +.TP +.B \-hfs +Create an ISO-9660/HFS hybrid CD. This option should be used in conjunction +with the +.BR \-map , +.B \-magic +and/or the various +.I double dash +options given below. +.TP +.B \-no\-hfs +Do not create an ISO-9660/HFS hybrid CD even though other options may imply to do so. +.TP +.B \-apple +Create an ISO-9660 CD with Apple's extensions. Similar to the +.B \-hfs +option, except that the Apple Extensions to ISO-9660 are added instead of +creating an HFS hybrid volume. +Former +.B mkisofs +versions did include Rock Ridge attributes by default if +.B \-apple +was specified. This versions of +.B mkisofs +does not do this anymore. If you like to have Rock Ridge attributes, +you need to specify this separately. +.TP +.BI \-map " mapping_file +Use the +.I mapping_file +to set the CREATOR and TYPE information for a file based on the +filename's extension. A filename is +mapped only if it is not one of the know Apple/Unix file formats. See the +.B "HFS CREATOR/TYPE +section below. +.TP +.BI \-magic " magic_file +The CREATOR and TYPE information is set by using a file's +.I magic number +(usually the first few bytes of a file). The +.I magic_file +is only used if a file is not one of the known Apple/Unix file formats, or +the filename extension has not been mapped using the +.B \-map +option. See the +.B "HFS CREATOR/TYPE +section below for more details. +.TP +.BI \-hfs\-creator " CREATOR +Set the default CREATOR for all files. Must be exactly 4 characters. See the +.B "HFS CREATOR/TYPE +section below for more details. +.TP +.BI \-hfs\-type " TYPE +Set the default TYPE for all files. Must be exactly 4 characters. See the +.B "HFS CREATOR/TYPE +section below for more details. +.TP +.B \-probe +Search the contents of files for all the known Apple/Unix file formats. +See the +.B HFS MACINTOSH FILE FORMATS +section below for more about these formats. +However, the only way to check for +.I MacBinary +and +.I AppleSingle +files is to open and read them. Therefore this option +.I may +increase processing time. It is better to use one or more +.I double dash +options given below if the Apple/Unix formats in use are known. +.TP +.B \-no\-desktop +Do not create (empty) Desktop files. New HFS Desktop files will be created +when the CD is used on a Macintosh (and stored in the System Folder). +By default, empty Desktop files are added to the HFS volume. +.TP +.B \-mac\-name +Use the HFS filename as the starting point for the ISO-9660, Joliet and +Rock Ridge file names. See the +.B HFS MACINTOSH FILE NAMES +section below for more information. +.TP +.BI \-boot\-hfs\-file " driver_file +Installs the +.I driver_file +that +.I may +make the CD bootable on a Macintosh. See the +.B HFS BOOT DRIVER +section below. (Alpha). +.TP +.B \-part +Generate an HFS partition table. By default, no partition table is generated, +but some older Macintosh CDROM drivers need an HFS partition table on the +CDROM to be able to recognize a hybrid CDROM. +.TP +.BI \-auto " AutoStart_file +Make the HFS CD use the QuickTime 2.0 Autostart feature to launch an +application or document. The given filename must be the name of a document or +application located at the top level of the CD. The filename must be less +than 12 characters. (Alpha). +.TP +.BI \-cluster\-size " size +Set the size in bytes of the cluster or allocation units of PC Exchange +files. Implies the +.B \-\-exchange +option. See the +.B HFS MACINTOSH FILE FORMATS +section below. +.TP +.BI \-hide\-hfs " glob +Hide +.I glob +from the HFS volume. The file or directory will still exist in the +ISO-9660 and/or Joliet directory. +.I glob +is a shell wild-card-style pattern that must match any part of the filename +Multiple globs may be excluded. +Example: + +mkisofs \-o rom \-hfs \-hide\-hfs '*.o' \-hide\-hfs foobar + +would exclude all files ending in ".o" or called "foobar" +from the HFS volume. Note that if you had a directory called +"foobar" it too (and of course all its descendants) would be excluded. +The +.I glob +can also be a path name relative to the source directories given on the +command line. Example: + +mkisofs \-o rom \-hfs \-hide\-hfs src/html src + +would exclude just the file or directory called "html" from the "src" +directory. Any other file or directory called "html" in the tree will +not be excluded. +Should be used with the +.B \-hide +and/or +.B \-hide\-joliet +options. +In order to match a directory name, make sure the pathname does not include +a trailing '/' character. See README.hide for more details. +.TP +.BI \-hide\-hfs\-list " file +A file containing a list of +.I globs +to be hidden as above. +.TP +.BI \-hfs\-volid " hfs_volid +Volume name for the HFS partition. This is the name that is +assigned to the disc on a Macintosh and replaces the +.I volid +used with the +.B \-V +option +.TP +.B \-icon\-position +Use the icon position information, if it exists, from the Apple/Unix file. +The icons will appear in the same position as they would on a Macintosh +desktop. Folder location and size on screen, its scroll positions, folder +View (view as Icons, Small Icons, etc.) are also preserved. +This option may become set by default in the future. +(Alpha). +.TP +.BI \-root\-info " file +Set the location, size on screen, scroll positions, folder View etc. for the +root folder of an HFS volume. See README.rootinfo for more information. +(Alpha) +.TP +.BI \-prep\-boot " FILE +PReP boot image file. Up to 4 are allowed. See README.prep_boot (Alpha) +.TP +.B \-chrp-\boot +Create a CHRP boot in boot partition 1. +See +.B \-prep\-boot +for further information. +.TP +.BI \-input\-hfs\-charset " charset +Input charset that defines the characters used in HFS file names when +used with the +.I \-mac\-name +option. +The default charset is cp10000 (Mac Roman) +.I cp10000 +(Mac Roman) +See +.B "CHARACTER SETS +and +.B "HFS MACINTOSH FILE NAMES +sections below for more details. +.TP +.BI \-output\-hfs\-charset " charset +Output charset that defines the characters that will be used in the HFS +file names. Defaults to the input charset. See +.B "CHARACTER SETS +section below for more details. +.TP +.B \-hfs\-unlock +By default, +.B mkisofs +will create an HFS volume that is +.IR locked . +This option leaves the volume unlocked so that other applications (e.g. +hfsutils) can modify the volume. See the +.B "HFS PROBLEMS/LIMITATIONS +section below for warnings about using this option. +.TP +.BI \-hfs\-bless " folder_name +"Bless" the given directory (folder). This is usually the +.B System Folder +and is used in creating HFS bootable CDs. The name of the directory must +be the whole path name as +.B mkisofs +sees it. e.g. if the given pathspec is ./cddata and the required folder is +called System Folder, then the whole path name is "./cddata/System Folder" +(remember to use quotes if the name contains spaces). +.TP +.BI \-hfs\-parms " PARAMETERS +Override certain parameters used to create the HFS file system. Unlikely to +be used in normal circumstances. See the libhfs_iso/hybrid.h source file for +details. +.TP +.B \-\-cap +Look for AUFS CAP Macintosh files. Search for CAP Apple/Unix file formats +only. Searching for the other possible Apple/Unix file formats is disabled, +unless other +.I double dash +options are given. +.TP +.B \-\-netatalk +Look for NETATALK Macintosh files +.TP +.B \-\-double +Look for AppleDouble Macintosh files +.TP +.B \-\-ethershare +Look for Helios EtherShare Macintosh files +.TP +.B \-\-ushare +Look for IPT UShare Macintosh files +.TP +.B \-\-exchange +Look for PC Exchange Macintosh files +.TP +.B \-\-sgi +Look for SGI Macintosh files +.TP +.B \-\-xinet +Look for XINET Macintosh files +.TP +.B \-\-macbin +Look for MacBinary Macintosh files +.TP +.B \-\-single +Look for AppleSingle Macintosh files +.TP +.B \-\-dave +Look for Thursby Software Systems DAVE Macintosh files +.TP +.B \-\-sfm +Look for Microsoft's Services for Macintosh files (NT only) (Alpha) +.TP +.B \-\-osx\-double +Look for MacOS X AppleDouble Macintosh files +.TP +.B \-\-osx\-hfs +Look for MacOS X HFS Macintosh files + +.SH "CHARACTER SETS +.B mkisofs +processes file names in a POSIX compliant way as strings of 8-bit characters. +To represent all codings for all languages, 8-bit characters are not +sufficient. Unicode or +.B ISO-10646 +define character codings that need at least 21 bits to represent all +known languages. They may be represented with +.BR UTF-32 ", " UTF-16 " or " UTF-8 +coding. +.B UTF-32 +uses a plain 32-bit coding but seems to be uncommon. +.B UCS-2 +is used by Microsoft with Win32. +This coding is similar to +.B UTF-16 +with the disadvantage that it only supports +a 16 bit subset (except when surrogates are used) of all codes +and that 16-bit characters are not compliant with +the POSIX filesystem interface. +.PP +Modern UNIX operating systems may use +.B UTF-8 +coding for filenames. This coding allows to use the complete Unicode code set. +Each 32-bit character is represented by one or more 8-bit characters. +If a character is coded in +.B ISO-8859-1 +(used in Central Europe and North America) it maps 1:1 to a +.BR UTF-32 " or " UTF-16 " +coded Unicode character. +If a character is coded in +.B "7-Bit ASCII +(used in USA and other countries with limited character set) +it maps 1:1 to a +.BR UTF-32 ", " UTF-16 " or " UTF-8 +coded Unicode character. +Character codes that cannot be represented as a single byte in UTF-8 +(typically if the value is > 0x7F) use escape sequences that map to more than +one 8-bit character. +.PP +If all operating systems would use +.B UTF-8 +coding, +.B mkisofs +would not need to recode characters in file names. +Unfortunately, Apple uses completely nonstandard codings and Microsoft +uses a Unicode coding that is not compatible with the POSIX filename +interface. +.PP +For all non +.B UTF-8 +coded operating systems, the actual character +that each byte represents, depends on the +.I character set +or +.I codepage +(which is the name used by Microsoft) +used by the local operating system in use - the characters in a character +set will reflect the region or natural language used by the user. +.PP +Usually character codes 0x00-0x1f are control characters, codes 0x20-0x7f +are the 7 bit ASCII characters and (on PC's and Mac's) 0x80-0xff are used +for other characters. +Unfortunately even this does not follow ISO standards that reserve the +range 0x80-0x9f for control characters and only allow 0xa0-0xff for other +characters. +.PP +As there is a lot more than 256 characters/symbols in use, only a small +subset are represented in a character set. Therefore the same character code +may represent a different character in different character sets. So a file name +generated, say in central Europe, may not display the same character +when viewed on a machine in, say eastern Europe. +.PP +To make matters more complicated, different operating systems use +different character sets for the region or language. For example the character +code for "small e with acute accent" may be character code 0x82 on a PC, +code 0x8e on a Macintosh and code 0xe9 on a UNIX system. +Note while the codings used on a PC or Mac are nonstandard, +Unicode codes this character as 0x00000000e9 which is basically the +same value as the value used by most UNIX systems. +.PP +As long as not all operating systems and applications will use the Unicode +character set as the basis for file names in a unique way, it may be +necessary to specify which character set your file names use in and which +character set the file names should appear on the CD. +.PP +There are four options to specify the character sets you want to use: +.IP \-input\-charset +Defines the local character set you are using on your host machine. +Any character set conversions that take place will use this character +set as the staring point. The default input character sets are +.I cp437 +on DOS based systems and +.I iso8859-1 +on all other systems. + +If the +.I \-J +option is given, then the Unicode equivalents of the input character set +will be used in the Joliet directory. Using the +.I \-jcharset +option is the same as using the +.I \-input\-charset +and +.I \-J +options. +.IP \-output\-charset +Defines the character set that will be used with for the Rock Ridge names +on the CD. Defaults to the input character set. Only likely to be useful +if used on a non-Unix platform. e.g. using +.B mkisofs +on a Microsoft Win32 machine to create Rock Ridge CDs. If you are using +.B mkisofs +on a Unix machine, it is likely that the output character set +will be the same as the input character set. +.IP \-input\-hfs\-charset +Defines the HFS character set used for HFS file names decoded from +any of the various Apple/Unix file formats. Only useful when used with +.I \-mac\-name +option. See the +.B HFS MACINTOSH FILE NAMES +for more information. Defaults to +.I cp10000 +(Mac Roman). +.IP \-output\-hfs\-charset +Defines the HFS character set used to create HFS file names from the input +character set in use. In most cases this will be from the character set +given with the +.I \-input\-charset +option. Defaults to the input HFS character set. +.PP +The +.B default +character set is built into +.BR mkisofs . +A number of further character sets are read in from the filesystem by +.I mkisofs +from a directory relatively to the install path. +To get a listing, use +.B "mkisofs \-input\-charset help. +.PP +Additional character sets from +.BR iconv (1) +may be used on systems, that support +.BR iconv (1). +In this case, call +.B "iconv \-l +to get a list of valid character sets from this coding method. +To force an +.BR iconv (1) +based coding, use +.BI iconv: name +instead of +.I name +for the character set. +.PP +If using non +.BR iconv (1) +based character sets, +additional character sets can be read from file for any of the character +set options by giving a filename as the argument to the options. A given +character set will be read from a file whenever the supplied name contains +a '/'. +.PP +The format of the character set files is the same as the mapping files +available from http://www.unicode.org/Public/MAPPINGS The format of these +files is: + + Column #1 is the input byte code (in hex as 0xXX) +.br + Column #2 is the Unicode (in hex as 0xXXXX) +.br + Rest of the line is ignored. + +Any blank line, line without two (or more) columns in the above format +or comments lines (starting with the # character) are ignored without any +warnings. Any missing input code is mapped to Unicode character 0x0000. +.PP +Note that there is no support for 16 bit UNICODE (UTF-16) or 32 bit UNICODE +(UTF-32) coding because this coding is not POSIX compliant. There should +be support for UTF-8 UNICODE coding which is compatible to POSIX filenames +and supported by moder UNIX implementations such as Solaris. +.PP +A 1:1 character set mapping can be defined by using the keyword +.I default +as the argument to any of the character set options. This is the behaviour +of older (v1.12) versions of +.BR mkisofs . +.PP +The ISO-9660 file names generated from the input filenames are not converted +from the input character set. The ISO-9660 character set is a very limited +subset of the ASCII characters, so any conversion would be pointless. +.PP +Any character that +.B mkisofs +can not convert will be replaced with a '_' character. +.PP +.SH "HFS CREATOR/TYPE +A Macintosh file has two properties associated with it which define +which application created the file, the +.I CREATOR +and what data the file contains, the +.IR TYPE . +Both are (exactly) 4 letter strings. Usually this +allows a Macintosh user to double-click on a file and launch the correct +application etc. The CREATOR and TYPE of a particular file can be found by +using something like ResEdit (or similar) on a Macintosh. +.LP +The CREATOR and TYPE information is stored in all the various Apple/Unix +encoded files. +For other files it is possible to base the CREATOR and TYPE on the +filename's extension using a +.I mapping +file (the +.B \-map +option) and/or using the +.I magic number +(usually a +.I signature +in the first few bytes) +of a file (the +.B \-magic +option). If both these options are given, then their order on the command +line is important. If the +.B \-map +option is given first, then a filename extension match is attempted +before a magic number match. However, if the +.B \-magic +option is given first, then a magic number match is attempted before a +filename extension match. +.PP +If a mapping or magic file is not used, or no match is found then the default +CREATOR and TYPE for all regular files can be set by using entries in the +.B \&.m\&kisofsrc +file or using the +.B \-hfs\-creator +and/or +.B \-hfs\-type +options, otherwise the default CREATOR and TYPE are 'unix' and 'TEXT'. +.PP +The format of the +.I mapping +file is the same +.I afpfile +format as used by +.IR aufs . +This file has five columns for the +.IR extension , +.I file +.IR translation , +.IR CREATOR , +.I TYPE +and +.IR Comment . +Lines starting with the '#' character are +comment lines and are ignored. An example file would be like: +.LP +.TS +tab (/); +l s s s s +l s s s s +l l l l l . +# Example filename mapping file +# +# EXTN/XLate/CREATOR/TYPE/Comment +\&.tif/Raw/'8BIM'/'TIFF'/"Photoshop TIFF image" +\&.hqx/Ascii/'BnHq'/'TEXT'/"BinHex file" +\&.doc/Raw/'MSWD'/'WDBN'/"Word file" +\&.mov/Raw/'TVOD'/'MooV'/"QuickTime Movie" +*/Ascii/'ttxt'/'TEXT'/"Text file" +.TE +.LP +Where: +.IP +The first column +.I EXTN +defines the Unix filename extension to be +mapped. The default mapping for any filename extension that doesn't +match is defined with the "*" character. +.IP +The +.I Xlate +column defines the type of text translation between the Unix and +Macintosh file it is ignored by +.BR mkisofs , +but is kept to be compatible with +.BR aufs (1). +Although +.B mkisofs +does not alter the contents of a file, if a binary file has its TYPE +set as 'TEXT', it +.I may +be read incorrectly on a Macintosh. Therefore a better choice for the +default TYPE may be '????' +.IP +The +.I CREATOR +and +.I TYPE +keywords must be 4 characters long and enclosed in single quotes. +.IP +The comment field is enclosed in double quotes - it is ignored by +.BR mkisofs , +but is kept to be compatible with +.BR aufs . +.PP +The format of the +.I magic +file is almost identical to the +.BR magic (4) +file used by the Linux +.BR file (1) +command - the routines for reading and decoding the +.I magic +file are based on the Linux +.BR file (1) +command. +.PP +This file has four tab separated columns for the +.I byte +.IR offset , +.IR type , +.I test +and +.IR message . +Lines starting with the '#' character are +comment lines and are ignored. An example file would be like: +.LP +.TS +tab (/); +l s s s +l s s s +l l l l . +# Example magic file +# +# off/type/test/message +0/string/GIF8/8BIM GIFf GIF image +0/beshort/0xffd8/8BIM JPEG image data +0/string/SIT!/SIT! SIT! StuffIt Archive +0/string/\e037\e235/LZIV ZIVU standard unix compress +0/string/\e037\e213/GNUz ZIVU gzip compressed data +0/string/%!/ASPS TEXT Postscript +0/string/\e004%!/ASPS TEXT PC Postscript with a ^D to start +4/string/moov/txtt MooV QuickTime movie file (moov) +4/string/mdat/txtt MooV QuickTime movie file (mdat) +.TE +.PP +The format of the file is described in the +.BR magic (4) +man page. The only difference here is that for each entry in the magic file, the +.I message +for the initial offset +.B must +be 4 characters for the CREATOR followed by 4 characters for the TYPE - +white space is +optional between them. Any other characters on this line are ignored. +Continuation lines (starting with a '>') are also ignored i.e. only the initial +offset lines are used. +.PP +Using the +.B \-magic +option may significantly increase processing time as each file has to opened +and read to find its magic number. +.PP +In summary, for all files, the default CREATOR is 'unix' and the default +TYPE is 'TEXT'. These can be changed by using entries in the +.I \&.m\&kisofsrc +file or by using the +.B \-hfs\-creator +and/or +.B \-hfs\-type +options. +.PP +If the a file is in one of the known Apple/Unix formats (and the format +has been selected), then the CREATOR and TYPE are taken from the values +stored in the Apple/Unix file. +.PP +Other files can have their CREATOR and TYPE set from their file name +extension (the +.B \-map +option), or their magic number (the +.B \-magic +option). If the default match is used in the +.I mapping +file, then these values override the default CREATOR and TYPE. +.PP +A full CREATOR/TYPE database can be found at +http://www.angelfire.com/il/szekely/index.html + +.SH "HFS MACINTOSH FILE FORMATS +Macintosh files have two parts called the +.I Data +and +.I Resource +fork. Either may be empty. Unix (and many other OSs) can only +cope with files having one part (or fork). To add to this, Macintosh files +have a number of attributes associated with them - probably the most +important are the TYPE and CREATOR. Again Unix has no concept of these +types of attributes. +.PP +e.g. a Macintosh file may be a JPEG image where the image is stored in the +Data fork and a desktop thumbnail stored in the Resource fork. It is usually +the information in the data fork that is useful across platforms. +.PP +Therefore to store a Macintosh file on a Unix filesystem, a way has to be +found to cope with the two forks and the extra attributes (which are +referred to as the +.I finder +.IR info ). +Unfortunately, it seems that every software package that stores Macintosh +files on Unix has chosen a completely different storage method. +.PP +The Apple/Unix formats that +.I mkisofs +(partially) supports are: +.IP "CAP AUFS format" +Data fork stored in a file. Resource fork in subdirectory .resource +with same filename as data fork. Finder info +in .finderinfo subdirectory with same filename. +.IP "AppleDouble/Netatalk" +Data fork stored in a file. Resource fork stored in a file with +same name prefixed with "%". Finder info also stored in same +"%" file. Netatalk uses the same format, but the resource +fork/finderinfo stored in subdirectory .AppleDouble with same +name as data fork. +.IP AppleSingle +Data structures similar to above, except both forks and finder +info are stored in one file. +.IP "Helios EtherShare" +Data fork stored in a file. Resource fork and finder info together in +subdirectory .rsrc with same filename as data fork. +.IP "IPT UShare" +Very similar to the EtherShare format, but the finder info +is stored slightly differently. +.IP MacBinary +Both forks and finder info stored in one file. +.IP "Apple PC Exchange" +Used by Macintoshes to store Apple files on DOS (FAT) disks. +Data fork stored in a file. Resource fork in subdirectory +resource.frk (or RESOURCE.FRK). Finder info as one record +in file finder.dat (or FINDER.DAT). Separate finder.dat for +each data fork directory. +.IP +Note: +.I mkisofs +needs to know the native FAT cluster size of the disk that the PC Exchange +files are on (or have been copied from). This size is given by the +.B \-cluster\-size +option. +The cluster or allocation size can be found by using the DOS utility +.BR CHKDSK . +.IP +May not work with PC Exchange v2.2 or higher files (available with MacOS 8.1). +DOS media containing PC Exchange files should be mounted as type +.B msdos +(not +.BR vfat ) +when using Linux. +.IP "SGI/XINET" +Used by SGI machines when they mount HFS disks. Data fork stored +in a file. Resource fork in subdirectory .HSResource with same +name. Finder info as one record in file .HSancillary. Separate .HSancillary +for each data fork directory. +.IP "Thursby Software Systems DAVE" +Allows Macintoshes to store Apple files on SMB servers. +Data fork stored in a file. Resource fork in subdirectory +resource.frk. Uses the AppleDouble format to store resource fork. +.IP "Services for Macintosh" +Format of files stored by NT Servers on NTFS filesystems. Data fork is +stored as "filename". Resource fork stored as a NTFS +.I stream +called "filename:AFP_Resource". The finder info is stored as a NTFS +.I stream +called "filename:Afp_AfpInfo". These streams are normally invisible to the +user. +.IP +Warning: mkisofs only partially supports the SFM format. If an HFS file +or folder stored on the NT server contains an +.I illegal +NT character in its name, then NT converts these characters to +.I Private Use Unicode +characters. The characters are: " * / < > ? \ | also a space or +period if it is the last character of the file name, character codes 0x01 +to 0x1f (control characters) and Apple' apple logo. +.IP +Unfortunately, these private Unicode characters are not +readable by the mkisofs NT executable. Therefore any file or directory +name containing these characters will be ignored - including the contents of +any such directory. +.IP "MacOS X AppleDouble" +When HFS/HFS+ files are copied or saved by MacOS X on to a non-HFS file +system (e.g. UFS, NFS etc.), the files are stored in AppleDouble format. +Data fork stored in a file. Resource fork stored in a file with +same name prefixed with "._". Finder info also stored in same "._" file. +.IP "MacOS X HFS (Alpha)" +Not really an Apple/Unix encoding, but actual HFS/HFS+ files on a MacOS X +system. Data fork stored in a file. Resource fork stored in a pseudo file +with the same name with the suffix '/rsrc'. The finderinfo is only +available via a MacOS X library call. +.IP +Notes: (also see README.macosx) +.IP +Only works when used on MacOS X. +.IP +If a file is found with a zero +length resource fork and empty finderinfo, it is assumed not to have +any Apple/Unix encoding - therefore a TYPE and CREATOR can be set using +other methods. +.LP +.I mkisofs +will attempt to set the CREATOR, TYPE, date and possibly other flags from +the finder info. Additionally, if it exists, the Macintosh filename is set +from the finder info, otherwise the Macintosh name is based on the Unix +filename - see the +.B "HFS MACINTOSH FILE NAMES +section below. +.PP +When using the +.B \-apple +option, the TYPE and CREATOR are stored in the optional System Use or SUSP field +in the ISO-9660 Directory Record - in much the same way as the Rock Ridge +attributes are. In fact to make life easy, the Apple extensions are added +at the beginning of the existing Rock Ridge attributes (i.e. to get the Apple +extensions you get the Rock Ridge extensions as well). +.PP +The Apple extensions require the resource fork to be stored as an ISO-9660 +.I associated +file. This is just like any normal file stored in the ISO-9660 filesystem +except that the associated file flag is set in the Directory Record (bit +2). This file has the same name as the data fork (the file seen by +non-Apple machines). Associated files are normally ignored by other OSs +.PP +When using the +.B \-hfs +option, the TYPE and CREATOR plus other finder info, are stored in a separate +HFS directory, not visible on the ISO-9660 volume. The HFS directory references +the same data and resource fork files described above. +.PP +In most cases, it is better to use the +.B \-hfs +option instead of the +.B \-apple +option, as the latter imposes the limited ISO-9660 characters allowed in +filenames. However, the Apple extensions do give the advantage that the +files are packed on the disk more efficiently and it may be possible to fit +more files on a CD - important when the total size of the source files is +approaching 650MB. + +.SH "HFS MACINTOSH FILE NAMES +Where possible, the HFS filename that is stored with an Apple/Unix file +is used for the HFS part of the CD. However, not all the Apple/Unix +encodings store the HFS filename with the finderinfo. In these cases, +the Unix filename is used - with escaped special characters. Special +characters include '/' and characters with codes over 127. +.PP +Aufs escapes these characters by using ":" followed by the character code +as two hex digits. Netatalk and EtherShare have a similar scheme, but uses +"%" instead of a ":". +.PP +If mkisofs can't find an HFS filename, then it uses the Unix name, with +any %xx or :xx characters (xx == two hex digits) converted to a single +character code. If "xx" are not hex digits ([0-9a-fA-F]), then they are +left alone - although any remaining ":" is converted to "%" as colon +is the HFS directory separator. Care must be taken, as an ordinary Unix +file with %xx or :xx will also be converted. e.g. +.PP +.TS +l l +l s +l l +l s +l l . +This:2fFile converted to This/File + +This:File converted to This%File + +This:t7File converted to This%t7File +.TE +.PP +Although HFS filenames appear to support upper and lower case letters, +the filesystem is case insensitive. i.e. the filenames "aBc" and "AbC" +are the same. If a file is found in a directory with the same HFS name, +then +.I mkisofs +will attempt, where possible, to make a unique name by adding '_' characters +to one of the filenames. +.PP +If an HFS filename exists for a file, then mkisofs can use this name as +the starting point for the ISO-9660, Joliet and Rock Ridge filenames using +the +.B \-mac\-name +option. Normal Unix files without an HFS name will still use their Unix name. +e.g. +.PP +If a +.I MacBinary +(or +.I PC +.IR Exchange ) +file is stored as +.I someimage.gif.bin +on the Unix filesystem, but contains a HFS file called +.IR someimage.gif , +then this is the name that would appear on the HFS part of the CD. However, as +mkisofs uses the Unix name as the starting point for the other names, then +the ISO-9660 name generated will probably be +.I SOMEIMAG.BIN +and the Joliet/Rock Ridge would be +.IR someimage.gif.bin . +Although the actual data (in this case) is a GIF image. This option will use +the HFS filename as the starting point and the ISO-9660 name will probably be +.I SOMEIMAG.GIF +and the Joliet/Rock Ridge would be +.IR someimage.gif . +.PP +Using the +.B \-mac\-name +option will not currently work with the +.B \-T +option - the Unix +name will be used in the TRANS.TBL file, not the Macintosh name. +.PP +The character set used to convert any HFS file name to a Joliet/Rock Ridge +file name defaults to +.I cp10000 +(Mac Roman). +The character set used can be specified using the +.I \-input\-hfs\-charset +option. Other built in HFS character sets are: cp10006 (MacGreek), +cp10007 (MacCyrillic), cp10029 (MacLatin2), cp10079 (MacIcelandic) and +cp10081 (MacTurkish). +.PP +Note: the character codes used by HFS file names taken from the various +Apple/Unix formats will not be converted as they are assumed to be in the +correct Apple character set. Only the Joliet/Rock Ridge names derived from +the HFS file names will be converted. +.PP +The existing mkisofs code will filter out any illegal characters for the +ISO-9660 and Joliet filenames, but as mkisofs expects to be dealing +directly with Unix names, it leaves the Rock Ridge names as is. +But as '/' is a legal HFS filename character, the +.B \-mac\-name +option converts '/' to a '_' in Rock Ridge filenames. +.PP +If the Apple extensions are used, then only the ISO-9660 filenames will +appear on the Macintosh. However, as the Macintosh ISO-9660 drivers can use +.I Level 2 +filenames, then you can use options like +.B \-allow\-multidot +without problems on +a Macintosh - still take care over the names, for example +.I this.file.name +will be converted to +.I THIS.FILE +i.e. only have one '.', also filename +.I abcdefgh +will be seen as +.I ABCDEFGH +but +.I abcdefghi +will be seen as +.I ABCDEFGHI. +i.e. with a '.' at the end - don't know if this is a Macintosh +problem or m\&kisofs/mkhybrid problem. All filenames will be in upper case +when viewed on a Macintosh. Of course, DOS/Win3.X machines will not be able +to see Level 2 filenames... + +.SH "HFS CUSTOM VOLUME/FOLDER ICONS +To give a HFS CD a custom icon, make sure the root (top level) folder includes +a standard Macintosh volume icon file. To give a volume a custom icon on +a Macintosh, an icon has to be pasted over the volume's icon in the "Get Info" +box of the volume. This creates an invisible file called 'Icon\er' ('\er' is +the 'carriage return' character) in the root folder. +.P +A custom folder icon is very similar - an invisible file called 'Icon\er' +exits in the folder itself. +.P +Probably the easiest way to create a custom icon that mkisofs can use, is to +format a blank HFS floppy disk on a Mac, paste an icon to its "Get Info" +box. If using Linux with the HFS module installed, mount the floppy using +something like: + + mount \-t hfs /dev/fd0 /mnt/floppy + +The floppy will be mounted as a CAP file system by default. Then run mkisofs +using something like: + + mkisofs \-\-cap \-o output source_dir /mnt/floppy + +If you are not using Linux, then you can use the hfsutils to copy the icon +file from the floppy. However, care has to be taken, as the icon file +contains a control character. e.g. + + hmount /dev/fd0 +.br + hdir \-a +.br + hcopy \-m Icon^V^M icon_dir/icon + +Where '^V^M' is control\-V followed by control\-M. Then run +.B mkisofs +by using something like: + + mkisofs \-\-macbin \-o output source_dir icon_dir +.PP +The procedure for creating/using custom folder icons is very similar - paste +an icon to folder's "Get Info" box and transfer the resulting 'Icon\er' +file to the relevant directory in the mkisofs source tree. +.PP +You may want to hide the icon files from the ISO-9660 and Joliet trees. +.PP +To give a custom icon to a Joliet CD, follow the instructions found at: +http://www.fadden.com/cdrfaq/faq03.html#[3-21] + +.SH "HFS BOOT DRIVER +It +.I may +be possible to make the hybrid CD bootable on a Macintosh. +.PP +A bootable HFS CD requires an Apple CD-ROM (or compatible) driver, a bootable +HFS partition and the necessary System, Finder, etc. files. +.PP +A driver can be obtained from any other Macintosh bootable CD-ROM using the +.I apple_driver +utility. This file can then be used with the +.B \-boot\-hfs\-file +option. +.PP +The HFS partition (i.e. the hybrid disk in our case) must contain a +suitable System Folder, again from another CD-ROM or disk. +.PP +For a partition to be bootable, it must have its +.I boot block +set. The boot +block is in the first two blocks of a partition. For a non-bootable partition +the boot block is full of zeros. Normally, when a System file is copied to +partition on a Macintosh disk, the boot block is filled with a number of +required settings - unfortunately I don't know the full spec for the boot +block, so I'm guessing that the following will work OK. +.PP +Therefore, the utility +.I apple_driver +also extracts the boot block from the +first HFS partition it finds on the given CD-ROM and this is used for the +HFS partition created by +.BR mkisofs . +.IP "PLEASE NOTE" +By using a driver from an Apple CD and copying Apple software to your CD, +you become liable to obey Apple Computer, Inc. Software License Agreements. +.SH "EL TORITO BOOT INFORMATION TABLE +When the +.B \-boot\-info\-table +option is given, +.B mkisofs +will modify the boot file specified by the +.B \-b +option by inserting a 56-byte "boot information table" at offset 8 in +the file. This modification is done in the source filesystem, so make +sure you use a copy if this file is not easily recreated! This file +contains pointers which may not be easily or reliably obtained at boot +time. +.PP +The format of this table is as follows; all integers are in +section 7.3.1 ("little endian") format. +.sp +.RS +.2i +.ta 1.0i 2.5i 3.5i +.nf +Offset Name Size Meaning + 8 bi_pvd 4 bytes LBA of primary volume descriptor +12 bi_file 4 bytes LBA of boot file +16 bi_length 4 bytes Boot file length in bytes +20 bi_csum 4 bytes 32-bit checksum +24 bi_reserved 40 bytes Reserved +.fi +.RE +.sp +The 32-bit checksum is the sum of all the 32-bit words in the boot +file starting at byte offset 64. All linear block addresses (LBAs) +are given in CD sectors (normally 2048 bytes). +.SH CONFIGURATION +.B mkisofs +looks for the +.B \&.m\&kisofsrc +file, +first in the current working directory, +then in the user's home directory, +and then in the directory in which the +.B mkisofs +binary is stored. This file is assumed to contain a series of lines +of the form +.BI TAG= value +, and in this way you can specify certain options. +The case of the tag is not significant. +Some fields in the volume header +are not settable on the command line, but can be altered through this +facility. +Comments may be placed in this file, +using lines which start with a hash (#) character. +.TP +.B APPI +The application identifier +should describe the application that will be on the disc. +There is space on the disc for 128 characters of information. +The related Joliet entry is limited to 64 characters. +May be overridden using the +.B \-A +command line option. +.TP +.B COPY +The copyright information, +often the name of a file on the disc containing the copyright notice. +There is space in the disc for 37 characters of information. +The related Joliet entry is limited to 18 characters. +May be overridden using the +.B \-copyright +command line option. +.TP +.B ABST +The abstract information, +often the name of a file on the disc containing an abstract. +There is space in the disc for 37 characters of information. +The related Joliet entry is limited to 18 characters. +May be overridden using the +.B \-abstract +command line option. +.TP +.B BIBL +The bibliographic information, +often the name of a file on the disc containing a bibliography. +There is space in the disc for 37 characters of information. +The related Joliet entry is limited to 18 characters. +May be overridden using the +.B \-bilio +command line option. +.TP +.B PREP +This should describe the preparer of the CDROM, +usually with a mailing address and phone number. +There is space on the disc for 128 characters of information. +The related Joliet entry is limited to 64 characters. +May be overridden using the +.B \-p +command line option. +.TP +.B PUBL +This should describe the publisher of the CDROM, +usually with a mailing address and phone number. +There is space on the disc for 128 characters of information. +The related Joliet entry is limited to 64 characters. +May be overridden using the +.B \-publisher +command line option. +.TP +.B SYSI +The System Identifier. +There is space on the disc for 32 characters of information. +May be overridden using the +.B \-sysid +command line option. +.TP +.B VOLI +The Volume Identifier. +There is space on the disc for 32 characters of information. +May be overridden using the +.B \-V +command line option. +.TP +.B VOLS +The Volume Set Name. +There is space on the disc for 128 characters of information. +The related Joliet entry is limited to 64 characters. +May be overridden using the +.B \-volset +command line option. +.TP +.B HFS_TYPE +The default TYPE for Macintosh files. Must be exactly 4 characters. +May be overridden using the +.B \-hfs\-type +command line option. +.TP +.B HFS_CREATOR +The default CREATOR for Macintosh files. Must be exactly 4 characters. +May be overridden using the +.B \-hfs\-creator +command line option. +.PP +.B mkisofs +can also be configured at compile time with defaults for many of these fields. +See the file defaults.h. + +.SH EXAMPLES +.PP +To create a vanilla ISO-9660 filesystem image in the file +.IR cd.iso , +where the directory +.I cd_dir +will become the root directory of the CD ISO image, call: +.PP +% mkisofs \-o cd.iso cd_dir +.PP +To create a CD with Rock Ridge extensions of +the source directory +.IR cd_dir : +.PP +% mkisofs \-o cd.iso \-R cd_dir +.PP +To create a CD with Rock Ridge extensions of +the source directory +.I cd_dir +where all files have at least read permission and all files +are owned by +.IR root , +call: +.PP +% mkisofs \-o cd.iso \-r cd_dir +.PP +To write a tar archive directly to a CD that will later contain a simple +ISO-9660 filesystem with the tar archive call: +.PP +% star \-c . | mkisofs \-stream\-media\-size 333000 | \e +.br + cdrecord dev=b,t,l \-dao tsize=333000s \- +.PP +To create a HFS hybrid CD with the Joliet and Rock Ridge extensions of +the source directory +.IR cd_dir : +.PP +% mkisofs \-o cd.iso \-R \-J \-hfs cd_dir +.PP +To create a HFS hybrid CD from the source directory +.I cd_dir +that contains +Netatalk Apple/Unix files: +.PP +% mkisofs \-o cd.iso \-\-netatalk cd_dir +.PP +To create a HFS hybrid CD from the source directory +.IR cd_dir , +giving all files +CREATOR and TYPES based on just their filename extensions listed in the file +"mapping".: +.PP +% mkisofs \-o cd.iso \-map mapping cd_dir +.PP +To create a CD with the 'Apple Extensions to ISO-9660', from the source +directories +.I cd_dir +and +.IR another_dir. +Files in all the known Apple/Unix format +are decoded and any other files are given CREATOR and TYPE based on their +magic number given in the file "magic": +.PP +% mkisofs \-o cd.iso \-apple \-magic magic \-probe \e +.br + cd_dir another_dir +.PP +The following example puts different files on the CD that all have +the name README, but have different contents when seen as a +ISO-9660/RockRidge, Joliet or HFS CD. +.PP +Current directory contains: +.PP +% ls \-F +.br +README.hfs README.joliet README.unix cd_dir/ +.PP +The following command puts the contents of the directory +.I cd_dir +on the +CD along with the three README files - but only one will be seen from +each of the three filesystems: +.PP +% mkisofs \-o cd.iso \-hfs \-J \-r \-graft\-points \e +.br + \-hide README.hfs \-hide README.joliet \e +.br + \-hide\-joliet README.hfs \-hide\-joliet README.unix \e +.br + \-hide\-hfs README.joliet \-hide\-hfs README.unix \e +.br + README=README.hfs README=README.joliet \e +.br + README=README.unix cd_dir +.PP +i.e. the file README.hfs will be seen as README on the HFS CD and the +other two README files will be hidden. Similarly for the Joliet and +ISO-9660/RockRidge CD. +.PP +There are probably all sorts of strange results possible with +combinations of the hide options ... +.PP +To create a DVD-Audio of the DVD-Audio compliant source directory +.IR DVD : +.PP +% mkisofs \-o dvda.iso \-dvd\-audio DVD + +.SH AUTHOR +.br +Eric Youngdale <ericy@gnu.ai.mit.edu> or <eric@andante.org> wrote the +first versions (1993 .\|.\|. 1998) of the m\&kisofs utility. +The copyright for old versions of the m\&kisofs utility is held by +Yggdrasil Computing, Incorporated. +J\*org Schilling wrote the SCSI transport library and its adaptation layer to +.B mkisofs +and newer parts (starting from 1997) of the utility. +J\*org Schilling is the primary maintainer since 1999, this makes +.B mkisofs +Copyright (C) 1997-2014 J\*org Schilling. +.PP +HFS hybrid code Copyright (C) James Pearson 1997 .\|.\|. 2001. +.sp +libhfs code Copyright (C) 1996, 1997 Robert Leslie. +.sp +libfile code Copyright (C) Ian F. Darwin 1986, 1987, 1989, 1990, 1991, +1992, 1994, 1995. +.SH NOTES +.PP +.B Mkisofs +may safely be installed suid root. This may be needed to allow +.B mkisofs +to read the previous session when creating a multi session image. +.PP +.B m\&kisofs +is not based on the standard mk*fs tools for unix, because we must generate +a complete copy of an existing filesystem on a disk in the ISO-9660 +filesystem. The name m\&kisofs is probably a bit of a misnomer, since it +not only creates the filesystem, but it also populates it as well. +However, the appropriate tool name for a UNIX tool that creates populated +filesystems - +.B mkproto +- is not well known. +.PP +If +.B mkisofs +is creating a filesystem image with Rock Ridge attributes and the +directory nesting level of the source directory tree is too much +for ISO-9660, +.B mkisofs +will do deep directory relocation. +This results in a directory called +.B RR_MOVED +in the root directory of the CD. You cannot avoid this directory in the +directory tree that is visible with ISO-9660 but it it automatically hidden +in the +.B Rock Ridge +tree. +.PP +The sparc boot support that is implemented with the +.B \-sparc\-boot +options completely follows the official Sparc CD boot requirements from +the Boot prom in Sun Sparc systems. Some Linux distributions for Sparc +systems use a boot loader called +.B SILO +that unfortunately is not Sparc CD boot compliant. +It is annoyingly to see that the Authors of SILO don't fix SILO but instead +provide a completely unneeded "patch" to mkisofs that incorporates far +more source than the fix for SILO would need. +.SH BUGS +.TP +\(bu +Does not properly read relocated directories in multi-session +mode when adding data. +.sp +Any relocated deep directory is lost if the new session does not +include the deep directory. +.sp +Repeat by: create first session with deep directory relocation +then add new session with a single dir that differs from the +old deep path. +.TP +\(bu +Does not re-use RR_MOVED when doing multi-session from TRANS.TBL +.PP +There may be some other ones. Please, report them to the author. + +.SH "HFS PROBLEMS/LIMITATIONS +I have had to make several assumptions on how I expect the modified +libhfs routines to work, however there may be situations that either +I haven't thought of, or come across when these assumptions fail. +Therefore I can't guarantee that mkisofs will work as expected +(although I haven't had a major problem yet). Most of the HFS features work +fine, however, some are not fully tested. These are marked as +.I Alpha +above. +.PP +Although HFS filenames appear to support upper and lower case letters, +the filesystem is case insensitive. i.e. the filenames "aBc" and "AbC" +are the same. If a file is found in a directory with the same HFS name, then +.I mkisofs +will attempt, where possible, to make a unique name by adding '_' characters +to one of the filenames. +.PP +HFS file/directory names that share the first 31 characters have +_N' (N == decimal number) substituted for the last few characters +to generate unique names. +.PP +Care must be taken when "grafting" Apple/Unix files or directories (see +above for the method and syntax involved). It is not possible to use a +new name for an Apple/Unix encoded file/directory. e.g. If a Apple/Unix +encoded file called "oldname" is to added to the CD, then you can not use +the command line: +.IP +mkisofs \-o output.raw \-hfs \-graft\-points newname=oldname cd_dir +.LP +mkisofs will be unable to decode "oldname". However, you can graft +Apple/Unix encoded files or directories as long as you do not attempt to +give them new names as above. +.PP +When creating an HFS volume with the multisession options, +.B \-M +and +.BR \-C , +only files in the last session will be in the HFS volume. i.e. mkisofs can +not +.I add +existing files from previous sessions to the HFS volume. +.PP +However, if each session is created with the +.B \-part +option, then each session will appear as +separate volumes when mounted on a Mac. In this case, it is worth using the +.B \-V +or +.B \-hfs\-volid +option to give each session a unique volume name, +otherwise each "volume" will appear on the Desktop with the same name. +.PP +Symbolic links (as with all other non-regular files) are not added to +the HFS directory. +.PP +Hybrid volumes may be larger than pure ISO-9660 volumes +containing the same data. In some cases (e.g. DVD sized volumes) the hybrid +volume may be significantly larger. As an HFS volume gets bigger, so does the +allocation block size (the smallest amount of space a file can occupy). +For a 650Mb CD, the allocation block is 10Kb, for a 4.7Gb DVD it will be +about 70Kb. +.PP +The maximum number of files in an HFS volume is about 65500 - although +the real limit will be somewhat less than this. +.PP +The resulting hybrid volume can be accessed on a Unix machine by using +the hfsutils routines. However, no changes can be made to the volume as it +is set as +.B locked. +The option +.B \-hfs\-unlock +will create an output image that is unlocked - however no changes should be +made to the contents of the volume (unless you really know what you are +doing) as it's not a "real" HFS volume. +.PP +Using the +.B \-mac\-name +option will not currently work with the +.B \-T +option - the Unix +name will be used in the TRANS.TBL file, not the Macintosh name. +.PP +Although +.B mkisofs +does not alter the contents of a file, if a binary file has its TYPE +set as 'TEXT', it +.I may +be read incorrectly on a Macintosh. Therefore a better choice for the +default TYPE may be '????' +.PP +The +.B \-mac\-boot\-file +option may not work at all... +.PP +May not work with PC Exchange v2.2 or higher files (available with MacOS 8.1). +DOS media containing PC Exchange files should be mounted as type +.B msdos +(not +.BR vfat ) +when using Linux. +.PP +The SFM format is only partially supported - see +.B HFS MACINTOSH FILE FORMATS +section above. +.PP +It is not possible to use the the +.B \-sparc\-boot +or +.B \-generic\-boot +options with the +.B \-boot\-hfs\-file +the +.B \-prep\-boot +or +.B \-chrp\-boot +options. +.PP +.B mkisofs +should be able to create HFS hybrid images over 4Gb, although this has not +been fully tested. + +.SH "SEE ALSO +.BR cdrecord (1), +.BR mkzftree (1), +.BR sfind (1), +.BR magic (5), +.BR apple_driver (8). + +.SH "FUTURE IMPROVEMENTS +Some sort of gui interface. +.SH AVAILABILITY +.B m\&kisofs +is available as part of the cdrecord package from +https://sourceforge.net/projects/cdrtools/files/ + +.B hfsutils +from ftp://ftp.mars.org/pub/hfs + +.B mkzftree +is available as part of the zisofs-tools package +from ftp://ftp.kernel.org/pub/linux/utils/fs/zisofs/ +.SH "MAILING LISTS +If you want to actively take part on the development of mkisofs, +you may join the developer mailing list via this URL: +.sp +.B +https://lists.sourceforge.net/lists/listinfo/cdrtools-developers + +.SH MAINTAINER +.nf +J\*org Schilling +Seestr. 110 +D-13353 Berlin +Germany +.fi +.SH "HFS MKHYBRID MAINTAINER +James Pearson +.PP +j.pearson@ge.ucl.ac.uk + +.PP +If you have support questions, send them to: +.PP +.B +cdrtools-support@lists.sourceforge.net +.PP +If you definitely found a bug, send a mail to: +.PP +.B +cdrtools-developers@lists.sourceforge.net +.br +or +.B +joerg.schilling@fokus.fraunhofer.de +.PP +To subscribe, use: +.PP +.B +https://lists.sourceforge.net/lists/listinfo/cdrtools-developers +.br +or +.B +https://lists.sourceforge.net/lists/listinfo/cdrtools-support +.br +.ne 7 +.SH "INTERFACE STABILITY +The interfaces provided by +.B mkisofs +are designed for long term stability. +As +.B mkisofs +depends on interfaces provided by the underlying operating system, +the stability of the interfaces offered by +.B mkisofs +depends on the interface stability of the OS interfaces. +Modified interfaces in the OS may enforce modified interfaces +in +.BR mkisofs . diff --git a/upstream/opensuse-leap-15-6/man8/mklost+found.8 b/upstream/opensuse-leap-15-6/man8/mklost+found.8 new file mode 100644 index 00000000..54e39f90 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/mklost+found.8 @@ -0,0 +1,43 @@ +.\" -*- 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 MKLOST+FOUND 8 "February 2023" "E2fsprogs version 1.47.0" +.SH NAME +mklost+found \- create a lost+found directory on a mounted Linux +second extended file system +.SH SYNOPSIS +.B mklost+found +.SH DESCRIPTION +.B mklost+found +is used to create a +.I lost+found +directory in the current working directory on a Linux second extended +file system. There is normally a +.I lost+found +directory in the root directory of each file system. +.PP +.B mklost+found +pre-allocates disk blocks to the +.I lost+found +directory so that when +.BR e2fsck (8) +is being run to recover a file system, it does not need to allocate blocks in +the file system to store a large number of unlinked files. This ensures that +.B e2fsck +will not have to allocate data blocks in the file system during recovery. +.SH OPTIONS +There are none. +.SH AUTHOR +.B mklost+found +has been written by Remy Card <Remy.Card@linux.org>. It is currently being +maintained by Theodore Ts'o <tytso@alum.mit.edu>. +.SH BUGS +There are none :-) +.SH AVAILABILITY +.B mklost+found +is part of the e2fsprogs package and is available from +http://e2fsprogs.sourceforge.net. +.SH SEE ALSO +.BR e2fsck (8), +.BR mke2fs (8) diff --git a/upstream/opensuse-leap-15-6/man8/mkreiserfs.8 b/upstream/opensuse-leap-15-6/man8/mkreiserfs.8 new file mode 100644 index 00000000..1395daf7 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/mkreiserfs.8 @@ -0,0 +1,115 @@ +.\" -*- nroff -*- +.\" Copyright 1996-2004 Hans Reiser. +.\" +.TH MKREISERFS 8 "January 2009" "Reiserfsprogs-3.6.27" +.SH NAME +mkreiserfs \- The create tool for the Linux ReiserFS filesystem. +.SH SYNOPSIS +.B mkreiserfs +[ \fB-dfV\fR ] +[ \fB-b\fR | \fB--block-size \fIN\fR ] +[ \fB-h\fR | \fB--hash \fIHASH\fR ] +[ \fB-u\fR | \fB--uuid \fIUUID\fR ] +[ \fB-l\fR | \fB--label \fILABEL\fR ] +[ \fB--format \fIFORMAT\fR ] +[ \fB-q\fR | \fB--quiet\fR ] +[ \fB-j\fR | \fB--journal-device \fIFILE\fR ] +[ \fB-s\fR | \fB--journal-size \fIN\fR ] +[ \fB-o\fR | \fB--journal-offset \fIN\fR ] +[ \fB-t\fR | \fB--transaction-max-size\fR \fIN\fR ] +[ \fB-B\fR | \fB--badblocks\fR \fIfile\fR ] \fI device\fR +[ \fIfilesystem-size\fR ] +.SH DESCRIPTION +\fBmkreiserfs\fR creates a Linux ReiserFS filesystem on a device (usually a disk +partition). +.TP +.I device +is the special file corresponding to a device or to a partition (e.g +/dev/hdXX for an IDE disk partition or /dev/sdXX for a SCSI disk partition). +.TP +.I filesystem-size +is the size in blocks of the filesystem. If omitted, \fBmkreiserfs\fR will +automatically set it. +.SH OPTIONS +.TP +\fB-b\fR | \fB--block-size \fIN\fR +\fIN\fR is block size in bytes. It may only be set to a power of 2 within the +512-8192 interval. +.TP +\fB-h\fR | \fB--hash \fIHASH\fR +\fIHASH\fR specifies which hash function will sort the names in the directories. +Choose from r5, rupasov, or tea. r5 is the default one. +.TP +\fB--format \fIFORMAT\fR +\fIFORMAT\fR specifies the format for the new filsystem. Choose format 3.5 or +3.6. If none is specified \fBmkreiserfs\fR will create format 3.6 if running +kernel is 2.4 or higher, and format 3.5 if kernel 2.2 is running, and will +refuse creation under all other kernels. +.TP +\fB-u\fR | \fB--uuid \fIUUID\fR +Sets the Universally Unique IDentifier of the filesystem to \fIUUID\fR +(see also \fBuuidgen(8)\fR). The format of the \fIUUID\fR is a series +of hex digits separated by hypthens, e.g.: "c1b9d5a2-f162-11cf-9ece-0020afc76f16". +If the option is skipped, \fBmkreiserfs\fR will by default generate a new +\fIUUID\fR. +.TP +\fB-l\fR | \fB--label \fILABEL\fR +Sets the volume label of the filesystem. \fILABEL\fR can at most be 16 +characters long; if it is longer than 16 characters, \fBmkreiserfs\fR will +truncate it. +.TP +\fB-q\fR | \fB--quiet \fR +Sets \fBmkreiserfs\fR to work quietly without producing messages, progress or +questions. It is useful, but only for use by end users, if you run \fBmkreiserfs\fR +in a script. +.TP +\fB-j\fR | \fB--journal-device \fIFILE\fR +\fIFILE\fR is the name of the block device on which is to be places the +filesystem journal. +.TP +\fB-o\fR | \fB--journal-offset \fIN\fR +\fIN\fR is the offset where the journal starts when it is to be on a separate +device. Default is 0. \fIN\fR has no effect when the journal is to be on the +host device. +.TP +\fB-s\fR | \fB--journal-size \fIN +\fIN\fR is the size of the journal in blocks. When the journal is to be on a +separate device, its size defaults to the number of blocks that the device has. +When journal is to be on the host device, its size defaults to 8193 and the +maximal possible size is 32749 (for blocksize 4k). The minimum size is 513 blocks +(whether the journal is on the host or on a separate device). +.TP +\fB-t\fR | \fB--transaction-max-size \fIN +\fIN\fR is the maximum transaction size parameter for the journal. The +default, and max possible, value is 1024 blocks. It should be less +than half the size of the journal. If specified incorrectly, it will automatically +be adjusted. +.TP +\fB-B\fR | \fB--badblocks \fIfile +\fIFile\fR is the file name of the file that contains the list of blocks to be +marked as bad on the filesystem. This list can be created by +\fB/sbin/badblocks \-b block-size device\fR. +.TP +\fB-f\fR +Forces \fBmkreiserfs\fR to continue even when the device is the whole disk, +looks mounted, or is not a block device. If \fB-f\fR is specified more than +once, it allows the user to avoid asking for confirmation. +.TP +\fB-d\fR +Sets \fBmkreiserfs\fR to print debugging information during \fBmkreiserfs\fR. +.TP +\fB-V\fR +Prints the version and then exits. + +.SH AUTHOR +This version of +.B mkreiserfs +has been written by Edward Shishkin <edward@namesys.com>. +.SH BUGS +Please report bugs to the ReiserFS developers <reiserfs-devel@vger.kernel.org>, providing +as much information as possible--your hardware, kernel, patches, settings, all printed +messages; check the syslog file for any related information. +.SH SEE ALSO +.BR reiserfsck (8), +.BR debugreiserfs (8), +.BR reiserfstune (8) diff --git a/upstream/opensuse-leap-15-6/man8/mkswap.8 b/upstream/opensuse-leap-15-6/man8/mkswap.8 new file mode 100644 index 00000000..816fe6d9 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/mkswap.8 @@ -0,0 +1,151 @@ +'\" t +.\" Title: mkswap +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "MKSWAP" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +mkswap \- set up a Linux swap area +.SH "SYNOPSIS" +.sp +\fBmkswap\fP [options] \fIdevice\fP [\fIsize\fP] +.SH "DESCRIPTION" +.sp +\fBmkswap\fP sets up a Linux swap area on a device or in a file. +.sp +The \fIdevice\fP argument will usually be a disk partition (something like \fI/dev/sdb7\fP) but can also be a file. The Linux kernel does not look at partition IDs, but many installation scripts will assume that partitions of hex type 82 (LINUX_SWAP) are meant to be swap partitions. (\fBWarning: Solaris also uses this type. Be careful not to kill your Solaris partitions.\fP) +.sp +The \fIsize\fP parameter is superfluous but retained for backwards compatibility. (It specifies the desired size of the swap area in 1024\-byte blocks. \fBmkswap\fP will use the entire partition or file if it is omitted. Specifying it is unwise \- a typo may destroy your disk.) +.sp +After creating the swap area, you need the \fBswapon\fP command to start using it. Usually swap areas are listed in \fI/etc/fstab\fP so that they can be taken into use at boot time by a \fBswapon \-a\fP command in some boot script. +.SH "WARNING" +.sp +The swap header does not touch the first block. A boot loader or disk label can be there, but it is not a recommended setup. The recommended setup is to use a separate partition for a Linux swap area. +.sp +\fBmkswap\fP, like many others mkfs\-like utils, \fBerases the first partition block to make any previous filesystem invisible.\fP +.sp +However, \fBmkswap\fP refuses to erase the first block on a device with a disk label (SUN, BSD, ...). +.SH "OPTIONS" +.sp +\fB\-c\fP, \fB\-\-check\fP +.RS 4 +Check the device (if it is a block device) for bad blocks before creating the swap area. If any bad blocks are found, the count is printed. +.RE +.sp +\fB\-f\fP, \fB\-\-force\fP +.RS 4 +Go ahead even if the command is stupid. This allows the creation of a swap area larger than the file or partition it resides on. +.sp +Also, without this option, \fBmkswap\fP will refuse to erase the first block on a device with a partition table. +.RE +.sp +\fB\-L\fP, \fB\-\-label\fP \fIlabel\fP +.RS 4 +Specify a \fIlabel\fP for the device, to allow \fBswapon\fP by label. +.RE +.sp +\fB\-\-lock\fP[=\fImode\fP] +.RS 4 +Use exclusive BSD lock for device or file it operates. The optional argument \fImode\fP can be \fByes\fP, \fBno\fP (or 1 and 0) or \fBnonblock\fP. If the \fImode\fP argument is omitted, it defaults to \fB"yes"\fP. This option overwrites environment variable \fB$LOCK_BLOCK_DEVICE\fP. The default is not to use any lock at all, but it\(cqs recommended to avoid collisions with udevd or other tools. +.RE +.sp +\fB\-p\fP, \fB\-\-pagesize\fP \fIsize\fP +.RS 4 +Specify the page \fIsize\fP (in bytes) to use. This option is usually unnecessary; \fBmkswap\fP reads the size from the kernel. +.RE +.sp +\fB\-U\fP, \fB\-\-uuid\fP \fIUUID\fP +.RS 4 +Specify the \fIUUID\fP to use. The default is to generate a UUID. +.RE +.sp +\fB\-v\fP, \fB\-\-swapversion 1\fP +.RS 4 +Specify the swap\-space version. (This option is currently pointless, as the old \fB\-v 0\fP option has become obsolete and now only \fB\-v 1\fP is supported. The kernel has not supported v0 swap\-space format since 2.5.22 (June 2002). The new version v1 is supported since 2.1.117 (August 1998).) +.RE +.sp +\fB\-\-verbose\fP +.RS 4 +Verbose execution. With this option \fBmkswap\fP will output more details about detected problems during swap area set up. +.RE +.sp +\fB\-h\fP, \fB\-\-help\fP +.RS 4 +Display help text and exit. +.RE +.sp +\fB\-V\fP, \fB\-\-version\fP +.RS 4 +Display version information and exit. +.RE +.SH "ENVIRONMENT" +.sp +LIBBLKID_DEBUG=all +.RS 4 +enables libblkid debug output. +.RE +.sp +LOCK_BLOCK_DEVICE=<mode> +.RS 4 +use exclusive BSD lock. The mode is "1" or "0". See \fB\-\-lock\fP for more details. +.RE +.SH "NOTES" +.sp +The maximum useful size of a swap area depends on the architecture and the kernel version. +.sp +The maximum number of the pages that is possible to address by swap area header is 4294967295 (32\-bit unsigned int). The remaining space on the swap device is ignored. +.sp +Presently, Linux allows 32 swap areas. The areas in use can be seen in the file \fI/proc/swaps\fP. +.sp +\fBmkswap\fP refuses areas smaller than 10 pages. +.sp +If you don\(cqt know the page size that your machine uses, you may be able to look it up with \fBcat /proc/cpuinfo\fP (or you may not \- the contents of this file depend on architecture and kernel version). +.sp +To set up a swap file, it is necessary to create that file before initializing it with \fBmkswap\fP, e.g. using a command like +.sp +.if n .RS 4 +.nf +.fam C +# dd if=/dev/zero of=swapfile bs=1MiB count=$((8*1024)) +.fam +.fi +.if n .RE +.sp +to create 8GiB swapfile. +.sp +Please read notes from \fBswapon\fP(8) about \fBthe swap file use restrictions\fP (holes, preallocation and copy\-on\-write issues). +.SH "SEE ALSO" +.sp +\fBfdisk\fP(8), +\fBswapon\fP(8) +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBmkswap\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/modinfo.8 b/upstream/opensuse-leap-15-6/man8/modinfo.8 new file mode 100644 index 00000000..b1471aac --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/modinfo.8 @@ -0,0 +1,129 @@ +'\" t +.\" Title: modinfo +.\" Author: Jon Masters <jcm@jonmasters.org> +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 01/29/2021 +.\" Manual: modinfo +.\" Source: kmod +.\" Language: English +.\" +.TH "MODINFO" "8" "01/29/2021" "kmod" "modinfo" +.\" ----------------------------------------------------------------- +.\" * 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" +modinfo \- Show information about a Linux Kernel module +.SH "SYNOPSIS" +.HP \w'\fBmodinfo\fR\ 'u +\fBmodinfo\fR [\fB\-0\fR] [\fB\-F\ \fR\fB\fIfield\fR\fR] [\fB\-k\ \fR\fB\fIkernel\fR\fR] [modulename|filename...] +.HP \w'\fBmodinfo\ \-V\fR\ 'u +\fBmodinfo \-V\fR +.HP \w'\fBmodinfo\ \-h\fR\ 'u +\fBmodinfo \-h\fR +.SH "DESCRIPTION" +.PP +\fBmodinfo\fR +extracts information from the Linux Kernel modules given on the command line\&. If the module name is not a filename, then the +/lib/modules/\fIversion\fR +directory is searched, as is also done by +\fBmodprobe\fR(8) +when loading kernel modules\&. +.PP +\fBmodinfo\fR +by default lists each attribute of the module in form +\fIfieldname\fR +: +\fIvalue\fR, for easy reading\&. The filename is listed the same way (although it\*(Aqs not really an attribute)\&. +.PP +This version of +\fBmodinfo\fR +can understand modules of any Linux Kernel architecture\&. +.SH "OPTIONS" +.PP +\fB\-V\fR, \fB\-\-version\fR +.RS 4 +Print the modinfo version\&. +.RE +.PP +\fB\-F\fR, \fB\-\-field\fR +.RS 4 +Only print this field value, one per line\&. This is most useful for scripts\&. Field names are case\-insensitive\&. Common fields (which may not be in every module) include +author, +description, +license, +parm, +depends, and +alias\&. There are often multiple +parm, +alias +and +depends +fields\&. The special field +filename +lists the filename of the module\&. +.RE +.PP +\fB\-b \fR\fB\fIbasedir\fR\fR, \fB\-\-basedir \fR\fB\fIbasedir\fR\fR +.RS 4 +Root directory for modules, +/ +by default\&. +.RE +.PP +\fB\-k \fR\fB\fIkernel\fR\fR +.RS 4 +Provide information about a kernel other than the running one\&. This is particularly useful for distributions needing to extract information from a newly installed (but not yet running) set of kernel modules\&. For example, you wish to find which firmware files are needed by various modules in a new kernel for which you must make an initrd/initramfs image prior to booting\&. +.RE +.PP +\fB\-0\fR, \fB\-\-null\fR +.RS 4 +Use the ASCII zero character to separate field values, instead of a new line\&. This is useful for scripts, since a new line can theoretically appear inside a field\&. +.RE +.PP +\fB\-a\fR \fB\-\-author\fR, \fB\-d\fR \fB\-\-description\fR, \fB\-l\fR \fB\-\-license\fR, \fB\-p\fR \fB\-\-parameters\fR, \fB\-n\fR \fB\-\-filename\fR +.RS 4 +These are shortcuts for the +\fB\-\-field\fR +flag\*(Aqs +author, +description, +license, +parm +and +filename +arguments, to ease the transition from the old modutils +\fBmodinfo\fR\&. +.RE +.SH "COPYRIGHT" +.PP +This manual page originally Copyright 2003, Rusty Russell, IBM Corporation\&. Maintained by Jon Masters and others\&. +.SH "SEE ALSO" +.PP +\fBmodprobe\fR(8) +.SH "AUTHORS" +.PP +\fBJon Masters\fR <\&jcm@jonmasters\&.org\&> +.RS 4 +Developer +.RE +.PP +\fBLucas De Marchi\fR <\&lucas\&.de\&.marchi@gmail\&.com\&> +.RS 4 +Developer +.RE diff --git a/upstream/opensuse-leap-15-6/man8/modprobe.8 b/upstream/opensuse-leap-15-6/man8/modprobe.8 new file mode 100644 index 00000000..7c8abc5d --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/modprobe.8 @@ -0,0 +1,286 @@ +'\" t +.\" Title: modprobe +.\" Author: Jon Masters <jcm@jonmasters.org> +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 01/29/2021 +.\" Manual: modprobe +.\" Source: kmod +.\" Language: English +.\" +.TH "MODPROBE" "8" "01/29/2021" "kmod" "modprobe" +.\" ----------------------------------------------------------------- +.\" * 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" +modprobe \- Add and remove modules from the Linux Kernel +.SH "SYNOPSIS" +.HP \w'\fBmodprobe\fR\ 'u +\fBmodprobe\fR [\fB\-v\fR] [\fB\-V\fR] [\fB\-C\ \fR\fB\fIconfig\-file\fR\fR] [\fB\-n\fR] [\fB\-i\fR] [\fB\-q\fR] [\fB\-b\fR] [\fImodulename\fR] [\fB\fImodule\ parameters\fR\fR...] +.HP \w'\fBmodprobe\fR\ 'u +\fBmodprobe\fR [\-r] [\fB\-v\fR] [\fB\-n\fR] [\fB\-i\fR] [\fB\fImodulename\fR\fR...] +.HP \w'\fBmodprobe\fR\ 'u +\fBmodprobe\fR [\-c] +.HP \w'\fBmodprobe\fR\ 'u +\fBmodprobe\fR [\-\-dump\-modversions] [\fIfilename\fR] +.SH "DESCRIPTION" +.PP +\fBmodprobe\fR +intelligently adds or removes a module from the Linux kernel: note that for convenience, there is no difference between _ and \- in module names (automatic underscore conversion is performed)\&. +\fBmodprobe\fR +looks in the module directory +/lib/modules/`uname \-r` +for all the modules and other files, except for the optional configuration files in the +/etc/modprobe\&.d +directory (see +\fBmodprobe.d\fR(5))\&. +\fBmodprobe\fR +will also use module options specified on the kernel command line in the form of <module>\&.<option> and blacklists in the form of modprobe\&.blacklist=<module>\&. +.PP +Note that unlike in 2\&.4 series Linux kernels (which are not supported by this tool) this version of +\fBmodprobe\fR +does not do anything to the module itself: the work of resolving symbols and understanding parameters is done inside the kernel\&. So module failure is sometimes accompanied by a kernel message: see +\fBdmesg\fR(8)\&. +.PP +\fBmodprobe\fR +expects an up\-to\-date +modules\&.dep\&.bin +file as generated by the corresponding +\fBdepmod\fR +utility shipped along with +\fBmodprobe\fR +(see +\fBdepmod\fR(8))\&. This file lists what other modules each module needs (if any), and +\fBmodprobe\fR +uses this to add or remove these dependencies automatically\&. +.PP +If any arguments are given after the +\fImodulename\fR, they are passed to the kernel (in addition to any options listed in the configuration file)\&. +.SH "OPTIONS" +.PP +\fB\-a\fR, \fB\-\-all\fR +.RS 4 +Insert all module names on the command line\&. +.RE +.PP +\fB\-b\fR, \fB\-\-use\-blacklist\fR +.RS 4 +This option causes +\fBmodprobe\fR +to apply the +\fBblacklist\fR +commands in the configuration files (if any) to module names as well\&. It is usually used by +\fBudev\fR(7)\&. +.RE +.PP +\fB\-C\fR, \fB\-\-config\fR +.RS 4 +This option overrides the default configuration directory (/etc/modprobe\&.d)\&. +.sp +This option is passed through +\fBinstall\fR +or +\fBremove\fR +commands to other +\fBmodprobe\fR +commands in the MODPROBE_OPTIONS environment variable\&. +.RE +.PP +\fB\-c\fR, \fB\-\-showconfig\fR +.RS 4 +Dump out the effective configuration from the config directory and exit\&. +.RE +.PP +\fB\-\-dump\-modversions\fR +.RS 4 +Print out a list of module versioning information required by a module\&. This option is commonly used by distributions in order to package up a Linux kernel module using module versioning deps\&. +.RE +.PP +\fB\-d\fR, \fB\-\-dirname\fR +.RS 4 +Root directory for modules, +/ +by default\&. +.RE +.PP +\fB\-\-first\-time\fR +.RS 4 +Normally, +\fBmodprobe\fR +will succeed (and do nothing) if told to insert a module which is already present or to remove a module which isn\*(Aqt present\&. This is ideal for simple scripts; however, more complicated scripts often want to know whether +\fBmodprobe\fR +really did something: this option makes modprobe fail in the case that it actually didn\*(Aqt do anything\&. +.RE +.PP +\fB\-\-force\-vermagic\fR +.RS 4 +Every module contains a small string containing important information, such as the kernel and compiler versions\&. If a module fails to load and the kernel complains that the "version magic" doesn\*(Aqt match, you can use this option to remove it\&. Naturally, this check is there for your protection, so using this option is dangerous unless you know what you\*(Aqre doing\&. +.sp +This applies to any modules inserted: both the module (or alias) on the command line and any modules on which it depends\&. +.RE +.PP +\fB\-\-force\-modversion\fR +.RS 4 +When modules are compiled with CONFIG_MODVERSIONS set, a section detailing the versions of every interfaced used by (or supplied by) the module is created\&. If a module fails to load and the kernel complains that the module disagrees about a version of some interface, you can use "\-\-force\-modversion" to remove the version information altogether\&. Naturally, this check is there for your protection, so using this option is dangerous unless you know what you\*(Aqre doing\&. +.sp +This applies any modules inserted: both the module (or alias) on the command line and any modules on which it depends\&. +.RE +.PP +\fB\-f\fR, \fB\-\-force\fR +.RS 4 +Try to strip any versioning information from the module which might otherwise stop it from loading: this is the same as using both +\fB\-\-force\-vermagic\fR +and +\fB\-\-force\-modversion\fR\&. Naturally, these checks are there for your protection, so using this option is dangerous unless you know what you are doing\&. +.sp +This applies to any modules inserted: both the module (or alias) on the command line and any modules it on which it depends\&. +.RE +.PP +\fB\-i\fR, \fB\-\-ignore\-install\fR, \fB\-\-ignore\-remove\fR +.RS 4 +This option causes +\fBmodprobe\fR +to ignore +\fBinstall\fR +and +\fBremove\fR +commands in the configuration file (if any) for the module specified on the command line (any dependent modules are still subject to commands set for them in the configuration file)\&. Both +\fBinstall\fR +and +\fBremove\fR +commands will currently be ignored when this option is used regardless of whether the request was more specifically made with only one or other (and not both) of +\fB\-\-ignore\-install\fR +or +\fB\-\-ignore\-remove\fR\&. See +\fBmodprobe.d\fR(5)\&. +.RE +.PP +\fB\-n\fR, \fB\-\-dry\-run\fR, \fB\-\-show\fR +.RS 4 +This option does everything but actually insert or delete the modules (or run the install or remove commands)\&. Combined with +\fB\-v\fR, it is useful for debugging problems\&. For historical reasons both +\fB\-\-dry\-run\fR +and +\fB\-\-show\fR +actually mean the same thing and are interchangeable\&. +.RE +.PP +\fB\-q\fR, \fB\-\-quiet\fR +.RS 4 +With this flag, +\fBmodprobe\fR +won\*(Aqt print an error message if you try to remove or insert a module it can\*(Aqt find (and isn\*(Aqt an alias or +\fBinstall\fR/\fBremove\fR +command)\&. However, it will still return with a non\-zero exit status\&. The kernel uses this to opportunistically probe for modules which might exist using request_module\&. +.RE +.PP +\fB\-R\fR, \fB\-\-resolve\-alias\fR +.RS 4 +Print all module names matching an alias\&. This can be useful for debugging module alias problems\&. +.RE +.PP +\fB\-r\fR, \fB\-\-remove\fR +.RS 4 +This option causes +\fBmodprobe\fR +to remove rather than insert a module\&. If the modules it depends on are also unused, +\fBmodprobe\fR +will try to remove them too\&. Unlike insertion, more than one module can be specified on the command line (it does not make sense to specify module parameters when removing modules)\&. +.sp +There is usually no reason to remove modules, but some buggy modules require it\&. Your distribution kernel may not have been built to support removal of modules at all\&. +.RE +.PP +\fB\-S\fR, \fB\-\-set\-version\fR +.RS 4 +Set the kernel version, rather than using +\fBuname\fR(2) +to decide on the kernel version (which dictates where to find the modules)\&. +.RE +.PP +\fB\-\-show\-depends\fR +.RS 4 +List the dependencies of a module (or alias), including the module itself\&. This produces a (possibly empty) set of module filenames, one per line, each starting with "insmod" and is typically used by distributions to determine which modules to include when generating initrd/initramfs images\&. +\fBInstall\fR +commands which apply are shown prefixed by "install"\&. It does not run any of the install commands\&. Note that +\fBmodinfo\fR(8) +can be used to extract dependencies of a module from the module itself, but knows nothing of aliases or install commands\&. +.RE +.PP +\fB\-s\fR, \fB\-\-syslog\fR +.RS 4 +This option causes any error messages to go through the syslog mechanism (as LOG_DAEMON with level LOG_NOTICE) rather than to standard error\&. This is also automatically enabled when stderr is unavailable\&. +.sp +This option is passed through +\fBinstall\fR +or +\fBremove\fR +commands to other +\fBmodprobe\fR +commands in the MODPROBE_OPTIONS environment variable\&. +.RE +.PP +\fB\-V\fR, \fB\-\-version\fR +.RS 4 +Show version of program and exit\&. +.RE +.PP +\fB\-v\fR, \fB\-\-verbose\fR +.RS 4 +Print messages about what the program is doing\&. Usually +\fBmodprobe\fR +only prints messages if something goes wrong\&. +.sp +This option is passed through +\fBinstall\fR +or +\fBremove\fR +commands to other +\fBmodprobe\fR +commands in the MODPROBE_OPTIONS environment variable\&. +.RE +.SH "ENVIRONMENT" +.PP +The MODPROBE_OPTIONS environment variable can also be used to pass arguments to +\fBmodprobe\fR\&. +.SH "COPYRIGHT" +.PP +This manual page originally Copyright 2002, Rusty Russell, IBM Corporation\&. Maintained by Jon Masters and others\&. +.SH "SEE ALSO" +.PP +\fBmodprobe.d\fR(5), +\fBinsmod\fR(8), +\fBrmmod\fR(8), +\fBlsmod\fR(8), +\fBmodinfo\fR(8) +\fBdepmod\fR(8) +.SH "AUTHORS" +.PP +\fBJon Masters\fR <\&jcm@jonmasters\&.org\&> +.RS 4 +Developer +.RE +.PP +\fBRobby Workman\fR <\&rworkman@slackware\&.com\&> +.RS 4 +Developer +.RE +.PP +\fBLucas De Marchi\fR <\&lucas\&.de\&.marchi@gmail\&.com\&> +.RS 4 +Developer +.RE diff --git a/upstream/opensuse-leap-15-6/man8/mount.8 b/upstream/opensuse-leap-15-6/man8/mount.8 new file mode 100644 index 00000000..7ea8535b --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/mount.8 @@ -0,0 +1,2425 @@ +'\" t +.\" Title: mount +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "MOUNT" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +mount \- mount a filesystem +.SH "SYNOPSIS" +.sp +\fBmount\fP [\fB\-h\fP|\fB\-V\fP] +.sp +\fBmount\fP [\fB\-l\fP] [\fB\-t\fP \fIfstype\fP] +.sp +\fBmount\fP \fB\-a\fP [\fB\-fFnrsvw\fP] [\fB\-t\fP \fIfstype\fP] [\fB\-O\fP \fIoptlist\fP] +.sp +\fBmount\fP [\fB\-fnrsvw\fP] [\fB\-o\fP \fIoptions\fP] \fIdevice\fP|\fImountpoint\fP +.sp +\fBmount\fP [\fB\-fnrsvw\fP] [\fB\-t\fP \fIfstype\fP] [\fB\-o\fP \fIoptions\fP] \fIdevice mountpoint\fP +.sp +\fBmount\fP \fB\-\-bind\fP|\fB\-\-rbind\fP|\fB\-\-move\fP \fIolddir newdir\fP +.sp +\fBmount\fP \fB\-\-make\fP\-[\fBshared\fP|\fBslave\fP|\fBprivate\fP|\fBunbindable\fP|\fBrshared\fP|\fBrslave\fP|\fBrprivate\fP|\fBrunbindable\fP] \fImountpoint\fP +.SH "DESCRIPTION" +.sp +All files accessible in a Unix system are arranged in one big tree, the file hierarchy, rooted at \fI/\fP. These files can be spread out over several devices. The \fBmount\fP command serves to attach the filesystem found on some device to the big file tree. Conversely, the \fBumount\fP(8) command will detach it again. The filesystem is used to control how data is stored on the device or provided in a virtual way by network or other services. +.sp +The standard form of the \fBmount\fP command is: +.RS 3 +.ll -.6i +.sp +\fBmount \-t\fP \fItype device dir\fP +.br +.RE +.ll +.sp +This tells the kernel to attach the filesystem found on \fIdevice\fP (which is of type \fItype\fP) at the directory \fIdir\fP. The option \fB\-t\fP \fItype\fP is optional. The \fBmount\fP command is usually able to detect a filesystem. The root permissions are necessary to mount a filesystem by default. See section "Non\-superuser mounts" below for more details. The previous contents (if any) and owner and mode of \fIdir\fP become invisible, and as long as this filesystem remains mounted, the pathname \fIdir\fP refers to the root of the filesystem on \fIdevice\fP. +.sp +If only the directory or the device is given, for example: +.RS 3 +.ll -.6i +.sp +\fBmount /dir\fP +.br +.RE +.ll +.sp +then \fBmount\fP looks for a mountpoint (and if not found then for a device) in the \fI/etc/fstab\fP file. It\(cqs possible to use the \fB\-\-target\fP or \fB\-\-source\fP options to avoid ambiguous interpretation of the given argument. For example: +.RS 3 +.ll -.6i +.sp +\fBmount \-\-target /mountpoint\fP +.br +.RE +.ll +.sp +The same filesystem may be mounted more than once, and in some cases (e.g., network filesystems) the same filesystem may be mounted on the same mountpoint multiple times. The \fBmount\fP command does not implement any policy to control this behavior. All behavior is controlled by the kernel and it is usually specific to the filesystem driver. The exception is \fB\-\-all\fP, in this case already mounted filesystems are ignored (see \fB\-\-all\fP below for more details). +.SS "Listing the mounts" +.sp +The listing mode is maintained for backward compatibility only. +.sp +For more robust and customizable output use \fBfindmnt\fP(8), \fBespecially in your scripts\fP. Note that control characters in the mountpoint name are replaced with \(aq?\(aq. +.sp +The following command lists all mounted filesystems (of type \fItype\fP): +.RS 3 +.ll -.6i +.sp +\fBmount\fP [\fB\-l\fP] [\fB\-t\fP \fItype\fP] +.br +.RE +.ll +.sp +The option \fB\-l\fP adds labels to this listing. See below. +.SS "Indicating the device and filesystem" +.sp +Most devices are indicated by a filename (of a block special device), like \fI/dev/sda1\fP, but there are other possibilities. For example, in the case of an NFS mount, \fIdevice\fP may look like \fIknuth.cwi.nl:/dir\fP. +.sp +The device names of disk partitions are unstable; hardware reconfiguration, and adding or removing a device can cause changes in names. This is the reason why it\(cqs strongly recommended to use filesystem or partition identifiers like UUID or LABEL. Currently supported identifiers (tags): +.sp +LABEL=\fIlabel\fP +.RS 4 +Human readable filesystem identifier. See also \fB\-L\fP. +.RE +.sp +UUID=\fIuuid\fP +.RS 4 +Filesystem universally unique identifier. The format of the UUID is usually a series of hex digits separated by hyphens. See also \fB\-U\fP. +.sp +Note that \fBmount\fP uses UUIDs as strings. The UUIDs from the command line or from \fBfstab\fP(5) are not converted to internal binary representation. The string representation of the UUID should be based on lower case characters. +.RE +.sp +PARTLABEL=\fIlabel\fP +.RS 4 +Human readable partition identifier. This identifier is independent on filesystem and does not change by mkfs or mkswap operations It\(cqs supported for example for GUID Partition Tables (GPT). +.RE +.sp +PARTUUID=\fIuuid\fP +.RS 4 +Partition universally unique identifier. This identifier is independent on filesystem and does not change by mkfs or mkswap operations It\(cqs supported for example for GUID Partition Tables (GPT). +.RE +.sp +ID=\fIid\fP +.RS 4 +Hardware block device ID as generated by udevd. This identifier is usually based on WWN (unique storage identifier) and assigned by the hardware manufacturer. See \fBls /dev/disk/by\-id\fP for more details, this directory and running udevd is required. This identifier is not recommended for generic use as the identifier is not strictly defined and it depends on udev, udev rules and hardware. +.RE +.sp +The command \fBlsblk \-\-fs\fP provides an overview of filesystems, LABELs and UUIDs on available block devices. The command \fBblkid \-p <device>\fP provides details about a filesystem on the specified device. +.sp +Don\(cqt forget that there is no guarantee that UUIDs and labels are really unique, especially if you move, share or copy the device. Use \fBlsblk \-o +UUID,PARTUUID\fP to verify that the UUIDs are really unique in your system. +.sp +The recommended setup is to use tags (e.g. \fBUUID\fP=\fIuuid\fP) rather than \fI/dev/disk/by\-{label,uuid,id,partuuid,partlabel}\fP udev symlinks in the \fI/etc/fstab\fP file. Tags are more readable, robust and portable. The \fBmount\fP(8) command internally uses udev symlinks, so the use of symlinks in \fI/etc/fstab\fP has no advantage over tags. For more details see \fBlibblkid\fP(3). +.sp +The \fIproc\fP filesystem is not associated with a special device, and when mounting it, an arbitrary keyword \- for example, \fIproc\fP \- can be used instead of a device specification. (The customary choice \fInone\fP is less fortunate: the error message \(aqnone already mounted\(aq from \fBmount\fP can be confusing.) +.SS "The files /etc/fstab, /etc/mtab and /proc/mounts" +.sp +The file \fI/etc/fstab\fP (see \fBfstab\fP(5)), may contain lines describing what devices are usually mounted where, using which options. The default location of the \fBfstab\fP(5) file can be overridden with the \fB\-\-fstab\fP \fIpath\fP command\-line option (see below for more details). +.sp +The command +.RS 3 +.ll -.6i +.sp +\fBmount \-a\fP [\fB\-t\fP \fItype\fP] [\fB\-O\fP \fIoptlist\fP] +.br +.RE +.ll +.sp +(usually given in a bootscript) causes all filesystems mentioned in \fIfstab\fP (of the proper type and/or having or not having the proper options) to be mounted as indicated, except for those whose line contains the \fBnoauto\fP keyword. Adding the \fB\-F\fP option will make \fBmount\fP fork, so that the filesystems are mounted in parallel. +.sp +When mounting a filesystem mentioned in \fIfstab\fP or \fImtab\fP, it suffices to specify on the command line only the device, or only the mount point. +.sp +The programs \fBmount\fP and \fBumount\fP(8) traditionally maintained a list of currently mounted filesystems in the file \fI/etc/mtab\fP. The support for regular classic \fI/etc/mtab\fP is completely disabled at compile time by default, because on current Linux systems it is better to make \fI/etc/mtab\fP a symlink to \fI/proc/mounts\fP instead. The regular \fImtab\fP file maintained in userspace cannot reliably work with namespaces, containers and other advanced Linux features. If the regular \fImtab\fP support is enabled, then it\(cqs possible to use the file as well as the symlink. +.sp +If no arguments are given to \fBmount\fP, the list of mounted filesystems is printed. +.sp +If you want to override mount options from \fI/etc/fstab\fP, you have to use the \fB\-o\fP option: +.RS 3 +.ll -.6i +.sp +\fBmount\fP \fIdevice\fP*\fB*\fP|\fIdir\fP \fB\-o\fP \fIoptions\fP +.br +.RE +.ll +.sp +and then the mount options from the command line will be appended to the list of options from \fI/etc/fstab\fP. This default behaviour can be changed using the \fB\-\-options\-mode\fP command\-line option. The usual behavior is that the last option wins if there are conflicting ones. +.sp +The \fBmount\fP program does not read the \fI/etc/fstab\fP file if both \fIdevice\fP (or LABEL, UUID, ID, PARTUUID or PARTLABEL) and \fIdir\fP are specified. For example, to mount device \fBfoo\fP at \fB/dir\fP: +.RS 3 +.ll -.6i +.sp +\fBmount /dev/foo /dir\fP +.br +.RE +.ll +.sp +This default behaviour can be changed by using the \fB\-\-options\-source\-force\fP command\-line option to always read configuration from \fIfstab\fP. For non\-root users \fBmount\fP always reads the \fIfstab\fP configuration. +.SS "Non\-superuser mounts" +.sp +Normally, only the superuser can mount filesystems. However, when \fIfstab\fP contains the \fBuser\fP option on a line, anybody can mount the corresponding filesystem. +.sp +Thus, given a line +.RS 3 +.ll -.6i +.sp +\fB/dev/cdrom /cd iso9660 ro,user,noauto,unhide\fP +.br +.RE +.ll +.sp +any user can mount the iso9660 filesystem found on an inserted CDROM using the command: +.RS 3 +.ll -.6i +.sp +\fBmount /cd\fP +.br +.RE +.ll +.sp +Note that \fBmount\fP is very strict about non\-root users and all paths specified on command line are verified before \fIfstab\fP is parsed or a helper program is executed. It\(cqs strongly recommended to use a valid mountpoint to specify filesystem, otherwise \fBmount\fP may fail. For example it\(cqs a bad idea to use NFS or CIFS source on command line. +.sp +Since util\-linux 2.35, \fBmount\fP does not exit when user permissions are inadequate according to libmount\(cqs internal security rules. Instead, it drops suid permissions and continues as regular non\-root user. This behavior supports use\-cases where root permissions are not necessary (e.g., fuse filesystems, user namespaces, etc). +.sp +For more details, see \fBfstab\fP(5). Only the user that mounted a filesystem can unmount it again. If any user should be able to unmount it, then use \fBusers\fP instead of \fBuser\fP in the \fIfstab\fP line. The \fBowner\fP option is similar to the \fBuser\fP option, with the restriction that the user must be the owner of the special file. This may be useful e.g. for \fI/dev/fd\fP if a login script makes the console user owner of this device. The \fBgroup\fP option is similar, with the restriction that the user must be a member of the group of the special file. +.SS Blacklisted file systems +In the Linux kernel, file system types are implemented as kernel +modules. While many of these file systems are well maintained, +some of the older and less frequently used ones are not. This +poses a security risk, because maliciously crafted file system +images might open security holes when mounted either automatically +or by an inadvertent user. The +.B mount +command prints "unsupported file system type 'somefs'" in this case, +because it can't distinguish between a really unsupported file system +(kernel module non-existent) and a blacklisted file system. + +Users who need the blacklisted file systems and therefore want +to override the blacklisting can either load the blacklisted module +directly: +.RS + +.br +.BI "modprobe -v" " somefs" +.br + +.RE +or override the blacklist configuration by editing files under the +.I /etc/modprobe.d +directory. + +.SS "Bind mount operation" +.sp +Remount part of the file hierarchy somewhere else. The call is: +.RS 3 +.ll -.6i +.sp +\fBmount \-\-bind\fP \fIolddir newdir\fP +.br +.RE +.ll +.sp +or by using this \fIfstab\fP entry: +.RS 3 +.ll -.6i +.sp +\fB/\fP\fIolddir\fP \fB/\fP\fInewdir\fP \fBnone bind\fP +.br +.RE +.ll +.sp +After this call the same contents are accessible in two places. +.sp +It is important to understand that "bind" does not create any second\-class or special node in the kernel VFS. The "bind" is just another operation to attach a filesystem. There is nowhere stored information that the filesystem has been attached by a "bind" operation. The \fIolddir\fP and \fInewdir\fP are independent and the \fIolddir\fP may be unmounted. +.sp +One can also remount a single file (on a single file). It\(cqs also possible to use a bind mount to create a mountpoint from a regular directory, for example: +.RS 3 +.ll -.6i +.sp +\fBmount \-\-bind foo foo\fP +.br +.RE +.ll +.sp +The bind mount call attaches only (part of) a single filesystem, not possible submounts. The entire file hierarchy including submounts can be attached a second place by using: +.RS 3 +.ll -.6i +.sp +\fBmount \-\-rbind\fP \fIolddir newdir\fP +.br +.RE +.ll +.sp +Note that the filesystem mount options maintained by the kernel will remain the same as those on the original mount point. The userspace mount options (e.g., _netdev) will not be copied by \fBmount\fP and it\(cqs necessary to explicitly specify the options on the \fBmount\fP command line. +.sp +Since util\-linux 2.27 \fBmount\fP permits changing the mount options by passing the relevant options along with \fB\-\-bind\fP. For example: +.RS 3 +.ll -.6i +.sp +\fBmount \-o bind,ro foo foo\fP +.br +.RE +.ll +.sp +This feature is not supported by the Linux kernel; it is implemented in userspace by an additional \fBmount\fP(2) remounting system call. This solution is not atomic. +.sp +The alternative (classic) way to create a read\-only bind mount is to use the remount operation, for example: +.RS 3 +.ll -.6i +.sp +\fBmount \-\-bind\fP \fIolddir newdir\fP \fBmount \-o remount,bind,ro\fP \fIolddir newdir\fP +.br +.RE +.ll +.sp +Note that a read\-only bind will create a read\-only mountpoint (VFS entry), but the original filesystem superblock will still be writable, meaning that the \fIolddir\fP will be writable, but the \fInewdir\fP will be read\-only. +.sp +It\(cqs also possible to change nosuid, nodev, noexec, noatime, nodiratime and relatime VFS entry flags via a "remount,bind" operation. The other flags (for example filesystem\-specific flags) are silently ignored. It\(cqs impossible to change mount options recursively (for example with \fB\-o rbind,ro\fP). +.sp +Since util\-linux 2.31, \fBmount\fP ignores the \fBbind\fP flag from \fI/etc/fstab\fP on a \fBremount\fP operation (if "\-o remount" is specified on command line). This is necessary to fully control mount options on remount by command line. In previous versions the bind flag has been always applied and it was impossible to re\-define mount options without interaction with the bind semantic. This \fBmount\fP behavior does not affect situations when "remount,bind" is specified in the \fI/etc/fstab\fP file. +.SS "The move operation" +.sp +Move a \fBmounted tree\fP to another place (atomically). The call is: +.RS 3 +.ll -.6i +.sp +\fBmount \-\-move\fP \fIolddir newdir\fP +.br +.RE +.ll +.sp +This will cause the contents which previously appeared under \fIolddir\fP to now be accessible under \fInewdir\fP. The physical location of the files is not changed. Note that \fIolddir\fP has to be a mountpoint. +.sp +Note also that moving a mount residing under a shared mount is invalid and unsupported. Use \fBfindmnt \-o TARGET,PROPAGATION\fP to see the current propagation flags. +.SS "Shared subtree operations" +.sp +Since Linux 2.6.15 it is possible to mark a mount and its submounts as shared, private, slave or unbindable. A shared mount provides the ability to create mirrors of that mount such that mounts and unmounts within any of the mirrors propagate to the other mirror. A slave mount receives propagation from its master, but not vice versa. A private mount carries no propagation abilities. An unbindable mount is a private mount which cannot be cloned through a bind operation. The detailed semantics are documented in \fIDocumentation/filesystems/sharedsubtree.txt\fP file in the kernel source tree; see also \fBmount_namespaces\fP(7). +.sp +Supported operations are: +.sp +.if n .RS 4 +.nf +.fam C +mount \-\-make\-shared mountpoint +mount \-\-make\-slave mountpoint +mount \-\-make\-private mountpoint +mount \-\-make\-unbindable mountpoint +.fam +.fi +.if n .RE +.sp +The following commands allow one to recursively change the type of all the mounts under a given mountpoint. +.sp +.if n .RS 4 +.nf +.fam C +mount \-\-make\-rshared mountpoint +mount \-\-make\-rslave mountpoint +mount \-\-make\-rprivate mountpoint +mount \-\-make\-runbindable mountpoint +.fam +.fi +.if n .RE +.sp +\fBmount\fP(8) \fBdoes not read\fP \fBfstab\fP(5) when a \fB\-\-make\-\fP* operation is requested. All necessary information has to be specified on the command line. +.sp +Note that the Linux kernel does not allow changing multiple propagation flags with a single \fBmount\fP(2) system call, and the flags cannot be mixed with other mount options and operations. +.sp +Since util\-linux 2.23 the \fBmount\fP command can be used to do more propagation (topology) changes by one \fBmount\fP(8) call and do it also together with other mount operations. The propagation flags are applied by additional \fBmount\fP(2) system calls when the preceding mount operations were successful. Note that this use case is not atomic. It is possible to specify the propagation flags in \fBfstab\fP(5) as mount options (\fBprivate\fP, \fBslave\fP, \fBshared\fP, \fBunbindable\fP, \fBrprivate\fP, \fBrslave\fP, \fBrshared\fP, \fBrunbindable\fP). +.sp +For example: +.sp +.if n .RS 4 +.nf +.fam C +mount \-\-make\-private \-\-make\-unbindable /dev/sda1 /foo +.fam +.fi +.if n .RE +.sp +is the same as: +.sp +.if n .RS 4 +.nf +.fam C +mount /dev/sda1 /foo +mount \-\-make\-private /foo +mount \-\-make\-unbindable /foo +.fam +.fi +.if n .RE +.SH "COMMAND\-LINE OPTIONS" +.sp +The full set of mount options used by an invocation of \fBmount\fP is determined by first extracting the mount options for the filesystem from the \fIfstab\fP table, then applying any options specified by the \fB\-o\fP argument, and finally applying a \fB\-r\fP or \fB\-w\fP option, when present. +.sp +The \fBmount\fP command does not pass all command\-line options to the \fB/sbin/mount.\fP\fIsuffix\fP mount helpers. The interface between \fBmount\fP and the mount helpers is described below in the section \fBEXTERNAL HELPERS\fP. +.sp +Command\-line options available for the \fBmount\fP command are: +.sp +\fB\-a\fP, \fB\-\-all\fP +.RS 4 +Mount all filesystems (of the given types) mentioned in \fIfstab\fP (except for those whose line contains the \fBnoauto\fP keyword). The filesystems are mounted following their order in \fIfstab\fP. The \fBmount\fP command compares filesystem source, target (and fs root for bind mount or btrfs) to detect already mounted filesystems. The kernel table with already mounted filesystems is cached during \fBmount \-\-all\fP. This means that all duplicated \fIfstab\fP entries will be mounted. +.sp +The option \fB\-\-all\fP is possible to use for remount operation too. In this case all filters (\fB\-t\fP and \fB\-O\fP) are applied to the table of already mounted filesystems. +.sp +Since version 2.35 is possible to use the command line option \fB\-o\fP to alter mount options from \fIfstab\fP (see also \fB\-\-options\-mode\fP). +.sp +Note that it is a bad practice to use \fBmount \-a\fP for \fIfstab\fP checking. The recommended solution is \fBfindmnt \-\-verify\fP. +.RE +.sp +\fB\-B\fP, \fB\-\-bind\fP +.RS 4 +Remount a subtree somewhere else (so that its contents are available in both places). See above, under \fBBind mounts\fP. +.RE +.sp +\fB\-c\fP, \fB\-\-no\-canonicalize\fP +.RS 4 +Don\(cqt canonicalize paths. The \fBmount\fP command canonicalizes all paths (from the command line or \fIfstab\fP) by default. This option can be used together with the \fB\-f\fP flag for already canonicalized absolute paths. The option is designed for mount helpers which call \fBmount \-i\fP. It is strongly recommended to not use this command\-line option for normal mount operations. +.sp +Note that \fBmount\fP does not pass this option to the \fB/sbin/mount.\fP\fItype\fP helpers. +.RE +.sp +\fB\-F\fP, \fB\-\-fork\fP +.RS 4 +(Used in conjunction with \fB\-a\fP.) Fork off a new incarnation of \fBmount\fP for each device. This will do the mounts on different devices or different NFS servers in parallel. This has the advantage that it is faster; also NFS timeouts proceed in parallel. A disadvantage is that the order of the mount operations is undefined. Thus, you cannot use this option if you want to mount both \fI/usr\fP and \fI/usr/spool\fP. +.RE +.sp +\fB\-f, \-\-fake\fP +.RS 4 +Causes everything to be done except for the actual system call; if it\(cqs not obvious, this "fakes" mounting the filesystem. This option is useful in conjunction with the \fB\-v\fP flag to determine what the \fBmount\fP command is trying to do. It can also be used to add entries for devices that were mounted earlier with the \fB\-n\fP option. The \fB\-f\fP option checks for an existing record in \fI/etc/mtab\fP and fails when the record already exists (with a regular non\-fake mount, this check is done by the kernel). +.RE +.sp +\fB\-i, \-\-internal\-only\fP +.RS 4 +Don\(cqt call the \fB/sbin/mount.\fP\fIfilesystem\fP helper even if it exists. +.RE +.sp +\fB\-L\fP, \fB\-\-label\fP \fIlabel\fP +.RS 4 +Mount the partition that has the specified \fIlabel\fP. +.RE +.sp +\fB\-l\fP, \fB\-\-show\-labels\fP +.RS 4 +Add the labels in the mount output. \fBmount\fP must have permission to read the disk device (e.g. be set\-user\-ID root) for this to work. One can set such a label for ext2, ext3 or ext4 using the \fBe2label\fP(8) utility, or for XFS using \fBxfs_admin\fP(8), or for reiserfs using \fBreiserfstune\fP(8). +.RE +.sp +\fB\-M\fP, \fB\-\-move\fP +.RS 4 +Move a subtree to some other place. See above, the subsection \fBThe move operation\fP. +.RE +.sp +\fB\-n\fP, \fB\-\-no\-mtab\fP +.RS 4 +Mount without writing in \fI/etc/mtab\fP. This is necessary for example when \fI/etc\fP is on a read\-only filesystem. +.RE +.sp +\fB\-N\fP, \fB\-\-namespace\fP \fIns\fP +.RS 4 +Perform the mount operation in the mount namespace specified by \fIns\fP. \fIns\fP is either PID of process running in that namespace or special file representing that namespace. +.sp +\fBmount\fP switches to the mount namespace when it reads \fI/etc/fstab\fP, writes \fI/etc/mtab: (or writes to _/run/mount\fP) and calls the \fBmount\fP(2) system call, otherwise it runs in the original mount namespace. This means that the target namespace does not have to contain any libraries or other requirements necessary to execute the \fBmount\fP(2) call. +.sp +See \fBmount_namespaces\fP(7) for more information. +.RE +.sp +\fB\-O\fP, \fB\-\-test\-opts\fP \fIopts\fP +.RS 4 +Limit the set of filesystems to which the \fB\-a\fP option applies. In this regard it is like the \fB\-t\fP option except that \fB\-O\fP is useless without \fB\-a\fP. For example, the command +.sp +\fBmount \-a \-O no_netdev\fP +.sp +mounts all filesystems except those which have the option \fInetdev\fP specified in the options field in the \fI/etc/fstab\fP file. +.sp +It is different from \fB\-t\fP in that each option is matched exactly; a leading \fBno\fP at the beginning of one option does not negate the rest. +.sp +The \fB\-t\fP and \fB\-O\fP options are cumulative in effect; that is, the command +.sp +\fBmount \-a \-t ext2 \-O _netdev\fP +.sp +mounts all ext2 filesystems with the _netdev option, not all filesystems that are either ext2 or have the _netdev option specified. +.RE +.sp +\fB\-o\fP, \fB\-\-options\fP \fIopts\fP +.RS 4 +Use the specified mount options. The \fIopts\fP argument is a comma\-separated list. For example: +.sp +\fBmount LABEL=mydisk \-o noatime,nodev,nosuid\fP +.sp +For more details, see the \fBFILESYSTEM\-INDEPENDENT MOUNT OPTIONS\fP and \fBFILESYSTEM\-SPECIFIC MOUNT OPTIONS\fP sections. +.RE +.sp +\fB\-\-options\-mode\fP \fImode\fP +.RS 4 +Controls how to combine options from \fIfstab\fP/\fImtab\fP with options from the command line. \fImode\fP can be one of \fBignore\fP, \fBappend\fP, \fBprepend\fP or \fBreplace\fP. For example, \fBappend\fP means that options from \fIfstab\fP are appended to options from the command line. The default value is \fBprepend\fP \(em it means command line options are evaluated after \fIfstab\fP options. Note that the last option wins if there are conflicting ones. +.RE +.sp +\fB\-\-options\-source\fP \fIsource\fP +.RS 4 +Source of default options. \fIsource\fP is a comma\-separated list of \fBfstab\fP, \fBmtab\fP and \fBdisable\fP. \fBdisable\fP disables \fBfstab\fP and \fBmtab\fP and disables \fB\-\-options\-source\-force\fP. The default value is \fBfstab,mtab\fP. +.RE +.sp +\fB\-\-options\-source\-force\fP +.RS 4 +Use options from \fIfstab\fP/\fImtab\fP even if both \fIdevice\fP and \fIdir\fP are specified. +.RE +.sp +\fB\-R\fP, \fB\-\-rbind\fP +.RS 4 +Remount a subtree and all possible submounts somewhere else (so that its contents are available in both places). See above, the subsection \fBBind mounts\fP. +.RE +.sp +\fB\-r\fP, \fB\-\-read\-only\fP +.RS 4 +Mount the filesystem read\-only. A synonym is \fB\-o ro\fP. +.sp +Note that, depending on the filesystem type, state and kernel behavior, the system may still write to the device. For example, ext3 and ext4 will replay the journal if the filesystem is dirty. To prevent this kind of write access, you may want to mount an ext3 or ext4 filesystem with the \fBro,noload\fP mount options or set the block device itself to read\-only mode, see the \fBblockdev\fP(8) command. +.RE +.sp +\fB\-s\fP +.RS 4 +Tolerate sloppy mount options rather than failing. This will ignore mount options not supported by a filesystem type. Not all filesystems support this option. Currently it\(cqs supported by the \fBmount.nfs\fP mount helper only. +.RE +.sp +\fB\-\-source\fP \fIdevice\fP +.RS 4 +If only one argument for the \fBmount\fP command is given, then the argument might be interpreted as the target (mountpoint) or source (device). This option allows you to explicitly define that the argument is the mount source. +.RE +.sp +\fB\-\-target\fP \fIdirectory\fP +.RS 4 +If only one argument for the mount command is given, then the argument might be interpreted as the target (mountpoint) or source (device). This option allows you to explicitly define that the argument is the mount target. +.RE +.sp +\fB\-\-target\-prefix\fP \fIdirectory\fP +.RS 4 +Prepend the specified directory to all mount targets. This option can be used to follow \fIfstab\fP, but mount operations are done in another place, for example: +.sp +\fBmount \-\-all \-\-target\-prefix /chroot \-o X\-mount.mkdir\fP +.sp +mounts all from system \fIfstab\fP to \fI/chroot\fP, all missing mountpoint are created (due to X\-mount.mkdir). See also \fB\-\-fstab\fP to use an alternative \fIfstab\fP. +.RE +.sp +\fB\-T\fP, \fB\-\-fstab\fP \fIpath\fP +.RS 4 +Specifies an alternative \fIfstab\fP file. If \fIpath\fP is a directory, then the files in the directory are sorted by \fBstrverscmp\fP(3); files that start with "." or without an \fI.fstab\fP extension are ignored. The option can be specified more than once. This option is mostly designed for initramfs or chroot scripts where additional configuration is specified beyond standard system configuration. +.sp +Note that \fBmount\fP does not pass the option \fB\-\-fstab\fP to the \fB/sbin/mount.\fP\fItype\fP helpers, meaning that the alternative \fIfstab\fP files will be invisible for the helpers. This is no problem for normal mounts, but user (non\-root) mounts always require \fIfstab\fP to verify the user\(cqs rights. +.RE +.sp +\fB\-t\fP, \fB\-\-types\fP \fIfstype\fP +.RS 4 +The argument following the \fB\-t\fP is used to indicate the filesystem type. The filesystem types which are currently supported depend on the running kernel. See \fI/proc/filesystems\fP and \fI/lib/modules/$(uname \-r)/kernel/fs\fP for a complete list of the filesystems. The most common are ext2, ext3, ext4, xfs, btrfs, vfat, sysfs, proc, nfs and cifs. +.sp +The programs \fBmount\fP and \fBumount\fP(8) support filesystem subtypes. The subtype is defined by a \(aq.subtype\(aq suffix. For example \(aqfuse.sshfs\(aq. It\(cqs recommended to use subtype notation rather than add any prefix to the mount source (for example \(aqsshfs#example.com\(aq is deprecated). +.sp +If no \fB\-t\fP option is given, or if the \fBauto\fP type is specified, \fBmount\fP will try to guess the desired type. \fBmount\fP uses the \fBlibblkid\fP(3) library for guessing the filesystem type; if that does not turn up anything that looks familiar, \fBmount\fP will try to read the file \fI/etc/filesystems\fP, or, if that does not exist, \fI/proc/filesystems\fP. All of the filesystem types listed there will be tried, except for those that are labeled "nodev" (e.g. \fIdevpts\fP, \fIproc\fP and \fInfs\fP). If \fI/etc/filesystems\fP ends in a line with a single *, mount will read \fI/proc/filesystems\fP afterwards. While trying, all filesystem types will be mounted with the mount option \fBsilent\fP. +.sp +The \fBauto\fP type may be useful for user\-mounted floppies. Creating a file \fI/etc/filesystems\fP can be useful to change the probe order (e.g., to try vfat before msdos or ext3 before ext2) or if you use a kernel module autoloader. +.sp +More than one type may be specified in a comma\-separated list, for the \fB\-t\fP option as well as in an \fI/etc/fstab\fP entry. The list of filesystem types for the \fB\-t\fP option can be prefixed with \fBno\fP to specify the filesystem types on which no action should be taken. The prefix \fBno\fP has no effect when specified in an \fI/etc/fstab\fP entry. +.sp +The prefix \fBno\fP can be meaningful with the \fB\-a\fP option. For example, the command +.sp +\fBmount \-a \-t nomsdos,smbfs\fP +.sp +mounts all filesystems except those of type \fImsdos\fP and \fIsmbfs\fP. +.sp +For most types all the \fBmount\fP program has to do is issue a simple \fBmount\fP(2) system call, and no detailed knowledge of the filesystem type is required. For a few types however (like nfs, nfs4, cifs, smbfs, ncpfs) an ad hoc code is necessary. The nfs, nfs4, cifs, smbfs, and ncpfs filesystems have a separate mount program. In order to make it possible to treat all types in a uniform way, \fBmount\fP will execute the program \fB/sbin/mount.\fP\fItype\fP (if that exists) when called with type \fItype\fP. Since different versions of the \fBsmbmount\fP program have different calling conventions, \fB/sbin/mount.smbfs\fP may have to be a shell script that sets up the desired call. +.RE +.sp +\fB\-U\fP, \fB\-\-uuid\fP \fIuuid\fP +.RS 4 +Mount the partition that has the specified \fIuuid\fP. +.RE +.sp +\fB\-v\fP, \fB\-\-verbose\fP +.RS 4 +Verbose mode. +.RE +.sp +\fB\-w\fP, \fB\-\-rw\fP, \fB\-\-read\-write\fP +.RS 4 +Mount the filesystem read/write. Read\-write is the kernel default and the \fBmount\fP default is to try read\-only if the previous mount syscall with read\-write flags on write\-protected devices of filesystems failed. +.sp +A synonym is \fB\-o rw\fP. +.sp +Note that specifying \fB\-w\fP on the command line forces \fBmount\fP to never try read\-only mount on write\-protected devices or already mounted read\-only filesystems. +.RE +.sp +\fB\-V\fP, \fB\-\-version\fP +.RS 4 +Display version information and exit. +.RE +.sp +\fB\-h\fP, \fB\-\-help\fP +.RS 4 +Display help text and exit. +.RE +.SH "FILESYSTEM\-INDEPENDENT MOUNT OPTIONS" +.sp +Some of these options are only useful when they appear in the \fI/etc/fstab\fP file. +.sp +Some of these options could be enabled or disabled by default in the system kernel. To check the current setting see the options in \fI/proc/mounts\fP. Note that filesystems also have per\-filesystem specific default mount options (see for example \fBtune2fs \-l\fP output for ext_N_ filesystems). +.sp +The following options apply to any filesystem that is being mounted (but not every filesystem actually honors them \- e.g., the \fBsync\fP option today has an effect only for ext2, ext3, ext4, fat, vfat, ufs and xfs): +.sp +\fBasync\fP +.RS 4 +All I/O to the filesystem should be done asynchronously. (See also the \fBsync\fP option.) +.RE +.sp +\fBatime\fP +.RS 4 +Do not use the \fBnoatime\fP feature, so the inode access time is controlled by kernel defaults. See also the descriptions of the \fBrelatime\fP and \fBstrictatime\fP mount options. +.RE +.sp +\fBnoatime\fP +.RS 4 +Do not update inode access times on this filesystem (e.g. for faster access on the news spool to speed up news servers). This works for all inode types (directories too), so it implies \fBnodiratime\fP. +.RE +.sp +\fBauto\fP +.RS 4 +Can be mounted with the \fB\-a\fP option. +.RE +.sp +\fBnoauto\fP +.RS 4 +Can only be mounted explicitly (i.e., the \fB\-a\fP option will not cause the filesystem to be mounted). +.RE +.sp +\fBcontext=\fP\fIcontext\fP, \fBfscontext=\fP\fIcontext\fP, \fBdefcontext=\fP\fIcontext\fP, and \fBrootcontext=\fP\fIcontext\fP +.RS 4 +The \fBcontext=\fP option is useful when mounting filesystems that do not support extended attributes, such as a floppy or hard disk formatted with VFAT, or systems that are not normally running under SELinux, such as an ext3 or ext4 formatted disk from a non\-SELinux workstation. You can also use \fBcontext=\fP on filesystems you do not trust, such as a floppy. It also helps in compatibility with xattr\-supporting filesystems on earlier 2.4.<x> kernel versions. Even where xattrs are supported, you can save time not having to label every file by assigning the entire disk one security context. +.sp +A commonly used option for removable media is \fBcontext="system_u:object_r:removable_t\fP. +.sp +The \fBfscontext=\fP option works for all filesystems, regardless of their xattr support. The fscontext option sets the overarching filesystem label to a specific security context. This filesystem label is separate from the individual labels on the files. It represents the entire filesystem for certain kinds of permission checks, such as during mount or file creation. Individual file labels are still obtained from the xattrs on the files themselves. The context option actually sets the aggregate context that fscontext provides, in addition to supplying the same label for individual files. +.sp +You can set the default security context for unlabeled files using \fBdefcontext=\fP option. This overrides the value set for unlabeled files in the policy and requires a filesystem that supports xattr labeling. +.sp +The \fBrootcontext=\fP option allows you to explicitly label the root inode of a FS being mounted before that FS or inode becomes visible to userspace. This was found to be useful for things like stateless Linux. +.sp +Note that the kernel rejects any remount request that includes the context option, \fBeven\fP when unchanged from the current context. +.sp +\fBWarning: the\fP \fIcontext\fP \fBvalue might contain commas\fP, in which case the value has to be properly quoted, otherwise \fBmount\fP will interpret the comma as a separator between mount options. Don\(cqt forget that the shell strips off quotes and thus \fBdouble quoting is required\fP. For example: +.RE +.RS 3 +.ll -.6i +.sp +mount \-t tmpfs none /mnt \-o \(rs +\(aqcontext="system_u:object_r:tmp_t:s0:c127,c456",noexec\(aq +.br +.RE +.ll +.sp +For more details, see \fBselinux\fP(8). +.sp +\fBdefaults\fP +.RS 4 +Use the default options: \fBrw\fP, \fBsuid\fP, \fBdev\fP, \fBexec\fP, \fBauto\fP, \fBnouser\fP, and \fBasync\fP. +.sp +Note that the real set of all default mount options depends on the kernel and filesystem type. See the beginning of this section for more details. +.RE +.sp +\fBdev\fP +.RS 4 +Interpret character or block special devices on the filesystem. +.RE +.sp +\fBnodev\fP +.RS 4 +Do not interpret character or block special devices on the filesystem. +.RE +.sp +\fBdiratime\fP +.RS 4 +Update directory inode access times on this filesystem. This is the default. (This option is ignored when \fBnoatime\fP is set.) +.RE +.sp +\fBnodiratime\fP +.RS 4 +Do not update directory inode access times on this filesystem. (This option is implied when \fBnoatime\fP is set.) +.RE +.sp +\fBdirsync\fP +.RS 4 +All directory updates within the filesystem should be done synchronously. This affects the following system calls: \fBcreat\fP(2), \fBlink\fP(2), \fBunlink\fP(2), \fBsymlink\fP(2), \fBmkdir\fP(2), \fBrmdir\fP(2), \fBmknod\fP(2) and \fBrename\fP(2). +.RE +.sp +\fBexec\fP +.RS 4 +Permit execution of binaries. +.RE +.sp +\fBnoexec\fP +.RS 4 +Do not permit direct execution of any binaries on the mounted filesystem. +.RE +.sp +\fBgroup\fP +.RS 4 +Allow an ordinary user to mount the filesystem if one of that user\(cqs groups matches the group of the device. This option implies the options \fBnosuid\fP and \fBnodev\fP (unless overridden by subsequent options, as in the option line \fBgroup,dev,suid\fP). +.RE +.sp +\fBiversion\fP +.RS 4 +Every time the inode is modified, the i_version field will be incremented. +.RE +.sp +\fBnoiversion\fP +.RS 4 +Do not increment the i_version inode field. +.RE +.sp +\fBmand\fP +.RS 4 +Allow mandatory locks on this filesystem. See \fBfcntl\fP(2). +.RE +.sp +\fBnomand\fP +.RS 4 +Do not allow mandatory locks on this filesystem. +.RE +.sp +\fB_netdev\fP +.RS 4 +The filesystem resides on a device that requires network access (used to prevent the system from attempting to mount these filesystems until the network has been enabled on the system). +.RE +.sp +\fBnofail\fP +.RS 4 +Do not report errors for this device if it does not exist. +.RE +.sp +\fBrelatime\fP +.RS 4 +Update inode access times relative to modify or change time. Access time is only updated if the previous access time was earlier than the current modify or change time. (Similar to \fBnoatime\fP, but it doesn\(cqt break \fBmutt\fP(1) or other applications that need to know if a file has been read since the last time it was modified.) +.sp +Since Linux 2.6.30, the kernel defaults to the behavior provided by this option (unless \fBnoatime\fP was specified), and the \fBstrictatime\fP option is required to obtain traditional semantics. In addition, since Linux 2.6.30, the file\(cqs last access time is always updated if it is more than 1 day old. +.RE +.sp +\fBnorelatime\fP +.RS 4 +Do not use the \fBrelatime\fP feature. See also the \fBstrictatime\fP mount option. +.RE +.sp +\fBstrictatime\fP +.RS 4 +Allows to explicitly request full atime updates. This makes it possible for the kernel to default to \fBrelatime\fP or \fBnoatime\fP but still allow userspace to override it. For more details about the default system mount options see \fI/proc/mounts\fP. +.RE +.sp +\fBnostrictatime\fP +.RS 4 +Use the kernel\(cqs default behavior for inode access time updates. +.RE +.sp +\fBlazytime\fP +.RS 4 +Only update times (atime, mtime, ctime) on the in\-memory version of the file inode. +.sp +This mount option significantly reduces writes to the inode table for workloads that perform frequent random writes to preallocated files. +.sp +The on\-disk timestamps are updated only when: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +. sp -1 +. IP \(bu 2.3 +.\} +the inode needs to be updated for some change unrelated to file timestamps +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +. sp -1 +. IP \(bu 2.3 +.\} +the application employs \fBfsync\fP(2), \fBsyncfs\fP(2), or \fBsync\fP(2) +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +. sp -1 +. IP \(bu 2.3 +.\} +an undeleted inode is evicted from memory +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +. sp -1 +. IP \(bu 2.3 +.\} +more than 24 hours have passed since the inode was written to disk. +.RE +.RE +.sp +\fBnolazytime\fP +.RS 4 +Do not use the lazytime feature. +.RE +.sp +\fBsuid\fP +.RS 4 +Honor set\-user\-ID and set\-group\-ID bits or file capabilities when executing programs from this filesystem. +.RE +.sp +\fBnosuid\fP +.RS 4 +Do not honor set\-user\-ID and set\-group\-ID bits or file capabilities when executing programs from this filesystem. In addition, SELinux domain transitions require permission nosuid_transition, which in turn needs also policy capability nnp_nosuid_transition. +.RE +.sp +\fBsilent\fP +.RS 4 +Turn on the silent flag. +.RE +.sp +\fBloud\fP +.RS 4 +Turn off the silent flag. +.RE +.sp +\fBowner\fP +.RS 4 +Allow an ordinary user to mount the filesystem if that user is the owner of the device. This option implies the options \fBnosuid\fP and \fBnodev\fP (unless overridden by subsequent options, as in the option line \fBowner,dev,suid\fP). +.RE +.sp +\fBremount\fP +.RS 4 +Attempt to remount an already\-mounted filesystem. This is commonly used to change the mount flags for a filesystem, especially to make a readonly filesystem writable. It does not change device or mount point. +.sp +The remount operation together with the \fBbind\fP flag has special semantics. See above, the subsection \fBBind mounts\fP. +.sp +The remount functionality follows the standard way the \fBmount\fP command works with options from \fIfstab\fP. This means that \fBmount\fP does not read \fIfstab\fP (or \fImtab\fP) only when both \fIdevice\fP and \fIdir\fP are specified. +.sp +\fBmount \-o remount,rw /dev/foo /dir\fP +.sp +After this call all old mount options are replaced and arbitrary stuff from \fIfstab\fP (or \fImtab\fP) is ignored, except the loop= option which is internally generated and maintained by the mount command. +.sp +\fBmount \-o remount,rw /dir\fP +.sp +After this call, mount reads \fIfstab\fP and merges these options with the options from the command line (\fB\-o\fP). If no mountpoint is found in \fIfstab\fP, then a remount with unspecified source is allowed. +.sp +\fBmount\fP allows the use of \fB\-\-all\fP to remount all already mounted filesystems which match a specified filter (\fB\-O\fP and \fB\-t\fP). For example: +.sp +\fBmount \-\-all \-o remount,ro \-t vfat\fP +.sp +remounts all already mounted vfat filesystems in read\-only mode. Each of the filesystems is remounted by \fBmount \-o remount,ro /dir\fP semantic. This means the \fBmount\fP command reads \fIfstab\fP or \fImtab\fP and merges these options with the options from the command line. +.RE +.sp +\fBro\fP +.RS 4 +Mount the filesystem read\-only. +.RE +.sp +\fBrw\fP +.RS 4 +Mount the filesystem read\-write. +.RE +.sp +\fBsync\fP +.RS 4 +All I/O to the filesystem should be done synchronously. In the case of media with a limited number of write cycles (e.g. some flash drives), \fBsync\fP may cause life\-cycle shortening. +.RE +.sp +\fBuser\fP +.RS 4 +Allow an ordinary user to mount the filesystem. The name of the mounting user is written to the \fImtab\fP file (or to the private libmount file in \fI/run/mount\fP on systems without a regular \fImtab\fP) so that this same user can unmount the filesystem again. This option implies the options \fBnoexec\fP, \fBnosuid\fP, and \fBnodev\fP (unless overridden by subsequent options, as in the option line \fBuser,exec,dev,suid\fP). +.RE +.sp +\fBnouser\fP +.RS 4 +Forbid an ordinary user to mount the filesystem. This is the default; it does not imply any other options. +.RE +.sp +\fBusers\fP +.RS 4 +Allow any user to mount and to unmount the filesystem, even when some other ordinary user mounted it. This option implies the options \fBnoexec\fP, \fBnosuid\fP, and \fBnodev\fP (unless overridden by subsequent options, as in the option line \fBusers,exec,dev,suid\fP). +.RE +.sp +\fBX\-\fP* +.RS 4 +All options prefixed with "X\-" are interpreted as comments or as userspace application\-specific options. These options are not stored in user space (e.g., \fImtab\fP file), nor sent to the mount.\fItype\fP helpers nor to the \fBmount\fP(2) system call. The suggested format is \fBX\-\fP\fIappname\fP.\fIoption\fP. +.RE +.sp +\fBx\-\fP* +.RS 4 +The same as \fBX\-\fP* options, but stored permanently in user space. This means the options are also available for \fBumount\fP(8) or other operations. Note that maintaining mount options in user space is tricky, because it\(cqs necessary use libmount\-based tools and there is no guarantee that the options will be always available (for example after a move mount operation or in unshared namespace). +.sp +Note that before util\-linux v2.30 the x\-* options have not been maintained by libmount and stored in user space (functionality was the same as for X\-* now), but due to the growing number of use\-cases (in initrd, systemd etc.) the functionality has been extended to keep existing \fIfstab\fP configurations usable without a change. +.RE +.sp +\fBX\-mount.mkdir\fP[=\fImode\fP] +.RS 4 +Allow to make a target directory (mountpoint) if it does not exit yet. The optional argument \fImode\fP specifies the filesystem access mode used for \fBmkdir\fP(2) in octal notation. The default mode is 0755. This functionality is supported only for root users or when mount executed without suid permissions. The option is also supported as x\-mount.mkdir, this notation is deprecated since v2.30. +.RE +.sp +\fBnosymfollow\fP +.RS 4 +Do not follow symlinks when resolving paths. Symlinks can still be created, and \fBreadlink\fP(1), \fBreadlink\fP(2), \fBrealpath\fP(1), and \fBrealpath\fP(3) all still work properly. +.RE +.SH "FILESYSTEM\-SPECIFIC MOUNT OPTIONS" +.sp +This section lists options that are specific to particular filesystems. Where possible, you should first consult filesystem\-specific manual pages for details. Some of those pages are listed in the following table. +.TS +allbox tab(:); +lt lt. +T{ +.sp +\fBFilesystem(s)\fP +T}:T{ +.sp +\fBManual page\fP +T} +T{ +.sp +btrfs +T}:T{ +.sp +\fBbtrfs\fP(5) +T} +T{ +.sp +cifs +T}:T{ +.sp +\fBmount.cifs\fP(8) +T} +T{ +.sp +ext2, ext3, ext4 +T}:T{ +.sp +\fBext4\fP(5) +T} +T{ +.sp +fuse +T}:T{ +.sp +\fBfuse\fP(8) +T} +T{ +.sp +nfs +T}:T{ +.sp +\fBnfs\fP(5) +T} +T{ +.sp +tmpfs +T}:T{ +.sp +\fBtmpfs\fP(5) +T} +T{ +.sp +xfs +T}:T{ +.sp +\fBxfs\fP(5) +T} +.TE +.sp +.sp +Note that some of the pages listed above might be available only after you install the respective userland tools. +.sp +The following options apply only to certain filesystems. We sort them by filesystem. All options follow the \fB\-o\fP flag. +.sp +What options are supported depends a bit on the running kernel. Further information may be available in filesystem\-specific files in the kernel source subdirectory \fIDocumentation/filesystems\fP. +.SS "Mount options for adfs" +.sp +\fBuid=\fP\fIvalue\fP and \fBgid=\fP\fIvalue\fP +.RS 4 +Set the owner and group of the files in the filesystem (default: uid=gid=0). +.RE +.sp +\fBownmask=\fP\fIvalue\fP and \fBothmask=\fP\fIvalue\fP +.RS 4 +Set the permission mask for ADFS \(aqowner\(aq permissions and \(aqother\(aq permissions, respectively (default: 0700 and 0077, respectively). See also \fI/usr/src/linux/Documentation/filesystems/adfs.rst\fP. +.RE +.SS "Mount options for affs" +.sp +\fBuid=\fP\fIvalue\fP and \fBgid=\fP\fIvalue\fP +.RS 4 +Set the owner and group of the root of the filesystem (default: uid=gid=0, but with option \fBuid\fP or \fBgid\fP without specified value, the UID and GID of the current process are taken). +.RE +.sp +\fBsetuid=\fP\fIvalue\fP and \fBsetgid=\fP\fIvalue\fP +.RS 4 +Set the owner and group of all files. +.RE +.sp +\fBmode=\fP\fIvalue\fP +.RS 4 +Set the mode of all files to \fIvalue\fP & 0777 disregarding the original permissions. Add search permission to directories that have read permission. The value is given in octal. +.RE +.sp +\fBprotect\fP +.RS 4 +Do not allow any changes to the protection bits on the filesystem. +.RE +.sp +\fBusemp\fP +.RS 4 +Set UID and GID of the root of the filesystem to the UID and GID of the mount point upon the first sync or umount, and then clear this option. Strange... +.RE +.sp +\fBverbose\fP +.RS 4 +Print an informational message for each successful mount. +.RE +.sp +\fBprefix=\fP\fIstring\fP +.RS 4 +Prefix used before volume name, when following a link. +.RE +.sp +\fBvolume=\fP\fIstring\fP +.RS 4 +Prefix (of length at most 30) used before \(aq/\(aq when following a symbolic link. +.RE +.sp +\fBreserved=\fP\fIvalue\fP +.RS 4 +(Default: 2.) Number of unused blocks at the start of the device. +.RE +.sp +\fBroot=\fP\fIvalue\fP +.RS 4 +Give explicitly the location of the root block. +.RE +.sp +\fBbs=\fP\fIvalue\fP +.RS 4 +Give blocksize. Allowed values are 512, 1024, 2048, 4096. +.RE +.sp +\fBgrpquota\fP|\fBnoquota\fP|\fBquota\fP|\fBusrquota\fP +.RS 4 +These options are accepted but ignored. (However, quota utilities may react to such strings in \fI/etc/fstab\fP.) +.RE +.SS "Mount options for debugfs" +.sp +The debugfs filesystem is a pseudo filesystem, traditionally mounted on \fI/sys/kernel/debug\fP. As of kernel version 3.4, debugfs has the following options: +.sp +\fBuid=\fP\fIn\fP\fB, gid=\fP\fIn\fP +.RS 4 +Set the owner and group of the mountpoint. +.RE +.sp +\fBmode=\fP\fIvalue\fP +.RS 4 +Sets the mode of the mountpoint. +.RE +.SS "Mount options for devpts" +.sp +The devpts filesystem is a pseudo filesystem, traditionally mounted on \fI/dev/pts\fP. In order to acquire a pseudo terminal, a process opens \fI/dev/ptmx\fP; the number of the pseudo terminal is then made available to the process and the pseudo terminal slave can be accessed as \fI/dev/pts/\fP<number>. +.sp +\fBuid=\fP\fIvalue\fP and \fBgid=\fP\fIvalue\fP +.RS 4 +This sets the owner or the group of newly created pseudo terminals to the specified values. When nothing is specified, they will be set to the UID and GID of the creating process. For example, if there is a tty group with GID 5, then \fBgid=5\fP will cause newly created pseudo terminals to belong to the tty group. +.RE +.sp +\fBmode=\fP\fIvalue\fP +.RS 4 +Set the mode of newly created pseudo terminals to the specified value. The default is 0600. A value of \fBmode=620\fP and \fBgid=5\fP makes "mesg y" the default on newly created pseudo terminals. +.RE +.sp +\fBnewinstance\fP +.RS 4 +Create a private instance of the devpts filesystem, such that indices of pseudo terminals allocated in this new instance are independent of indices created in other instances of devpts. +.sp +All mounts of devpts without this \fBnewinstance\fP option share the same set of pseudo terminal indices (i.e., legacy mode). Each mount of devpts with the \fBnewinstance\fP option has a private set of pseudo terminal indices. +.sp +This option is mainly used to support containers in the Linux kernel. It is implemented in Linux kernel versions starting with 2.6.29. Further, this mount option is valid only if \fBCONFIG_DEVPTS_MULTIPLE_INSTANCES\fP is enabled in the kernel configuration. +.sp +To use this option effectively, \fI/dev/ptmx\fP must be a symbolic link to \fIpts/ptmx\fP. See \fIDocumentation/filesystems/devpts.txt\fP in the Linux kernel source tree for details. +.RE +.sp +\fBptmxmode=\fP\fIvalue\fP +.RS 4 +Set the mode for the new \fIptmx\fP device node in the devpts filesystem. +.sp +With the support for multiple instances of devpts (see \fBnewinstance\fP option above), each instance has a private \fIptmx\fP node in the root of the devpts filesystem (typically \fI/dev/pts/ptmx\fP). +.sp +For compatibility with older versions of the kernel, the default mode of the new \fIptmx\fP node is 0000. \fBptmxmode=\fP\fIvalue\fP specifies a more useful mode for the \fIptmx\fP node and is highly recommended when the \fBnewinstance\fP option is specified. +.sp +This option is only implemented in Linux kernel versions starting with 2.6.29. Further, this option is valid only if \fBCONFIG_DEVPTS_MULTIPLE_INSTANCES\fP is enabled in the kernel configuration. +.RE +.SS "Mount options for fat" +.sp +(Note: \fIfat\fP is not a separate filesystem, but a common part of the \fImsdos\fP, \fIumsdos\fP and \fIvfat\fP filesystems.) +.sp +\fBblocksize=\fP{\fB512\fP|\fB1024\fP|\fB2048\fP} +.RS 4 +Set blocksize (default 512). This option is obsolete. +.RE +.sp +\fBuid=\fP\fIvalue\fP and \fBgid=\fP\fIvalue\fP +.RS 4 +Set the owner and group of all files. (Default: the UID and GID of the current process.) +.RE +.sp +\fBumask=\fP\fIvalue\fP +.RS 4 +Set the umask (the bitmask of the permissions that are \fBnot\fP present). The default is the umask of the current process. The value is given in octal. +.RE +.sp +\fBdmask=\fP\fIvalue\fP +.RS 4 +Set the umask applied to directories only. The default is the umask of the current process. The value is given in octal. +.RE +.sp +\fBfmask=\fP\fIvalue\fP +.RS 4 +Set the umask applied to regular files only. The default is the umask of the current process. The value is given in octal. +.RE +.sp +\fBallow_utime=\fP\fIvalue\fP +.RS 4 +This option controls the permission check of mtime/atime. +.sp +\fB20\fP +.RS 4 +If current process is in group of file\(cqs group ID, you can change timestamp. +.RE +.sp +\fB2\fP +.RS 4 +Other users can change timestamp. +.RE +.RE +.sp +The default is set from \(aqdmask\(aq option. (If the directory is writable, \fButime\fP(2) is also allowed. I.e. ~dmask & 022) +.sp +Normally \fButime\fP(2) checks that the current process is owner of the file, or that it has the \fBCAP_FOWNER\fP capability. But FAT filesystems don\(cqt have UID/GID on disk, so the normal check is too inflexible. With this option you can relax it. +.sp +\fBcheck=\fP\fIvalue\fP +.RS 4 +Three different levels of pickiness can be chosen: +.sp +\fBr\fP[\fBelaxed\fP] +.RS 4 +Upper and lower case are accepted and equivalent, long name parts are truncated (e.g. \fIverylongname.foobar\fP becomes \fIverylong.foo\fP), leading and embedded spaces are accepted in each name part (name and extension). +.RE +.sp +\fBn\fP[\fBormal\fP] +.RS 4 +Like "relaxed", but many special characters (*, ?, <, spaces, etc.) are rejected. This is the default. +.RE +.sp +\fBs\fP[\fBtrict\fP] +.RS 4 +Like "normal", but names that contain long parts or special characters that are sometimes used on Linux but are not accepted by MS\-DOS (+, =, etc.) are rejected. +.RE +.RE +.sp +\fBcodepage=\fP\fIvalue\fP +.RS 4 +Sets the codepage for converting to shortname characters on FAT and VFAT filesystems. By default, codepage 437 is used. +.RE +.sp +\fBconv=\fP\fImode\fP +.RS 4 +This option is obsolete and may fail or be ignored. +.RE +.sp +\fBcvf_format=\fP\fImodule\fP +.RS 4 +Forces the driver to use the CVF (Compressed Volume File) module cvf__module_ instead of auto\-detection. If the kernel supports kmod, the cvf_format=xxx option also controls on\-demand CVF module loading. This option is obsolete. +.RE +.sp +\fBcvf_option=\fP\fIoption\fP +.RS 4 +Option passed to the CVF module. This option is obsolete. +.RE +.sp +\fBdebug\fP +.RS 4 +Turn on the \fIdebug\fP flag. A version string and a list of filesystem parameters will be printed (these data are also printed if the parameters appear to be inconsistent). +.RE +.sp +\fBdiscard\fP +.RS 4 +If set, causes discard/TRIM commands to be issued to the block device when blocks are freed. This is useful for SSD devices and sparse/thinly\-provisioned LUNs. +.RE +.sp +\fBdos1xfloppy\fP +.RS 4 +If set, use a fallback default BIOS Parameter Block configuration, determined by backing device size. These static parameters match defaults assumed by DOS 1.x for 160 kiB, 180 kiB, 320 kiB, and 360 kiB floppies and floppy images. +.RE +.sp +\fBerrors=\fP{\fBpanic\fP|\fBcontinue\fP|\fBremount\-ro\fP} +.RS 4 +Specify FAT behavior on critical errors: panic, continue without doing anything, or remount the partition in read\-only mode (default behavior). +.RE +.sp +\fBfat=\fP{\fB12\fP|\fB16\fP|\fB32\fP} +.RS 4 +Specify a 12, 16 or 32 bit fat. This overrides the automatic FAT type detection routine. Use with caution! +.RE +.sp +\fBiocharset=\fP\fIvalue\fP +.RS 4 +Character set to use for converting between 8 bit characters and 16 bit Unicode characters. The default is iso8859\-1. Long filenames are stored on disk in Unicode format. +.RE +.sp +\fBnfs=\fP{\fBstale_rw\fP|\fBnostale_ro\fP} +.RS 4 +Enable this only if you want to export the FAT filesystem over NFS. +.sp +\fBstale_rw\fP: This option maintains an index (cache) of directory inodes which is used by the nfs\-related code to improve look\-ups. Full file operations (read/write) over NFS are supported but with cache eviction at NFS server, this could result in spurious \fBESTALE\fP errors. +.sp +\fBnostale_ro\fP: This option bases the inode number and file handle on the on\-disk location of a file in the FAT directory entry. This ensures that \fBESTALE\fP will not be returned after a file is evicted from the inode cache. However, it means that operations such as rename, create and unlink could cause file handles that previously pointed at one file to point at a different file, potentially causing data corruption. For this reason, this option also mounts the filesystem readonly. +.sp +To maintain backward compatibility, \fB\-o nfs\fP is also accepted, defaulting to \fBstale_rw\fP. +.RE +.sp +\fBtz=UTC\fP +.RS 4 +This option disables the conversion of timestamps between local time (as used by Windows on FAT) and UTC (which Linux uses internally). This is particularly useful when mounting devices (like digital cameras) that are set to UTC in order to avoid the pitfalls of local time. +.RE +.sp +\fBtime_offset=\fP\fIminutes\fP +.RS 4 +Set offset for conversion of timestamps from local time used by FAT to UTC. I.e., \fIminutes\fP will be subtracted from each timestamp to convert it to UTC used internally by Linux. This is useful when the time zone set in the kernel via \fBsettimeofday\fP(2) is not the time zone used by the filesystem. Note that this option still does not provide correct time stamps in all cases in presence of DST \- time stamps in a different DST setting will be off by one hour. +.RE +.sp +\fBquiet\fP +.RS 4 +Turn on the \fIquiet\fP flag. Attempts to chown or chmod files do not return errors, although they fail. Use with caution! +.RE +.sp +\fBrodir\fP +.RS 4 +FAT has the \fBATTR_RO\fP (read\-only) attribute. On Windows, the \fBATTR_RO\fP of the directory will just be ignored, and is used only by applications as a flag (e.g. it\(cqs set for the customized folder). +.sp +If you want to use \fBATTR_RO\fP as read\-only flag even for the directory, set this option. +.RE +.sp +\fBshowexec\fP +.RS 4 +If set, the execute permission bits of the file will be allowed only if the extension part of the name is .EXE, .COM, or .BAT. Not set by default. +.RE +.sp +\fBsys_immutable\fP +.RS 4 +If set, \fBATTR_SYS\fP attribute on FAT is handled as \fBIMMUTABLE\fP flag on Linux. Not set by default. +.RE +.sp +\fBflush\fP +.RS 4 +If set, the filesystem will try to flush to disk more early than normal. Not set by default. +.RE +.sp +\fBusefree\fP +.RS 4 +Use the "free clusters" value stored on \fBFSINFO\fP. It\(cqll be used to determine number of free clusters without scanning disk. But it\(cqs not used by default, because recent Windows don\(cqt update it correctly in some case. If you are sure the "free clusters" on \fBFSINFO\fP is correct, by this option you can avoid scanning disk. +.RE +.sp +\fBdots\fP, \fBnodots\fP, \fBdotsOK=\fP[\fByes\fP|\fBno\fP] +.RS 4 +Various misguided attempts to force Unix or DOS conventions onto a FAT filesystem. +.RE +.SS "Mount options for hfs" +.sp +\fBcreator=\fP\fIcccc\fP\fB, type=\fP\fIcccc\fP +.RS 4 +Set the creator/type values as shown by the MacOS finder used for creating new files. Default values: \(aq????\(aq. +.RE +.sp +\fBuid=\fP\fIn\fP\fB, gid=\fP\fIn\fP +.RS 4 +Set the owner and group of all files. (Default: the UID and GID of the current process.) +.RE +.sp +\fBdir_umask=\fP\fIn\fP\fB, file_umask=\fP\fIn\fP\fB, umask=\fP\fIn\fP +.RS 4 +Set the umask used for all directories, all regular files, or all files and directories. Defaults to the umask of the current process. +.RE +.sp +\fBsession=\fP\fIn\fP +.RS 4 +Select the CDROM session to mount. Defaults to leaving that decision to the CDROM driver. This option will fail with anything but a CDROM as underlying device. +.RE +.sp +\fBpart=\fP\fIn\fP +.RS 4 +Select partition number n from the device. Only makes sense for CDROMs. Defaults to not parsing the partition table at all. +.RE +.sp +\fBquiet\fP +.RS 4 +Don\(cqt complain about invalid mount options. +.RE +.SS "Mount options for hpfs" +.sp +\fBuid=\fP\fIvalue\fP and \fBgid=\fP\fIvalue\fP +.RS 4 +Set the owner and group of all files. (Default: the UID and GID of the current process.) +.RE +.sp +\fBumask=\fP\fIvalue\fP +.RS 4 +Set the umask (the bitmask of the permissions that are \fBnot\fP present). The default is the umask of the current process. The value is given in octal. +.RE +.sp +\fBcase=\fP{\fBlower\fP|\fBasis\fP} +.RS 4 +Convert all files names to lower case, or leave them. (Default: \fBcase=lower\fP.) +.RE +.sp +\fBconv=\fP\fImode\fP +.RS 4 +This option is obsolete and may fail or being ignored. +.RE +.sp +\fBnocheck\fP +.RS 4 +Do not abort mounting when certain consistency checks fail. +.RE +.SS "Mount options for iso9660" +.sp +ISO 9660 is a standard describing a filesystem structure to be used on CD\-ROMs. (This filesystem type is also seen on some DVDs. See also the \fIudf\fP filesystem.) +.sp +Normal \fIiso9660\fP filenames appear in an 8.3 format (i.e., DOS\-like restrictions on filename length), and in addition all characters are in upper case. Also there is no field for file ownership, protection, number of links, provision for block/character devices, etc. +.sp +Rock Ridge is an extension to iso9660 that provides all of these UNIX\-like features. Basically there are extensions to each directory record that supply all of the additional information, and when Rock Ridge is in use, the filesystem is indistinguishable from a normal UNIX filesystem (except that it is read\-only, of course). +.sp +\fBnorock\fP +.RS 4 +Disable the use of Rock Ridge extensions, even if available. Cf. \fBmap\fP. +.RE +.sp +\fBnojoliet\fP +.RS 4 +Disable the use of Microsoft Joliet extensions, even if available. Cf. \fBmap\fP. +.RE +.sp +\fBcheck=\fP{\fBr\fP[\fBelaxed\fP]|\fBs\fP[\fBtrict\fP]} +.RS 4 +With \fBcheck=relaxed\fP, a filename is first converted to lower case before doing the lookup. This is probably only meaningful together with \fBnorock\fP and \fBmap=normal\fP. (Default: \fBcheck=strict\fP.) +.RE +.sp +\fBuid=\fP\fIvalue\fP and \fBgid=\fP\fIvalue\fP +.RS 4 +Give all files in the filesystem the indicated user or group id, possibly overriding the information found in the Rock Ridge extensions. (Default: \fBuid=0,gid=0\fP.) +.RE +.sp +\fBmap=\fP{\fBn\fP[\fBormal\fP]|\fBo\fP[\fBff\fP]|\fBa\fP[\fBcorn\fP]} +.RS 4 +For non\-Rock Ridge volumes, normal name translation maps upper to lower case ASCII, drops a trailing \(aq;1\(aq, and converts \(aq;\(aq to \(aq.\(aq. With \fBmap=off\fP no name translation is done. See \fBnorock\fP. (Default: \fBmap=normal\fP.) \fBmap=acorn\fP is like \fBmap=normal\fP but also apply Acorn extensions if present. +.RE +.sp +\fBmode=\fP\fIvalue\fP +.RS 4 +For non\-Rock Ridge volumes, give all files the indicated mode. (Default: read and execute permission for everybody.) Octal mode values require a leading 0. +.RE +.sp +\fBunhide\fP +.RS 4 +Also show hidden and associated files. (If the ordinary files and the associated or hidden files have the same filenames, this may make the ordinary files inaccessible.) +.RE +.sp +\fBblock=\fP{\fB512\fP|\fB1024\fP|\fB2048\fP} +.RS 4 +Set the block size to the indicated value. (Default: \fBblock=1024\fP.) +.RE +.sp +\fBconv=\fP\fImode\fP +.RS 4 +This option is obsolete and may fail or being ignored. +.RE +.sp +\fBcruft\fP +.RS 4 +If the high byte of the file length contains other garbage, set this mount option to ignore the high order bits of the file length. This implies that a file cannot be larger than 16 MB. +.RE +.sp +\fBsession=\fP\fIx\fP +.RS 4 +Select number of session on a multisession CD. +.RE +.sp +\fBsbsector=\fP\fIxxx\fP +.RS 4 +Session begins from sector xxx. +.RE +.sp +The following options are the same as for vfat and specifying them only makes sense when using discs encoded using Microsoft\(cqs Joliet extensions. +.sp +\fBiocharset=\fP\fIvalue\fP +.RS 4 +Character set to use for converting 16 bit Unicode characters on CD to 8 bit characters. The default is iso8859\-1. +.RE +.sp +\fButf8\fP +.RS 4 +Convert 16 bit Unicode characters on CD to UTF\-8. +.RE +.SS "Mount options for jfs" +.sp +\fBiocharset=\fP\fIname\fP +.RS 4 +Character set to use for converting from Unicode to ASCII. The default is to do no conversion. Use \fBiocharset=utf8\fP for UTF8 translations. This requires \fBCONFIG_NLS_UTF8\fP to be set in the kernel \fI.config\fP file. +.RE +.sp +\fBresize=\fP\fIvalue\fP +.RS 4 +Resize the volume to \fIvalue\fP blocks. JFS only supports growing a volume, not shrinking it. This option is only valid during a remount, when the volume is mounted read\-write. The \fBresize\fP keyword with no value will grow the volume to the full size of the partition. +.RE +.sp +\fBnointegrity\fP +.RS 4 +Do not write to the journal. The primary use of this option is to allow for higher performance when restoring a volume from backup media. The integrity of the volume is not guaranteed if the system abnormally ends. +.RE +.sp +\fBintegrity\fP +.RS 4 +Default. Commit metadata changes to the journal. Use this option to remount a volume where the \fBnointegrity\fP option was previously specified in order to restore normal behavior. +.RE +.sp +\fBerrors=\fP{\fBcontinue\fP|\fBremount\-ro\fP|\fBpanic\fP} +.RS 4 +Define the behavior when an error is encountered. (Either ignore errors and just mark the filesystem erroneous and continue, or remount the filesystem read\-only, or panic and halt the system.) +.RE +.sp +\fBnoquota\fP|\fBquota\fP|\fBusrquota\fP|\fBgrpquota\fP +.RS 4 +These options are accepted but ignored. +.RE +.SS "Mount options for msdos" +.sp +See mount options for fat. If the \fImsdos\fP filesystem detects an inconsistency, it reports an error and sets the file system read\-only. The filesystem can be made writable again by remounting it. +.SS "Mount options for ncpfs" +.sp +Just like \fInfs\fP, the \fIncpfs\fP implementation expects a binary argument (a \fIstruct ncp_mount_data\fP) to the mount system call. This argument is constructed by \fBncpmount\fP(8) and the current version of \fBmount\fP (2.12) does not know anything about ncpfs. +.SS "Mount options for ntfs" +.sp +\fBiocharset=\fP\fIname\fP +.RS 4 +Character set to use when returning file names. Unlike VFAT, NTFS suppresses names that contain nonconvertible characters. Deprecated. +.RE +.sp +\fBnls=\fP\fIname\fP +.RS 4 +New name for the option earlier called \fIiocharset\fP. +.RE +.sp +\fButf8\fP +.RS 4 +Use UTF\-8 for converting file names. +.RE +.sp +\fBuni_xlate=\fP{\fB0\fP|\fB1\fP|\fB2\fP} +.RS 4 +For 0 (or \(aqno\(aq or \(aqfalse\(aq), do not use escape sequences for unknown Unicode characters. For 1 (or \(aqyes\(aq or \(aqtrue\(aq) or 2, use vfat\-style 4\-byte escape sequences starting with ":". Here 2 gives a little\-endian encoding and 1 a byteswapped bigendian encoding. +.RE +.sp +\fBposix=[0|1]\fP +.RS 4 +If enabled (posix=1), the filesystem distinguishes between upper and lower case. The 8.3 alias names are presented as hard links instead of being suppressed. This option is obsolete. +.RE +.sp +\fBuid=\fP\fIvalue\fP, \fBgid=\fP\fIvalue\fP and \fBumask=\fP\fIvalue\fP +.RS 4 +Set the file permission on the filesystem. The umask value is given in octal. By default, the files are owned by root and not readable by somebody else. +.RE +.SS "Mount options for overlay" +.sp +Since Linux 3.18 the overlay pseudo filesystem implements a union mount for other filesystems. +.sp +An overlay filesystem combines two filesystems \- an \fBupper\fP filesystem and a \fBlower\fP filesystem. When a name exists in both filesystems, the object in the upper filesystem is visible while the object in the lower filesystem is either hidden or, in the case of directories, merged with the upper object. +.sp +The lower filesystem can be any filesystem supported by Linux and does not need to be writable. The lower filesystem can even be another overlayfs. The upper filesystem will normally be writable and if it is it must support the creation of trusted.* extended attributes, and must provide a valid d_type in readdir responses, so NFS is not suitable. +.sp +A read\-only overlay of two read\-only filesystems may use any filesystem type. The options \fBlowerdir\fP and \fBupperdir\fP are combined into a merged directory by using: +.RS 3 +.ll -.6i +.sp +.if n .RS 4 +.nf +.fam C +mount \-t overlay overlay \(rs + \-olowerdir=/lower,upperdir=/upper,workdir=/work /merged +.fam +.fi +.if n .RE +.br +.RE +.ll +.sp +\fBlowerdir=\fP\fIdirectory\fP +.RS 4 +Any filesystem, does not need to be on a writable filesystem. +.RE +.sp +\fBupperdir=\fP\fIdirectory\fP +.RS 4 +The upperdir is normally on a writable filesystem. +.RE +.sp +\fBworkdir=\fP\fIdirectory\fP +.RS 4 +The workdir needs to be an empty directory on the same filesystem as upperdir. +.RE +.sp +\fBuserxattr\fP +.RS 4 +Use the "\fBuser.overlay.\fP" xattr namespace instead of "\fBtrusted.overlay.\fP". This is useful for unprivileged mounting of overlayfs. +.RE +.sp +\fBredirect_dir=\fP{\fBon\fP|\fBoff\fP|\fBfollow\fP|\fBnofollow\fP} +.RS 4 +If the \fIredirect_dir\fP feature is enabled, then the directory will be copied up (but not the contents). Then the "{\fBtrusted\fP|\fBuser\fP}.overlay.redirect" extended attribute is set to the path of the original location from the root of the overlay. Finally the directory is moved to the new location. +.sp +\fBon\fP +.RS 4 +Redirects are enabled. +.RE +.sp +\fBoff\fP +.RS 4 +Redirects are not created and only followed if "redirect_always_follow" feature is enabled in the kernel/module config. +.RE +.sp +\fBfollow\fP +.RS 4 +Redirects are not created, but followed. +.RE +.sp +\fBnofollow\fP +.RS 4 +Redirects are not created and not followed (equivalent to "redirect_dir=off" if "redirect_always_follow" feature is not enabled). +.RE +.RE +.sp +\fBindex=\fP{\fBon\fP|\fBoff\fP} +.RS 4 +Inode index. If this feature is disabled and a file with multiple hard links is copied up, then this will "break" the link. Changes will not be propagated to other names referring to the same inode. +.RE +.sp +\fBuuid=\fP{\fBon\fP|\fBoff\fP} +.RS 4 +Can be used to replace UUID of the underlying filesystem in file handles with null, and effectively disable UUID checks. This can be useful in case the underlying disk is copied and the UUID of this copy is changed. This is only applicable if all lower/upper/work directories are on the same filesystem, otherwise it will fallback to normal behaviour. +.RE +.sp +\fBnfs_export=\fP{\fBon\fP|\fBoff\fP} +.RS 4 +When the underlying filesystems supports NFS export and the "nfs_export" +feature is enabled, an overlay filesystem may be exported to NFS. +.sp +With the “nfs_export” feature, on copy_up of any lower object, an index entry +is created under the index directory. The index entry name is the hexadecimal +representation of the copy up origin file handle. For a non\-directory object, +the index entry is a hard link to the upper inode. For a directory object, the +index entry has an extended attribute "{\fBtrusted\fP|\fBuser\fP}.overlay.upper" +with an encoded file handle of the upper directory inode. +.sp +When encoding a file handle from an overlay filesystem object, the following rules apply +.RS 4 +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +. sp -1 +. IP \(bu 2.3 +.\} +For a non\-upper object, encode a lower file handle from lower inode +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +. sp -1 +. IP \(bu 2.3 +.\} +For an indexed object, encode a lower file handle from copy_up origin +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +. sp -1 +. IP \(bu 2.3 +.\} +For a pure\-upper object and for an existing non\-indexed upper object, encode an upper file handle from upper inode +.RE +.RE +.sp +The encoded overlay file handle includes +.RS 4 +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +. sp -1 +. IP \(bu 2.3 +.\} +Header including path type information (e.g. lower/upper) +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +. sp -1 +. IP \(bu 2.3 +.\} +UUID of the underlying filesystem +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +. sp -1 +. IP \(bu 2.3 +.\} +Underlying filesystem encoding of underlying inode +.RE +.RE +.sp +This encoding format is identical to the encoding format file handles that are stored in extended attribute "{\fBtrusted\fP|\fBuser\fP}.overlay.origin". When decoding an overlay file handle, the following steps are followed +.RS 4 +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +. sp -1 +. IP \(bu 2.3 +.\} +Find underlying layer by UUID and path type information. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +. sp -1 +. IP \(bu 2.3 +.\} +Decode the underlying filesystem file handle to underlying dentry. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +. sp -1 +. IP \(bu 2.3 +.\} +For a lower file handle, lookup the handle in index directory by name. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +. sp -1 +. IP \(bu 2.3 +.\} +If a whiteout is found in index, return ESTALE. This represents an overlay object that was deleted after its file handle was encoded. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +. sp -1 +. IP \(bu 2.3 +.\} +For a non\-directory, instantiate a disconnected overlay dentry from the decoded underlying dentry, the path type and index inode, if found. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +. sp -1 +. IP \(bu 2.3 +.\} +For a directory, use the connected underlying decoded dentry, path type and index, to lookup a connected overlay dentry. +.RE +.RE +.sp +Decoding a non\-directory file handle may return a disconnected dentry. copy_up +of that disconnected dentry will create an upper index entry with no upper +alias. +.sp +When overlay filesystem has multiple lower layers, a middle layer directory may +have a "redirect" to lower directory. Because middle layer "redirects" are not +indexed, a lower file handle that was encoded from the "redirect" origin +directory, cannot be used to find the middle or upper layer directory. +Similarly, a lower file handle that was encoded from a descendant of the +"redirect" origin directory, cannot be used to reconstruct a connected overlay +path. To mitigate the cases of directories that cannot be decoded from a lower +file handle, these directories are copied up on encode and encoded as an upper +file handle. On an overlay filesystem with no upper layer this mitigation +cannot be used NFS export in this setup requires turning off redirect follow +(e.g. "\fIredirect_dir=nofollow\fP"). +.sp +The overlay filesystem does not support non\-directory connectable file handles, so exporting with the \fIsubtree_check\fP exportfs configuration will cause failures to lookup files over NFS. +.sp +When the NFS export feature is enabled, all directory index entries are verified on mount time to check that upper file handles are not stale. This verification may cause significant overhead in some cases. +.sp +Note: the mount options \fIindex=off,nfs_export=on\fP are conflicting for a +read\-write mount and will result in an error. +.RE +.sp +\fBxinfo=\fP{\fBon\fP|\fBoff\fP|\fBauto\fP} +.RS 4 +The "xino" feature composes a unique object identifier from the real object st_ino and an underlying fsid index. The "xino" feature uses the high inode number bits for fsid, because the underlying filesystems rarely use the high inode number bits. In case the underlying inode number does overflow into the high xino bits, overlay filesystem will fall back to the non xino behavior for that inode. +.sp +For a detailed description of the effect of this option please refer to \c +.URL "https://www.kernel.org/doc/html/latest/filesystems/overlayfs.html?highlight=overlayfs" "" "" +.RE +.sp +\fBmetacopy=\fP{\fBon\fP|\fBoff\fP} +.RS 4 +When metadata only copy up feature is enabled, overlayfs will only copy up metadata (as opposed to whole file), when a metadata specific operation like chown/chmod is performed. Full file will be copied up later when file is opened for WRITE operation. +.sp +In other words, this is delayed data copy up operation and data is copied up when there is a need to actually modify data. +.RE +.sp +\fBvolatile\fP +.RS 4 +Volatile mounts are not guaranteed to survive a crash. It is strongly recommended that volatile mounts are only used if data written to the overlay can be recreated without significant effort. +.sp +The advantage of mounting with the "volatile" option is that all forms of sync calls to the upper filesystem are omitted. +.sp +In order to avoid a giving a false sense of safety, the syncfs (and fsync) semantics of volatile mounts are slightly different than that of the rest of VFS. If any writeback error occurs on the upperdir’s filesystem after a volatile mount takes place, all sync functions will return an error. Once this condition is reached, the filesystem will not recover, and every subsequent sync call will return an error, even if the upperdir has not experience a new error since the last sync call. +.sp +When overlay is mounted with "volatile" option, the directory "$workdir/work/incompat/volatile" is created. During next mount, overlay checks for this directory and refuses to mount if present. This is a strong indicator that user should throw away upper and work directories and create fresh one. In very limited cases where the user knows that the system has not crashed and contents of upperdir are intact, The "volatile" directory can be removed. +.RE +.SS "Mount options for reiserfs" +.sp +Reiserfs is a journaling filesystem. +.sp +\fBconv\fP +.RS 4 +Instructs version 3.6 reiserfs software to mount a version 3.5 filesystem, using the 3.6 format for newly created objects. This filesystem will no longer be compatible with reiserfs 3.5 tools. +.RE +.sp +\fBhash=\fP{\fBrupasov\fP|\fBtea\fP|\fBr5\fP|\fBdetect\fP} +.RS 4 +Choose which hash function reiserfs will use to find files within directories. +.sp +\fBrupasov\fP +.RS 4 +A hash invented by Yury Yu. Rupasov. It is fast and preserves locality, mapping lexicographically close file names to close hash values. This option should not be used, as it causes a high probability of hash collisions. +.RE +.sp +\fBtea\fP +.RS 4 +A Davis\-Meyer function implemented by Jeremy Fitzhardinge. It uses hash permuting bits in the name. It gets high randomness and, therefore, low probability of hash collisions at some CPU cost. This may be used if \fBEHASHCOLLISION\fP errors are experienced with the r5 hash. +.RE +.sp +\fBr5\fP +.RS 4 +A modified version of the rupasov hash. It is used by default and is the best choice unless the filesystem has huge directories and unusual file\-name patterns. +.RE +.sp +\fBdetect\fP +.RS 4 +Instructs \fBmount\fP to detect which hash function is in use by examining the filesystem being mounted, and to write this information into the reiserfs superblock. This is only useful on the first mount of an old format filesystem. +.RE +.RE +.sp +\fBhashed_relocation\fP +.RS 4 +Tunes the block allocator. This may provide performance improvements in some situations. +.RE +.sp +\fBno_unhashed_relocation\fP +.RS 4 +Tunes the block allocator. This may provide performance improvements in some situations. +.RE +.sp +\fBnoborder\fP +.RS 4 +Disable the border allocator algorithm invented by Yury Yu. Rupasov. This may provide performance improvements in some situations. +.RE +.sp +\fBnolog\fP +.RS 4 +Disable journaling. This will provide slight performance improvements in some situations at the cost of losing reiserfs\(cqs fast recovery from crashes. Even with this option turned on, reiserfs still performs all journaling operations, save for actual writes into its journaling area. Implementation of \fInolog\fP is a work in progress. +.RE +.sp +\fBnotail\fP +.RS 4 +By default, reiserfs stores small files and \(aqfile tails\(aq directly into its tree. This confuses some utilities such as \fBlilo\fP(8). This option is used to disable packing of files into the tree. +.RE +.sp +\fBreplayonly\fP +.RS 4 +Replay the transactions which are in the journal, but do not actually mount the filesystem. Mainly used by \fIreiserfsck\fP. +.RE +.sp +\fBresize=\fP\fInumber\fP +.RS 4 +A remount option which permits online expansion of reiserfs partitions. Instructs reiserfs to assume that the device has \fInumber\fP blocks. This option is designed for use with devices which are under logical volume management (LVM). There is a special \fIresizer\fP utility which can be obtained from \fI\c +.URL "ftp://ftp.namesys.com/pub/reiserfsprogs" "" "\fP." +.RE +.sp +\fBuser_xattr\fP +.RS 4 +Enable Extended User Attributes. See the \fBattr\fP(1) manual page. +.RE +.sp +\fBacl\fP +.RS 4 +Enable POSIX Access Control Lists. See the \fBacl\fP(5) manual page. +.RE +.sp +\fBbarrier=none\fP / \fBbarrier=flush\fP +.RS 4 +This disables / enables the use of write barriers in the journaling code. \fBbarrier=none\fP disables, \fBbarrier=flush\fP enables (default). This also requires an IO stack which can support barriers, and if reiserfs gets an error on a barrier write, it will disable barriers again with a warning. Write barriers enforce proper on\-disk ordering of journal commits, making volatile disk write caches safe to use, at some performance penalty. If your disks are battery\-backed in one way or another, disabling barriers may safely improve performance. +.RE +.SS "Mount options for ubifs" +.sp +UBIFS is a flash filesystem which works on top of UBI volumes. Note that \fBatime\fP is not supported and is always turned off. +.sp +The device name may be specified as +.RS 3 +.ll -.6i +.sp +\fBubiX_Y\fP +.RS 4 +UBI device number \fBX\fP, volume number \fBY\fP +.RE +.sp +\fBubiY\fP +.RS 4 +UBI device number \fB0\fP, volume number \fBY\fP +.RE +.sp +\fBubiX:NAME\fP +.RS 4 +UBI device number \fBX\fP, volume with name \fBNAME\fP +.RE +.sp +\fBubi:NAME\fP +.RS 4 +UBI device number \fB0\fP, volume with name \fBNAME\fP +.RE +.br +.RE +.ll +.sp +Alternative \fB!\fP separator may be used instead of \fB:\fP. +.sp +The following mount options are available: +.sp +\fBbulk_read\fP +.RS 4 +Enable bulk\-read. VFS read\-ahead is disabled because it slows down the filesystem. Bulk\-Read is an internal optimization. Some flashes may read faster if the data are read at one go, rather than at several read requests. For example, OneNAND can do "read\-while\-load" if it reads more than one NAND page. +.RE +.sp +\fBno_bulk_read\fP +.RS 4 +Do not bulk\-read. This is the default. +.RE +.sp +\fBchk_data_crc\fP +.RS 4 +Check data CRC\-32 checksums. This is the default. +.RE +.sp +\fBno_chk_data_crc\fP +.RS 4 +Do not check data CRC\-32 checksums. With this option, the filesystem does not check CRC\-32 checksum for data, but it does check it for the internal indexing information. This option only affects reading, not writing. CRC\-32 is always calculated when writing the data. +.RE +.sp +\fBcompr=\fP{\fBnone\fP|\fBlzo\fP|\fBzlib\fP} +.RS 4 +Select the default compressor which is used when new files are written. It is still possible to read compressed files if mounted with the \fBnone\fP option. +.RE +.SS "Mount options for udf" +.sp +UDF is the "Universal Disk Format" filesystem defined by OSTA, the Optical Storage Technology Association, and is often used for DVD\-ROM, frequently in the form of a hybrid UDF/ISO\-9660 filesystem. It is, however, perfectly usable by itself on disk drives, flash drives and other block devices. See also \fIiso9660\fP. +.sp +\fBuid=\fP +.RS 4 +Make all files in the filesystem belong to the given user. uid=forget can be specified independently of (or usually in addition to) uid=<user> and results in UDF not storing uids to the media. In fact the recorded uid is the 32\-bit overflow uid \-1 as defined by the UDF standard. The value is given as either <user> which is a valid user name or the corresponding decimal user id, or the special string "forget". +.RE +.sp +\fBgid=\fP +.RS 4 +Make all files in the filesystem belong to the given group. gid=forget can be specified independently of (or usually in addition to) gid=<group> and results in UDF not storing gids to the media. In fact the recorded gid is the 32\-bit overflow gid \-1 as defined by the UDF standard. The value is given as either <group> which is a valid group name or the corresponding decimal group id, or the special string "forget". +.RE +.sp +\fBumask=\fP +.RS 4 +Mask out the given permissions from all inodes read from the filesystem. The value is given in octal. +.RE +.sp +\fBmode=\fP +.RS 4 +If \fBmode=\fP is set the permissions of all non\-directory inodes read from the filesystem will be set to the given mode. The value is given in octal. +.RE +.sp +\fBdmode=\fP +.RS 4 +If \fBdmode=\fP is set the permissions of all directory inodes read from the filesystem will be set to the given dmode. The value is given in octal. +.RE +.sp +\fBbs=\fP +.RS 4 +Set the block size. Default value prior to kernel version 2.6.30 was 2048. Since 2.6.30 and prior to 4.11 it was logical device block size with fallback to 2048. Since 4.11 it is logical block size with fallback to any valid block size between logical device block size and 4096. +.sp +For other details see the \fBmkudffs\fP(8) 2.0+ manpage, sections \fBCOMPATIBILITY\fP and \fBBLOCK SIZE\fP. +.RE +.sp +\fBunhide\fP +.RS 4 +Show otherwise hidden files. +.RE +.sp +\fBundelete\fP +.RS 4 +Show deleted files in lists. +.RE +.sp +\fBadinicb\fP +.RS 4 +Embed data in the inode. (default) +.RE +.sp +\fBnoadinicb\fP +.RS 4 +Don\(cqt embed data in the inode. +.RE +.sp +\fBshortad\fP +.RS 4 +Use short UDF address descriptors. +.RE +.sp +\fBlongad\fP +.RS 4 +Use long UDF address descriptors. (default) +.RE +.sp +\fBnostrict\fP +.RS 4 +Unset strict conformance. +.RE +.sp +\fBiocharset=\fP +.RS 4 +Set the NLS character set. This requires kernel compiled with \fBCONFIG_UDF_NLS\fP option. +.RE +.sp +\fButf8\fP +.RS 4 +Set the UTF\-8 character set. +.RE +.SS "Mount options for debugging and disaster recovery" +.sp +\fBnovrs\fP +.RS 4 +Ignore the Volume Recognition Sequence and attempt to mount anyway. +.RE +.sp +\fBsession=\fP +.RS 4 +Select the session number for multi\-session recorded optical media. (default= last session) +.RE +.sp +\fBanchor=\fP +.RS 4 +Override standard anchor location. (default= 256) +.RE +.sp +\fBlastblock=\fP +.RS 4 +Set the last block of the filesystem. +.RE +.SS "Unused historical mount options that may be encountered and should be removed" +.sp +\fBuid=ignore\fP +.RS 4 +Ignored, use uid=<user> instead. +.RE +.sp +\fBgid=ignore\fP +.RS 4 +Ignored, use gid=<group> instead. +.RE +.sp +\fBvolume=\fP +.RS 4 +Unimplemented and ignored. +.RE +.sp +\fBpartition=\fP +.RS 4 +Unimplemented and ignored. +.RE +.sp +\fBfileset=\fP +.RS 4 +Unimplemented and ignored. +.RE +.sp +\fBrootdir=\fP +.RS 4 +Unimplemented and ignored. +.RE +.SS "Mount options for ufs" +.sp +\fBufstype=\fP\fIvalue\fP +.RS 4 +UFS is a filesystem widely used in different operating systems. The problem are differences among implementations. Features of some implementations are undocumented, so its hard to recognize the type of ufs automatically. That\(cqs why the user must specify the type of ufs by mount option. Possible values are: +.sp +\fBold\fP +.RS 4 +Old format of ufs, this is the default, read only. (Don\(cqt forget to give the \fB\-r\fP option.) +.RE +.sp +\fB44bsd\fP +.RS 4 +For filesystems created by a BSD\-like system (NetBSD, FreeBSD, OpenBSD). +.RE +.sp +\fBufs2\fP +.RS 4 +Used in FreeBSD 5.x supported as read\-write. +.RE +.sp +\fB5xbsd\fP +.RS 4 +Synonym for ufs2. +.RE +.sp +\fBsun\fP +.RS 4 +For filesystems created by SunOS or Solaris on Sparc. +.RE +.sp +\fBsunx86\fP +.RS 4 +For filesystems created by Solaris on x86. +.RE +.sp +\fBhp\fP +.RS 4 +For filesystems created by HP\-UX, read\-only. +.RE +.sp +\fBnextstep\fP +.RS 4 +For filesystems created by NeXTStep (on NeXT station) (currently read only). +.RE +.sp +\fBnextstep\-cd\fP +.RS 4 +For NextStep CDROMs (block_size == 2048), read\-only. +.RE +.sp +\fBopenstep\fP +.RS 4 +For filesystems created by OpenStep (currently read only). The same filesystem type is also used by Mac OS X. +.RE +.RE +.sp +\fBonerror=\fP\fIvalue\fP +.RS 4 +Set behavior on error: +.sp +\fBpanic\fP +.RS 4 +If an error is encountered, cause a kernel panic. +.RE +.sp +[\fBlock\fP|\fBumount\fP|\fBrepair\fP] +.RS 4 +These mount options don\(cqt do anything at present; when an error is encountered only a console message is printed. +.RE +.RE +.SS "Mount options for umsdos" +.sp +See mount options for msdos. The \fBdotsOK\fP option is explicitly killed by \fIumsdos\fP. +.SS "Mount options for vfat" +.sp +First of all, the mount options for \fIfat\fP are recognized. The \fBdotsOK\fP option is explicitly killed by \fIvfat\fP. Furthermore, there are +.sp +\fBuni_xlate\fP +.RS 4 +Translate unhandled Unicode characters to special escaped sequences. This lets you backup and restore filenames that are created with any Unicode characters. Without this option, a \(aq?\(aq is used when no translation is possible. The escape character is \(aq:\(aq because it is otherwise invalid on the vfat filesystem. The escape sequence that gets used, where u is the Unicode character, is: \(aq:\(aq, (u & 0x3f), ((u>>6) & 0x3f), (u>>12). +.RE +.sp +\fBposix\fP +.RS 4 +Allow two files with names that only differ in case. This option is obsolete. +.RE +.sp +\fBnonumtail\fP +.RS 4 +First try to make a short name without sequence number, before trying \fIname~num.ext\fP. +.RE +.sp +\fButf8\fP +.RS 4 +UTF8 is the filesystem safe 8\-bit encoding of Unicode that is used by the console. It can be enabled for the filesystem with this option or disabled with utf8=0, utf8=no or utf8=false. If \fIuni_xlate\fP gets set, UTF8 gets disabled. +.RE +.sp +\fBshortname=\fP\fImode\fP +.RS 4 +Defines the behavior for creation and display of filenames which fit into 8.3 characters. If a long name for a file exists, it will always be the preferred one for display. There are four \fImode\fPs: +.sp +\fBlower\fP +.RS 4 +Force the short name to lower case upon display; store a long name when the short name is not all upper case. +.RE +.sp +\fBwin95\fP +.RS 4 +Force the short name to upper case upon display; store a long name when the short name is not all upper case. +.RE +.sp +\fBwinnt\fP +.RS 4 +Display the short name as is; store a long name when the short name is not all lower case or all upper case. +.RE +.sp +\fBmixed\fP +.RS 4 +Display the short name as is; store a long name when the short name is not all upper case. This mode is the default since Linux 2.6.32. +.RE +.RE +.SS "Mount options for usbfs" +.sp +\fBdevuid=\fP\fIuid\fP and \fBdevgid=\fP\fIgid\fP and \fBdevmode=\fP\fImode\fP +.RS 4 +Set the owner and group and mode of the device files in the usbfs filesystem (default: uid=gid=0, mode=0644). The mode is given in octal. +.RE +.sp +\fBbusuid=\fP\fIuid\fP and \fBbusgid=\fP\fIgid\fP and \fBbusmode=\fP\fImode\fP +.RS 4 +Set the owner and group and mode of the bus directories in the usbfs filesystem (default: uid=gid=0, mode=0555). The mode is given in octal. +.RE +.sp +\fBlistuid=\fP\fIuid\fP and \fBlistgid=\fP\fIgid\fP and \fBlistmode=\fP\fImode\fP +.RS 4 +Set the owner and group and mode of the file \fIdevices\fP (default: uid=gid=0, mode=0444). The mode is given in octal. +.RE +.SH "DM\-VERITY SUPPORT (EXPERIMENTAL)" +.sp +The device\-mapper verity target provides read\-only transparent integrity checking of block devices using kernel crypto API. The \fBmount\fP command can open the dm\-verity device and do the integrity verification before on the device filesystem is mounted. Requires libcryptsetup with in libmount (optionally via \fBdlopen\fP(3)). If libcryptsetup supports extracting the root hash of an already mounted device, existing devices will be automatically reused in case of a match. Mount options for dm\-verity: +.sp +\fBverity.hashdevice=\fP\fIpath\fP +.RS 4 +Path to the hash tree device associated with the source volume to pass to dm\-verity. +.RE +.sp +\fBverity.roothash=\fP\fIhex\fP +.RS 4 +Hex\-encoded hash of the root of \fIverity.hashdevice\fP. Mutually exclusive with \fIverity.roothashfile.\fP +.RE +.sp +\fBverity.roothashfile=\fP\fIpath\fP +.RS 4 +Path to file containing the hex\-encoded hash of the root of \fIverity.hashdevice.\fP Mutually exclusive with \fIverity.roothash.\fP +.RE +.sp +\fBverity.hashoffset=\fP\fIoffset\fP +.RS 4 +If the hash tree device is embedded in the source volume, \fIoffset\fP (default: 0) is used by dm\-verity to get to the tree. +.RE +.sp +\fBverity.fecdevice=\fP\fIpath\fP +.RS 4 +Path to the Forward Error Correction (FEC) device associated with the source volume to pass to dm\-verity. Optional. Requires kernel built with \fBCONFIG_DM_VERITY_FEC\fP. +.RE +.sp +\fBverity.fecoffset=\fP\fIoffset\fP +.RS 4 +If the FEC device is embedded in the source volume, \fIoffset\fP (default: 0) is used by dm\-verity to get to the FEC area. Optional. +.RE +.sp +\fBverity.fecroots=\fP\fIvalue\fP +.RS 4 +Parity bytes for FEC (default: 2). Optional. +.RE +.sp +\fBverity.roothashsig=\fP\fIpath\fP +.RS 4 +Path to \fBpkcs7\fP(1ssl) signature of root hash hex string. Requires crypt_activate_by_signed_key() from cryptsetup and kernel built with \fBCONFIG_DM_VERITY_VERIFY_ROOTHASH_SIG\fP. For device reuse, signatures have to be either used by all mounts of a device or by none. Optional. +.RE +.sp +Supported since util\-linux v2.35. +.sp +For example commands: +.sp +.if n .RS 4 +.nf +.fam C +mksquashfs /etc /tmp/etc.squashfs +dd if=/dev/zero of=/tmp/etc.hash bs=1M count=10 +veritysetup format /tmp/etc.squashfs /tmp/etc.hash +openssl smime \-sign \-in <hash> \-nocerts \-inkey private.key \(rs +\-signer private.crt \-noattr \-binary \-outform der \-out /tmp/etc.roothash.p7s +mount \-o verity.hashdevice=/tmp/etc.hash,verity.roothash=<hash>,\(rs +verity.roothashsig=/tmp/etc.roothash.p7s /tmp/etc.squashfs /mnt +.fam +.fi +.if n .RE +.sp +create squashfs image from \fI/etc\fP directory, verity hash device and mount verified filesystem image to \fI/mnt\fP. The kernel will verify that the root hash is signed by a key from the kernel keyring if roothashsig is used. +.SH "LOOP\-DEVICE SUPPORT" +.sp +One further possible type is a mount via the loop device. For example, the command +.RS 3 +.ll -.6i +.sp +\fBmount /tmp/disk.img /mnt \-t vfat \-o loop=/dev/loop3\fP +.br +.RE +.ll +.sp +will set up the loop device \fI/dev/loop3\fP to correspond to the file \fI/tmp/disk.img\fP, and then mount this device on \fI/mnt\fP. +.sp +If no explicit loop device is mentioned (but just an option \(aq\fB\-o loop\fP\(aq is given), then \fBmount\fP will try to find some unused loop device and use that, for example +.RS 3 +.ll -.6i +.sp +\fBmount /tmp/disk.img /mnt \-o loop\fP +.br +.RE +.ll +.sp +The \fBmount\fP command \fBautomatically\fP creates a loop device from a regular file if a filesystem type is not specified or the filesystem is known for libblkid, for example: +.RS 3 +.ll -.6i +.sp +\fBmount /tmp/disk.img /mnt\fP +.sp +\fBmount \-t ext4 /tmp/disk.img /mnt\fP +.br +.RE +.ll +.sp +This type of mount knows about three options, namely \fBloop\fP, \fBoffset\fP and \fBsizelimit\fP, that are really options to \fBlosetup\fP(8). (These options can be used in addition to those specific to the filesystem type.) +.sp +Since Linux 2.6.25 auto\-destruction of loop devices is supported, meaning that any loop device allocated by \fBmount\fP will be freed by \fBumount\fP independently of \fI/etc/mtab\fP. +.sp +You can also free a loop device by hand, using \fBlosetup \-d\fP or \fBumount \-d\fP. +.sp +Since util\-linux v2.29, \fBmount\fP re\-uses the loop device rather than initializing a new device if the same backing file is already used for some loop device with the same offset and sizelimit. This is necessary to avoid a filesystem corruption. +.SH "EXIT STATUS" +.sp +\fBmount\fP has the following exit status values (the bits can be ORed): +.sp +\fB0\fP +.RS 4 +success +.RE +.sp +\fB1\fP +.RS 4 +incorrect invocation or permissions +.RE +.sp +\fB2\fP +.RS 4 +system error (out of memory, cannot fork, no more loop devices) +.RE +.sp +\fB4\fP +.RS 4 +internal \fBmount\fP bug +.RE +.sp +\fB8\fP +.RS 4 +user interrupt +.RE +.sp +\fB16\fP +.RS 4 +problems writing or locking \fI/etc/mtab\fP +.RE +.sp +\fB32\fP +.RS 4 +mount failure +.RE +.sp +\fB64\fP +.RS 4 +some mount succeeded +.sp +The command \fBmount \-a\fP returns 0 (all succeeded), 32 (all failed), or 64 (some failed, some succeeded). +.RE +.SH "EXTERNAL HELPERS" +.sp +The syntax of external mount helpers is: +.sp +\fB/sbin/mount.\fP\fIsuffix\fP \fIspec dir\fP [\fB\-sfnv\fP] [\fB\-N\fP \fInamespace\fP] [\fB\-o\fP \fIoptions\fP] [\fB\-t\fP \fItype\fP\fB.\fP\fIsubtype\fP] +.sp +where the \fIsuffix\fP is the filesystem type and the \fB\-sfnvoN\fP options have the same meaning as the normal mount options. The \fB\-t\fP option is used for filesystems with subtypes support (for example \fB/sbin/mount.fuse \-t fuse.sshfs\fP). +.sp +The command \fBmount\fP does not pass the mount options \fBunbindable\fP, \fBrunbindable\fP, \fBprivate\fP, \fBrprivate\fP, \fBslave\fP, \fBrslave\fP, \fBshared\fP, \fBrshared\fP, \fBauto\fP, \fBnoauto\fP, \fBcomment\fP, \fBx\-\fP*, \fBloop\fP, \fBoffset\fP and \fBsizelimit\fP to the mount.<suffix> helpers. All other options are used in a comma\-separated list as an argument to the \fB\-o\fP option. +.SH "ENVIRONMENT" +.sp +LIBMOUNT_FSTAB=<path> +.RS 4 +overrides the default location of the \fIfstab\fP file (ignored for suid) +.RE +.sp +LIBMOUNT_MTAB=<path> +.RS 4 +overrides the default location of the \fImtab\fP file (ignored for suid) +.RE +.sp +LIBMOUNT_DEBUG=all +.RS 4 +enables libmount debug output +.RE +.sp +LIBBLKID_DEBUG=all +.RS 4 +enables libblkid debug output +.RE +.sp +LOOPDEV_DEBUG=all +.RS 4 +enables loop device setup debug output +.RE +.SH "FILES" +.sp +See also "\fBThe files /etc/fstab, /etc/mtab and /proc/mounts\fP" section above. +.sp +\fI/etc/fstab\fP +.RS 4 +filesystem table +.RE +.sp +\fI/run/mount\fP +.RS 4 +libmount private runtime directory +.RE +.sp +\fI/etc/mtab\fP +.RS 4 +table of mounted filesystems or symlink to \fI/proc/mounts\fP +.RE +.sp +\fI/etc/mtab~\fP +.RS 4 +lock file (unused on systems with \fImtab\fP symlink) +.RE +.sp +\fI/etc/mtab.tmp\fP +.RS 4 +temporary file (unused on systems with \fImtab\fP symlink) +.RE +.sp +\fI/etc/filesystems\fP +.RS 4 +a list of filesystem types to try +.RE +.SH "HISTORY" +.sp +A \fBmount\fP command existed in Version 5 AT&T UNIX. +.SH "BUGS" +.sp +It is possible for a corrupted filesystem to cause a crash. +.sp +Some Linux filesystems don\(cqt support \fB\-o sync\fP and \fB\-o dirsync\fP (the ext2, ext3, ext4, fat and vfat filesystems \fIdo\fP support synchronous updates (a la BSD) when mounted with the \fBsync\fP option). +.sp +The \fB\-o remount\fP may not be able to change mount parameters (all \fIext2fs\fP\-specific parameters, except \fBsb\fP, are changeable with a remount, for example, but you can\(cqt change \fBgid\fP or \fBumask\fP for the \fIfatfs\fP). +.sp +It is possible that the files \fI/etc/mtab\fP and \fI/proc/mounts\fP don\(cqt match on systems with a regular \fImtab\fP file. The first file is based only on the \fBmount\fP command options, but the content of the second file also depends on the kernel and others settings (e.g. on a remote NFS server \(em in certain cases the \fBmount\fP command may report unreliable information about an NFS mount point and the \fI/proc/mount\fP file usually contains more reliable information.) This is another reason to replace the \fImtab\fP file with a symlink to the \fI/proc/mounts\fP file. +.sp +Checking files on NFS filesystems referenced by file descriptors (i.e. the \fBfcntl\fP and \fBioctl\fP families of functions) may lead to inconsistent results due to the lack of a consistency check in the kernel even if the \fBnoac\fP mount option is used. +.sp +The \fBloop\fP option with the \fBoffset\fP or \fBsizelimit\fP options used may fail when using older kernels if the \fBmount\fP command can\(cqt confirm that the size of the block device has been configured as requested. This situation can be worked around by using the \fBlosetup\fP(8) command manually before calling \fBmount\fP with the configured loop device. +.SH "AUTHORS" +.sp +.MTO "kzak\(atredhat.com" "Karel Zak" "" +.SH "SEE ALSO" +.sp +\fBmount\fP(2), +\fBumount\fP(2), +\fBfilesystems\fP(5), +\fBfstab\fP(5), +\fBnfs\fP(5), +\fBxfs\fP(5), +\fBmount_namespaces\fP(7), +\fBxattr\fP(7), +\fBe2label\fP(8), +\fBfindmnt\fP(8), +\fBlosetup\fP(8), +\fBlsblk\fP(8), +\fBmke2fs\fP(8), +\fBmountd\fP(8), +\fBnfsd\fP(8), +\fBswapon\fP(8), +\fBtune2fs\fP(8), +\fBumount\fP(8), +\fBxfs_admin\fP(8) +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBmount\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "." diff --git a/upstream/opensuse-leap-15-6/man8/mount.nfs.8 b/upstream/opensuse-leap-15-6/man8/mount.nfs.8 new file mode 100644 index 00000000..0409c96f --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/mount.nfs.8 @@ -0,0 +1,93 @@ +.\"@(#)mount.nfs.8" +.TH MOUNT.NFS 8 "5 Jun 2006" +.SH NAME +mount.nfs, mount.nfs4 \- mount a Network File System +.SH SYNOPSIS +.BI "mount.nfs" " remotetarget dir" " [\-rvVwfnsh ] [\-o " options "] +.SH DESCRIPTION +.BR mount.nfs +is a part of +.BR nfs (5) +utilities package, which provides NFS client functionality. + +.BR mount.nfs +is meant to be used by the +.BR mount (8) +command for mounting NFS shares. This subcommand, however, can also be used as a standalone command with limited functionality. + +.I remotetarget +is a server share usually in the form of +.BR servername:/path/to/share. +.I dir +is the directory on which the file system is to be mounted. + +Under Linux 2.6.32 and later kernel versions, +.BR mount.nfs +can mount all NFS file system versions. Under earlier Linux kernel versions, +.BR mount.nfs4 +must be used for mounting NFSv4 file systems while +.BR mount.nfs +must be used for NFSv3 and v2. + +.SH OPTIONS +.TP +.BI "\-r" +Mount file system readonly. +.TP +.BI "\-v" +Be verbose. +.TP +.BI "\-V" +Print version. +.TP +.BI "\-w" +Mount file system read-write. +.TP +.BI "\-f" +Fake mount. Don't actually call the mount system call. +.TP +.BI "\-n" +Do not update +.I /etc/mtab. +By default, an entry is created in +.I /etc/mtab +for every mounted file system. Use this option to skip making an entry. +.TP +.BI "\-s" +Tolerate sloppy mount options rather than fail. +.TP +.BI "\-h" +Print help message. +.TP +.BI "nfsoptions" +Refer to +.BR nfs (5) +or +.BR mount (8) +manual pages. + +.SH NOTE +For further information please refer +.BR nfs (5) +and +.BR mount (8) +manual pages. + +.SH FILES +.TP 18n +.I /etc/fstab +file system table +.TP +.I /etc/mtab +table of mounted file systems +.TP +.I /etc/nfsmount.conf +Configuration file for NFS mounts +.PD +.SH "SEE ALSO" +.BR nfs (5), +.BR nfsmount.conf (5), +.BR mount (8), + +.SH "AUTHOR" +Amit Gud <agud@redhat.com> diff --git a/upstream/opensuse-leap-15-6/man8/mountd.8 b/upstream/opensuse-leap-15-6/man8/mountd.8 new file mode 100644 index 00000000..21daa15b --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/mountd.8 @@ -0,0 +1,363 @@ +.\"@(#)rpc.mountd.8" +.\" +.\" Copyright (C) 1999 Olaf Kirch <okir@monad.swb.de> +.\" Modified by Paul Clements, 2004. +.\" +.TH rpc.mountd 8 "31 Dec 2009" +.SH NAME +rpc.mountd \- NFS mount daemon +.SH SYNOPSIS +.BI "/usr/sbin/rpc.mountd [" options "]" +.SH DESCRIPTION +The +.B rpc.mountd +daemon implements the server side of the NFS MOUNT protocol, +an NFS side protocol used by NFS version 2 [RFC1094] and NFS version 3 [RFC1813]. +It also responds to requests from the Linux kernel to authenticate +clients and provides details of access permissions. +.PP +The NFS server +.RI ( nfsd ) +maintains a cache of authentication and authorization information which +is used to identify the source of each requent, and then what access +permissions that source has to any local filesystem. When required +information is not found in the cache, the server sends a request to +.B mountd +to fill in the missing information. Mountd uses a table of information +stored in +.B /var/lib/nfs/etab +and maintained by +.BR exportfs (8), +possibly based on the contents of +.BR exports (5), +to respond to each request. +.SS Mounting exported NFS File Systems +The NFS MOUNT protocol has several procedures. +The most important of these are +MNT (mount an export) and +UMNT (unmount an export). +.PP +A MNT request has two arguments: an explicit argument that +contains the pathname of the root directory of the export to be mounted, +and an implicit argument that is the sender's IP address. +.PP +When receiving a MNT request from an NFS client, +.B rpc.mountd +checks both the pathname and the sender's IP address against its export table. +If the sender is permitted to access the requested export, +.B rpc.mountd +returns an NFS file handle for the export's root directory to the client. +The client can then use the root file handle and NFS LOOKUP requests +to navigate the directory structure of the export. +.SS The rmtab File +The +.B rpc.mountd +daemon registers every successful MNT request by adding an entry to the +.I /var/lib/nfs/rmtab +file. +When receivng a UMNT request from an NFS client, +.B rpc.mountd +simply removes the matching entry from +.IR /var/lib/nfs/rmtab , +as long as the access control list for that export allows that sender +to access the export. +.PP +Clients can discover the list of file systems an NFS server is +currently exporting, or the list of other clients that have mounted +its exports, by using the +.BR showmount (8) +command. +.BR showmount (8) +uses other procedures in the NFS MOUNT protocol to report information +about the server's exported file systems. +.PP +Note, however, that there is little to guarantee that the contents of +.I /var/lib/nfs/rmtab +are accurate. +A client may continue accessing an export even after invoking UMNT. +If the client reboots without sending a UMNT request, stale entries +remain for that client in +.IR /var/lib/nfs/rmtab . +.SS Mounting File Systems with NFSv4 +Version 4 (and later) of NFS does not use a separate NFS MOUNT +protocol. Instead mounting is performed using regular NFS requests +handled by the NFS server in the Linux kernel +.RI ( nfsd ). +Consequently +.I /var/lib/nfs/rmtab +is not updated to reflect any NFSv4 activity. +.SH OPTIONS +.TP +.B \-d kind " or " \-\-debug kind +Turn on debugging. Valid kinds are: all, auth, call, general and parse. +.TP +.BR \-l " or " \-\-log\-auth +Enable logging of responses to authentication and access requests from +nfsd. Each response is then cached by the kernel for 30 minutes (or as set by +.B \-\-ttl +below), and will be refreshed after 15 minutes (half the ttl time) if +the relevant client remains active. +Note that +.B -l +is equivalent to +.B "-d auth" +and so can be enabled in +.B /etc/nfs.conf +with +.B "\[dq]debug = auth\[dq]" +in the +.B "[mountd]" +section. +.IP +.B rpc.mountd +will always log authentication responses to MOUNT requests when NFSv3 is +used, but to get similar logs for NFSv4, this option is required. +.TP +.BR \-i " or " \-\-cache\-use\-ipaddr +Normally each client IP address is matched against each host identifier +(name, wildcard, netgroup etc) found in +.B /etc/exports +and a combined identity is formed from all matching identifiers. +Often many clients will map to the same combined identity so performing +this mapping reduces the number of distinct access details that the +kernel needs to store. +Specifying the +.B \-i +option suppresses this mapping so that access to each filesystem is +requested and cached separately for each client IP address. Doing this +can increase the burden of updating the cache slightly, but can make the +log messages produced by the +.B -l +option easier to read. +.TP +.B \-T " or " \-\-ttl +Provide a time-to-live (TTL) for cached information given to the kernel. +The kernel will normally request an update if the information is needed +after half of this time has expired. Increasing the provided number, +which is in seconds, reduces the rate of cache update requests, and this +is particularly noticeable when these requests are logged with +.BR \-l . +However increasing also means that changes to hostname to address +mappings can take longer to be noticed. +The default TTL is 1800 (30 minutes). +.TP +.B \-F " or " \-\-foreground +Run in foreground (do not daemonize) +.TP +.B \-h " or " \-\-help +Display usage message. +.TP +.B \-o num " or " \-\-descriptors num +Set the limit of the number of open file descriptors to num. The +default is to leave the limit unchanged. +.TP +.B \-N mountd-version " or " \-\-no-nfs-version mountd-version +This option can be used to request that +.B rpc.mountd +do not offer certain versions of NFS. The current version of +.B rpc.mountd +can support both NFS version 2, 3 and 4. If the +either one of these version should not be offered, +.B rpc.mountd +must be invoked with the option +.B "\-\-no-nfs-version <vers>" . +.TP +.B \-n " or " \-\-no-tcp +Don't advertise TCP for mount. +.TP +.B \-p num " or " \-P num " or " \-\-port num +Specifies the port number used for RPC listener sockets. +If this option is not specified, +.B rpc.mountd +will try to consult +.IR /etc/services , +if gets port succeed, set the same port for all listener socket, +otherwise chooses a random ephemeral port for each listener socket. +.IP +This option can be used to fix the port value of +.BR rpc.mountd 's +listeners when NFS MOUNT requests must traverse a firewall +between clients and servers. +.TP +.B \-H " prog or " \-\-ha-callout prog +Specify a high availability callout program. +This program receives callouts for all MOUNT and UNMOUNT requests. +This allows +.B rpc.mountd +to be used in a High Availability NFS (HA-NFS) environment. +.IP +The callout program is run with 4 arguments. +The first is +.B mount +or +.B unmount +depending on the reason for the callout. +The second will be the name of the client performing the mount. +The third will be the path that the client is mounting. +The last is the number of concurrent mounts that we believe the client +has of that path. +.IP +This callout is not needed with 2.6 and later kernels. +Instead, mount the nfsd filesystem on +.IR /proc/fs/nfsd . +.TP +.BI "\-s," "" " \-\-state\-directory\-path " directory +Specify a directory in which to place statd state information. +If this option is not specified the default of +.I /var/lib/nfs +is used. +.TP +.BI "\-r," "" " \-\-reverse\-lookup" +.B rpc.mountd +tracks IP addresses in the +.I rmtab +file. When a DUMP request is made (by +someone running +.BR "showmount -a" , +for instance), it returns IP addresses instead +of hostnames by default. This option causes +.B rpc.mountd +to perform a reverse lookup on each IP address and return that hostname instead. +Enabling this can have a substantial negative effect on performance +in some situations. +.TP +.BR "\-t N" " or " "\-\-num\-threads=N " or " \-\-num\-threads N " +This option specifies the number of worker threads that rpc.mountd +spawns. The default is 1 thread, which is probably enough. More +threads are usually only needed for NFS servers which need to handle +mount storms of hundreds of NFS mounts in a few seconds, or when +your DNS server is slow or unreliable. +.TP +.B \-u " or " \-\-no-udp +Don't advertise UDP for mounting +.TP +.B \-V version " or " \-\-nfs-version version +This option can be used to request that +.B rpc.mountd +offer certain versions of NFS. The current version of +.B rpc.mountd +can support both NFS version 2 and the newer version 3. +.TP +.B \-v " or " \-\-version +Print the version of +.B rpc.mountd +and exit. +.TP +.B \-g " or " \-\-manage-gids +Accept requests from the kernel to map user id numbers into lists of +group id numbers for use in access control. An NFS request will +normally (except when using Kerberos or other cryptographic +authentication) contains a user-id and a list of group-ids. Due to a +limitation in the NFS protocol, at most 16 groups ids can be listed. +If you use the +.B \-g +flag, then the list of group ids received from the client will be +replaced by a list of group ids determined by an appropriate lookup on +the server. Note that the 'primary' group id is not affected so a +.B newgroup +command on the client will still be effective. This function requires +a Linux Kernel with version at least 2.6.21. + +.SH CONFIGURATION FILE +Many of the options that can be set on the command line can also be +controlled through values set in the +.B [mountd] +or, in some cases, the +.B [nfsd] +sections of the +.I /etc/nfs.conf +configuration file. +Values recognized in the +.B [mountd] +section include +.BR manage-gids , +.BR cache\-use\-ipaddr , +.BR descriptors , +.BR port , +.BR threads , +.BR ttl , +.BR reverse-lookup ", and" +.BR state-directory-path , +.B ha-callout +which each have the same effect as the option with the same name. + +The values recognized in the +.B [nfsd] +section include +.BR TCP , +.BR UDP , +.BR vers2 , +.BR vers3 ", and" +.B vers4 +which each have same same meaning as given by +.BR rpc.nfsd (8). + +.SH TCP_WRAPPERS SUPPORT +You can protect your +.B rpc.mountd +listeners using the +.B tcp_wrapper +library or +.BR iptables (8). +.PP +Note that the +.B tcp_wrapper +library supports only IPv4 networking. +.PP +Add the hostnames of NFS peers that are allowed to access +.B rpc.mountd +to +.IR /etc/hosts.allow . +Use the daemon name +.B mountd +even if the +.B rpc.mountd +binary has a different name. +.PP +Hostnames used in either access file will be ignored when +they can not be resolved into IP addresses. +For further information see the +.BR tcpd (8) +and +.BR hosts_access (5) +man pages. +.SS IPv6 and TI-RPC support +TI-RPC is a pre-requisite for supporting NFS on IPv6. +If TI-RPC support is built into +.BR rpc.mountd , +it attempts to start listeners on network transports marked 'visible' in +.IR /etc/netconfig . +As long as at least one network transport listener starts successfully, +.B rpc.mountd +will operate. +.SH FILES +.TP 2.5i +.I /etc/exports +input file for +.BR exportfs , +listing exports, export options, and access control lists +.TP 2.5i +.I /var/lib/nfs/rmtab +table of clients accessing server's exports +.SH SEE ALSO +.BR exportfs (8), +.BR exports (5), +.BR showmount (8), +.BR rpc.nfsd (8), +.BR rpc.rquotad (8), +.BR nfs (5), +.BR nfs.conf (5), +.BR tcpd (8), +.BR hosts_access (5), +.BR iptables (8), +.BR netconfig (5) +.sp +RFC 1094 - "NFS: Network File System Protocol Specification" +.br +RFC 1813 - "NFS Version 3 Protocol Specification" +.br +RFC 7530 - "Network File System (NFS) Version 4 Protocol" +.br +RFC 8881 - "Network File System (NFS) Version 4 Minor Version 1 Protocol" +.SH AUTHOR +Olaf Kirch, H. J. Lu, G. Allan Morris III, and a host of others. diff --git a/upstream/opensuse-leap-15-6/man8/mountstats.8 b/upstream/opensuse-leap-15-6/man8/mountstats.8 new file mode 100644 index 00000000..a55130bb --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/mountstats.8 @@ -0,0 +1,146 @@ +.\" +.\" mountstats(8) +.\" +.TH mountstats 8 "12 Dec 2014" +.SH NAME +mountstats \- Displays various NFS client per-mount statistics +.SH SYNOPSIS +.B mountstats +.RB [ \-h | \-\-help ] +.RB [ \-v | \-\-version ] +.RB [ \-f | \-\-file +.IR infile ] +.RB [ \-S | \-\-since +.IR sincefile ] +.\" .RB [ \-n | \-\-nfs | \-r | \-\-rpc | \-R | \-\-raw ] +[ +.RB [ \-n | \-\-nfs ] +| +.RB [ \-r | \-\-rpc ] +| +.RB [ \-R | \-\-raw ] +] +.RI [ mountpoint ] ... +.P +.B mountstats iostat +.RB [ \-h | \-\-help ] +.RB [ \-v | \-\-version ] +.RB [ \-f | \-\-file +.IR infile ] +.RB [ \-S | \-\-since +.IR sincefile ] +.RI [ interval ] +.RI [ count ] +.RI [ mountpoint ] ... +.P +.B mounstats nfsstat +.RB [ \-h | \-\-help ] +.RB [ \-v | \-\-version ] +.RB [ \-f | \-\-file +.IR infile ] +.RB [ \-S | \-\-since +.IR sincefile ] +.RB [ \-3 ] +.RB [ \-4 ] +.RI [ mountpoint ] ... +.P +.SH DESCRIPTION +.RB "The " mountstats " command displays various NFS client statisitics for each given" +.IR mountpoint . +.P +.RI "If no " mountpoint " is given, statistics will be displayed for all NFS mountpoints on the client." +.SS Sub-commands +Valid +.BR mountstats (8) +subcommands are: +.IP "\fBmountstats\fP" +Display a combination of per-op RPC statistics, NFS event counts, and NFS byte counts. This is the default sub-command that will be executed if no sub-command is given. +.IP "\fBiostat\fP" +Display iostat-like statistics. +.IP "\fBnfsstat\fP" +Display nfsstat-like statistics. +.SH OPTIONS +.SS Options valid for all sub-commands +.TP +.B \-h, \-\-help +show the help message and exit +.TP +.B \-v, \-\-version +show program's version number and exit +.TP +\fB\-f \fIinfile\fR, \fB\-\-file \fIinfile +Read stats from +.I infile +instead of +.IR /proc/self/mountstats ". " infile +must be in the same format as +.IR /proc/self/mountstats . +This may be used with the +.BR \-S | \-\-since +options to display the delta between two different points in time. +This may not be used with the +.IR interval " or " count +options of the +.B iostat +sub-command. +.TP +\fB\-S \fIsincefile\fR, \fB\-\-since \fIsincefile +Show difference between current stats and those in +.IR sincefile ". " sincefile +must be in the same format as +.IR /proc/self/mountstats . +This may be used with the +.BR \-f | \-\-file +options to display the delta between two different points in time. +This may not be used with the +.IR interval " or " count +options of the +.B iostat +sub-command. +.SS Options specific to the mountstats sub-command +.B \-n, \-\-nfs +Display only the NFS statistics +.TP +.B \-r, \-\-rpc +Display only the RPC statistics +.TP +.B \-R, \-\-raw +Display only the raw statistics. This is intended for use with the +.BR \-f | \-\-file +and +.BR \-S | \-\-since +options. +.SS Options specific to the iostat sub-command +.IP "\fIinterval\fP" +Specifies the amount of time in seconds between each report. The first report contains statistics for the time since each file system was mounted. Each subsequent report contains statistics collected during the interval since the previous report. This may not be used with the +.BR \-f | \-\-file +or +.BR \-S | \-\-since +options. +.P +.IP "\fIcount\fP" +Determines the number of reports generated at +.I interval +seconds apart. If the +.I interval +parameter is specified without the +.I count +parameter, the command generates reports continuously. This may not be used with the +.BR \-f | \-\-file +or +.BR \-S | \-\-since +options. +.SS Options specific to the nfsstat sub-command +.IP "\fB\-3\fP" +Show only NFS version 3 statistics. The default is to show both version 3 and version 4 statistics. +.IP "\fB\-4\fP" +Show only NFS version 4 statistics. The default is to show both version 3 and version 4 statistics. +.SH FILES +.TP +.B /proc/self/mountstats +.SH SEE ALSO +.BR iostat (8), +.BR nfsiostat (8), +.BR nfsstat (8) +.SH AUTHOR +Chuck Lever <chuck.lever@oracle.com> diff --git a/upstream/opensuse-leap-15-6/man8/nfsd.8 b/upstream/opensuse-leap-15-6/man8/nfsd.8 new file mode 100644 index 00000000..020092dc --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/nfsd.8 @@ -0,0 +1,197 @@ +.\" +.\" nfsd(8) +.\" +.\" Copyright (C) 1999 Olaf Kirch <okir@monad.swb.de> +.TH rpc.nfsd 8 "20 Feb 2014" +.SH NAME +rpc.nfsd \- NFS server process +.SH SYNOPSIS +.BI "/usr/sbin/rpc.nfsd [" options "]" " "nproc +.SH DESCRIPTION +The +.B rpc.nfsd +program implements the user level part of the NFS service. The +main functionality is handled by the +.B nfsd +kernel module. The user space program merely specifies what sort of sockets +the kernel service should listen on, what NFS versions it should support, and +how many kernel threads it should use. +.P +The +.B rpc.mountd +server provides an ancillary service needed to satisfy mount requests +by NFS clients. +.SH OPTIONS +.TP +.B \-d " or " \-\-debug +enable logging of debugging messages +.TP +.B \-H " or " \-\-host hostname +specify a particular hostname (or address) that NFS requests will +be accepted on. By default, +.B rpc.nfsd +will accept NFS requests on all known network addresses. +Note that +.B lockd +(which performs file locking services for NFS) may still accept +request on all known network addresses. This may change in future +releases of the Linux Kernel. This option can be used multiple times +to listen to more than one interface. +.TP +.B \-S " or " \-\-scope scope +NFSv4.1 and later require the server to report a "scope" which is used +by the clients to detect if two connections are to the same server. +By default Linux NFSD uses the host name as the scope. +.sp +It is particularly important for high-availablity configurations to ensure +that all potential server nodes report the same server scope. +.TP +.B \-p " or " \-\-port port +specify a different port to listen on for NFS requests. By default, +.B rpc.nfsd +will listen on port 2049. +.TP +.B \-r " or " \-\-rdma +specify that NFS requests on the standard RDMA port ("nfsrdma", port +20049) should be honored. +.TP +.BI \-\-rdma= port +Listen for RDMA requests on an alternate port - may be a number or a +name listed in +.BR /etc/services . +.TP +.B \-N " or " \-\-no-nfs-version vers +This option can be used to request that +.B rpc.nfsd +does not offer certain versions of NFS. The current version of +.B rpc.nfsd +can support major NFS versions 2,3,4 and the minor versions 4.1 and 4.2. +.TP +.B \-s " or " \-\-syslog +By default, +.B rpc.nfsd +logs error messages (and debug messages, if enabled) to stderr. This option makes +.B rpc.nfsd +log these messages to syslog instead. Note that errors encountered during +option processing will still be logged to stderr regardless of this option. +.TP +.B \-T " or " \-\-no-tcp +Disable +.B rpc.nfsd +from accepting TCP connections from clients. +.TP +.B \-U " or " \-\-no-udp +Disable +.B rpc.nfsd +from accepting UDP connections from clients. +.TP +.B \-V " or " \-\-nfs-version vers +This option can be used to request that +.B rpc.nfsd +offer certain versions of NFS. The current version of +.B rpc.nfsd +can support major NFS versions 2,3,4 and the minor versions 4.1 and 4.2. +.TP +.B \-L " or " \-\-lease-time seconds +Set the lease-time used for NFSv4. This corresponds to how often +clients need to confirm their state with the server. Valid range is +from 10 to 3600 seconds. +.TP +.B \-G " or " \-\-grace-time seconds +Set the grace-time used for NFSv4 and NLM (for NFSv2 and NFSv3). +New file open requests (NFSv4) and new file locks (NLM) will not be +allowed until after this time has passed to allow clients to recover state. +.TP +.I nproc +specify the number of NFS server threads. By default, eight +threads are started. However, for optimum performance several threads +should be used. The actual figure depends on the number of and the work +load created by the NFS clients, but a useful starting point is +eight threads. Effects of modifying that number can be checked using +the +.BR nfsstat (8) +program. +.P +Note that if the NFS server is already running, then the options for +specifying host, port, and protocol will be ignored. The number of +processes given will be the only option considered, and the number of +active +.B nfsd +processes will be increased or decreased to match this number. +In particular +.B rpc.nfsd 0 +will stop all threads and thus close any open connections. + +.SH CONFIGURATION FILE +Many of the options that can be set on the command line can also be +controlled through values set in the +.B [nfsd] +section of the +.I /etc/nfs.conf +configuration file. Values recognized include: +.TP +.B threads +The number of threads to start. +.TP +.B host +A host name, or comma separated list of host names, that +.I rpc.nfsd +will listen on. Use of the +.B --host +option replaces all host names listed here. +.TP +.B scope +Set the server scope. +.TP +.B grace-time +The grace time, for both NFSv4 and NLM, in seconds. +.TP +.B lease-time +The lease time for NFSv4, in seconds. +.TP +.B port +Set the port for TCP/UDP to bind to. +.TP +.B rdma +Set RDMA port. Use "rdma=nfsrdma" to enable standard port. +.TP +.B UDP +Enable (with "on" or "yes" etc) or disable ("off", "no") UDP support. +.TP +.B TCP +Enable or disable TCP support. +.TP +.B vers2 +.TP +.B vers3 +.TP +.B vers4 +Enable or disable a major NFS version. 3 and 4 are normally enabled +by default. +.TP +.B vers4.1 +.TP +.B vers4.2 +Setting these to "off" or similar will disable the selected minor +versions. Setting to "on" will enable them. The default values +are determined by the kernel, and usually minor versions default to +being enabled once the implementation is sufficiently complete. + +.SH NOTES +If the program is built with TI-RPC support, it will enable any protocol and +address family combinations that are marked visible in the +.B netconfig +database. + +.SH SEE ALSO +.BR nfsd (7), +.BR rpc.mountd (8), +.BR exports (5), +.BR exportfs (8), +.BR nfs.conf (5), +.BR rpc.rquotad (8), +.BR nfsstat (8), +.BR netconfig(5). +.SH AUTHOR +Olaf Kirch, Bill Hawes, H. J. Lu, G. Allan Morris III, +and a host of others. diff --git a/upstream/opensuse-leap-15-6/man8/nfsdcltrack.8 b/upstream/opensuse-leap-15-6/man8/nfsdcltrack.8 new file mode 100644 index 00000000..cc24b7a2 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/nfsdcltrack.8 @@ -0,0 +1,112 @@ +.ie \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.el \{\ +. de IX +.. +.\} +.IX Title "NFSDCLTRACK 8" +.TH NFSDCLTRACK 8 "2012-10-24" "" "" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh +.SH "NAME" +nfsdcltrack \- NFSv4 Client Tracking Callout Program +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +nfsdcltrack [\-d] [\-f] [\-s stable storage dir] <command> <args...> +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +nfsdcltrack is the NFSv4 client tracking callout program. It is not necessary +to install this program on machines that are not acting as NFSv4 servers. +.PP +When a network partition is combined with a server reboot, there are +edge conditions that can cause the server to grant lock reclaims when +other clients have taken conflicting locks in the interim. A more detailed +explanation of this issue is described in \s-1RFC\s0 3530, section 8.6.3 +and in \s-1RFC\s0 5661, section 8.4.3. +.PP +In order to prevent these problems, the server must track a small amount +of per-client information on stable storage. This program provides the +userspace piece of that functionality. When the kernel needs to manipulate +the database that stores this info, it will execute this program to handle +it. +.SH "OPTIONS" +.IX Header "OPTIONS" +.IP "\fB\-d\fR, \fB\-\-debug\fR" 4 +.IX Item "-d, --debug" +Enable debug level logging. +.IP "\fB\-f\fR, \fB\-\-foreground\fR" 4 +.IX Item "-f, --foreground" +Log to stderr instead of syslog. +.IP "\fB\-s\fR \fIstoragedir\fR, \fB\-\-storagedir\fR=\fIstorage_dir\fR" 4 +.IX Item "-s storagedir, --storagedir=storage_dir" +Directory where stable storage information should be kept. The default +value is \fI/var/lib/nfs/nfsdcltrack\fR. +.SH "COMMANDS" +.IX Header "COMMANDS" +nfsdcltrack requires a command for each invocation. Supported commands +are: +.IP "\fBinit\fR" 4 +.IX Item "init" +Initialize the database. This command requires no argument. +.IP "\fBcreate\fR" 4 +.IX Item "create" +Create a new client record (or update the timestamp on an existing one). This command requires a hex-encoded nfs_client_id4 as an argument. +.IP "\fBremove\fR" 4 +.IX Item "remove" +Remove a client record from the database. This command requires a hex-encoded nfs_client_id4 as an argument. +.IP "\fBcheck\fR" 4 +.IX Item "check" +Check to see if a nfs_client_id4 is allowed to reclaim. This command requires a hex-encoded nfs_client_id4 as an argument. +.IP "\fBgracedone\fR" 4 +.IX Item "gracedone" +Remove any unreclaimed client records from the database. This command requires a epoch boot time as an argument. +.SH "EXTERNAL CONFIGURATION" +The directory for stable storage information can be set via the file +.B /etc/nfs.conf +by setting the +.B storagedir +value in the +.B nfsdcltrack +section. For example: +.in +5 +[nfsdcltrack] +.br + storagedir = /shared/nfs/nfsdcltrack +.in -5 +Debuging to syslog can also be enabled by setting "debug = 1" in this file. +.SH "LEGACY TRANSITION MECHANISM" +.IX Header "LEGACY TRANSITION MECHANISM" +The Linux kernel NFSv4 server has historically tracked this information +on stable storage by manipulating information on the filesystem +directly, in the directory to which \fI/proc/fs/nfsd/nfsv4recoverydir\fR +points. If the kernel passes the correct information, then nfsdcltrack +can use it to allow a seamless transition from the old client tracking +scheme to the new one. +.PP +On a \fBcheck\fR operation, if there is no record of the client in the +database, nfsdcltrack will look to see if the \fB\s-1NFSDCLTRACK_LEGACY_RECDIR\s0\fR +environment variable is set. If it is, then it will fetch that value and +see if a directory exists by that name. If it does, then the check +operation will succeed and the directory will be removed. +.PP +On a \fBgracedone\fR operation, nfsdcltrack will look to see if the +\&\fB\s-1NFSDCLTRACK_LEGACY_TOPDIR\s0\fR environment variable is set. If it is, then +it will attempt to clean out that directory prior to exiting. +.PP +Note that this transition is one-way. If the machine subsequently reboots +back into an older kernel that does not support the nfsdcltrack upcall +then the clients will not be able to recover their state. +.SH "NOTES" +.IX Header "NOTES" +This program requires a kernel that supports the nfsdcltrack usermodehelper +upcall. This support was first added to mainline kernels in 3.8. +.SH "AUTHORS" +.IX Header "AUTHORS" +nfsdcltrack was developed by Jeff Layton <jlayton@redhat.com>. diff --git a/upstream/opensuse-leap-15-6/man8/nfsidmap.8 b/upstream/opensuse-leap-15-6/man8/nfsidmap.8 new file mode 100644 index 00000000..2af16f31 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/nfsidmap.8 @@ -0,0 +1,159 @@ +.\" +.\"@(#)nfsidmap(8) - The NFS idmapper upcall program +.\" +.\" Copyright (C) 2010 Bryan Schumaker <bjschuma@netapp.com> +.TH nfsidmap 5 "1 October 2010" +.SH NAME +nfsidmap \- The NFS idmapper upcall program +.SH SYNOPSIS +.B "nfsidmap [-v] [-t timeout] key desc" +.br +.B "nfsidmap [-v] [-c]" +.br +.B "nfsidmap [-v] [-u|-g|-r user]" +.br +.B "nfsidmap -d" +.br +.B "nfsidmap -l" +.br +.B "nfsidmap -h" +.SH DESCRIPTION +The NFSv4 protocol represents the local system's UID and GID values +on the wire as strings of the form +.IR user@domain . +The process of translating from UID to string and string to UID is +referred to as "ID mapping." +.PP +The system derives the +.I user +part of the string by performing a password or group lookup. +The lookup mechanism is configured in +.IR /etc/idmapd.conf . +.PP +By default, the +.I domain +part of the string is the system's DNS domain name. +It can also be specified in +.I /etc/idmapd.conf +if the system is multi-homed, +or if the system's DNS domain name does +not match the name of the system's Kerberos realm. +.PP +When the domain is not specified in +.I /etc/idmapd.conf +the local DNS server will be queried for the +.I _nfsv4idmapdomain +text record. If the record exists +that will be used as the domain. When the record +does not exist, the domain part of the DNS domain +will used. +.PP +The +.I /usr/sbin/nfsidmap +program performs translations on behalf of the kernel. +The kernel uses the request-key mechanism to perform +an upcall. +.I /usr/sbin/nfsidmap +is invoked by /sbin/request-key, performs the translation, +and initializes a key with the resulting information. +The kernel then caches the translation results in the key. +.PP +.I nfsidmap +can also clear cached ID map results in the kernel, +or revoke one particular key. +An incorrect cached key can result in file and directory ownership +reverting to "nobody" on NFSv4 mount points. +.PP +In addition, the +.B -d +and +.B -l +options are available to help diagnose misconfigurations. +They have no effect on the keyring containing ID mapping results. +.SH OPTIONS +.TP +.B -c +Clear the keyring of all the keys. +.TP +.B -d +Display the system's effective NFSv4 domain name on +.IR stdout . +.TP +.B -g user +Revoke the gid key of the given user. +.TP +.B -h +Display usage message. +.TP +.B -l +Display on +.I stdout +all keys currently in the keyring used to cache ID mapping results. +These keys are visible only to the superuser. +.TP +.B -r user +Revoke both the uid and gid key of the given user. +.TP +.B -t timeout +Set the expiration timer, in seconds, on the key. +The default is 600 seconds (10 mins). +.TP +.B -u user +Revoke the uid key of the given user. +.TP +.B -v +Increases the verbosity of the output to syslog +(can be specified multiple times). +.SH CONFIGURING +The file +.I /etc/request-key.conf +will need to be modified so +.I /sbin/request-key +can properly direct the upcall. The following line should be added before a call +to keyctl negate: +.PP +create id_resolver * * /usr/sbin/nfsidmap -t 600 %k %d +.PP +This will direct all id_resolver requests to the program +.I /usr/sbin/nfsidmap. +The +.B -t 600 +defines how many seconds into the future the key will +expire. This is an optional parameter for +.I /usr/sbin/nfsidmap +and will default to 600 seconds when not specified. +.PP +The idmapper system uses four key descriptions: +.PP + uid: Find the UID for the given user +.br + gid: Find the GID for the given group +.br + user: Find the user name for the given UID +.br + group: Find the group name for the given GID +.PP +You can choose to handle any of these individually, rather than using the +generic upcall program. If you would like to use your own program for a uid +lookup then you would edit your request-key.conf so it looks similar to this: +.PP +create id_resolver uid:* * /some/other/program %k %d +.br +create id_resolver * * /usr/sbin/nfsidmap %k %d +.PP +Notice that the new line was added above the line for the generic program. +request-key will find the first matching line and run the corresponding program. +In this case, /some/other/program will handle all uid lookups, and +/usr/sbin/nfsidmap will handle gid, user, and group lookups. +.SH FILES +.TP +.I /etc/idmapd.conf +ID mapping configuration file +.TP +.I /etc/request-key.conf +Request key configuration file +.SH "SEE ALSO" +.BR idmapd.conf (5), +.BR request-key (8) +.SH AUTHOR +Bryan Schumaker, <bjschuma@netapp.com> diff --git a/upstream/opensuse-leap-15-6/man8/nfsiostat.8 b/upstream/opensuse-leap-15-6/man8/nfsiostat.8 new file mode 100644 index 00000000..b477a9a0 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/nfsiostat.8 @@ -0,0 +1,126 @@ +.\" +.\" nfsiostat(8) +.\" +.TH nfsiostat 8 "15 Apr 2010" +.SH NAME +nfsiostat \- Emulate iostat for NFS mount points using /proc/self/mountstats +.SH SYNOPSIS +.BI "nfsiostat [[" <interval> "] [" <count> "]] [" <options> "]["<mount_point> "] +.SH DESCRIPTION +The +.B nfsiostat +command displays NFS client per-mount statisitics. +.TP +<interval> +specifies the amount of time in seconds between each report. +The first report contains statistics for the time since each file +system was mounted. Each subsequent report contains statistics collected +during the interval since the previous report. +.TP +<count> +If the +.I <count> +parameter is +specified, the value of +.I <count> +determines the number of reports generated at +.I <interval> +seconds apart. if the interval parameter is +specified without the +.I <count> +parameter, the command generates reports continuously. +.TP +<options> +Define below +.TP +<mount_point> +If one or more +.I <mount point> +names are specified, statistics for only these mount points will +be displayed. Otherwise, all NFS mount points on the client are listed. +.TP +The meaning of each column of \fBnfsiostat\fR's output is the following: +.RS 8 +- \fBop/s\fR +.RS +This is the number of operations per second. +.RS +.RE +.RE +.RE +.RS 8 +- \fBrpc bklog\fR +.RS +This is the length of the backlog queue. +.RE +.RE +.RE +.RS 8 +- \fBkB/s\fR +.RS +This is the number of kB written/read per second. +.RE +.RE +.RE +.RS 8 +- \fBkB/op\fR +.RS +This is the number of kB written/read per each operation. +.RE +.RE +.RE +.RS 8 +- \fBretrans\fR +.RS +This is the number of retransmissions. +.RE +.RE +.RE +.RS 8 +- \fBavg RTT (ms)\fR +.RS +This is the duration from the time that client's kernel sends the RPC request until the time it receives the reply. +.RE +.RE +.RE +.RS 8 +- \fBavg exe (ms)\fR +.RS +This is the duration from the time that NFS client does the RPC request to its kernel until the RPC request is completed, this includes the RTT time above. +.RE +.RE +.RE +.TP +Note that if an interval is used as argument to \fBnfsiostat\fR, then the diffrence from previous interval will be displayed, otherwise the results will be from the time that the share was mounted. + +.SH OPTIONS +.TP +.B \-a " or " \-\-attr +displays statistics related to the attribute cache +.TP +.B \-d " or " \-\-dir +displays statistics related to directory operations +.TP +.B \-h " or " \-\-help +shows help message and exit +.TP +.B \-l LIST or " \-\-list=LIST +only print stats for first LIST mount points +.TP +.B \-p " or " \-\-page +displays statistics related to the page cache +.TP +.B \-s " or " \-\-sort +Sort NFS mount points by ops/second +.TP +.B \-\-version +show program's version number and exit +.SH FILES +.TP +.B /proc/self/mountstats +.SH SEE ALSO +.BR iostat (8), +.BR mountstats (8), +.BR nfsstat(8) +.SH AUTHOR +Chuck Lever <chuck.lever@oracle.com> diff --git a/upstream/opensuse-leap-15-6/man8/nfsstat.8 b/upstream/opensuse-leap-15-6/man8/nfsstat.8 new file mode 100644 index 00000000..2e52935e --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/nfsstat.8 @@ -0,0 +1,173 @@ +.\" +.\" nfsstat(8) +.\" +.\" Copyright (C) 1996-2005 Olaf Kirch <okir@suse.de> +.TH nfsstat 8 "7 Aug 2007" +.SH NAME +nfsstat \- list NFS statistics +.SH SYNOPSIS +.B nfsstat +[\fIOPTION\fR]... +.SH DESCRIPTION +The +.B nfsstat +displays statistics kept about NFS client and server activity. +.SH OPTIONS +.TP +.B \-s, \-\-server +Print only server-side statistics. The default is to print both server and +client statistics. +.TP +.B \-c, \-\-client +Print only client-side statistics. +.TP +.B \-n, \-\-nfs +Print only NFS statistics. The default is to print both NFS and RPC +information. +.TP +.B \-2 +Print only NFS v2 statistics. The default is to only print information +about the versions of \fBNFS\fR that have non-zero counts. +.TP +.B \-3 +Print only NFS v3 statistics. The default is to only print information +about the versions of \fBNFS\fR that have non-zero counts. +.TP +.B \-4 +Print only NFS v4 statistics. The default is to only print information +about the versions of \fBNFS\fR that have non-zero counts. +.TP +.B \-m, \-\-mounts +Print information about each of the mounted \fBNFS\fR file systems. + +If this option is used, all other options are ignored. +.TP +.B \-r, \-\-rpc +Print only RPC statistics. +.TP +.BI \-o " facility +Display statistics for the specified facility, which must be one of: +.RS +.TP +.B nfs +NFS protocol information, split up by RPC call. +.TP +.B rpc +General RPC information. +.TP +.B net +Network layer statistics, such as the number of received packets, number +of TCP connections, etc. +.TP +.B fh +Usage information on the server's file handle cache, including the +total number of lookups, and the number of hits and misses. +.TP +.B rc +Usage information on the server's request reply cache, including the +total number of lookups, and the number of hits and misses. +.TP +.B io +Usage information on the server's io statistics; bytes read and +written. +.TP +.B ra +Usage information on the server's read ahead cache, including the +ra cache size, the depth of ra cache hits, and ra cache misses. +.TP +.B all +Display all of the above facilities. +.RE +.TP +.B \-v, \-\-verbose +This is equivalent to \fB\-o all\fR. +.TP +.B \-l, \-\-list +Print information in list form. +.TP +.BI "\-S, \-\-since " file +Instead of printing current statistics, +.B nfsstat +imports statistics from +.I file +and displays the difference between those and the current statistics. +Valid input +.IR file "s may be in the form of " +.B /proc/net/rpc/nfs +(raw client stats), +.B /proc/net/rpc/nfsd +(raw server stats), or saved output from +.B nfsstat +itself (client and/or server stats). Any statistics missing from a saved +.B nfsstat +output +.I file +are treated as zeroes. +.TP +.B \-Z[interval], \-\-sleep=[interval] +Instead of printing current statistics and immediately exiting, +.B nfsstat +takes a snapshot of the current statistics and pauses until it receives +.B SIGINT +(typically from +.BR Ctrl-C ), +at which point it takes another snapshot and displays the difference +between the two. +If \fIinterval\fR is specified, +.B nfsstat +will print the number of \fBNFS\fR calls made since the previous report. +Stats will be printed repeatedly every \fIinterval\fR seconds. +.\" --------------------- EXAMPLES ------------------------------- +.SH EXAMPLES +.TP +.B nfsstat \-o all \-234 +Show all information about all versions of \fBNFS\fR. +.TP +.B nfsstat \-\-verbose \-234 +Same as above. +.TP +.B nfsstat \-o all +Show all information about active versions of \fBNFS\fR. +.TP +.B nfsstat \-\-nfs \-\-server \-3 +Show statistics for \fBNFS\fR version 3 server. +.TP +.B nfsstat \-m +Show information about mounted \fBNFS\fR filesystems. +.\" --------------------- DISPLAY -------------------------------- +.SH DISPLAY +The \fBFlags\fR output from the \fB\-m\fR option is the same as the +flags give to the \fBmount\fR command. +.\" --------------------- FILES ---------------------------------- +.SH FILES +.TP +.B /proc/net/rpc/nfsd +.BR procfs -based +interface to kernel NFS server statistics. +.TP +.B /proc/net/rpc/nfs +.BR procfs -based +interface to kernel NFS client statistics. +.TP +.B /proc/mounts +.BR procfs -based +interface to the mounted filesystems. +.\" -------------------- SEE ALSO -------------------------------- +.SH SEE ALSO +.BR rpc.nfsd (8). +.BR nfs (5). +.\" ---------------------- BUGS ---------------------------------- +.SH BUGS +The default output has been changed. To get the old default output you must run \fBnfsstat \-\-auto \-2\fR. +.P +The function of the \fB\-v\fR and \fB\-a\fR options have changed. The \fB\-a\fR option +is now reserved for future use. The \fB\-v\fR does what the \fB\-a\fR option used to do, +and the new \fB\-[234]\fR options replace the \fB\-v\fR option. +.P +The \fBDisplay\fR section should be more complete. +.P +Further bugs can be found or reported at +.BR http://nfs.sf.net/ . +.\" -------------------- AUTHOR ---------------------------------- +.SH AUTHOR +Olaf Kirch, <okir@suse.de> diff --git a/upstream/opensuse-leap-15-6/man8/nmbd.8 b/upstream/opensuse-leap-15-6/man8/nmbd.8 new file mode 100644 index 00000000..6d8537de --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/nmbd.8 @@ -0,0 +1,304 @@ +'\" t +.\" Title: nmbd +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 10/23/2023 +.\" Manual: System Administration tools +.\" Source: Samba 4.19.2-git.328.e4c431e307f150600.1.23SUSE-oS15.0-x86_64 +.\" Language: English +.\" +.TH "NMBD" "8" "10/23/2023" "Samba 4\&.19\&.2\-git\&.328\&." "System Administration tools" +.\" ----------------------------------------------------------------- +.\" * 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" +nmbd \- NetBIOS name server to provide NetBIOS over IP naming services to clients +.SH "SYNOPSIS" +.HP \w'\ 'u +nmbd [\-D|\-\-daemon] [\-i|\-\-interactive] [\-F|\-\-foreground] [\-\-no\-process\-group] [\-b|\-\-build\-options] [\-p\ <port\ number(s)>] [\-P\ <profiling\ level>] [\-d\ <debug\ level>] [\-\-debug\-stdout] [\-\-configfile=<configuration\ file>] [\-\-option=<name>=<value>] [\-l|\-\-log\-basename\ <log\ directory>] [\-\-leak\-report] [\-\-leak\-report\-full] [\-V|\-\-version] +.SH "DESCRIPTION" +.PP +This program is part of the +\fBsamba\fR(7) +suite\&. +.PP +nmbd +is a server that understands and can reply to NetBIOS over IP name service requests, like those produced by SMB/CIFS clients such as Windows 95/98/ME, Windows NT, Windows 2000, Windows XP and LanManager clients\&. It also participates in the browsing protocols which make up the Windows "Network Neighborhood" view\&. +.PP +SMB/CIFS clients, when they start up, may wish to locate an SMB/CIFS server\&. That is, they wish to know what IP number a specified host is using\&. +.PP +Amongst other services, +nmbd +will listen for such requests, and if its own NetBIOS name is specified it will respond with the IP number of the host it is running on\&. Its "own NetBIOS name" is by default the primary DNS name of the host it is running on, but this can be overridden by the +\m[blue]\fBnetbios name\fR\m[] +in +/etc/samba/smb\&.conf\&. Thus +nmbd +will reply to broadcast queries for its own name(s)\&. Additional names for +nmbd +to respond on can be set via parameters in the +\fBsmb.conf\fR(5) +configuration file\&. +.PP +nmbd +can also be used as a WINS (Windows Internet Name Server) server\&. What this basically means is that it will act as a WINS database server, creating a database from name registration requests that it receives and replying to queries from clients for these names\&. +.PP +In addition, +nmbd +can act as a WINS proxy, relaying broadcast queries from clients that do not understand how to talk the WINS protocol to a WINS server\&. +.SH "OPTIONS" +.PP +\-D|\-\-daemon +.RS 4 +If specified, this parameter causes +nmbd +to operate as a daemon\&. That is, it detaches itself and runs in the background, fielding requests on the appropriate port\&. By default, +nmbd +will operate as a daemon if launched from a command shell\&. nmbd can also be operated from the +inetd +meta\-daemon, although this is not recommended\&. +.RE +.PP +\-F|\-\-foreground +.RS 4 +If specified, this parameter causes the main +nmbd +process to not daemonize, i\&.e\&. double\-fork and disassociate with the terminal\&. Child processes are still created as normal to service each connection request, but the main process does not exit\&. This operation mode is suitable for running +nmbd +under process supervisors such as +supervise +and +svscan +from Daniel J\&. Bernstein\*(Aqs +daemontools +package, or the AIX process monitor\&. +.RE +.PP +\-i|\-\-interactive +.RS 4 +If this parameter is specified it causes the server to run "interactively", not as a daemon, even if the server is executed on the command line of a shell\&. Setting this parameter negates the implicit daemon mode when run from the command line\&. +nmbd +also logs to standard output, as if the +\fB\-S\fR +parameter had been given\&. +.RE +.PP +\-H|\-\-hosts <filename> +.RS 4 +NetBIOS lmhosts file\&. The lmhosts file is a list of NetBIOS names to IP addresses that is loaded by the nmbd server and used via the name resolution mechanism +\m[blue]\fBname resolve order\fR\m[] +described in +\fBsmb.conf\fR(5) +to resolve any NetBIOS name queries needed by the server\&. Note that the contents of this file are +\fINOT\fR +used by +nmbd +to answer any name queries\&. Adding a line to this file affects name NetBIOS resolution from this host +\fIONLY\fR\&. +.sp +The default path to this file is compiled into Samba as part of the build process\&. Common defaults are +/usr/local/samba/lib/lmhosts, +/usr/samba/lib/lmhosts +or +/etc/samba/lmhosts\&. See the +\fBlmhosts\fR(5) +man page for details on the contents of this file\&. +.RE +.PP +\-p|\-\-port <UDP port number> +.RS 4 +UDP port number is a positive integer value\&. This option changes the default UDP port number (normally 137) that +nmbd +responds to name queries on\&. Don\*(Aqt use this option unless you are an expert, in which case you won\*(Aqt need help! +.RE +.PP +\-\-no\-process\-group +.RS 4 +Do not create a new process group for nmbd\&. +.RE +.PP +\-d|\-\-debuglevel=DEBUGLEVEL, \-\-debug\-stdout +.RS 4 +\fIlevel\fR +is an integer from 0 to 10\&. The default value if this parameter is not specified is 0\&. +.sp +The higher this value, the more detail will be logged to the log files about the activities of the server\&. At level 0, only critical errors and serious warnings will be logged\&. Level 1 is a reasonable level for day\-to\-day running \- it generates a small amount of information about operations carried out\&. +.sp +Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem\&. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic\&. +.sp +Note that specifying this parameter here will override the +\m[blue]\fBlog level\fR\m[] +parameter in the +/etc/samba/smb\&.conf +file\&. +This will redirect debug output to STDOUT\&. By default server daemons are logging to a log file\&. +.RE +.PP +\-\-configfile=CONFIGFILE +.RS 4 +The file specified contains the configuration details required by the server\&. The information in this file includes server\-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide\&. See +/etc/samba/smb\&.conf +for more information\&. The default configuration file name is determined at compile time\&. +.RE +.PP +\-\-option=<name>=<value> +.RS 4 +Set the +\fBsmb.conf\fR(5) +option "<name>" to value "<value>" from the command line\&. This overrides compiled\-in defaults and options read from the configuration file\&. If a name or a value includes a space, wrap whole \-\-option=name=value into quotes\&. +.RE +.PP +\-l|\-\-log\-basename=logdirectory +.RS 4 +Base directory name for log/debug files\&. The extension +\fB"\&.progname"\fR +will be appended (e\&.g\&. log\&.smbclient, log\&.smbd, etc\&.\&.\&.)\&. The log file is never removed by the client\&. +.RE +.PP +\-\-leak\-report +.RS 4 +Enable talloc leak reporting on exit\&. +.RE +.PP +\-\-leak\-report\-full +.RS 4 +Enable full talloc leak reporting on exit\&. +.RE +.PP +\-V|\-\-version +.RS 4 +Prints the program version number\&. +.RE +.PP +\-?|\-\-help +.RS 4 +Print a summary of command line options\&. +.RE +.PP +\-\-usage +.RS 4 +Display brief usage message\&. +.RE +.SH "FILES" +.PP +/etc/inetd\&.conf +.RS 4 +If the server is to be run by the +inetd +meta\-daemon, this file must contain suitable startup information for the meta\-daemon\&. +.RE +.PP +/etc/rc +.RS 4 +or whatever initialization script your system uses)\&. +.sp +If running the server as a daemon at startup, this file will need to contain an appropriate startup sequence for the server\&. +.RE +.PP +/etc/services +.RS 4 +If running the server via the meta\-daemon +inetd, this file must contain a mapping of service name (e\&.g\&., netbios\-ssn) to service port (e\&.g\&., 139) and protocol type (e\&.g\&., tcp)\&. +.RE +.PP +/usr/local/samba/lib/smb\&.conf +.RS 4 +This is the default location of the +\fBsmb.conf\fR(5) +server configuration file\&. Other common places that systems install this file are +/usr/samba/lib/smb\&.conf +and +/etc/samba/smb\&.conf\&. +.sp +When run as a WINS server (see the +\m[blue]\fBwins support\fR\m[] +parameter in the +\fBsmb.conf\fR(5) +man page), +nmbd +will store the WINS database in the file +wins\&.dat +in the +var/locks +directory configured under wherever Samba was configured to install itself\&. +.sp +If +nmbd +is acting as a +\fI browse master\fR +(see the +\m[blue]\fBlocal master\fR\m[] +parameter in the +\fBsmb.conf\fR(5) +man page, +nmbd +will store the browsing database in the file +browse\&.dat +in the +var/locks +directory configured under wherever Samba was configured to install itself\&. +.RE +.SH "SIGNALS" +.PP +To shut down an +nmbd +process it is recommended that SIGKILL (\-9) +\fINOT\fR +be used, except as a last resort, as this may leave the name database in an inconsistent state\&. The correct way to terminate +nmbd +is to send it a SIGTERM (\-15) signal and wait for it to die on its own\&. +.PP +nmbd +will accept SIGHUP, which will cause it to dump out its namelists into the file +namelist\&.debug +in the +/usr/local/samba/var/locks +directory (or the +var/locks +directory configured under wherever Samba was configured to install itself)\&. This will also cause +nmbd +to dump out its server database in the +log\&.nmb +file\&. Additionally, the signal will cause reloading +nmbd +configuration\&. +.PP +Instead of sending a SIGHUP signal, a request to dump namelists into the file and reload a configuration file may be sent using +\fBsmbcontrol\fR(1) +program\&. +.PP +The debug log level of nmbd may be raised or lowered using +\fBsmbcontrol\fR(1) +(SIGUSR[1|2] signals are no longer used since Samba 2\&.2)\&. This is to allow transient problems to be diagnosed, whilst still running at a normally low log level\&. +.SH "VERSION" +.PP +This man page is part of version 4\&.19\&.2\-git\&.328\&.e4c431e307f150600\&.1\&.23SUSE\-oS15\&.0\-x86_64 of the Samba suite\&. +.SH "SEE ALSO" +.PP +\fBinetd\fR(8), +\fBsmbd\fR(8), +\fBsmb.conf\fR(5), +\fBsmbclient\fR(1), +\fBtestparm\fR(1), and the Internet RFC\*(Aqs +rfc1001\&.txt, +rfc1002\&.txt\&. In addition the CIFS (formerly SMB) specification is available as a link from the Web page +https://www\&.samba\&.org/cifs/\&. +.SH "AUTHOR" +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. diff --git a/upstream/opensuse-leap-15-6/man8/nologin.8 b/upstream/opensuse-leap-15-6/man8/nologin.8 new file mode 100644 index 00000000..97c378c7 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/nologin.8 @@ -0,0 +1,100 @@ +'\" t +.\" Title: nologin +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "NOLOGIN" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +nologin \- politely refuse a login +.SH "SYNOPSIS" +.sp +\fBnologin\fP [\fB\-V\fP] [\fB\-h\fP] +.SH "DESCRIPTION" +.sp +\fBnologin\fP displays a message that an account is not available and exits non\-zero. It is intended as a replacement shell field to deny login access to an account. +.sp +If the file \fI/etc/nologin.txt\fP exists, \fBnologin\fP displays its contents to the user instead of the default message. +.sp +The exit status returned by \fBnologin\fP is always 1. +.SH "OPTIONS" +.sp +\fB\-c\fP, \fB\-\-command\fP \fIcommand\fP +.sp +\fB\-\-init\-file\fP +.sp +\fB\-i\fP \fB\-\-interactive\fP +.sp +\fB\-\-init\-file\fP \fIfile\fP +.sp +\fB\-i\fP, \fB\-\-interactive\fP +.sp +\fB\-l\fP, \fB\-\-login\fP +.sp +\fB\-\-noprofile\fP +.sp +\fB\-\-norc\fP +.sp +\fB\-\-posix\fP +.sp +\fB\-\-rcfile\fP \fIfile\fP +.sp +\fB\-r\fP, \fB\-\-restricted\fP +.sp +These shell command\-line options are ignored to avoid \fBnologin\fP error. +.sp +\fB\-h\fP, \fB\-\-help\fP +.RS 4 +Display help text and exit. +.RE +.sp +\fB\-V\fP, \fB\-\-version\fP +.RS 4 +Display version information and exit. +.RE +.SH "NOTES" +.sp +\fBnologin\fP is a per\-account way to disable login (usually used for system accounts like http or ftp). \fBnologin\fP uses \fI/etc/nologin.txt\fP as an optional source for a non\-default message, the login access is always refused independently of the file. +.sp +\fBpam_nologin\fP(8) PAM module usually prevents all non\-root users from logging into the system. \fBpam_nologin\fP(8) functionality is controlled by \fI/var/run/nologin\fP or the \fI/etc/nologin\fP file. +.SH "HISTORY" +.sp +The \fBnologin\fP command appeared in 4.4BSD. +.SH "AUTHORS" +.sp +.MTO "kzak\(atredhat.com" "Karel Zak" "" +.SH "SEE ALSO" +.sp +\fBlogin\fP(1), +\fBpasswd\fP(5), +\fBpam_nologin\fP(8) +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBnologin\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/nscd.8 b/upstream/opensuse-leap-15-6/man8/nscd.8 new file mode 100644 index 00000000..6a169e66 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/nscd.8 @@ -0,0 +1,84 @@ +.\" Copyright 1999 SuSE GmbH Nuernberg, Germany +.\" Author: Thorsten Kukuk <kukuk@suse.de> +.\" +.\" SPDX-License-Identifier: GPL-2.0-or-later +.\" +.\" 2008-12-05 Petr Baudis <pasky@suse.cz> +.\" Rewrite the NOTES section to reflect modern reality +.\" +.TH nscd 8 2022-10-30 "Linux man-pages 6.04" +.SH NAME +nscd \- name service cache daemon +.SH DESCRIPTION +.B nscd +is a daemon that provides a cache for the most common name service +requests. +The default configuration file, +.IR /etc/nscd.conf , +determines the behavior of the cache daemon. +See +.BR nscd.conf (5). +.PP +.B nscd +provides caching for accesses of the +.BR passwd (5), +.BR group (5), +.BR hosts (5) +.BR services (5) +and +.I netgroup +databases through standard libc interfaces, such as +.BR getpwnam (3), +.BR getpwuid (3), +.BR getgrnam (3), +.BR getgrgid (3), +.BR gethostbyname (3), +and others. +.PP +There are two caches for each database: +a positive one for items found, and a negative one +for items not found. +Each cache has a separate TTL (time-to-live) +period for its data. +Note that the shadow file is specifically not cached. +.BR getspnam (3) +calls remain uncached as a result. +.SH OPTIONS +.TP +.B "\-\-help" +will give you a list with all options and what they do. +.SH NOTES +The daemon will try to watch for changes in configuration files +appropriate for each database (e.g., +.I /etc/passwd +for the +.I passwd +database or +.I /etc/hosts +and +.I /etc/resolv.conf +for the +.I hosts +database), and flush the cache when these are changed. +However, this will happen only after a short delay (unless the +.BR inotify (7) +mechanism is available and glibc 2.9 or later is available), +and this auto-detection does not cover configuration files +required by nonstandard NSS modules, if any are specified in +.IR /etc/nsswitch.conf . +In that case, you need to run the following command +after changing the configuration file of the database so that +.B nscd +invalidates its cache: +.PP +.in +4n +.EX +$ \fBnscd \-i\fP \fI<database>\fP +.EE +.in +.SH SEE ALSO +.BR nscd.conf (5), +.BR nsswitch.conf (5) +.\" .SH AUTHOR +.\" .B nscd +.\" was written by Thorsten Kukuk and Ulrich Drepper. diff --git a/upstream/opensuse-leap-15-6/man8/nss-myhostname.8 b/upstream/opensuse-leap-15-6/man8/nss-myhostname.8 new file mode 100644 index 00000000..ab3064a2 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/nss-myhostname.8 @@ -0,0 +1,182 @@ +'\" t +.TH "NSS\-MYHOSTNAME" "8" "" "systemd 254" "nss-myhostname" +.\" ----------------------------------------------------------------- +.\" * 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" +nss-myhostname, libnss_myhostname.so.2 \- Hostname resolution for the locally configured system hostname +.SH "SYNOPSIS" +.PP +libnss_myhostname\&.so\&.2 +.SH "DESCRIPTION" +.PP +\fBnss\-myhostname\fR +is a plug\-in module for the GNU Name Service Switch (NSS) functionality of the GNU C Library (\fBglibc\fR), primarily providing hostname resolution for the locally configured system hostname as returned by +\fBgethostname\fR(2)\&. The precise hostnames resolved by this module are: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +The local, configured hostname is resolved to all locally configured IP addresses ordered by their scope, or \(em if none are configured \(em the IPv4 address 127\&.0\&.0\&.2 (which is on the local loopback) and the IPv6 address ::1 (which is the local host)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +The hostnames +"localhost" +and +"localhost\&.localdomain" +(as well as any hostname ending in +"\&.localhost" +or +"\&.localhost\&.localdomain") are resolved to the IP addresses 127\&.0\&.0\&.1 and ::1\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +The hostname +"_gateway" +is resolved to all current default routing gateway addresses, ordered by their metric\&. This assigns a stable hostname to the current gateway, useful for referencing it independently of the current network configuration state\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +The hostname +"_outbound" +is resolved to the local IPv4 and IPv6 addresses that are most likely used for communication with other hosts\&. This is determined by requesting a routing decision to the configured default gateways from the kernel and then using the local IP addresses selected by this decision\&. This hostname is only available if there is at least one local default gateway configured\&. This assigns a stable hostname to the local outbound IP addresses, useful for referencing them independently of the current network configuration state\&. +.RE +.PP +Various software relies on an always\-resolvable local hostname\&. When using dynamic hostnames, this is traditionally achieved by patching +/etc/hosts +at the same time as changing the hostname\&. This is problematic since it requires a writable +/etc/ +file system and is fragile because the file might be edited by the administrator at the same time\&. With +\fBnss\-myhostname\fR +enabled, changing +/etc/hosts +is unnecessary, and on many systems, the file becomes entirely optional\&. +.PP +To activate the NSS modules, add +"myhostname" +to the line starting with +"hosts:" +in +/etc/nsswitch\&.conf\&. +.PP +It is recommended to place +"myhostname" +after +"file" +and before +"dns"\&. This resolves well\-known hostnames like +"localhost" +and the machine hostnames locally\&. It is consistent with the behaviour of +\fBnss\-resolve\fR, and still allows overriding via +/etc/hosts\&. +.PP +Please keep in mind that +\fBnss\-myhostname\fR +(and +\fBnss\-resolve\fR) also resolve in the other direction \(em from locally attached IP addresses to hostnames\&. If you rely on that lookup being provided by DNS, you might want to order things differently\&. +.SH "EXAMPLE" +.PP +Here is an example +/etc/nsswitch\&.conf +file that enables +\fBnss\-myhostname\fR +correctly: +.sp +.if n \{\ +.RS 4 +.\} +.nf +passwd: compat systemd +group: compat [SUCCESS=merge] systemd +shadow: compat systemd +gshadow: files systemd + + +hosts: mymachines resolve [!UNAVAIL=return] files \fBmyhostname\fR dns +networks: files + +protocols: db files +services: db files +ethers: db files +rpc: db files + +netgroup: nis +.fi +.if n \{\ +.RE +.\} +.PP +To test, use +\fBglibc\fR\*(Aqs +\fBgetent\fR(1) +tool: +.sp +.if n \{\ +.RS 4 +.\} +.nf +$ getent ahosts `hostname` +::1 STREAM omega +::1 DGRAM +::1 RAW +127\&.0\&.0\&.2 STREAM +127\&.0\&.0\&.2 DGRAM +127\&.0\&.0\&.2 RAW +.fi +.if n \{\ +.RE +.\} +.PP +In this case, the local hostname is +\fIomega\fR\&. +.SH "SEE ALSO" +.PP +\fBsystemd\fR(1), +\fBnss-systemd\fR(8), +\fBnss-resolve\fR(8), +\fBnss-mymachines\fR(8), +\fBnsswitch.conf\fR(5), +\fBgetent\fR(1) diff --git a/upstream/opensuse-leap-15-6/man8/nss-mymachines.8 b/upstream/opensuse-leap-15-6/man8/nss-mymachines.8 new file mode 100644 index 00000000..009e217f --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/nss-mymachines.8 @@ -0,0 +1,140 @@ +'\" t +.TH "NSS\-MYMACHINES" "8" "" "systemd 254" "nss-mymachines" +.\" ----------------------------------------------------------------- +.\" * 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" +nss-mymachines, libnss_mymachines.so.2 \- Hostname resolution for local container instances +.SH "SYNOPSIS" +.PP +libnss_mymachines\&.so\&.2 +.SH "DESCRIPTION" +.PP +\fBnss\-mymachines\fR +is a plug\-in module for the GNU Name Service Switch (NSS) functionality of the GNU C Library (\fBglibc\fR), providing hostname resolution for the names of containers running locally that are registered with +\fBsystemd-machined.service\fR(8)\&. The container names are resolved to the IP addresses of the specific container, ordered by their scope\&. This functionality only applies to containers using network namespacing (see the description of +\fB\-\-private\-network\fR +in +\fBsystemd-nspawn\fR(1))\&. Note that the name that is resolved is the one registered with +\fBsystemd\-machined\fR, which may be different than the hostname configured inside of the container\&. +.PP +Note that this NSS module only makes available names of the containers running immediately below the current system context\&. It does not provide host name resolution for containers running side\-by\-side with the invoking system context, or containers further up or down the container hierarchy\&. Or in other words, on the host system it provides host name resolution for the containers running immediately below the host environment\&. When used inside a container environment however, it will not be able to provide name resolution for containers running on the host (as those are siblings and not children of the current container environment), but instead only for nested containers running immediately below its own container environment\&. +.PP +To activate the NSS module, add +"mymachines" +to the line starting with +"hosts:" +in +/etc/nsswitch\&.conf\&. +.PP +It is recommended to place +"mymachines" +before the +"resolve" +or +"dns" +entry of the +"hosts:" +line of +/etc/nsswitch\&.conf +in order to make sure that its mappings are preferred over other resolvers such as DNS\&. +.SH "CONFIGURATION IN /ETC/NSSWITCH\&.CONF" +.PP +Here is an example +/etc/nsswitch\&.conf +file that enables +\fBnss\-mymachines\fR +correctly: +.sp +.if n \{\ +.RS 4 +.\} +.nf +passwd: compat systemd +group: compat [SUCCESS=merge] systemd +shadow: compat systemd +gshadow: files systemd + +hosts: \fBmymachines\fR resolve [!UNAVAIL=return] files myhostname dns +networks: files + +protocols: db files +services: db files +ethers: db files +rpc: db files + +netgroup: nis +.fi +.if n \{\ +.RE +.\} +.SH "EXAMPLE: MAPPINGS PROVIDED BY NSS\-MYMACHINES" +.PP +The container +"rawhide" +is spawned using +\fBsystemd-nspawn\fR(1): +.sp +.if n \{\ +.RS 4 +.\} +.nf +# systemd\-nspawn \-M rawhide \-\-boot \-\-network\-veth \-\-private\-users=pick +Spawning container rawhide on /var/lib/machines/rawhide\&. +Selected user namespace base 20119552 and range 65536\&. +\&.\&.\&. + +$ machinectl \-\-max\-addresses=3 +MACHINE CLASS SERVICE OS VERSION ADDRESSES +rawhide container systemd\-nspawn fedora 30 169\&.254\&.40\&.164 fe80::94aa:3aff:fe7b:d4b9 + +$ ping \-c1 rawhide +PING rawhide(fe80::94aa:3aff:fe7b:d4b9%ve\-rawhide (fe80::94aa:3aff:fe7b:d4b9%ve\-rawhide)) 56 data bytes +64 bytes from fe80::94aa:3aff:fe7b:d4b9%ve\-rawhide (fe80::94aa:3aff:fe7b:d4b9%ve\-rawhide): icmp_seq=1 ttl=64 time=0\&.045 ms +\&.\&.\&. +$ ping \-c1 \-4 rawhide +PING rawhide (169\&.254\&.40\&.164) 56(84) bytes of data\&. +64 bytes from 169\&.254\&.40\&.164 (169\&.254\&.40\&.164): icmp_seq=1 ttl=64 time=0\&.064 ms +\&.\&.\&. + +# machinectl shell rawhide /sbin/ip a +Connected to machine rawhide\&. Press ^] three times within 1s to exit session\&. +1: lo: <LOOPBACK,UP,LOWER_UP> mtu 65536 qdisc noqueue state UNKNOWN group default qlen 1000 + \&.\&.\&. +2: host0@if21: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc noqueue state UP group default qlen 1000 + link/ether 96:aa:3a:7b:d4:b9 brd ff:ff:ff:ff:ff:ff link\-netnsid 0 + inet 169\&.254\&.40\&.164/16 brd 169\&.254\&.255\&.255 scope link host0 + valid_lft forever preferred_lft forever + inet6 fe80::94aa:3aff:fe7b:d4b9/64 scope link + valid_lft forever preferred_lft forever +Connection to machine rawhide terminated\&. +.fi +.if n \{\ +.RE +.\} +.SH "SEE ALSO" +.PP +\fBsystemd\fR(1), +\fBsystemd-machined.service\fR(8), +\fBmachinectl\fR(1), +\fBnss-systemd\fR(8), +\fBnss-resolve\fR(8), +\fBnss-myhostname\fR(8), +\fBnsswitch.conf\fR(5), +\fBgetent\fR(1) diff --git a/upstream/opensuse-leap-15-6/man8/nss-systemd.8 b/upstream/opensuse-leap-15-6/man8/nss-systemd.8 new file mode 100644 index 00000000..cc685a61 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/nss-systemd.8 @@ -0,0 +1,236 @@ +'\" t +.TH "NSS\-SYSTEMD" "8" "" "systemd 254" "nss-systemd" +.\" ----------------------------------------------------------------- +.\" * 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" +nss-systemd, libnss_systemd.so.2 \- UNIX user and group name resolution for user/group lookup via Varlink +.SH "SYNOPSIS" +.PP +libnss_systemd\&.so\&.2 +.SH "DESCRIPTION" +.PP +\fBnss\-systemd\fR +is a plug\-in module for the GNU Name Service Switch (NSS) functionality of the GNU C Library (\fBglibc\fR), providing UNIX user and group name resolution for services implementing the +\m[blue]\fBUser/Group Record Lookup API via Varlink\fR\m[]\&\s-2\u[1]\d\s+2, such as the system and service manager +\fBsystemd\fR(1) +(for its +\fIDynamicUser=\fR +feature, see +\fBsystemd.exec\fR(5) +for details), +\fBsystemd-homed.service\fR(8), or +\fBsystemd-machined.service\fR(8)\&. +.PP +This module also ensures that the root and nobody users and groups (i\&.e\&. the users/groups with the UIDs/GIDs 0 and 65534) remain resolvable at all times, even if they aren\*(Aqt listed in +/etc/passwd +or +/etc/group, or if these files are missing\&. +.PP +This module preferably utilizes +\fBsystemd-userdbd.service\fR(8) +for resolving users and groups, but also works without the service running\&. +.PP +To activate the NSS module, add +"systemd" +to the lines starting with +"passwd:", +"group:", +"shadow:" +and +"gshadow:" +in +/etc/nsswitch\&.conf\&. +.PP +It is recommended to place +"systemd" +after the +"files" +or +"compat" +entry of the +/etc/nsswitch\&.conf +lines so that +/etc/passwd, +/etc/group, +/etc/shadow +and +/etc/gshadow +based mappings take precedence\&. +.SH "STATIC DROP\-IN JSON USER/GROUP RECORDS" +.PP +Besides user/group records acquired via the aforementioned Varlink IPC interfaces and the synthesized root and nobody accounts, this module also makes user and group accounts available to the system that are defined in static drop\-in files in the +/etc/userdb/, +/run/userdb/, +/run/host/userdb/ +and +/usr/lib/userdb/ +directories\&. +.PP +This is a simple mechanism to provide static user and group records via JSON drop\-in files\&. Such user records should be defined in the format described by the +\m[blue]\fBJSON User Records\fR\m[]\&\s-2\u[2]\d\s+2 +specification and be placed in one of the aforementioned directories under a file name composed of the user name suffixed with +\&.user, with a world\-readable access mode\&. A symlink named after the user record\*(Aqs UID formatted in decimal and suffixed with +\&.user +pointing to the primary record file should be created as well, in order to allow both lookups by username and by UID\&. Privileged user record data (e\&.g\&. hashed UNIX passwords) may optionally be provided as well, in a pair of separate companion files with the +\&.user\-privileged +suffix\&. The data should be stored in a regular file named after the user name, suffixed with +\&.user\-privileged, and a symlink pointing to it, named after the used numeric UID formatted in decimal with the same suffix\&. These companion files should not be readable to anyone but root\&. Example: +.sp +.if n \{\ +.RS 4 +.\} +.nf +\-rw\-r\-\-r\-\-\&. 1 root root 723 May 10 foobar\&.user +\-rw\-\-\-\-\-\-\-\&. 1 root root 123 May 10 foobar\&.user\-privileged +lrwxrwxrwx\&. 1 root root 19 May 10 4711\&.user \-> foobar\&.user +lrwxrwxrwx\&. 1 root root 19 May 10 4711\&.user\-privileged \-> foobar\&.user\-privileged +.fi +.if n \{\ +.RE +.\} +.PP +Similarly, group records following the format described in +\m[blue]\fBJSON Group Record\fR\m[]\&\s-2\u[3]\d\s+2 +may be defined, using the file suffixes +\&.group +and +\&.group\-privileged\&. +.PP +The primary user/group record files (i\&.e\&. those with the +\&.user +and +\&.group +suffixes) should not contain the +"privileged" +section as described in the specifications\&. The privileged user/group record files (i\&.e\&. those with the +\&.user\-privileged +and +\&.group\-privileged +suffixes) should contain this section, exclusively\&. +.PP +Note that static user/group records generally do not override conflicting records in +/etc/passwd +or +/etc/group +or other account databases\&. In fact, before dropping in these files a reasonable level of care should be taken to avoid user/group name and UID/GID conflicts\&. +.SH "CONFIGURATION IN /ETC/NSSWITCH\&.CONF" +.PP +Here is an example +/etc/nsswitch\&.conf +file that enables +\fBnss\-systemd\fR +correctly: +.sp +.if n \{\ +.RS 4 +.\} +.nf +passwd: compat \fBsystemd\fR +group: compat [SUCCESS=merge] \fBsystemd\fR +shadow: compat \fBsystemd\fR +gshadow: files \fBsystemd\fR + +hosts: mymachines resolve [!UNAVAIL=return] files myhostname dns +networks: files + +protocols: db files +services: db files +ethers: db files +rpc: db files + +netgroup: nis +.fi +.if n \{\ +.RE +.\} +.SH "EXAMPLE: MAPPINGS PROVIDED BY SYSTEMD\-MACHINED\&.SERVICE" +.PP +The container +"rawhide" +is spawned using +\fBsystemd-nspawn\fR(1): +.sp +.if n \{\ +.RS 4 +.\} +.nf +# systemd\-nspawn \-M rawhide \-\-boot \-\-network\-veth \-\-private\-users=pick +Spawning container rawhide on /var/lib/machines/rawhide\&. +Selected user namespace base 20119552 and range 65536\&. +\&.\&.\&. + +$ machinectl \-\-max\-addresses=3 +MACHINE CLASS SERVICE OS VERSION ADDRESSES +rawhide container systemd\-nspawn fedora 30 169\&.254\&.40\&.164 fe80::94aa:3aff:fe7b:d4b9 + +$ getent passwd vu\-rawhide\-0 vu\-rawhide\-81 +vu\-rawhide\-0:*:20119552:65534:vu\-rawhide\-0:/:/usr/sbin/nologin +vu\-rawhide\-81:*:20119633:65534:vu\-rawhide\-81:/:/usr/sbin/nologin + +$ getent group vg\-rawhide\-0 vg\-rawhide\-81 +vg\-rawhide\-0:*:20119552: +vg\-rawhide\-81:*:20119633: + +$ ps \-o user:15,pid,tty,command \-e|grep \*(Aq^vu\-rawhide\*(Aq +vu\-rawhide\-0 692 ? /usr/lib/systemd/systemd +vu\-rawhide\-0 731 ? /usr/lib/systemd/systemd\-journald +vu\-rawhide\-192 734 ? /usr/lib/systemd/systemd\-networkd +vu\-rawhide\-193 738 ? /usr/lib/systemd/systemd\-resolved +vu\-rawhide\-0 742 ? /usr/lib/systemd/systemd\-logind +vu\-rawhide\-81 744 ? /usr/bin/dbus\-daemon \-\-system \-\-address=systemd: \-\-nofork \-\-nopidfile \-\-systemd\-activation \-\-syslog\-only +vu\-rawhide\-0 746 ? /usr/sbin/sshd \-D \&.\&.\&. +vu\-rawhide\-0 752 ? /usr/lib/systemd/systemd \-\-user +vu\-rawhide\-0 753 ? (sd\-pam) +vu\-rawhide\-0 1628 ? login \-\- zbyszek +vu\-rawhide\-1000 1630 ? /usr/lib/systemd/systemd \-\-user +vu\-rawhide\-1000 1631 ? (sd\-pam) +vu\-rawhide\-1000 1637 pts/8 \-zsh +.fi +.if n \{\ +.RE +.\} +.SH "SEE ALSO" +.PP +\fBsystemd\fR(1), +\fBsystemd.exec\fR(5), +\fBnss-resolve\fR(8), +\fBnss-myhostname\fR(8), +\fBnss-mymachines\fR(8), +\fBsystemd-userdbd.service\fR(8), +\fBsystemd-homed.service\fR(8), +\fBsystemd-machined.service\fR(8), +\fBnsswitch.conf\fR(5), +\fBgetent\fR(1) +.SH "NOTES" +.IP " 1." 4 +User/Group Record Lookup API via Varlink +.RS 4 +\%https://systemd.io/USER_GROUP_API +.RE +.IP " 2." 4 +JSON User Records +.RS 4 +\%https://systemd.io/USER_RECORD +.RE +.IP " 3." 4 +JSON Group Record +.RS 4 +\%https://systemd.io/GROUP_RECORD +.RE diff --git a/upstream/opensuse-leap-15-6/man8/pam_systemd.8 b/upstream/opensuse-leap-15-6/man8/pam_systemd.8 new file mode 100644 index 00000000..41c74edb --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/pam_systemd.8 @@ -0,0 +1,398 @@ +'\" t +.TH "PAM_SYSTEMD" "8" "" "systemd 254" "pam_systemd" +.\" ----------------------------------------------------------------- +.\" * 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" +pam_systemd \- Register user sessions in the systemd login manager +.SH "SYNOPSIS" +.PP +pam_systemd\&.so +.SH "DESCRIPTION" +.PP +\fBpam_systemd\fR +registers user sessions with the systemd login manager +\fBsystemd-logind.service\fR(8), and hence the systemd control group hierarchy\&. +.PP +The module also applies various resource management and runtime parameters to the new session, as configured in the +\m[blue]\fBJSON User Records\fR\m[]\&\s-2\u[1]\d\s+2 +of the user, when one is defined\&. +.PP +On login, this module \(em in conjunction with +systemd\-logind\&.service +\(em ensures the following: +.sp +.RS 4 +.ie n \{\ +\h'-04' 1.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 1." 4.2 +.\} +If it does not exist yet, the user runtime directory +/run/user/$UID +is either created or mounted as new +"tmpfs" +file system with quota applied, and its ownership changed to the user that is logging in\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04' 2.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 2." 4.2 +.\} +The +\fI$XDG_SESSION_ID\fR +environment variable is initialized\&. If auditing is available and +\fBpam_loginuid\&.so\fR +was run before this module (which is highly recommended), the variable is initialized from the auditing session id (/proc/self/sessionid)\&. Otherwise, an independent session counter is used\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04' 3.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 3." 4.2 +.\} +A new systemd scope unit is created for the session\&. If this is the first concurrent session of the user, an implicit per\-user slice unit below +user\&.slice +is automatically created and the scope placed into it\&. An instance of the system service +user@\&.service, which runs the systemd user manager instance, is started\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04' 4.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 4." 4.2 +.\} +The +"$TZ", +"$EMAIL" +and +"$LANG" +environment variables are configured for the user, based on the respective data from the user\*(Aqs JSON record (if it is defined)\&. Moreover, any environment variables explicitly configured in the user record are imported, and the umask, nice level, and resource limits initialized\&. +.RE +.PP +On logout, this module ensures the following: +.sp +.RS 4 +.ie n \{\ +\h'-04' 1.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 1." 4.2 +.\} +If enabled in +\fBlogind.conf\fR(5) +(\fIKillUserProcesses=\fR), all processes of the session are terminated\&. If the last concurrent session of a user ends, the user\*(Aqs systemd instance will be terminated too, and so will the user\*(Aqs slice unit\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04' 2.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 2." 4.2 +.\} +If the last concurrent session of a user ends, the user runtime directory +/run/user/$UID +and all its contents are removed, too\&. +.RE +.PP +If the system was not booted up with systemd as init system, this module does nothing and immediately returns +\fBPAM_SUCCESS\fR\&. +.SH "OPTIONS" +.PP +The following options are understood: +.PP +\fIclass=\fR +.RS 4 +Takes a string argument which sets the session class\&. The +\fIXDG_SESSION_CLASS\fR +environment variable (see below) takes precedence\&. One of +"user", +"greeter", +"lock\-screen" +or +"background"\&. See +\fBsd_session_get_class\fR(3) +for details about the session class\&. +.RE +.PP +\fItype=\fR +.RS 4 +Takes a string argument which sets the session type\&. The +\fIXDG_SESSION_TYPE\fR +environment variable (see below) takes precedence\&. One of +"unspecified", +"tty", +"x11", +"wayland" +or +"mir"\&. See +\fBsd_session_get_type\fR(3) +for details about the session type\&. +.RE +.PP +\fIdesktop=\fR +.RS 4 +Takes a single, short identifier string for the desktop environment\&. The +\fIXDG_SESSION_DESKTOP\fR +environment variable (see below) takes precedence\&. This may be used to indicate the session desktop used, where this applies and if this information is available\&. For example: +"GNOME", or +"KDE"\&. It is recommended to use the same identifiers and capitalization as for +\fI$XDG_CURRENT_DESKTOP\fR, as defined by the +\m[blue]\fBDesktop Entry Specification\fR\m[]\&\s-2\u[2]\d\s+2\&. (However, note that the option only takes a single item, and not a colon\-separated list like +\fI$XDG_CURRENT_DESKTOP\fR\&.) See +\fBsd_session_get_desktop\fR(3) +for further details\&. +.RE +.PP +\fIdefault\-capability\-bounding\-set=\fR, \fIdefault\-capability\-ambient\-set=\fR +.RS 4 +Takes a comma\-separated list of process capabilities (e\&.g\&. +\fBCAP_WAKE_ALARM\fR, +\fBCAP_BLOCK_SUSPEND\fR, \&...) to set for the invoked session\*(Aqs processes, if the user record does not encode appropriate sets of capabilities directly\&. See +\fBcapabilities\fR(7) +for details on the capabilities concept\&. If not specified, the default bounding set is left as is (i\&.e\&. usually contains the full set of capabilities)\&. The default ambient set is set to +\fBCAP_WAKE_ALARM\fR +for regular users if the PAM session is associated with a local seat or if it is invoked for the +"systemd\-user" +service\&. Otherwise defaults to the empty set\&. +.RE +.PP +\fIdebug\fR[=] +.RS 4 +Takes an optional boolean argument\&. If yes or without the argument, the module will log debugging information as it operates\&. +.RE +.SH "MODULE TYPES PROVIDED" +.PP +Only +\fBsession\fR +is provided\&. +.SH "ENVIRONMENT" +.PP +The following environment variables are initialized by the module and available to the processes of the user\*(Aqs session: +.PP +\fI$XDG_SESSION_ID\fR +.RS 4 +A short session identifier, suitable to be used in filenames\&. The string itself should be considered opaque, although often it is just the audit session ID as reported by +/proc/self/sessionid\&. Each ID will be assigned only once during machine uptime\&. It may hence be used to uniquely label files or other resources of this session\&. Combine this ID with the boot identifier, as returned by +\fBsd_id128_get_boot\fR(3), for a globally unique identifier\&. +.RE +.PP +\fI$XDG_RUNTIME_DIR\fR +.RS 4 +Path to a user\-private user\-writable directory that is bound to the user login time on the machine\&. It is automatically created the first time a user logs in and removed on the user\*(Aqs final logout\&. If a user logs in twice at the same time, both sessions will see the same +\fI$XDG_RUNTIME_DIR\fR +and the same contents\&. If a user logs in once, then logs out again, and logs in again, the directory contents will have been lost in between, but applications should not rely on this behavior and must be able to deal with stale files\&. To store session\-private data in this directory, the user should include the value of +\fI$XDG_SESSION_ID\fR +in the filename\&. This directory shall be used for runtime file system objects such as +\fBAF_UNIX\fR +sockets, FIFOs, PID files and similar\&. It is guaranteed that this directory is local and offers the greatest possible file system feature set the operating system provides\&. For further details, see the +\m[blue]\fBXDG Base Directory Specification\fR\m[]\&\s-2\u[3]\d\s+2\&. +\fI$XDG_RUNTIME_DIR\fR +is not set if the current user is not the original user of the session\&. +.RE +.PP +\fI$TZ\fR, \fI$EMAIL\fR, \fI$LANG\fR +.RS 4 +If a JSON user record is known for the user logging in these variables are initialized from the respective data in the record\&. +.RE +.PP +The following environment variables are read by the module and may be used by the PAM service to pass metadata to the module\&. If these variables are not set when the PAM module is invoked but can be determined otherwise they are set by the module, so that these variables are initialized for the session and applications if known at all\&. +.PP +\fI$XDG_SESSION_TYPE\fR +.RS 4 +The session type\&. This may be used instead of +\fItype=\fR +on the module parameter line, and is usually preferred\&. +.RE +.PP +\fI$XDG_SESSION_CLASS\fR +.RS 4 +The session class\&. This may be used instead of +\fIclass=\fR +on the module parameter line, and is usually preferred\&. +.RE +.PP +\fI$XDG_SESSION_DESKTOP\fR +.RS 4 +The desktop identifier\&. This may be used instead of +\fIdesktop=\fR +on the module parameter line, and is usually preferred\&. +.RE +.PP +\fI$XDG_SEAT\fR +.RS 4 +The seat name the session shall be registered for, if any\&. +.RE +.PP +\fI$XDG_VTNR\fR +.RS 4 +The VT number the session shall be registered for, if any\&. (Only applies to seats with a VT available, such as +"seat0") +.RE +.PP +If not set, +\fBpam_systemd\fR +will initialize +\fI$XDG_SEAT\fR +and +\fI$XDG_VTNR\fR +based on the +\fI$DISPLAY\fR +variable (if the latter is set)\&. +.SH "SESSION LIMITS" +.PP +PAM modules earlier in the stack, that is those that come before +\fBpam_systemd\&.so\fR, can set session scope limits using the PAM context objects\&. The data for these objects is provided as +\fBNUL\fR\-terminated C strings and maps directly to the respective unit resource control directives\&. Note that these limits apply to individual sessions of the user, they do not apply to all user processes as a combined whole\&. In particular, the per\-user +\fBuser@\&.service\fR +unit instance, which runs the +\fBsystemd \-\-user\fR +manager process and its children, and is tracked outside of any session, being shared by all the user\*(Aqs sessions, is not covered by these limits\&. +.PP +See +\fBsystemd.resource-control\fR(5) +for more information about the resources\&. Also, see +\fBpam_set_data\fR(3) +for additional information about how to set the context objects\&. +.PP +\fIsystemd\&.memory_max=\fR +.RS 4 +Sets unit +\fIMemoryMax=\fR\&. +.RE +.PP +\fIsystemd\&.tasks_max=\fR +.RS 4 +Sets unit +\fITasksMax=\fR\&. +.RE +.PP +\fIsystemd\&.cpu_weight=\fR +.RS 4 +Sets unit +\fICPUWeight=\fR\&. +.RE +.PP +\fIsystemd\&.io_weight=\fR +.RS 4 +Sets unit +\fIIOWeight=\fR\&. +.RE +.PP +\fIsystemd\&.runtime_max_sec=\fR +.RS 4 +Sets unit +\fIRuntimeMaxSec=\fR\&. +.RE +.PP +Example data as can be provided from an another PAM module: +.sp +.if n \{\ +.RS 4 +.\} +.nf +pam_set_data(handle, "systemd\&.memory_max", (void *)"200M", cleanup); +pam_set_data(handle, "systemd\&.tasks_max", (void *)"50", cleanup); +pam_set_data(handle, "systemd\&.cpu_weight", (void *)"100", cleanup); +pam_set_data(handle, "systemd\&.io_weight", (void *)"340", cleanup); +pam_set_data(handle, "systemd\&.runtime_max_sec", (void *)"3600", cleanup); + +.fi +.if n \{\ +.RE +.\} +.sp +.SH "EXAMPLE" +.PP +Here\*(Aqs an example PAM configuration fragment that allows users sessions to be managed by +systemd\-logind\&.service: +.sp +.if n \{\ +.RS 4 +.\} +.nf +#%PAM\-1\&.0 +auth sufficient pam_unix\&.so +\-auth sufficient pam_systemd_home\&.so +auth required pam_deny\&.so + +account required pam_nologin\&.so +\-account sufficient pam_systemd_home\&.so +account sufficient pam_unix\&.so +account required pam_permit\&.so + +\-password sufficient pam_systemd_home\&.so +password sufficient pam_unix\&.so sha512 shadow try_first_pass use_authtok + +password required pam_deny\&.so + +\-session optional pam_keyinit\&.so revoke +\-session optional pam_loginuid\&.so +\-session optional pam_systemd_home\&.so +\fB\-session optional pam_systemd\&.so\fR +session required pam_unix\&.so +.fi +.if n \{\ +.RE +.\} +.SH "SEE ALSO" +.PP +\fBsystemd\fR(1), +\fBsystemd-logind.service\fR(8), +\fBlogind.conf\fR(5), +\fBloginctl\fR(1), +\fBpam_systemd_home\fR(8), +\fBpam.conf\fR(5), +\fBpam.d\fR(5), +\fBpam\fR(8), +\fBpam_loginuid\fR(8), +\fBsystemd.scope\fR(5), +\fBsystemd.slice\fR(5), +\fBsystemd.service\fR(5) +.SH "NOTES" +.IP " 1." 4 +JSON User Records +.RS 4 +\%https://systemd.io/USER_RECORD +.RE +.IP " 2." 4 +Desktop Entry Specification +.RS 4 +\%https://standards.freedesktop.org/desktop-entry-spec/latest/ +.RE +.IP " 3." 4 +XDG Base Directory Specification +.RS 4 +\%https://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html +.RE diff --git a/upstream/opensuse-leap-15-6/man8/parted.8 b/upstream/opensuse-leap-15-6/man8/parted.8 new file mode 100644 index 00000000..a3566321 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/parted.8 @@ -0,0 +1,147 @@ +.TH PARTED 8 "2007 March 29" parted "GNU Parted Manual" +.SH NAME +GNU Parted \- a partition manipulation program +.SH SYNOPSIS +.B parted +[options] [device [command [options...]...]] +.SH DESCRIPTION +.B parted +is a program to manipulate disk partitions. It supports multiple partition +table formats, including MS-DOS and GPT. It is useful for creating space for +new operating systems, reorganising disk usage, and copying data to new hard +disks. +.PP +This manual page documents \fBparted\fP briefly. Complete documentation is +distributed with the package in GNU Info format. +.SH OPTIONS +.TP +.B -h, --help +displays a help message +.TP +.B -l, --list +lists partition layout on all block devices +.TP +.B -m, --machine +displays machine parseable output +.TP +.B -s, --script +never prompts for user intervention +.TP +.B -v, --version +displays the version +.TP +.B --ignore-busy +perform the requested action in script mode although a partition is busy +.TP +.B --wipesignatures +mkpart wipes the superblock signatures from the disk region where it is +about to create the partition +.TP +.B -a \fIalignment-type\fP, --align \fIalignment-type\fP +Set alignment for newly created partitions, valid alignment types are: +.RS +.IP none +Use the minimum alignment allowed by the disk type. +.IP cylinder +Align partitions to cylinders. +.IP minimal +Use minimum alignment as given by the disk topology information. This and +the opt value will use layout information provided by the disk to align the +logical partition table addresses to actual physical blocks on the disks. +The min value is the minimum alignment needed to align the partition properly to +physical blocks, which avoids performance degradation. +.IP optimal +Use optimum alignment as given by the disk topology information. This +aligns to a multiple of the physical block size in a way that guarantees +optimal performance. +.RE + +.SH COMMANDS +.TP +.B [device] +The block device to be used. When none is given, \fBparted\fP will use the +first block device it finds. +.TP +.B [command [options]] +Specifies the command to be executed. If no command is given, +.BR parted +will present a command prompt. Possible commands are: +.RS +.TP +.B help \fI[command]\fP +Print general help, or help on \fIcommand\fP if specified. +.TP +.B align-check \fItype\fP \fIpartition\fP +Check if \fIpartition\fP satisfies the alignment constraint of \fItype\fP. +\fItype\fP must be "minimal" or "optimal". +.TP +.B mklabel \fIlabel-type\fP +Create a new disklabel (partition table) of \fIlabel-type\fP. \fIlabel-type\fP +should be one of "aix", "amiga", "bsd", "dvh", "gpt", "loop", "mac", "msdos", +"pc98", or "sun". +.TP +.B mkpart [\fIpart-type\fP \fIname\fP \fIfs-type\fP] \fIstart\fP \fIend\fP +Create a new partition. \fIpart-type\fP may be specified only with msdos and +dvh partition tables, it should be one of "primary", "logical", or "extended". +\fIname\fP is required for GPT partition tables and \fIfs-type\fP is optional. +.TP +.B name \fIpartition\fP \fIname\fP +Set the name of \fIpartition\fP to \fIname\fP. This option works only on Mac, +PC98, and GPT disklabels. The name can be placed in quotes, if necessary. +.TP +.B print +Display the partition table. +.TP +.B quit +Exit from \fBparted\fP. +.TP +.B rescue \fIstart\fP \fIend\fP +Rescue a lost partition that was located somewhere between \fIstart\fP and +\fIend\fP. If a partition is found, \fBparted\fP will ask if you want to +create an entry for it in the partition table. +.TP +.B resizepart \fIpartition\fP \fIend\fP +Change the \fIend\fP position of \fIpartition\fP. Note that this does not +modify any filesystem present in the partition. +.TP +.B rm \fIpartition\fP +Delete \fIpartition\fP. +.TP +.B select \fIdevice\fP +Choose \fIdevice\fP as the current device to edit. \fIdevice\fP should usually +be a Linux hard disk device, but it can be a partition, software raid device, +or an LVM logical volume if necessary. +.TP +.B set \fIpartition\fP \fIflag\fP \fIstate\fP +Change the state of the \fIflag\fP on \fIpartition\fP to \fIstate\fP. +Supported flags are: "boot", "root", "swap", "hidden", "raid", "lvm", "lba", +"legacy_boot", "irst", "esp" and "palo". +\fIstate\fP should be either "on" or "off". +.TP +.B unit \fIunit\fP +Set \fIunit\fP as the unit to use when displaying locations and sizes, and for +interpreting those given by the user when not suffixed with an explicit unit. +\fIunit\fP can be one of "s" (sectors), "B" (bytes), "kB", "MB", "MiB", "GB", +"GiB", "TB", "TiB", "%" (percentage of device size), "cyl" (cylinders), "chs" +(cylinders, heads, sectors), or "compact" (megabytes for input, and a +human-friendly form for output). +.TP +.B toggle \fIpartition\fP \fIflag\fP +Toggle the state of \fIflag\fP on \fIpartition\fP. +.TP +.B version +Display version information and a copyright message. +.RE +.SH REPORTING BUGS +Report bugs to <bug-parted@gnu.org> +.SH SEE ALSO +.BR fdisk (8), +.BR mkfs (8), +The \fIparted\fP program is fully documented in the +.BR info(1) +format +.IR "GNU partitioning software" +manual. +.SH AUTHOR +This manual page was written by Timshel Knoll <timshel@debian.org>, +for the Debian GNU/Linux system (but may be used by others). diff --git a/upstream/opensuse-leap-15-6/man8/partprobe.8 b/upstream/opensuse-leap-15-6/man8/partprobe.8 new file mode 100644 index 00000000..48ae5dcc --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/partprobe.8 @@ -0,0 +1,55 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH PARTPROBE 8 "March 18, 2002" parted "GNU Parted Manual" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +partprobe \- inform the OS of partition table changes +.SH SYNOPSIS +.B partprobe +.RI [ -d ] +.RI [ -s ] +.RI [ devices... ] +.SH DESCRIPTION +This manual page documents briefly the +.B partprobe +command. +.PP +.\" TeX users may be more comfortable with the \fB<whatever>\fP and +.\" \fI<whatever>\fP escape sequences to invode bold face and italics, +.\" respectively. +\fBpartprobe\fP is a program that informs the operating system kernel of +partition table changes. +.SH OPTIONS +This program uses short UNIX style options. +.TP +.B -d, --dry-run +Don't update the kernel. +.TP +.B -s, --summary +Show a summary of devices and their partitions. +.TP +.B -h, --help +Show summary of options. +.TP +.B -v, --version +Show version of program. +.SH REPORTING BUGS +Report bugs to <bug-parted@gnu.org> +.SH SEE ALSO +.BR parted (8). +.SH AUTHOR +This manual page was written by Timshel Knoll <timshel@debian.org>, +for the Debian GNU/Linux system (but may be used by others). diff --git a/upstream/opensuse-leap-15-6/man8/partx.8 b/upstream/opensuse-leap-15-6/man8/partx.8 new file mode 100644 index 00000000..6e7ac4db --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/partx.8 @@ -0,0 +1,222 @@ +'\" t +.\" Title: partx +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "PARTX" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +partx \- tell the kernel about the presence and numbering of on\-disk partitions +.SH "SYNOPSIS" +.sp +\fBpartx\fP [\fB\-a\fP|\fB\-d\fP|\fB\-P\fP|\fB\-r\fP|\fB\-s\fP|\fB\-u\fP] [\fB\-t\fP \fItype\fP] [\fB\-n\fP \fIM\fP:_N_] [\-] \fIdisk\fP +.sp +\fBpartx\fP [\fB\-a\fP|\fB\-d\fP|\fB\-P\fP|\fB\-r\fP|\fB\-s\fP|\fB\-u\fP] [\fB\-t\fP \fItype\fP] \fIpartition\fP [\fIdisk\fP] +.SH "DESCRIPTION" +.sp +Given a device or disk\-image, \fBpartx\fP tries to parse the partition table and list its contents. It can also tell the kernel to add or remove partitions from its bookkeeping. +.sp +The \fIdisk\fP argument is optional when a \fIpartition\fP argument is provided. To force scanning a partition as if it were a whole disk (for example to list nested subpartitions), use the argument "\-" (hyphen\-minus). For example: +.RS 3 +.ll -.6i +.sp +partx \-\-show \- /dev/sda3 +.br +.RE +.ll +.sp +This will see sda3 as a whole\-disk rather than as a partition. +.sp +\fBpartx is not an fdisk program\fP \- adding and removing partitions does not change the disk, it just tells the kernel about the presence and numbering of on\-disk partitions. +.SH "OPTIONS" +.sp +\fB\-a\fP, \fB\-\-add\fP +.RS 4 +Add the specified partitions, or read the disk and add all partitions. +.RE +.sp +\fB\-b\fP, \fB\-\-bytes\fP +.RS 4 +Print the SIZE column in bytes rather than in human\-readable format. +.RE +.sp +\fB\-d\fP, \fB\-\-delete\fP +.RS 4 +Delete the specified partitions or all partitions. It is not error to remove non\-existing partitions, so this option is possible to use together with large \fB\-\-nr\fP ranges without care about the current partitions set on the device. +.RE +.sp +\fB\-g\fP, \fB\-\-noheadings\fP +.RS 4 +Do not print a header line with \fB\-\-show\fP or \fB\-\-raw\fP. +.RE +.sp +\fB\-l\fP, \fB\-\-list\fP +.RS 4 +List the partitions. Note that all numbers are in 512\-byte sectors. This output format is DEPRECATED in favour of \fB\-\-show\fP. Do not use it in newly written scripts. +.RE +.sp +\fB\-n\fP, \fB\-\-nr\fP \fIM\fP\fB:\fP\fIN\fP +.RS 4 +Specify the range of partitions. For backward compatibility also the format \fIM\fP\fB\-\fP\fIN\fP is supported. The range may contain negative numbers, for example \fB\-\-nr \-1:\-1\fP means the last partition, and \fB\-\-nr \-2:\-1\fP means the last two partitions. Supported range specifications are: +.sp +\fIM\fP +.RS 4 +Specifies just one partition (e.g. \fB\-\-nr 3\fP). +.RE +.sp +\fIM\fP\fB:\fP +.RS 4 +Specifies the lower limit only (e.g. \fB\-\-nr 2:\fP). +.RE +.sp +\fB:\fP\fIN\fP +.RS 4 +Specifies the upper limit only (e.g. \fB\-\-nr :4\fP). +.RE +.sp +\fIM\fP\fB:\fP\fIN\fP +.RS 4 +Specifies the lower and upper limits (e.g. \fB\-\-nr 2:4\fP). +.RE +.RE +.sp +\fB\-o\fP, \fB\-\-output\fP \fIlist\fP +.RS 4 +Define the output columns to use for \fB\-\-show\fP, \fB\-\-pairs\fP and \fB\-\-raw\fP output. If no output arrangement is specified, then a default set is used. Use \fB\-\-help\fP to get \fIlist\fP of all supported columns. This option cannot be combined with the \fB\-\-add\fP, \fB\-\-delete\fP, \fB\-\-update\fP or \fB\-\-list\fP options. +.RE +.sp +\fB\-\-output\-all\fP +.RS 4 +Output all available columns. +.RE +.sp +\fB\-P\fP, \fB\-\-pairs\fP +.RS 4 +List the partitions using the KEY="value" format. +.RE +.sp +\fB\-r\fP, \fB\-\-raw\fP +.RS 4 +List the partitions using the raw output format. +.RE +.sp +\fB\-s\fP, \fB\-\-show\fP +.RS 4 +List the partitions. The output columns can be selected and rearranged with the \fB\-\-output\fP option. All numbers (except SIZE) are in 512\-byte sectors. +.RE +.sp +\fB\-t\fP, \fB\-\-type\fP \fItype\fP +.RS 4 +Specify the partition table type. +.RE +.sp +\fB\-\-list\-types\fP +.RS 4 +List supported partition types and exit. +.RE +.sp +\fB\-u\fP, \fB\-\-update\fP +.RS 4 +Update the specified partitions. +.RE +.sp +\fB\-S\fP, \fB\-\-sector\-size\fP \fIsize\fP +.RS 4 +Overwrite default sector size. +.RE +.sp +\fB\-v\fP, \fB\-\-verbose\fP +.RS 4 +Verbose mode. +.RE +.sp +\fB\-V\fP, \fB\-\-version\fP +.RS 4 +Display version information and exit. +.RE +.sp +\fB\-h\fP, \fB\-\-help\fP +.RS 4 +Display help text and exit. +.RE +.SH "ENVIRONMENT" +.sp +LIBBLKID_DEBUG=all +.RS 4 +enables libblkid debug output. +.RE +.SH "EXAMPLE" +.sp +partx \-\-show /dev/sdb3, partx \-\-show \-\-nr 3 /dev/sdb, partx \-\-show /dev/sdb3 /dev/sdb +.RS 4 +All three commands list partition 3 of /dev/sdb. +.RE +.sp +partx \-\-show \- /dev/sdb3 +.RS 4 +Lists all subpartitions on \fI/dev/sdb3\fP (the device is used as whole\-disk). +.RE +.sp +partx \-o START \-g \-\-nr 5 /dev/sdb +.RS 4 +Prints the start sector of partition 5 on \fI/dev/sdb\fP without header. +.RE +.sp +partx \-o SECTORS,SIZE /dev/sda5 /dev/sda +.RS 4 +Lists the length in sectors and human\-readable size of partition 5 on \fI/dev/sda\fP. +.RE +.sp +partx \-\-add \-\-nr 3:5 /dev/sdd +.RS 4 +Adds all available partitions from 3 to 5 (inclusive) on \fI/dev/sdd\fP. +.RE +.sp +partx \-d \-\-nr :\-1 /dev/sdd +.RS 4 +Removes the last partition on \fI/dev/sdd\fP. +.RE +.SH "AUTHORS" +.sp +.MTO "dave\(atgnu.org" "Davidlohr Bueso" "," +.MTO "kzak\(atredhat.com" "Karel Zak" "" +.sp +The original version was written by \c +.MTO "aeb\(atcwi.nl" "Andries E. Brouwer" "" +.SH "SEE ALSO" +.sp +\fBaddpart\fP(8), +\fBdelpart\fP(8), +\fBfdisk\fP(8), +\fBparted\fP(8), +\fBpartprobe\fP(8) +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBpartx\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/ping.8 b/upstream/opensuse-leap-15-6/man8/ping.8 new file mode 100644 index 00000000..e93f786c --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/ping.8 @@ -0,0 +1,523 @@ +'\" t +.TH "PING" "8" "" "iputils 20221126" "iputils" +.\" ----------------------------------------------------------------- +.\" * 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" +ping \- send ICMP ECHO_REQUEST to network hosts +.SH "SYNOPSIS" +.HP \w'\fBping\fR\ 'u +\fBping\fR [\fB\-aAbBdCDefhLnOqrRUvV46\fR] [\fB\-c\ \fR\fB\fIcount\fR\fR] [\fB\-F\ \fR\fB\fIflowlabel\fR\fR] [\fB\-i\ \fR\fB\fIinterval\fR\fR] [\fB\-I\ \fR\fB\fIinterface\fR\fR] [\fB\-l\ \fR\fB\fIpreload\fR\fR] [\fB\-m\ \fR\fB\fImark\fR\fR] [\fB\-M\ \fR\fB\fIpmtudisc_option\fR\fR] [\fB\-N\ \fR\fB\fInodeinfo_option\fR\fR] [\fB\-w\ \fR\fB\fIdeadline\fR\fR] [\fB\-W\ \fR\fB\fItimeout\fR\fR] [\fB\-p\ \fR\fB\fIpattern\fR\fR] [\fB\-Q\ \fR\fB\fItos\fR\fR] [\fB\-s\ \fR\fB\fIpacketsize\fR\fR] [\fB\-S\ \fR\fB\fIsndbuf\fR\fR] [\fB\-t\ \fR\fB\fIttl\fR\fR] [\fB\-T\ \fR\fB\fItimestamp\ option\fR\fR] [hop\&.\&.\&.] {destination} +.SH "DESCRIPTION" +.PP +\fBping\fR +uses the ICMP protocol\*(Aqs mandatory ECHO_REQUEST datagram to elicit an ICMP ECHO_RESPONSE from a host or gateway\&. ECHO_REQUEST datagrams (\(lqpings\(rq) have an IP and ICMP header, followed by a struct timeval and then an arbitrary number of \(lqpad\(rq bytes used to fill out the packet\&. +.PP +\fBping\fR +works with both IPv4 and IPv6\&. Using only one of them explicitly can be enforced by specifying +\fB\-4\fR +or +\fB\-6\fR\&. +.PP +\fBping\fR +can also send IPv6 Node Information Queries (RFC4620)\&. Intermediate +\fIhop\fRs may not be allowed, because IPv6 source routing was deprecated (RFC5095)\&. +.SH "OPTIONS" +.PP +\fB\-4\fR +.RS 4 +Use IPv4 only\&. +.RE +.PP +\fB\-6\fR +.RS 4 +Use IPv6 only\&. +.RE +.PP +\fB\-a\fR +.RS 4 +Audible ping\&. +.RE +.PP +\fB\-A\fR +.RS 4 +Adaptive ping\&. Interpacket interval adapts to round\-trip time, so that effectively not more than one (or more, if preload is set) unanswered probe is present in the network\&. Minimal interval is 200msec unless super\-user\&. On networks with low RTT this mode is essentially equivalent to flood mode\&. +.RE +.PP +\fB\-b\fR +.RS 4 +Allow pinging a broadcast address\&. +.RE +.PP +\fB\-B\fR +.RS 4 +Do not allow +\fBping\fR +to change source address of probes\&. The address is bound to one selected when +\fBping\fR +starts\&. +.RE +.PP +\fB\-c\fR \fIcount\fR +.RS 4 +Stop after sending +\fIcount\fR +ECHO_REQUEST packets\&. With +\fIdeadline\fR +option, +\fBping\fR +waits for +\fIcount\fR +ECHO_REPLY packets, until the timeout expires\&. +.RE +.PP +\fB\-C\fR +.RS 4 +Call connect() syscall on socket creation\&. +.RE +.PP +\fB\-d\fR +.RS 4 +Set the SO_DEBUG option on the socket being used\&. Essentially, this socket option is not used by Linux kernel\&. +.RE +.PP +\fB\-e\fR +.RS 4 +Set the identification field of ECHO_REQUEST\&. Value 0 implies using +\fIraw socket\fR +(not supported on +\fIICMP datagram socket\fR)\&. The value of the field may be printed with +\fB\-v\fR +option\&. +.RE +.PP +\fB\-D\fR +.RS 4 +Print timestamp (unix time + microseconds as in gettimeofday) before each line\&. +.RE +.PP +\fB\-f\fR +.RS 4 +Flood ping\&. For every ECHO_REQUEST sent a period \(lq\&.\(rq is printed, while for every ECHO_REPLY received a backspace is printed\&. This provides a rapid display of how many packets are being dropped\&. If interval is not given, it sets interval to zero and outputs packets as fast as they come back or one hundred times per second, whichever is more\&. Only the super\-user may use this option with zero interval\&. +.RE +.PP +\fB\-F\fR \fIflow label\fR +.RS 4 +IPv6 only\&. Allocate and set 20 bit flow label (in hex) on echo request packets\&. If value is zero, kernel allocates random flow label\&. +.RE +.PP +\fB\-h\fR +.RS 4 +Show help\&. +.RE +.PP +\fB\-i\fR \fIinterval\fR +.RS 4 +Wait +\fIinterval\fR +seconds between sending each packet\&. Real number allowed with dot as a decimal separator (regardless locale setup)\&. The default is to wait for one second between each packet normally, or not to wait in flood mode\&. Only super\-user may set interval to values less than 2 ms\&. +.RE +.PP +\fB\-I\fR \fIinterface\fR +.RS 4 +\fIinterface\fR +is either an address, an interface name or a VRF name\&. If +\fIinterface\fR +is an address, it sets source address to specified interface address\&. If +\fIinterface\fR +is an interface name, it sets source interface to specified interface\&. If +\fIinterface\fR +is a VRF name, each packet is routed using the corresponding routing table; in this case, the +\fB\-I\fR +option can be repeated to specify a source address\&. NOTE: For IPv6, when doing ping to a link\-local scope address, link specification (by the \*(Aq%\*(Aq\-notation in +\fIdestination\fR, or by this option) can be used but it is no longer required\&. +.RE +.PP +\fB\-l\fR \fIpreload\fR +.RS 4 +If +\fIpreload\fR +is specified, +\fBping\fR +sends that many packets not waiting for reply\&. Only the super\-user may select preload more than 3\&. +.RE +.PP +\fB\-L\fR +.RS 4 +Suppress loopback of multicast packets\&. This flag only applies if the ping destination is a multicast address\&. +.RE +.PP +\fB\-m\fR \fImark\fR +.RS 4 +use +\fImark\fR +to tag the packets going out\&. This is useful for variety of reasons within the kernel such as using policy routing to select specific outbound processing\&. +.RE +.PP +\fB\-M\fR \fIpmtudisc_opt\fR +.RS 4 +Select Path MTU Discovery strategy\&. +\fIpmtudisc_option\fR +may be either +\fIdo\fR +(prohibit fragmentation, even local one), +\fIwant\fR +(do PMTU discovery, fragment locally when packet size is large), or +\fIdont\fR +(do not set DF flag)\&. +.RE +.PP +\fB\-N\fR \fInodeinfo_option\fR +.RS 4 +IPv6 only\&. Send ICMPv6 Node Information Queries (RFC4620), instead of Echo Request\&. CAP_NET_RAW capability is required\&. +.PP +\fBhelp\fR +.RS 4 +Show help for NI support\&. +.RE +.PP +\fBname\fR +.RS 4 +Queries for Node Names\&. +.RE +.PP +\fBipv6\fR +.RS 4 +Queries for IPv6 Addresses\&. There are several IPv6 specific flags\&. +.PP +\fBipv6\-global\fR +.RS 4 +Request IPv6 global\-scope addresses\&. +.RE +.PP +\fBipv6\-sitelocal\fR +.RS 4 +Request IPv6 site\-local addresses\&. +.RE +.PP +\fBipv6\-linklocal\fR +.RS 4 +Request IPv6 link\-local addresses\&. +.RE +.PP +\fBipv6\-all\fR +.RS 4 +Request IPv6 addresses on other interfaces\&. +.RE +.RE +.PP +\fBipv4\fR +.RS 4 +Queries for IPv4 Addresses\&. There is one IPv4 specific flag\&. +.PP +\fBipv4\-all\fR +.RS 4 +Request IPv4 addresses on other interfaces\&. +.RE +.RE +.PP +\fBsubject\-ipv6=\fR\fIipv6addr\fR +.RS 4 +IPv6 subject address\&. +.RE +.PP +\fBsubject\-ipv4=\fR\fIipv4addr\fR +.RS 4 +IPv4 subject address\&. +.RE +.PP +\fBsubject\-name=\fR\fInodename\fR +.RS 4 +Subject name\&. If it contains more than one dot, fully\-qualified domain name is assumed\&. +.RE +.PP +\fBsubject\-fqdn=\fR\fInodename\fR +.RS 4 +Subject name\&. Fully\-qualified domain name is always assumed\&. +.RE +.RE +.PP +\fB\-n\fR +.RS 4 +Numeric output only\&. No attempt will be made to lookup symbolic names for host addresses\&. +.RE +.PP +\fB\-O\fR +.RS 4 +Report outstanding ICMP ECHO reply before sending next packet\&. This is useful together with the timestamp +\fB\-D\fR +to log output to a diagnostic file and search for missing answers\&. +.RE +.PP +\fB\-p\fR \fIpattern\fR +.RS 4 +You may specify up to 16 \(lqpad\(rq bytes to fill out the packet you send\&. This is useful for diagnosing data\-dependent problems in a network\&. For example, +\fB\-p ff\fR +will cause the sent packet to be filled with all ones\&. +.RE +.PP +\fB\-q\fR +.RS 4 +Quiet output\&. Nothing is displayed except the summary lines at startup time and when finished\&. +.RE +.PP +\fB\-Q\fR \fItos\fR +.RS 4 +Set Quality of Service \-related bits in ICMP datagrams\&. +\fItos\fR +can be decimal (\fBping\fR +only) or hex number\&. +.sp +In RFC2474, these fields are interpreted as 8\-bit Differentiated Services (DS), consisting of: bits 0\-1 (2 lowest bits) of separate data, and bits 2\-7 (highest 6 bits) of Differentiated Services Codepoint (DSCP)\&. In RFC2481 and RFC3168, bits 0\-1 are used for ECN\&. +.sp +Historically (RFC1349, obsoleted by RFC2474), these were interpreted as: bit 0 (lowest bit) for reserved (currently being redefined as congestion control), 1\-4 for Type of Service and bits 5\-7 (highest bits) for Precedence\&. +.RE +.PP +\fB\-r\fR +.RS 4 +Bypass the normal routing tables and send directly to a host on an attached interface\&. If the host is not on a directly\-attached network, an error is returned\&. This option can be used to ping a local host through an interface that has no route through it provided the option +\fB\-I\fR +is also used\&. +.RE +.PP +\fB\-R\fR +.RS 4 +\fBping\fR +only\&. Record route\&. Includes the RECORD_ROUTE option in the ECHO_REQUEST packet and displays the route buffer on returned packets\&. Note that the IP header is only large enough for nine such routes\&. Many hosts ignore or discard this option\&. +.RE +.PP +\fB\-s\fR \fIpacketsize\fR +.RS 4 +Specifies the number of data bytes to be sent\&. The default is 56, which translates into 64 ICMP data bytes when combined with the 8 bytes of ICMP header data\&. +.RE +.PP +\fB\-S\fR \fIsndbuf\fR +.RS 4 +Set socket sndbuf\&. If not specified, it is selected to buffer not more than one packet\&. +.RE +.PP +\fB\-t\fR \fIttl\fR +.RS 4 +\fBping\fR +only\&. Set the IP Time to Live\&. +.RE +.PP +\fB\-T\fR \fItimestamp option\fR +.RS 4 +Set special IP timestamp options\&. +\fItimestamp option\fR +may be either +\fItsonly\fR +(only timestamps), +\fItsandaddr\fR +(timestamps and addresses) or +\fItsprespec host1 [host2 [host3 [host4]]]\fR +(timestamp prespecified hops)\&. +.RE +.PP +\fB\-U\fR +.RS 4 +Print full user\-to\-user latency (the old behaviour)\&. Normally +\fBping\fR +prints network round trip time, which can be different f\&.e\&. due to DNS failures\&. +.RE +.PP +\fB\-v\fR +.RS 4 +Verbose output\&. Do not suppress DUP replies when pinging multicast address\&. +.RE +.PP +\fB\-V\fR +.RS 4 +Show version and exit\&. +.RE +.PP +\fB\-w\fR \fIdeadline\fR +.RS 4 +Specify a timeout, in seconds, before +\fBping\fR +exits regardless of how many packets have been sent or received\&. In this case +\fBping\fR +does not stop after +\fIcount\fR +packet are sent, it waits either for +\fIdeadline\fR +expire or until +\fIcount\fR +probes are answered or for some error notification from network\&. +.RE +.PP +\fB\-W\fR \fItimeout\fR +.RS 4 +Time to wait for a response, in seconds\&. The option affects only timeout in absence of any responses, otherwise +\fBping\fR +waits for two RTTs\&. Real number allowed with dot as a decimal separator (regardless locale setup)\&. 0 means infinite timeout\&. +.RE +.PP +When using +\fBping\fR +for fault isolation, it should first be run on the local host, to verify that the local network interface is up and running\&. Then, hosts and gateways further and further away should be \(lqpinged\(rq\&. Round\-trip times and packet loss statistics are computed\&. If duplicate packets are received, they are not included in the packet loss calculation, although the round trip time of these packets is used in calculating the minimum/average/maximum/mdev round\-trip time numbers\&. +.PP +Population standard deviation (mdev), essentially an average of how far each ping RTT is from the mean RTT\&. The higher mdev is, the more variable the RTT is (over time)\&. With a high RTT variability, you will have speed issues with bulk transfers (they will take longer than is strictly speaking necessary, as the variability will eventually cause the sender to wait for ACKs) and you will have middling to poor VoIP quality\&. +.PP +When the specified number of packets have been sent (and received) or if the program is terminated with a SIGINT, a brief summary is displayed\&. Shorter current statistics can be obtained without termination of process with signal SIGQUIT\&. +.PP +If +\fBping\fR +does not receive any reply packets at all it will exit with code 1\&. If a packet +\fIcount\fR +and +\fIdeadline\fR +are both specified, and fewer than +\fIcount\fR +packets are received by the time the +\fIdeadline\fR +has arrived, it will also exit with code 1\&. On other error it exits with code 2\&. Otherwise it exits with code 0\&. This makes it possible to use the exit code to see if a host is alive or not\&. +.PP +This program is intended for use in network testing, measurement and management\&. Because of the load it can impose on the network, it is unwise to use +\fBping\fR +during normal operations or from automated scripts\&. +.SH "IPV6 LINK\-LOCAL DESTINATIONS" +.PP +For IPv6, when the destination address has link\-local scope and +\fBping\fR +is using +\fIICMP datagram sockets\fR, the output interface must be specified\&. When +\fBping\fR +is using +\fIraw sockets\fR, it is not strictly necessary to specify the output interface but it should be done to avoid ambiguity when there are multiple possible output interfaces\&. +.PP +There are two ways to specify the output interface: +.PP +\(bu using the \fI% notation\fR +.RS 4 +The destination address is postfixed with +\fI%\fR +and the output interface name or ifindex, for example: +.sp +\fBping fe80::5054:ff:fe70:67bc%eth0\fR +.sp +\fBping fe80::5054:ff:fe70:67bc%2\fR +.RE +.PP +\(bu using the \fI\-I option\fR +.RS 4 +When using +\fIICMP datagram sockets\fR, this method is supported since the following kernel versions: 5\&.17, 5\&.15\&.19, 5\&.10\&.96, 5\&.4\&.176, 4\&.19\&.228, 4\&.14\&.265\&. Also it is not supported on musl libc\&. +.RE +.SH "ICMP PACKET DETAILS" +.PP +An IP header without options is 20 bytes\&. An ICMP ECHO_REQUEST packet contains an additional 8 bytes worth of ICMP header followed by an arbitrary amount of data\&. When a +\fIpacketsize\fR +is given, this indicates the size of this extra piece of data (the default is 56)\&. Thus the amount of data received inside of an IP packet of type ICMP ECHO_REPLY will always be 8 bytes more than the requested data space (the ICMP header)\&. +.PP +If the data space is at least of size of struct timeval +\fBping\fR +uses the beginning bytes of this space to include a timestamp which it uses in the computation of round trip times\&. If the data space is shorter, no round trip times are given\&. +.SH "DUPLICATE AND DAMAGED PACKETS" +.PP +\fBping\fR +will report duplicate and damaged packets\&. Duplicate packets should never occur, and seem to be caused by inappropriate link\-level retransmissions\&. Duplicates may occur in many situations and are rarely (if ever) a good sign, although the presence of low levels of duplicates may not always be cause for alarm\&. +.PP +Damaged packets are obviously serious cause for alarm and often indicate broken hardware somewhere in the +\fBping\fR +packet\*(Aqs path (in the network or in the hosts)\&. +.SH "TRYING DIFFERENT DATA PATTERNS" +.PP +The (inter)network layer should never treat packets differently depending on the data contained in the data portion\&. Unfortunately, data\-dependent problems have been known to sneak into networks and remain undetected for long periods of time\&. In many cases the particular pattern that will have problems is something that doesn\*(Aqt have sufficient \(lqtransitions\(rq, such as all ones or all zeros, or a pattern right at the edge, such as almost all zeros\&. It isn\*(Aqt necessarily enough to specify a data pattern of all zeros (for example) on the command line because the pattern that is of interest is at the data link level, and the relationship between what you type and what the controllers transmit can be complicated\&. +.PP +This means that if you have a data\-dependent problem you will probably have to do a lot of testing to find it\&. If you are lucky, you may manage to find a file that either can\*(Aqt be sent across your network or that takes much longer to transfer than other similar length files\&. You can then examine this file for repeated patterns that you can test using the +\fB\-p\fR +option of +\fBping\fR\&. +.SH "TTL DETAILS" +.PP +The TTL value of an IP packet represents the maximum number of IP routers that the packet can go through before being thrown away\&. In current practice you can expect each router in the Internet to decrement the TTL field by exactly one\&. +.PP +The TCP/IP specification states that the TTL field for TCP packets should be set to 60, but many systems use smaller values (4\&.3 BSD uses 30, 4\&.2 used 15)\&. +.PP +The maximum possible value of this field is 255, and most Unix systems set the TTL field of ICMP ECHO_REQUEST packets to 255\&. This is why you will find you can \(lqping\(rq some hosts, but not reach them with +\fBtelnet\fR(1) +or +\fBftp\fR(1)\&. +.PP +In normal operation ping prints the TTL value from the packet it receives\&. When a remote system receives a ping packet, it can do one of three things with the TTL field in its response: +.PP +.RS 4 +\(bu Not change it; this is what Berkeley Unix systems did before the 4\&.3BSD Tahoe release\&. In this case the TTL value in the received packet will be 255 minus the number of routers in the round\-trip path\&. +.RE +.PP +.RS 4 +\(bu Set it to 255; this is what current Berkeley Unix systems do\&. In this case the TTL value in the received packet will be 255 minus the number of routers in the path +\fBfrom\fR +the remote system +\fBto\fR +the +\fBping\fRing host\&. +.RE +.PP +.RS 4 +\(bu Set it to some other value\&. Some machines use the same value for ICMP packets that they use for TCP packets, for example either 30 or 60\&. Others may use completely wild values\&. +.RE +.SH "BUGS" +.PP +.RS 4 +\(bu Many Hosts and Gateways ignore the RECORD_ROUTE option\&. +.RE +.PP +.RS 4 +\(bu The maximum IP header length is too small for options like RECORD_ROUTE to be completely useful\&. There\*(Aqs not much that can be done about this, however\&. +.RE +.PP +.RS 4 +\(bu Flood pinging is not recommended in general, and flood pinging the broadcast address should only be done under very controlled conditions\&. +.RE +.SH "SEE ALSO" +.PP +\fBip\fR(8), +\fBss\fR(8)\&. +.SH "HISTORY" +.PP +The +\fBping\fR +command appeared in 4\&.3BSD\&. +.PP +The version described here is its descendant specific to Linux\&. +.PP +As of version s20150815, the +\fBping6\fR +binary doesn\*(Aqt exist anymore\&. It has been merged into +\fBping\fR\&. Creating a symlink named +\fBping6\fR +pointing to +\fBping\fR +will result in the same functionality as before\&. +.SH "SECURITY" +.PP +\fBping\fR +requires CAP_NET_RAW capability to be executed 1) if the program is used for non\-echo queries (see +\fB\-N\fR +option) or when the identification field set to 0 for ECHO_REQUEST (see +\fB\-e\fR), or 2) if kernel does not support ICMP datagram sockets, or 3) if the user is not allowed to create an ICMP echo socket\&. The program may be used as set\-uid root\&. +.SH "AVAILABILITY" +.PP +\fBping\fR +is part of +\fIiputils\fR +package\&. diff --git a/upstream/opensuse-leap-15-6/man8/pivot_root.8 b/upstream/opensuse-leap-15-6/man8/pivot_root.8 new file mode 100644 index 00000000..40459573 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/pivot_root.8 @@ -0,0 +1,112 @@ +'\" t +.\" Title: pivot_root +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "PIVOT_ROOT" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +pivot_root \- change the root filesystem +.SH "SYNOPSIS" +.sp +\fBpivot_root\fP \fInew_root\fP \fIput_old\fP +.SH "DESCRIPTION" +.sp +\fBpivot_root\fP moves the root file system of the current process to the directory \fIput_old\fP and makes \fInew_root\fP the new root file system. Since \fBpivot_root\fP(8) simply calls \fBpivot_root\fP(2), we refer to the man page of the latter for further details. +.sp +Note that, depending on the implementation of \fBpivot_root\fP, root and current working directory of the caller may or may not change. The following is a sequence for invoking \fBpivot_root\fP that works in either case, assuming that \fBpivot_root\fP and \fBchroot\fP are in the current \fBPATH\fP: +.sp +.if n .RS 4 +.nf +.fam C +cd new_root +pivot_root . put_old +exec chroot . command +.fam +.fi +.if n .RE +.sp +Note that \fBchroot\fP must be available under the old root and under the new root, because \fBpivot_root\fP may or may not have implicitly changed the root directory of the shell. +.sp +Note that \fBexec chroot\fP changes the running executable, which is necessary if the old root directory should be unmounted afterwards. Also note that standard input, output, and error may still point to a device on the old root file system, keeping it busy. They can easily be changed when invoking \fBchroot\fP (see below; note the absence of leading slashes to make it work whether \fBpivot_root\fP has changed the shell\(cqs root or not). +.SH "OPTIONS" +.sp +\fB\-V\fP, \fB\-\-version\fP +.RS 4 +Display version information and exit. +.RE +.sp +\fB\-h\fP, \fB\-\-help\fP +.RS 4 +Display help text and exit. +.RE +.SH "EXAMPLE" +.sp +Change the root file system to \fI/dev/hda1\fP from an interactive shell: +.sp +.if n .RS 4 +.nf +.fam C +mount /dev/hda1 /new\-root +cd /new\-root +pivot_root . old\-root +exec chroot . sh <dev/console >dev/console 2>&1 +umount /old\-root +.fam +.fi +.if n .RE +.sp +Mount the new root file system over NFS from 10.0.0.1:/my_root and run \fBinit\fP: +.sp +.if n .RS 4 +.nf +.fam C +ifconfig lo 127.0.0.1 up # for portmap +# configure Ethernet or such +portmap # for lockd (implicitly started by mount) +mount \-o ro 10.0.0.1:/my_root /mnt +killall portmap # portmap keeps old root busy +cd /mnt +pivot_root . old_root +exec chroot . sh \-c \(aqumount /old_root; exec /sbin/init\(aq \(rs + <dev/console >dev/console 2>&1 +.fam +.fi +.if n .RE +.SH "SEE ALSO" +.sp +\fBchroot\fP(1), +\fBpivot_root\fP(2), +\fBmount\fP(8), +\fBswitch_root\fP(8), +\fBumount\fP(8) +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBpivot_root\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/poweroff.8 b/upstream/opensuse-leap-15-6/man8/poweroff.8 new file mode 100644 index 00000000..efafc081 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/poweroff.8 @@ -0,0 +1,121 @@ +'\" t +.TH "POWEROFF" "8" "" "systemd 254" "poweroff" +.\" ----------------------------------------------------------------- +.\" * 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" +poweroff, reboot, halt \- Power off, reboot, or halt the machine +.SH "SYNOPSIS" +.HP \w'\fBpoweroff\fR\ 'u +\fBpoweroff\fR [OPTIONS...] +.HP \w'\fBreboot\fR\ 'u +\fBreboot\fR [OPTIONS...] +.HP \w'\fBhalt\fR\ 'u +\fBhalt\fR [OPTIONS...] +.SH "DESCRIPTION" +.PP +\fBpoweroff\fR, +\fBreboot\fR, and +\fBhalt\fR +may be used to power off, reboot, or halt the machine\&. All three commands take the same options\&. +.SH "OPTIONS" +.PP +The following options are understood: +.PP +\fB\-\-help\fR +.RS 4 +Print a short help text and exit\&. +.RE +.PP +\fB\-\-halt\fR +.RS 4 +Halt the machine, regardless of which one of the three commands is invoked\&. +.RE +.PP +\fB\-p\fR, \fB\-\-poweroff\fR +.RS 4 +Power off the machine, when either +\fBhalt\fR +or +\fBpoweroff\fR +is invoked\&. This option is ignored when +\fBreboot\fR +is invoked\&. +.RE +.PP +\fB\-\-reboot\fR +.RS 4 +Reboot the machine, regardless of which one of the three commands is invoked\&. +.RE +.PP +\fB\-f\fR, \fB\-\-force\fR +.RS 4 +Force immediate power\-off, halt, or reboot\&. If specified, the command does not contact the init system\&. In most cases, filesystems are not properly unmounted before shutdown\&. For example, the command +\fBreboot \-f\fR +is mostly equivalent to +\fBsystemctl reboot \-ff\fR, instead of +\fBsystemctl reboot \-f\fR\&. +.RE +.PP +\fB\-w\fR, \fB\-\-wtmp\-only\fR +.RS 4 +Only write wtmp shutdown entry, do not actually power off, reboot, or halt\&. +.RE +.PP +\fB\-d\fR, \fB\-\-no\-wtmp\fR +.RS 4 +Do not write wtmp shutdown entry\&. +.RE +.PP +\fB\-n\fR, \fB\-\-no\-sync\fR +.RS 4 +Don\*(Aqt sync hard disks/storage media before power\-off, reboot, or halt\&. +.RE +.PP +\fB\-\-no\-wall\fR +.RS 4 +Do not send wall message before power\-off, reboot, or halt\&. +.RE +.SH "EXIT STATUS" +.PP +On success, 0 is returned, a non\-zero failure code otherwise\&. +.SH "NOTES" +.PP +These commands are implemented in a way that preserves basic compatibility with the original SysV commands\&. +\fBsystemctl\fR(1) +verbs +\fBpoweroff\fR, +\fBreboot\fR, +\fBhalt\fR +provide the same functionality with some additional features\&. +.PP +Note that on many SysV systems +\fBhalt\fR +used to be synonymous to +\fBpoweroff\fR, i\&.e\&. both commands would equally result in powering the machine off\&. systemd is more accurate here, and +\fBhalt\fR +results in halting the machine only (leaving power on), and +\fBpoweroff\fR +is required to actually power it off\&. +.SH "SEE ALSO" +.PP +\fBsystemd\fR(1), +\fBsystemctl\fR(1), +\fBshutdown\fR(8), +\fBwall\fR(1) diff --git a/upstream/opensuse-leap-15-6/man8/pppd-radattr.8 b/upstream/opensuse-leap-15-6/man8/pppd-radattr.8 new file mode 100644 index 00000000..22d190bb --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/pppd-radattr.8 @@ -0,0 +1,44 @@ +.\" manual page [] for RADATTR plugin for pppd 2.4 +.\" $Id: pppd-radattr.8,v 1.2 2003/04/25 07:33:20 fcusack Exp $ +.\" SH section heading +.\" SS subsection heading +.\" LP paragraph +.\" IP indented paragraph +.\" TP hanging label +.TH PPPD-RADATTR 8 +.SH NAME +radattr.so \- RADIUS utility plugin for +.BR pppd (8) +.SH SYNOPSIS +.B pppd +[ +.I options +] +plugin radius.so plugin radattr.so +.SH DESCRIPTION +.LP +The radattr plugin for pppd causes all radius attributes returned by +the RADIUS server at authentication time to be stored in the file +.I /var/run/radattr.pppN +where +.I pppN +is the name of the PPP interface. The RADIUS attributes are stored +one per line in the format "Attribute-Name Attribute-Value". This +format is convenient for use in /etc/ppp/ip-up and /etc/ppp/ip-down +scripts. +.LP +Note that you +.I must +load the radius.so plugin before loading the radattr.so plugin; +radattr.so depends on symbols defined in radius.so. + +.SH USAGE +To use the plugin, simply supply the +.B plugin radius.so plugin radattr.so +options to pppd. + +.SH SEE ALSO +.BR pppd (8) " pppd-radius" (8) + +.SH AUTHOR +David F. Skoll <dfs@roaringpenguin.com> diff --git a/upstream/opensuse-leap-15-6/man8/pppd-radius.8 b/upstream/opensuse-leap-15-6/man8/pppd-radius.8 new file mode 100644 index 00000000..a8c103c2 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/pppd-radius.8 @@ -0,0 +1,67 @@ +.\" manual page [] for RADIUS plugin for pppd 2.4 +.\" $Id: pppd-radius.8,v 1.5 2004/03/26 13:27:17 kad Exp $ +.\" SH section heading +.\" SS subsection heading +.\" LP paragraph +.\" IP indented paragraph +.\" TP hanging label +.TH PPPD-RADIUS 8 +.SH NAME +radius.so \- RADIUS authentication plugin for +.BR pppd (8) +.SH SYNOPSIS +.B pppd +[ +.I options +] +plugin radius.so +.SH DESCRIPTION +.LP +The RADIUS plugin for pppd permits pppd to perform PAP, CHAP, MS-CHAP and +MS-CHAPv2 authentication against a RADIUS server instead of the usual +.I /etc/ppp/pap-secrets +and +.I /etc/ppp/chap-secrets +files. +.LP +The RADIUS plugin is built on a library called +.B radiusclient +which has its own configuration files (usually in \fI/etc/radiusclient\fR), +consult those files for more information on configuring the RADIUS +plugin + +.SH OPTIONS +The RADIUS plugin introduces one additional pppd option: +.TP +.BI "radius-config-file " filename +The file +.I filename +is taken as the radiusclient configuration file. If this option is not +used, then the plugin uses +.I /etc/radiusclient/radiusclient.conf +as the configuration file. +.TP +.BI "avpair " attribute=value +Adds an Attribute-Value pair to be passed on to the RADIUS server on each request. +.TP +.BI map-to-ifname +Sets Radius NAS-Port attribute to number equal to interface name (Default) +.TP +.BI map-to-ttyname +Sets Radius NAS-Port attribute value via libradiusclient library + +.SH USAGE +To use the plugin, simply supply the +.B plugin radius.so +option to pppd, and edit +.I /etc/radiusclient/radiusclient.conf +appropriately. If you use the RADIUS plugin, the normal pppd authentication +schemes (login, checking the /etc/ppp/*-secrets files) are skipped. The +RADIUS server should assign an IP address to the peer using the RADIUS +Framed-IP-Address attribute. + +.SH SEE ALSO +.BR pppd (8) " pppd-radattr" (8) + +.SH AUTHOR +David F. Skoll <dfs@roaringpenguin.com> diff --git a/upstream/opensuse-leap-15-6/man8/pppd.8 b/upstream/opensuse-leap-15-6/man8/pppd.8 new file mode 100644 index 00000000..6912ae34 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/pppd.8 @@ -0,0 +1,1989 @@ +.\" manual page [] for pppd 2.4 +.\" $Id: pppd.8,v 1.90 2008/03/26 12:09:40 paulus Exp $ +.\" SH section heading +.\" SS subsection heading +.\" LP paragraph +.\" IP indented paragraph +.\" TP hanging label +.\" +.\" Copyright (c) 1993-2003 Paul Mackerras <paulus@samba.org> +.\" +.\" Permission to use, copy, modify, and distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.TH PPPD 8 +.SH NAME +pppd \- Point-to-Point Protocol Daemon +.SH SYNOPSIS +.B pppd +[ +.I options +] +.SH DESCRIPTION +.LP +PPP is the protocol used for establishing internet links over dial-up +modems, DSL connections, and many other types of point-to-point +links. The \fIpppd\fR daemon works together with the kernel PPP +driver to establish and maintain a PPP link with another system +(called the \fIpeer\fR) and to negotiate Internet Protocol (IP) +addresses for each end of the link. Pppd can also authenticate the +peer and/or supply authentication information to the peer. PPP can be +used with other network protocols besides IP, but such use is becoming +increasingly rare. +.SH FREQUENTLY USED OPTIONS +.TP +.I ttyname +Use the serial port called \fIttyname\fR to communicate with the +peer. If \fIttyname\fR does not begin with a slash (/), +the string "/dev/" is prepended to \fIttyname\fR to form the +name of the device to open. If no device name is given, or if the +name of the terminal +connected to the standard input is given, pppd will use that terminal, +and will not fork to put itself in the background. A value for this +option from a privileged source cannot be overridden by a +non-privileged user. +.TP +.I speed +An option that is a decimal number is taken as the desired baud rate +for the serial device. On systems such as +4.4BSD and NetBSD, any speed can be specified. Other systems +(e.g. Linux, SunOS) only support the commonly-used baud rates. +.TP +.B asyncmap \fImap +This option sets the Async-Control-Character-Map (ACCM) for this end +of the link. The ACCM is a set of 32 bits, one for each of the +ASCII control characters with values from 0 to 31, where a 1 bit +indicates that the corresponding control character should not be used +in PPP packets sent to this system. The map is encoded as a +hexadecimal number (without a leading 0x) where the least significant +bit (00000001) represents character 0 and the most significant bit +(80000000) represents character 31. +Pppd will ask the peer to send these characters as a 2-byte +escape sequence. +If multiple \fIasyncmap\fR options are given, the values are ORed +together. If no \fIasyncmap\fR option is given, the default is zero, +so pppd will ask the peer not to escape any control characters. +To escape transmitted characters, use the \fIescape\fR option. +.TP +.B auth +Require the peer to authenticate itself before allowing network +packets to be sent or received. This option is the default if the +system has a default route. If neither this option nor the +\fInoauth\fR option is specified, pppd will only allow the peer to use +IP addresses to which the system does not already have a route. +.TP +.B call \fIname +Read additional options from the file /etc/ppp/peers/\fIname\fR. This +file may contain privileged options, such as \fInoauth\fR, even if pppd +is not being run by root. The \fIname\fR string may not begin with / +or include .. as a pathname component. The format of the options file +is described below. +.TP +.B connect \fIscript +Usually there is something which needs to be done to prepare the link +before the PPP protocol can be started; for instance, with a dial-up +modem, commands need to be sent to the modem to dial the appropriate +phone number. This option specifies an command for pppd to execute +(by passing it to a shell) before attempting to start PPP negotiation. +The chat (8) program is often useful here, as it provides a way to +send arbitrary strings to a modem and respond to received characters. +A value +for this option from a privileged source cannot be overridden by a +non-privileged user. +.TP +.B crtscts +Specifies that pppd should set the serial port to use hardware flow +control using the RTS and CTS signals in the RS-232 interface. +If neither the \fIcrtscts\fR, the +\fInocrtscts\fR, the \fIcdtrcts\fR nor the \fInocdtrcts\fR option +is given, the hardware flow control setting for the serial port is +left unchanged. +Some serial ports (such as Macintosh serial ports) lack a true +RTS output. Such serial ports use this mode to implement +unidirectional flow control. The serial port will +suspend transmission when requested by the modem (via CTS) +but will be unable to request the modem to stop sending to the +computer. This mode retains the ability to use DTR as +a modem control line. +.TP +.B defaultroute +Add a default route to the system routing tables, using the peer as +the gateway, when IPCP negotiation is successfully completed. +This entry is removed when the PPP connection is broken. This option +is privileged if the \fInodefaultroute\fR option has been specified. +.TP +.B replacedefaultroute +This option is a flag to the defaultroute option. If defaultroute is +set and this flag is also set, pppd replaces an existing default route +with the new default route. + + +.TP +.B disconnect \fIscript +Execute the command specified by \fIscript\fR, by passing it to a +shell, after +pppd has terminated the link. This command could, for example, issue +commands to the modem to cause it to hang up if hardware modem control +signals were not available. The disconnect script is not run if the +modem has already hung up. A value for this option from a privileged +source cannot be overridden by a non-privileged user. +.TP +.B escape \fIxx,yy,... +Specifies that certain characters should be escaped on transmission +(regardless of whether the peer requests them to be escaped with its +async control character map). The characters to be escaped are +specified as a list of hex numbers separated by commas. Note that +almost any character can be specified for the \fIescape\fR option, +unlike the \fIasyncmap\fR option which only allows control characters +to be specified. The characters which may not be escaped are those +with hex values 0x20 - 0x3f or 0x5e. +.TP +.B file \fIname +Read options from file \fIname\fR (the format is described below). +The file must be readable by the user who has invoked pppd. +.TP +.B init \fIscript +Execute the command specified by \fIscript\fR, by passing it to a shell, to +initialize the serial line. This script would typically use the +chat(8) program to configure the modem to enable auto answer. A value +for this option from a privileged source cannot be overridden by a +non-privileged user. +.TP +.B lock +Specifies that pppd should create a UUCP-style lock file for the +serial device to ensure exclusive access to the device. By default, +pppd will not create a lock file. +.TP +.B mru \fIn +Set the MRU [Maximum Receive Unit] value to \fIn\fR. Pppd +will ask the peer to send packets of no more than \fIn\fR bytes. +The value of \fIn\fR must be between 128 and 16384; the default is 1500. +A value of +296 works well on very slow links (40 bytes for TCP/IP header + 256 +bytes of data). +Note that for the IPv6 protocol, the MRU must be at least 1280. +.TP +.B mtu \fIn +Set the MTU [Maximum Transmit Unit] value to \fIn\fR. Unless the +peer requests a smaller value via MRU negotiation, pppd will +request that the kernel networking code send data packets of no more +than \fIn\fR bytes through the PPP network interface. Note that for +the IPv6 protocol, the MTU must be at least 1280. +.TP +.B passive +Enables the "passive" option in the LCP. With this option, pppd will +attempt to initiate a connection; if no reply is received from the +peer, pppd will then just wait passively for a valid LCP packet from +the peer, instead of exiting, as it would without this option. +.SH OPTIONS +.TP +.I <local_IP_address>\fB:\fI<remote_IP_address> +Set the local and/or remote interface IP addresses. Either one may be +omitted. The IP addresses can be specified with a host name or in +decimal dot notation (e.g. 150.234.56.78). The default local +address is the (first) IP address of the system (unless the +\fInoipdefault\fR +option is given). The remote address will be obtained from the peer +if not specified in any option. Thus, in simple cases, this option is +not required. If a local and/or remote IP address is specified with +this option, pppd +will not accept a different value from the peer in the IPCP +negotiation, unless the \fIipcp\-accept\-local\fR and/or +\fIipcp\-accept\-remote\fR options are given, respectively. +.TP +.B +ipv6 +Enable the IPv6CP and IPv6 protocols. +.TP +.B ipv6 \fI<local_interface_identifier>\fR,\fI<remote_interface_identifier> +Set the local and/or remote 64-bit interface identifier. Either one may be +omitted. The identifier must be specified in standard ASCII notation of +IPv6 addresses (e.g. ::dead:beef). If the +\fIipv6cp\-use\-ipaddr\fR +option is given, the local identifier is the local IPv4 address (see above). +On systems which supports a unique persistent id, such as EUI\-48 derived +from the Ethernet MAC address, \fIipv6cp\-use\-persistent\fR option can be +used to replace the \fIipv6 <local>,<remote>\fR option. Otherwise the +identifier is randomized. +.TP +.B active\-filter \fIfilter\-expression +Specifies a packet filter to be applied to data packets to determine +which packets are to be regarded as link activity, and therefore reset +the idle timer, or cause the link to be brought up in demand-dialling +mode. This option is useful in conjunction with the +\fBidle\fR option if there are packets being sent or received +regularly over the link (for example, routing information packets) +which would otherwise prevent the link from ever appearing to be idle. +The \fIfilter\-expression\fR syntax is as described for tcpdump(1), +except that qualifiers which are inappropriate for a PPP link, such as +\fBether\fR and \fBarp\fR, are not permitted. Generally the filter +expression should be enclosed in single-quotes to prevent whitespace +in the expression from being interpreted by the shell. This option +is currently only available under Linux, and requires that the kernel +was configured to include PPP filtering support (CONFIG_PPP_FILTER). +Note that it +is possible to apply different constraints to incoming and outgoing +packets using the \fBinbound\fR and \fBoutbound\fR qualifiers. +.TP +.B allow\-ip \fIaddress(es) +Allow peers to use the given IP address or subnet without +authenticating themselves. The parameter is parsed as for each +element of the list of allowed IP addresses in the secrets files (see +the AUTHENTICATION section below). +.TP +.B allow\-number \fInumber +Allow peers to connect from the given telephone number. A trailing +`*' character will match all numbers beginning with the leading part. +.TP +.B bsdcomp \fInr,nt +Request that the peer compress packets that it sends, using the +BSD-Compress scheme, with a maximum code size of \fInr\fR bits, and +agree to compress packets sent to the peer with a maximum code size of +\fInt\fR bits. If \fInt\fR is not specified, it defaults to the value +given for \fInr\fR. Values in the range 9 to 15 may be used for +\fInr\fR and \fInt\fR; larger values give better compression but +consume more kernel memory for compression dictionaries. +Alternatively, a value of 0 for \fInr\fR or \fInt\fR disables +compression in the corresponding direction. Use \fInobsdcomp\fR or +\fIbsdcomp 0\fR to disable BSD-Compress compression entirely. +.TP +.B cdtrcts +Use a non-standard hardware flow control (i.e. DTR/CTS) to control +the flow of data on the serial port. If neither the \fIcrtscts\fR, +the \fInocrtscts\fR, the \fIcdtrcts\fR nor the \fInocdtrcts\fR +option is given, the hardware flow control setting for the serial +port is left unchanged. +Some serial ports (such as Macintosh serial ports) lack a true +RTS output. Such serial ports use this mode to implement true +bi-directional flow control. The sacrifice is that this flow +control mode does not permit using DTR as a modem control line. +.TP +.B chap\-interval \fIn +If this option is given, pppd will rechallenge the peer every \fIn\fR +seconds. +.TP +.B chap\-max\-challenge \fIn +Set the maximum number of CHAP challenge transmissions to \fIn\fR +(default 10). +.TP +.B chap\-restart \fIn +Set the CHAP restart interval (retransmission timeout for challenges) +to \fIn\fR seconds (default 3). +.TP +.B child\-timeout \fIn +When exiting, wait for up to \fIn\fR seconds for any child processes +(such as the command specified with the \fBpty\fR command) to exit +before exiting. At the end of the timeout, pppd will send a SIGTERM +signal to any remaining child processes and exit. A value of 0 means +no timeout, that is, pppd will wait until all child processes have +exited. +.TP +.B connect\-delay \fIn +Wait for up to \fIn\fR milliseconds after the connect script finishes for +a valid PPP packet from the peer. At the end of this time, or when a +valid PPP packet is received from the peer, pppd will commence +negotiation by sending its first LCP packet. The default value is +1000 (1 second). This wait period only applies if the \fBconnect\fR +or \fBpty\fR option is used. +.TP +.B debug +Enables connection debugging facilities. +If this option is given, pppd will log the contents of all +control packets sent or received in a readable form. The packets are +logged through syslog with facility \fIdaemon\fR and level +\fIdebug\fR. This information can be directed to a file by setting up +/etc/syslog.conf appropriately (see syslog.conf(5)). +.TP +.B default\-asyncmap +Disable asyncmap negotiation, forcing all control characters to be +escaped for both the transmit and the receive direction. +.TP +.B default\-mru +Disable MRU [Maximum Receive Unit] negotiation. With this option, +pppd will use the default MRU value of 1500 bytes for both the +transmit and receive direction. +.TP +.B deflate \fInr,nt +Request that the peer compress packets that it sends, using the +Deflate scheme, with a maximum window size of \fI2**nr\fR bytes, and +agree to compress packets sent to the peer with a maximum window size +of \fI2**nt\fR bytes. If \fInt\fR is not specified, it defaults to +the value given for \fInr\fR. Values in the range 9 to 15 may be used +for \fInr\fR and \fInt\fR; larger values give better compression but +consume more kernel memory for compression dictionaries. +Alternatively, a value of 0 for \fInr\fR or \fInt\fR disables +compression in the corresponding direction. Use \fInodeflate\fR or +\fIdeflate 0\fR to disable Deflate compression entirely. (Note: pppd +requests Deflate compression in preference to BSD-Compress if the peer +can do either.) +.TP +.B demand +Initiate the link only on demand, i.e. when data traffic is present. +With this option, the remote IP address may be specified by the user +on the command line or in an options file, or if not, pppd will use +an arbitrary address in the 10.x.x.x range. Pppd will initially +configure the interface and enable it for IP traffic without +connecting to the peer. When traffic is available, pppd will +connect to the peer and perform negotiation, authentication, etc. +When this is completed, pppd will commence passing data packets +(i.e., IP packets) across the link. + +The \fIdemand\fR option implies the \fIpersist\fR option. If this +behaviour is not desired, use the \fInopersist\fR option after the +\fIdemand\fR option. The \fIidle\fR and \fIholdoff\fR +options are also useful in conjunction with the \fIdemand\fR option. +.TP +.B domain \fId +Append the domain name \fId\fR to the local host name for authentication +purposes. For example, if gethostname() returns the name porsche, but +the fully qualified domain name is porsche.Quotron.COM, you could +specify \fIdomain Quotron.COM\fR. Pppd would then use the name +\fIporsche.Quotron.COM\fR for looking up secrets in the secrets file, +and as the default name to send to the peer when authenticating itself +to the peer. This option is privileged. +.TP +.B dryrun +With the \fBdryrun\fR option, pppd will print out all the option +values which have been set and then exit, after parsing the command +line and options files and checking the option values, but before +initiating the link. The option values are logged at level info, and +also printed to standard output unless the device on standard output +is the device that pppd would be using to communicate with the peer. +.TP +.B dump +With the \fBdump\fR option, pppd will print out all the option values +which have been set. This option is like the \fBdryrun\fR option +except that pppd proceeds as normal rather than exiting. +.TP +.B enable-session +Enables session accounting via PAM or wtwp/wtmpx, as appropriate. +When PAM is enabled, the PAM "account" and "session" module stacks +determine behavior, and are enabled for all PPP authentication +protocols. When PAM is disabled, wtmp/wtmpx entries are recorded +regardless of whether the peer name identifies a valid user on the +local system, making peers visible in the last(1) log. This feature +is automatically enabled when the pppd \fBlogin\fR option is used. +Session accounting is disabled by default. +.TP +.B endpoint \fI<epdisc> +Sets the endpoint discriminator sent by the local machine to the peer +during multilink negotiation to \fI<epdisc>\fR. The default is to use +the MAC address of the first ethernet interface on the system, if any, +otherwise the IPv4 address corresponding to the hostname, if any, +provided it is not in the multicast or locally-assigned IP address +ranges, or the localhost address. The endpoint discriminator can be +the string \fBnull\fR or of the form \fItype\fR:\fIvalue\fR, where +type is a decimal number or one of the strings \fBlocal\fR, \fBIP\fR, +\fBMAC\fR, \fBmagic\fR, or \fBphone\fR. The value is an IP address in +dotted-decimal notation for the \fBIP\fR type, or a string of bytes in +hexadecimal, separated by periods or colons for the other types. For +the MAC type, the value may also be the name of an ethernet or similar +network interface. This option is currently only available under +Linux. +.TP +.B eap\-interval \fIn +If this option is given and pppd authenticates the peer with EAP +(i.e., is the server), pppd will restart EAP authentication every +\fIn\fR seconds. For EAP SRP\-SHA1, see also the \fBsrp\-interval\fR +option, which enables lightweight rechallenge. +.TP +.B eap\-max\-rreq \fIn +Set the maximum number of EAP Requests to which pppd will respond (as +a client) without hearing EAP Success or Failure. (Default is 20.) +.TP +.B eap\-max\-sreq \fIn +Set the maximum number of EAP Requests that pppd will issue (as a +server) while attempting authentication. (Default is 10.) +.TP +.B eap\-restart \fIn +Set the retransmit timeout for EAP Requests when acting as a server +(authenticator). (Default is 3 seconds.) +.TP +.B eap\-timeout \fIn +Set the maximum time to wait for the peer to send an EAP Request when +acting as a client (authenticatee). (Default is 20 seconds.) +.TP +.B hide\-password +When logging the contents of PAP packets, this option causes pppd to +exclude the password string from the log. This is the default. +.TP +.B holdoff \fIn +Specifies how many seconds to wait before re-initiating the link after +it terminates. This option only has any effect if the \fIpersist\fR +or \fIdemand\fR option is used. The holdoff period is not applied if +the link was terminated because it was idle. +.TP +.B idle \fIn +Specifies that pppd should disconnect if the link is idle for \fIn\fR +seconds. The link is idle when no data packets (i.e. IP packets) are +being sent or received. Note: it is not advisable to use this option +with the \fIpersist\fR option without the \fIdemand\fR option. +If the \fBactive\-filter\fR +option is given, data packets which are rejected by the specified +activity filter also count as the link being idle. +.TP +.B ipcp\-accept\-local +With this option, pppd will accept the peer's idea of our local IP +address, even if the local IP address was specified in an option. +.TP +.B ipcp\-accept\-remote +With this option, pppd will accept the peer's idea of its (remote) IP +address, even if the remote IP address was specified in an option. +.TP +.B ipcp\-max\-configure \fIn +Set the maximum number of IPCP configure-request transmissions to +\fIn\fR (default 10). +.TP +.B ipcp\-max\-failure \fIn +Set the maximum number of IPCP configure-NAKs returned before starting +to send configure-Rejects instead to \fIn\fR (default 10). +.TP +.B ipcp\-max\-terminate \fIn +Set the maximum number of IPCP terminate-request transmissions to +\fIn\fR (default 3). +.TP +.B ipcp\-restart \fIn +Set the IPCP restart interval (retransmission timeout) to \fIn\fR +seconds (default 3). +.TP +.B ipparam \fIstring +Provides an extra parameter to the ip\-up, ip\-pre\-up and ip\-down +scripts. If this +option is given, the \fIstring\fR supplied is given as the 6th +parameter to those scripts. +.TP +.B ipv6cp\-accept\-local +With this option, pppd will accept the peer's idea of our local IPv6 +interface identifier, even if the local IPv6 interface identifier +was specified in an option. +.TP +.B ipv6cp\-max\-configure \fIn +Set the maximum number of IPv6CP configure-request transmissions to +\fIn\fR (default 10). +.TP +.B ipv6cp\-max\-failure \fIn +Set the maximum number of IPv6CP configure-NAKs returned before starting +to send configure-Rejects instead to \fIn\fR (default 10). +.TP +.B ipv6cp\-max\-terminate \fIn +Set the maximum number of IPv6CP terminate-request transmissions to +\fIn\fR (default 3). +.TP +.B ipv6cp\-restart \fIn +Set the IPv6CP restart interval (retransmission timeout) to \fIn\fR +seconds (default 3). +.TP +.B ipx +Enable the IPXCP and IPX protocols. This option is presently only +supported under Linux, and only if your kernel has been configured to +include IPX support. +.TP +.B ipx\-network \fIn +Set the IPX network number in the IPXCP configure request frame to +\fIn\fR, a hexadecimal number (without a leading 0x). There is no +valid default. If this option is not specified, the network number is +obtained from the peer. If the peer does not have the network number, +the IPX protocol will not be started. +.TP +.B ipx\-node \fIn\fB:\fIm +Set the IPX node numbers. The two node numbers are separated from each +other with a colon character. The first number \fIn\fR is the local +node number. The second number \fIm\fR is the peer's node number. Each +node number is a hexadecimal number, at most 10 digits long. The node +numbers on the ipx\-network must be unique. There is no valid +default. If this option is not specified then the node numbers are +obtained from the peer. +.TP +.B ipx\-router\-name \fI<string> +Set the name of the router. This is a string and is sent to the peer +as information data. +.TP +.B ipx\-routing \fIn +Set the routing protocol to be received by this option. More than one +instance of \fIipx\-routing\fR may be specified. The '\fInone\fR' +option (0) may be specified as the only instance of ipx\-routing. The +values may be \fI0\fR for \fINONE\fR, \fI2\fR for \fIRIP/SAP\fR, and +\fI4\fR for \fINLSP\fR. +.TP +.B ipxcp\-accept\-local +Accept the peer's NAK for the node number specified in the ipx\-node +option. If a node number was specified, and non-zero, the default is +to insist that the value be used. If you include this option then you +will permit the peer to override the entry of the node number. +.TP +.B ipxcp\-accept\-network +Accept the peer's NAK for the network number specified in the +ipx\-network option. If a network number was specified, and non-zero, the +default is to insist that the value be used. If you include this +option then you will permit the peer to override the entry of the node +number. +.TP +.B ipxcp\-accept\-remote +Use the peer's network number specified in the configure request +frame. If a node number was specified for the peer and this option was +not specified, the peer will be forced to use the value which you have +specified. +.TP +.B ipxcp\-max\-configure \fIn +Set the maximum number of IPXCP configure request frames which the +system will send to \fIn\fR. The default is 10. +.TP +.B ipxcp\-max\-failure \fIn +Set the maximum number of IPXCP NAK frames which the local system will +send before it rejects the options. The default value is 3. +.TP +.B ipxcp\-max\-terminate \fIn +Set the maximum number of IPXCP terminate request frames before the +local system considers that the peer is not listening to them. The +default value is 3. +.TP +.B kdebug \fIn +Enable debugging code in the kernel-level PPP driver. The argument +values depend on the specific kernel driver, but in general a value of +1 will enable general kernel debug messages. (Note that these +messages are usually only useful for debugging the kernel driver +itself.) For the Linux 2.2.x kernel driver, the value is a sum of +bits: 1 to +enable general debug messages, 2 to request that the contents of +received packets be printed, and 4 to request that the contents of +transmitted packets be printed. On most systems, messages printed by +the kernel are logged by syslog(1) to a file as directed in the +/etc/syslog.conf configuration file. +.TP +.B ktune +Enables pppd to alter kernel settings as appropriate. Under Linux, +pppd will enable IP forwarding (i.e. set /proc/sys/net/ipv4/ip_forward +to 1) if the \fIproxyarp\fR option is used, and will enable the +dynamic IP address option (i.e. set /proc/sys/net/ipv4/ip_dynaddr to +1) in demand mode if the local address changes. +.TP +.B lcp\-echo\-failure \fIn +If this option is given, pppd will presume the peer to be dead +if \fIn\fR LCP echo\-requests are sent without receiving a valid LCP +echo\-reply. If this happens, pppd will terminate the +connection. Use of this option requires a non-zero value for the +\fIlcp\-echo\-interval\fR parameter. This option can be used to enable +pppd to terminate after the physical connection has been broken +(e.g., the modem has hung up) in situations where no hardware modem +control lines are available. +.TP +.B lcp\-echo\-interval \fIn +If this option is given, pppd will send an LCP echo\-request frame to +the peer every \fIn\fR seconds. Normally the peer should respond to +the echo\-request by sending an echo\-reply. This option can be used +with the \fIlcp\-echo\-failure\fR option to detect that the peer is no +longer connected. +.TP +.B lcp\-max\-configure \fIn +Set the maximum number of LCP configure-request transmissions to +\fIn\fR (default 10). +.TP +.B lcp\-max\-failure \fIn +Set the maximum number of LCP configure-NAKs returned before starting +to send configure-Rejects instead to \fIn\fR (default 10). +.TP +.B lcp\-max\-terminate \fIn +Set the maximum number of LCP terminate-request transmissions to +\fIn\fR (default 3). +.TP +.B lcp\-restart \fIn +Set the LCP restart interval (retransmission timeout) to \fIn\fR +seconds (default 3). +.TP +.B linkname \fIname\fR +Sets the logical name of the link to \fIname\fR. Pppd will create a +file named \fBppp\-\fIname\fB.pid\fR in /var/run (or /etc/ppp on some +systems) containing its process ID. This can be useful in determining +which instance of pppd is responsible for the link to a given peer +system. This is a privileged option. +.TP +.B local +Don't use the modem control lines. With this option, pppd will ignore +the state of the CD (Carrier Detect) signal from the modem and will +not change the state of the DTR (Data Terminal Ready) signal. This is +the opposite of the \fBmodem\fR option. +.TP +.B logfd \fIn +Send log messages to file descriptor \fIn\fR. Pppd will send log +messages to at most one file or file descriptor (as well as sending +the log messages to syslog), so this option and the \fBlogfile\fR +option are mutually exclusive. The default is for pppd to send log +messages to stdout (file descriptor 1), unless the serial port is +already open on stdout. +.TP +.B logfile \fIfilename +Append log messages to the file \fIfilename\fR (as well as sending the +log messages to syslog). The file is opened with the privileges of +the user who invoked pppd, in append mode. +.TP +.B login +Use the system password database for authenticating the peer using +PAP, and record the user in the system wtmp file. Note that the peer +must have an entry in the /etc/ppp/pap\-secrets file as well as the +system password database to be allowed access. See also the +\fBenable\-session\fR option. +.TP +.B master_detach +If multilink is enabled and this pppd process is the multilink bundle +master, and the link controlled by this pppd process terminates, this +pppd process continues to run in order to maintain the bundle. If the +\fBmaster_detach\fR option has been given, pppd will detach from its +controlling terminal in this situation, even if the \fBnodetach\fR +option has been given. +.TP +.B maxconnect \fIn +Terminate the connection when it has been available for network +traffic for \fIn\fR seconds (i.e. \fIn\fR seconds after the first +network control protocol comes up). +.TP +.B maxfail \fIn +Terminate after \fIn\fR consecutive failed connection attempts. A +value of 0 means no limit. The default value is 10. +.TP +.B modem +Use the modem control lines. This option is the default. With this +option, pppd will wait for the CD (Carrier Detect) signal from the +modem to be asserted when opening the serial device (unless a connect +script is specified), and it will drop the DTR (Data Terminal Ready) +signal briefly when the connection is terminated and before executing +the connect script. On Ultrix, this option implies hardware flow +control, as for the \fIcrtscts\fR option. This is the opposite of the +\fBlocal\fR option. +.TP +.B mp +Enables the use of PPP multilink; this is an alias for the `multilink' +option. This option is currently only available under Linux. +.TP +.B mppe\-stateful +Allow MPPE to use stateful mode. Stateless mode is still attempted first. +The default is to disallow stateful mode. +.TP +.B mpshortseq +Enables the use of short (12-bit) sequence numbers in multilink +headers, as opposed to 24-bit sequence numbers. This option is only +available under Linux, and only has any effect if multilink is +enabled (see the multilink option). +.TP +.B mrru \fIn +Sets the Maximum Reconstructed Receive Unit to \fIn\fR. The MRRU is +the maximum size for a received packet on a multilink bundle, and is +analogous to the MRU for the individual links. This option is +currently only available under Linux, and only has any effect if +multilink is enabled (see the multilink option). +.TP +.B ms\-dns \fI<addr> +If pppd is acting as a server for Microsoft Windows clients, this +option allows pppd to supply one or two DNS (Domain Name Server) +addresses to the clients. The first instance of this option specifies +the primary DNS address; the second instance (if given) specifies the +secondary DNS address. (This option was present in some older +versions of pppd under the name \fBdns\-addr\fR.) +.TP +.B ms\-wins \fI<addr> +If pppd is acting as a server for Microsoft Windows or "Samba" +clients, this option allows pppd to supply one or two WINS (Windows +Internet Name Services) server addresses to the clients. The first +instance of this option specifies the primary WINS address; the second +instance (if given) specifies the secondary WINS address. +.TP +.B multilink +Enables the use of the PPP multilink protocol. If the peer also +supports multilink, then this link can become part of a bundle between +the local system and the peer. If there is an existing bundle to the +peer, pppd will join this link to that bundle, otherwise pppd will +create a new bundle. See the MULTILINK section below. This option is +currently only available under Linux. +.TP +.B name \fIname +Set the name of the local system for authentication purposes to +\fIname\fR. This is a privileged option. With this option, pppd will +use lines in the secrets files which have \fIname\fR as the second +field when looking for a secret to use in authenticating the peer. In +addition, unless overridden with the \fIuser\fR option, \fIname\fR +will be used as the name to send to the peer when authenticating the +local system to the peer. (Note that pppd does not append the domain +name to \fIname\fR.) +.TP +.B noaccomp +Disable Address/Control compression in both directions (send and +receive). +.TP +.B noauth +Do not require the peer to authenticate itself. This option is +privileged. +.TP +.B nobsdcomp +Disables BSD-Compress compression; \fBpppd\fR will not request or +agree to compress packets using the BSD-Compress scheme. +.TP +.B noccp +Disable CCP (Compression Control Protocol) negotiation. This option +should only be required if the peer is buggy and gets confused by +requests from pppd for CCP negotiation. +.TP +.B nocrtscts +Disable hardware flow control (i.e. RTS/CTS) on the serial port. +If neither the \fIcrtscts\fR nor the \fInocrtscts\fR nor the +\fIcdtrcts\fR nor the \fInocdtrcts\fR option is given, the hardware +flow control setting for the serial port is left unchanged. +.TP +.B nocdtrcts +This option is a synonym for \fInocrtscts\fR. Either of these options will +disable both forms of hardware flow control. +.TP +.B nodefaultroute +Disable the \fIdefaultroute\fR option. The system administrator who +wishes to prevent users from adding a default route with pppd +can do so by placing this option in the /etc/ppp/options file. +.TP +.B noreplacedefaultroute +Disable the \fIreplacedefaultroute\fR option. The system administrator who +wishes to prevent users from replacing a default route with pppd +can do so by placing this option in the /etc/ppp/options file. +.TP +.B nodeflate +Disables Deflate compression; pppd will not request or agree to +compress packets using the Deflate scheme. +.TP +.B nodetach +Don't detach from the controlling terminal. Without this option, if a +serial device other than the terminal on the standard input is +specified, pppd will fork to become a background process. +.TP +.B noendpoint +Disables pppd from sending an endpoint discriminator to the peer or +accepting one from the peer (see the MULTILINK section below). This +option should only be required if the peer is buggy. +.TP +.B noip +Disable IPCP negotiation and IP communication. This option should +only be required if the peer is buggy and gets confused by requests +from pppd for IPCP negotiation. +.TP +.B noipv6 +Disable IPv6CP negotiation and IPv6 communication. This option should +only be required if the peer is buggy and gets confused by requests +from pppd for IPv6CP negotiation. +.TP +.B noipdefault +Disables the default behaviour when no local IP address is specified, +which is to determine (if possible) the local IP address from the +hostname. With this option, the peer will have to supply the local IP +address during IPCP negotiation (unless it specified explicitly on the +command line or in an options file). +.TP +.B noipx +Disable the IPXCP and IPX protocols. This option should only be +required if the peer is buggy and gets confused by requests from pppd +for IPXCP negotiation. +.TP +.B noktune +Opposite of the \fIktune\fR option; disables pppd from changing system +settings. +.TP +.B nolock +Opposite of the \fIlock\fR option; specifies that pppd should not +create a UUCP-style lock file for the serial device. This option is +privileged. +.TP +.B nolog +Do not send log messages to a file or file descriptor. This option +cancels the \fBlogfd\fR and \fBlogfile\fR options. +.TP +.B nomagic +Disable magic number negotiation. With this option, pppd cannot +detect a looped-back line. This option should only be needed if the +peer is buggy. +.TP +.B nomp +Disables the use of PPP multilink. This option is currently only +available under Linux. +.TP +.B nomppe +Disables MPPE (Microsoft Point to Point Encryption). This is the default. +.TP +.B nomppe\-40 +Disable 40-bit encryption with MPPE. +.TP +.B nomppe\-128 +Disable 128-bit encryption with MPPE. +.TP +.B nomppe\-stateful +Disable MPPE stateful mode. This is the default. +.TP +.B nompshortseq +Disables the use of short (12-bit) sequence numbers in the PPP +multilink protocol, forcing the use of 24-bit sequence numbers. This +option is currently only available under Linux, and only has any +effect if multilink is enabled. +.TP +.B nomultilink +Disables the use of PPP multilink. This option is currently only +available under Linux. +.TP +.B nopcomp +Disable protocol field compression negotiation in both the receive and +the transmit direction. +.TP +.B nopersist +Exit once a connection has been made and terminated. This is the +default unless the \fIpersist\fR or \fIdemand\fR option has been +specified. +.TP +.B nopredictor1 +Do not accept or agree to Predictor\-1 compression. +.TP +.B noproxyarp +Disable the \fIproxyarp\fR option. The system administrator who +wishes to prevent users from creating proxy ARP entries with pppd can +do so by placing this option in the /etc/ppp/options file. +.TP +.B noremoteip +Allow pppd to operate without having an IP address for the peer. This +option is only available under Linux. Normally, pppd will request the +peer's IP address, and if the peer does not supply it, pppd will use +an arbitrary address in the 10.x.x.x subnet. +With this option, if the peer does +not supply its IP address, pppd will not ask the peer for it, and will +not set the destination address of the ppp interface. In this +situation, the ppp interface can be used for routing by creating +device routes, but the peer itself cannot be addressed directly for IP +traffic. +.TP +.B notty +Normally, pppd requires a terminal device. With this option, pppd +will allocate itself a pseudo-tty master/slave pair and use the slave +as its terminal device. Pppd will create a child process to act as a +`character shunt' to transfer characters between the pseudo-tty master +and its standard input and output. Thus pppd will transmit characters +on its standard output and receive characters on its standard input +even if they are not terminal devices. This option increases the +latency and CPU overhead of transferring data over the ppp interface +as all of the characters sent and received must flow through the +character shunt process. An explicit device name may not be given if +this option is used. +.TP +.B novj +Disable Van Jacobson style TCP/IP header compression in both the +transmit and the receive direction. +.TP +.B novjccomp +Disable the connection-ID compression option in Van Jacobson style +TCP/IP header compression. With this option, pppd will not omit the +connection-ID byte from Van Jacobson compressed TCP/IP headers, nor +ask the peer to do so. +.TP +.B papcrypt +Indicates that all secrets in the /etc/ppp/pap\-secrets file which are +used for checking the identity of the peer are encrypted, and thus +pppd should not accept a password which, before encryption, is +identical to the secret from the /etc/ppp/pap\-secrets file. +.TP +.B pap\-max\-authreq \fIn +Set the maximum number of PAP authenticate-request transmissions to +\fIn\fR (default 10). +.TP +.B pap\-restart \fIn +Set the PAP restart interval (retransmission timeout) to \fIn\fR +seconds (default 3). +.TP +.B pap\-timeout \fIn +Set the maximum time that pppd will wait for the peer to authenticate +itself with PAP to \fIn\fR seconds (0 means no limit). +.TP +.B pass\-filter \fIfilter\-expression +Specifies a packet filter to applied to data packets being sent or +received to determine which packets should be allowed to pass. +Packets which are rejected by the filter are silently discarded. This +option can be used to prevent specific network daemons (such as +routed) using up link bandwidth, or to provide a very basic firewall +capability. +The \fIfilter\-expression\fR syntax is as described for tcpdump(1), +except that qualifiers which are inappropriate for a PPP link, such as +\fBether\fR and \fBarp\fR, are not permitted. Generally the filter +expression should be enclosed in single-quotes to prevent whitespace +in the expression from being interpreted by the shell. Note that it +is possible to apply different constraints to incoming and outgoing +packets using the \fBinbound\fR and \fBoutbound\fR qualifiers. This +option is currently only available under Linux, and requires that the +kernel was configured to include PPP filtering support (CONFIG_PPP_FILTER). +.TP +.B password \fIpassword\-string +Specifies the password to use for authenticating to the peer. Use +of this option is discouraged, as the password is likely to be visible +to other users on the system (for example, by using ps(1)). +.TP +.B persist +Do not exit after a connection is terminated; instead try to reopen +the connection. The \fBmaxfail\fR option still has an effect on +persistent connections. +.TP +.B plugin \fIfilename +Load the shared library object file \fIfilename\fR as a plugin. This +is a privileged option. If \fIfilename\fR does not contain a slash +(/), pppd will look in the \fB/usr/lib64/pppd/\fIversion\fR directory +for the plugin, where +\fIversion\fR is the version number of pppd (for example, 2.4.2). +.TP +.B predictor1 +Request that the peer compress frames that it sends using Predictor-1 +compression, and agree to compress transmitted frames with Predictor-1 +if requested. This option has no effect unless the kernel driver +supports Predictor-1 compression. +.TP +.B privgroup \fIgroup\-name +Allows members of group \fIgroup\-name\fR to use privileged options. +This is a privileged option. Use of this option requires care as +there is no guarantee that members of \fIgroup\-name\fR cannot use pppd +to become root themselves. Consider it equivalent to putting the +members of \fIgroup\-name\fR in the kmem or disk group. +.TP +.B proxyarp +Add an entry to this system's ARP [Address Resolution Protocol] table +with the IP address of the peer and the Ethernet address of this +system. This will have the effect of making the peer appear to other +systems to be on the local ethernet. +.TP +.B pty \fIscript +Specifies that the command \fIscript\fR is to be used to communicate +rather than a specific terminal device. Pppd will allocate itself a +pseudo-tty master/slave pair and use the slave as its terminal +device. The \fIscript\fR will be run in a child process with the +pseudo-tty master as its standard input and output. An explicit +device name may not be given if this option is used. (Note: if the +\fIrecord\fR option is used in conjunction with the \fIpty\fR option, +the child process will have pipes on its standard input and output.) +.TP +.B receive\-all +With this option, pppd will accept all control characters from the +peer, including those marked in the receive asyncmap. Without this +option, pppd will discard those characters as specified in RFC1662. +This option should only be needed if the peer is buggy. +.TP +.B record \fIfilename +Specifies that pppd should record all characters sent and received to +a file named \fIfilename\fR. This file is opened in append mode, +using the user's user-ID and permissions. This option is implemented +using a pseudo-tty and a process to transfer characters between the +pseudo-tty and the real serial device, so it will increase the latency +and CPU overhead of transferring data over the ppp interface. The +characters are stored in a tagged format with timestamps, which can be +displayed in readable form using the pppdump(8) program. +.TP +.B remotename \fIname +Set the assumed name of the remote system for authentication purposes +to \fIname\fR. +.TP +.B remotenumber \fInumber +Set the assumed telephone number of the remote system for authentication +purposes to \fInumber\fR. +.TP +.B refuse\-chap +With this option, pppd will not agree to authenticate itself to the +peer using CHAP. +.TP +.B refuse\-mschap +With this option, pppd will not agree to authenticate itself to the +peer using MS\-CHAP. +.TP +.B refuse\-mschap\-v2 +With this option, pppd will not agree to authenticate itself to the +peer using MS\-CHAPv2. +.TP +.B refuse\-eap +With this option, pppd will not agree to authenticate itself to the +peer using EAP. +.TP +.B refuse\-pap +With this option, pppd will not agree to authenticate itself to the +peer using PAP. +.TP +.B require\-chap +Require the peer to authenticate itself using CHAP [Challenge +Handshake Authentication Protocol] authentication. +.TP +.B require\-mppe +Require the use of MPPE (Microsoft Point to Point Encryption). This +option disables all other compression types. This option enables +both 40-bit and 128-bit encryption. In order for MPPE to successfully +come up, you must have authenticated with either MS\-CHAP or MS\-CHAPv2. +This option is presently only supported under Linux, and only if your +kernel has been configured to include MPPE support. +.TP +.B require\-mppe\-40 +Require the use of MPPE, with 40-bit encryption. +.TP +.B require\-mppe\-128 +Require the use of MPPE, with 128-bit encryption. +.TP +.B require\-mschap +Require the peer to authenticate itself using MS\-CHAP [Microsoft Challenge +Handshake Authentication Protocol] authentication. +.TP +.B require\-mschap\-v2 +Require the peer to authenticate itself using MS\-CHAPv2 [Microsoft Challenge +Handshake Authentication Protocol, Version 2] authentication. +.TP +.B require\-eap +Require the peer to authenticate itself using EAP [Extensible +Authentication Protocol] authentication. +.TP +.B require\-pap +Require the peer to authenticate itself using PAP [Password +Authentication Protocol] authentication. +.TP +.B set \fIname\fR=\fIvalue +Set an environment variable for scripts that are invoked by pppd. +When set by a privileged source, the variable specified by \fIname\fR +cannot be changed by options contained in an unprivileged source. See +also the \fIunset\fR option and the environment described in +\fISCRIPTS\fR. +.TP +.B show\-password +When logging the contents of PAP packets, this option causes pppd to +show the password string in the log message. +.TP +.B silent +With this option, pppd will not transmit LCP packets to initiate a +connection until a valid LCP packet is received from the peer (as for +the `passive' option with ancient versions of pppd). +.TP +.B srp\-interval \fIn +If this parameter is given and pppd uses EAP SRP\-SHA1 to authenticate +the peer (i.e., is the server), then pppd will use the optional +lightweight SRP rechallenge mechanism at intervals of \fIn\fR +seconds. This option is faster than \fBeap\-interval\fR +reauthentication because it uses a hash\-based mechanism and does not +derive a new session key. +.TP +.B srp\-pn\-secret \fIstring +Set the long-term pseudonym-generating secret for the server. This +value is optional and if set, needs to be known at the server +(authenticator) side only, and should be different for each server (or +poll of identical servers). It is used along with the current date to +generate a key to encrypt and decrypt the client's identity contained +in the pseudonym. +.TP +.B srp\-use\-pseudonym +When operating as an EAP SRP\-SHA1 client, attempt to use the pseudonym +stored in ~/.ppp_pseudonym first as the identity, and save in this +file any pseudonym offered by the peer during authentication. +.TP +.B sync +Use synchronous HDLC serial encoding instead of asynchronous. +The device used by pppd with this option must have sync support. +Currently supports Microgate SyncLink adapters +under Linux and FreeBSD 2.2.8 and later. +.TP +.B unit \fInum +Sets the ppp unit number (for a ppp0 or ppp1 etc interface name) for outbound +connections. If the unit is already in use a dynamically allocated will be +used. +.TP +.B ifname \fIstring +Set the ppp interface name for outbound connections. A failure to set the +name will terminate the pppd. +.TP +.B unset \fIname +Remove a variable from the environment variable for scripts that are +invoked by pppd. When specified by a privileged source, the variable +\fIname\fR cannot be set by options contained in an unprivileged +source. See also the \fIset\fR option and the environment described +in \fISCRIPTS\fR. +.TP +.B updetach +With this option, pppd will detach from its controlling terminal once +it has successfully established the ppp connection (to the point where +the first network control protocol, usually the IP control protocol, +has come up). +.TP +.B usehostname +Enforce the use of the hostname (with domain name appended, if given) +as the name of the local system for authentication purposes (overrides +the \fIname\fR option). This option is not normally needed since the +\fIname\fR option is privileged. +.TP +.B usepeerdns +Ask the peer for up to 2 DNS server addresses. The addresses supplied +by the peer (if any) are passed to the /etc/ppp/ip\-up script in the +environment variables DNS1 and DNS2, and the environment variable +USEPEERDNS will be set to 1. In addition, pppd will create an +/var/run/ppp_resolv.conf.$INTERFACE file containing one or two nameserver +lines with the address(es) supplied by the peer. +.TP +.B user \fIname +Sets the name used for authenticating the local system to the peer to +\fIname\fR. +.TP +.B vj\-max\-slots \fIn +Sets the number of connection slots to be used by the Van Jacobson +TCP/IP header compression and decompression code to \fIn\fR, which +must be between 2 and 16 (inclusive). +.TP +.B welcome \fIscript +Run the executable or shell command specified by \fIscript\fR before +initiating PPP negotiation, after the connect script (if any) has +completed. A value for this option from a privileged source cannot be +overridden by a non-privileged user. +.TP +.B xonxoff +Use software flow control (i.e. XON/XOFF) to control the flow of data on +the serial port. +.SH OPTIONS FILES +Options can be taken from files as well as the command line. Pppd +reads options from the files /etc/ppp/options, ~/.ppprc and +/etc/ppp/options.\fIttyname\fR (in that order) before processing the +options on the command line. (In fact, the command-line options are +scanned to find the terminal name before the options.\fIttyname\fR +file is read.) In forming the name of the options.\fIttyname\fR file, +the initial /dev/ is removed from the terminal name, and any remaining +/ characters are replaced with dots. +.PP +An options file is parsed into a series of words, delimited by +whitespace. Whitespace can be included in a word by enclosing the +word in double-quotes ("). A backslash (\e) quotes the following character. +A hash (#) starts a comment, which continues until the end of the +line. There is no restriction on using the \fIfile\fR or \fIcall\fR +options within an options file. +.SH SECURITY +.I pppd +provides system administrators with sufficient access control that PPP +access to a server machine can be provided to legitimate users without +fear of compromising the security of the server or the network it's +on. This control is provided through restrictions on which IP +addresses the peer may use, based on its authenticated identity (if +any), and through restrictions on which options a non-privileged user +may use. Several of pppd's options are privileged, in particular +those which permit potentially insecure configurations; these options +are only accepted in files which are under the control of the system +administrator, or if pppd is being run by root. +.PP +The default behaviour of pppd is to allow an unauthenticated peer to +use a given IP address only if the system does not already have a +route to that IP address. For example, a system with a +permanent connection to the wider internet will normally have a +default route, and thus all peers will have to authenticate themselves +in order to set up a connection. On such a system, the \fIauth\fR +option is the default. On the other hand, a system where the +PPP link is the only connection to the internet will not normally have +a default route, so the peer will be able to use almost any IP address +without authenticating itself. +.PP +As indicated above, some security-sensitive options are privileged, +which means that they may not be used by an ordinary non-privileged +user running a setuid-root pppd, either on the command line, in the +user's ~/.ppprc file, or in an options file read using the \fIfile\fR +option. Privileged options may be used in /etc/ppp/options file or in +an options file read using the \fIcall\fR option. If pppd is being +run by the root user, privileged options can be used without +restriction. +.PP +When opening the device, pppd uses either the invoking user's user ID +or the root UID (that is, 0), depending on whether the device name was +specified by the user or the system administrator. If the device name +comes from a privileged source, that is, /etc/ppp/options or an +options file read using the \fIcall\fR option, pppd uses full root +privileges when opening the device. Thus, by creating an appropriate +file under /etc/ppp/peers, the system administrator can allow users to +establish a ppp connection via a device which they would not normally +have permission to access. Otherwise pppd uses the invoking user's +real UID when opening the device. +.SH AUTHENTICATION +Authentication is the process whereby one peer convinces the other of +its identity. This involves the first peer sending its name to the +other, together with some kind of secret information which could only +come from the genuine authorized user of that name. In such an +exchange, we will call the first peer the "client" and the other the +"server". The client has a name by which it identifies itself to the +server, and the server also has a name by which it identifies itself +to the client. Generally the genuine client shares some secret (or +password) with the server, and authenticates itself by proving that it +knows that secret. Very often, the names used for authentication +correspond to the internet hostnames of the peers, but this is not +essential. +.LP +At present, pppd supports three authentication protocols: the Password +Authentication Protocol (PAP), Challenge Handshake Authentication +Protocol (CHAP), and Extensible Authentication Protocol (EAP). PAP +involves the client sending its name and a cleartext password to the +server to authenticate itself. In contrast, the server initiates the +CHAP authentication exchange by sending a challenge to the client (the +challenge packet includes the server's name). The client must respond +with a response which includes its name plus a hash value derived from +the shared secret and the challenge, in order to prove that it knows +the secret. EAP supports CHAP-style authentication, and also includes +the SRP\-SHA1 mechanism, which is resistant to dictionary-based attacks +and does not require a cleartext password on the server side. +.LP +The PPP protocol, being symmetrical, allows both peers to require the +other to authenticate itself. In that case, two separate and +independent authentication exchanges will occur. The two exchanges +could use different authentication protocols, and in principle, +different names could be used in the two exchanges. +.LP +The default behaviour of pppd is to agree to authenticate if +requested, and to not require authentication from the peer. However, +pppd will not agree to authenticate itself with a particular protocol +if it has no secrets which could be used to do so. +.LP +Pppd stores secrets for use in authentication in secrets +files (/etc/ppp/pap\-secrets for PAP, /etc/ppp/chap\-secrets for CHAP, +MS\-CHAP, MS\-CHAPv2, and EAP MD5-Challenge, and /etc/ppp/srp\-secrets +for EAP SRP\-SHA1). +All secrets files have the same format. The secrets files can +contain secrets for pppd to use in authenticating itself to other +systems, as well as secrets for pppd to use when authenticating other +systems to itself. +.LP +Each line in a secrets file contains one secret. A given secret is +specific to a particular combination of client and server - it can +only be used by that client to authenticate itself to that server. +Thus each line in a secrets file has at least 3 fields: the name of +the client, the name of the server, and the secret. These fields may +be followed by a list of the IP addresses that the specified client +may use when connecting to the specified server. +.LP +A secrets file is parsed into words as for a options file, so the +client name, server name and secrets fields must each be one word, +with any embedded spaces or other special characters quoted or +escaped. Note that case is significant in the client and server names +and in the secret. +.LP +If the secret starts with an `@', what follows is assumed to be the +name of a file from which to read the secret. A "*" as the client or +server name matches any name. When selecting a secret, pppd takes the +best match, i.e. the match with the fewest wildcards. +.LP +Any following words on the same line are taken to be a list of +acceptable IP addresses for that client. If there are only 3 words on +the line, or if the first word is "\-", then all IP addresses are +disallowed. To allow any address, use "*". A word starting with "!" +indicates that the specified address is \fInot\fR acceptable. An +address may be followed by "/" and a number \fIn\fR, to indicate a +whole subnet, i.e. all addresses which have the same value in the most +significant \fIn\fR bits. In this form, the address may be followed +by a plus sign ("+") to indicate that one address from the subnet is +authorized, based on the ppp network interface unit number in use. +In this case, the host part of the address will be set to the unit +number plus one. +.LP +Thus a secrets file contains both secrets for use in authenticating +other hosts, plus secrets which we use for authenticating ourselves to +others. When pppd is authenticating the peer (checking the peer's +identity), it chooses a secret with the peer's name in the first +field and the name of the local system in the second field. The +name of the local system defaults to the hostname, with the domain +name appended if the \fIdomain\fR option is used. This default can be +overridden with the \fIname\fR option, except when the +\fIusehostname\fR option is used. (For EAP SRP\-SHA1, see the +srp\-entry(8) utility for generating proper validator entries to be +used in the "secret" field.) +.LP +When pppd is choosing a secret to use in authenticating itself to the +peer, it first determines what name it is going to use to identify +itself to the peer. This name can be specified by the user with the +\fIuser\fR option. If this option is not used, the name defaults to +the name of the local system, determined as described in the previous +paragraph. Then pppd looks for a secret with this name in the first +field and the peer's name in the second field. Pppd will know the +name of the peer if CHAP or EAP authentication is being used, because +the peer will have sent it in the challenge packet. However, if PAP +is being used, pppd will have to determine the peer's name from the +options specified by the user. The user can specify the peer's name +directly with the \fIremotename\fR option. Otherwise, if the remote +IP address was specified by a name (rather than in numeric form), that +name will be used as the peer's name. Failing that, pppd will use the +null string as the peer's name. +.LP +When authenticating the peer with PAP, the supplied password is first +compared with the secret from the secrets file. If the password +doesn't match the secret, the password is encrypted using crypt() and +checked against the secret again. Thus secrets for authenticating the +peer can be stored in encrypted form if desired. If the +\fIpapcrypt\fR option is given, the first (unencrypted) comparison is +omitted, for better security. +.LP +Furthermore, if the \fIlogin\fR option was specified, the username and +password are also checked against the system password database. Thus, +the system administrator can set up the pap\-secrets file to allow PPP +access only to certain users, and to restrict the set of IP addresses +that each user can use. Typically, when using the \fIlogin\fR option, +the secret in /etc/ppp/pap\-secrets would be "", which will match any +password supplied by the peer. This avoids the need to have the same +secret in two places. +.LP +Authentication must be satisfactorily completed before IPCP (or any +other Network Control Protocol) can be started. If the peer is +required to authenticate itself, and fails to do so, pppd will +terminated the link (by closing LCP). If IPCP negotiates an +unacceptable IP address for the remote host, IPCP will be closed. IP +packets can only be sent or received when IPCP is open. +.LP +In some cases it is desirable to allow some hosts which can't +authenticate themselves to connect and use one of a restricted set of +IP addresses, even when the local host generally requires +authentication. If the peer refuses to authenticate itself when +requested, pppd takes that as equivalent to authenticating with PAP +using the empty string for the username and password. Thus, by adding +a line to the pap\-secrets file which specifies the empty string for +the client and password, it is possible to allow restricted access to +hosts which refuse to authenticate themselves. +.SH ROUTING +.LP +When IPCP negotiation is completed successfully, pppd will inform the +kernel of the local and remote IP addresses for the ppp interface. +This is sufficient to create a host route to the remote end of the +link, which will enable the peers to exchange IP packets. +Communication with other machines generally requires further +modification to routing tables and/or ARP (Address Resolution +Protocol) tables. In most cases the \fIdefaultroute\fR and/or +\fIproxyarp\fR options are sufficient for this, but in some cases +further intervention is required. The /etc/ppp/ip\-up script can be +used for this. +.LP +Sometimes it is desirable to add a default route through the remote +host, as in the case of a machine whose only connection to the +Internet is through the ppp interface. The \fIdefaultroute\fR option +causes pppd to create such a default route when IPCP comes up, and +delete it when the link is terminated. +.LP +In some cases it is desirable to use proxy ARP, for example on a +server machine connected to a LAN, in order to allow other hosts to +communicate with the remote host. The \fIproxyarp\fR option causes +pppd to look for a network interface on the same subnet as the remote +host (an interface supporting broadcast and ARP, which is up and not a +point-to-point or loopback interface). If found, pppd creates a +permanent, published ARP entry with the IP address of the remote host +and the hardware address of the network interface found. +.LP +When the \fIdemand\fR option is used, the interface IP addresses have +already been set at the point when IPCP comes up. If pppd has not +been able to negotiate the same addresses that it used to configure +the interface (for example when the peer is an ISP that uses dynamic +IP address assignment), pppd has to change the interface IP addresses +to the negotiated addresses. This may disrupt existing connections, +and the use of demand dialling with peers that do dynamic IP address +assignment is not recommended. +.SH MULTILINK +Multilink PPP provides the capability to combine two or more PPP links +between a pair of machines into a single `bundle', which appears as a +single virtual PPP link which has the combined bandwidth of the +individual links. Currently, multilink PPP is only supported under +Linux. +.LP +Pppd detects that the link it is controlling is connected to the same +peer as another link using the peer's endpoint discriminator and the +authenticated identity of the peer (if it authenticates itself). The +endpoint discriminator is a block of data which is hopefully unique +for each peer. Several types of data can be used, including +locally-assigned strings of bytes, IP addresses, MAC addresses, +randomly strings of bytes, or E\-164 phone numbers. The endpoint +discriminator sent to the peer by pppd can be set using the endpoint +option. +.LP +In some circumstances the peer may send no endpoint discriminator or a +non-unique value. The bundle option adds an extra string which is +added to the peer's endpoint discriminator and authenticated identity +when matching up links to be joined together in a bundle. The bundle +option can also be used to allow the establishment of multiple bundles +between the local system and the peer. Pppd uses a TDB database in +/var/run/pppd2.tdb to match up links. +.LP +Assuming that multilink is enabled and the peer is willing to +negotiate multilink, then when pppd is invoked to bring up the first +link to the peer, it will detect that no other link is connected to +the peer and create a new bundle, that is, another ppp network +interface unit. When another pppd is invoked to bring up another link +to the peer, it will detect the existing bundle and join its link to +it. +.LP +If the first link terminates (for example, because of a hangup or a +received LCP terminate-request) the bundle is not destroyed unless +there are no other links remaining in the bundle. Rather than +exiting, the first pppd keeps running after its link terminates, until +all the links in the bundle have terminated. If the first pppd +receives a SIGTERM or SIGINT signal, it will destroy the bundle and +send a SIGHUP to the pppd processes for each of the links in the +bundle. If the first pppd receives a SIGHUP signal, it will terminate +its link but not the bundle. +.LP +Note: demand mode is not currently supported with multilink. +.SH EXAMPLES +.LP +The following examples assume that the /etc/ppp/options file contains +the \fIauth\fR option (as in the default /etc/ppp/options file in the +ppp distribution). +.LP +Probably the most common use of pppd is to dial out to an ISP. This +can be done with a command such as +.IP +pppd call isp +.LP +where the /etc/ppp/peers/isp file is set up by the system +administrator to contain something like this: +.IP +ttyS0 19200 crtscts +.br +connect '/usr/sbin/chat \-v \-f /etc/ppp/chat\-isp' +.br +noauth +.LP +In this example, we are using chat to dial the ISP's modem and go +through any logon sequence required. The /etc/ppp/chat\-isp file +contains the script used by chat; it could for example contain +something like this: +.IP +ABORT "NO CARRIER" +.br +ABORT "NO DIALTONE" +.br +ABORT "ERROR" +.br +ABORT "NO ANSWER" +.br +ABORT "BUSY" +.br +ABORT "Username/Password Incorrect" +.br +"" "at" +.br +OK "at&d0&c1" +.br +OK "atdt2468135" +.br +"name:" "^Umyuserid" +.br +"word:" "\eqmypassword" +.br +"ispts" "\eq^Uppp" +.br +"~\-^Uppp\-~" +.LP +See the chat(8) man page for details of chat scripts. +.LP +Pppd can also be used to provide a dial-in ppp service for users. If +the users already have login accounts, the simplest way to set up the +ppp service is to let the users log in to their accounts and run pppd +(installed setuid-root) with a command such as +.IP +pppd proxyarp +.LP +To allow a user to use the PPP facilities, you need to allocate an IP +address for that user's machine and create an entry in +/etc/ppp/pap\-secrets, /etc/ppp/chap\-secrets, or /etc/ppp/srp\-secrets +(depending on which authentication method the PPP implementation on +the user's machine supports), so that the user's machine can +authenticate itself. For example, if Joe has a machine called +"joespc" that is to be allowed to dial in to the machine called +"server" and use the IP address joespc.my.net, you would add an entry +like this to /etc/ppp/pap\-secrets or /etc/ppp/chap\-secrets: +.IP +joespc server "joe's secret" joespc.my.net +.LP +(See srp\-entry(8) for a means to generate the server's entry when +SRP\-SHA1 is in use.) +Alternatively, you can create a username called (for example) "ppp", +whose login shell is pppd and whose home directory is /etc/ppp. +Options to be used when pppd is run this way can be put in +/etc/ppp/.ppprc. +.LP +If your serial connection is any more complicated than a piece of +wire, you may need to arrange for some control characters to be +escaped. In particular, it is often useful to escape XON (^Q) and +XOFF (^S), using \fIasyncmap a0000\fR. If the path includes a telnet, +you probably should escape ^] as well (\fIasyncmap 200a0000\fR). If +the path includes an rlogin, you will need to use the \fIescape ff\fR +option on the end which is running the rlogin client, since many +rlogin implementations are not transparent; they will remove the +sequence [0xff, 0xff, 0x73, 0x73, followed by any 8 bytes] from the +stream. +.SH DIAGNOSTICS +.LP +Messages are sent to the syslog daemon using facility LOG_DAEMON. +(This can be overridden by recompiling pppd with the macro +LOG_PPP defined as the desired facility.) See the syslog(8) +documentation for details of where the syslog daemon will write the +messages. On most systems, the syslog daemon uses the +/etc/syslog.conf file to specify the destination(s) for syslog +messages. You may need to edit that file to suit. +.LP +The \fIdebug\fR option causes the contents of all control packets sent +or received to be logged, that is, all LCP, PAP, CHAP, EAP, or IPCP packets. +This can be useful if the PPP negotiation does not succeed or if +authentication fails. +If debugging is enabled at compile time, the \fIdebug\fR option also +causes other debugging messages to be logged. +.LP +Debugging can also be enabled or disabled by sending a SIGUSR1 signal +to the pppd process. This signal acts as a toggle. +.SH EXIT STATUS +The exit status of pppd is set to indicate whether any error was +detected, or the reason for the link being terminated. The values +used are: +.TP +.B 0 +Pppd has detached, or otherwise the connection was successfully +established and terminated at the peer's request. +.TP +.B 1 +An immediately fatal error of some kind occurred, such as an essential +system call failing, or running out of virtual memory. +.TP +.B 2 +An error was detected in processing the options given, such as two +mutually exclusive options being used. +.TP +.B 3 +Pppd is not setuid-root and the invoking user is not root. +.TP +.B 4 +The kernel does not support PPP, for example, the PPP kernel driver is +not included or cannot be loaded. +.TP +.B 5 +Pppd terminated because it was sent a SIGINT, SIGTERM or SIGHUP +signal. +.TP +.B 6 +The serial port could not be locked. +.TP +.B 7 +The serial port could not be opened. +.TP +.B 8 +The connect script failed (returned a non-zero exit status). +.TP +.B 9 +The command specified as the argument to the \fIpty\fR option could +not be run. +.TP +.B 10 +The PPP negotiation failed, that is, it didn't reach the point where +at least one network protocol (e.g. IP) was running. +.TP +.B 11 +The peer system failed (or refused) to authenticate itself. +.TP +.B 12 +The link was established successfully and terminated because it was +idle. +.TP +.B 13 +The link was established successfully and terminated because the +connect time limit was reached. +.TP +.B 14 +Callback was negotiated and an incoming call should arrive shortly. +.TP +.B 15 +The link was terminated because the peer is not responding to echo +requests. +.TP +.B 16 +The link was terminated by the modem hanging up. +.TP +.B 17 +The PPP negotiation failed because serial loopback was detected. +.TP +.B 18 +The init script failed (returned a non-zero exit status). +.TP +.B 19 +We failed to authenticate ourselves to the peer. +.SH SCRIPTS +Pppd invokes scripts at various stages in its processing which can be +used to perform site-specific ancillary processing. These scripts are +usually shell scripts, but could be executable code files instead. +Pppd does not wait for the scripts to finish (except for the ip-pre-up +script). The scripts are +executed as root (with the real and effective user-id set to 0), so +that they can do things such as update routing tables or run +privileged daemons. Be careful that the contents of these scripts do +not compromise your system's security. Pppd runs the scripts with +standard input, output and error redirected to /dev/null, and with an +environment that is empty except for some environment variables that +give information about the link. The environment variables that pppd +sets are: +.TP +.B DEVICE +The name of the serial tty device being used. +.TP +.B IFNAME +The name of the network interface being used. +.TP +.B IPLOCAL +The IP address for the local end of the link. This is only set when +IPCP has come up. +.TP +.B IPREMOTE +The IP address for the remote end of the link. This is only set when +IPCP has come up. +.TP +.B PEERNAME +The authenticated name of the peer. This is only set if the peer +authenticates itself. +.TP +.B SPEED +The baud rate of the tty device. +.TP +.B ORIG_UID +The real user-id of the user who invoked pppd. +.TP +.B PPPLOGNAME +The username of the real user-id that invoked pppd. This is always set. +.P +For the ip-down and auth-down scripts, pppd also sets the following +variables giving statistics for the connection: +.TP +.B CONNECT_TIME +The number of seconds from when the PPP negotiation started until the +connection was terminated. +.TP +.B BYTES_SENT +The number of bytes sent (at the level of the serial port) during the +connection. +.TP +.B BYTES_RCVD +The number of bytes received (at the level of the serial port) during +the connection. +.TP +.B LINKNAME +The logical name of the link, set with the \fIlinkname\fR option. +.TP +.B DNS1 +If the peer supplies DNS server addresses, this variable is set to the +first DNS server address supplied (whether or not the usepeerdns +option was given). +.TP +.B DNS2 +If the peer supplies DNS server addresses, this variable is set to the +second DNS server address supplied (whether or not the usepeerdns +option was given). +.P +Pppd invokes the following scripts, if they exist. It is not an error +if they don't exist. +.TP +.B /etc/ppp/auth\-up +A program or script which is executed after the remote system +successfully authenticates itself. It is executed with the parameters +.IP +\fIinterface\-name peer\-name user\-name tty\-device speed\fR +.IP +Note that this script is not executed if the peer doesn't authenticate +itself, for example when the \fInoauth\fR option is used. +.TP +.B /etc/ppp/auth\-down +A program or script which is executed when the link goes down, if +/etc/ppp/auth\-up was previously executed. It is executed in the same +manner with the same parameters as /etc/ppp/auth\-up. +.TP +.B /etc/ppp/ip\-pre\-up +A program or script which is executed just before the ppp network +interface is brought up. It is executed with the same parameters as +the ip\-up script (below). At this point the interface exists and has +IP addresses assigned but is still down. This can be used to +add firewall rules before any IP traffic can pass through the +interface. Pppd will wait for this script to finish before bringing +the interface up, so this script should run quickly. +.TP +.B /etc/ppp/ip\-up +A program or script which is executed when the link is available for +sending and receiving IP packets (that is, IPCP has come up). It is +executed with the parameters +.IP +\fIinterface\-name tty\-device speed local\-IP\-address +remote\-IP\-address ipparam\fR +.TP +.B /etc/ppp/ip\-down +A program or script which is executed when the link is no longer +available for sending and receiving IP packets. This script can be +used for undoing the effects of the /etc/ppp/ip\-up and +/etc/ppp/ip\-pre\-up scripts. It is +invoked in the same manner and with the same parameters as the ip\-up +script. +.TP +.B /etc/ppp/ipv6\-up +Like /etc/ppp/ip\-up, except that it is executed when the link is available +for sending and receiving IPv6 packets. It is executed with the parameters +.IP +\fIinterface\-name tty\-device speed local\-link\-local\-address +remote\-link\-local\-address ipparam\fR +.TP +.B /etc/ppp/ipv6\-down +Similar to /etc/ppp/ip\-down, but it is executed when IPv6 packets can no +longer be transmitted on the link. It is executed with the same parameters +as the ipv6\-up script. +.TP +.B /etc/ppp/ipx\-up +A program or script which is executed when the link is available for +sending and receiving IPX packets (that is, IPXCP has come up). It is +executed with the parameters +.IP +\fIinterface\-name tty\-device speed network\-number local\-IPX\-node\-address +remote\-IPX\-node\-address local\-IPX\-routing\-protocol remote\-IPX\-routing\-protocol +local\-IPX\-router\-name remote\-IPX\-router\-name ipparam pppd\-pid\fR +.IP +The local\-IPX\-routing\-protocol and remote\-IPX\-routing\-protocol field +may be one of the following: +.IP +NONE to indicate that there is no routing protocol +.br +RIP to indicate that RIP/SAP should be used +.br +NLSP to indicate that Novell NLSP should be used +.br +RIP NLSP to indicate that both RIP/SAP and NLSP should be used +.TP +.B /etc/ppp/ipx\-down +A program or script which is executed when the link is no longer +available for sending and receiving IPX packets. This script can be +used for undoing the effects of the /etc/ppp/ipx\-up script. It is +invoked in the same manner and with the same parameters as the ipx\-up +script. +.SH FILES +.TP +.B /var/run/ppp\fIn\fB.pid \fR(BSD or Linux), \fB/etc/ppp/ppp\fIn\fB.pid \fR(others) +Process-ID for pppd process on ppp interface unit \fIn\fR. +.TP +.B /var/run/ppp\-\fIname\fB.pid \fR(BSD or Linux), +\fB/etc/ppp/ppp\-\fIname\fB.pid \fR(others) +Process-ID for pppd process for logical link \fIname\fR (see the +\fIlinkname\fR option). +.TP +.B /var/run/pppd2.tdb +Database containing information about pppd processes, interfaces and +links, used for matching links to bundles in multilink operation. May +be examined by external programs to obtain information about running +pppd instances, the interfaces and devices they are using, IP address +assignments, etc. +.B /etc/ppp/pap\-secrets +Usernames, passwords and IP addresses for PAP authentication. This +file should be owned by root and not readable or writable by any other +user. Pppd will log a warning if this is not the case. +.TP +.B /etc/ppp/chap\-secrets +Names, secrets and IP addresses for CHAP/MS\-CHAP/MS\-CHAPv2 authentication. +As for /etc/ppp/pap\-secrets, this file should be owned by root and not +readable or writable by any other user. Pppd will log a warning if +this is not the case. +.TP +.B /etc/ppp/srp\-secrets +Names, secrets, and IP addresses for EAP authentication. As for +/etc/ppp/pap\-secrets, this file should be owned by root and not +readable or writable by any other user. Pppd will log a warning if +this is not the case. +.TP +.B ~/.ppp_pseudonym +Saved client-side SRP\-SHA1 pseudonym. See the \fIsrp\-use\-pseudonym\fR +option for details. +.TP +.B /etc/ppp/options +System default options for pppd, read before user default options or +command-line options. +.TP +.B ~/.ppprc +User default options, read before /etc/ppp/options.\fIttyname\fR. +.TP +.B /etc/ppp/options.\fIttyname +System default options for the serial port being used, read after +~/.ppprc. In forming the \fIttyname\fR part of this +filename, an initial /dev/ is stripped from the port name (if +present), and any slashes in the remaining part are converted to +dots. +.TP +.B /etc/ppp/peers +A directory containing options files which may contain privileged +options, even if pppd was invoked by a user other than root. The +system administrator can create options files in this directory to +permit non-privileged users to dial out without requiring the peer to +authenticate, but only to certain trusted peers. +.SH SEE ALSO +.BR chat (8), +.BR pppstats (8) +.TP +.B RFC1144 +Jacobson, V. +\fICompressing TCP/IP headers for low-speed serial links.\fR +February 1990. +.TP +.B RFC1321 +Rivest, R. +.I The MD5 Message-Digest Algorithm. +April 1992. +.TP +.B RFC1332 +McGregor, G. +.I PPP Internet Protocol Control Protocol (IPCP). +May 1992. +.TP +.B RFC1334 +Lloyd, B.; Simpson, W.A. +.I PPP authentication protocols. +October 1992. +.TP +.B RFC1661 +Simpson, W.A. +.I The Point-to-Point Protocol (PPP). +July 1994. +.TP +.B RFC1662 +Simpson, W.A. +.I PPP in HDLC-like Framing. +July 1994. +.TP +.B RFC2284 +Blunk, L.; Vollbrecht, J., +.I PPP Extensible Authentication Protocol (EAP). +March 1998. +.TP +.B RFC2472 +Haskin, D. +.I IP Version 6 over PPP +December 1998. +.TP +.B RFC2945 +Wu, T., +.I The SRP Authentication and Key Exchange System +September 2000. +.TP +.B draft\-ietf\-pppext\-eap\-srp\-03.txt +Carlson, J.; et al., +.I EAP SRP\-SHA1 Authentication Protocol. +July 2001. +.SH NOTES +Some limited degree of control can be exercised over a running pppd +process by sending it a signal from the list below. +.TP +.B SIGINT, SIGTERM +These signals cause pppd to terminate the link (by closing LCP), +restore the serial device settings, and exit. If a connector or +disconnector process is currently running, pppd will send the same +signal to its process group, so as to terminate the connector or +disconnector process. +.TP +.B SIGHUP +This signal causes pppd to terminate the link, restore the serial +device settings, and close the serial device. If the \fIpersist\fR or +\fIdemand\fR option has been specified, pppd will try to reopen the +serial device and start another connection (after the holdoff period). +Otherwise pppd will exit. If this signal is received during the +holdoff period, it causes pppd to end the holdoff period immediately. +If a connector or disconnector process is running, pppd will send the +same signal to its process group. +.TP +.B SIGUSR1 +This signal toggles the state of the \fIdebug\fR option. +.TP +.B SIGUSR2 +This signal causes pppd to renegotiate compression. This can be +useful to re-enable compression after it has been disabled as a result +of a fatal decompression error. (Fatal decompression errors generally +indicate a bug in one or other implementation.) + +.SH AUTHORS +Paul Mackerras (paulus@samba.org), based on earlier work by +Drew Perkins, +Brad Clements, +Karl Fox, +Greg Christy, +and +Brad Parker. + +.SH COPYRIGHT +Pppd is copyrighted and made available under conditions which provide +that it may be copied and used in source or binary forms provided that +the conditions listed below are met. Portions of pppd are covered by +the following copyright notices: +.LP +Copyright (c) 1984-2000 Carnegie Mellon University. All rights +reserved. +.br +Copyright (c) 1993-2004 Paul Mackerras. All rights reserved. +.br +Copyright (c) 1995 Pedro Roque Marques. All rights reserved. +.br +Copyright (c) 1995 Eric Rosenquist. All rights reserved. +.br +Copyright (c) 1999 Tommi Komulainen. All rights reserved. +.br +Copyright (C) Andrew Tridgell 1999 +.br +Copyright (c) 2000 by Sun Microsystems, Inc. All rights reserved. +.br +Copyright (c) 2001 by Sun Microsystems, Inc. All rights reserved. +.br +Copyright (c) 2002 Google, Inc. All rights reserved. +.LP +The copyright notices contain the following statements. +.LP +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions +are met: +.LP +1. Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. +.LP +2. Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in + the documentation and/or other materials provided with the + distribution. +.LP +3. The name "Carnegie Mellon University" must not be used to + endorse or promote products derived from this software without + prior written permission. For permission or any legal + details, please contact +.br + Office of Technology Transfer +.br + Carnegie Mellon University +.br + 5000 Forbes Avenue +.br + Pittsburgh, PA 15213-3890 +.br + (412) 268-4387, fax: (412) 268-7395 +.br + tech-transfer@andrew.cmu.edu +.LP +3b. The name(s) of the authors of this software must not be used to + endorse or promote products derived from this software without + prior written permission. +.LP +4. Redistributions of any form whatsoever must retain the following + acknowledgements: +.br + "This product includes software developed by Computing Services + at Carnegie Mellon University (http://www.cmu.edu/computing/)." +.br + "This product includes software developed by Paul Mackerras + <paulus@samba.org>". +.br + "This product includes software developed by Pedro Roque Marques + <pedro_m@yahoo.com>". +.br + "This product includes software developed by Tommi Komulainen + <Tommi.Komulainen@iki.fi>". +.LP +CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO +THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY +AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE +FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN +AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING +OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.LP +THE AUTHORS OF THIS SOFTWARE DISCLAIM ALL WARRANTIES WITH REGARD TO +THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY +AND FITNESS, IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY +SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN +AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING +OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. diff --git a/upstream/opensuse-leap-15-6/man8/pppdump.8 b/upstream/opensuse-leap-15-6/man8/pppdump.8 new file mode 100644 index 00000000..4072e68c --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/pppdump.8 @@ -0,0 +1,62 @@ +.\" @(#) $Id: pppdump.8,v 1.2 2004/11/13 12:22:49 paulus Exp $ +.TH PPPDUMP 8 "1 April 1999" +.SH NAME +pppdump \- convert PPP record file to readable format +.SH SYNOPSIS +.B pppdump +[ +.B \-h +| +.B \-p +[ +.B \-d +]] [ +.B \-r +] [ +.B \-m \fImru +] [ +.I file \fR... +] +.ti 12 +.SH DESCRIPTION +The +.B pppdump +utility converts the files written using the \fIrecord\fR option of +.B pppd +into a human-readable format. If one or more filenames are specified, +.B pppdump +will read each in turn; otherwise it will read its standard input. In +each case the result is written to standard output. +.PP +The options are as follows: +.TP +.B \-h +Prints the bytes sent and received in hexadecimal. If neither this +option nor the \fB\-p\fR option is specified, the bytes are printed as +the characters themselves, with non-printing and non-ASCII characters +printed as escape sequences. +.TP +.B \-p +Collects the bytes sent and received into PPP packets, interpreting +the async HDLC framing and escape characters and checking the FCS +(frame check sequence) of each packet. The packets are printed as hex +values and as characters (non-printable characters are printed as +`.'). +.TP +.B \-d +With the \fB\-p\fR option, this option causes +.B pppdump +to decompress packets which have been compressed with the BSD-Compress +or Deflate methods. +.TP +.B \-r +Reverses the direction indicators, so that `sent' is printed for +bytes or packets received, and `rcvd' is printed for bytes or packets +sent. +.TP +.B \-m \fImru +Use \fImru\fR as the MRU (maximum receive unit) for both directions of +the link when checking for over-length PPP packets (with the \fB\-p\fR +option). +.SH SEE ALSO +pppd(8) diff --git a/upstream/opensuse-leap-15-6/man8/pppoe-discovery.8 b/upstream/opensuse-leap-15-6/man8/pppoe-discovery.8 new file mode 100644 index 00000000..6aa28beb --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/pppoe-discovery.8 @@ -0,0 +1,86 @@ +.\" pppoe-discovery.8 written by +.\" Ben Hutchings <ben@decadentplace.org.uk>, based on pppoe.8. +.\" Licenced under the GPL version 2 or later. +.TH PPPOE-DISCOVERY 8 "22 January 2006" +.SH NAME +pppoe\-discovery \- perform PPPoE discovery +.SH SYNOPSIS +.B pppoe\-discovery +[ +.I options +] +.br +.BR pppoe\-discovery " { " \-V " | " \-h " }" +.SH DESCRIPTION +.LP +\fBpppoe\-discovery\fR performs the same discovery process as +\fBpppoe\fR, but does not initiate a session. +It sends a PADI packet and then prints the names of access +concentrators in each PADO packet it receives. +.SH OPTIONS +.TP +.BI \-I " interface" +.RS +The \fB\-I\fR option specifies the Ethernet interface to use. +Under Linux, it is typically eth0 or eth1. +The interface should be \(lqup\(rq before you start +\fBpppoe\-discovery\fR, but should \fInot\fR be configured to have an +IP address. +The default interface is eth0. +.RE +.TP +.BI \-D " file_name" +.RS +The \fB\-D\fR option causes every packet to be dumped to the specified +\fIfile_name\fR. +This is intended for debugging only. +.RE +.TP +.B \-U +.RS +Causes \fBpppoe\-discovery\fR to use the Host-Uniq tag in its discovery +packets. +This lets you run multiple instances of \fBpppoe\-discovery\fR and/or +\fBpppoe\fR without having their discovery packets interfere with one +another. +You must supply this option to \fIall\fR instances that you intend to +run simultaneously. +.RE +.TP +.BI \-S " service_name" +.RS +Specifies the desired service name. +\fBpppoe\-discovery\fR will only accept access concentrators which can +provide the specified service. +In most cases, you should \fInot\fR specify this option. +Use it only if you know that there are multiple access concentrators +or know that you need a specific service name. +.RE +.TP +.BI \-C " ac_name" +.RS +Specifies the desired access concentrator name. +\fBpppoe\-discovery\fR will only accept the specified access +concentrator. +In most cases, you should \fInot\fR specify this option. +Use it only if you know that there are multiple access concentrators. +If both the \fB\-S\fR and \fB\-C\fR options are specified, they must +\fIboth\fR match. +.RE +.TP +.B \-A +.RS +This option is accepted for compatibility with \fBpppoe\fR, but has no +effect. +.RE +.TP +.BR \-V " | " \-h +.RS +Either of these options causes \fBpppoe\-discovery\fR to print its +version number and usage information, then exit. +.RE +.SH AUTHORS +\fBpppoe\-discovery\fR was written by Marco d'Itri <md@linux.it>, +based on \fBpppoe\fR by David F. Skoll <dfs@roaringpenguin.com>. +.SH SEE ALSO +pppoe(8), pppoe-sniff(8) diff --git a/upstream/opensuse-leap-15-6/man8/pppstats.8 b/upstream/opensuse-leap-15-6/man8/pppstats.8 new file mode 100644 index 00000000..4ac101e9 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/pppstats.8 @@ -0,0 +1,217 @@ +.\" @(#) $Id: pppstats.8,v 1.4 2004/11/13 12:22:49 paulus Exp $ +.TH PPPSTATS 8 "26 June 1995" +.SH NAME +pppstats \- print PPP statistics +.SH SYNOPSIS +.B pppstats +[ +.B \-a +] [ +.B \-v +] [ +.B \-r +] [ +.B \-z +] [ +.B \-c +.I <count> +] [ +.B \-w +.I <secs> +] [ +.I interface +] +.ti 12 +.SH DESCRIPTION +The +.B pppstats +utility reports PPP\-related statistics at regular intervals for the +specified PPP interface. If the interface is unspecified, it will +default to ppp0. +The display is split horizontally +into input and output sections containing columns of statistics +describing the properties and volume of packets received and +transmitted by the interface. +.PP +The options are as follows: +.TP +.B \-a +Display absolute values rather than deltas. With this option, all +reports show statistics for the time since the link was initiated. +Without this option, the second and subsequent reports show statistics +for the time since the last report. +.TP +.B \-c \fIcount +Repeat the display +.I count +times. If this option is not specified, the default repeat count is 1 +if the +.B \-w +option is not specified, otherwise infinity. +.TP +.B \-r +Display additional statistics summarizing the compression ratio +achieved by the packet compression algorithm in use. +.TP +.B \-v +Display additional statistics relating to the performance of the Van +Jacobson TCP header compression algorithm. +.TP +.B \-w \fIwait +Pause +.I wait +seconds between each display. If this option is not specified, the +default interval is 5 seconds. +.TP +.B \-z +Instead of the standard display, show statistics indicating the +performance of the packet compression algorithm in use. +.PP +The following fields are printed on the input side when the +.B \-z +option is not used: +.TP +.B IN +The total number of bytes received by this interface. +.TP +.B PACK +The total number of packets received by this interface. +.TP +.B VJCOMP +The number of header-compressed TCP packets received by this interface. +.TP +.B VJUNC +The number of header-uncompressed TCP packets received by this +interface. Not reported when the +.B \-r +option is specified. +.TP +.B VJERR +The number of corrupted or bogus header-compressed TCP packets +received by this interface. Not reported when the +.B \-r +option is specified. +.TP +.B VJTOSS +The number of VJ header-compressed TCP packets dropped on reception by +this interface because of preceding errors. Only reported when the +.B \-v +option is specified. +.TP +.B NON-VJ +The total number of non-TCP packets received by this interface. Only +reported when the +.B \-v +option is specified. +.TP +.B RATIO +The compression ratio achieved for received packets by the +packet compression scheme in use, defined as the uncompressed size +divided by the compressed size. +Only reported when the +.B \-r +option is specified. +.TP +.B UBYTE +The total number of bytes received, after decompression of compressed +packets. Only reported when the +.B \-r +option is specified. +.PP +The following fields are printed on the output side: +.TP +.B OUT +The total number of bytes transmitted from this interface. +.TP +.B PACK +The total number of packets transmitted from this interface. +.TP +.B VJCOMP +The number of TCP packets transmitted from this interface with +VJ-compressed TCP headers. +.TP +.B VJUNC +The number of TCP packets transmitted from this interface with +VJ-uncompressed TCP headers. +Not reported when the +.B \-r +option is specified. +.TP +.B NON-VJ +The total number of non-TCP packets transmitted from this interface. +Not reported when the +.B \-r +option is specified. +.TP +.B VJSRCH +The number of searches for the cached header entry for a VJ header +compressed TCP packet. Only reported when the +.B \-v +option is specified. +.TP +.B VJMISS +The number of failed searches for the cached header entry for a +VJ header compressed TCP packet. Only reported when the +.B \-v +option is specified. +.TP +.B RATIO +The compression ratio achieved for transmitted packets by the +packet compression scheme in use, defined as the size +before compression divided by the compressed size. +Only reported when the +.B \-r +option is specified. +.TP +.B UBYTE +The total number of bytes to be transmitted, before packet compression +is applied. Only reported when the +.B \-r +option is specified. +.PP +When the +.B \-z +option is specified, +.B pppstats +instead displays the following fields, relating to the packet +compression algorithm currently in use. If packet compression is not +in use, these fields will all display zeroes. The fields displayed on +the input side are: +.TP +.B COMPRESSED BYTE +The number of bytes of compressed packets received. +.TP +.B COMPRESSED PACK +The number of compressed packets received. +.TP +.B INCOMPRESSIBLE BYTE +The number of bytes of incompressible packets (that is, those which +were transmitted in uncompressed form) received. +.TP +.B INCOMPRESSIBLE PACK +The number of incompressible packets received. +.TP +.B COMP RATIO +The recent compression ratio for incoming packets, defined as the +uncompressed size divided by the compressed size (including both +compressible and incompressible packets). +.PP +The fields displayed on the output side are: +.TP +.B COMPRESSED BYTE +The number of bytes of compressed packets transmitted. +.TP +.B COMPRESSED PACK +The number of compressed packets transmitted. +.TP +.B INCOMPRESSIBLE BYTE +The number of bytes of incompressible packets transmitted (that is, +those which were transmitted in uncompressed form). +.TP +.B INCOMPRESSIBLE PACK +The number of incompressible packets transmitted. +.TP +.B COMP RATIO +The recent compression ratio for outgoing packets. +.SH SEE ALSO +pppd(8) diff --git a/upstream/opensuse-leap-15-6/man8/praliases.8 b/upstream/opensuse-leap-15-6/man8/praliases.8 new file mode 100644 index 00000000..8a8f66d9 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/praliases.8 @@ -0,0 +1,57 @@ +.\" Copyright (c) 1998-2000, 2008 Proofpoint, Inc. and its suppliers. +.\" All rights reserved. +.\" +.\" By using this file, you agree to the terms and conditions set +.\" forth in the LICENSE file which can be found at the top level of +.\" the sendmail distribution. +.\" +.\" +.\" $Id: praliases.8,v 8.20 2013-11-22 20:51:53 ca Exp $ +.\" +.TH PRALIASES 8 "$Date: 2013-11-22 20:51:53 $" +.SH NAME +praliases +\- display system mail aliases +.SH SYNOPSIS +.B praliases +.RB [ \-C +.IR file ] +.RB [ \-f +.IR file ] +.RB [\c +.IR key +.IR ... ] +.SH DESCRIPTION +The +.B praliases +utility displays the current system aliases, +one per line, in no particular order. +The special internal @:@ alias will be displayed if present. +.PP +The options are as follows: +.TP +.BI "\-C " file +Read the specified sendmail configuration file instead of the default +.B sendmail +configuration file. +.TP +.BI "\-f " file +Read the specified file instead of the configured +.B sendmail +system aliases file(s). +.PP +If one or more keys are specified on the command line, +only entries which match those keys are displayed. +.PP +The +.B praliases +utility exits 0 on success, and >0 if an error occurs. +.SH FILES +.TP 2.5i +/etc/mail/sendmail.cf +The default +.B sendmail +configuration file. +.SH SEE ALSO +mailq(1), +sendmail(8) diff --git a/upstream/opensuse-leap-15-6/man8/quota_nld.8 b/upstream/opensuse-leap-15-6/man8/quota_nld.8 new file mode 100644 index 00000000..9eb72140 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/quota_nld.8 @@ -0,0 +1,61 @@ +.TH RQUOTAD 8 +.SH NAME +quota_nld \- quota netlink message daemon +.SH SYNOPSIS +.B quota_nld +[[ +.B \-D +| +.B \-C +][ +.B \-F +][ +.B \-b +]] +.SH DESCRIPTION +.BR quota_nld +listens on netlink socket and processes received quota +warnings. By default +.BR quota_nld +forwards warning messages to both the system's DBUS (so that the desktop +manager can display a dialog) and the last-accessed terminal of the user to +whom each warning is directed. Either of these destinations can be disabled +with the +.B \-D +and +.B \-C +options, respectively. + +In the case of the user's terminal, quota messages about falling below +the hard and soft limits are not sent unless the +.B \-b +option is specified. In the case of the DBUS, all quota messages are sent. + +Note, that you have to enable the kernel support for sending quota +messages over netlink (in Filesystems->Quota menu). + +.SH OPTIONS +.TP +.B \-V, \-\-version +Show version of quota tools and exit. +.TP +.B \-h, \-\-help +Show a usage message and exit. +.TP +.B \-D, \-\-no-dbus +Do not forward quota warnings to DBUS. +.TP +.B \-C, \-\-no-console +Do not print quota warnings to the user's last-accessed terminal. +.TP +.B \-b, \-\-print-below +If quota warnings are printed to users' terminals, include +messages about falling below their hard and soft limits. +.TP +.B \-F, \-\-foreground +Run daemon in foreground (may be useful for debugging purposes). + +.SH "SEE ALSO" +.BR quota (1), +.BR netlink (7), +.BR dbus.freedesktop.org diff --git a/upstream/opensuse-leap-15-6/man8/quotacheck.8 b/upstream/opensuse-leap-15-6/man8/quotacheck.8 new file mode 100644 index 00000000..fe020f49 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/quotacheck.8 @@ -0,0 +1,197 @@ +.TH quotacheck 8 "Fri Jul 20 2001" +.SH NAME +quotacheck \- scan a filesystem for disk usage, create, check and repair quota files +.SH SYNOPSIS +.B quotacheck +[ +.B \-gubcfinvdMmR +] [ +.B \-F +.I quota-format +] +.B \-a +| +.I filesystem +.br +.SH DESCRIPTION +.B quotacheck +examines each filesystem, builds a table of current disk usage, and +compares this table against that recorded in the disk quota file for the +filesystem (this step is omitted if option +.B -c +is specified). If any inconsistencies are detected, both the quota file +and the current system copy of the incorrect quotas are updated (the +latter only occurs if an active filesystem is checked which is not advised). +By default, only user quotas are checked. +.B quotacheck +expects each filesystem to be checked to have quota files named +.I [a]quota.user +and +.I [a]quota.group +located at the root of the associated filesystem. If a file is not +present, +.B quotacheck +will create it. +.PP +If the quota file is corrupted, +.B quotacheck +tries to save as much data as possible. Rescuing data may need user +intervention. With no additional options +.B quotacheck +will simply exit in such a situation. When in interactive mode (option +.BR -i ) +, the user is asked for advice. Advice can also be provided from command +line (see option +.BR -n ) +, which is useful when +.B quotacheck +is run automatically (ie. from script) and failure is unacceptable. +.PP +.B quotacheck +should be run each time the system boots and mounts non-valid filesystems. +This is most likely to happen after a system crash. +.PP +It is strongly recommended to run +.B quotacheck +with quotas turned off for the filesystem. Otherwise, possible damage +or loss to data in the quota files can result. It is also unwise to +run +.B quotacheck +on a live filesystem as actual usage may change during the scan. To +prevent this, +.B quotacheck +tries to remount the filesystem read-only before starting the scan. +After the scan is done it remounts the filesystem read-write. You can +disable this with option +.BR \-m . +You can also make +.B quotacheck +ignore the failure to remount the filesystem read-only with option +.BR \-M . +.SH OPTIONS +.TP +.B -b, --backup +Forces +.B quotacheck +to make backups of the quota file before writing the new data. +.TP +.B -v, --verbose +.B quotacheck +reports its operation as it progresses. Normally it operates silently. +If the option is specified twice, also the current directory is printed (note +that printing can slow down the scan measurably). +.TP +.B -d, --debug +Enable debugging mode. It will result in a lot of information which can +be used in debugging the program. The output is very verbose and the +scan will be slow. +.TP +.B -u, --user +Only user quotas listed in +.I /etc/mtab +or on the filesystems specified are to be checked. This is the default action. +.TP +.B -g, --group +Only group quotas listed in +.I /etc/mtab +or on the filesystems specified are to be checked. +.TP +.B -c, --create-files +Don't read existing quota files. Just perform a new scan and save it to disk. +.B quotacheck +also skips scanning of old quota files when they are not found. +.TP +.B -f, --force +Forces checking and writing of new quota files on filesystems with quotas +enabled. This is not recommended as the created quota files may be out of sync. +.TP +.B -M, --try-remount +This flag forces checking of filesystem in read-write mode if a remount +fails. Do this only when you are sure no process will write to a +filesystem while scanning. +.TP +.B -m, --no-remount +Don't try to remount filesystem read-only. See comment with option +.BR \-M . +.TP +.B -i, --interactive +Interactive mode. By default +.B quotacheck +exits when it finds an error. In interactive mode user is asked for +input instead. See option +.BR \-n . +.TP +.B -n, --use-first-dquot +If the quota files become corrupted, it is possible for duplicate +entries for a single user or group ID to exist. Normally in this case, +.B quotacheck +exits or asks user for input. When this option is set, the first entry found +is always used (this option works in interactive mode too). +.TP +.B -F, --format=\f2format-name\f1 +Check and fix quota files of specified format (ie. don't perform format +auto-detection). This is recommended as detection might not work well on +corrupted quota files. Possible format names are: +.B vfsold +Original quota format with 16-bit UIDs / GIDs, +.B vfsv0 +Quota format with 32-bit UIDs / GIDs, 64-bit space usage, 32-bit inode usage and limits, +.B vfsv1 +Quota format with 64-bit quota limits and usage, +.B rpc +(quota over NFS), +.B xfs +(quota on XFS filesystem) +.TP +.B -a, --all +Check all mounted non-NFS filesystems in +.B /etc/mtab +.TP +.B -R, --exclude-root +When used together with the +.B \-a +option, all filesystems except for the root filesystem are checked for +quotas. + +.SH NOTE +.B quotacheck +should only be run by super-user. Non-privileged users are presumably +not allowed to read all the directories on the given filesystem. + +.SH "SEE ALSO" +.BR quota (1), +.BR quotactl (2), +.BR fstab (5), +.BR quotaon (8), +.BR repquota (8), +.BR convertquota (8), +.BR setquota (8), +.BR edquota (8), +.BR fsck (8), +.BR efsck (8), +.BR e2fsck (8), +.BR xfsck (8) + +.SH FILES +.PD 0 +.TP 15 +.B aquota.user or aquota.group +located at filesystem root with quotas (version 2 quota, non-XFS +filesystems) +.TP 15 +.B quota.user or quota.group +located at filesystem root with quotas (version 1 quota, non-XFS +filesystems) +.TP +.B /etc/mtab +names and locations of mounted filesystems +.SH AUTHOR +Jan Kara \<jack@suse.cz\> +.br +Based on old +.B quotacheck +by: +.br +Edvard Tuinder \<ed@elm.net\> +.br +Marco van Wieringen \<mvw@planets.elm.net\> diff --git a/upstream/opensuse-leap-15-6/man8/quotaon.8 b/upstream/opensuse-leap-15-6/man8/quotaon.8 new file mode 100644 index 00000000..0a2d2680 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/quotaon.8 @@ -0,0 +1,224 @@ +.TH QUOTAON 8 +.UC 4 +.SH NAME +quotaon, quotaoff \- turn filesystem quotas on and off +.SH SYNOPSIS +.B quotaon +[ +.B \-vugfp +] [ +.B \-F +.I format-name +] +.IR filesystem .\|.\|. +.br +.B quotaon +[ +.B \-avugPfp +] [ +.B \-F +.I format-name +] +.LP +.B quotaoff +[ +.B \-vugPp +] +[ +.B \-x +.I state +] +.IR filesystem .\|.\|. +.br +.B quotaoff +[ +.B \-avugp +] +.SH DESCRIPTION +.SS quotaon +.IX "quotaon command" "" "\fLquotaon\fP \(em turn filesystem quotas on" +.IX "user quotas" "quotaon command" "" "\fLquotaon\fP \(em turn filesystem quotas on" +.IX "disk quotas" "quotaon command" "" "\fLquotaon\fP \(em turn filesystem quotas on" +.IX "quotas" "quotaon command" "" "\fLquotaon\fP \(em turn filesystem quotas on" +.IX "filesystem" "quotaon command" "" "\fLquotaon\fP \(em turn filesystem quotas on" +.LP +.B quotaon +announces to the system that disk quotas should be enabled on one or +more filesystems. The filesystem quota files must be present in the root +directory of the specified filesystem and be named either +.IR aquota.user +(for version 2 user quota), +.IR quota.user +(for version 1 user quota), +.IR aquota.group +(for version 2 group quota), or +.IR quota.group +(for version 1 group quota). +.PP +XFS filesystems are a special case - XFS considers quota +information as filesystem metadata and uses journaling to provide +a higher level guarantee of consistency. +There are two components to the XFS disk quota system: +accounting and limit enforcement. +XFS filesystems require that quota accounting be turned on at mount time. +It is possible to enable and disable limit enforcement on an XFS +filesystem after quota accounting is already turned on. +The default is to turn on both accounting and enforcement. +.PP +The XFS quota implementation does not maintain quota information in +user-visible files, but rather stores this information internally. +.SS quotaoff +.IX "quotaoff command" "" "\fLquotaoff\fP \(em turn filesystem quotas off" +.IX "user quotas" "quotaoff command" "" "\fLquotaoff\fP \(em turn filesystem quotas off" +.IX "disk quotas" "quotaoff command" "" "\fLquotaoff\fP \(em turn filesystem quotas off" +.IX "quotas" "quotaoff command" "" "\fLquotaoff\fP \(em turn filesystem quotas off" +.IX "filesystem" "quotaoff command" "" "\fLquotaoff\fP \(em turn filesystem quotas off" +.LP +.B quotaoff +announces to the system that the specified filesystems should +have any disk quotas turned off. +.SH OPTIONS +.SS quotaon +.TP +.B -F, --format=\f2format-name\f1 +Report quota for specified format (ie. don't perform format autodetection). +Possible format names are: +.B vfsold +Original quota format with 16-bit UIDs / GIDs, +.B vfsv0 +Quota format with 32-bit UIDs / GIDs, 64-bit space usage, 32-bit inode usage and limits, +.B vfsv1 +Quota format with 64-bit quota limits and usage, +.B xfs +(quota on XFS filesystem) +.TP +.B -a, --all +All automatically mounted (no +.B noauto +option) non-NFS filesystems in +.B /etc/fstab +with quotas will have their quotas turned on. +This is normally used at boot time to enable quotas. +.TP +.B -v, --verbose +Display a message for each filesystem where quotas are turned on. +.TP +.B -u, --user +Manipulate user quotas. This is the default. +.TP +.B -g, --group +Manipulate group quotas. +.TP +.B -P, --project +Manipulate project quotas. +.TP +.B -p, --print-state +Instead of turning quotas on just print state of quotas (ie. whether. quota is on or off) +.TP +.B -x, --xfs-command enforce +Switch on limit enforcement for XFS filesystems. This is the default action for +any XFS filesystem. This option is only applicable to XFS, and is silently +ignored for other filesystem types. +.TP +.B -f, --off +Make +.B quotaon +behave like being called as +.BR quotaoff . +.SS quotaoff +.TP +.B -F, --format=\f2format-name\f1 +Report quota for specified format (ie. don't perform format autodetection). +Possible format names are: +.B vfsold +(version 1 quota), +.B vfsv0 +(version 2 quota), +.B xfs +(quota on XFS filesystem) +.TP +.B -a, --all +Force all filesystems in +.B /etc/fstab +to have their quotas disabled. +.TP +.B -v, --verbose +Display a message for each filesystem affected. +.TP +.B -u, --user +Manipulate user quotas. This is the default. +.TP +.B -g, --group +Manipulate group quotas. +.TP +.B -P, --project +Manipulate project quotas. +.TP +.B -p, --print-state +Instead of turning quotas off just print state of quotas (ie. whether. quota is on or off) +.TP +.B -x, --xfs-command delete +Free up the space used to hold quota information (maintained +internally) within XFS. +This option is only applicable to XFS, and is silently +ignored for other filesystem types. +It can only be used on a filesystem with quota previously turned off. +.TP +.B -x, --xfs-command enforce +Switch off limit enforcement for XFS filesystems (perform quota accounting +only). This is the default action for any XFS filesystem. This option is only +applicable to XFS, and is silently ignored for other filesystem types. +.TP +.B -x, --xfs-command account +This option can be used to disable quota accounting. It is not possible to +enable quota accounting by quota tools. Use +.IR mount (8) +for that. This option is only applicable to XFS filesystems, and is silently +ignored for other filesystem types. +.SH "NOTES ON XFS FILESYSTEMS" +To enable quotas on an XFS filesystem, use +.IR mount (8) +or +.B /etc/fstab +quota option to enable both accounting and limit enforcement. +.B quotaon +utility cannot be used for this purpose. +.PP +Turning on quotas on an XFS root filesystem requires the quota mount +options be passed into the kernel at boot time through the Linux +.B rootflags +boot option. +.PP +To turn off quota limit enforcement on any XFS filesystem, first make +sure that quota accounting and enforcement are both turned on using +.B "repquota -v" +.IR filesystem . +Then, use +.B "quotaoff -v +.I filesystem +to disable limit enforcement. +This may be done while the filesystem is mounted. +.PP +Turning on quota limit enforcement on an XFS filesystem is +achieved using +.B "quotaon -v" +.IR filesystem . +This may be done while the filesystem is mounted. +.SH FILES +.PD 0 +.TP 20 +.B aquota.user or aquota.group +quota file at the filesystem root (version 2 quota, non-XFS filesystems) +.TP +.B quota.user or quota.group +quota file at the filesystem root (version 1 quota, non-XFS filesystems) +.TP +.B /etc/fstab +default filesystems +.PD +.SH "SEE ALSO" +.BR quotactl (2), +.BR fstab (5), +.BR quota_nld (8), +.BR repquota (8), +.BR warnquota (8) diff --git a/upstream/opensuse-leap-15-6/man8/quotastats.8 b/upstream/opensuse-leap-15-6/man8/quotastats.8 new file mode 100644 index 00000000..6ebfccf7 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/quotastats.8 @@ -0,0 +1,41 @@ +.\" 2004, Max Vozeler <max@hinterhof.net> +.\" Released under the Gnu GPL +.TH QUOTASTATS 8 "April 2, 2004" "" "quota" +.SH NAME +.B quotastats +\- Program to query quota statistics +.SH SYNOPSIS +.I /usr/sbin/quotastats +.SH DESCRIPTION +.B quotastats +queries the kernel for quota statistics. +It displays: +.P +.PD 0 +.RS 4 +.IP \[bu] +Supported kernel quota version +.IP \[bu] +Number of dquot lookups +.IP \[bu] +Number of dquot drops +.IP \[bu] +Number of dquot reads +.IP \[bu] +Number of dquot writes +.IP \[bu] +Number of quotafile syncs +.IP \[bu] +Number of dquot cache hits +.IP \[bu] +Number of allocated dquots +.IP \[bu] +Number of free dquots +.IP \[bu] +Number of in use dquot entries (user/group) +.RE +.PD +.SH OPTIONS +None. +.SH SEE ALSO +.BR quota (1). diff --git a/upstream/opensuse-leap-15-6/man8/readprofile.8 b/upstream/opensuse-leap-15-6/man8/readprofile.8 new file mode 100644 index 00000000..d82b9a15 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/readprofile.8 @@ -0,0 +1,190 @@ +'\" t +.\" Title: readprofile +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "READPROFILE" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +readprofile \- read kernel profiling information +.SH "SYNOPSIS" +.sp +\fBreadprofile\fP [options] +.SH "VERSION" +.sp +This manpage documents version 2.0 of the program. +.SH "DESCRIPTION" +.sp +The \fBreadprofile\fP command uses the \fI/proc/profile\fP information to print ascii data on standard output. The output is organized in three columns: the first is the number of clock ticks, the second is the name of the C function in the kernel where those many ticks occurred, and the third is the normalized `load\(aq of the procedure, calculated as a ratio between the number of ticks and the length of the procedure. The output is filled with blanks to ease readability. +.SH "OPTIONS" +.sp +\fB\-a\fP, \fB\-\-all\fP +.RS 4 +Print all symbols in the mapfile. By default the procedures with reported ticks are not printed. +.RE +.sp +\fB\-b\fP, \fB\-\-histbin\fP +.RS 4 +Print individual histogram\-bin counts. +.RE +.sp +\fB\-i\fP, \fB\-\-info\fP +.RS 4 +Info. This makes \fBreadprofile\fP only print the profiling step used by the kernel. The profiling step is the resolution of the profiling buffer, and is chosen during kernel configuration (through \fBmake config\fP), or in the kernel\(cqs command line. If the \fB\-t\fP (terse) switch is used together with \fB\-i\fP only the decimal number is printed. +.RE +.sp +\fB\-m\fP, \fB\-\-mapfile\fP \fImapfile\fP +.RS 4 +Specify a mapfile, which by default is \fI/usr/src/linux/System.map\fP. You should specify the map file on cmdline if your current kernel isn\(cqt the last one you compiled, or if you keep System.map elsewhere. If the name of the map file ends with \fI.gz\fP it is decompressed on the fly. +.RE +.sp +\fB\-M\fP, \fB\-\-multiplier\fP \fImultiplier\fP +.RS 4 +On some architectures it is possible to alter the frequency at which the kernel delivers profiling interrupts to each CPU. This option allows you to set the frequency, as a multiplier of the system clock frequency, HZ. Linux 2.6.16 dropped multiplier support for most systems. This option also resets the profiling buffer, and requires superuser privileges. +.RE +.sp +\fB\-p\fP, \fB\-\-profile\fP \fIpro\-file\fP +.RS 4 +Specify a different profiling buffer, which by default is \fI/proc/profile\fP. Using a different pro\-file is useful if you want to `freeze\(aq the kernel profiling at some time and read it later. The \fI/proc/profile\fP file can be copied using \fBcat\fP(1) or \fBcp\fP(1). There is no more support for compressed profile buffers, like in \fBreadprofile\-1.1\fP, because the program needs to know the size of the buffer in advance. +.RE +.sp +\fB\-r\fP, \fB\-\-reset\fP +.RS 4 +Reset the profiling buffer. This can only be invoked by root, because \fI/proc/profile\fP is readable by everybody but writable only by the superuser. However, you can make \fBreadprofile\fP set\-user\-ID 0, in order to reset the buffer without gaining privileges. +.RE +.sp +\fB\-s, \-\-counters\fP +.RS 4 +Print individual counters within functions. +.RE +.sp +\fB\-v\fP, \fB\-\-verbose\fP +.RS 4 +Verbose. The output is organized in four columns and filled with blanks. The first column is the RAM address of a kernel function, the second is the name of the function, the third is the number of clock ticks and the last is the normalized load. +.RE +.sp +\fB\-V\fP, \fB\-\-version\fP +.RS 4 +Display version information and exit. +.RE +.sp +\fB\-h\fP, \fB\-\-help\fP +.RS 4 +Display help text and exit. +.RE +.SH "FILES" +.sp +\fI/proc/profile\fP +.RS 4 +A binary snapshot of the profiling buffer. +.RE +.sp +\fI/usr/src/linux/System.map\fP +.RS 4 +The symbol table for the kernel. +.RE +.sp +\fI/usr/src/linux/*\fP +.RS 4 +The program being profiled :\-) +.RE +.SH "BUGS" +.sp +\fBreadprofile\fP only works with a 1.3.x or newer kernel, because \fI/proc/profile\fP changed in the step from 1.2 to 1.3. +.sp +This program only works with ELF kernels. The change for a.out kernels is trivial, and left as an exercise to the a.out user. +.sp +To enable profiling, the kernel must be rebooted, because no profiling module is available, and it wouldn\(cqt be easy to build. To enable profiling, you can specify \fBprofile\fP=\fI2\fP (or another number) on the kernel commandline. The number you specify is the two\-exponent used as profiling step. +.sp +Profiling is disabled when interrupts are inhibited. This means that many profiling ticks happen when interrupts are re\-enabled. Watch out for misleading information. +.SH "EXAMPLE" +.sp +Browse the profiling buffer ordering by clock ticks: +.sp +.if n .RS 4 +.nf +.fam C + readprofile | sort \-nr | less +.fam +.fi +.if n .RE +.sp +Print the 20 most loaded procedures: +.sp +.if n .RS 4 +.nf +.fam C + readprofile | sort \-nr +2 | head \-20 +.fam +.fi +.if n .RE +.sp +Print only filesystem profile: +.sp +.if n .RS 4 +.nf +.fam C + readprofile | grep _ext2 +.fam +.fi +.if n .RE +.sp +Look at all the kernel information, with ram addresses: +.sp +.if n .RS 4 +.nf +.fam C + readprofile \-av | less +.fam +.fi +.if n .RE +.sp +Browse a \(aqfrozen\(aq profile buffer for a non current kernel: +.sp +.if n .RS 4 +.nf +.fam C + readprofile \-p ~/profile.freeze \-m /zImage.map.gz +.fam +.fi +.if n .RE +.sp +Request profiling at 2kHz per CPU, and reset the profiling buffer: +.sp +.if n .RS 4 +.nf +.fam C + sudo readprofile \-M 20 +.fam +.fi +.if n .RE +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBreadprofile\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/reiserfsck.8 b/upstream/opensuse-leap-15-6/man8/reiserfsck.8 new file mode 100644 index 00000000..a3f87a8e --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/reiserfsck.8 @@ -0,0 +1,206 @@ +.\" -*- nroff -*- +.\" Copyright 1996-2004 Hans Reiser. +.\" +.TH REISERFSCK 8 "January 2009" "Reiserfsprogs-3.6.27" +.SH NAME +reiserfsck \- The checking tool for the ReiserFS filesystem. +.SH SYNOPSIS +.B reiserfsck +[ \fB-aprVy\fR ] +[ \fB--rebuild-sb\fR | \fB--check\fR | \fB--fix-fixable\fR +| \fB--rebuild-tree\fR | \fB--clean-attributes\fR ] +.\" [ \fB-i\fR | \fB--interactive\fR ] +[ \fB-j\fR | \fB--journal\fR \fIdevice\fR ] +[ \fB-z\fR | \fB--adjust-size\fR ] +[ \fB-n\fR | \fB--nolog\fR ] +[ \fB-B\fR | \fB--badblocks \fIfile\fR ] +[ \fB-l\fR | \fB--logfile \fIfile\fR ] +[ \fB-q\fR | \fB--quiet\fR ] +[ \fB-y\fR | \fB--yes\fR ] +[ \fB-f\fR | \fB--force\fR ] +.\" [ \fB-b\fR | \fB--scan-marked-in-bitmap \fIbitmap-filename\fR ] +.\" [ \fB-h\fR | \fB--hash \fIhash-name\fR ] +.\" [ \fB-g\fR | \fB--background\fR ] +[ \fB-S\fR | \fB--scan-whole-partition\fR ] +[ \fB--no-journal-available\fR ] +.I device +.SH DESCRIPTION +\fBReiserfsck\fR searches for a Reiserfs filesystem on a device, replays +any necessary transactions, and either checks or repairs the file system. +.TP +.I device +is the special file corresponding to a device or to a partition (e.g +/dev/hdXX for an IDE disk partition or /dev/sdXX for a SCSI disk partition). +.SH OPTIONS +.TP +.B --rebuild-sb +This option recovers the superblock on a Reiserfs partition. Normally you +only need this option if mount reports "read_super_block: can't find +a reiserfs file system" and you are sure that a Reiserfs file system is +there. But remember that if you have used some partition editor program and +now you cannot find a filesystem, probably something has gone wrong while +repartitioning and the start of the partition has been changed. If so, +instead of rebuilding the super block on a wrong place you should find the +correct start of the partition first. +.TP +.B --check +This default action checks filesystem consistency and reports, but +does not repair any corruption that it finds. This option may be +used on a read-only file system mount. +.TP +.B --fix-fixable +This option recovers certain kinds of corruption that do not require +rebuilding the entire file system tree (\fB--rebuild-tree\fR). Normally +you only need this option if the \fB--check\fR option reports +"corruption that can be fixed with \fB--fix-fixable\fR". This includes: +zeroing invalid data-block pointers, correcting st_size and st_blocks +for directories, and deleting invalid directory entries. +.TP +.B --rebuild-tree +This option rebuilds the entire filesystem tree using leaf nodes +found on the device. Normally you only need this option if the +\fBreiserfsck \-\-check\fR reports "Running with \fB\-\-rebuild-tree\fR +is required". You are strongly encouraged to make a backup copy +of the whole partition before attempting the \fB--rebuild-tree\fR +option. Once \fBreiserfsck \-\-rebuild-tree\fR is started it must +finish its work (and you should not interrupt it), otherwise the +filesystem will be left in the unmountable state to avoid subsequent +data corruptions. +.TP +.B --clean-attributes +This option cleans reserved fields of Stat-Data items. There were days when +there were no extended attributes in reiserfs. When they were implemented old +partitions needed to be cleaned first -- reiserfs code in the kernel did not +care about not used fields in its strutures. Thus if you have used one of the +old (pre-attrbutes) kernels with a ReiserFS filesystem and you want to use +extented attribues there, you should clean the filesystem first. +.TP +.B \fB--journal \fIdevice \fR, \fB-j \fIdevice \fR +This option supplies the device name of the current file system journal. +This option is required when the journal resides on a separate device +from the main data device (although it can be avoided with the expert +option \fB--no-journal-available\fR). +.TP +.\" .B --interactive, -i +.\" This makes \fBreiserfsck\fR to stop after each pass completed. +.\" .TP +.B --adjust-size, -z +This option causes \fBreiserfsck\fR to correct file sizes that +are larger than the offset of the last discovered byte. This +implies that holes at the end of a file will be removed. File +sizes that are smaller than the offset of the last discovered +byte are corrected by \fB--fix-fixable\fR. +.TP +\fB--badblocks \fIfile\fR, \fB-B \fI file\fR +This option sets the badblock list to be the list of blocks specified in +the given `file`. The filesystem badblock list is cleared before the new +list is added. It can be used with \fB--fix-fixable\fR to fix the list of +badblocks (see \fBdebugreiserfs \-B\fR). If the device has bad blocks, every +time it must be given with the \fB--rebuild-tree\fR option. +.TP +\fB--logfile \fIfile\fR, \fB-l \fI file\fR +This option causes \fBreiserfsck\fR to report any corruption it finds +to the specified log file rather than to stderr. +.TP +.B --nolog, -n +This option prevents \fBreiserfsck\fR from reporting any kinds of corruption. +.TP +.B --quiet, -q +This option prevents \fBreiserfsck\fR from reporting its rate of progress. +.TP +.B --yes, -y +This option inhibits \fBreiserfsck\fR from asking you for confirmation after +telling you what it is going to do. It will assuem you confirm. For safety, +it does not work with the \fB--rebuild-tree\fR option. +.TP +\fB-a\fR, \fB-p\fR +These options are usually passed by fsck \-A during the automatic checking +of those partitions listed in /etc/fstab. These options cause \fBreiserfsck\fR +to print some information about the specified filesystem, to check if error +flags in the superblock are set and to do some light-weight checks. If these +checks reveal a corruption or the flag indicating a (possibly fixable) +corruption is found set in the superblock, then \fBreiserfsck\fR switches +to the fix-fixable mode. If the flag indicating a fatal corruption is found +set in the superblock, then \fBreiserfsck\fR finishes with an error. +.TP +.B --force, -f +Force checking even if the file system seems clean. +.TP +.B -V +This option prints the reiserfsprogs version and then exit. +.TP +.B -r +This option does nothing at all; it is provided only for +backwards compatibility. +.SH EXPERT OPTIONS +DO NOT USE THESE OPTIONS UNLESS YOU KNOW WHAT YOU ARE DOING. +WE ARE NOT RESPONSIBLE IF YOU LOSE DATA AS A RESULT OF THESE +OPTIONS. +.TP +.B \fB\--no-journal-available\fR +This option allows \fBreiserfsck\fR to proceed when the journal device is +not available. This option has no effect when the journal is located on +the main data device. NOTE: after this operation you must use \fBreiserfstune\fR +to specify a new journal device. +.TP +.B --scan-whole-partition, -S +This option causes \fB--rebuild-tree\fR to scan the whole partition but not only +the used space on the partition. +.SH AN EXAMPLE OF USING reiserfsck +1. You think something may be wrong with a reiserfs partition on /dev/hda1 +or you would just like to perform a periodic disk check. + +2. Run \fBreiserfsck \-\-check \-\-logfile check.log /dev/hda1\fR. If \fBreiserfsck +\-\-check\fR exits with status 0 it means no errors were discovered. + +3. If \fBreiserfsck \-\-check\fR exits with status 1 (and reports about fixable +corruptions) it means that you should run \fBreiserfsck \-\-fix-fixable \-\-logfile +fixable.log /dev/hda1\fR. + +4. If \fBreiserfsck \-\-check\fR exits with status 2 (and reports about fatal +corruptions) it means that you need to run \fBreiserfsck \-\-rebuild\-tree\fR. +If \fBreiserfsck \-\-check\fR fails in some way you should also run \fBreiserfsck +\-\-rebuild-tree\fR, but we also encourage you to submit this as a bug report. + +5. Before running \fBreiserfsck \-\-rebuild-tree\fR, please make a backup of +the whole partition before proceeding. Then run \fBreiserfsck \-\-rebuild-tree +\-\-logfile rebuild.log /dev/hda1\fR. + +6. If the \fBreiserfsck \-\-rebuild-tree\fR step fails or does not recover what +you expected, please submit this as a bug report. Try to provide as much +information as possible including your platform and Linux kernel version. We +will try to help solve the problem. +.SH EXIT CODES +\fBreiserfsck\fR uses the following exit codes: +.br +\ \fI0\fR \-\ No errors. +.br +\ \fI1\fR \-\ File system errors corrected. +.br +\ \fI2\fR \-\ Reboot is needed. +.br +\ \fI4\fR \-\ File system fatal errors left uncorrected, +.br +\ \fBreiserfsck \-\-rebuild-tree\fR needs to be launched. +.br +\ \fI6\fR \-\ File system fixable errors left uncorrected, +.br +\ \fBreiserfsck \-\-fix-fixable\fR needs to be launched. +.br +\ \fI8\fR \-\ Operational error. +.br +\ \fI16\fR \-\ Usage or syntax error. +.br +.SH AUTHOR +This version of \fBreiserfsck\fR has been written by Vitaly Fertman <vitaly@namesys.com>. +.SH BUGS +Please report bugs to the ReiserFS developers <reiserfs-devel@vger.kernel.org>, providing +as much information as possible--your hardware, kernel, patches, settings, all printed +messages, the logfile; check the syslog file for any related information. +.SH TODO +Faster recovering, signal handling. +.SH SEE ALSO +.BR mkreiserfs (8), +.BR reiserfstune (8) +.BR resize_reiserfs (8), +.BR debugreiserfs (8), diff --git a/upstream/opensuse-leap-15-6/man8/reiserfstune.8 b/upstream/opensuse-leap-15-6/man8/reiserfstune.8 new file mode 100644 index 00000000..0f4d2388 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/reiserfstune.8 @@ -0,0 +1,238 @@ +.\" -*- nroff -*- +.\" Copyright 1996-2004 Hans Reiser. +.\" +.TH REISERFSTUNE 8 "January 2009" "Reiserfsprogs-3.6.27" +.SH NAME +reiserfstune \- The tunning tool for the ReiserFS filesystem. +.SH SYNOPSIS +.B reiserfstune +[ \fB-f\fR ] +[ \fB-h\fR | \fB--help\fR ] +[ \fB-j\fR | \fB--journal-device\fR \fIFILE\fR ] +[ \fB--no-journal-available\fR ] +[ \fB--journal-new-device\fR \fIFILE\fR ] [ \fB--make-journal-standard\fR ] +[ \fB-s\fR | \fB--journal-new-size\fR \fIN\fR ] +[ \fB-o\fR | \fB--journal-new-offset\fR \fIN\fR ] +[ \fB-t\fR | \fB--max-transaction-size\fR \fIN\fR ] +[ \fB-b\fR | \fB--add-badblocks\fR \fIfile\fR ] +[ \fB-B\fR | \fB--badblocks\fR \fIfile\fR ] +[ \fB-u\fR | \fB--uuid \fIUUID\fR ] +[ \fB-l\fR | \fB--label \fILABEL\fR ] +[ \fB-c\fR | \fB--check-interval \fIinterval-in-days\fR ] +[ \fB-C\fR | \fB--time-last-checked \fItimestamp\fR ] +[ \fB-m\fR | \fB--max-mnt-count \fIcount\fR ] +[ \fB-M\fR | \fB--mnt-count \fIcount\fR ] +.I device +.SH DESCRIPTION +\fBreiserfstune\fR is used for tuning the ReiserFS. It can change two journal +parameters (the journal size and the maximum transaction size), and it can move +the journal's location to a new specified block device. (The old ReiserFS's +journal may be kept unused, or discarded at the user's option.) Besides that +\fBreiserfstune\fR can store the bad block list to the ReiserFS and set UUID +and LABEL. +Note: At the time of writing the relocated journal was implemented for a special +release of ReiserFS, and was not expected to be put into the mainstream kernel +until approximately Linux 2.5. This means that if you have the stock kernel you +must apply a special patch. Without this patch the kernel will refuse to mount +the newly modified file system. We will charge $25 to explain this to you if +you ask us why it doesn't work. +.PP +Perhaps the most interesting application of this code is to put the +journal on a solid state disk. +.TP +\fIdevice +is the special file corresponding to the newly specified block device (e.g +/dev/hdXX for IDE disk partition or /dev/sdXX for the SCSI disk partition). +.SH OPTIONS +.TP +\fB-h\fR | \fB--help\fR +Print usage information and exit. +.TP +\fB-j\fR | \fB--journal-device\fR \fIFILE +\fIFILE\fR is the file name of the block device the file system has +the current journal (the one prior to running reiserfstune) on. This option is required when the journal is +already on a separate device from the main data device (although it +can be avoided with \fB--no-journal-available\fR). If you don't +specify journal device by this option, reiserfstune suppose that +journal is on main device. +.TP +\fB--no-journal-available +allows \fBreiserfstune\fR to continue when the current journal's block +device is no longer available. This might happen if a disk goes bad +and you remove it (and run fsck). +.TP +\fB--journal-new-device \fIFILE +\fIFILE\fR is the file name of the block device which will contain the +new journal for the file system. If you don't specify this, +reiserfstune supposes that journal device remains the same. +.TP +\fB \-s\fR | \fB\--journal-new-size \fIN +\fIN\fR is the size parameter for the new journal. When journal is to +be on a separate device - its size defaults to number of blocks that +device has. When journal is to be on the same device as the filesytem - its size defaults +to amount of blocks allocated for journal by \fImkreiserfs\fR when it +created the filesystem. Minimum is 513 for +both cases. +.TP +\fB \-o\fR | \fB\--journal-new-offset \fIN +\fIN\fR is an offset in blocks where journal will starts from when journal is to +be on a separate device. Default is 0. Has no effect when journal is +to be on the same device as the filesystem. Most users have no need +to use this feature. It can be used when you want the journals from +multiple filesystems to reside on the same device, and you don't want +to or cannot partition that device. +.TP +\fB \-t\fR | \fB\--maximal-transaction-size \fIN +\fIN\fR is the maximum transaction size parameter for the new +journal. The default, and max possible, value is 1024 blocks. It +should be less than half the size of the journal. If specifed +incorrectly, it will be adjusted. +.TP +\fB \-b\fR | \fB\--add-badblocks\fR \fIfile\fR +\fIFile\fR is the file name of the file that contains the list of blocks to be marked +as bad on the fs. The list is added to the fs list of bad blocks. +.TP +\fB \-B\fR | \fB\--badblocks\fR \fIfile\fR +\fIFile\fR is the file name of the file that contains the list of blocks to be marked +as bad on the fs. The bad block list on the fs is cleared before the list specified +in the \fIFile\fR is added to the fs. +.TP +\fB\-f\fR | \fB--force\fR +Normally \fBreiserfstune\fR will refuse to change a journal of a +file system that was created before this journal relocation code. This +is because if you change the journal, you cannot go back (without special +option \fB--make-journal-standard\fR) to an old kernel that lacks this feature and be able to use your filesytem. This option forces it to do that. Specified more +than once it allows to avoid asking for confirmation. +.TP +\fB--make-journal-standard\fR +As it was mentioned above, if your file system has non-standard journal, +it can not be mounted on the kernel without journal relocation +code. The thing can be changed, the only condition is that there is reserved +area on main device of the standard journal size 8193 blocks (it will be so for +instance if you convert standard journal to non-standard). Just +specify this option when you relocate journal back, or without relocation +if you already have it on main device. +.TP +\fB-u\fR | \fB--uuid \fIUUID\fR +Set the universally unique identifier (\fB UUID \fR) of the filesystem to +\fIUUID\fR (see also \fBuuidgen(8)\fR). The format of the UUID is a +series of hex digits separated by hypthens, like this: +"c1b9d5a2-f162-11cf-9ece-0020afc76f16". +.TP +\fB-l\fR | \fB--label \fILABEL\fR +Set the volume label of the filesystem. \fILABEL\fR can be at most 16 +characters long; if it is longer than 16 characters, reiserfstune will truncate it. +.TP +\fB-c\fR | \fB--check-interval \fIinterval-in-days\fR +Adjust the maximal time between two filesystem checks. A value of "disable" +will disable the time-dependent checking. A value of "default" will restore +the compile-time default. + +It is strongly recommended that either +.B \-m +(mount-count dependent) or +.B \-c +(time-dependent) checking be enabled to force periodic full +.BR fsck.reiserfs(8) +checking of the filesystem. Failure to do so may lead to +filesystem corruption (due to bad disks, cables, memory, or kernel bugs) +going unnoticed, ultimately resulting in data loss or corruption. +.TP +\fB-C\fR | \fB--time-last-checked \fItimestamp\fR +Set the time the filesystem was last checked using fsck.reiserfs. This +can be useful in scripts which use a Logical Volume Manager to make a +consistent snapshot of a filesystem, and then check the filesystem during +off hours to make sure it hasn't been corrupted due to hardware problems, +etc. If the filesystem was clean, then this option can be used to set the +last checked time on the original filesystem. The format of time-last-checked +is the international date format, with an optional time specifier, i.e. +YYYYMMDD[HH[MM[SS]]]. The keyword +.B now +is also accepted, in which case the +last checked time will be set to the current time. +.TP +\fB-m\fR | \fB--max-mnt-count \fImax-mount-count\fR +Adjust the number of mounts after which the filesystem will be +checked by +.BR fsck.reiserfs(8). +If max-mount-count is "disable", the number of times the filesystem +is mounted will be disregarded by +.BR fsck.reiserfs(8) +and the kernel. A value of "default" will restore the compile-time default. + +Staggering the mount-counts at which filesystems are forcibly +checked will avoid all filesystems being checked at one time +when using journaled filesystems. + +You should strongly consider the consequences of disabling +mount-count-dependent checking entirely. Bad disk drives, +cables, memory, and kernel bugs could all corrupt a filesystem +without marking the filesystem dirty or in error. If you are +using journaling on your filesystem, your filesystem will never +be marked dirty, so it will not normally be checked. A filesys‐ +tem error detected by the kernel will still force an fsck on the +next reboot, but it may already be too late to prevent data loss +at that point. + +This option requires a kernel which supports incrementing the +count on each mount. This feature has not been incorporated into +kernel versions older than 2.6.25. + +See also the +.B \-c +option for time-dependent checking. +.TP +\fB-M\fR | \fB--mnt-count \fIcount\fR +Set the number of times the filesystem has been mounted. If set +to a greater value than the max-mount-counts parameter set by +the +.B \-m +option, +.BR fsck.reiserfs(8) +will check the filesystem at the next +reboot. +.SH POSSIBLE SCENARIOS OF USING REISERFSTUNE: +1. You have ReiserFS on /dev/hda1, and you wish to have +it working with its journal on the device /dev/journal +.nf +.IP +boot kernel patched with special "relocatable journal support" patch +reiserfstune /dev/hda1 \-\-journal\-new\-device /dev/journal \-f +mount /dev/hda1 and use. +You would like to change max transaction size to 512 blocks +reiserfstune \-t 512 /dev/hda1 +You would like to use your file system on another kernel that doesn't +contain relocatable journal support. +umount /dev/hda1 +reiserfstune /dev/hda1 \-j /dev/journal \-\-journal\-new\-device /dev/hda1 \-\-make\-journal\-standard +mount /dev/hda1 and use. +.LP +2. You would like to have ReiserFS on /dev/hda1 and to be able to +switch between different journals including journal located on the +device containing the filesystem. +.nf +.IP +boot kernel patched with special "relocatable journal support" patch +mkreiserfs /dev/hda1 +you got solid state disk (perhaps /dev/sda, they typically look like scsi disks) +reiserfstune \-\-journal\-new\-device /dev/sda1 \-f /dev/hda1 +Your scsi device dies, it is three in the morning, you have an extra IDE device +lying around +reiserfsck \-\-no\-journal\-available /dev/hda1 +or +reiserfsck \-\-rebuild-tree \-\-no\-journal\-available /dev/hda1 +reiserfstune \-\-no\-journal\-available \-\-journal\-new\-device /dev/hda1 /dev/hda1 +using /dev/hda1 under patched kernel +.SH AUTHOR +This version of \fBreiserfstune\fR has been written by Vladimir +Demidov <vova@namesys.com> and Edward Shishkin <edward@namesys.com>. +.SH BUGS +Please report bugs to the ReiserFS developers <reiserfs-devel@vger.kerne.org>, providing +as much information as possible--your hardware, kernel, patches, settings, all printed +messages; check the syslog file for any related information. +.SH SEE ALSO +.BR reiserfsck (8), +.BR debugreiserfs (8), +.BR mkreiserfs (8) + + diff --git a/upstream/opensuse-leap-15-6/man8/repquota.8 b/upstream/opensuse-leap-15-6/man8/repquota.8 new file mode 100644 index 00000000..61af898f --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/repquota.8 @@ -0,0 +1,177 @@ +.TH REPQUOTA 8 +.UC 4 +.SH NAME +repquota \- summarize quotas for a filesystem +.SH SYNOPSIS +.B /usr/sbin/repquota +[ +.B \-vspiugP +] [ +.B \-c +| +.B \-C +] [ +.B \-t +| +.B \-n +] [ +.B \-F +.I format-name +] +.IR filesystem .\|.\|. +.LP +.B /usr/sbin/repquota +[ +.B \-avtpsiugP +] [ +.B \-c +| +.B \-C +] [ +.B \-t +| +.B \-n +] [ +.B \-F +.I format-name +] +.SH DESCRIPTION +.IX "repquota command" "" "\fLrepquota\fP \(em summarize quotas" +.IX "user quotas" "repquota command" "" "\fLrepquota\fP \(em summarize quotas" +.IX "disk quotas" "repquota command" "" "\fLrepquota\fP \(em summarize quotas" +.IX "quotas" "repquota command" "" "\fLrepquota\fP \(em summarize quotas" +.IX "filesystem" "repquota command" "" "\fLrepquota\fP \(em summarize quotas" +.IX "summarize filesystem quotas repquota" "" "summarize filesystem quotas \(em \fLrepquota\fP" +.IX "report filesystem quotas repquota" "" "report filesystem quotas \(em \fLrepquota\fP" +.IX display "filesystem quotas \(em \fLrepquota\fP" +.LP +.B repquota +prints a summary of the disc usage and quotas for the specified file +systems. For each user the current number of files and amount of space +(in kilobytes) is printed, along with any quota limits set with +.BR edquota (8) +or +.BR setquota (8). +In the second column repquota prints two characters marking which limits are +exceeded. If user is over his space softlimit or reaches his space hardlimit in +case softlimit is unset, the first character is '+'. Otherwise the character +printed is '-'. The second character denotes the state of inode usage +analogously. + +.B repquota +has to translate ids of all users/groups/projects to names (unless option +.B -n +was specified) so it may take a while to +print all the information. To make translating as fast as possible +.B repquota +tries to detect (by reading +.BR /etc/nsswitch.conf ) +whether entries are stored in standard plain text file or in a database and either +translates chunks of 1024 names or each name individually. You can override this +autodetection by +.B -c +or +.B -C +options. +.SH OPTIONS +.TP +.B -a, --all +Report on all filesystems indicated in +.B /etc/mtab +to be read-write with quotas. +.TP +.B -v, --verbose +Report all quotas, even if there is no usage. Be also more verbose about quotafile +information. +.TP +.B -c, --cache +Cache entries to report and translate uids/gids to names in big chunks by scanning +all users (default). This is good (fast) behaviour when using /etc/passwd file. +.TP +.B -C, --no-cache +Translate individual entries. This is faster when you have users stored in database. +.TP +.B -t, --truncate-names +Truncate user/group names longer than 9 characters. This results in nicer output when +there are such names. +.TP +.B -n, --no-names +Don't resolve UIDs/GIDs to names. This can speedup printing a lot. +.TP +.B -s, --human-readable[=\f2units\f1] +Try to report used space, number of used inodes and limits in more appropriate +units than the default ones. Units can be also specified explicitely by an +optional argument in format [ +.BR kgt +],[ +.BR kgt +] where the first character specifies space units and the second character +specifies inode units. +.TP +.B -p, --raw-grace +When user is in grace period, report time in seconds since epoch when his grace +time runs out (or has run out). Field is '0' when no grace time is in effect. +This is especially useful when parsing output by a script. +.TP +.B -i, --no-autofs +Ignore mountpoints mounted by automounter. +.TP +.B \-F, --format=\f2format-name\f1 +Report quota for specified format (ie. don't perform format autodetection). +Possible format names are: +.B vfsold +Original quota format with 16-bit UIDs / GIDs, +.B vfsv0 +Quota format with 32-bit UIDs / GIDs, 64-bit space usage, 32-bit inode usage and limits, +.B vfsv1 +Quota format with 64-bit quota limits and usage, +.B xfs +(quota on XFS filesystem) +.TP +.B -g, --group +Report quotas for groups. +.TP +.B -P, --project +Report quotas for projects. +.TP +.B -u, --user +Report quotas for users. This is the default. +.TP +.B -O, --output=\f2format-name\f1 +Output quota report in the specified format. +Possible format names are: +.B default +The default format, optimized for console viewing +.B csv +Comma-separated values, a text file with the columns delimited by commas +.B xml +Output is XML encoded, useful for processing with XSLT +.LP +Only the super-user may view quotas which are not their own. +.SH FILES +.PD 0 +.TP 20 +.BR aquota.user " or " aquota.group +quota file at the filesystem root (version 2 quota, non-XFS filesystems) +.TP +.BR quota.user " or " quota.group +quota file at the filesystem root (version 1 quota, non-XFS filesystems) +.TP +.B /etc/mtab +default filesystems +.TP +.B /etc/passwd +default set of users +.TP +.B /etc/group +default set of groups +.PD +.SH SEE ALSO +.BR quota (1), +.BR quotactl (2), +.BR edquota (8), +.BR quotacheck (8), +.BR quotaon (8), +.BR quota_nld (8), +.BR setquota (8), +.BR warnquota (8) diff --git a/upstream/opensuse-leap-15-6/man8/resize2fs.8 b/upstream/opensuse-leap-15-6/man8/resize2fs.8 new file mode 100644 index 00000000..52c9e848 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/resize2fs.8 @@ -0,0 +1,181 @@ +.\" -*- nroff -*- +.\" Copyright 1997 by Theodore Ts'o. All Rights Reserved. +.\" +.\" .TH RESIZE2FS 8 "February 2023" "E2fsprogs version 1.47.0" +.TH RESIZE2FS 8 "February 2023" "E2fsprogs version 1.47.0" +.SH NAME +resize2fs \- ext2/ext3/ext4 file system resizer +.SH SYNOPSIS +.B resize2fs +[ +.B \-fFpPMbs +] +[ +.B \-d +.I debug-flags +] +[ +.B \-S +.I RAID-stride +] +[ +.B \-z +.I undo_file +] +.I device +[ +.I size +] +.SH DESCRIPTION +The +.B resize2fs +program will resize ext2, ext3, or ext4 file systems. It can be used to +enlarge or shrink an unmounted file system located on +.IR device . +If the file system is mounted, it can be used to expand the size of the +mounted file system, assuming the kernel and the file system supports +on-line resizing. (Modern Linux 2.6 kernels will support on-line resize +for file systems mounted using ext3 and ext4; ext3 file systems will +require the use of file systems with the resize_inode feature enabled.) +.PP +The +.I size +parameter specifies the requested new size of the file system. +If no units are specified, the units of the +.I size +parameter shall be the file system blocksize of the file system. +Optionally, the +.I size +parameter may be suffixed by one of the following units +designators: 'K', 'M', 'G', 'T' (either upper-case or lower-case) or 's' +for power-of-two kilobytes, megabytes, gigabytes, terabytes or 512 byte +sectors respectively. The +.I size +of the file system may never be larger than the size of the partition. +If +.I size +parameter is not specified, it will default to the size of the partition. +.PP +The +.B resize2fs +program does not manipulate the size of partitions. If you wish to enlarge +a file system, you must make sure you can expand the size of the +underlying partition first. This can be done using +.BR fdisk (8) +by deleting the partition and recreating it with a larger size or using +.BR lvextend (8), +if you're using the logical volume manager +.BR lvm (8). +When +recreating the partition, make sure you create it with the same starting +disk cylinder as before! Otherwise, the resize operation will +certainly not work, and you may lose your entire file system. +After running +.BR fdisk (8), +run resize2fs to resize the ext2 file system +to use all of the space in the newly enlarged partition. +.PP +If you wish to shrink an ext2 partition, first use +.B resize2fs +to shrink the size of file system. Then you may use +.BR fdisk (8) +to shrink the size of the partition. When shrinking the size of +the partition, make sure you do not make it smaller than the new size +of the ext2 file system! +.PP +The +.B \-b +and +.B \-s +options enable and disable the 64bit feature, respectively. The resize2fs +program will, of course, take care of resizing the block group descriptors +and moving other data blocks out of the way, as needed. It is not possible +to resize the file system concurrent with changing the 64bit status. +.SH OPTIONS +.TP +.B \-b +Turns on the 64bit feature, resizes the group descriptors as necessary, and +moves other metadata out of the way. +.TP +.B \-d \fIdebug-flags +Turns on various resize2fs debugging features, if they have been compiled +into the binary. +.I debug-flags +should be computed by adding the numbers of the desired features +from the following list: +.br + 2 \-\ Debug block relocations +.br + 4 \-\ Debug inode relocations +.br + 8 \-\ Debug moving the inode table +.br + 16 \-\ Print timing information +.br + 32 \-\ Debug minimum file system size (\-M) calculation +.TP +.B \-f +Forces resize2fs to proceed with the file system resize operation, overriding +some safety checks which resize2fs normally enforces. +.TP +.B \-F +Flush the file system device's buffer caches before beginning. Only +really useful for doing +.B resize2fs +time trials. +.TP +.B \-M +Shrink the file system to minimize its size as much as possible, +given the files stored in the file system. +.TP +.B \-p +Print out percentage completion bars for each +.B resize2fs +phase during an offline (non-trivial) resize operation, so that the user +can keep track of what the program is doing. (For very fast resize +operations, no progress bars may be displayed.) +.TP +.B \-P +Print an estimate of the number of file system blocks in the file system +if it is shrunk using +.BR resize2fs 's +.B \-M +option and then exit. +.TP +.B \-s +Turns off the 64bit feature and frees blocks that are no longer in use. +.TP +.B \-S \fIRAID-stride +The +.B resize2fs +program will heuristically determine the RAID stride that was specified +when the file system was created. This option allows the user to +explicitly specify a RAID stride setting to be used by resize2fs instead. +.TP +.BI \-z " undo_file" +Before overwriting a file system block, write the old contents of the block to +an undo file. This undo file can be used with e2undo(8) to restore the old +contents of the file system should something go wrong. If the empty string is +passed as the undo_file argument, the undo file will be written to a file named +resize2fs-\fIdevice\fR.e2undo in the directory specified via the +\fIE2FSPROGS_UNDO_DIR\fR environment variable. + +WARNING: The undo file cannot be used to recover from a power or system crash. +.SH KNOWN BUGS +The minimum size of the file system as estimated by resize2fs may be +incorrect, especially for file systems with 1k and 2k blocksizes. +.SH AUTHOR +.B resize2fs +was written by Theodore Ts'o <tytso@mit.edu>. +.SH COPYRIGHT +Resize2fs is Copyright 1998 by Theodore Ts'o and PowerQuest, Inc. All +rights reserved. +As of April, 2000 +.B Resize2fs +may be redistributed under the terms of the GPL. +.SH SEE ALSO +.BR fdisk (8), +.BR e2fsck (8), +.BR mke2fs (8), +.BR lvm (8), +.BR lvextend (8) diff --git a/upstream/opensuse-leap-15-6/man8/resize_reiserfs.8 b/upstream/opensuse-leap-15-6/man8/resize_reiserfs.8 new file mode 100644 index 00000000..7be494d1 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/resize_reiserfs.8 @@ -0,0 +1,122 @@ +.\" -*- nroff -*- +.\" Copyright 1996-2004 Hans Reiser. +.\" +.TH RESIZE_REISERFS 8 "January 2009" "Reiserfsprogs-3.6.27" +.SH NAME +resize_reiserfs \- resizer tool for the ReiserFS filesystem +.SH SYNOPSIS +.BR resize_reiserfs +[ +.B \-s +.IR \fR[\fB+\fR|\fB\- ]\fIsize\fB[\fBK\fR|\fBM\fR|\fBG\fR] +] [ +.B \-j +.IR \fR\fIdev +] [ +.B \-fqv +] +.I device +.SH DESCRIPTION +The +.B resize_reiserfs +tool resizes an unmounted reiserfs file system. It enlarges or shrinks an +reiserfs file system located on a +.I device +so that it will have +.I size +bytes or size=old_size +(\-) +.I size +bytes if the + or \- prefix is used. +If the +.B \-s +option is not specified, the filesystem will be resized to fill the +given device. +The +.I size +parameter may have one of the optional modifiers +.BR K ", " M ", " G , +which means the +.I size +parameter is given in kilo\-, mega\-, gigabytes respectively. +.PP +The +.B resize_reiserfs +program does not manipulate the size of the device. If you wish to +enlarge a filesystem, you must make sure you expand the underlying +device first. This can be done using +.BR cfdisk (8) +for partitions, by deleting the partition and recreating it with a +larger size (assuming there is free space +.I after +the partition in question). Make sure you re\-create it with the +same starting disk cylinder as before! Otherwise, the resize operation +will certainly not work, and you may lose your entire filesystem. +.PP +The +.B resize_reiserfs +program allows to grow a reiserfs on-line if there is a free +space on block +.I device. + +.PP +If you wish to shrink a reiserfs partition, first use +.B resize_reiserfs +to shrink the file system. You may then use +.BR cfdisk (8) +to shrink the device. When shrinking the size of the device, make sure +you do not make it smaller than the reduced size of the reiserfs filesystem. + +.SH OPTIONS +.TP +.BR \-s\ [+|\-]\fIsize +Set the new size in bytes. +.TP +.BR \-j\ \fIdev +Set the journal device name. +.TP +.BR \-f +Force, do not perform checks. +.TP +.BR \-q +Do not print anything but error messages. +.TP +.BR \-v +Turn on extra progress status messages (default). + +.SH RETURN VALUES +0 Resizing successful. +.TP +\-1 Resizing not successful. + +.SH EXAMPLES +The following example shows how to test +.B resize_reiserfs\fR. +Suppose 2Gb reiserfs filesystem is created on the device /dev/hda8 +and is mounted on /mnt. +For shrinking the device we need to unmount it first, then run +.B resize_reiserfs +with a +.I size \fR parameter (in this case -1Gb): +.PP +\ df +.br +\ umount /mnt +.br +\ resize_reiserfs \-s \-1G /dev/hda8 +.br +\ mount /dev/hda8 /mnt +.br +\ df /mnt + +.SH AUTHOR +This version of +.B resize_reiserfs +has been written by Alexander Zarochentcev <zam@namesys.com>. +.SH BUGS +Please report bugs to the ReiserFS developers <reiserfs-devel@vger.kernel.org>, providing +as much information as possible--your hardware, kernel, patches, settings, all printed +messages; check the syslog file for any related information. +.SH SEE ALSO +.BR cfdisk (8), +.BR reiserfsck (8), +.BR debugreiserfs (8) diff --git a/upstream/opensuse-leap-15-6/man8/resizecons.8 b/upstream/opensuse-leap-15-6/man8/resizecons.8 new file mode 100644 index 00000000..2955f3b9 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/resizecons.8 @@ -0,0 +1,70 @@ +.\" @(#)man/man8/resizecons.8 1.0 Jan 17 12:04:28 MET 1995 +.TH RESIZECONS 8 "17 Jan 1995" "kbd" +.SH NAME +resizecons \- change kernel idea of the console size +.SH SYNOPSIS +.BI "resizecons " COLSxROWS +.br +.BI "resizecons -lines " ROWS +.SH DESCRIPTION +The +.I resizecons +command tries to change the videomode of the console. +There are several aspects to this: (a) the kernel must know about it, +(b) the hardware must know about it, (c) user programs must know +about it, (d) the console font may have to be adapted. + +(a) The kernel is told about the change using the ioctl VT_RESIZE. +This causes the kernel to reallocate console screen memory for +all virtual consoles, and might fail if there is not enough memory. +(In that case, try to disallocate some virtual consoles first.) +If this ioctl succeeds, but a later step fails (e.g., because +you do not have root permissions), you may be left with a very messy +screen. + +The most difficult part of this is (b), since it requires detailed +knowledge of the video card hardware, and the setting of numerous +registers. Only changing the number of rows is slightly easier, and +.I resizecons +will try to do that itself, when given the +.I -lines +option. (Probably, root permission will be required.) +The command +.I "resizecons COLSxROWS" +will execute +.I "restoretextmode -r COLSxROWS" +(and hence requires that you have svgalib installed). Here COLSxROWS +is a file that was created earlier by +.I "restoretextmode -w COLSxROWS." +Again, either root permissions are required, or +.I restoretextmode +has to be suid root. + +In order to deal with (c), +.I resizecons +does a `stty rows ROWS cols COLS' for each active console (in the +range tty0..tty15), and sends a SIGWINCH signal to +.I selection +if it finds the file /tmp/selection.pid. + +Finally, (d) is dealt with by executing a +.I setfont +command. Most likely, the wrong font is loaded, and you may want to +do another +.I setfont +yourself afterwards. + +.SH BUGS +.I resizecons +does not work on all hardware. +This command used to be called +.I resize, +but was renamed to avoid conflict with another command with the same name. + +.SH "SEE ALSO" +.BR setfont (8), +.BR stty (1), +.BR selection (1), +.BR restoretextmode (8), +.BR disalloc (8) + diff --git a/upstream/opensuse-leap-15-6/man8/resizepart.8 b/upstream/opensuse-leap-15-6/man8/resizepart.8 new file mode 100644 index 00000000..6d272cd9 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/resizepart.8 @@ -0,0 +1,71 @@ +'\" t +.\" Title: resizepart +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "RESIZEPART" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +resizepart \- tell the kernel about the new size of a partition +.SH "SYNOPSIS" +.sp +\fBresizepart\fP \fIdevice partition length\fP +.SH "DESCRIPTION" +.sp +\fBresizepart\fP tells the Linux kernel about the new size of the specified partition. The command is a simple wrapper around the "resize partition" ioctl. +.sp +This command doesn\(cqt manipulate partitions on a block device. +.SH "PARAMETERS" +.sp +\fIdevice\fP +.RS 4 +The disk device. +.RE +.sp +\fIpartition\fP +.RS 4 +The partition number. +.RE +.sp +\fIlength\fP +.RS 4 +The new length of the partition (in 512\-byte sectors). +.RE +.SH "SEE ALSO" +.sp +\fBaddpart\fP(8), +\fBdelpart\fP(8), +\fBfdisk\fP(8), +\fBparted\fP(8), +\fBpartprobe\fP(8), +\fBpartx\fP(8) +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBresizepart\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/rfkill.8 b/upstream/opensuse-leap-15-6/man8/rfkill.8 new file mode 100644 index 00000000..eeeb2994 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/rfkill.8 @@ -0,0 +1,148 @@ +'\" t +.\" Title: rfkill +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "RFKILL" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +rfkill \- tool for enabling and disabling wireless devices +.SH "SYNOPSIS" +.sp +\fBrfkill\fP [options] [\fIcommand\fP] [\fIID\fP|\fItype\fP ...] +.SH "DESCRIPTION" +.sp +\fBrfkill\fP lists, enabling and disabling wireless devices. +.sp +The command "list" output format is deprecated and maintained for backward compatibility only. The new output format is the default when no command is specified or when the option \fB\-\-output\fP is used. +.sp +The default output is subject to change. So whenever possible, you should avoid using default outputs in your scripts. Always explicitly define expected columns by using the \fB\-\-output\fP option together with a columns list in environments where a stable output is required. +.SH "OPTIONS" +.sp +\fB\-J\fP, \fB\-\-json\fP +.RS 4 +Use JSON output format. +.RE +.sp +\fB\-n\fP, \fB\-\-noheadings\fP +.RS 4 +Do not print a header line. +.RE +.sp +\fB\-o\fP, \fB\-\-output\fP +.RS 4 +Specify which output columns to print. Use \fB\-\-help\fP to get a list of available columns. +.RE +.sp +\fB\-\-output\-all\fP +.RS 4 +Output all available columns. +.RE +.sp +\fB\-r\fP, \fB\-\-raw\fP +.RS 4 +Use the raw output format. +.RE +.sp +\fB\-\-help\fP +.RS 4 +Display help text and exit. +.RE +.sp +\fB\-\-version\fP +.RS 4 +Display version information and exit. +.RE +.SH "COMMANDS" +.sp +\fBhelp\fP +.RS 4 +Display help text and exit. +.RE +.sp +\fBevent\fP +.RS 4 +Listen for rfkill events and display them on stdout. +.RE +.sp +\fBlist\fP [\fIid\fP|\fItype\fP ...] +.RS 4 +List the current state of all available devices. The command output format is deprecated, see the section DESCRIPTION. It is a good idea to check with \fBlist\fP command \fIid\fP or \fItype\fP scope is appropriate before setting \fBblock\fP or \fBunblock\fP. Special \fIall\fP type string will match everything. Use of multiple \fIID\fP or \fItype\fP arguments is supported. +.RE +.sp +\fBblock id\fP|\fBtype\fP [...] +.RS 4 +Disable the corresponding device. +.RE +.sp +\fBunblock id\fP|\fBtype\fP [...] +.RS 4 +Enable the corresponding device. If the device is hard\-blocked, for example via a hardware switch, it will remain unavailable though it is now soft\-unblocked. +.RE +.sp +\fBtoggle id\fP|\fBtype\fP [...] +.RS 4 +Enable or disable the corresponding device. +.RE +.SH "EXAMPLE" +.sp +.if n .RS 4 +.nf +.fam C + rfkill \-\-output ID,TYPE + rfkill block all + rfkill unblock wlan + rfkill block bluetooth uwb wimax wwan gps fm nfc +.fam +.fi +.if n .RE +.SH "AUTHORS" +.sp +\fBrfkill\fP was originally written by \c +.MTO "johannes\(atsipsolutions.net" "Johannes Berg" "" +and +.MTO "marcel\(atholtmann.org" "Marcel Holtmann" "." +The code has been later modified by +.MTO "kerolasa\(atiki.fi" "Sami Kerola" "" +and +.MTO "kzak\(atredhat.com" "Karel Zak" "" +for the util\-linux project. +.sp +This manual page was written by \c +.MTO "linux\(atyoumustbejoking.demon.co.uk" "Darren Salt" "" +for the Debian project (and may be used by others). +.SH "SEE ALSO" +.sp +\fBpowertop\fP(8), +\fBsystemd\-rfkill\fP(8), +.URL "https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Documentation/driver\-api/rfkill.rst" "Linux kernel documentation" "" +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBrfkill\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/rmmod.8 b/upstream/opensuse-leap-15-6/man8/rmmod.8 new file mode 100644 index 00000000..eefd06a4 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/rmmod.8 @@ -0,0 +1,87 @@ +'\" t +.\" Title: rmmod +.\" Author: Jon Masters <jcm@jonmasters.org> +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 01/29/2021 +.\" Manual: rmmod +.\" Source: kmod +.\" Language: English +.\" +.TH "RMMOD" "8" "01/29/2021" "kmod" "rmmod" +.\" ----------------------------------------------------------------- +.\" * 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" +rmmod \- Simple program to remove a module from the Linux Kernel +.SH "SYNOPSIS" +.HP \w'\fBrmmod\fR\ 'u +\fBrmmod\fR [\fB\-f\fR] [\fB\-s\fR] [\fB\-v\fR] [\fImodulename\fR] +.SH "DESCRIPTION" +.PP +\fBrmmod\fR +is a trivial program to remove a module (when module unloading support is provided) from the kernel\&. Most users will want to use +\fBmodprobe\fR(8) +with the +\fB\-r\fR +option instead\&. +.SH "OPTIONS" +.PP +\fB\-v\fR, \fB\-\-verbose\fR +.RS 4 +Print messages about what the program is doing\&. Usually +\fBrmmod\fR +prints messages only if something goes wrong\&. +.RE +.PP +\fB\-f\fR, \fB\-\-force\fR +.RS 4 +This option can be extremely dangerous: it has no effect unless CONFIG_MODULE_FORCE_UNLOAD was set when the kernel was compiled\&. With this option, you can remove modules which are being used, or which are not designed to be removed, or have been marked as unsafe (see +\fBlsmod\fR(8))\&. +.RE +.PP +\fB\-s\fR, \fB\-\-syslog\fR +.RS 4 +Send errors to syslog instead of standard error\&. +.RE +.PP +\fB\-V\fR \fB\-\-version\fR +.RS 4 +Show version of program and exit\&. +.RE +.SH "COPYRIGHT" +.PP +This manual page originally Copyright 2002, Rusty Russell, IBM Corporation\&. Maintained by Jon Masters and others\&. +.SH "SEE ALSO" +.PP +\fBmodprobe\fR(8), +\fBinsmod\fR(8), +\fBlsmod\fR(8), +\fBmodinfo\fR(8) +\fBdepmod\fR(8) +.SH "AUTHORS" +.PP +\fBJon Masters\fR <\&jcm@jonmasters\&.org\&> +.RS 4 +Developer +.RE +.PP +\fBLucas De Marchi\fR <\&lucas\&.de\&.marchi@gmail\&.com\&> +.RS 4 +Developer +.RE diff --git a/upstream/opensuse-leap-15-6/man8/rpc.rquotad.8 b/upstream/opensuse-leap-15-6/man8/rpc.rquotad.8 new file mode 100644 index 00000000..a045dbab --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/rpc.rquotad.8 @@ -0,0 +1,112 @@ +.TH RQUOTAD 8 +.SH NAME +rpc.rquotad \- remote quota server +.SH SYNOPSIS +.B /usr/sbin/rpc.rquotad +[ +.BR \-FI +] [ +.B \-p +.I port +] [ +.B \-s +| +.B \-S +] [ +.B \-x +.I path +] +.LP +.B /usr/sbin/rpc.rquotad +[ +.B \-h +| +.B \-V +] +.SH DESCRIPTION +.LP +.IX "rquotad daemon" "" "\fLrquotad\fP \(em remote quota server" +.IX daemons "rquotad daemon" "" "\fLrquotad\fP \(em remote quota server" +.IX "user quotas" "rquotad daemon" "" "\fLrquotad\fP \(em remote quota server" +.IX "disk quotas" "rquotad daemon" "" "\fLrquotad\fP \(em remote quota server" +.IX "quotas" "rquotad daemon" "" "\fLrquotad\fP \(em remote quota server" +.IX "filesystem" "rquotad daemon" "" "\fLrquotad\fP \(em remote quota server" +.IX "remote procedure call services" "rquotad" "" "\fLrquotad\fP \(em remote quota server" +.B rpc.rquotad +is an +.BR rpc (3) +server which returns quotas for a user of a local filesystem +which is mounted by a remote machine over the +.SM NFS\s0. +It also allows setting of quotas on +.SM NFS +mounted filesystem (if configured during compilation and allowed by a command line option +.BR \-S ). +The results are used by +.BR quota (1) +to display user quotas for remote filesystems and by +.BR edquota (8) +to set quotas on remote filesystems. +.B rquotad +daemon uses tcp-wrappers library (under service name +.IR rquotad ) +which allows you to specify hosts allowed/disallowed to use +the daemon (see +.BR hosts.allow (5) +manpage for more information). The +.B rquotad +daemon is normally started at boot time from the +system startup scripts. +.SH OPTIONS +.TP +.B \-h, \-\-help +Show program usage and exit. +.B \-V, \-\-version +Show version of quota tools. +.TP +.B \-s, \-\-no-setquota +Don't allow setting of quotas (default). This option is available only +if utilities were compiled with the +.I rpcsetquota +option. +.TP +.B \-S, \-\-setquota +Allow setting of quotas. This option is available only +if utilities were compiled with the +.I rpcsetquota +option. +.TP +.B \-F, \-\-foreground +Run daemon in foreground (may be useful for debugging purposes). +.TP +.B \-I, \-\-autofs +Do not ignore autofs mountpoints. +.TP +.B \-p \f2port\f3, \-\-port \f2port\f1 +Listen on alternate port +.IR port. +.TP +.B \-x \f2path\f3, \-\-xtab \f2path\f1 +Set an alternative file with NFSD export table. This file is used to +determine pseudoroot of NFSv4 exports. The pseudoroot is then prepended +to each relative path (i.e. a path not beginning by '/') received in a +quota RPC request. + +.SH FILES +.PD 0 +.TP 20 +.B aquota.user or aquota.group +quota file at the filesystem root (version 2 quota, non-XFS filesystems) +.TP +.B quota.user or quota.group +quota file at the filesystem root (version 1 quota, non-XFS filesystems) +.TP +.B /etc/mtab +default filesystems +.PD +.SH "SEE ALSO" +.BR quota (1), +.BR rpc (3), +.BR nfs (5), +.BR services (5), +.BR inetd (8) diff --git a/upstream/opensuse-leap-15-6/man8/rpcdebug.8 b/upstream/opensuse-leap-15-6/man8/rpcdebug.8 new file mode 100644 index 00000000..e65598af --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/rpcdebug.8 @@ -0,0 +1,88 @@ +.\" +.\" rpcdebug(8) +.\" +.\" By Greg Banks <gnb@melbourne.sgi.com> +.\" Copyright (c) 2006 Silicon Graphics, Inc. +.\" Derived from nfsstat.man which bore the message: +.\" Copyright (C) 1996-2005 Olaf Kirch <okir@suse.de> +.TH rpcdebug 8 "5 Jul 2006" +.SH NAME +rpcdebug \- set and clear NFS and RPC kernel debug flags +.SH SYNOPSIS +\fBrpcdebug\fP \fB\-vh\fP +.br +\fBrpcdebug\fP \fB\-m\fP \fImodule\fP +.br +\fBrpcdebug\fP \fB\-m\fP \fImodule\fP \fB\-s\fP \fIflags\fP... +.br +\fBrpcdebug\fP \fB\-m\fP \fImodule\fP \fB\-c\fP \fIflags\fP... +.br +.SH DESCRIPTION +The \fBrpcdebug\fP command allows an administrator to set and clear +the Linux kernel's NFS client and server debug flags. Setting these +flags causes the kernel to emit messages to the system log in response +to NFS activity; this is typically useful when debugging NFS problems. +.PP +The first form in the synopsis can be used to list all available +debug flags. The second form shows the currently set debug flags +for the given module. The third form sets one or more flags, and +the fourth form clears one or more flags. +.PP +The value \fBall\fP may be used to set or clear all the flags for +the given module. +.SH OPTIONS +.\" -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=- +.TP +.B \-c +Clear the given debug flags. +.\" -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=- +.TP +.B \-h +Print a help message and exit. When combined with the \fB\-v\fP +option, also prints the available debug flags. +.\" -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=- +.TP +.BI \-m " module" +Specify which module's flags to set or clear. Available +modules are: +.RS +.TP +.BR nfsd +The NFS server. +.TP +.BR nfs +The NFS client. +.TP +.BR nlm +The Network Lock Manager, in either an NFS client or server. +.TP +.BR rpc +The Remote Procedure Call module, in either an NFS client or server. +.RE +.\" -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=- +.TP +.B \-s +Set the given debug flags. +.\" -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=- +.TP +.B \-v +Increase the verbosity of \fBrpcdebug\fP's output. +.\" -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=- +.SH FILES +.TP +.B /proc/sys/sunrpc/{rpc,nfs,nfsd,nlm}_debug +procfs\-based interface to kernel debug flags. +.\" -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=- +.SH SEE ALSO +.BR rpc.nfsd (8), +.BR nfs (5), +.BR syslogd (8). +.\" -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=- +.SH BUGS +Bugs can be found or reported at +.BR http://nfs.sf.net/ . +.\" -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=- +.SH AUTHOR +Program by Olaf Kirch <okir@suse.de> and +<frederic.jolly@bull.ext.net>. +Manpage by Greg Banks <gnb@melbourne.sgi.com>. diff --git a/upstream/opensuse-leap-15-6/man8/rpm-misc.8 b/upstream/opensuse-leap-15-6/man8/rpm-misc.8 new file mode 100644 index 00000000..f9bcdbc1 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/rpm-misc.8 @@ -0,0 +1,64 @@ +.TH "RPM misc options" 8 +.SH NAME rpm \- lesser need options for rpm(8) + +.SH OPTIONS +.TP +\fB\-\-predefine\fR='\fIMACRO EXPR\fB'\fR +Defines \fIMACRO\fR with value \fIEXPR\fR. before loading macro files. + +.SH Switching off features +.TP +\fB\-\-color [never|auto|always]\fR +Use terminal colors for highlighting error and debug message. Default is turning colors on for ttys only (\fBauto\fR). +.TP + +\fB\-\-nocontexts\fR +Disable the SELinux plugin if available. This stops the plugin from setting SELinux contexts for files and scriptlets. +.TP +\fB\-\-noglob\fR +Do not glob arguments when installing package files. +.TP +\fB\-\-nocaps\fR +Don't verify capabilities of files. +.TP +\fB\-\-excludeconfigs, \-\-noconfigs\fR +Do not install configuration files. +.TP +\fB\-\-nohdrchk\fR +Don't verify database header(s) when retrieved. + +.SH Debugging + +.TP +\fB-d, \-\-debug\fR +Print debugging information. +.TP +\fB\-\-deploops\fR +Print dependency loops as warning. +.TP +\fB\-\-fsmdebug\fR +Print debuging information of payload handling code. +.TP +\fB\-\-rpmfcdebug\fR +Print debug information about files packaged. +.TP +\fB\-\-rpmiodebug\fR +Print debug information about file IO. +.TP +\fB\-\-stats\fR +Print runtime statistics of often used functions. + +.SH Obsolete Options +.TP +\fB-K, \-\-checksig\fR +See and use rpmkeys(8). +.TP +\fB\-\-nodocs\fR +Do not install documentation. +Use \fB\-\-excludedocs\fR instead. +.TP +\fB\-\-promoteepoch\fR +Enable obsolete epoch handling used in rpm 3.x time frame. +.TP +\fB\-\-prtpkts\fR +OBSOLETE! Used to print the packages containing and representing the pgp keys for debugging purposes. diff --git a/upstream/opensuse-leap-15-6/man8/rpm-plugin-systemd-inhibit.8 b/upstream/opensuse-leap-15-6/man8/rpm-plugin-systemd-inhibit.8 new file mode 100644 index 00000000..372f1be0 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/rpm-plugin-systemd-inhibit.8 @@ -0,0 +1,36 @@ +.TH "RPM-SYSTEMD-INHIBIT" "8" "14 Apr 2016" "Red Hat, Inc." +.SH NAME +rpm-plugin-systemd-inhibit \- Plugin for the RPM Package Manager + +.SH Description + +This plugin for RPM prevents the system to enter shutdown, sleep or idle +mode while there is a rpm transaction running to prevent system corruption +that can occur if the transaction is interrupted by a reboot. + +This is achieved by using the inhibit DBUS interface of systemd. The call is +roughly equivalent to executing + +\fBsystemd-inhibit --mode=block --what=idle:sleep:shutdown --who=RPM --why="Transaction running"\fR + +See \fBsystemd-inhibit(1)\fR for the details of this mechanism. + +It is strongly advised to have the plugin installed on all systemd +based systems. + +.SH Prerequisites + +For the plugin to work systemd has to be used as init system and +though the DBUS system bus must be available. If the plugin cannot access the +interface it gives a warning but does not stop the transaction. + +.SH Configuration + +The plugin currently does not have any configuration option other than +turning it on and off. It can be disabled by commenting out the +\fI%__transaction_systemd_inhibit\fR macro in main macros file +(typically located at \fI/usr/lib/rpm/macros\fR) or otherwise change +the value of the macro. + +Another option is to remove the plugin from the system if it is +packaged in its own sub package. diff --git a/upstream/opensuse-leap-15-6/man8/rpm.8 b/upstream/opensuse-leap-15-6/man8/rpm.8 new file mode 100644 index 00000000..4287bc38 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/rpm.8 @@ -0,0 +1,999 @@ +.\" This manpage has been automatically generated by docbook2man +.\" from a DocBook document. This tool can be found at: +.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> +.\" Please send any bug reports, improvements, comments, patches, +.\" etc. to Steve Cheng <steve@ggi-project.org>. +.TH "RPM" "8" "09 June 2002" "Red Hat, Inc." +.SH NAME +rpm \- RPM Package Manager +.SH SYNOPSIS +.SS "QUERYING AND VERIFYING PACKAGES:" +.PP + + +\fBrpm\fR {\fB-q|--query\fR} [\fBselect-options\fR] [\fBquery-options\fR] + +\fBrpm\fR \fB--querytags\fR + +\fBrpm\fR {\fB-V|--verify\fR} [\fBselect-options\fR] [\fBverify-options\fR] + +.SS "INSTALLING, UPGRADING, AND REMOVING PACKAGES:" +.PP + + +\fBrpm\fR {\fB-i|--install\fR} [\fBinstall-options\fR] \fB\fIPACKAGE_FILE\fB\fR\fI ...\fR + + + +\fBrpm\fR {\fB-U|--upgrade\fR} [\fBinstall-options\fR] \fB\fIPACKAGE_FILE\fB\fR\fI ...\fR + + + +\fBrpm\fR {\fB-F|--freshen\fR} [\fBinstall-options\fR] \fB\fIPACKAGE_FILE\fB\fR\fI ...\fR + + + +\fBrpm\fR {\fB--reinstall\fR} [\fBinstall-options\fR] \fB\fIPACKAGE_FILE\fB\fR\fI ...\fR + + + +\fBrpm\fR {\fB-e|--erase\fR} [\fB--allmatches\fR] [\fB--justdb] [\fB--nodeps\fR] [\fB--noscripts\fR] + [\fB--notriggers\fR] [\fB--test\fR] \fB\fIPACKAGE_NAME\fB\fR\fI\ ...\fR + +.SS "MISCELLANEOUS:" +.PP + +\fBrpm\fR \fB--showrc\fR + +\fBrpm\fR \fB--setperms\fR \fB\fIPACKAGE_NAME\fB\fR\fI ...\fR + +\fBrpm\fR \fB--setugids\fR \fB\fIPACKAGE_NAME\fB\fR\fI ...\fR + +\fBrpm\fR \fB--setcaps\fR \fB\fIPACKAGE_NAME\fB\fR\fI ...\fR + +\fBrpm\fR \fB--restore\fR \fB\fIPACKAGE_NAME\fB\fR\fI ...\fR + +.SS "select-options" +.PP + + [\fB\fIPACKAGE_NAME\fB\fR] + [\fB-a,--all [\fISELECTOR\fR]\fR] [\fB-f,--file \fIFILE\fB\fR] + [\fB-g,--group \fIGROUP\fB\fR] {\fB-p,--package \fIPACKAGE_FILE\fB\fR] + [\fB--hdrid \fISHA1\fB\fR] [\fB--pkgid \fIMD5\fB\fR] [\fB--tid \fITID\fB\fR] + [\fB--querybynumber \fIHDRNUM\fB\fR] [\fB--triggeredby \fIPACKAGE_NAME\fB\fR] + [\fB--whatprovides \fICAPABILITY\fB\fR] [\fB--whatrequires \fICAPABILITY\fB\fR] + [\fB--whatrecommends \fICAPABILITY\fB\fR] [\fB--whatsuggests \fICAPABILITY\fB\fR] + [\fB--whatsupplements \fICAPABILITY\fB\fR] [\fB--whatenhances \fICAPABILITY\fB\fR] + [\fB--whatobsoletes \fICAPABILITY\fB\fR] [\fB--whatconflicts \fICAPABILITY\fB\fR] + +.SS "query-options" +.PP +General: + [\fB--changelog\fR] [\fB--changes\fR] [\fB--dupes\fR] [\fB-i,--info\fR] + [\fB--last\fR] [\fB--qf,--queryformat \fIQUERYFMT\fB\fR] [\fB--xml\fR] +.PP +Dependencies: + [\fB--conflicts\fR] [\fB--enhances\fR] [\fB--obsoletes\fR] [\fB--provides\fR] + [\fB--recommends\fR] [\fB-R,--requires\fR] [\fB--suggests\fR] [\fB--supplements\fR] +.PP +Files: + [\fB-c,--configfiles\fR] [\fB-d,--docfiles\fR] [\fB--dump\fR] [\fB--fileclass\fR] + [\fB--filecolor\fR] [\fB--fileprovide\fR][\fB--filerequire\fR] [\fB--filecaps\fR] + [\fB--filesbypkg\fR] [\fB-l,--list\fR] [\fB-s,--state\fR] + [\fB--noartifact\fR] [\fB--noghost\fR] [\fB--noconfig\fR +.PP +Scripts and triggers: + [\fB--filetriggers\fR] [\fB--scripts\fR] [\fB--triggers,--triggerscripts\fR] + +.SS "verify-options" +.PP + + + [\fB--nodeps\fR] [\fB--nofiles\fR] [\fB--noscripts\fR] + [\fB--nodigest\fR] [\fB--nosignature\fR] + [\fB--nolinkto\fR] [\fB--nofiledigest\fR] [\fB--nosize\fR] [\fB--nouser\fR] + [\fB--nogroup\fR] [\fB--nomtime\fR] [\fB--nomode\fR] [\fB--nordev\fR] + [\fB--nocaps\fR] + +.SS "install-options" +.PP + + + [\fB--allfiles\fR] [\fB--badreloc\fR] [\fB--excludepath \fIOLDPATH\fB\fR] + [\fB--excludedocs\fR] [\fB--force\fR] [\fB-h,--hash\fR] + [\fB--ignoresize\fR] [\fB--ignorearch\fR] [\fB--ignoreos\fR] + [\fB--includedocs\fR] [\fB--justdb\fR] + [\fB--nodeps\fR] [\fB--nodigest\fR] [\fB--noplugins\fR] + [\fB--nocaps\fR] [\fB--noorder\fR] + [\fB--nosignature\fR] [\fB--noscripts\fR] [\fB--notriggers\fR] + [\fB--oldpackage\fR] [\fB--percent\fR] [\fB--prefix \fINEWPATH\fB\fR] + [\fB--relocate \fIOLDPATH\fB=\fINEWPATH\fB\fR] + [\fB--replacefiles\fR] [\fB--replacepkgs\fR] + [\fB--test\fR] + +.SH "DESCRIPTION" +.PP +\fBrpm\fR is a powerful \fBPackage Manager\fR, +which can be used to build, install, query, verify, update, and +erase individual software packages. +A \fBpackage\fR consists of an archive of files and +meta-data used to install and erase the archive files. The meta-data +includes helper scripts, file attributes, and descriptive information +about the package. +\fBPackages\fR come in two varieties: binary packages, +used to encapsulate software to be installed, and source packages, +containing the source code and recipe necessary to produce binary +packages. +.PP +One of the following basic modes must be selected: +\fBQuery\fR, +\fBVerify\fR, +\fBInstall/Upgrade/Freshen/Reinstall\fR, +\fBUninstall\fR, +\fBSet Owners/Groups\fR, +\fBShow Querytags\fR, and +\fBShow Configuration\fR. +.SS "GENERAL OPTIONS" +.PP +These options can be used in all the different modes. +.TP +\fB-?, --help\fR +Print a longer usage message then normal. +.TP +\fB--version\fR +Print a single line containing the version number of \fBrpm\fR +being used. +.TP +\fB--quiet\fR +Print as little as possible - normally only error messages will +be displayed. +.TP +\fB-v, --verbose\fR +Print verbose information - normally routine progress messages will be +displayed. +.TP +\fB-vv\fR +Print lots of ugly debugging information. +.TP +\fB--rcfile \fIFILELIST\fB\fR +Replace the list of configuration files to be read. Each of the files in the colon separated +\fIFILELIST\fR +is read sequentially by \fBrpm\fR for configuration +information. +Only the first file in the list must exist, and tildes will be +expanded to the value of \fB$HOME\fR. +The default \fIFILELIST\fR is +\fI/usr/\:lib/\:rpm/\:rpmrc\fR:\:\fI/usr/\:lib/\:rpm/\:redhat/\:rpmrc\fR:\:\fI/etc/\:rpmrc\fR:\:\fI~/.rpmrc\fR. + +.TP +\fB--macros \fIFILELIST\fB\fR +Replace the list of macro files to be loaded. Each of the files in the colon separated +\fIFILELIST\fR +is read sequentially by \fBrpm\fR for macro definitions. +Only the first file in the list must exist, and tildes will be +expanded to the value of \fB$HOME\fR. +The default \fIFILELIST\fR is +\fI/usr/\:lib/\:rpm/\:macros\fR:\:\fI/usr/\:lib/\:rpm/\:macros.d/\:macros.*\fR:\:\fI/usr/\:lib/\:rpm/\:platform/\:%{_target}/\:macros\fR:\:\fI/usr/\:lib/\:rpm/\:fileattrs/\:*.attr\fR:\:\fI/usr/\:lib/\:rpm/\:redhat/\:macros\fR:\:\fI/etc/\:rpm/\:macros.*\fR:\:\fI/etc/\:rpm/\:macros\fR:\:\fI/etc/\:rpm/\:%{_target}/\:macros\fR:\:\fI~/.rpmmacros + +.TP +\fB--pipe \fICMD\fB\fR +Pipes the output of \fBrpm\fR to the command \fICMD\fR. +.TP +\fB--dbpath \fIDIRECTORY\fB\fR +Use the database in \fIDIRECTORY\fR rather +than the default path \fI/var/lib/rpm\fR +.TP +\fB--root \fIDIRECTORY\fB\fR +Use the file system tree rooted at \fIDIRECTORY\fR for all operations. +Note that this means the database within +\fIDIRECTORY\fR +will be used for dependency checks and any scriptlet(s) (e.g. +\fB%post\fR if installing, or +\fB%prep\fR if building, a package) +will be run after a chroot(2) to +\fIDIRECTORY\fR. +.TP +\fB-D, --define='\fIMACRO EXPR\fB'\fR +Defines \fIMACRO\fR with value \fIEXPR\fR. +.TP +\fB--undefine='\fIMACRO\fB'\fR +Undefines \fIMACRO\fR. +.TP +\fB-E, --eval='\fIEXPR\fB'\fR +Prints macro expansion of \fIEXPR\fR. + +.PP +More - less often needed - options can be found on the \fBrpm-misc(8)\fR man page. +.SS "INSTALL AND UPGRADE OPTIONS" +.PP +In these options, \fIPACKAGE_FILE\fR can be either \fBrpm\fR binary +file or ASCII package manifest (see \fBPACKAGE SELECTION OPTIONS\fR), and +may be specified as an +\fBftp\fR or +\fBhttp\fR URL, +in which case the package will be downloaded before being +installed. See \fBFTP/HTTP OPTIONS\fR +for information on \fBrpm\fR's internal +\fBftp\fR and +\fBhttp\fR +client support. +.PP +The general form of an rpm install command is +.PP +\fBrpm\fR {\fB-i|--install\fR} [\fBinstall-options\fR] \fB\fIPACKAGE_FILE\fB\fR\fI ...\fR +.PP +This installs a new package. +.PP +The general form of an rpm upgrade command is +.PP +\fBrpm\fR {\fB-U|--upgrade\fR} [\fBinstall-options\fR] \fB\fIPACKAGE_FILE\fB\fR\fI ...\fR +.PP +This upgrades or installs the package currently installed +to a newer version. This is the same as install, except +all other version(s) of the package are removed after the +new package is installed. +.PP +\fBrpm\fR {\fB-F|--freshen\fR} [\fBinstall-options\fR] \fB\fIPACKAGE_FILE\fB\fR\fI ...\fR +.PP +This will upgrade packages, but only ones for which an earlier version is +installed. +.PP +The general form of an rpm reinstall command is +.PP +\fBrpm\fR {\fB--reinstall\fR} [\fBinstall-options\fR] \fB\fIPACKAGE_FILE\fB\fR\fI ...\fR +.PP +This reinstalls a previously installed package. +.PP +.PP +.TP +\fB--allfiles\fR +Installs or upgrades all the missingok files in the package, +regardless if they exist. +.TP +\fB--badreloc\fR +Used with \fB--relocate\fR, permit relocations on +all file paths, not just those \fIOLDPATH\fR's +included in the binary package relocation hint(s). +.TP +\fB--excludepath \fIOLDPATH\fB\fR +Don't install files whose name begins with +\fIOLDPATH\fR. +.TP +\fB--excludedocs\fR +Don't install any files which are marked as documentation +(which includes man pages and texinfo documents). +.TP +\fB--force\fR +Same as using +\fB--replacepkgs\fR, +\fB--replacefiles\fR, and +\fB--oldpackage\fR. +.TP +\fB-h, --hash\fR +Print 50 hash marks as the package archive is unpacked. +Use with \fB-v|--verbose\fR for a nicer display. +.TP +\fB--ignoresize\fR +Don't check mount file systems for sufficient disk space before +installing this package. +.TP +\fB--ignorearch\fR +Allow installation or upgrading even if the architectures +of the binary package and host don't match. +.TP +\fB--ignoreos\fR +Allow installation or upgrading even if the operating +systems of the binary package and host don't match. +.TP +\fB--includedocs\fR +Install documentation files. This is the default behavior. +.TP +\fB--justdb\fR +Update only the database, not the filesystem. +.TP +\fB--nodigest\fR +Don't verify package or header digests when reading. +.TP +\fB--nomanifest\fR +Don't process non-package files as manifests. +.TP +\fB--nosignature\fR +Don't verify package or header signatures when reading. +.TP +\fB--nodeps\fR +Don't do a dependency check before installing or upgrading +a package. +.TP +\fB--nocaps\fR +Don't set file capabilities. +.TP +\fB--noorder\fR +Don't reorder the packages for an install. The list of +packages would normally be reordered to satisfy dependencies. +.TP +\fB--noplugins\fR +Do not load and execute plugins. +.TP +\fB--noscripts\fR, \fB--nopre\fR, \fB--nopost\fR, \fB--nopreun\fR, \fB--nopostun\fR, \fB--nopretrans\fR, \fB--noposttrans\fR +Don't execute the scriptlet of the same name. +The \fB--noscripts\fR option is equivalent to + +\fB--nopre\fR +\fB--nopost\fR +\fB--nopreun\fR +\fB--nopostun\fR +\fB--nopretrans\fR +\fB--noposttrans\fR + +and turns off the execution of the corresponding +\fB%pre\fR, +\fB%post\fR, +\fB%preun\fR, +\fB%postun\fR +\fB%pretrans\fR, and +\fB%posttrans\fR +scriptlet(s). + +.TP +\fB--notriggers\fR, \fB--notriggerin\fR, \fB--notriggerun\fR, \fB--notriggerprein\fR, \fB--notriggerpostun\fR +Don't execute any trigger scriptlet of the named type. +The \fB--notriggers\fR option is equivalent to + +\fB--notriggerprein\fR +\fB--notriggerin\fR +\fB--notriggerun\fR +\fB--notriggerpostun\fR + +and turns off execution of the corresponding +\fB%triggerprein\fR, +\fB%triggerin\fR, +\fB%triggerun\fR, and +\fB%triggerpostun\fR +scriptlet(s). +.TP +\fB--oldpackage\fR +Allow an upgrade to replace a newer package with an older one. +.TP +\fB--percent\fR +Print percentages as files are unpacked from the package archive. +This is intended to make \fBrpm\fR easy to run from +other tools. +.TP +\fB--prefix \fINEWPATH\fB\fR +For relocatable binary packages, translate all file paths that +start with the installation prefix in the package relocation hint(s) +to \fINEWPATH\fR. +.TP +\fB--relocate \fIOLDPATH\fB=\fINEWPATH\fB\fR +For relocatable binary packages, translate all file paths +that start with \fIOLDPATH\fR in the +package relocation hint(s) to \fINEWPATH\fR. +This option can be used repeatedly if several +\fIOLDPATH\fR's in the package are to +be relocated. +.TP +\fB--replacefiles\fR +Install the packages even if they replace files from other, +already installed, packages. +.TP +\fB--replacepkgs\fR +Install the packages even if some of them are already installed +on this system. +.TP +\fB--test\fR +Do not install the package, simply check for and report +potential conflicts. +.SS "ERASE OPTIONS" +.PP +The general form of an rpm erase command is +.PP + +\fBrpm\fR {\fB-e|--erase\fR} [\fB--allmatches\fR] [\fB--justdb] [\fB--nodeps\fR] [\fB--noscripts\fR] [\fB--notriggers\fR] [\fB--test\fR] \fB\fIPACKAGE_NAME\fB\fR\fI ...\fR + +.PP +The following options may also be used: +.TP +\fB--allmatches\fR +Remove all versions of the package which match +\fIPACKAGE_NAME\fR. Normally an +error is issued if \fIPACKAGE_NAME\fR +matches multiple packages. +.TP +\fB--justdb\fR +Update only the database, not the filesystem. +.TP +\fB--nodeps\fR +Don't check dependencies before uninstalling the packages. +.TP +\fB--noscripts\fR, \fB--nopreun\fR, \fB--nopostun\fR +Don't execute the scriptlet of the same name. +The \fB--noscripts\fR option during package erase is +equivalent to + +\fB--nopreun\fR +\fB--nopostun\fR + +and turns off the execution of the corresponding +\fB%preun\fR, and +\fB%postun\fR +scriptlet(s). +.TP +\fB--notriggers\fR, \fB--notriggerun\fR, \fB--notriggerpostun\fR +Don't execute any trigger scriptlet of the named type. +The \fB--notriggers\fR option is equivalent to + +\fB--notriggerun\fR +\fB--notriggerpostun\fR + +and turns off execution of the corresponding +\fB%triggerun\fR, and +\fB%triggerpostun\fR +scriptlet(s). +.TP +\fB--test\fR +Don't really uninstall anything, just go through the motions. +Useful in conjunction with the \fB-vv\fR option +for debugging. +.SS "QUERY OPTIONS" +.PP +The general form of an rpm query command is +.PP + +\fBrpm\fR {\fB-q|--query\fR} [\fBselect-options\fR] [\fBquery-options\fR] + +.PP +You may specify the format that package information should be +printed in. To do this, you use the + + \fB--qf|--queryformat\fR \fB\fIQUERYFMT\fB\fR + +option, followed by the \fIQUERYFMT\fR +format string. Query formats are modified versions of the +standard \fBprintf(3)\fR formatting. The format +is made up of static strings (which may include standard C +character escapes for newlines, tabs, and other special +characters) and \fBprintf(3)\fR type formatters. +As \fBrpm\fR already knows the type to print, the +type specifier must be omitted however, and replaced by the name +of the header tag to be printed, enclosed by \fB{}\fR +characters. Tag names are case insensitive, and the leading +\fBRPMTAG_\fR portion of the tag name may be omitted +as well. +.PP +Alternate output formats may be requested by following +the tag with \fB:\fItypetag\fB\fR. +Currently, the following types are supported: +.TP +\fB:armor\fR +Wrap a public key in ASCII armor. +.TP +\fB:arraysize\fR +Display number of elements in array tags. +.TP +\fB:base64\fR +Encode binary data using base64. +.TP +\fB:date\fR +Use strftime(3) "%c" format. +.TP +\fB:day\fR +Use strftime(3) "%a %b %d %Y" format. +.TP +\fB:depflags\fR +Format dependency comparison operator. +.TP +\fB:deptype\fR +Format dependency type. +.TP +\fB:expand\fR +Perform macro expansion. +.TP +\fB:fflags\fR +Format file flags. +.TP +\fB:fstate\fR +Format file state. +.TP +\fB:fstatus\fR +Format file verify status. +.TP +\fB:hex\fR +Format in hexadecimal. +.TP +\fB:octal\fR +Format in octal. +.TP +\fB:humaniec\fR +Human readable number (in IEC 80000). The suffix K = 1024, M = 1048576, ... +.TP +\fB:humansi\fR +Human readable number (in SI). The suffix K = 1000, M = 1000000, ... +.TP +\fB:perms\fR +Format file permissions. +.TP +\fB:pgpsig\fR +Display signature fingerprint and time. +.TP +\fB:shescape\fR +Escape single quotes for use in a script. +.TP +\fB:triggertype\fR +Display trigger suffix. +.TP +\fB:vflags\fR +File verification flags. +.TP +\fB:xml\fR +Wrap data in simple xml markup. +.PP +For example, to print only the names of the packages queried, +you could use \fB%{NAME}\fR as the format string. +To print the packages name and distribution information in +two columns, you could use \fB%-30{NAME}%{DISTRIBUTION}\fR. +\fBrpm\fR will print a list of all of the tags it knows about when it +is invoked with the \fB--querytags\fR argument. +.PP +There are two subsets of options for querying: package selection, +and information selection. +.SS "PACKAGE SELECTION OPTIONS:" +.PP +.TP +\fB\fIPACKAGE_NAME\fB\fR +Query installed package named \fIPACKAGE_NAME\fR. To specify the package more precisely the package name may be followed by the version or version and release +both separated by a dash or an architecture name separated by a dot. See the output of \fBrpm -qa\fR or \fBrpm -qp \fIPACKAGE_FILE\fB\fR as an example. + +.TP +\fB-a, --all [\fISELECTOR\fR]\fR +Query all installed packages. + +An optional \fISELECTOR\fR in the form of tag=pattern can be provided to +narrow the selection, for example name="b*" to query packages whose name +starts with "b". +.TP +\fB--dupes\fB +List duplicated packages. +.TP +\fB-f, --file \fIFILE\fB\fR +Query package owning \fIFILE\fR. +.TP +\fB--filecaps\fR +List file names with POSIX1.e capabilities. +.TP +\fB--fileclass\fR +List file names with their classes (libmagic classification). +.TP +\fB--filecolor\fR +List file names with their colors (0 for noarch, 1 for 32bit, 2 for 64 bit). +.TP +\fB--fileprovide\fR +List file names with their provides. +.TP +\fB--filerequire\fR +List file names with their requires. +.TP +\fB-g, --group \fIGROUP\fB\fR +Query packages with the group of \fIGROUP\fR. +.TP +\fB--hdrid \fISHA1\fB\fR +Query package that contains a given header identifier, i.e. the +\fISHA1\fR digest of the immutable header region. +.TP +\fB-p, --package \fIPACKAGE_FILE\fB\fR +Query an (uninstalled) package \fIPACKAGE_FILE\fR. +The \fIPACKAGE_FILE\fR may be specified +as an \fBftp\fR or \fBhttp\fR style URL, in +which case the package header will be downloaded and queried. +See \fBFTP/HTTP OPTIONS\fR for information on +\fBrpm\fR's internal +\fBftp\fR and +\fBhttp\fR +client support. The \fIPACKAGE_FILE\fR argument(s), +if not a binary package, will be interpreted as an ASCII package +manifest unless \fB--nomanifest\fR option is used. +In manifests, comments are permitted, starting with a '#', and each +line of a package manifest file may include white space separated +glob expressions, including URL's, +that will be expanded to paths that are substituted in place of +the package manifest as additional \fIPACKAGE_FILE\fR +arguments to the query. +.TP +\fB--pkgid \fIMD5\fB\fR +Query package that contains a given package identifier, i.e. the +\fIMD5\fR digest of the combined header and +payload contents. +.TP +\fB--querybynumber \fIHDRNUM\fB\fR +Query the \fIHDRNUM\fRth database entry +directly; this is useful only for debugging. +.TP +\fB--specfile \fISPECFILE\fB\fR +Parse and query \fISPECFILE\fR as if +it were a package. Although not all the information (e.g. file lists) +is available, this type of query permits rpm to be used to extract +information from spec files without having to write a specfile +parser. +.TP +\fB--tid \fITID\fB\fR +Query package(s) that have a given \fITID\fR +transaction identifier. A unix time stamp is currently used as a +transaction identifier. All package(s) installed or erased within +a single transaction have a common identifier. +.TP +\fB--triggeredby \fIPACKAGE_NAME\fB\fR +Query packages that are triggered by package(s) +\fIPACKAGE_NAME\fR. +.TP +\fB--whatobsoletes \fICAPABILITY\fB\fR +Query all packages that obsolete \fICAPABILITY\fR for proper functioning. +.TP +\fB--whatprovides \fICAPABILITY\fB\fR +Query all packages that provide the \fICAPABILITY\fR capability. +.TP +\fB--whatrequires \fICAPABILITY\fB\fR +Query all packages that require \fICAPABILITY\fR for proper functioning. +.br +Note that this does not return what requires a given package. +A package usually provides multiple capabilities and file-names on which +other packages may depend. To see the complete dependencies +for a package, use \fB-e --test \fIPACKAGE_NAME\fB\fR +.TP +\fB--whatconflicts \fICAPABILITY\fB\fR +Query all packages that conflict with \fICAPABILITY\fR. +.TP +\fB--whatrecommends \fICAPABILITY\fB\fR +Query all packages that recommend \fICAPABILITY\fR. +.TP +\fB--whatsuggests \fICAPABILITY\fB\fR +Query all packages that suggest \fICAPABILITY\fR. +.TP +\fB--whatsupplements \fICAPABILITY\fB\fR +Query all packages that supplement \fICAPABILITY\fR. +.TP +\fB--whatenhances \fICAPABILITY\fB\fR +Query all packages that enhance \fICAPABILITY\fR. +.SS "PACKAGE QUERY OPTIONS:" +.PP +.TP +\fB-d, --artifactfiles\fR +List only artifact files (implies \fB-l\fR). +.TP +\fB--changelog\fR +Display change information for the package. +.TP +\fB--changes\fR +Display change information for the package with full time stamps. +.TP +\fB-c, --configfiles\fR +List only configuration files (implies \fB-l\fR). +.TP +\fB--conflicts\fR +List capabilities this package conflicts with. +.TP +\fB-d, --docfiles\fR +List only documentation files (implies \fB-l\fR). +.TP +\fB--dump\fR +Dump file information as follows (implies \fB-l\fR): +.sp +.RS + +.nf +path size mtime digest mode owner group isconfig isdoc rdev symlink + +.fi +.RE +.TP +\fB--enhances\fR +List capabilities enhanced by package(s) +.TP +\fB--filesbypkg\fR +List all the files in each selected package. +.TP +\fB--filetriggers\fR +List filetrigger scriptlets from package(s). +.TP +\fB-i, --info\fR +Display package information, including name, version, and description. +This uses the \fB--queryformat\fR if one was specified. +.TP +\fB--last\fR +Orders the package listing by install time such that the latest +packages are at the top. +.TP +\fB-L, --licensefiles\fR +List only license files (implies \fB-l\fR). +.TP +\fB-l, --list\fR +List files in package. +.TP +\fB--obsoletes\fR +List packages this package obsoletes. +.TP +\fB--provides\fR +List capabilities this package provides. +.TP +\fB--recommends\fR +List capabilities recommended by package(s) +.TP +\fB-R, --requires\fR +List capabilities on which this package depends. +.TP +\fB--suggests\fR +List capabilities suggested by package(s) +.TP +\fB--supplements\fR +List capabilities supplemented by package(s) +.TP +\fB--scripts\fR +List the package specific scriptlet(s) that are used as part +of the installation and uninstallation processes. +.TP +\fB-s, --state\fR +Display the \fIstates\fR of files in the package +(implies \fB-l\fR). The state of each file is one of +\fInormal\fR, +\fInot installed\fR, or +\fIreplaced\fR. +.TP +\fB--triggers, --triggerscripts\fR +Display the trigger scripts, if any, which are contained in +the package. +.TP +\fB--noartifact\fR +Don't display artifact files. +\fB--noghost\fR +Don't display ghost files. Useful in combination with option --list. +.TP +\fB--noconfig\fR +Don't display config files. +.TP +\fB--xml\fR +Format package headers as XML. + +.SS "VERIFY OPTIONS" +.PP +The general form of an rpm verify command is +.PP + +\fBrpm\fR {\fB-V|--verify\fR} [\fBselect-options\fR] [\fBverify-options\fR] + +.PP +Verifying a package compares information about the installed files in +the package with information about the files taken from the package +metadata stored in the rpm database. Among other things, verifying +compares the size, digest, permissions, type, owner and group of +each file. Any discrepancies are displayed. +Files that were not installed from the package, for example, +documentation files excluded on installation using the +"\fB--excludedocs\fR" option, +will be silently ignored. +.PP +The package selection options are the same as for package +querying (including package manifest files as arguments). +Other options unique to verify mode are: +.TP +\fB--nodeps\fR +Don't verify dependencies of packages. +.TP +\fB--nodigest\fR +Don't verify package or header digests when reading. +.TP +\fB--nofiles\fR +Don't verify any attributes of package files. +.TP +\fB--noghost\fR +Don't verify ghost files. +.TP +\fB--noconfig\fR +Don't verify config files. +.TP +\fB--noscripts\fR +Don't execute the \fB%verifyscript\fR scriptlet (if any). +.TP +\fB--nosignature\fR +Don't verify package or header signatures when reading. +.TP +\fB--nolinkto\fR +.TP +\fB--nofiledigest\fR (formerly \fB--nomd5\fR) +.TP +\fB--nosize\fR +.TP +\fB--nouser\fR +.TP +\fB--nogroup\fR +.TP +\fB--nomtime\fR +.TP +\fB--nomode\fR +.TP +\fB--nordev\fR +Don't verify the corresponding file attribute. +.TP +\fB--nocaps\fR +Don't verify file capabilities. +.PP +The format of the output is a string of 9 characters, a possible +attribute marker: + +.nf +\fBc\fR \fB%config\fR configuration file. +\fBd\fR \fB%doc\fR documentation file. +\fBg\fR \fB%ghost\fR file (i.e. the file contents are not included in the package payload). +\fBl\fR \fB%license\fR license file. +\fBr\fR \fB%readme\fR readme file. +.fi + +from the package header, followed by the file name. +Each of the 9 characters denotes the result of a comparison of +attribute(s) of the file to the value of those attribute(s) recorded +in the database. A single +"\fB.\fR" (period) +means the test passed, while a single +"\fB?\fR" (question mark) +indicates the test could not be performed (e.g. file permissions +prevent reading). Otherwise, the (mnemonically +em\fBB\fRoldened) character denotes failure of +the corresponding \fB--verify\fR test: + +.nf +\fBS\fR file \fBS\fRize differs +\fBM\fR \fBM\fRode differs (includes permissions and file type) +\fB5\fR digest (formerly MD\fB5\fR sum) differs +\fBD\fR \fBD\fRevice major/minor number mismatch +\fBL\fR read\fBL\fRink(2) path mismatch +\fBU\fR \fBU\fRser ownership differs +\fBG\fR \fBG\fRroup ownership differs +\fBT\fR m\fBT\fRime differs +\fBP\fR ca\fBP\fRabilities differ +.fi + +.SS "MISCELLANEOUS COMMANDS" +.PP +.TP +\fBrpm\fR \fB--showrc\fR +shows the values \fBrpm\fR will use for all of the +options are currently set in +\fIrpmrc\fR and +\fImacros\fR +configuration file(s). +.TP +\fBrpm\fR \fB--setperms\fR \fIPACKAGE_NAME\fR +sets permissions of files in the given package. Consider using +\fB--restore\fR instead. +.TP +\fBrpm\fR \fB--setugids\fR \fIPACKAGE_NAME\fR +sets user/group ownership of files in the given package. This command can +change permissions and capabilities of files in that package. In most +cases it is better to use \fB--restore\fR instead. +.TP +\fBrpm\fR \fB--setcaps\fR \fIPACKAGE_NAME\fR +sets capabilities of files in the given package. Consider using +\fB--restore\fR instead. +.TP +\fBrpm\fR \fB--restore\fR \fIPACKAGE_NAME\fR +The option restores owner, group, permissions and capabilities of files +in the given package. +.TP +Options \fB--setperms\fR, \fB--setugids\fR, \fB--setcaps\fR and +\fB--restore\fR are mutually exclusive. + +.SS "FTP/HTTP OPTIONS" +.PP +\fBrpm\fR can act as an FTP and/or HTTP client so +that packages can be queried or installed from the internet. +Package files for install, upgrade, and query operations may be +specified as an +\fBftp\fR or +\fBhttp\fR +style URL: +.PP +ftp://USER:PASSWORD@HOST:PORT/path/to/package.rpm +.PP +If the \fB:PASSWORD\fR portion is omitted, the password will be +prompted for (once per user/hostname pair). If both the user and +password are omitted, anonymous \fBftp\fR is used. +In all cases, passive (PASV) \fBftp\fR transfers are +performed. +.PP +\fBrpm\fR allows the following options to be used with +ftp URLs: +.TP +\fB--ftpproxy \fIHOST\fB\fR +The host \fIHOST\fR will be used as a proxy server +for all ftp transfers, which allows users to ftp through firewall +machines which use proxy systems. This option may also be specified +by configuring the macro \fB%_ftpproxy\fR. +.TP +\fB--ftpport \fIPORT\fB\fR +The TCP \fIPORT\fR number to use for +the ftp connection on the proxy ftp server instead of the default +port. This option may also be specified by configuring the macro +\fB%_ftpport\fR. +.PP +\fBrpm\fR allows the following options to be used with +\fBhttp\fR URLs: +.TP +\fB--httpproxy \fIHOST\fB\fR +The host \fIHOST\fR will be used as +a proxy server for all \fBhttp\fR transfers. This +option may also be specified by configuring the macro +\fB%_httpproxy\fR. +.TP +\fB--httpport \fIPORT\fB\fR +The TCP \fIPORT\fR number to use for the +\fBhttp\fR connection on the proxy http server instead +of the default port. This option may also be specified by configuring +the macro \fB%_httpport\fR. +.SH "LEGACY ISSUES" +.SS "Executing rpmbuild" +.PP +The build modes of rpm are now resident in the \fI/usr/bin/rpmbuild\fR +executable. +Install the package containing \fBrpmbuild\fR (usually \fBrpm-build\fR) and see +\fBrpmbuild\fR(8) for documentation of all the \fBrpm\fR build modes. +.SH "FILES" +.SS "rpmrc Configuration" +.PP +.nf +\fI/usr/lib/rpm/rpmrc\fR +\fI/usr/lib/rpm/redhat/rpmrc\fR +\fI/etc/rpmrc\fR +\fI~/.rpmrc\fR +.fi +.SS "Macro Configuration" +.PP +.nf +\fI/usr/lib/rpm/macros\fR +\fI/usr/lib/rpm/redhat/macros\fR +\fI/etc/rpm/macros\fR +\fI~/.rpmmacros\fR +.fi +.SS "Database" +.PP +.nf +\fI/var/lib/rpm/Basenames\fR +\fI/var/lib/rpm/Conflictname\fR +\fI/var/lib/rpm/Dirnames\fR +\fI/var/lib/rpm/Group\fR +\fI/var/lib/rpm/Installtid\fR +\fI/var/lib/rpm/Name\fR +\fI/var/lib/rpm/Obsoletename\fR +\fI/var/lib/rpm/Packages\fR +\fI/var/lib/rpm/Providename\fR +\fI/var/lib/rpm/Requirename\fR +\fI/var/lib/rpm/Sha1header\fR +\fI/var/lib/rpm/Sigmd5\fR +\fI/var/lib/rpm/Triggername\fR +.fi +.SS "Temporary" +.PP +\fI/var/tmp/rpm*\fR +.SH "SEE ALSO" + +.nf +\fBrpm-misc(8), +\fBpopt\fR(3), +\fBrpm2cpio\fR(8), +\fBrpmbuild\fR(8), +\fBrpmdb\fR(8), +\fBrpmkeys\fR(8), +\fBrpmsign\fR(8), +\fBrpmspec\fR(8), +.fi + +\fBrpm --help\fR - as rpm supports customizing the options via popt aliases +it's impossible to guarantee that what's described in the manual matches +what's available. + + +\fBhttp://www.rpm.org/ <URL:http://www.rpm.org/> +\fR +.SH "AUTHORS" + +.nf +Marc Ewing <marc@redhat.com> +Jeff Johnson <jbj@redhat.com> +Erik Troan <ewt@redhat.com> +.fi diff --git a/upstream/opensuse-leap-15-6/man8/rpm2cpio.8 b/upstream/opensuse-leap-15-6/man8/rpm2cpio.8 new file mode 100644 index 00000000..c44120a6 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/rpm2cpio.8 @@ -0,0 +1,22 @@ +.\" rpm2cpio - Converts Red Hat Package (RPM) to cpio archive +.TH rpm2cpio 8 "11 January 2001" "Red Hat, Inc." +.SH NAME +rpm2cpio \- Extract cpio archive from RPM Package Manager (RPM) package. +.SH SYNOPSIS +\fBrpm2cpio\fP [filename] +.SH DESCRIPTION +\fBrpm2cpio\fP converts the .rpm file specified as a single argument +to a cpio archive on standard out. If a '-' argument is given, an rpm stream +is read from standard in. + +.br +.I "\fBrpm2cpio glint-1.0-1.i386.rpm | cpio -dium\fP" +.br +.I "\fBcat glint-1.0-1.i386.rpm | rpm2cpio - | cpio -tv\fP" + +.SH SEE ALSO +.IR rpm (8) +.SH AUTHOR +.nf +Erik Troan <ewt@redhat.com> +.fi diff --git a/upstream/opensuse-leap-15-6/man8/rpmbuild.8 b/upstream/opensuse-leap-15-6/man8/rpmbuild.8 new file mode 100644 index 00000000..49af829c --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/rpmbuild.8 @@ -0,0 +1,294 @@ +.\" This manpage has been automatically generated by docbook2man +.\" from a DocBook document. This tool can be found at: +.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> +.\" Please send any bug reports, improvements, comments, patches, +.\" etc. to Steve Cheng <steve@ggi-project.org>. +.TH "RPMBUILD" "8" "09 June 2002" "Red Hat, Inc." +.SH NAME +rpmbuild \- Build RPM Package(s) +.SH SYNOPSIS +.SS "BUILDING PACKAGES:" +.PP + + +\fBrpmbuild\fR {\fB-ba|-bb|-bp|-bc|-bi|-bl|-bs\fR} [\fBrpmbuild-options\fR] \fB\fISPECFILE\fB\fR\fI ...\fR + + +\fBrpmbuild\fR {\fB-ra|-rb|-rp|-rc|-ri|-rl|-rs\fR} [\fBrpmbuild-options\fR] \fB\fISOURCEPACKAGE\fB\fR\fI ...\fR + + +\fBrpmbuild\fR {\fB-ta|-tb|-tp|-tc|-ti|-tl|-ts\fR} [\fBrpmbuild-options\fR] \fB\fITARBALL\fB\fR\fI ...\fR + + + +\fBrpmbuild\fR {\fB--rebuild|--recompile\fR} \fB\fISOURCEPKG\fB\fR\fI ...\fR + +.SS "MISCELLANEOUS:" +.PP + + +\fBrpmbuild\fR \fB--showrc\fR + +.SS "rpmbuild-options" +.PP + + + [\fB--buildroot \fIDIRECTORY\fB\fR] [\fB--clean\fR] [\fB--nobuild\fR] + [\fB--rmsource\fR] [\fB--rmspec\fR] [\fB--short-circuit\fR] [\fB--build-in-place\fR] + [\fB--noprep\fR] [\fB--noclean\fR] [\fB--nocheck\fR] + [\fB--rpmfcdebug\fR] + [\fB--target \fIPLATFORM\fB\fR] + [\fB--with \fIOPTION\fB\fR] [\fB--without \fIOPTION\fB\fR] + +.SH "DESCRIPTION" +.PP +\fBrpmbuild\fR is used to build both binary and source software packages. +A \fBpackage\fR consists of an archive of files and +meta-data used to install and erase the archive files. The meta-data +includes helper scripts, file attributes, and descriptive information +about the package. +\fBPackages\fR come in two varieties: binary packages, +used to encapsulate software to be installed, and source packages, +containing the source code and recipe necessary to produce binary +packages. +.PP +One of the following basic modes must be selected: +\fBBuild Package\fR, +\fBBuild Package from Tarball\fR, +\fBRecompile Package\fR, +\fBShow Configuration\fR. +.SS "GENERAL OPTIONS" +.PP +These options can be used in all the different modes. +.TP +\fB-?, --help\fR +Print a longer usage message then normal. +.TP +\fB--version\fR +Print a single line containing the version number of \fBrpm\fR +being used. +.TP +\fB--quiet\fR +Print as little as possible - normally only error messages will +be displayed. +.TP +\fB-v\fR +Print verbose information - normally routine progress messages will be +displayed. +.TP +\fB-vv\fR +Print lots of ugly debugging information. +.TP +\fB--rpmfcdebug\fR +Enables to debug dependencies generation. +.TP +\fB--rcfile \fIFILELIST\fB\fR +Each of the files in the colon separated +\fIFILELIST\fR +is read sequentially by \fBrpm\fR for configuration +information. +Only the first file in the list must exist, and tildes will be +expanded to the value of \fB$HOME\fR. +The default \fIFILELIST\fR is +\fI/usr/lib/rpm/rpmrc\fR:\fI/usr/lib/rpm/redhat/rpmrc\fR:\fI/etc/rpmrc\fR:\fI~/.rpmrc\fR. +.TP +\fB--pipe \fICMD\fB\fR +Pipes the output of \fBrpm\fR to the command \fICMD\fR. +.TP +\fB--dbpath \fIDIRECTORY\fB\fR +Use the database in \fIDIRECTORY\fR rather +than the default path \fI/var/lib/rpm\fR +.TP +\fB--root \fIDIRECTORY\fB\fR +Use the file system tree rooted at \fIDIRECTORY\fR for all operations. +Note that this means the database within +\fIDIRECTORY\fR +will be used for dependency checks and any scriptlet(s) (e.g. +\fB%post\fR if installing, or +\fB%prep\fR if building, a package) +will be run after a chroot(2) to +\fIDIRECTORY\fR. +.TP +\fB-D, --define='\fIMACRO EXPR\fB'\fR +Defines \fIMACRO\fR with value \fIEXPR\fR. +.SS "BUILD OPTIONS" +.PP +The general form of an rpm build command is +.PP + +\fBrpmbuild\fR \fB-b\fISTAGE\fB|-r\fISTAGE\fB|-t\fISTAGE\fB\fR [ \fB rpmbuild-options +\fR ] \fB\fIFILE\fB\fR\fI ...\fR + +.PP +The argument used is \fB-b\fR if a spec file is being +used to build the package, \fB-r\fR if a source package is to be rebuild +and \fB-t\fR if \fBrpmbuild\fR +should look inside of a (possibly compressed) tar file for +the spec file to use. After the first argument, the next +character (\fISTAGE\fR) specifies the stages +of building and packaging to be done and is one of: +.TP +\fB-ba\fR +Build binary and source packages (after doing the %prep, %build, and +%install stages). +.TP +\fB-bb\fR +Build a binary package (after doing the %prep, %build, and %install +stages). +.TP +\fB-bp\fR +Executes the "%prep" stage from the spec file. Normally this +involves unpacking the sources and applying any patches. +.TP +\fB-bc\fR +Do the "%build" stage from the spec file (after doing the %prep stage). +This generally involves the equivalent of a "make". +.TP +\fB-bi\fR +Do the "%install" stage from the spec file (after doing the %prep and +%build stages). This generally involves the equivalent of a +"make install". +.TP +\fB-bl\fR +Do a "list check". The "%files" section from the spec file is +macro expanded, and checks are made to verify that each file +exists. +.TP +\fB-bs\fR +Build just the source package. +.PP +The following options may also be used: +.TP +\fB--buildroot \fIDIRECTORY\fB\fR +When building a package, override the BuildRoot tag with directory +\fIDIRECTORY\fR. +.TP +\fB--clean\fR +Remove the build tree after the packages are made. +.TP +\fB--nobuild\fR +Do not execute any build stages. Useful for testing out spec files. +.TP +\fB--noprep\fR +Do not execute %prep build stage even if present in spec. +.TP +\fB--noclean\fR +Do not execute %clean build stage even if present in spec. +.TP +\fB--nocheck\fR +Do not execute %check build stage even if present in spec. +.TP +\fB--nodebuginfo\fR +Do not generate debuginfo packages.. +.TP +\fB--nodeps\fR +Do not verify build dependencies. +.TP +\fB--rmsource\fR +Remove the sources after the build (may also be +used standalone, e.g. "\fBrpmbuild\fR \fB--rmsource foo.spec\fR"). +.TP +\fB--rmspec\fR +Remove the spec file after the build (may also be +used standalone, eg. "\fBrpmbuild\fR \fB--rmspec foo.spec\fR"). +.TP +\fB--short-circuit\fR +Skip straight to specified stage (i.e., skip all stages leading +up to the specified stage). Only valid with \fB-bc\fR, \fB-bi\fR, +and \fB-bb\fR. Useful for local testing only. Packages built this +way will be marked with an unsatisfiable dependency to prevent +their accidental use. +.TP +\fB--build-in-place\fR +Build from locally checked out sources. Sets _builddir to current working +directory. Skips handling of -n and untar in the %setup and the deletion of +the buildSubdir. +.TP +\fB--target \fIPLATFORM\fB\fR +When building the package, interpret \fIPLATFORM\fR +as \fBarch-vendor-os\fR and set the macros +\fB%_target\fR, +\fB%_target_cpu\fR, and +\fB%_target_os\fR +accordingly. +.TP +\fB--with \fIOPTION\fB\fR +Enable configure \fIOPTION\fR for build. +.TP +\fB--without \fIOPTION\fB\fR +Disable configure \fIOPTION\fR for build. +.SS "REBUILD AND RECOMPILE OPTIONS" +.PP +There are two other ways to invoke building with rpm: +.PP + +\fBrpmbuild\fR \fB--rebuild|--recompile\fR \fB\fISOURCEPKG\fB\fR\fI ...\fR + +.PP +When invoked this way, \fBrpmbuild\fR installs the named source +package, and does a prep, compile and install. In addition, +\fB--rebuild\fR builds a new binary package. When the build +has completed, the build directory is removed (as in +\fB--clean\fR) and the the sources and spec file for +the package are removed. + +These options are now superseded by the \fB-r*\fR options which allow +much more fine control over what stages of the build to run. +.SS "SHOWRC" +.PP +The command +.PP + +\fBrpmbuild\fR \fB--showrc\fR + +.PP +shows the values \fBrpmbuild\fR will use for all of the +options are currently set in +\fIrpmrc\fR and +\fImacros\fR +configuration file(s). +.SH "FILES" +.SS "rpmrc Configuration" +.PP +.nf +\fI/usr/lib/rpm/rpmrc\fR +\fI/usr/lib/rpm/redhat/rpmrc\fR +\fI/etc/rpmrc\fR +\fI~/.rpmrc\fR +.fi +.SS "Macro Configuration" +.PP +.nf +\fI/usr/lib/rpm/macros\fR +\fI/usr/lib/rpm/redhat/macros\fR +\fI/etc/rpm/macros\fR +\fI~/.rpmmacros\fR +.fi +.SS "Temporary" +.PP +\fI/var/tmp/rpm*\fR +.SH "SEE ALSO" + +.nf +\fBgendiff\fR(1), +\fBpopt\fR(3), +\fBrpm\fR(8), +\fBrpm2cpio\fR(8), +\fBrpmkeys\fR(8) +\fBrpmspec\fR(8), +\fBrpmsign\fR(8), +.fi + +\fBrpmbuild --help\fR - as rpm supports customizing the options via popt +aliases it's impossible to guarantee that what's described in the manual +matches what's available. + +\fBhttp://www.rpm.org/ <URL:http://www.rpm.org/> +\fR +.SH "AUTHORS" + +.nf +Marc Ewing <marc@redhat.com> +Jeff Johnson <jbj@redhat.com> +Erik Troan <ewt@redhat.com> +.fi diff --git a/upstream/opensuse-leap-15-6/man8/rpmdb.8 b/upstream/opensuse-leap-15-6/man8/rpmdb.8 new file mode 100644 index 00000000..f1ee5dc4 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/rpmdb.8 @@ -0,0 +1,48 @@ +.TH "RPMDB" "8" "29 June 2010" "Red Hat, Inc" +.SH NAME +rpmdb \- RPM Database Tool +.SH SYNOPSIS + +\fBrpm\fR {\fB--initdb|--rebuilddb\fR} + +.SH "DESCRIPTION" +The general form of an rpm rebuild database command is +.PP + +\fBrpm\fR {\fB--initdb|--rebuilddb\fR} [\fB-v\fR] [\fB--dbpath \fIDIRECTORY\fB\fR] [\fB--root \fIDIRECTORY\fB\fR] + +.PP +Use \fB--initdb\fR to create a new database if one doesn't already exist +(existing database is not overwritten), use +\fB--rebuilddb\fR to rebuild the database indices from +the installed package headers. +.PP + +.SH "SEE ALSO" + +.nf +\fBpopt\fR(3), +\fBrpm\fR(8), +\fBrpmkeys\fR(8), +\fBrpmsign\fR(8), +\fBrpm2cpio\fR(8), +\fBrpmbuild\fR(8), +\fBrpmspec\fR(8), +.fi + +\fBrpm --help\fR - as rpm supports customizing the options via popt aliases +it's impossible to guarantee that what's described in the manual matches +what's available. + + +\fBhttp://www.rpm.org/ <URL:http://www.rpm.org/> +\fR +.SH "AUTHORS" + +.nf +Marc Ewing <marc@redhat.com> +Jeff Johnson <jbj@redhat.com> +Erik Troan <ewt@redhat.com> +Panu Matilainen <pmatilai@redhat.com> +.fi + diff --git a/upstream/opensuse-leap-15-6/man8/rpmdeps.8 b/upstream/opensuse-leap-15-6/man8/rpmdeps.8 new file mode 100644 index 00000000..29ada034 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/rpmdeps.8 @@ -0,0 +1,29 @@ +.\" This manpage has been automatically generated by docbook2man +.\" from a DocBook document. This tool can be found at: +.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> +.\" Please send any bug reports, improvements, comments, patches, +.\" etc. to Steve Cheng <steve@ggi-project.org>. +.TH "RPMDEPS" "8" "24 October 2002" "Red Hat, Inc." +.SH NAME +rpmdeps \- Generate RPM Package Dependencies +.SH SYNOPSIS +.PP + + +\fBrpmdeps\fR \fB{-P|--provides}\fR \fB{-R|--requires}\fR \fB{--rpmfcdebug}\fR \fB\fIFILE\fB\fR\fI ...\fR + +.SH "DESCRIPTION" +.PP +\fBrpmdeps\fR generates package dependencies +for the set of \fIFILE\fR arguments. +Each \fIFILE\fR argument is searched for +Elf32/Elf64, script interpreter, or per-script dependencies, +and the dependencies are printed to stdout. +.SH "SEE ALSO" + +\fBrpm\fR(8), + +\fBrpmbuild\fR(8), +.SH "AUTHORS" + +Jeff Johnson <jbj@redhat.com> diff --git a/upstream/opensuse-leap-15-6/man8/rpmgraph.8 b/upstream/opensuse-leap-15-6/man8/rpmgraph.8 new file mode 100644 index 00000000..a20e8c20 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/rpmgraph.8 @@ -0,0 +1,45 @@ +.\" This manpage has been automatically generated by docbook2man +.\" from a DocBook document. This tool can be found at: +.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> +.\" Please send any bug reports, improvements, comments, patches, +.\" etc. to Steve Cheng <steve@ggi-project.org>. +.TH "RPMGRAPH" "8" "30 June 2002" "Red Hat, Inc." +.SH NAME +rpmgraph \- Display RPM Package Dependency Graph +.SH SYNOPSIS +.PP + + +\fBrpmgraph\fR \fB\fIPACKAGE_FILE\fB\fR\fI ...\fR + +.SH "DESCRIPTION" +.PP +\fBrpmgraph\fR uses \fIPACKAGE_FILE\fR arguments +to generate a package dependency graph. Each +\fIPACKAGE_FILE\fR argument is read and +added to an rpm transaction set. The elements of the transaction +set are partially ordered using a topological sort. The partially +ordered elements are then printed to standard output. +.PP +Nodes in the dependency graph are package names, and edges in the +directed graph point to the parent of each node. The parent node +is defined as the last predecessor of a package when partially ordered +using the package dependencies as a relation. That means that the +parent of a given package is the package's last prerequisite. +.PP +The output is in \fBdot\fR(1) directed graph format, +and can be displayed or printed using the \fBdotty\fR +graph editor from the \fBgraphviz\fR package. +There are no \fBrpmgraph\fR specific options, only common \fBrpm\fR options. +See the \fBrpmgraph\fR usage message for what is currently implemented. +.SH "SEE ALSO" + +\fBdot\fR(1), + +\fBdotty\fR(1), + +\fB http://www.graphviz.org/ <URL:http://www.graphviz.org/> +\fR +.SH "AUTHORS" + +Jeff Johnson <jbj@redhat.com> diff --git a/upstream/opensuse-leap-15-6/man8/rpmkeys.8 b/upstream/opensuse-leap-15-6/man8/rpmkeys.8 new file mode 100644 index 00000000..5f26dc5d --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/rpmkeys.8 @@ -0,0 +1,77 @@ +.TH "RPMKEYS" "8" "29 October 2010" "Red Hat, Inc" +.SH NAME +rpmkeys \- RPM Keyring +.SH SYNOPSIS +.PP + +\fBrpmkeys\fR {\fB--import|--checksig\fR} + +.SH "DESCRIPTION" +.PP +The general forms of rpm digital signature commands are +.PP + +\fBrpmkeys\fR \fB--import\fR \fB\fIPUBKEY\fB\fR\fI ...\fR + +\fBrpmkeys\fR {\fB-K|--checksig\fR} \fB\fIPACKAGE_FILE\fB\fR\fI ...\fR + +.\" These are not implemented yet... +.\" \fBrpm\fR \fB--list-key[s]\fR \fB\fIKEY_ID\fB\fR\fI ...\fR +.\" +.\" \fBrpm\fR \fB--delete-key[s]\fR \fB\fIKEY_ID\fB\fR\fI ...\fR +.\" + +.PP +The \fB--checksig\fR option checks all the digests and signatures contained in +\fIPACKAGE_FILE\fR to ensure +the integrity and origin of the package. Note that +signatures are now verified whenever a package is read, +and \fB--checksig\fR is useful to verify +all of the digests and signatures associated with a package. +.PP +Digital signatures cannot be verified without a public key. +An ASCII armored public key can be added to the \fBrpm\fR database +using \fB--import\fR. An imported public key is +carried in a header, and key ring management is performed +exactly like package management. For example, all currently imported +public keys can be displayed by: +.PP +\fBrpm -qa gpg-pubkey*\fR +.PP +Details about a specific public key, when imported, can be displayed +by querying. Here's information about the Red Hat GPG/DSA key: +.PP +\fBrpm -qi gpg-pubkey-db42a60e\fR +.PP +Finally, public keys can be erased after importing just like +packages. Here's how to remove the Red Hat GPG/DSA key +.PP +\fBrpm -e gpg-pubkey-db42a60e\fR +.PP + +.SH "SEE ALSO" +.nf +\fBpopt\fR(3), +\fBrpm\fR(8), +\fBrpmdb\fR(8), +\fBrpmsign\fR(8), +\fBrpm2cpio\fR(8), +\fBrpmbuild\fR(8), +\fBrpmspec\fR(8), +.fi + +\fBrpmkeys --help\fR - as rpm supports customizing the options via popt aliases +it's impossible to guarantee that what's described in the manual matches +what's available. + + +\fBhttp://www.rpm.org/ <URL:http://www.rpm.org/> +\fR +.SH "AUTHORS" + +.nf +Marc Ewing <marc@redhat.com> +Jeff Johnson <jbj@redhat.com> +Erik Troan <ewt@redhat.com> +Panu Matilainen <pmatilai@redhat.com> +.fi diff --git a/upstream/opensuse-leap-15-6/man8/rpmqpack.8 b/upstream/opensuse-leap-15-6/man8/rpmqpack.8 new file mode 100644 index 00000000..81e2bc4c --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/rpmqpack.8 @@ -0,0 +1,25 @@ +.TH RPMQPACK 8 "Mar 2002" +.SH NAME +rpmqpack \- check for installed rpm packages + +.SH SYNOPSIS +.B rpmqpack +.RI [ pack1 "] [" pack2 ]... + +.SH DESCRIPTION +rpmqpack checks if packages given as arguments are installed in +the system. It prints each installed package to stdout. +If no arguments are given all installed packages are printed. + +.SH EXIT STATUS +rpmqpack returns 0 if all given packages are installed, otherwise +1. + +.SH SEE ALSO +.BR rpm (1) + +.SH COPYRIGHT +2002 SUSE Linux AG Nuernberg, Germany. + +.SH AUTHOR +Michael Schroeder <mls@suse.de> diff --git a/upstream/opensuse-leap-15-6/man8/rpmsign.8 b/upstream/opensuse-leap-15-6/man8/rpmsign.8 new file mode 100644 index 00000000..d895a3b8 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/rpmsign.8 @@ -0,0 +1,104 @@ +.TH "RPMSIGN" "8" "Red Hat, Inc" +.SH NAME +rpmsign \- RPM Package Signing +.SH SYNOPSIS +.SS "SIGNING PACKAGES:" +.PP + +\fBrpm\fR \fB--addsign|--resign\fR [\fBrpmsign-options\fR] \fB\fIPACKAGE_FILE\fB\fR\fI ...\fR + +\fBrpm\fR \fB--delsign\fR \fB\fIPACKAGE_FILE\fB\fR\fI ...\fR + +.SS "rpmsign-options" +.PP +[\fb--fskpath \fIKEY\fb\fR] [\fB--signfiles\fR] + +.SH DESCRIPTION +.PP +Both of the \fB--addsign\fR and \fB--resign\fR +options generate and insert new signatures for each package +\fIPACKAGE_FILE\fR given, replacing any +existing signatures. There are two options for historical reasons, +there is no difference in behavior currently. + +To create a signature rpm needs to verify the package's checksum. As a result +packages with a MD5/SHA1 checksums cannot be signed in FIPS mode. + +\fBrpm\fR \fB--delsign\fR \fB\fIPACKAGE_FILE\fB\fR\fI ...\fR + +.PP +Delete all signatures from each package \fIPACKAGE_FILE\fR given. + +.SS "SIGN OPTIONS" +.PP +.TP +\fB--fskpath \fIKEY\fB\fR +Used with \fB--signfiles\fR, use file signing key \fIKey\fR. +.TP +\fB--signfiles\fR +Sign package files. The macro \fB%_binary_filedigest_algorithm\fR must +be set to a supported algorithm before building the package. The +supported algorithms are SHA1, SHA256, SHA384, and SHA512, which are +represented as 2, 8, 9, and 10 respectively. The file signing key (RSA +private key) must be set before signing the package, it can be configured on the command line with \fB--fskpath\fR or the macro %_file_signing_key. + +.SS "USING GPG TO SIGN PACKAGES" +.PP +In order to sign packages using GPG, \fBrpm\fR +must be configured to run GPG and be able to find a key +ring with the appropriate keys. By default, +\fBrpm\fR uses the same conventions as GPG +to find key rings, namely the \fB$GNUPGHOME\fR environment +variable. If your key rings are not located where GPG expects +them to be, you will need to configure the macro +\fB%_gpg_path\fR +to be the location of the GPG key rings to use. +If you want to be able to sign packages you create yourself, you +also need to create your own public and secret key pair (see the +GPG manual). You will also need to configure the \fBrpm\fR macros +.TP +\fB%_gpg_name\fR +The name of the "user" whose key you wish to use to sign your packages. +.PP +For example, to be able to use GPG to sign packages as the user +\fI"John Doe <jdoe@foo.com>"\fR +from the key rings located in \fI/etc/rpm/.gpg\fR +using the executable \fI/usr/bin/gpg\fR you would include +.PP +.nf +%_gpg_path /etc/rpm/.gpg +%_gpg_name John Doe <jdoe@foo.com> +%__gpg /usr/bin/gpg +.fi +.PP +in a macro configuration file. Use \fI/etc/rpm/macros\fR +for per-system configuration and \fI~/.rpmmacros\fR +for per-user configuration. Typically it's sufficient to set just %_gpg_name. +.PP +.SH "SEE ALSO" +.nf +\fBpopt\fR(3), +\fBrpm\fR(8), +\fBrpmdb\fR(8), +\fBrpmkeys\fR(8), +\fBrpm2cpio\fR(8), +\fBrpmbuild\fR(8), +\fBrpmspec\fR(8), +.fi + +\fBrpmsign --help\fR - as rpm supports customizing the options via popt aliases +it's impossible to guarantee that what's described in the manual matches +what's available. + + +\fBhttp://www.rpm.org/ <URL:http://www.rpm.org/> +\fR +.SH "AUTHORS" + +.nf +Marc Ewing <marc@redhat.com> +Jeff Johnson <jbj@redhat.com> +Erik Troan <ewt@redhat.com> +Panu Matilainen <pmatilai@redhat.com> +Fionnuala Gunter <fin@linux.vnet.ibm.com> +.fi diff --git a/upstream/opensuse-leap-15-6/man8/rpmspec.8 b/upstream/opensuse-leap-15-6/man8/rpmspec.8 new file mode 100644 index 00000000..85b7b663 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/rpmspec.8 @@ -0,0 +1,124 @@ +.TH "RPMSPEC" "8" "29 October 2010" "Red Hat, Inc" +.SH NAME +rpmspec \- RPM Spec Tool +.SH SYNOPSIS +.SS "QUERYING SPEC FILES:" +.PP + +\fBrpmspec\fR {\fB-q|--query\fR} [\fBselect-options\fR] [\fBquery-options\fR] \fB\fISPEC_FILE\fB\fR\fI ...\fR + +.SS "PARSING SPEC FILES TO STDOUT:" +.PP + +\fBrpmspec\fR {\fB-P|--parse\fR} \fB\fISPEC_FILE\fB\fR\fI ...\fR + +.SH DESCRIPTION +.PP +\fBrpmspec\fR is a tool for querying a spec file. More specifically for querying hypothetical packages which would be created from the given spec file. So querying a spec file with \fBrpmspec\fR is similar to querying a package built from that spec file. But is is not identical. With \fBrpmspec\fR you can't query all fields which you can query from a built package. E. g. you can't query BUILDTIME with \fBrpmspec\fR for obvious reasons. You also cannot query other fields automatically generated during a build of a package like auto generated dependencies. + +.SS "select-options" +.PP + + [\fB\--rpms\fB\fR] + [\fB\--srpm\fB\fR] + +.SS "query-options" +.PP + + [\fB--qf,--queryformat \fIQUERYFMT\fB\fR] + [\fB--target \fITARGET_PLATFORM\fB\fR] + +.SS "QUERY OPTIONS" +.PP +The general form of an rpm spec query command is +.PP + +\fBrpm\fR {\fB-q|--query\fR} [\fBselect-options\fR] [\fBquery-options\fR] + +.PP +You may specify the format that the information should be +printed in. To do this, you use the + + \fB--qf|--queryformat\fR \fB\fIQUERYFMT\fB\fR + +option, followed by the \fIQUERYFMT\fR format string. +See \fBrpm(8)\fR for details. +.PP + +.SS "SELECT OPTIONS" +.PP + \fB--rpms\fR +Operate on the all binary package headers generated from spec. + \fB--builtrpms\fR +Operate only on the binary package headers of packages which would be built from spec. That means ignoring package headers of packages that won't be built from spec i. e. ignoring package headers of packages without file section. + \fB--srpm\fR +Operate on the source package header(s) generated from spec. + +.SH EXAMPLES +.PP +Get list of binary packages which would be generated from the rpm spec file: +.PP +.RS 4 +.nf + $ rpmspec -q rpm.spec + rpm-4.11.3-3.fc20.x86_64 + rpm-libs-4.11.3-3.fc20.x86_64 + rpm-build-libs-4.11.3-3.fc20.x86_64 + ... +.RE +.PP +Get summary infos for single binary packages generated from the rpm spec file: +.PP +.RS 4 +.nf + $ rpmspec -q --qf "%{name}: %{summary}\\n" rpm.spec + rpm: The RPM package management system + rpm-libs: Libraries for manipulating RPM packages + rpm-build-libs: Libraries for building and signing RPM packages + ... +.RE +.PP +Get the source package which would be generated from the rpm spec file: +.PP +.RS 4 +.nf + $ rpmspec -q --srpm rpm.spec + rpm-4.11.3-3.fc20.x86_64 +.RE +.PP +Parse the rpm spec file to stdout: +.PP +.RS 4 +.nf + $ rpmspec -P rpm.spec + Summary: The RPM package management system + Name: rpm + Version: 4.14.0 + ... +.RE +.SH "SEE ALSO" +.nf +\fBpopt\fR(3), +\fBrpm\fR(8), +\fBrpmdb\fR(8), +\fBrpmkeys\fR(8), +\fBrpmsign\fR(8), +\fBrpm2cpio\fR(8), +\fBrpmbuild\fR(8), +.fi + +\fBrpmspec --help\fR - as rpm supports customizing the options via popt aliases +it's impossible to guarantee that what's described in the manual matches +what's available. + + +\fBhttp://www.rpm.org/ <URL:http://www.rpm.org/> +\fR +.SH "AUTHORS" + +.nf +Marc Ewing <marc@redhat.com> +Jeff Johnson <jbj@redhat.com> +Erik Troan <ewt@redhat.com> +Panu Matilainen <pmatilai@redhat.com> +.fi diff --git a/upstream/opensuse-leap-15-6/man8/rtcwake.8 b/upstream/opensuse-leap-15-6/man8/rtcwake.8 new file mode 100644 index 00000000..1f0e284e --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/rtcwake.8 @@ -0,0 +1,256 @@ +'\" t +.\" Title: rtcwake +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "RTCWAKE" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +rtcwake \- enter a system sleep state until specified wakeup time +.SH "SYNOPSIS" +.sp +\fBrtcwake\fP [options] [\fB\-d\fP \fIdevice\fP] [\fB\-m\fP \fIstandby_mode\fP] {\fB\-s\fP \fIseconds\fP|\fB\-t\fP \fItime_t\fP} +.SH "DESCRIPTION" +.sp +This program is used to enter a system sleep state and to automatically wake from it at a specified time. +.sp +This uses cross\-platform Linux interfaces to enter a system sleep state, and leave it no later than a specified time. It uses any RTC framework driver that supports standard driver model wakeup flags. +.sp +This is normally used like the old \fBapmsleep\fP utility, to wake from a suspend state like ACPI S1 (standby) or S3 (suspend\-to\-RAM). Most platforms can implement those without analogues of BIOS, APM, or ACPI. +.sp +On some systems, this can also be used like \fBnvram\-wakeup\fP, waking from states like ACPI S4 (suspend to disk). Not all systems have persistent media that are appropriate for such suspend modes. +.sp +Note that alarm functionality depends on hardware; not every RTC is able to setup an alarm up to 24 hours in the future. +.sp +The suspend setup may be interrupted by active hardware; for example wireless USB input devices that continue to send events for some fraction of a second after the return key is pressed. \fBrtcwake\fP tries to avoid this problem and it waits to terminal to settle down before entering a system sleep. +.SH "OPTIONS" +.sp +\fB\-A\fP, \fB\-\-adjfile\fP \fIfile\fP +.RS 4 +Specify an alternative path to the adjust file. +.RE +.sp +\fB\-a\fP, \fB\-\-auto\fP +.RS 4 +Read the clock mode (whether the hardware clock is set to UTC or local time) from the \fIadjtime\fP file, where \fBhwclock\fP(8) stores that information. This is the default. +.RE +.sp +\fB\-\-date\fP \fItimestamp\fP +.RS 4 +Set the wakeup time to the value of the timestamp. Format of the timestamp can be any of the following: +.RE +.TS +allbox tab(:); +lt lt. +T{ +.sp +YYYYMMDDhhmmss +T}:T{ +.sp + +T} +T{ +.sp +YYYY\-MM\-DD hh:mm:ss +T}:T{ +.sp + +T} +T{ +.sp +YYYY\-MM\-DD hh:mm +T}:T{ +.sp +(seconds will be set to 00) +T} +T{ +.sp +YYYY\-MM\-DD +T}:T{ +.sp +(time will be set to 00:00:00) +T} +T{ +.sp +hh:mm:ss +T}:T{ +.sp +(date will be set to today) +T} +T{ +.sp +hh:mm +T}:T{ +.sp +(date will be set to today, seconds to 00) +T} +T{ +.sp +tomorrow +T}:T{ +.sp +(time is set to 00:00:00) +T} +T{ +.sp ++5min +T}:T{ +.sp + +T} +.TE +.sp +.sp +\fB\-d\fP, \fB\-\-device\fP \fIdevice\fP +.RS 4 +Use the specified \fIdevice\fP instead of \fBrtc0\fP as realtime clock. This option is only relevant if your system has more than one RTC. You may specify \fBrtc1\fP, \fBrtc2\fP, ... here. +.RE +.sp +\fB\-l\fP, \fB\-\-local\fP +.RS 4 +Assume that the hardware clock is set to local time, regardless of the contents of the \fIadjtime\fP file. +.RE +.sp +\fB\-\-list\-modes\fP +.RS 4 +List available \fB\-\-mode\fP option arguments. +.RE +.sp +\fB\-m\fP, \fB\-\-mode\fP \fImode\fP +.RS 4 +Go into the given standby state. Valid values for \fImode\fP are: +.sp +\fBstandby\fP +.RS 4 +ACPI state S1. This state offers minimal, though real, power savings, while providing a very low\-latency transition back to a working system. This is the default mode. +.RE +.sp +\fBfreeze\fP +.RS 4 +The processes are frozen, all the devices are suspended and all the processors idled. This state is a general state that does not need any platform\-specific support, but it saves less power than Suspend\-to\-RAM, because the system is still in a running state. (Available since Linux 3.9.) +.RE +.sp +\fBmem\fP +.RS 4 +ACPI state S3 (Suspend\-to\-RAM). This state offers significant power savings as everything in the system is put into a low\-power state, except for memory, which is placed in self\-refresh mode to retain its contents. +.RE +.sp +\fBdisk\fP +.RS 4 +ACPI state S4 (Suspend\-to\-disk). This state offers the greatest power savings, and can be used even in the absence of low\-level platform support for power management. This state operates similarly to Suspend\-to\-RAM, but includes a final step of writing memory contents to disk. +.RE +.sp +\fBoff\fP +.RS 4 +ACPI state S5 (Poweroff). This is done by calling \(aq/sbin/shutdown\(aq. Not officially supported by ACPI, but it usually works. +.RE +.sp +\fBno\fP +.RS 4 +Don\(cqt suspend, only set the RTC wakeup time. +.RE +.sp +\fBon\fP +.RS 4 +Don\(cqt suspend, but read the RTC device until an alarm time appears. This mode is useful for debugging. +.RE +.sp +\fBdisable\fP +.RS 4 +Disable a previously set alarm. +.RE +.sp +\fBshow\fP +.RS 4 +Print alarm information in format: "alarm: off|on <time>". The time is in ctime() output format, e.g., "alarm: on Tue Nov 16 04:48:45 2010". +.RE +.RE +.sp +\fB\-n\fP, \fB\-\-dry\-run\fP +.RS 4 +This option does everything apart from actually setting up the alarm, suspending the system, or waiting for the alarm. +.RE +.sp +\fB\-s\fP, \fB\-\-seconds\fP \fIseconds\fP +.RS 4 +Set the wakeup time to \fIseconds\fP in the future from now. +.RE +.sp +\fB\-t\fP, \fB\-\-time\fP \fItime_t\fP +.RS 4 +Set the wakeup time to the absolute time \fItime_t\fP. \fItime_t\fP is the time in seconds since 1970\-01\-01, 00:00 UTC. Use the \fBdate\fP(1) tool to convert between human\-readable time and \fItime_t\fP. +.RE +.sp +\fB\-u\fP, \fB\-\-utc\fP +.RS 4 +Assume that the hardware clock is set to UTC (Universal Time Coordinated), regardless of the contents of the \fIadjtime\fP file. +.RE +.sp +\fB\-v\fP, \fB\-\-verbose\fP +.RS 4 +Be verbose. +.RE +.sp +\fB\-V\fP, \fB\-\-version\fP +.RS 4 +Display version information and exit. +.RE +.sp +\fB\-h\fP, \fB\-\-help\fP +.RS 4 +Display help text and exit. +.RE +.SH "NOTES" +.sp +Some PC systems can\(cqt currently exit sleep states such as \fBmem\fP using only the kernel code accessed by this driver. They need help from userspace code to make the framebuffer work again. +.SH "FILES" +.sp +\fI/etc/adjtime\fP +.SH "HISTORY" +.sp +The program was posted several times on LKML and other lists before appearing in kernel commit message for Linux 2.6 in the GIT commit 87ac84f42a7a580d0dd72ae31d6a5eb4bfe04c6d. +.SH "AUTHORS" +.sp +The program was written by \c +.MTO "dbrownell\(atusers.sourceforge.net" "David Brownell" "" +and improved by +.MTO "bwalle\(atsuse.de" "Bernhard Walle" "." +.SH "COPYRIGHT" +.sp +This is free software. You may redistribute copies of it under the terms of the \c +.URL "http://www.gnu.org/licenses/gpl.html" "GNU General Public License" "." +There is NO WARRANTY, to the extent permitted by law. +.SH "SEE ALSO" +.sp +\fBhwclock\fP(8), +\fBdate\fP(1) +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBrtcwake\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/sa.8 b/upstream/opensuse-leap-15-6/man8/sa.8 new file mode 100644 index 00000000..91487727 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/sa.8 @@ -0,0 +1,425 @@ +.TH SA 8 "1997 August 19" +.SH NAME +sa \- summarizes accounting information +.SH SYNOPSIS +.hy 0 +.na +.TP +.B sa +[ +.B \-a +| +.B \-\-list-all-names +] +.br +[ +.B \-b +| +.B \-\-sort-sys-user-div-calls +] +.br +[ +.B \-c +| +.B \-\-percentages +] +[ +.B \-d +| +.B \-\-sort-avio +] +.br +[ +.B \-D +| +.B \-\-sort-tio +] +[ +.B \-f +| +.B \-\-not-interactive +] +.br +[ +.B \-i +| +.B \-\-dont-read-summary-files +] +.br +[ +.B \-j +| +.B \-\-print-seconds +] +[ +.B \-k +| +.B \-\-sort-cpu-avmem +] +.br +[ +.B \-K +| +.B \-\-sort-ksec +] +[ +.B \-l +| +.B \-\-separate-times +] +.br +[ +.B \-m +| +.B \-\-user-summary +] +[ +.B \-n +| +.B \-\-sort-num-calls +] +.br +[ +.B \-p +| +.B \-\-show-paging +] +[ +.B \-P +| +.B \-\-show-paging-avg +] +.br +[ +.B \-r +| +.B \-\-reverse-sort +] +[ +.B \-s +| +.B \-\-merge +] +.br +[ +.B \-t +| +.B \-\-print-ratio +] +[ +.B \-u +| +.B \-\-print-users +] +.br +[ +.BI \-v " num" +| +.BI \-\-threshold " num" +] +[ +.B \-\-sort-real-time +] +.br +[ +.B \-\-debug +] +[ +.B \-V +| +.B \-\-version +] +[ +.B \-h +| +.B \-\-help +] +.br +[ +.BI "\-\-other-usracct-file " filename +] +[ +.BI \-\-ahz " hz" +] +.br +[ +.BI "\-\-other-savacct-file " filename +] +.br +[ +[ +.B "\-\-other-acct-file " +] +.I filename +] +.SH DESCRIPTION +.LP +.B sa +summarizes information about previously executed commands as +recorded in the +.I acct +file. In addition, it condenses this data into a summary file named +.I savacct +which contains the number of times the command was called and the system +resources used. The information can also be summarized on a per-user +basis; +.B sa +will save this information into a file named +.I usracct. +.LP +If no arguments are specified, +.B sa +will print information about all of the commands in the +.I acct +file. +.LP +If called with a file name as the last argument, +.B sa +will use that file instead of the system's default +.I acct +file. +.LP +By default, +.B sa +will sort the output by sum of user and system time. +If command names have unprintable characters, or are only called once, +.B sa +will sort them into a group called `***other'. +If more than one sorting option is specified, the list will +be sorted by the one specified last on the command line. +.LP +The output fields are labeled as follows: +.TP +.I cpu + sum of system and user time in cpu minutes +.TP +.I re + "elapsed time" in minutes +.TP +.I k + cpu-time averaged core usage, in 1k units +.TP +.I avio + average number of I/O operations per execution +.TP +.I tio + total number of I/O operations +.TP +.I k*sec + cpu storage integral (kilo-core seconds) +.TP +.I u + user cpu time in cpu seconds +.TP +.I s + system time in cpu seconds +.LP +Note that these column titles do not appear in the first row of the +table, but after each numeric entry (as units of measurement) in every +row. For example, you might see `79.29re', meaning 79.29 cpu seconds +of "real time". +.LP +An asterisk will appear after the name of commands that forked but didn't call +.B exec. +.LP +GNU +.B sa +takes care to implement a number of features not found in other versions. +For example, most versions of +.B sa +don't pay attention to flags like `\-\-print-seconds' and +`\-\-sort-num-calls' when printing out commands when combined with +the `\-\-user-summary' or `\-\-print-users' flags. GNU +.B sa +pays attention to these flags if they are applicable. +Also, MIPS' +.B sa +stores the average memory use as a short rather than a double, resulting +in some round-off errors. GNU +.B sa +uses double the whole way through. +.SH OPTIONS +.LP +The availability of these program options depends on your operating +system. In specific, the members that appear in the +.B struct acct +of your system's process accounting header file (usually +.I acct.h +) determine which flags will be present. For example, if your system's +.B struct acct +doesn't have the `ac_mem' field, the installed +version of +.B sa +will not support the `\-\-sort-cpu-avmem', `\-\-sort-ksec', `\-k', or +`\-K' options. +.LP +In short, all of these flags may not be available on your machine. +.TP +.PD 0 +.B \-a, \-\-list-all-names +Force +.B sa +not to sort those command names with unprintable characters and those +used only once into the +.I ***other +group. +.TP +.B \-b, \-\-sort-sys-user-div-calls +Sort the output by the sum of user and system time divided by the +number of calls. +.TP +.B \-c, \-\-percentages +Print percentages of total time for the command's user, system, +and real time values. +.TP +.B \-d, \-\-sort-avio +Sort the output by the average number of disk I/O operations. +.TP +.B \-D, \-\-sort-tio +Print and sort the output by the total number of disk I/O operations. +.TP +.B \-f, \-\-not-interactive +When using the `\-\-threshold' option, assume that all answers to +interactive queries will be affirmative. +.TP +.B \-i, \-\-dont-read-summary-files +Don't read the information in the system's default +.I savacct +file. +.TP +.B \-j, \-\-print-seconds +Instead of printing total minutes for each category, print seconds per call. +.TP +.B \-k, \-\-sort-cpu-avmem +Sort the output by cpu time average memory usage. +.TP +.B \-K, \-\-sort-ksec +Print and sort the output by the cpu-storage integral. +.TP +.B \-l, \-\-separate-times +Print separate columns for system and user time; usually the two +are added together and listed as `cpu'. +.TP +.B \-m, \-\-user-summary +Print the number of processes and number of CPU minutes on a +per-user basis. +.TP +.B \-n, \-\-sort-num-calls +Sort the output by the number of calls. This is the default sorting method. +.TP +.B \-p, \-\-show-paging +Print the number of minor and major pagefaults and swaps. +.TP +.B \-P, \-\-show-paging-avg +Print the number of minor and major pagefaults and swaps divided by +the number of calls. +.TP +.B \-r, \-\-reverse-sort +Sort output items in reverse order. +.TP +.B \-s, \-\-merge +Merge the summarized accounting data into the summary files +.I savacct +and +.I usracct. +.TP +.B \-t, \-\-print-ratio +For each entry, print the ratio of real time to the sum of system +and user times. If the sum of system and user times is too small +to report--the sum is zero--`*ignore*' will appear in this field. +.TP +.B \-u, \-\-print-users +For each command in the accounting file, print the userid and +command name. After printing all entries, quit. *Note*: this flag +supersedes all others. +.TP +.BI \-v " num " \-\-threshold " num" +Print commands which were executed +.I num +times or fewer and await a +reply from the terminal. If the response begins with `y', add the +command to the `**junk**' group. +.TP +.B \-\-separate-forks +It really doesn't make any sense to me that the stock version of +.B sa +separates statistics for a particular executable depending on +whether or not that command forked. Therefore, GNU +.B sa +lumps this information together unless this option is specified. +.TP +.BI \-\-ahz " hz" +Use this flag to tell the program what +.B AHZ +should be (in hertz). This option is useful if you are trying to view +an +.I acct +file created on another machine which has the same byte order and file +format as your current machine, but has a different value for +.B AHZ. +.TP +.B \-\-debug +Print verbose internal information. +.TP +.B \-V, \-\-version +Print the version number of +.B sa. +.TP +.B \-h, \-\-help +Prints the usage string and default locations of system files to +standard output and exits. +.TP +.BI \-\-sort-real-time +Sort the output by the "real time" field. +.TP +.BI \-\-other-usracct-file " filename" +Write summaries by user ID to +.I filename +rather than the system's default +.I usracct +file. +.TP +.BI \-\-other-savacct-file " filename" +Write summaries by command name to +.I filename +rather than the system's default +.I SAVACCT +file. +.TP +.BI \-\-other-acct-file " filename" +Read from the file +.I filename +instead of the system's default +.I ACCT +file. +.SH FILES +.TP +.I acct +The raw system wide process accounting file. See +.BR acct (5) +for further details. +.TP +.I savacct +A summary of system process accounting sorted by command. +.TP +.I usracct +A summary of system process accounting sorted by user ID. +.RE +.LP + +.SH BUGS +There is not yet a wide experience base for comparing the output of GNU +.B sa +with versions of +.B sa +in many other systems. The problem is that the data files grow big in a short +time and therefore require a lot of disk space. +.LP + +.SH AUTHOR +The GNU accounting utilities were written by Noel Cragg +<noel@gnu.ai.mit.edu>. The man page was adapted from the accounting +texinfo page by Susan Kleinmann <sgk@sgk.tiac.net>. +.SH "SEE ALSO" +.BR acct (5), +.BR ac (1) diff --git a/upstream/opensuse-leap-15-6/man8/sa1.8 b/upstream/opensuse-leap-15-6/man8/sa1.8 new file mode 100644 index 00000000..9067affe --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/sa1.8 @@ -0,0 +1,86 @@ +.TH SA1 8 "JULY 2018" Linux "Linux User's Manual" -*- nroff -*- +.SH NAME +sa1 \- Collect and store binary data in the system activity daily data file. +.SH SYNOPSIS +.B /usr/lib64/sa/sa1 [ --boot | +.I interval +.I count +.B ] +.SH DESCRIPTION +The +.B sa1 +command is a shell procedure variant of the +.B sadc +command and handles all of the flags and parameters of that command. The +.B sa1 +command collects and stores binary data in the current standard +system activity daily data file. + +The standard system activity daily data file is named +.I saDD +unless +.BR sadc 's +option +.B -D +is used, in which case its name is +.IR saYYYYMMDD , +where YYYY stands for the current year, MM for the current month +and DD for the current day. By default it is located in the +.I /var/log/sa +directory. + +The +.I interval +and +.I count +parameters specify that the record should be written +.I count +times at +.I interval +seconds. If no arguments are given to +.B sa1 +then a single record is written. + +The +.B sa1 +command is designed to be started automatically by the cron command. + +.SH OPTIONS +.IP --boot +This option tells +.B sa1 +that the +.B sadc +command should be called without specifying the +.I interval +and +.I count +parameters in order to insert a dummy record, marking the time when the counters +restart from 0. + +.SH EXAMPLE +To collect data (including those from disks) every 10 minutes, +place the following entry in your root crontab file: + +.B 0,10,20,30,40,50 * * * * /usr/lib64/sa/sa1 1 1 -S DISK + +.SH FILES +.I /var/log/sa/saDD +.br +.I /var/log/sa/saYYYYMMDD +.RS +The standard system activity daily data files and their default location. +YYYY stands for the current year, MM for the current month and DD for the +current day. +.SH AUTHOR +Sebastien Godard (sysstat <at> orange.fr) +.SH SEE ALSO +.BR sar (1), +.BR sadc (8), +.BR sa2 (8), +.BR sadf (1), +.BR sysstat (5) + +.I https://github.com/sysstat/sysstat + +.I http://pagesperso-orange.fr/sebastien.godard/ diff --git a/upstream/opensuse-leap-15-6/man8/sa2.8 b/upstream/opensuse-leap-15-6/man8/sa2.8 new file mode 100644 index 00000000..3a68dee2 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/sa2.8 @@ -0,0 +1,72 @@ +.TH SA2 8 "JULY 2018" Linux "Linux User's Manual" -*- nroff -*- +.SH NAME +sa2 \- Create a report from the current standard system activity daily data file. +.SH SYNOPSIS +.B /usr/lib64/sa/sa2 +.SH DESCRIPTION +The +.B sa2 +command is a shell procedure variant of the +.B sar +command which writes a daily report in the +.I sarDD +or the +.I sarYYYYMMDD +file, where YYYY stands for the current year, MM for the current month +and DD for the current day. +By default the report is saved in the +.I /var/log/sa +directory. +The +.B sa2 +command will also remove reports more than one week old by default. +You can however keep reports for a longer (or a shorter) period by setting +the +.B HISTORY +environment variable. Read the +.BR sysstat (5) +manual page for details. + +The +.B sa2 +command accepts most of the flags and parameters of the +.B sar +command. + +The +.B sa2 +command is designed to be started automatically by the cron command. + +.SH EXAMPLES +To run the +.B sa2 +command daily, place the following entry in your root crontab file: + +.B 5 19 * * 1-5 /usr/lib64/sa/sa2 -A & + +This will generate by default a daily report called +.I sarDD +in the +.I /var/log/sa +directory, where the DD parameter is a number representing the day of the +month. +.SH FILES +.I /var/log/sa/sarDD +.br +.I /var/log/sa/sarYYYYMMDD +.RS +The standard system activity daily report files and their default location. +YYYY stands for the current year, MM for the current month and DD for the +current day. +.SH AUTHOR +Sebastien Godard (sysstat <at> orange.fr) +.SH SEE ALSO +.BR sar (1), +.BR sadc (8), +.BR sa1 (8), +.BR sadf (1), +.BR sysstat (5) + +.I https://github.com/sysstat/sysstat + +.I http://pagesperso-orange.fr/sebastien.godard/ diff --git a/upstream/opensuse-leap-15-6/man8/sadc.8 b/upstream/opensuse-leap-15-6/man8/sadc.8 new file mode 100644 index 00000000..0d252ea2 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/sadc.8 @@ -0,0 +1,242 @@ +.TH SADC 8 "JULY 2018" Linux "Linux User's Manual" -*- nroff -*- +.SH NAME +sadc \- System activity data collector. +.SH SYNOPSIS +.B /usr/lib64/sa/sadc [ -C +.I comment +.B ] [ -D ] [ -F ] [ -L ] [ -V ] [ -S { DISK | INT | IPV6 | POWER | SNMP | XDISK | ALL | XALL [,...] } ] [ +.I interval +.B [ +.I count +.B ] ] [ +.I outfile +.B ] +.SH DESCRIPTION +The +.B sadc +command samples system data a specified number of times +(\fIcount\fR) at a specified interval measured in seconds +(\fIinterval\fR). It writes in binary format to the specified +.I outfile +or to standard output. If +.I outfile +is set to -, then +.B sadc +uses the standard system activity daily data file (see below). +In this case, if the file already exists, +.B sadc +will overwrite it if it is from a previous month. +By default +.B sadc +collects most of the data available from the kernel. +But there are also optional metrics, for which the +relevant options must be explicitly passed to +.B sadc +to be collected (see option -S below). + +The standard system activity daily data file is named +.I saDD +unless option +.B -D +is used, in which case its name is +.IR saYYYYMMDD , +where YYYY stands for the current year, MM for the current month +and DD for the current day. +By default it is located in the +.I /var/log/sa +directory. Yet it is possible to specify an alternate location for +it: If +.I outfile +is a directory (instead of a plain file) then it will be considered +as the directory where the standard system activity daily data file +will be saved. + +When the +.I count +parameter is not specified, +.B sadc +writes its data endlessly. +When both +.I interval +and +.I count +are not specified, and option -C is not used, +a dummy record, which is used at system startup to mark +the time when the counter restarts from 0, will be written. +For example, one of the system startup script may write the restart mark to +the daily data file by the command entry: + +.B "/usr/lib64/sa/sadc -" + +The +.B sadc +command is intended to be used as a backend to the +.B sar +command. + +Note: The +.B sadc +command only reports on local activities. + +.SH OPTIONS +.IP "-C comment" +When neither the +.I interval +nor the +.I count +parameters are specified, this option tells +.B sadc +to write a dummy record containing the specified +.I comment +string. +This comment can then be displayed with option -C of +.BR sar . +.IP -D +Use +.I saYYYYMMDD +instead of +.I saDD +as the standard system activity daily data file name. +.IP -F +The creation of +.I outfile +will be forced. If the file already exists and has a format unknown to +.B sadc +then it will be truncated. This may be useful for daily data files +created by an older version of +.B sadc +and whose format is no longer compatible with current one. +.IP -L +.B sadc +will try to get an exclusive lock on the +.I outfile +before writing to it or truncating it. Failure to get the lock is fatal, +except in the case of trying to write a normal (i.e. not a dummy and not +a header) record to an existing file, in which case +.B sadc +will try again at the next interval. Usually, the only reason a lock +would fail would be if another +.B sadc +process were also writing to the file. This can happen when cron is used +to launch +.BR sadc . +If the system is under heavy load, an old +.B sadc +might still be running when cron starts a new one. Without locking, +this situation can result in a corrupted system activity file. +.IP "-S { DISK | INT | IPV6 | POWER | SNMP | XDISK | ALL | XALL [,...] }" +Specify which optional activities should be collected by +.BR sadc . +Some activities are optional to prevent data files from growing too large. +The +.B DISK +keyword indicates that +.B sadc +should collect data for block devices. +The +.B INT +keyword indicates that +.B sadc +should collect data for system interrupts. +The +.B IPV6 +keyword indicates that IPv6 statistics should be +collected by +.BR sadc . +The +.B POWER +keyword indicates that +.B sadc +should collect power management statistics. +The +.B SNMP +keyword indicates that SNMP statistics should be +collected by +.BR sadc . +The +.B ALL +keyword is equivalent to specifying all the keywords above and therefore +all previous activities are collected. + +The +.B XDISK +keyword is an extension to the +.B DISK +one and indicates that partitions and filesystems statistics should be collected by +.B sadc +in addition to disk statistics. This option works only with kernels 2.6.25 +and later. +The +.B XALL +keyword is equivalent to specifying all the keywords above (including +keyword extensions) and therefore all possible activities are collected. + +Important note: The activities (including optional ones) saved in an existing +data file prevail over those selected with option -S. +As a consequence, appending data to an existing data file will result in +option -S being ignored. +.IP -V +Print version number then exit. + +.SH ENVIRONMENT +The +.B sadc +command takes into account the following environment variable: + +.IP S_TIME_DEF_TIME +If this variable exists and its value is +.BR UTC +then +.B sadc +will save its data in UTC time. +.B sadc +will also use UTC time instead of local time to determine the current +daily data file located in the +.IR /var/log/sa +directory. +.SH EXAMPLES +.B /usr/lib64/sa/sadc 1 10 /tmp/datafile +.RS +Write 10 records of one second intervals to the /tmp/datafile binary file. +.RE + +.B /usr/lib64/sa/sadc -C Backup_Start /tmp/datafile +.RS +Insert the comment Backup_Start into the file /tmp/datafile. +.RE +.SH BUGS +The +.I /proc +filesystem must be mounted for the +.B sadc +command to work. + +All the statistics are not necessarily available, depending on the kernel version used. +.B sadc +assumes that you are using at least a 2.6 kernel. +.SH FILES +.I /var/log/sa/saDD +.br +.I /var/log/sa/saYYYYMMDD +.RS +The standard system activity daily data files and their default location. +YYYY stands for the current year, MM for the current month and DD for the +current day. + +.RE +.I /proc +and +.I /sys +contain various files with system statistics. +.SH AUTHOR +Sebastien Godard (sysstat <at> orange.fr) +.SH SEE ALSO +.BR sar (1), +.BR sa1 (8), +.BR sa2 (8), +.BR sadf (1), +.BR sysstat (5) + +.I https://github.com/sysstat/sysstat + +.I http://pagesperso-orange.fr/sebastien.godard/ diff --git a/upstream/opensuse-leap-15-6/man8/samba-bgqd.8 b/upstream/opensuse-leap-15-6/man8/samba-bgqd.8 new file mode 100644 index 00000000..d749bba8 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/samba-bgqd.8 @@ -0,0 +1,44 @@ +'\" t +.\" Title: samba-bgqd +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 10/23/2023 +.\" Manual: System Administration tools +.\" Source: Samba 4.19.2-git.328.e4c431e307f150600.1.23SUSE-oS15.0-x86_64 +.\" Language: English +.\" +.TH "SAMBA\-BGQD" "8" "10/23/2023" "Samba 4\&.19\&.2\-git\&.328\&." "System Administration tools" +.\" ----------------------------------------------------------------- +.\" * 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" +samba-bgqd \- This is an internal helper program performing asynchronous printing\-related jobs\&. +.SH "SYNOPSIS" +.HP \w'\ 'u +samba\-bgqd +.SH "DESCRIPTION" +.PP +This tool is part of the +\fBsamba\fR(7) +suite\&. +.PP +samba\-bgqd is an helper program to be spawned by smbd or spoolssd to perform jobs like updating the printer list or other management tasks asynchronously on demand\&. It is not intended to be called by users or administrators\&. +.SH "AUTHOR" +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. diff --git a/upstream/opensuse-leap-15-6/man8/samba-dcerpcd.8 b/upstream/opensuse-leap-15-6/man8/samba-dcerpcd.8 new file mode 100644 index 00000000..1a58a106 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/samba-dcerpcd.8 @@ -0,0 +1,138 @@ +'\" t +.\" Title: samba-dcerpcd +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 10/23/2023 +.\" Manual: System Administration tools +.\" Source: Samba 4.19.2-git.328.e4c431e307f150600.1.23SUSE-oS15.0-x86_64 +.\" Language: English +.\" +.TH "SAMBA\-DCERPCD" "8" "10/23/2023" "Samba 4\&.19\&.2\-git\&.328\&." "System Administration tools" +.\" ----------------------------------------------------------------- +.\" * 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" +samba-dcerpcd \- This is one of Samba\*(Aqs DCERPC server processes that can listen on sockets where RPC services are offered and is the parent process of the DCERPC services it invokes\&. Unless separately invoked it is started on demand from smbd or winbind and serves DCERPC only over named pipes (np) as a helper process\&. This will be the standard setup for most installations (standalone/member server/AD server) unless they modify their startup scripts\&. Note in when Samba is configured as an Active Directory Domain controller the samba process that invokes smbd will still provide its normal DCERPC services, not samba\-dcerpcd\&. When separately invoked by system startup scripts or a a daemon, the global smb\&.conf option \m[blue]\fBrpc start on demand helpers = false\fR\m[] MUST be set to allow samba\-dcerpcd to start standalone\&. +.SH "SYNOPSIS" +.HP \w'\ 'u +samba\-dcerpcd [\-D|\-\-daemon] [\-i|\-\-interactive] [\-F|\-\-foreground] [\-\-no\-process\-group] [\-d\ <debug\ level>] [\-\-debug\-stdout] [\-\-configfile=<configuration\ file>] [\-\-option=<name>=<value>] [\-\-leak\-report] [\-\-leak\-report\-full] [\-V|\-\-version] [\-\-libexec\-rpcds] [\-\-np\-helper] [\-\-ready\-signal\-fd=<fd>] [<SERVICE_1>] [<SERVICE_2>] [<\&.\&.\&.>] +.SH "DESCRIPTION" +.PP +This tool is part of the +\fBsamba\fR(7) +suite\&. +.PP +samba\-dcerpcd can be used in two ways\&. In the normal case without startup script modification and the global smb\&.conf option +\m[blue]\fBrpc start on demand helpers = true\fR\m[] +is set (the default setting), it is invoked on demand from +smbd +or +winbind +with a command line containing \-\-np\-helper to serve DCERPC over named pipes (np)\&. It can also be used in a standalone mode where it is started separately from +smbd +or +winbind +via system startup scripts\&. If invoked as a standalone daemon or started from system startup scripts the global smb\&.conf option +\m[blue]\fBrpc start on demand helpers = false\fR\m[] +MUST be set to false\&. If the global smb\&.conf option +\m[blue]\fBrpc start on demand helpers = true\fR\m[] +is set to true or left as default, +samba\-dcerpcd +will fail to start and log an error message\&. +.PP +Note that when Samba is run in the Active Directory Domain Controller mode the +samba +AD code will still provide its normal DCERPC services whilst allowing samba\-dcerpcd to provide services like SRVSVC in the same way that +smbd +used to in this configuration\&. +.PP +The standalone mode can also be useful for use outside of the Samba framework, for example, use with the Linux kernel SMB2 server ksmbd or possibly other SMB2 server implementations\&. In this mode it behaves like inetd and listens on sockets on behalf of RPC server implementations\&. +.PP +When a client connects, +samba\-dcerpcd +will start the relevant RPC service binary on demand and hand over the connection to that service\&. When an RPC service has been idle for a while, +samba\-dcerpcd +will ask it to shut down again\&. +.SH "OPTIONS" +.PP +\-D|\-\-daemon +.RS 4 +If specified, this parameter causes the server to operate as a daemon\&. That is, it detaches itself and runs in the background, fielding requests on the appropriate port\&. Operating the server as a daemon is useful for running +samba\-dcerpcd +outside of the Samba framework\&. However, it can also be used in this way within Samba for member servers if configured to start up via system startup scripts\&. This switch is assumed if +samba\-dcerpcd +is executed on the command line of a shell\&. +.RE +.PP +\-i|\-\-interactive +.RS 4 +If this parameter is specified it causes the server to run "interactively", not as a daemon, even if the server is executed on the command line of a shell\&. Setting this parameter negates the implicit daemon mode when run from the command line\&. +samba\-dcerpcd +will only accept one connection and terminate\&. It will also log to standard output, as if the +\-S +parameter had been given\&. +.RE +.PP +\-F|\-\-foreground +.RS 4 +If specified, this parameter causes the main +samba\-dcerpcd +process to not daemonize, i\&.e\&. double\-fork and disassociate with the terminal\&. Child processes are still spawned as normal to service each connection request, but the main process does not exit\&. This operation mode is suitable for running +samba\-dcerpcd +under process supervisors such as +supervise +and +svscan +from Daniel J\&. Bernstein\*(Aqs +daemontools +package, or the AIX process monitor\&. +.RE +.PP +\-\-no\-process\-group +.RS 4 +Do not create a new process group for samba\-dcerpcd\&. +.RE +.PP +\-\-libexec\-rpcds +.RS 4 +Offer RPC services for all daemons in Samba\*(Aqs LIBEXECDIR, all programs starting with "rpcd_" are assumed to offer RPC services\&. If you don\*(Aqt use the +\-\-libexec\-rpcds +option, you can explicitly list all RPC service helpers explicitly on the command line\&. +.RE +.PP +\-\-np\-helper +.RS 4 +Run +samba\-dcerpcd +on demand opening named pipe sockets as helpers for +smbd +or +winbind\&. In order to run in this mode, the global smb\&.conf option +\m[blue]\fBrpc start on demand helpers = true\fR\m[] +must be set to true (this is the default setting)\&. +.RE +.PP +\-\-ready\-signal\-fd=<fd> +.RS 4 +Report service readiness via this fd to +smbd\&. Only for internal use\&. +.RE +.SH "AUTHOR" +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. diff --git a/upstream/opensuse-leap-15-6/man8/saned.8 b/upstream/opensuse-leap-15-6/man8/saned.8 new file mode 100644 index 00000000..bb37d2c3 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/saned.8 @@ -0,0 +1,515 @@ +.TH saned 8 "29 Sep 2017" "" "SANE Scanner Access Now Easy" +.IX saned +.SH NAME +saned \- SANE network daemon +.SH SYNOPSIS +.B saned +.B [ \-a +.I [ username ] +.B ] +.B [ \-u +.I username +.B ] +.B [ \-b +.I address +.B ] +.B [ \-p +.I port +.B ] +.B [ \-l ] +.B [ \-D ] +.B [ \-o ] +.B [ \-d +.I n +.B ] +.B [ \-e ] +.B [ \-h ] +.SH DESCRIPTION +.B saned +is the SANE (Scanner Access Now Easy) daemon that allows remote clients +to access image acquisition devices available on the local host. +.SH OPTIONS +.PP +The +.B \-l +flag requests that +.B saned +run in standalone daemon mode. In this mode, +.B saned +will listen for incoming client connections; +.BR inetd (8) +is not required for +.B saned +operations in this mode. The +.B \-b +flag tells +.B saned +to bind to the +.I address +given. The +.B \-p +flags tells +.B saned +to listen on the port given. A value of 0 tells +.B saned +to pick an unused port. The default is the +.B sane-port (6566). +The +.B \-u +flag requests that +.B saned +drop root privileges and run as the user (and group) associated with +.I username +after binding. +The +.B \-D +flag will request +.B saned +to detach from the console and run in the background. +The flag +.B \-a +is equivalent to the combination of +.B \-l \-B \-u +.I username +options. +.PP +The +.B \-d +flag sets the level of +.B saned +debug output. When compiled with debugging enabled, this flag may be +followed by a number to request more or less debug info. The larger +the number, the more verbose the debug output. E.g., +.B \-d128 +will request output of all debug info. A level of 0 produces no +output at all. The default value is 2. +.PP +The +.B \-e +flag will divert +.B saned +debug output to stderr instead of the syslog default. +.PP +The +.B \-o +flag requests that +.B saned +exits after the first client disconnects. This is useful for debugging. +.PP +The +.B \-h +flag displays a short help message. +.PP +If +.B saned +is run from other programs such as +.BR inetd (8), +.BR xinetd (8) +and +.BR systemd (1), +check that program's documentation on how to pass command-line options. +.SH CONFIGURATION +First and foremost: +.B saned +is not intended to be exposed to the internet or other non-trusted +networks. Make sure that access is limited by tcpwrappers and/or a firewall +setup. Don't depend only on +.BR saned 's +own authentication. Don't run +.B saned +as root if it's not necessary. And do +.B not +install +.B saned +as setuid root. +.PP +The +.I saned.conf +configuration file contains both options for the daemon and the access +list. +.TP +\fBdata_portrange\fP = \fImin_port\fP - \fImax_port\fP +Specify the port range to use for the data connection. Pick a port +range between 1024 and 65535; don't pick a too large port range, as it +may have performance issues. Use this option if your +.B saned +server is sitting behind a firewall. If that firewall is a Linux +machine, we strongly recommend using the Netfilter +\fInf_conntrack_sane\fP module instead. +.TP +\fBdata_connect_timeout\fP = \fItimeout\fP +Specify the time in milliseconds that +.B saned +will wait for a data +connection. Without this option, if the data connection is not done +before the scanner reaches the end of scan, the scanner will continue +to scan past the end and may damage it depending on the +backend. Specify zero to have the old behavior. The default is 4000ms. +.PP +The access list is a list of host names, IP addresses or IP subnets +(CIDR notation) that are permitted to use local SANE devices. IPv6 +addresses must be enclosed in brackets, and should always be specified +in their compressed form. Connections from localhost are always +permitted. Empty lines and lines starting with a hash mark (#) are +ignored. A line containing the single character ``+'' is interpreted +to match any hostname. This allows any remote machine to use your +scanner and may present a security risk, so this shouldn't be used +unless you know what you're doing. +.PP +A sample configuration file is shown below: +.PP +.RS +# Daemon options +.br +data_portrange = 10000 - 10100 +.br +# Access list +.br +scan\-client.somedomain.firm +.br +# this is a comment +.br +192.168.0.1 +.br +192.168.2.12/29 +.br +[::1] +.br +[2001:db8:185e::42:12]/64 +.RE +.PP +The case of the host names does not matter, so AHost.COM is considered +identical to ahost.com. +.SH SERVER DAEMON CONFIGURATION +For +.B saned +to work properly in its default mode of operation, it is also necessary to +add the appropriate configuration for +.BR xinetd (8), +.BR inetd (8) +or +.BR systemd (1) +(see below). +Note that your +.BR inetd (8) +must support IPv6 if you want to connect to +.B saned +over IPv6; +.BR xinetd (8), +.BR openbsd-inetd (8) +and +.BR systemd (1) +are known to support IPv6, check the documentation for your +.BR inetd (8) +daemon. +.PP +In the sections below the configuration for +.BR inetd (8), +.BR xinetd (8) +and +.BR systemd (1) +are described in more detail. +.PP +For the configurations below it is necessary to add a line of the following +form to +.IR /etc/services : +.PP +.RS +sane\-port 6566/tcp # SANE network scanner daemon +.RE +.PP +The official IANA short name for port 6566 is "sane\-port". The older name +"sane" is now deprecated. + +.SH INETD CONFIGURATION +It is required to add a single line to the +.BR inetd (8) +configuration file +.IR (/etc/inetd.conf) +. +.PP +The configuration line normally looks like this: +.PP +.RS +sane\-port stream tcp nowait saned.saned /usr/sbin/saned saned +.RE +.PP +However, if your system uses +.BR tcpd (8) +for additional security screening, you may want to disable +.B saned +access control by putting ``+'' in +.IR saned.conf +and use a line of the following form in +.IR /etc/inetd.conf +instead: +.PP +.RS +sane\-port stream tcp nowait saned.saned /usr/sbin/tcpd /usr/sbin/saned +.RE +.PP +Note that both examples assume that there is a +.B saned +group and a +.B saned +user. If you follow this example, please make sure that the +access permissions on the special device are set such that +.B saned +can access the scanner (the program generally needs read and +write access to scanner devices). + +.SH XINETD CONFIGURATION +If +.BR xinetd (8) +is installed on your system instead of +.BR inetd (8) +the following example for +.I /etc/xinetd.conf +may be helpful: +.PP +.RS +.ft CR +.nf +# default: off +# description: The sane server accepts requests +# for network access to a local scanner via the +# network. +service sane\-port +{ + port = 6566 + socket_type = stream + wait = no + user = saned + group = saned + server = /usr/sbin/saned +} +.fi +.ft R +.RE + +.SH SYSTEMD CONFIGURATION +.B saned +can be compiled with explicit +.BR systemd (1) support. This +will allow logging debugging information to be forwarded +to the +.BR systemd (1) +journal. The +.BR systemd (1) +support requires compilation with the systemd-devel package +installed on the system. this is the preferred option. + +.B saned +can be used with +.BR systemd (1) +without the +.BR systemd (1) +integration compiled in, but then logging of debug information is not supported. + +The +.BR systemd (1) +configuration is different for the 2 options, so both are described below. + +.SH Systemd configuration for saned with systemd support compiled in +For +.BR systemd (1) +configuration we need to add 2 configuration files in +.I /etc/systemd/system. +.PP +The first file we need to add here is called +.I saned.socket. +It shall have +the following contents: +.PP +.RS +.ft CR +.nf +[Unit] +Description=saned incoming socket + +[Socket] +ListenStream=6566 +Accept=yes +MaxConnections=1 + +[Install] +WantedBy=sockets.target +.fi +.ft R +.RE +.PP +The second file to be added is +.I saned@.service +with the following contents: +.PP +.RS +.ft CR +.nf +[Unit] +Description=Scanner Service +Requires=saned.socket + +[Service] +ExecStart=/usr/sbin/saned +User=saned +Group=saned +StandardInput=null +StandardOutput=syslog +StandardError=syslog +Environment=SANE_CONFIG_DIR=/etc/sane.d +# If you need to debug your configuration uncomment the next line and +# change it as appropriate to set the desired debug options +# Environment=SANE_DEBUG_DLL=255 SANE_DEBUG_BJNP=5 + +[Install] +Also=saned.socket +.fi +.ft R +.RE +.PP +You need to set an environment variable for +.B SANE_CONFIG_DIR +pointing to the directory where +.B saned +can find its configuration files. +you will have to remove the # on the last line and set the variables +for the desired debugging information if required. Multiple variables +can be set by separating the assignments by spaces as shown in the +example above. +.PP +Unlike +.BR xinetd (8) +and +.BR inetd (8), +.BR systemd (1) +allows debugging output from backends set using +.B SANE_DEBUG_XXX +to be captured. See the man-page for your backend to see what options +are supported. +With the service unit as described above, the debugging output is +forwarded to the system log. + +.SH Systemd configuration when saned is compiled without systemd support +This configuration will also work when +.B saned +is compiled WITH +.BR systemd (1) integration support, but it does not allow debugging +information to be logged. +.PP +For +.BR systemd (1) +configuration for +.BR saned , +we need to add 2 configuration files in +.I /etc/systemd/system. +.PP +The first file we need to add here is called +.I saned.socket. +It is identical to the version for +.BR systemd (1) +with the support compiled in. +It shall have the following contents: +.PP +.RS +.ft CR +.nf +[Unit] +Description=saned incoming socket + +[Socket] +ListenStream=6566 +Accept=yes +MaxConnections=1 + +[Install] +WantedBy=sockets.target +.fi +.ft R +.RE +.PP +The second file to be added is +.I saned@.service +This one differs from the version with +.BR systemd (1) +integration compiled in: +.PP +.RS +.ft CR +.nf +[Unit] +Description=Scanner Service +Requires=saned.socket + +[Service] +ExecStart=/usr/sbin/saned +User=saned +Group=saned +StandardInput=socket + +Environment=SANE_CONFIG_DIR=/etc/sane.d + +[Install] +Also=saned.socket +.fi +.ft R +.RE +.PP + +.SH FILES +.TP +.I /etc/hosts.equiv +The hosts listed in this file are permitted to access all local SANE +devices. Caveat: this file imposes serious security risks and its use +is not recommended. +.TP +.I /etc/sane.d/saned.conf +Contains a list of hosts permitted to access local SANE devices (see +also description of +.B SANE_CONFIG_DIR +below). +.TP +.I /etc/sane.d/saned.users +If this file contains lines of the form + +user:password:backend + +access to the listed backends is restricted. A backend may be listed multiple +times for different user/password combinations. The server uses MD5 hashing +if supported by the client. +.SH ENVIRONMENT +.TP +.B SANE_CONFIG_DIR +This environment variable specifies the list of directories that may +contain the configuration file. Under UNIX, the directories are +separated by a colon (`:'), under OS/2, they are separated by a +semi-colon (`;'). If this variable is not set, the configuration file +is searched in two default directories: first, the current working +directory (".") and then in +.IR /etc/sane.d . +If the value of the +environment variable ends with the directory separator character, then +the default directories are searched after the explicitly specified +directories. For example, setting +.B SANE_CONFIG_DIR +to "/tmp/config:" would result in directories +.IR tmp/config , +.IR . , +and +.I "/etc/sane.d" +being searched (in this order). + +.SH "SEE ALSO" +.BR sane (7), +.BR scanimage (1), +.BR xscanimage (1), +.BR xcam (1), +.BR sane\-dll (5), +.BR sane\-net (5), +.BR sane\-"backendname" (5), +.BR inetd (8), +.BR xinetd (8), +.BR systemd (1), +.br +.I http://www.penguin-breeder.org/?page=sane\-net +.SH AUTHOR +David Mosberger diff --git a/upstream/opensuse-leap-15-6/man8/sendmail.8 b/upstream/opensuse-leap-15-6/man8/sendmail.8 new file mode 100644 index 00000000..9e0b9aff --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/sendmail.8 @@ -0,0 +1,755 @@ +.\" Copyright (c) 1998-2003 Proofpoint, Inc. and its suppliers. +.\" All rights reserved. +.\" Copyright (c) 1983, 1997 Eric P. Allman. All rights reserved. +.\" Copyright (c) 1988, 1991, 1993 +.\" The Regents of the University of California. All rights reserved. +.\" +.\" By using this file, you agree to the terms and conditions set +.\" forth in the LICENSE file which can be found at the top level of +.\" the sendmail distribution. +.\" +.\" +.\" $Id: sendmail.8,v 8.61 2013-11-22 20:51:56 ca Exp $ +.\" +.TH SENDMAIL 8 "$Date: 2013-11-22 20:51:56 $" +.SH NAME +sendmail +\- an electronic mail transport agent +.SH SYNOPSIS +.B sendmail +.RI [ flags "] [" "address ..." ] +.br +.B newaliases +.br +.B mailq +.RB [ \-v ] +.br +.B hoststat +.br +.B purgestat +.br +.B smtpd +.SH DESCRIPTION +.B Sendmail +sends a message to one or more +.I recipients, +routing the message over whatever networks +are necessary. +.B Sendmail +does internetwork forwarding as necessary +to deliver the message to the correct place. +.PP +.B Sendmail +is not intended as a user interface routine; +other programs provide user-friendly +front ends; +.B sendmail +is used only to deliver pre-formatted messages. +.PP +With no flags, +.B sendmail +reads its standard input +up to an end-of-file +or a line consisting only of a single dot +and sends a copy of the message found there +to all of the addresses listed. +It determines the network(s) to use +based on the syntax and contents of the addresses. +.PP +Local addresses are looked up in a file +and aliased appropriately. +Aliasing can be prevented by preceding the address +with a backslash. +Beginning with 8.10, the sender is included in any alias +expansions, e.g., +if `john' sends to `group', +and `group' includes `john' in the expansion, +then the letter will also be delivered to `john'. +.SS Parameters +.TP +.B \-Ac +Use submit.cf even if the operation mode does not indicate +an initial mail submission. +.TP +.B \-Am +Use sendmail.cf even if the operation mode indicates +an initial mail submission. +.TP +.BI \-B type +Set the body type to +.IR type . +Current legal values are +7BIT +or +8BITMIME. +.TP +.B \-ba +Go into +ARPANET +mode. All input lines must end with a CR-LF, +and all messages will be generated with a CR-LF at the end. +Also, +the ``From:'' and ``Sender:'' +fields are examined for the name of the sender. +.TP +.B \-bC +Check the configuration file. +.TP +.B \-bd +Run as a daemon. +.B Sendmail +will fork and run in background +listening on socket 25 for incoming +SMTP +connections. +This is normally run from +/etc/rc. +.TP +.B \-bD +Same as +.B \-bd +except runs in foreground. +.TP +.B \-bh +Print the persistent host status database. +.TP +.B \-bH +Purge expired entries from the persistent host status database. +.TP +.B \-bi +Initialize the alias database. +.TP +.B \-bm +Deliver mail in the usual way (default). +.TP +.B \-bp +Print a listing of the queue(s). +.TP +.B \-bP +Print number of entries in the queue(s); +only available with shared memory support. +.TP +.B \-bs +Use the +SMTP +protocol as described in +RFC821 +on standard input and output. +This flag implies all the operations of the +.B \-ba +flag that are compatible with +SMTP. +.TP +.B \-bt +Run in address test mode. +This mode reads addresses and shows the steps in parsing; +it is used for debugging configuration tables. +.TP +.B \-bv +Verify names only \- do not try to collect or deliver a message. +Verify mode is normally used for validating +users or mailing lists. +.TP +.BI \-C file +Use alternate configuration file. +.B Sendmail +gives up any enhanced (set-user-ID or set-group-ID) privileges +if an alternate configuration file is specified. +.TP +.BI "\-D " logfile +Send debugging output to the indicated log file instead of stdout. +.TP +.BI \-d category . level... +Set the debugging flag for +.I category +to +.IR level . +.I Category +is either an integer or a name specifying the topic, and +.I level +an integer specifying the level of debugging output desired. +Higher levels generally mean more output. +More than one flag can be specified by separating them with commas. +A list of numeric debugging categories can be found in the TRACEFLAGS file +in the sendmail source distribution. +.br +The option +.B \-d0.1 +prints the version of +.B sendmail +and the options it was compiled with. +.br +Most other categories are only useful with, and documented in, +.BR sendmail 's +source code. +.ne 1i +.TP +.BI \-F fullname +Set the full name of the sender. +.TP +.BI \-f name +Sets the name of the ``from'' person +(i.e., the envelope sender of the mail). +This address may also be used in the From: header +if that header is missing during initial submission. +The envelope sender address is used as the recipient +for delivery status notifications +and may also appear in a Return-Path: header. +.B \-f +should only be used +by ``trusted'' users +(normally +.IR root ", " daemon , +and +.IR network ) +or if the person you are trying to become +is the same as the person you are. +Otherwise, +an X-Authentication-Warning header +will be added to the message. +.TP +.BI \-G +Relay (gateway) submission of a message, +e.g., when +.BR rmail +calls +.B sendmail . +.TP +.BI \-h N +Set the hop count to +.IR N . +The hop count is incremented every time the mail is +processed. +When it reaches a limit, +the mail is returned with an error message, +the victim of an aliasing loop. +If not specified, +``Received:'' lines in the message are counted. +.TP +.B \-i +Do not strip a leading dot from lines in incoming messages, +and do not treat a dot on a line by itself +as the end of an incoming message. +This should be set if you are reading data from a file. +.TP +.BI "\-L " tag +Set the identifier used in syslog messages to the supplied +.IR tag . +.TP +.BI "\-N " dsn +Set delivery status notification conditions to +.IR dsn , +which can be +`never' +for no notifications +or a comma separated list of the values +`failure' +to be notified if delivery failed, +`delay' +to be notified if delivery is delayed, and +`success' +to be notified when the message is successfully delivered. +.TP +.B \-n +Don't do aliasing. +.TP +\fB\-O\fP \fIoption\fR=\fIvalue\fR +Set option +.I option +to the specified +.IR value . +This form uses long names. See below for more details. +.TP +.BI \-o "x value" +Set option +.I x +to the specified +.IR value . +This form uses single character names only. +The short names are not described in this manual page; +see the +.I "Sendmail Installation and Operation Guide" +for details. +.TP +.BI \-p protocol +Set the name of the protocol used to receive the message. +This can be a simple protocol name such as ``UUCP'' +or a protocol and hostname, such as ``UUCP:ucbvax''. +.TP +\fB\-q\fR[\fItime\fR] +Process saved messages in the queue at given intervals. +If +.I time +is omitted, process the queue once. +.I Time +is given as a tagged number, +with +`s' +being seconds, +`m' +being minutes (default), +`h' +being hours, +`d' +being days, +and +`w' +being weeks. +For example, +`\-q1h30m' +or +`\-q90m' +would both set the timeout to one hour thirty minutes. +By default, +.B sendmail +will run in the background. +This option can be used safely with +.BR \-bd . +.TP +\fB\-qp\fR[\fItime\fR] +Similar to \fB\-q\fItime\fR, +except that instead of periodically forking a child to process the queue, +sendmail forks a single persistent child for each queue +that alternates between processing the queue and sleeping. +The sleep time is given as the argument; it defaults to 1 second. +The process will always sleep at least 5 seconds if the queue was +empty in the previous queue run. +.TP +\fB\-q\fRf +Process saved messages in the queue once and do not fork(), +but run in the foreground. +.TP +\fB\-q\fRG\fIname\fR +Process jobs in queue group called +.I name +only. +.TP +\fB\-q\fR[\fI!\fR]I\fIsubstr\fR +Limit processed jobs to those containing +.I substr +as a substring of the queue id or not when +.I ! +is specified. +.TP +\fB\-q\fR[\fI!\fR]Q\fIsubstr\fR +Limit processed jobs to quarantined jobs containing +.I substr +as a substring of the quarantine reason or not when +.I ! +is specified. +.TP +\fB\-q\fR[\fI!\fR]R\fIsubstr\fR +Limit processed jobs to those containing +.I substr +as a substring of one of the recipients or not when +.I ! +is specified. +.TP +\fB\-q\fR[\fI!\fR]S\fIsubstr\fR +Limit processed jobs to those containing +.I substr +as a substring of the sender or not when +.I ! +is specified. +.TP +\fB\-Q\fR[reason] +Quarantine a normal queue items with the given reason or +unquarantine quarantined queue items if no reason is given. +This should only be used with some sort of item matching using +as described above. +.TP +.BI "\-R " return +Set the amount of the message to be returned +if the message bounces. +The +.I return +parameter can be +`full' +to return the entire message or +`hdrs' +to return only the headers. +In the latter case also local bounces return only the headers. +.TP +.BI \-r name +An alternate and obsolete form of the +.B \-f +flag. +.TP +.B \-t +Read message for recipients. +To:, Cc:, and Bcc: lines will be scanned for recipient addresses. +The Bcc: line will be deleted before transmission. +.TP +.BI "\-V " envid +Set the original envelope id. +This is propagated across SMTP to servers that support DSNs +and is returned in DSN-compliant error messages. +.TP +.B \-v +Go into verbose mode. +Alias expansions will be announced, etc. +.TP +.BI "\-X " logfile +Log all traffic in and out of mailers in the indicated log file. +This should only be used as a last resort +for debugging mailer bugs. +It will log a lot of data very quickly. +.TP +.B \-\- +Stop processing command flags and use the rest of the arguments as +addresses. +.SS Options +There are also a number of processing options that may be set. +Normally these will only be used by a system administrator. +Options may be set either on the command line +using the +.B \-o +flag (for short names), the +.B \-O +flag (for long names), +or in the configuration file. +This is a partial list limited to those options that are likely to be useful +on the command line +and only shows the long names; +for a complete list (and details), consult the +.IR "Sendmail Installation and Operation Guide" . +The options are: +.TP +.RI AliasFile= file +Use alternate alias file. +.TP +HoldExpensive +On mailers that are considered ``expensive'' to connect to, +don't initiate immediate connection. +This requires queueing. +.TP +.RI CheckpointInterval= N +Checkpoint the queue file after every +.I N +successful deliveries (default 10). +This avoids excessive duplicate deliveries +when sending to long mailing lists +interrupted by system crashes. +.ne 1i +.TP +.RI DeliveryMode= x +Set the delivery mode to +.IR x . +Delivery modes are +`i' +for interactive (synchronous) delivery, +`b' +for background (asynchronous) delivery, +`q' +for queue only \- i.e., +actual delivery is done the next time the queue is run, and +`d' +for deferred \- the same as +`q' +except that database lookups for maps which have set the \-D option +(default for the host map) are avoided. +.TP +.RI ErrorMode= x +Set error processing to mode +.IR x . +Valid modes are +`m' +to mail back the error message, +`w' +to ``write'' +back the error message +(or mail it back if the sender is not logged in), +`p' +to print the errors on the terminal +(default), +`q' +to throw away error messages +(only exit status is returned), +and +`e' +to do special processing for the BerkNet. +If the text of the message is not mailed back +by +modes +`m' +or +`w' +and if the sender is local to this machine, +a copy of the message is appended to the file +.I dead.letter +in the sender's home directory. +.TP +SaveFromLine +Save +UNIX-style +From lines at the front of messages. +.TP +.RI MaxHopCount= N +The maximum number of times a message is allowed to ``hop'' +before we decide it is in a loop. +.TP +IgnoreDots +Do not take dots on a line by themselves +as a message terminator. +.TP +SendMimeErrors +Send error messages in MIME format. +If not set, the DSN (Delivery Status Notification) SMTP extension +is disabled. +.TP +.RI ConnectionCacheTimeout= timeout +Set connection cache timeout. +.TP +.RI ConnectionCacheSize= N +Set connection cache size. +.TP +.RI LogLevel= n +The log level. +.TP +.RI MeToo= False +Don't send to ``me'' (the sender) if I am in an alias expansion. +.TP +CheckAliases +Validate the right hand side of aliases during a +newaliases(1) +command. +.TP +OldStyleHeaders +If set, this message may have +old style headers. +If not set, +this message is guaranteed to have new style headers +(i.e., commas instead of spaces between addresses). +If set, an adaptive algorithm is used that will correctly +determine the header format in most cases. +.TP +.RI QueueDirectory= queuedir +Select the directory in which to queue messages. +.TP +.RI StatusFile= file +Save statistics in the named file. +.TP +.RI Timeout.queuereturn= time +Set the timeout on undelivered messages in the queue to the specified time. +After delivery has failed +(e.g., because of a host being down) +for this amount of time, +failed messages will be returned to the sender. +The default is five days. +.TP +.RI UserDatabaseSpec= userdatabase +If set, a user database is consulted to get forwarding information. +You can consider this an adjunct to the aliasing mechanism, +except that the database is intended to be distributed; +aliases are local to a particular host. +This may not be available if your sendmail does not have the +USERDB +option compiled in. +.TP +ForkEachJob +Fork each job during queue runs. +May be convenient on memory-poor machines. +.TP +SevenBitInput +Strip incoming messages to seven bits. +.TP +.RI EightBitMode= mode +Set the handling of eight bit input to seven bit destinations to +.IR mode : +m +(mimefy) will convert to seven-bit MIME format, +p +(pass) will pass it as eight bits (but violates protocols), +and +s +(strict) will bounce the message. +.TP +.RI MinQueueAge= timeout +Sets how long a job must ferment in the queue between attempts to send it. +.TP +.RI DefaultCharSet= charset +Sets the default character set used to label 8-bit data +that is not otherwise labelled. +.TP +.RI DialDelay= sleeptime +If opening a connection fails, +sleep for +.I sleeptime +seconds and try again. +Useful on dial-on-demand sites. +.TP +.RI NoRecipientAction= action +Set the behaviour when there are no recipient headers (To:, Cc: or +Bcc:) in the message to +.IR action : +none +leaves the message unchanged, +add-to +adds a To: header with the envelope recipients, +add-apparently-to +adds an Apparently-To: header with the envelope recipients, +add-bcc +adds an empty Bcc: header, and +add-to-undisclosed +adds a header reading +`To: undisclosed-recipients:;'. +.TP +.RI MaxDaemonChildren= N +Sets the maximum number of children that an incoming SMTP daemon +will allow to spawn at any time to +.IR N . +.TP +.RI ConnectionRateThrottle= N +Sets the maximum number of connections per second to the SMTP port to +.IR N . +.PP +In aliases, +the first character of a name may be +a vertical bar to cause interpretation of +the rest of the name as a command +to pipe the mail to. +It may be necessary to quote the name +to keep +.B sendmail +from suppressing the blanks from between arguments. +For example, a common alias is: +.IP +msgs: "|/usr/bin/msgs -s" +.PP +Aliases may also have the syntax +.RI ``:include: filename '' +to ask +.B sendmail +to read the named file for a list of recipients. +For example, an alias such as: +.IP +poets: ":include:/usr/local/lib/poets.list" +.PP +would read +.I /usr/local/lib/poets.list +for the list of addresses making up the group. +.PP +.B Sendmail +returns an exit status +describing what it did. +The codes are defined in +.RI < sysexits.h >: +.TP +EX_OK +Successful completion on all addresses. +.TP +EX_NOUSER +User name not recognized. +.TP +EX_UNAVAILABLE +Catchall meaning necessary resources +were not available. +.TP +EX_SYNTAX +Syntax error in address. +.TP +EX_SOFTWARE +Internal software error, +including bad arguments. +.TP +EX_OSERR +Temporary operating system error, +such as +``cannot fork''. +.TP +EX_NOHOST +Host name not recognized. +.TP +EX_TEMPFAIL +Message could not be sent immediately, +but was queued. +.PP +If invoked as +.BR newaliases , +.B sendmail +will rebuild the alias database. If invoked as +.BR mailq , +.B sendmail +will print the contents of the mail queue. +If invoked as +.BR hoststat , +.B sendmail +will print the persistent host status database. +If invoked as +.BR purgestat , +.B sendmail +will purge expired entries from the persistent host status database. +If invoked as +.BR smtpd , +.B sendmail +will act as a daemon, as if the +.B \-bd +option were specified. +.SH NOTES +.B sendmail +often gets blamed for many problems +that are actually the result of other problems, +such as overly permissive modes on directories. +For this reason, +.B sendmail +checks the modes on system directories and files +to determine if they can be trusted. +Although these checks can be turned off +and your system security reduced by setting the +.BR DontBlameSendmail +option, +the permission problems should be fixed. +For more information, see: + +.I http://www.sendmail.org/tips/DontBlameSendmail.html +.SH FILES +Except for the file +.I /etc/mail/sendmail.cf +itself the following pathnames are all specified in +.IR /etc/mail/sendmail.cf . +Thus, +these values are only approximations. +.PP +.TP + /etc/mail/aliases +raw data for alias names +.TP + /etc/mail/aliases.db +data base of alias names +.TP + /etc/mail/sendmail.cf +configuration file +.TP + /etc/mail/helpfile +help file +.TP + /etc/mail/statistics +collected statistics +.TP + /var/spool/mqueue/* +temp files +.SH SEE ALSO +binmail(1), +mail(1), +rmail(1), +syslog(3), +aliases(5), +mailaddr(7), +rc(8) +.PP +DARPA +Internet Request For Comments +.IR RFC819 , +.IR RFC821 , +.IR RFC822 . +.IR "Sendmail Installation and Operation Guide" , +No. 8, SMM. +.PP +http://www.sendmail.org/ +.PP +US Patent Numbers 6865671, 6986037. +.SH HISTORY +The +.B sendmail +command appeared in +4.2BSD. diff --git a/upstream/opensuse-leap-15-6/man8/setarch.8 b/upstream/opensuse-leap-15-6/man8/setarch.8 new file mode 100644 index 00000000..49f0586e --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/setarch.8 @@ -0,0 +1,155 @@ +'\" t +.\" Title: setarch +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "SETARCH" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +setarch \- change reported architecture in new program environment and/or set personality flags +.SH "SYNOPSIS" +.sp +\fBsetarch\fP [\fIarch\fP] [options] [\fIprogram\fP [\fIargument\fP...]] +.sp +\fBsetarch\fP \fB\-\-list\fP|\fB\-h\fP|\fB\-V\fP +.sp +\fBarch\fP [options] [\fIprogram\fP [\fIargument\fP...]] +.SH "DESCRIPTION" +.sp +\fBsetarch\fP modifies execution domains and process personality flags. +.sp +The execution domains currently only affects the output of \fBuname \-m\fP. For example, on an AMD64 system, running \fBsetarch i386\fP \fIprogram\fP will cause \fIprogram\fP to see i686 instead of \fIx86_64\fP as the machine type. It can also be used to set various personality options. The default \fIprogram\fP is \fB/bin/sh\fP. +.sp +Since version 2.33 the \fIarch\fP command line argument is optional and \fBsetarch\fP may be used to change personality flags (ADDR_LIMIT_*, SHORT_INODE, etc) without modification of the execution domain. +.SH "OPTIONS" +.sp +\fB\-\-list\fP +.RS 4 +List the architectures that \fBsetarch\fP knows about. Whether \fBsetarch\fP can actually set each of these architectures depends on the running kernel. +.RE +.sp +\fB\-\-uname\-2.6\fP +.RS 4 +Causes the \fIprogram\fP to see a kernel version number beginning with 2.6. Turns on \fBUNAME26\fP. +.RE +.sp +\fB\-v\fP, \fB\-\-verbose\fP +.RS 4 +Be verbose. +.RE +.sp +\fB\-3\fP, \fB\-\-3gb\fP +.RS 4 +Specifies \fIprogram\fP should use a maximum of 3GB of address space. Supported on x86. Turns on \fBADDR_LIMIT_3GB\fP. +.RE +.sp +\fB\-\-4gb\fP +.RS 4 +This option has no effect. It is retained for backward compatibility only, and may be removed in future releases. +.RE +.sp +\fB\-B\fP, \fB\-\-32bit\fP +.RS 4 +Limit the address space to 32 bits to emulate hardware. Supported on ARM and Alpha. Turns on \fBADDR_LIMIT_32BIT\fP. +.RE +.sp +\fB\-F\fP, \fB\-\-fdpic\-funcptrs\fP +.RS 4 +Treat user\-space function pointers to signal handlers as pointers to address descriptors. This option has no effect on architectures that do not support \fBFDPIC\fP ELF binaries. In kernel v4.14 support is limited to ARM, Blackfin, Fujitsu FR\-V, and SuperH CPU architectures. +.RE +.sp +\fB\-I\fP, \fB\-\-short\-inode\fP +.RS 4 +Obsolete bug emulation flag. Turns on \fBSHORT_INODE\fP. +.RE +.sp +\fB\-L\fP, \fB\-\-addr\-compat\-layout\fP +.RS 4 +Provide legacy virtual address space layout. Use when the \fIprogram\fP binary does not have \fBPT_GNU_STACK\fP ELF header. Turns on \fBADDR_COMPAT_LAYOUT\fP. +.RE +.sp +\fB\-R\fP, \fB\-\-addr\-no\-randomize\fP +.RS 4 +Disables randomization of the virtual address space. Turns on \fBADDR_NO_RANDOMIZE\fP. +.RE +.sp +\fB\-S\fP, \fB\-\-whole\-seconds\fP +.RS 4 +Obsolete bug emulation flag. Turns on \fBWHOLE_SECONDS\fP. +.RE +.sp +\fB\-T\fP, \fB\-\-sticky\-timeouts\fP +.RS 4 +This makes \fBselect\fP(2), \fBpselect\fP(2), and \fBppoll\fP(2) system calls preserve the timeout value instead of modifying it to reflect the amount of time not slept when interrupted by a signal handler. Use when \fIprogram\fP depends on this behavior. For more details see the timeout description in \fBselect\fP(2) manual page. Turns on \fBSTICKY_TIMEOUTS\fP. +.RE +.sp +\fB\-X\fP, \fB\-\-read\-implies\-exec\fP +.RS 4 +If this is set then \fBmmap\fP(3p) \fBPROT_READ\fP will also add the \fBPROT_EXEC\fP bit \- as expected by legacy x86 binaries. Notice that the ELF loader will automatically set this bit when it encounters a legacy binary. Turns on \fBREAD_IMPLIES_EXEC\fP. +.RE +.sp +\fB\-Z\fP, \fB\-\-mmap\-page\-zero\fP +.RS 4 +SVr4 bug emulation that will set \fBmmap\fP(3p) page zero as read\-only. Use when \fIprogram\fP depends on this behavior, and the source code is not available to be fixed. Turns on \fBMMAP_PAGE_ZERO\fP. +.RE +.sp +\fB\-V\fP, \fB\-\-version\fP +.RS 4 +Display version information and exit. +.RE +.sp +\fB\-h\fP, \fB\-\-help\fP +.RS 4 +Display help text and exit. +.RE +.SH "EXAMPLE" +.sp +.if n .RS 4 +.nf +.fam C +setarch \-\-addr\-no\-randomize mytestprog +setarch ppc32 rpmbuild \-\-target=ppc \-\-rebuild foo.src.rpm +setarch ppc32 \-v \-vL3 rpmbuild \-\-target=ppc \-\-rebuild bar.src.rpm +setarch ppc32 \-\-32bit rpmbuild \-\-target=ppc \-\-rebuild foo.src.rpm +.fam +.fi +.if n .RE +.SH "AUTHORS" +.sp +.MTO "sopwith\(atredhat.com" "Elliot Lee" "," +.MTO "jnovy\(atredhat.com" "Jindrich Novy" "," +.MTO "kzak\(atredhat.com" "Karel Zak" "" +.SH "SEE ALSO" +.sp +\fBpersonality\fP(2), +\fBselect\fP(2) +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBsetarch\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/setfont.8 b/upstream/opensuse-leap-15-6/man8/setfont.8 new file mode 100644 index 00000000..a702fbea --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/setfont.8 @@ -0,0 +1,272 @@ +.TH SETFONT 8 "11 Feb 2001" "kbd" +.SH NAME +setfont \- load EGA/VGA console screen font +.SH SYNOPSIS +.B setfont +.RB [ -O +.IR font+umap.orig ] +.RB [ -o +.IR font.orig ] +.RB [ -om +.IR cmap.orig ] +.RB [ -ou +.IR umap.orig ] +.RB [ -\c +.IR N ] +.RI [ "font.new ...\&" ] +.RB [ -m +.IR cmap ] +.RB [ -u +.IR umap ] +.RB [ -C +.IR console ] +.RB [ -h\c +.IR H ] +.RB [ -v ] +.RB [ -V ] +.IX "setfont command" "" "\fLsetfont\fR command" +.SH DESCRIPTION +The +.B setfont +command reads a font from the file +.I font.new +and loads it into the EGA/VGA character generator, +and optionally outputs the previous font. +It can also load various mapping tables +and output the previous versions. +.LP +If no args are given (or only the option +.RI \- N +for some number +.IR N ), +then a default +.RI (8x N ) +font is loaded (see below). +One may give several small fonts, all containing +a Unicode table, and +.B setfont +will combine them and load the union. +Typical use: +.TP +.B setfont +Load a default font. +.TP +.B "setfont drdos8x16" +Load a given font (here the 448-glyph drdos font). +.TP +.B "setfont cybercafe -u cybercafe" +Load a given font that does not have a Unicode map +and provide one explicitly. +.TP +.B "setfont LatArCyrHeb-19 -m 8859-2" +Load a given font (here a 512-glyph font combining several +character sets) and indicate that one's local character set +is ISO 8859-2. +.LP +Note: if a font has more than 256 glyphs, only 8 out of 16 colors +can be used simultaneously. It can make console perception worse +(loss of intensity and even some colors). + +.SH "FONT FORMATS" +The standard Linux font format is the PSF font. +It has a header describing font properties like character size, +followed by the glyph bitmaps, optionally followed by a Unicode mapping +table giving the Unicode value for each glyph. +Several other (obsolete) font formats are recognized. +If the input file has code page format (probably with suffix .cp), +containing three fonts with sizes e.g. 8x8, 8x14 and 8x16, then one of +the options \-8 or \-14 or \-16 must be used to select one. +Raw font files are binary files of size +.RI 256* N +bytes, containing bit images for each of 256 characters, +one byte per scan line, and +.I N +bytes per character (0 < +.I N +<= 32). +Most fonts have a width of 8 bits, but with the framebuffer device (fb) +other widths can be used. + +.SH "FONT HEIGHT" +The program +.B setfont +has no built-in knowledge of VGA video modes, but just asks +the kernel to load the character ROM of the video card with +certain bitmaps. However, since Linux 1.3.1 the kernel knows +enough about EGA/VGA video modes to select a different line +distance. The default character height will be the number +.I N +inferred from the font or specified by option. However, the +user can specify a different character height +.I H +using the +.I "\-h" +option. + +.SH "CONSOLE MAPS" +Several mappings are involved in the path from user program +output to console display. If the console is in utf8 mode (see +.BR unicode_start (1)) +then the kernel expects that user program output is coded as UTF-8 (see +.BR utf-8 (7)), +and converts that to Unicode (ucs2). +Otherwise, a translation table is used from the 8-bit program output +to 16-bit Unicode values. Such a translation table is called a +.IR "Unicode console map" . +There are four of them: three built into the kernel, the fourth +settable using the +.I "\-m" +option of +.BR setfont . +An escape sequence chooses between these four tables; after loading a +.IR cmap , +.B setfont +will output the escape sequence Esc ( K that makes it the active translation. +.LP +Suitable arguments for the +.I "\-m" +option are for example +.IR 8859-1 , +.IR 8859-2 ", ...," +.IR 8859-15 , +.IR cp437 ", ...," +.IR cp1250 . +.LP +Given the Unicode value of the symbol to be displayed, the kernel +finds the right glyph in the font using the Unicode mapping info +of the font and displays it. +.LP +Old fonts do not have Unicode mapping info, and in order to handle +them there are direct-to-font maps (also loaded using +.IR "\-m" ) +that give a correspondence between user bytes and font positions. +The most common correspondence is the one given in the file +.I trivial +(where user byte values are used directly as font positions). +Other correspondences are sometimes preferable since the +PC video hardware expects line drawing characters in certain +font positions. +.LP +Giving a +.I "\-m none" +argument inhibits the loading and activation of a mapping table. +The previous console map can be saved to a file using the +.I "\-om file" +option. +These options of setfont render +.BR mapscrn (8) +obsolete. (However, it may be useful to read that man page.) + +.SH "UNICODE FONT MAPS" +The correspondence between the glyphs in the font and +Unicode values is described by a Unicode mapping table. +Many fonts have a Unicode mapping table included in +the font file, and an explicit table can be indicated using +the +.I "\-u" +option. The program +.B setfont +will load such a Unicode mapping table, unless a +.I "\-u none" +argument is given. The previous Unicode mapping table +will be saved as part of the saved font file when the \-O +option is used. It can be saved to a separate file using the +.I "\-ou file" +option. +These options of setfont render +.BR loadunimap (8) +obsolete. +.LP +The Unicode mapping table should assign some glyph to +the `missing character' value U+fffd, otherwise missing +characters are not translated, giving a usually very confusing +result. + +Usually no mapping table is needed, and a Unicode mapping table +is already contained in the font (sometimes this is indicated +by the .psfu extension), so that most users need not worry +about the precise meaning and functioning of these mapping tables. + +One may add a Unicode mapping table to a psf font using +.BR psfaddtable (1). + +.SH OPTIONS +.TP +.BI "\-h " H +Override font height. +.TP +.B \-d +Doubles the size of the font, by replicating all of its pixels +vertically and horizontally. This is suitable for high pixel density +(e.g. "4k") displays on which the standard fonts are too small to be +easily legible. Due to kernel limitations, this is suitable only for +16x16 or smaller fonts. +.TP +.BI "\-m " file +Load console map or Unicode console map from +.IR file . +.TP +.BI "\-o " file +Save previous font in +.IR file . +.TP +.BI "\-O " file +Save previous font and Unicode map in +.IR file . +.TP +.BI "\-om " file +Store console map in +.IR file . +.TP +.BI "\-ou " file +Save previous Unicode map in +.IR file . +.TP +.BI "\-u " file +Load Unicode table describing the font from +.IR file . +.TP +.BI "\-C " console +Set the font for the indicated console. (May require root permissions.) +.TP +.B \-v +Be verbose. +.TP +.B \-V +Print version and exit. + +.SH NOTE +PC video hardware allows one to use the "intensity" bit +either to indicate brightness, or to address 512 (instead of 256) +glyphs in the font. So, if the font has more than 256 glyphs, +the console will be reduced to 8 (instead of 16) colors. + +.SH FILES +.TP +.I /usr/share/kbd/consolefonts +The default font directory. +.LP +.TP +.I /usr/share/kbd/unimaps +The default directory for Unicode maps. +.LP +.TP +.I /usr/share/kbd/consoletrans +The default directory for screen mappings. +.LP +The default font is a file +.I default +(or +.IR default8x N +if the \-N option was given for some number N) +perhaps with suitable extension (like .psf). +.SH "SEE ALSO" +.BR psfaddtable (1), +.BR unicode_start (1), +.BR loadunimap (8), +.BR utf-8 (7), +.BR mapscrn (8) +.\" .SH "AUTHORS" +.\" Eugene G. Crosser (crosser@pccross.msk.su) +.\" .br +.\" Andries E. Brouwer (aeb@cwi.nl) diff --git a/upstream/opensuse-leap-15-6/man8/setkeycodes.8 b/upstream/opensuse-leap-15-6/man8/setkeycodes.8 new file mode 100644 index 00000000..f33db067 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/setkeycodes.8 @@ -0,0 +1,67 @@ +.\" @(#)man/man8/setkeycodes.8 1.0 Nov 8 22:30:48 MET 1994 +.TH SETKEYCODES 8 "8 Nov 1994" "kbd" +.SH NAME +setkeycodes \- load kernel scancode-to-keycode mapping table entries +.SH SYNOPSIS +.B setkeycodes +.I "scancode keycode ..." +.SH DESCRIPTION +The +.I setkeycodes +command reads its arguments two at a time, each pair of arguments +consisting of a scancode (given in hexadecimal) and a keycode (given +in decimal). For each such pair, it tells the kernel keyboard driver +to map the specified scancode to the specified keycode. + +This command is useful only for people with slightly unusual keyboards, +that have a few keys which produce scancodes that the kernel does not +recognize. + +.SH THEORY +The usual PC keyboard produces a series of scancodes for each +key press and key release. (Scancodes are shown by +\fBshowkey \-s\fP, see +.BR showkey (1) +) The kernel parses this stream of scancodes, and converts it to +a stream of keycodes (key press/release events). +(Keycodes are shown by \fBshowkey\fP.) +Apart from a few scancodes with special meaning, and apart from +the sequence produced by the Pause key, and apart from shiftstate +related scancodes, and apart from the key up/down bit, +the stream of scancodes consists of unescaped +scancodes xx (7 bits) and escaped scancodes e0 xx (8+7 bits). +To these scancodes or scancode pairs, a corresponding keycode can be +assigned (in the range 1-127). +For example, if you have a Macro key that produces e0 6f according +to +.BR showkey (1), +the command +.RS +.B "setkeycodes e06f 112" +.RE +will assign the keycode 112 to it, and then +.BR loadkeys (1) +can be used to define the function of this key. +.LP +Some older kernels might hardwire a low scancode range to the +equivalent keycodes; setkeycodes will fail when you try to remap +these. + +.SH "2.6 KERNELS" +In 2.6 kernels key codes lie in the range 1-255, instead of 1-127. +(It might be best to confine oneself to the range 1-239.) +.LP +In 2.6 kernels raw mode, or scancode mode, is not very raw at all. +The code returned by showkey \-s will change after use of setkeycodes. +A kernel bug. See also +.BR showkey (1). +.SH OPTIONS +None. +.SH BUGS +The keycodes of X have nothing to do with those of Linux. +Unusual keys can be made visible under Linux, but not under X. +.SH "SEE ALSO" +.BR dumpkeys (1), +.BR loadkeys (1), +.BR showkey (1), +.BR getkeycodes (8) diff --git a/upstream/opensuse-leap-15-6/man8/setlogcons.8 b/upstream/opensuse-leap-15-6/man8/setlogcons.8 new file mode 100644 index 00000000..ec16cb83 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/setlogcons.8 @@ -0,0 +1,26 @@ +.TH SETLOGCONS 8 "18 Apr 2004" "kbd" + +.SH NAME +setlogcons \- Send kernel messages to console N +.SH SYNOPSIS +.B setlogcons +.I N + +.SH DESCRIPTION +The command +.B setlogcons +.I N +sets all kernel messges to the console specified as N. +.P +By default kernel messages are sent to the current console. +.P +To change the level of messages sent, use +.B dmesg + +.SH "AUTHORS" +.B setlogcons +was originally written by Andries Brouwer for the kbd package. +.P +This manual page was written by Alastair McKinstry. +.SH "SEE ALSO" +.BR dmesg (1) diff --git a/upstream/opensuse-leap-15-6/man8/setpci.8 b/upstream/opensuse-leap-15-6/man8/setpci.8 new file mode 100644 index 00000000..53f8110c --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/setpci.8 @@ -0,0 +1,180 @@ +.TH setpci 8 "17 November 2017" "pciutils-3.5.6" "The PCI Utilities" +.SH NAME +setpci \- configure PCI devices +.SH SYNOPSIS +.B setpci +.RB [ options ] +.B devices +.BR operations ... + +.SH DESCRIPTION +.PP +.B setpci +is a utility for querying and configuring PCI devices. + +All numbers are entered in hexadecimal notation. + +Root privileges are necessary for almost all operations, excluding reads +of the standard header of the configuration space on some operating systems. +Please see +.BR lspci(8) +for details on access rights. + +.SH OPTIONS + +.SS General options +.TP +.B -v +Tells +.I setpci +to be verbose and display detailed information about configuration space accesses. +.TP +.B -f +Tells +.I setpci +not to complain when there's nothing to do (when no devices are selected). +This option is intended for use in widely-distributed configuration scripts +where it's uncertain whether the device in question is present in the machine +or not. +.TP +.B -D +`Demo mode' -- don't write anything to the configuration registers. +It's useful to try +.B setpci -vD +to verify that your complex sequence of +.B setpci +operations does what you think it should do. +.TP +.B --version +Show +.I setpci +version. This option should be used stand-alone. +.TP +.B --help +Show detailed help on available options. This option should be used stand-alone. +.TP +.B --dumpregs +Show a list of all known PCI registers and capabilities. This option should be +used stand-alone. + +.SS PCI access options +.PP +The PCI utilities use the PCI library to talk to PCI devices (see +\fBpcilib\fP(7) for details). You can use the following options to +influence its behavior: +.TP +.B -A <method> +The library supports a variety of methods to access the PCI hardware. +By default, it uses the first access method available, but you can use +this option to override this decision. See \fB-A help\fP for a list of +available methods and their descriptions. +.TP +.B -O <param>=<value> +The behavior of the library is controlled by several named parameters. +This option allows to set the value of any of the parameters. Use \fB-O help\fP +for a list of known parameters and their default values. +.TP +.B -H1 +Use direct hardware access via Intel configuration mechanism 1. +(This is a shorthand for \fB-A intel-conf1\fP.) +.TP +.B -H2 +Use direct hardware access via Intel configuration mechanism 2. +(This is a shorthand for \fB-A intel-conf2\fP.) +.TP +.B -G +Increase debug level of the library. + +.SH DEVICE SELECTION +.PP +Before each sequence of operations you need to select which devices you wish that +operation to affect. +.TP +.B -s [[[[<domain>]:]<bus>]:][<slot>][.[<func>]] +Consider only devices in the specified domain (in case your machine has several host bridges, +they can either share a common bus number space or each of them can address a PCI domain +of its own; domains are numbered from 0 to ffff), bus (0 to ff), slot (0 to 1f) and function (0 to 7). +Each component of the device address can be omitted or set to "*", both meaning "any value". All numbers are +hexadecimal. E.g., "0:" means all devices on bus 0, "0" means all functions of device 0 +on any bus, "0.3" selects third function of device 0 on all buses and ".4" matches only +the fourth function of each device. +.TP +.B -d [<vendor>]:[<device>] +Select devices with specified vendor and device ID. Both ID's are given in +hexadecimal and may be omitted or given as "*", both meaning "any value". +.PP +When +.B -s +and +.B -d +are combined, only devices that match both criteria are selected. When multiple +options of the same kind are specified, the rightmost one overrides the others. + +.SH OPERATIONS +.PP +There are two kinds of operations: reads and writes. To read a register, just specify +its name. Writes have the form +.IR name = value , value ...\& +where each +.I value +is either a hexadecimal number or an expression of type +.IR data : mask +where both +.I data +and +.I mask +are hexadecimal numbers. In the latter case, only the bits corresponding to binary +ones in the \fImask\fP are changed (technically, this is a read-modify-write operation). + +.PP +There are several ways how to identity a register: +.IP \(bu +Tell its address in hexadecimal. +.IP \(bu +Spell its name. Setpci knows the names of all registers in the standard configuration +headers. Use `\fBsetpci --dumpregs\fP' to get the complete list. +See PCI bus specifications for the precise meaning of these registers or consult +\fBheader.h\fP or \fB/usr/include/pci/pci.h\fP for a brief sketch. +.IP \(bu +If the register is a part of a PCI capability, you can specify the name of the +capability to get the address of its first register. See the names starting with +`CAP_' or `ECAP_' in the \fB--dumpregs\fP output. +.IP \(bu +If the name of the capability is not known to \fBsetpci\fP, you can refer to it +by its number in the form CAP\fBid\fP or ECAP\fBid\fP, where \fBid\fP is the numeric +identifier of the capability in hexadecimal. +.IP \(bu +Each of the previous formats can be followed by \fB+offset\fP to add an offset +(a hex number) to the address. This feature can be useful for addressing of registers +living within a capability, or to modify parts of standard registers. +.IP \(bu +Finally, you should append a width specifier \fB.B\fP, \fB.W\fP, or \fB.L\fP to choose +how many bytes (1, 2, or 4) should be transferred. The width can be omitted if you are +referring to a register by its name and the width of the register is well known. + +.PP +All names of registers and width specifiers are case-insensitive. + +.SH +EXAMPLES + +.IP COMMAND +asks for the word-sized command register. +.IP 4.w +is a numeric address of the same register. +.IP COMMAND.l +asks for a 32-bit word starting at the location of the command register, +i.e., the command and status registers together. +.IP VENDOR_ID+1.b +specifies the upper byte of the vendor ID register (remember, PCI is little-endian). +.IP CAP_PM+2.w +corresponds to the second word of the power management capability. +.IP ECAP108.l +asks for the first 32-bit word of the extended capability with ID 0x108. + +.SH SEE ALSO +.BR lspci (8), +.BR pcilib (7) + +.SH AUTHOR +The PCI Utilities are maintained by Martin Mares <mj@ucw.cz>. diff --git a/upstream/opensuse-leap-15-6/man8/setquota.8 b/upstream/opensuse-leap-15-6/man8/setquota.8 new file mode 100644 index 00000000..b59cc2e4 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/setquota.8 @@ -0,0 +1,234 @@ +.TH SETQUOTA 8 +.SH NAME +setquota \- set disk quotas +.SH SYNOPSIS +.B setquota +[ +.B \-rm +] +[ +.B \-u +| +.B \-g +| +.B \-P +] +[ +.B \-F +.I quotaformat +] +.I name +.I block-softlimit +.I block-hardlimit +.I inode-softlimit +.I inode-hardlimit +.B \-a +| +.I filesystem... +.LP +.B setquota +[ +.B \-rm +] +[ +.B \-u +| +.B \-g +| +.B \-P +] +[ +.B \-F +.I quotaformat +] +[ +.B \-p +.I protoname +] +.I name +.B \-a +| +.I filesystem... +.LP +.B setquota +.B \-b +[ +.B \-rm +] +[ +.B \-u +| +.B \-g +| +.B \-P +] +[ +.B \-F +.I quotaformat +] +.B \-a +| +.I filesystem... +.LP +.B setquota +.B \-t +[ +.B \-u +| +.B \-g +| +.B \-P +] +[ +.B \-F +.I quotaformat +] +.I block-grace +.I inode-grace +.B \-a +| +.I filesystem... +.LP +.B setquota +.B \-T +[ +.B \-u +| +.B \-g +| +.B \-P +] +[ +.B \-F +.I quotaformat +] +.I name +.I block-grace +.I inode-grace +.B \-a +| +.I filesystem... +.SH DESCRIPTION +.IX "setquota command" "" "\fLsetquota\fP \(em set disk quotas" +.IX set "disk quotas \(em \fLsetquota\fP" +.IX "disk quotas" "setquota command" "" "\fLsetquota\fP \(em set disk quotas" +.IX "disk quotas" "setquota command" "" "\fLsetquota\fP \(em set disk quotas" +.IX "quotas" "setquota command" "" "\fLsetquota\fP \(em set disk quotas" +.IX "filesystem" "setquota command" "" "\fLsetquota\fP \(em set disk quotas" +.B setquota +is a command line quota editor. +The filesystem, user/group/project name and new quotas for this +filesystem can be specified on the command line. Note that if a number is +given in the place of a user/group/project name it is treated as an UID/GID/project ID. +.TP +.B -r, --remote +Edit also remote quota use rpc.rquotad on remote server to set quota. This +option is available only if quota tools were compiled with enabled support +for setting quotas over RPC. +.TP +.B -m, --no-mixed-pathnames +Currently, pathnames of NFSv4 mountpoints are sent without leading slash in the path. +.BR rpc.rquotad +uses this to recognize NFSv4 mounts and properly prepend pseudoroot of NFS filesystem +to the path. If you specify this option, +.BR setquota +will always send paths with a leading slash. This can be useful for legacy reasons but +be aware that quota over RPC will stop working if you are using new +.BR rpc.rquotad . +.TP +.B -F, --format=\f2quotaformat\f1 +Perform setting for specified format (ie. don't perform format autodetection). +Possible format names are: +.B vfsold +Original quota format with 16-bit UIDs / GIDs, +.B vfsv0 +Quota format with 32-bit UIDs / GIDs, 64-bit space usage, 32-bit inode usage and limits, +.B vfsv1 +Quota format with 64-bit quota limits and usage, +.B rpc +(quota over NFS), +.B xfs +(quota on XFS filesystem) +.TP +.B -u, --user +Set user quotas for named user. This is the default. +.TP +.B -g, --group +Set group quotas for named group. +.TP +.B -P, --project +Set project quotas for named project. +.TP +.B -p, --prototype=\f2protoname\f1 +Use quota settings of user, group or project +.I protoname +to set the quota for the named user, group or project. +.TP +.B --always-resolve +Always try to translate user / group / project name to +uid / gid / project ID even if the name is composed of +digits only. +.TP +.B -b, --batch +Read information to set from stdin (input format is +.I name block-softlimit block-hardlimit inode-softlimit inode-hardlimit +). Empty lines and lines starting with # are ignored. +.TP +.B -c, --continue-batch +If parsing of an input line in batch mode fails, continue with processing the next line. +.TP +.B -t, --edit-period +Set grace times for users/groups/projects. Times +.B block-grace +and +.B inode-grace +are specified in seconds. +.TP +.B -T, --edit-times +Alter times for individual user/group/project when softlimit is enforced. Times +.B block-grace +and +.B inode-grace +are specified in seconds or can be string 'unset'. +.TP +.B -a, --all +Go through all filesystems with quota in +.B /etc/mtab +and perform setting. +.PP +.I block-softlimit +and +.I block-hardlimit +are interpreted as multiples of kibibyte (1024 bytes) blocks by default. +Symbols K, M, G, and T can be appended to numeric value to express kibibytes, +mebibytes, gibibytes, and tebibytes. +.PP +.I inode-softlimit +and +.I inode-hardlimit +are interpreted literally. Symbols k, m, g, and t can be appended to numeric +value to express multiples of 10^3, 10^6, 10^9, and 10^12 inodes. +.PP +To disable a quota, set the corresponding parameter to 0. To change quotas +for several filesystems, invoke once for each filesystem. +.PP +Only the super-user may edit quotas. +.SH FILES +.PD 0 +.TP 20 +.B aquota.user or aquota.group +quota file at the filesystem root (version 2 quota, non-XFS filesystems) +.TP +.B quota.user or quota.group +quota file at the filesystem root (version 1 quota, non-XFS filesystems) +.TP +.B /etc/mtab +mounted filesystem table +.PD +.SH SEE ALSO +.BR edquota (8), +.BR quota (1), +.BR quotactl (2), +.BR quotacheck (8), +.BR quotaon (8), +.BR repquota (8) diff --git a/upstream/opensuse-leap-15-6/man8/setvesablank.8 b/upstream/opensuse-leap-15-6/man8/setvesablank.8 new file mode 100644 index 00000000..08418a1a --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/setvesablank.8 @@ -0,0 +1,27 @@ +.\" @(#)setvesablank.8 +.TH SETVESABLANK 8 "14 Feb 2002" "kbd" +.SH NAME +setvesablank \- Turn VESA screen blanking on or off +.SH SYNOPSIS +.I setvesablank +[ [ +.I -b --blanking +] +.I on | ON | off | OFF +] [ +.I -h --help +] +[ +.I -v --verbose +] +.LP +.SH DESCRIPTION +.IX "setvesablank command" "" "\fLsetvesablank\fR command" +.LP +The program +.B setvesablank +sets VESA screen blanking on or off. +.\" .SH AUTHOR +.\" Andries Brouwer <aeb@cwi.nl>. +.\" .br +.\" Man page by Alastair McKinstry <mckinstry@computer.org> diff --git a/upstream/opensuse-leap-15-6/man8/setvtrgb.8 b/upstream/opensuse-leap-15-6/man8/setvtrgb.8 new file mode 100644 index 00000000..8347f03b --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/setvtrgb.8 @@ -0,0 +1,49 @@ +.\" @(#)man/man8/setvtrgb.8 1.0 Mar 3 12:32:18 CST 2011 +.TH SETVTRGB 8 "3 Mar 2011" "kbd" +.SH NAME +setvtrgb \- set the virtual terminal RGB colors +.SH SYNOPSIS +.B setvtrgb +[\fI\,options\/\fR] +.I vga|FILE|\- +.SH DESCRIPTION +The +.I setvtrgb +command takes a single argument, either the string +.B vga +, or a path to a file +containing the red, green, and blue colors to be used by the Linux virtual terminals. + +If you use the +.B FILE +parameter, +.B FILE +should be exactly 3 lines of 16 +comma-separated decimal values for RED, GREEN, and BLUE. + +To seed a valid +.B FILE +: +.RS +.B "cat /sys/module/vt/parameters/default_{red,grn,blu} > FILE" +.RE + +And then edit the values in +.B FILE + +.SH OPTIONS +.TP +\fB\-C\fR, \fB\-\-console\fR=\fI\,DEV\/\fR +the console device to be used; +.TP +\fB\-h\fR, \fB\-\-help\fR +Prints usage message and exits. +.TP +\fB\-V\fR, \fB\-\-version\fR +Prints version number and exists. + +.SH AUTHOR +The utility is written by Alexey Gladkov, Seth Forshee, Dustin Kirkland. + +.SH DOCUMENTATION +Documentation by Dustin Kirkland. diff --git a/upstream/opensuse-leap-15-6/man8/sfdisk.8 b/upstream/opensuse-leap-15-6/man8/sfdisk.8 new file mode 100644 index 00000000..964589b9 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/sfdisk.8 @@ -0,0 +1,602 @@ +'\" t +.\" Title: sfdisk +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "SFDISK" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +sfdisk \- display or manipulate a disk partition table +.SH "SYNOPSIS" +.sp +\fBsfdisk\fP [options] \fIdevice\fP [\fB\-N\fP \fIpartition\-number\fP] +.sp +\fBsfdisk\fP [options] \fIcommand\fP +.SH "DESCRIPTION" +.sp +\fBsfdisk\fP is a script\-oriented tool for partitioning any block device. It runs in interactive mode if executed on a terminal (stdin refers to a terminal). +.sp +Since version 2.26 \fBsfdisk\fP supports MBR (DOS), GPT, SUN and SGI disk labels, but no longer provides any functionality for CHS (Cylinder\-Head\-Sector) addressing. CHS has never been important for Linux, and this addressing concept does not make any sense for new devices. +.sp +\fBsfdisk\fP protects the first disk sector when create a new disk label. The option \fB\-\-wipe always\fP disables this protection. Note that \fBfdisk\fP(8) and \fBcfdisk\fP(8) completely erase this area by default. +.sp +\fBsfdisk\fP (since version 2.26) \fBaligns the start and end of partitions\fP to block\-device I/O limits when relative sizes are specified, when the default values are used or when multiplicative suffixes (e.g., MiB) are used for sizes. It is possible that partition size will be optimized (reduced or enlarged) due to alignment if the start offset is specified exactly in sectors and partition size relative or by multiplicative suffixes. +.sp +The recommended way is not to specify start offsets at all and specify partition size in MiB, GiB (or so). In this case \fBsfdisk\fP aligns all partitions to block\-device I/O limits (or when I/O limits are too small then to megabyte boundary to keep disk layout portable). If this default behaviour is unwanted (usually for very small partitions) then specify offsets and sizes in sectors. In this case \fBsfdisk\fP entirely follows specified numbers without any optimization. +.sp +\fBsfdisk\fP does not create the standard system partitions for SGI and SUN disk labels like \fBfdisk\fP(8) does. It is necessary to explicitly create all partitions including whole\-disk system partitions. +.sp +\fBsfdisk\fP uses \fBBLKRRPART\fP (reread partition table) ioctl to make sure that the device is not used by system or other tools (see also \fB\-\-no\-reread\fP). It\(cqs possible that this feature or another \fBsfdisk\fP activity races with \fBudevd\fP. The recommended way how to avoid possible collisions is to use \fB\-\-lock\fP option. The exclusive lock will cause udevd to skip the event handling on the device. +.sp +The \fBsfdisk\fP prompt is only a hint for users and a displayed partition number does not mean that the same partition table entry will be created (if \fB\-N\fP not specified), especially for tables with gaps. +.SH "COMMANDS" +.sp +The commands are mutually exclusive. +.sp +[\fB\-N\fP \fIpartition\-number\fP] \fIdevice\fP +.RS 4 +The default \fBsfdisk\fP command is to read the specification for the desired partitioning of \fIdevice\fP from standard input, and then create a partition table according to the specification. See below for the description of the input format. If standard input is a terminal, then \fBsfdisk\fP starts an interactive session. +.sp +If the option \fB\-N\fP is specified, then the changes are applied to the partition addressed by \fIpartition\-number\fP. The unspecified fields of the partition are not modified. +.sp +Note that it\(cqs possible to address an unused partition with \fB\-N\fP. For example, an MBR always contains 4 partitions, but the number of used partitions may be smaller. In this case \fBsfdisk\fP follows the default values from the partition table and does not use built\-in defaults for the unused partition given with \fB\-N\fP. See also \fB\-\-append\fP. +.RE +.sp +\fB\-A\fP, \fB\-\-activate\fP \fIdevice\fP [\fIpartition\-number\fP...] +.RS 4 +Switch on the bootable flag for the specified partitions and switch off the bootable flag on all unspecified partitions. The special placeholder \(aq\-\(aq may be used instead of the partition numbers to switch off the bootable flag on all partitions. +.sp +The activation command is supported for MBR and PMBR only. If a GPT label is detected, then \fBsfdisk\fP prints warning and automatically enters PMBR. +.sp +If no \fIpartition\-number\fP is specified, then list the partitions with an enabled flag. +.RE +.sp +\fB\-\-delete\fP \fIdevice\fP [\fIpartition\-number\fP...] +.RS 4 +Delete all or the specified partitions. +.RE +.sp +\fB\-d\fP, \fB\-\-dump\fP \fIdevice\fP +.RS 4 +Dump the partitions of a device in a format that is usable as input to \fBsfdisk\fP. See the section \fBBACKING UP THE PARTITION TABLE\fP. +.RE +.sp +\fB\-g\fP, \fB\-\-show\-geometry\fP [\fIdevice\fP...] +.RS 4 +List the geometry of all or the specified devices. For backward compatibility the deprecated option \fB\-\-show\-pt\-geometry\fP have the same meaning as this one. +.RE +.sp +\fB\-J\fP, \fB\-\-json\fP \fIdevice\fP +.RS 4 +Dump the partitions of a device in JSON format. Note that \fBsfdisk\fP is not able to use JSON as input format. +.RE +.sp +\fB\-l\fP, \fB\-\-list\fP [\fIdevice\fP...] +.RS 4 +List the partitions of all or the specified devices. This command can be used together with \fB\-\-verify\fP. +.RE +.sp +\fB\-F\fP, \fB\-\-list\-free\fP [\fIdevice\fP...] +.RS 4 +List the free unpartitioned areas on all or the specified devices. +.RE +.sp +\fB\-\-part\-attrs\fP \fIdevice partition\-number\fP [\fIattributes\fP] +.RS 4 +Change the GPT partition attribute bits. If \fIattributes\fP is not specified, then print the current partition settings. The \fIattributes\fP argument is a comma\- or space\-delimited list of bits numbers or bit names. For example, the string "RequiredPartition,50,51" sets three bits. The currently supported attribute bits are: +.sp +\fBBit 0 (RequiredPartition)\fP +.RS 4 +If this bit is set, the partition is required for the platform to function. The creator of the partition indicates that deletion or modification of the contents can result in loss of platform features or failure for the platform to boot or operate. The system cannot function normally if this partition is removed, and it should be considered part of the hardware of the system. +.RE +.sp +\fBBit 1 (NoBlockIOProtocol)\fP +.RS 4 +EFI firmware should ignore the content of the partition and not try to read from it. +.RE +.sp +\fBBit 2 (LegacyBIOSBootable)\fP +.RS 4 +The partition may be bootable by legacy BIOS firmware. +.RE +.sp +\fBBits 3\-47\fP +.RS 4 +Undefined and must be zero. Reserved for expansion by future versions of the UEFI specification. +.RE +.sp +\fBBits 48\-63\fP +.RS 4 +Reserved for GUID specific use. The use of these bits will vary depending on the partition type. For example Microsoft uses bit 60 to indicate read\-only, 61 for shadow copy of another partition, 62 for hidden partitions and 63 to disable automount. +.RE +.RE +.sp +\fB\-\-part\-label\fP \fIdevice partition\-number\fP [\fIlabel\fP] +.RS 4 +Change the GPT partition name (label). If \fIlabel\fP is not specified, then print the current partition label. +.RE +.sp +\fB\-\-part\-type\fP \fIdevice partition\-number\fP [\fItype\fP] +.RS 4 +Change the partition type. If \fItype\fP is not specified, then print the current partition type. +.sp +The \fItype\fP argument is hexadecimal for MBR, GUID for GPT, type alias (e.g. "linux") or type shortcut (e.g. \(aqL\(aq). For backward compatibility the options \fB\-c\fP and \fB\-\-id\fP have the same meaning as this one. +.RE +.sp +\fB\-\-part\-uuid\fP \fIdevice partition\-number\fP [\fIuuid\fP] +.RS 4 +Change the GPT partition UUID. If \fIuuid\fP is not specified, then print the current partition UUID. +.RE +.sp +\fB\-\-disk\-id\fP \fIdevice\fP [\fIid\fP] +.RS 4 +Change the disk identifier. If \fIid\fP is not specified, then print the current identifier. The identifier is UUID for GPT or unsigned integer for MBR. +.RE +.sp +\fB\-r\fP, \fB\-\-reorder\fP \fIdevice\fP +.RS 4 +Renumber the partitions, ordering them by their start offset. +.RE +.sp +\fB\-s\fP, \fB\-\-show\-size\fP [\fIdevice\fP...] +.RS 4 +List the sizes of all or the specified devices in units of 1024 byte size. This command is DEPRECATED in favour of \fBblockdev\fP(8). +.RE +.sp +\fB\-T\fP, \fB\-\-list\-types\fP +.RS 4 +Print all supported types for the current disk label or the label specified by \fB\-\-label\fP. +.RE +.sp +\fB\-V\fP, \fB\-\-verify\fP [\fIdevice\fP...] +.RS 4 +Test whether the partition table and partitions seem correct. +.RE +.sp +\fB\-\-relocate\fP \fIoper\fP \fIdevice\fP +.RS 4 +Relocate partition table header. This command is currently supported for GPT header only. The argument \fIoper\fP can be: +.sp +\fBgpt\-bak\-std\fP +.RS 4 +Move GPT backup header to the standard location at the end of the device. +.RE +.sp +\fBgpt\-bak\-mini\fP +.RS 4 +Move GPT backup header behind the last partition. Note that UEFI standard requires the backup header at the end of the device and partitioning tools can automatically relocate the header to follow the standard. +.RE +.RE +.SH "OPTIONS" +.sp +\fB\-a\fP, \fB\-\-append\fP +.RS 4 +Don\(cqt create a new partition table, but only append the specified partitions. +.sp +Note that unused partition maybe be re\-used in this case although it is not the last partition in the partition table. See also \fB\-N\fP to specify entry in the partition table. +.RE +.sp +\fB\-b\fP, \fB\-\-backup\fP +.RS 4 +Back up the current partition table sectors before starting the partitioning. The default backup file name is \fI~/sfdisk\-<device>\-<offset>.bak\fP; to use another name see option \fB\-O\fP, \fB\-\-backup\-file\fP. +.RE +.sp +\fB\-\-color\fP[\fB=\fP\fIwhen\fP] +.RS 4 +Colorize the output. The optional argument \fIwhen\fP can be \fBauto\fP, \fBnever\fP or \fBalways\fP. If the \fIwhen\fP argument is omitted, it defaults to \fBauto\fP. The colors can be disabled; for the current built\-in default see the \fB\-\-help\fP output. See also the \fBCOLORS\fP section. +.RE +.sp +\fB\-f\fP, \fB\-\-force\fP +.RS 4 +Disable all consistency checking. +.RE +.sp +\fB\-\-Linux\fP +.RS 4 +Deprecated and ignored option. Partitioning that is compatible with Linux (and other modern operating systems) is the default. +.RE +.sp +\fB\-\-lock\fP[=\fImode\fP] +.RS 4 +Use exclusive BSD lock for device or file it operates. The optional argument \fImode\fP can be \fByes\fP, \fBno\fP (or 1 and 0) or \fBnonblock\fP. If the \fImode\fP argument is omitted, it defaults to \fB"yes"\fP. This option overwrites environment variable \fB$LOCK_BLOCK_DEVICE\fP. The default is not to use any lock at all, but it\(cqs recommended to avoid collisions with udevd or other tools. +.RE +.sp +\fB\-n\fP, \fB\-\-no\-act\fP +.RS 4 +Do everything except writing to the device. +.RE +.sp +\fB\-\-no\-reread\fP +.RS 4 +Do not check through the re\-read\-partition\-table ioctl whether the device is in use. +.RE +.sp +\fB\-\-no\-tell\-kernel\fP +.RS 4 +Don\(cqt tell the kernel about partition changes. This option is recommended together with \fB\-\-no\-reread\fP to modify a partition on used disk. The modified partition should not be used (e.g., mounted). +.RE +.sp +\fB\-O\fP, \fB\-\-backup\-file\fP \fIpath\fP +.RS 4 +Override the default backup file name. Note that the device name and offset are always appended to the file name. +.RE +.sp +\fB\-\-move\-data\fP[\fB=\fP\fIpath\fP] +.RS 4 +Move data after partition relocation, for example when moving the beginning of a partition to another place on the disk. The size of the partition has to remain the same, the new and old location may overlap. This option requires option \fB\-N\fP in order to be processed on one specific partition only. +.sp +The optional \fIpath\fP specifies log file name. The log file contains information about all read/write operations on the partition data. The word "@default" as a \fIpath\fP forces sfdisk to use \fI~/sfdisk\-<devname>.move\fP for the log. The log is optional since v2.35. +.sp +Note that this operation is risky and not atomic. \fBDon\(cqt forget to backup your data!\fP +.sp +See also \fB\-\-move\-use\-fsync\fP. +.sp +In the example below, the first command creates a 100MiB free area before the first partition and moves the data it contains (e.g., a filesystem), the next command creates a new partition from the free space (at offset 2048), and the last command reorders partitions to match disk order (the original sdc1 will become sdc2). +.sp +\fBecho \(aq+100M,\(aq | sfdisk \-\-move\-data /dev/sdc \-N 1\fP \fBecho \(aq2048,\(aq | sfdisk /dev/sdc \-\-append\fP \fBsfdisk /dev/sdc \-\-reorder\fP +.RE +.sp +\fB\-\-move\-use\-fsync\fP +.RS 4 +Use the \fBfsync\fP(2) system call after each write when moving data to a new location by \fB\-\-move\-data\fP. +.RE +.sp +\fB\-o\fP, \fB\-\-output\fP \fIlist\fP +.RS 4 +Specify which output columns to print. Use \fB\-\-help\fP to get a list of all supported columns. +.sp +The default list of columns may be extended if \fIlist\fP is specified in the format \fI+list\fP (e.g., \fB\-o +UUID\fP). +.RE +.sp +\fB\-q\fP, \fB\-\-quiet\fP +.RS 4 +Suppress extra info messages. +.RE +.sp +\fB\-u\fP, \fB\-\-unit S\fP +.RS 4 +Deprecated option. Only the sector unit is supported. This option is not supported when using the \fB\-\-show\-size\fP command. +.RE +.sp +\fB\-X\fP, \fB\-\-label\fP \fItype\fP +.RS 4 +Specify the disk label type (e.g., \fBdos\fP, \fBgpt\fP, ...). If this option is not given, then \fBsfdisk\fP defaults to the existing label, but if there is no label on the device yet, then the type defaults to \fBdos\fP. The default or the current label may be overwritten by the "label: <name>" script header line. The option \fB\-\-label\fP does not force \fBsfdisk\fP to create empty disk label (see the \fBEMPTY DISK LABEL\fP section below). +.RE +.sp +\fB\-Y\fP, \fB\-\-label\-nested\fP \fItype\fP +.RS 4 +Force editing of a nested disk label. The primary disk label has to exist already. This option allows editing for example a hybrid/protective MBR on devices with GPT. +.RE +.sp +\fB\-w\fP, \fB\-\-wipe\fP \fIwhen\fP +.RS 4 +Wipe filesystem, RAID and partition\-table signatures from the device, in order to avoid possible collisions. The argument \fIwhen\fP can be \fBauto\fP, \fBnever\fP or \fBalways\fP. When this option is not given, the default is \fBauto\fP, in which case signatures are wiped only when in interactive mode; except the old partition\-table signatures which are always wiped before create a new partition\-table if the argument \fIwhen\fP is not \fBnever\fP. The \fBauto\fP mode also does not wipe the first sector (boot sector), it is necessary to use the \fBalways\fP mode to wipe this area. In all cases detected signatures are reported by warning messages before a new partition table is created. See also the \fBwipefs\fP(8) command. +.RE +.sp +\fB\-W\fP, \fB\-\-wipe\-partitions\fP \fIwhen\fP +.RS 4 +Wipe filesystem, RAID and partition\-table signatures from a newly created partitions, in order to avoid possible collisions. The argument \fIwhen\fP can be \fBauto\fP, \fBnever\fP or \fBalways\fP. When this option is not given, the default is \fBauto\fP, in which case signatures are wiped only when in interactive mode and after confirmation by user. In all cases detected signatures are reported by warning messages after a new partition is created. See also \fBwipefs\fP(8) command. +.RE +.sp +\fB\-v\fP, \fB\-\-version\fP +.RS 4 +Display version information and exit. +.RE +.sp +\fB\-h\fP, \fB\-\-help\fP +.RS 4 +Display help text and exit. +.RE +.SH "INPUT FORMATS" +.sp +\fBsfdisk\fP supports two input formats and generic header lines. +.SS "Header lines" +.sp +The optional header lines specify generic information that apply to the partition table. The header\-line format is: +.sp +\fB<name>: <value>\fP +.sp +The currently recognized headers are: +.sp +\fBunit\fP +.RS 4 +Specify the partitioning unit. The only supported unit is \fBsectors\fP. +.RE +.sp +\fBlabel\fP +.RS 4 +Specify the partition table type. For example \fBdos\fP or \fBgpt\fP. +.RE +.sp +\fBlabel\-id\fP +.RS 4 +Specify the partition table identifier. It should be a hexadecimal number (with a 0x prefix) for MBR and a UUID for GPT. +.RE +.sp +\fBfirst\-lba\fP +.RS 4 +Specify the first usable sector for GPT partitions. +.RE +.sp +\fBlast\-lba\fP +.RS 4 +Specify the last usable sector for GPT partitions. +.RE +.sp +\fBtable\-length\fP +.RS 4 +Specify the maximal number of GPT partitions. +.RE +.sp +\fBgrain\fP +.RS 4 +Specify minimal size in bytes used to calculate partitions alignment. The default is 1MiB and it\(cqs strongly recommended to use the default. Do not modify this variable if you\(cqre not sure. +.RE +.sp +\fBsector\-size\fP +.RS 4 +Specify sector size. This header is informative only and it is not used when sfdisk creates a new partition table, in this case the real device specific value is always used and sector size from the dump is ignored. +.RE +.sp +Note that it is only possible to use header lines before the first partition is specified in the input. +.SS "Unnamed\-fields format" +.RS 3 +.ll -.6i +.sp +\fIstart size type bootable\fP +.br +.RE +.ll +.sp +where each line fills one partition descriptor. +.sp +Fields are separated by whitespace, comma or semicolon possibly followed by whitespace; initial and trailing whitespace is ignored. Numbers can be octal, decimal or hexadecimal; decimal is the default. When a field is absent, empty or specified as \(aq\-\(aq a default value is used. But when the \fB\-N\fP option (change a single partition) is given, the default for each field is its previous value. +.sp +The default value of \fIstart\fP is the first non\-assigned sector aligned according to device I/O limits. The default start offset for the first partition is 1 MiB. The offset may be followed by the multiplicative suffixes (KiB, MiB, GiB, TiB, PiB, EiB, ZiB and YiB) then the number is interpreted as offset in bytes. +.sp +The default value of \fIsize\fP indicates "as much as possible"; i.e., until the next partition or end\-of\-device. A numerical argument is by default interpreted as a number of sectors, however if the size is followed by one of the multiplicative suffixes (KiB, MiB, GiB, TiB, PiB, EiB, ZiB and YiB) then the number is interpreted as the size of the partition in bytes and it is then aligned according to the device I/O limits. A \(aq+\(aq can be used instead of a number to enlarge the partition as much as possible. Note \(aq+\(aq is equivalent to the default behaviour for a new partition; existing partitions will be resized as required. +.sp +The partition \fItype\fP is given in hex for MBR (DOS) where 0x prefix is optional; a GUID string for GPT; a shortcut or an alias. It\(cqs recommended to use two letters for MBR hex codes to avoid collision between deprecated shortcut \(aqE\(aq and \(aq0E\(aq MBR hex code. For backward compatibility \fBsfdisk\fP tries to interpret \fItype\fP as a shortcut as a first possibility in partitioning scripts although on other places (e.g. \fB\-\-part\-type\fP command) it tries shortcuts as the last possibility. +.sp +Since v2.36 libfdisk supports partition type aliases as extension to shortcuts. The alias is a simple human readable word (e.g. "linux"). +.sp +Since v2.37 libfdisk supports partition type names on input, ignoring the case of the characters and all non\-alphanumeric and non\-digit characters in the name (e.g. "Linux /usr x86" is the same as "linux usr\-x86"). +.sp +Supported shortcuts and aliases: +.sp +\fBL \- alias \(aqlinux\(aq\fP +.RS 4 +Linux; means 83 for MBR and 0FC63DAF\-8483\-4772\-8E79\-3D69D8477DE4 for GPT. +.RE +.sp +\fBS \- alias \(aqswap\(aq\fP +.RS 4 +swap area; means 82 for MBR and 0657FD6D\-A4AB\-43C4\-84E5\-0933C84B4F4F for GPT +.RE +.sp +\fBEx \- alias \(aqextended\(aq\fP +.RS 4 +MBR extended partition; means 05 for MBR. The original shortcut \(aqE\(aq is deprecated due to collision with 0x0E MBR partition type. +.RE +.sp +\fBH \- alias \(aqhome\(aq\fP +.RS 4 +home partition; means 933AC7E1\-2EB4\-4F13\-B844\-0E14E2AEF915 for GPT +.RE +.sp +\fBU \- alias \(aquefi\(aq\fP +.RS 4 +EFI System partition, means EF for MBR and C12A7328\-F81F\-11D2\-BA4B\-00A0C93EC93B for GPT +.RE +.sp +\fBR \- alias \(aqraid\(aq\fP +.RS 4 +Linux RAID; means FD for MBR and A19D880F\-05FC\-4D3B\-A006\-743F0F84911E for GPT +.RE +.sp +\fBV \- alias \(aqlvm\(aq\fP +.RS 4 +LVM; means 8E for MBR and E6D6D379\-F507\-44C2\-A23C\-238F2A3DF928 for GPT +.RE +.sp +The default \fItype\fP value is \fIlinux\fP. +.sp +The shortcut \(aqX\(aq for Linux extended partition (85) is deprecated in favour of \(aqEx\(aq. +.sp +\fIbootable\fP is specified as [\fB*\fP|\fB\-\fP], with as default not\-bootable. The value of this field is irrelevant for Linux \- when Linux runs it has been booted already \- but it might play a role for certain boot loaders and for other operating systems. +.SS "Named\-fields format" +.sp +This format is more readable, robust, extensible and allows specifying additional information (e.g., a UUID). It is recommended to use this format to keep your scripts more readable. +.RS 3 +.ll -.6i +.sp +[\fIdevice\fP \fB:\fP] \fIname\fP[\fB=\fP\fIvalue\fP], ... +.br +.RE +.ll +.sp +The \fIdevice\fP field is optional. \fBsfdisk\fP extracts the partition number from the device name. It allows specifying the partitions in random order. This functionality is mostly used by \fB\-\-dump\fP. Don\(cqt use it if you are not sure. +.sp +The \fIvalue\fP can be between quotation marks (e.g., name="This is partition name"). The currently supported fields are: +.sp +\fBstart=\fP\fInumber\fP +.RS 4 +The first non\-assigned sector aligned according to device I/O limits. The default start offset for the first partition is 1 MiB. The offset may be followed by the multiplicative suffixes (KiB, MiB, GiB, TiB, PiB, EiB, ZiB and YiB) then the number is interpreted as offset in bytes. +.RE +.sp +\fBsize=\fP\fInumber\fP +.RS 4 +Specify the partition size in sectors. The number may be followed by the multiplicative suffixes (KiB, MiB, GiB, TiB, PiB, EiB, ZiB and YiB), then it\(cqs interpreted as size in bytes and the size is aligned according to device I/O limits. +.RE +.sp +\fBbootable\fP +.RS 4 +Mark the partition as bootable. +.RE +.sp +\fBattrs=\fP\fIstring\fP +.RS 4 +Partition attributes, usually GPT partition attribute bits. See \fB\-\-part\-attrs\fP for more details about the GPT\-bits string format. +.RE +.sp +\fBuuid=\fP\fIstring\fP +.RS 4 +GPT partition UUID. +.RE +.sp +\fBname=\fP\fIstring\fP +.RS 4 +GPT partition name. +.RE +.sp +\fBtype=\fP\fIcode\fP +.RS 4 +A hexadecimal number (without 0x) for an MBR partition, a GUID for a GPT partition, a shortcut as for unnamed\-fields format or a type name (e.g. type="Linux /usr (x86)"). See above the section about the unnamed\-fields format for more details. For backward compatibility the \fBId=\fP field has the same meaning. +.RE +.SH "EMPTY DISK LABEL" +.sp +\fBsfdisk\fP does not create partition table without partitions by default. The lines with partitions are expected in the script by default. The empty partition table has to be explicitly requested by "label: <name>" script header line without any partitions lines. For example: +.RS 3 +.ll -.6i +.sp +\fBecho \(aqlabel: gpt\(aq | sfdisk /dev/sdb\fP +.br +.RE +.ll +.sp +creates empty GPT partition table. Note that the \fB\-\-append\fP disables this feature. +.SH "BACKING UP THE PARTITION TABLE" +.sp +It is recommended to save the layout of your devices. \fBsfdisk\fP supports two ways. +.sp +Use the \fB\-\-dump\fP option to save a description of the device layout to a text file. The dump format is suitable for later \fBsfdisk\fP input. For example: +.RS 3 +.ll -.6i +.sp +\fBsfdisk \-\-dump /dev/sda > sda.dump\fP +.br +.RE +.ll +.sp +This can later be restored by: +.RS 3 +.ll -.6i +.sp +\fBsfdisk /dev/sda < sda.dump\fP +.br +.RE +.ll +.sp +If you want to do a full (binary) backup of all sectors where the partition table is stored, then use the \fB\-\-backup\fP option. It writes the sectors to \fI~/sfdisk\-<device>\-<offset>.bak\fP files. The default name of the backup file can be changed with the \fB\-\-backup\-file\fP option. The backup files contain only raw data from the \fIdevice\fP. Note that the same concept of backup files is used by \fBwipefs\fP(8). For example: +.RS 3 +.ll -.6i +.sp +\fBsfdisk \-\-backup /dev/sda\fP +.br +.RE +.ll +.sp +The GPT header can later be restored by: +.RS 3 +.ll -.6i +.sp +dd if=~/sfdisk\-sda\-0x00000200.bak of=/dev/sda \(rs +seek=$0x00000200 bs=1 conv=notrunc +.br +.RE +.ll +.sp +Note that \fBsfdisk\fP since version 2.26 no longer provides the \fB\-I\fP option to restore sectors. \fBdd\fP(1) provides all necessary functionality. +.SH "COLORS" +.sp +Implicit coloring can be disabled by an empty file \fI/etc/terminal\-colors.d/sfdisk.disable\fP. +.sp +See \fBterminal\-colors.d\fP(5) for more details about colorization configuration. The logical color names supported by \fBsfdisk\fP are: +.sp +\fBheader\fP +.RS 4 +The header of the output tables. +.RE +.sp +\fBwarn\fP +.RS 4 +The warning messages. +.RE +.sp +\fBwelcome\fP +.RS 4 +The welcome message. +.RE +.SH "ENVIRONMENT" +.sp +SFDISK_DEBUG=all +.RS 4 +enables \fBsfdisk\fP debug output. +.RE +.sp +LIBFDISK_DEBUG=all +.RS 4 +enables libfdisk debug output. +.RE +.sp +LIBBLKID_DEBUG=all +.RS 4 +enables libblkid debug output. +.RE +.sp +LIBSMARTCOLS_DEBUG=all +.RS 4 +enables libsmartcols debug output. +.RE +.sp +LOCK_BLOCK_DEVICE=<mode> +.RS 4 +use exclusive BSD lock. The mode is "1" or "0". See \fB\-\-lock\fP for more details. +.RE +.SH "NOTES" +.sp +Since version 2.26 \fBsfdisk\fP no longer provides the \fB\-R\fP or \fB\-\-re\-read\fP option to force the kernel to reread the partition table. Use \fBblockdev \-\-rereadpt\fP instead. +.sp +Since version 2.26 \fBsfdisk\fP does not provide the \fB\-\-DOS\fP, \fB\-\-IBM\fP, \fB\-\-DOS\-extended\fP, \fB\-\-unhide\fP, \fB\-\-show\-extended\fP, \fB\-\-cylinders\fP, \fB\-\-heads\fP, \fB\-\-sectors\fP, \fB\-\-inside\-outer\fP, \fB\-\-not\-inside\-outer\fP options. +.SH "AUTHORS" +.sp +.MTO "kzak\(atredhat.com" "Karel Zak" "" +.sp +The current \fBsfdisk\fP implementation is based on the original \fBsfdisk\fP from Andries E. Brouwer. +.SH "SEE ALSO" +.sp +\fBfdisk\fP(8), +\fBcfdisk\fP(8), +\fBparted\fP(8), +\fBpartprobe\fP(8), +\fBpartx\fP(8) +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBsfdisk\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/showconsolefont.8 b/upstream/opensuse-leap-15-6/man8/showconsolefont.8 new file mode 100644 index 00000000..851301ab --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/showconsolefont.8 @@ -0,0 +1,34 @@ +.TH SHOWCONSOLEFONT 8 "2002-02-22" "kbd" + +.SH NAME +showconsolefont \- Show the current EGA/VGA console screen font + +.SH SYNOPSIS +.B showconsolefont +[ +.B \-V | \-\-version +] [ +.B \-v +] [ +.B \-i +] [ +.B \-C +.I console +] + +.SH DESCRIPTION +The +.B showconsolefont +command outputs the current console font to stdout. The option +.B \-v +prints additional information, while the option +.B \-V +prints the program version number. The option +.B \-i +doesn't print out the font table, just shows ROWSxCOLSxCOUNT and exits. +On Linux 2.6.1 and later, the option +.B \-C +allows one to indicate the console involved. Its argument is a pathname. + +.SH "SEE ALSO" +.BR setfont (8) diff --git a/upstream/opensuse-leap-15-6/man8/showmount.8 b/upstream/opensuse-leap-15-6/man8/showmount.8 new file mode 100644 index 00000000..a2f510fb --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/showmount.8 @@ -0,0 +1,60 @@ +.\" Copyright 1993 Rick Sladkey <jrs@world.std.com> +.\" May be distributed under the GNU General Public License +.TH SHOWMOUNT 8 "6 October 1993" +.SH NAME +showmount \- show mount information for an NFS server +.SH SYNOPSIS +.B showmount +.B "[\ \-adehv\ ]" +.B "[\ \-\-all\ ]" +.B "[\ \-\-directories\ ]" +.B "[\ \-\-exports\ ]" +.B "[\ \-\-help\ ]" +.B "[\ \-\-version\ ]" +.B "[\ host\ ]" +.SH DESCRIPTION +.B showmount +queries the mount daemon on a remote host for information about +the state of the NFS server on that machine. With no options +.B showmount +lists the set of clients who are mounting from that host. +The output from +.B showmount +is designed to +appear as though it were processed through ``sort \-u''. +.SH OPTIONS +.TP +.BR \-a " or " \-\-all +List both the client hostname or IP address and mounted directory in +host:dir format. This info should not be considered reliable. See the notes +on rmtab in +.BR rpc.mountd (8). +.TP +.BR \-d " or " \-\-directories +List only the directories mounted by some client. +.TP +.BR \-e " or " \-\-exports +Show the NFS server's export list. +.TP +.BR \-h " or " \-\-help +Provide a short help summary. +.TP +.BR \-v " or " \-\-version +Report the current version number of the program. +.TP +.B \-\-no\-headers +Suppress the descriptive headings from the output. +.SH "SEE ALSO" +.BR rpc.mountd (8), +.BR rpc.nfsd (8) +.SH BUGS +The completeness and accuracy of the information that +.B showmount +displays varies according to the NFS server's implementation. +.P +Because +.B showmount +sorts and uniqs the output, it is impossible to determine from +the output whether a client is mounting the same directory more than once. +.SH AUTHOR +Rick Sladkey <jrs@world.std.com> diff --git a/upstream/opensuse-leap-15-6/man8/shutdown.8 b/upstream/opensuse-leap-15-6/man8/shutdown.8 new file mode 100644 index 00000000..eff64f9f --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/shutdown.8 @@ -0,0 +1,124 @@ +'\" t +.TH "SHUTDOWN" "8" "" "systemd 254" "shutdown" +.\" ----------------------------------------------------------------- +.\" * 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" +shutdown \- Halt, power off or reboot the machine +.SH "SYNOPSIS" +.HP \w'\fBshutdown\fR\ 'u +\fBshutdown\fR [OPTIONS...] [TIME] [WALL...] +.SH "DESCRIPTION" +.PP +\fBshutdown\fR +may be used to halt, power off, or reboot the machine\&. +.PP +The first argument may be a time string (which is usually +"now")\&. Optionally, this may be followed by a wall message to be sent to all logged\-in users before going down\&. +.PP +The time string may either be in the format +"hh:mm" +for hour/minutes specifying the time to execute the shutdown at, specified in 24h clock format\&. Alternatively it may be in the syntax +"+m" +referring to the specified number of minutes m from now\&. +"now" +is an alias for +"+0", i\&.e\&. for triggering an immediate shutdown\&. If no time argument is specified, +"+1" +is implied\&. +.PP +Note that to specify a wall message you must specify a time argument, too\&. +.PP +If the time argument is used, 5 minutes before the system goes down the +/run/nologin +file is created to ensure that further logins shall not be allowed\&. +.SH "OPTIONS" +.PP +The following options are understood: +.PP +\fB\-\-help\fR +.RS 4 +Print a short help text and exit\&. +.RE +.PP +\fB\-H\fR, \fB\-\-halt\fR +.RS 4 +Halt the machine\&. +.RE +.PP +\fB\-P\fR, \fB\-\-poweroff\fR +.RS 4 +Power the machine off (the default)\&. +.RE +.PP +\fB\-r\fR, \fB\-\-reboot\fR +.RS 4 +Reboot the machine\&. +.RE +.PP +\fB\-h\fR +.RS 4 +The same as +\fB\-\-poweroff\fR, but does not override the action to take if it is "halt"\&. E\&.g\&. +\fBshutdown \-\-reboot \-h\fR +means "poweroff", but +\fBshutdown \-\-halt \-h\fR +means "halt"\&. +.RE +.PP +\fB\-k\fR +.RS 4 +Do not halt, power off, or reboot, but just write the wall message\&. +.RE +.PP +\fB\-\-no\-wall\fR +.RS 4 +Do not send wall message before halt, power off, or reboot\&. +.RE +.PP +\fB\-c\fR +.RS 4 +Cancel a pending shutdown\&. This may be used to cancel the effect of an invocation of +\fBshutdown\fR +with a time argument that is not +"+0" +or +"now"\&. +.RE +.PP +\fB\-\-show\fR +.RS 4 +Show a pending shutdown action and time if there is any\&. +.RE +.SH "EXIT STATUS" +.PP +On success, 0 is returned, a non\-zero failure code otherwise\&. +.SH "COMPATIBILITY" +.PP +The +\fB shutdown\fR +command in previous init systems (including sysvinit) defaulted to single\-user mode instead of powering off the machine\&. To change into single\-user mode, use +\fBsystemctl rescue\fR +instead\&. +.SH "SEE ALSO" +.PP +\fBsystemd\fR(1), +\fBsystemctl\fR(1), +\fBhalt\fR(8), +\fBwall\fR(1) diff --git a/upstream/opensuse-leap-15-6/man8/sln.8 b/upstream/opensuse-leap-15-6/man8/sln.8 new file mode 100644 index 00000000..1e03c64e --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/sln.8 @@ -0,0 +1,44 @@ +.\" Copyright (c) 2013 by Michael Kerrisk <mtk.manpages@gmail.com> +.\" +.\" SPDX-License-Identifier: Linux-man-pages-copyleft +.\" +.TH sln 8 2023-01-07 "Linux man-pages 6.04" +.SH NAME +sln \- create symbolic links +.SH SYNOPSIS +.nf +.BI sln " source dest" +.BI sln " filelist" +.fi +.SH DESCRIPTION +The +.B sln +program creates symbolic links. +Unlike the +.BR ln (1) +program, it is statically linked. +This means that if for some reason the dynamic linker is not working, +.B sln +can be used to make symbolic links to dynamic libraries. +.PP +The command line has two forms. +In the first form, it creates +.I dest +as a new symbolic link to +.IR source . +.PP +In the second form, +.I filelist +is a list of space-separated pathname pairs, +and the effect is as if +.B sln +was executed once for each line of the file, +with the two pathnames as the arguments. +.PP +The +.B sln +program supports no command-line options. +.SH SEE ALSO +.BR ln (1), +.BR ld.so (8), +.BR ldconfig (8) diff --git a/upstream/opensuse-leap-15-6/man8/sm-notify.8 b/upstream/opensuse-leap-15-6/man8/sm-notify.8 new file mode 100644 index 00000000..bb7f6e0a --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/sm-notify.8 @@ -0,0 +1,340 @@ +.\"@(#)sm-notify.8" +.\" +.\" Copyright (C) 2004 Olaf Kirch <okir@suse.de> +.\" +.\" Rewritten by Chuck Lever <chuck.lever@oracle.com>, 2009. +.\" Copyright 2009 Oracle. All rights reserved. +.\" +.TH SM-NOTIFY 8 "1 November 2009 +.SH NAME +sm-notify \- send reboot notifications to NFS peers +.SH SYNOPSIS +.BI "/usr/sbin/sm-notify [-dfn] [-m " minutes "] [-v " name "] [-p " notify-port "] [-P " path "] +.SH DESCRIPTION +File locks are not part of persistent file system state. +Lock state is thus lost when a host reboots. +.PP +Network file systems must also detect when lock state is lost +because a remote host has rebooted. +After an NFS client reboots, an NFS server must release all file locks +held by applications that were running on that client. +After a server reboots, a client must remind the +server of file locks held by applications running on that client. +.PP +For NFS version 2 and version 3, the +.I Network Status Monitor +protocol (or NSM for short) +is used to notify NFS peers of reboots. +On Linux, two separate user-space components constitute the NSM service: +.TP +.B sm-notify +A helper program that notifies NFS peers after the local system reboots +.TP +.B rpc.statd +A daemon that listens for reboot notifications from other hosts, and +manages the list of hosts to be notified when the local system reboots +.PP +The local NFS lock manager alerts its local +.B rpc.statd +of each remote peer that should be monitored. +When the local system reboots, the +.B sm-notify +command notifies the NSM service on monitored peers of the reboot. +When a remote reboots, that peer notifies the local +.BR rpc.statd , +which in turn passes the reboot notification +back to the local NFS lock manager. +.SH NSM OPERATION IN DETAIL +The first file locking interaction between an NFS client and server causes +the NFS lock managers on both peers to contact their local NSM service to +store information about the opposite peer. +On Linux, the local lock manager contacts +.BR rpc.statd . +.PP +.B rpc.statd +records information about each monitored NFS peer on persistent storage. +This information describes how to contact a remote peer +in case the local system reboots, +how to recognize which monitored peer is reporting a reboot, +and how to notify the local lock manager when a monitored peer +indicates it has rebooted. +.PP +An NFS client sends a hostname, known as the client's +.IR caller_name , +in each file lock request. +An NFS server can use this hostname to send asynchronous GRANT +calls to a client, or to notify the client it has rebooted. +.PP +The Linux NFS server can provide the client's +.I caller_name +or the client's network address to +.BR rpc.statd . +For the purposes of the NSM protocol, +this name or address is known as the monitored peer's +.IR mon_name . +In addition, the local lock manager tells +.B rpc.statd +what it thinks its own hostname is. +For the purposes of the NSM protocol, +this hostname is known as +.IR my_name . +.PP +There is no equivalent interaction between an NFS server and a client +to inform the client of the server's +.IR caller_name . +Therefore NFS clients do not actually know what +.I mon_name +an NFS server might use in an SM_NOTIFY request. +The Linux NFS client records the server's hostname used on the mount command +to identify rebooting NFS servers. +.SS Reboot notification +When the local system reboots, the +.B sm-notify +command reads the list of monitored peers from persistent storage and +sends an SM_NOTIFY request to the NSM service on each listed remote peer. +It uses the +.I mon_name +string as the destination. +To identify which host has rebooted, the +.B sm-notify +command normally sends +.I my_name +string recorded when that remote was monitored. +The remote +.B rpc.statd +matches incoming SM_NOTIFY requests using this string, +or the caller's network address, +to one or more peers on its own monitor list. +.PP +If +.B rpc.statd +does not find a peer on its monitor list that matches +an incoming SM_NOTIFY request, +the notification is not forwarded to the local lock manager. +In addition, each peer has its own +.IR "NSM state number" , +a 32-bit integer that is bumped after each reboot by the +.B sm-notify +command. +.B rpc.statd +uses this number to distinguish between actual reboots +and replayed notifications. +.PP +Part of NFS lock recovery is rediscovering +which peers need to be monitored again. +The +.B sm-notify +command clears the monitor list on persistent storage after each reboot. +.SH OPTIONS +.TP +.B -d +Keeps +.B sm-notify +attached to its controlling terminal and running in the foreground +so that notification progress may be monitored directly. +.TP +.B -f +Send notifications even if +.B sm-notify +has already run since the last system reboot. +.TP +.BI -m " retry-time +Specifies the length of time, in minutes, to continue retrying +notifications to unresponsive hosts. +If this option is not specified, +.B sm-notify +attempts to send notifications for 15 minutes. +Specifying a value of 0 causes +.B sm-notify +to continue sending notifications to unresponsive peers +until it is manually killed. +.IP +Notifications are retried if sending fails, +the remote does not respond, +the remote's NSM service is not registered, +or if there is a DNS failure +which prevents the remote's +.I mon_name +from being resolved to an address. +.IP +Hosts are not removed from the notification list until a valid +reply has been received. +However, the SM_NOTIFY procedure has a void result. +There is no way for +.B sm-notify +to tell if the remote recognized the sender and has started +appropriate lock recovery. +.TP +.B -n +Prevents +.B sm-notify +from updating the local system's NSM state number. +.TP +.BI -p " port +Specifies the source port number +.B sm-notify +should use when sending reboot notifications. +If this option is not specified, a randomly chosen ephemeral port is used. +.IP +This option can be used to traverse a firewall between client and server. +.TP +.BI "\-P, " "" \-\-state\-directory\-path " pathname +Specifies the pathname of the parent directory +where NSM state information resides. +If this option is not specified, +.B sm-notify +uses +.I /var/lib/nfs +by default. +.IP +After starting, +.B sm-notify +attempts to set its effective UID and GID to the owner +and group of this directory. +.TP +.BI -v " ipaddr " | " hostname +Specifies the network address from which to send reboot notifications, +and the +.I mon_name +argument to use when sending SM_NOTIFY requests. +If this option is not specified, +.B sm-notify +uses a wildcard address as the transport bind address, +and uses the +.I my_name +recorded when the remote was monitored as the +.I mon_name +argument when sending SM_NOTIFY requests. +.IP +The +.I ipaddr +form can be expressed as either an IPv4 or an IPv6 presentation address. +If the +.I ipaddr +form is used, the +.B sm-notify +command converts this address to a hostname for use as the +.I mon_name +argument when sending SM_NOTIFY requests. +.IP +This option can be useful in multi-homed configurations where +the remote requires notification from a specific network address. +.SH CONFIGURATION FILE +Many of the options that can be set on the command line can also be +controlled through values set in the +.B [sm-notify] +or, in one case, the +.B [statd] +section of the +.I /etc/nfs.conf +configuration file. + +Values recognized in the +.B [sm-notify] +section include: +.BR retry-time , +.BR outgoing-port ", and" +.BR outgoing-addr . +These have the same effect as the command line options +.BR m , +.BR p ", and" +.B v +respectively. + +The value recognized in the +.B [statd] +section is +.BR state-directory-path . + +.SH SECURITY +The +.B sm-notify +command must be started as root to acquire privileges needed +to access the state information database. +It drops root privileges +as soon as it starts up to reduce the risk of a privilege escalation attack. +.PP +During normal operation, +the effective user ID it chooses is the owner of the state directory. +This allows it to continue to access files in that directory after it +has dropped its root privileges. +To control which user ID +.B rpc.statd +chooses, simply use +.BR chown (1) +to set the owner of +the state directory. +.SH ADDITIONAL NOTES +Lock recovery after a reboot is critical to maintaining data integrity +and preventing unnecessary application hangs. +.PP +To help +.B rpc.statd +match SM_NOTIFY requests to NLM requests, a number of best practices +should be observed, including: +.IP +The UTS nodename of your systems should match the DNS names that NFS +peers use to contact them +.IP +The UTS nodenames of your systems should always be fully qualified domain names +.IP +The forward and reverse DNS mapping of the UTS nodenames should be +consistent +.IP +The hostname the client uses to mount the server should match the server's +.I mon_name +in SM_NOTIFY requests it sends +.PP +Unmounting an NFS file system does not necessarily stop +either the NFS client or server from monitoring each other. +Both may continue monitoring each other for a time in case subsequent +NFS traffic between the two results in fresh mounts and additional +file locking. +.PP +On Linux, if the +.B lockd +kernel module is unloaded during normal operation, +all remote NFS peers are unmonitored. +This can happen on an NFS client, for example, +if an automounter removes all NFS mount +points due to inactivity. +.SS IPv6 and TI-RPC support +TI-RPC is a pre-requisite for supporting NFS on IPv6. +If TI-RPC support is built into the +.B sm-notify +command ,it will choose an appropriate IPv4 or IPv6 transport +based on the network address returned by DNS for each remote peer. +It should be fully compatible with remote systems +that do not support TI-RPC or IPv6. +.PP +Currently, the +.B sm-notify +command supports sending notification only via datagram transport protocols. +.SH FILES +.TP 2.5i +.I /var/lib/nfs/sm +directory containing monitor list +.TP 2.5i +.I /var/lib/nfs/sm.bak +directory containing notify list +.TP 2.5i +.I /var/lib/nfs/state +NSM state number for this host +.TP 2.5i +.I /proc/sys/fs/nfs/nsm_local_state +kernel's copy of the NSM state number +.SH SEE ALSO +.BR rpc.statd (8), +.BR nfs (5), +.BR uname (2), +.BR hostname (7) +.PP +RFC 1094 - "NFS: Network File System Protocol Specification" +.br +RFC 1813 - "NFS Version 3 Protocol Specification" +.br +OpenGroup Protocols for Interworking: XNFS, Version 3W - Chapter 11 +.SH AUTHORS +Olaf Kirch <okir@suse.de> +.br +Chuck Lever <chuck.lever@oracle.com> diff --git a/upstream/opensuse-leap-15-6/man8/smbd.8 b/upstream/opensuse-leap-15-6/man8/smbd.8 new file mode 100644 index 00000000..651afd45 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/smbd.8 @@ -0,0 +1,422 @@ +'\" t +.\" Title: smbd +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 10/23/2023 +.\" Manual: System Administration tools +.\" Source: Samba 4.19.2-git.328.e4c431e307f150600.1.23SUSE-oS15.0-x86_64 +.\" Language: English +.\" +.TH "SMBD" "8" "10/23/2023" "Samba 4\&.19\&.2\-git\&.328\&." "System Administration tools" +.\" ----------------------------------------------------------------- +.\" * 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" +smbd \- server to provide SMB/CIFS services to clients +.SH "SYNOPSIS" +.HP \w'\ 'u +smbd [\-D|\-\-daemon] [\-i|\-\-interactive] [\-F|\-\-foreground] [\-\-no\-process\-group] [\-b|\-\-build\-options] [\-p\ <port\ number(s)>] [\-P\ <profiling\ level>] [\-d\ <debug\ level>] [\-\-debug\-stdout] [\-\-configfile=<configuration\ file>] [\-\-option=<name>=<value>] [\-l|\-\-log\-basename\ <log\ directory>] [\-\-leak\-report] [\-\-leak\-report\-full] [\-V|\-\-version] +.SH "DESCRIPTION" +.PP +This program is part of the +\fBsamba\fR(7) +suite\&. +.PP +smbd +is the server daemon that provides filesharing and printing services to Windows clients\&. The server provides filespace and printer services to clients using the SMB (or CIFS) protocol\&. This is compatible with the LanManager protocol, and can service LanManager clients\&. These include MSCLIENT 3\&.0 for DOS, Windows for Workgroups, Windows 95/98/ME, Windows NT, Windows 2000, OS/2, DAVE for Macintosh, and smbfs for Linux\&. +.PP +An extensive description of the services that the server can provide is given in the man page for the configuration file controlling the attributes of those services (see +\fBsmb.conf\fR(5)\&. This man page will not describe the services, but will concentrate on the administrative aspects of running the server\&. +.PP +Please note that there are significant security implications to running this server, and the +\fBsmb.conf\fR(5) +manual page should be regarded as mandatory reading before proceeding with installation\&. +.PP +A session is created whenever a client requests one\&. Each client gets a copy of the server for each session\&. This copy then services all connections made by the client during that session\&. When all connections from its client are closed, the copy of the server for that client terminates\&. +.PP +The configuration file, and any files that it includes, are automatically reloaded every three minutes, if they change\&. One can force a reload by sending a SIGHUP to the server\&. Reloading the configuration file will not affect connections to any service that is already established\&. Either the user will have to disconnect from the service, or +smbd +killed and restarted\&. +.PP +Instead of sending a SIGHUP signal, a request to reload configuration file may be sent using +\fBsmbcontrol\fR(1) +program\&. +.SH "OPTIONS" +.PP +\-D|\-\-daemon +.RS 4 +If specified, this parameter causes the server to operate as a daemon\&. That is, it detaches itself and runs in the background, fielding requests on the appropriate port\&. Operating the server as a daemon is the recommended way of running +smbd +for servers that provide more than casual use file and print services\&. This switch is assumed if +smbd +is executed on the command line of a shell\&. +.RE +.PP +\-i|\-\-interactive +.RS 4 +If this parameter is specified it causes the server to run "interactively", not as a daemon, even if the server is executed on the command line of a shell\&. Setting this parameter negates the implicit daemon mode when run from the command line\&. +smbd +will only accept one connection and terminate\&. It will also log to standard output, as if the +\-S +parameter had been given\&. +.RE +.PP +\-F|\-\-foreground +.RS 4 +If specified, this parameter causes the main +smbd +process to not daemonize, i\&.e\&. double\-fork and disassociate with the terminal\&. Child processes are still created as normal to service each connection request, but the main process does not exit\&. This operation mode is suitable for running +smbd +under process supervisors such as +supervise +and +svscan +from Daniel J\&. Bernstein\*(Aqs +daemontools +package, or the AIX process monitor\&. +.RE +.PP +\-\-no\-process\-group +.RS 4 +Do not create a new process group for smbd\&. +.RE +.PP +\-b|\-\-build\-options +.RS 4 +Prints information about how Samba was built\&. +.RE +.PP +\-p|\-\-port<port number(s)> +.RS 4 +\fIport number(s)\fR +is a space or comma\-separated list of TCP ports smbd should listen on\&. The default value is taken from the +\m[blue]\fBports\fR\m[] +parameter in +/etc/samba/smb\&.conf +.sp +The default ports are 139 (used for SMB over NetBIOS over TCP) and port 445 (used for plain SMB over TCP)\&. +.RE +.PP +\-P|\-\-profiling\-level<profiling level> +.RS 4 +\fIprofiling level\fR +is a number specifying the level of profiling data to be collected\&. 0 turns off profiling, 1 turns on counter profiling only, 2 turns on complete profiling, and 3 resets all profiling data\&. +.RE +.PP +\-d|\-\-debuglevel=DEBUGLEVEL, \-\-debug\-stdout +.RS 4 +\fIlevel\fR +is an integer from 0 to 10\&. The default value if this parameter is not specified is 0\&. +.sp +The higher this value, the more detail will be logged to the log files about the activities of the server\&. At level 0, only critical errors and serious warnings will be logged\&. Level 1 is a reasonable level for day\-to\-day running \- it generates a small amount of information about operations carried out\&. +.sp +Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem\&. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic\&. +.sp +Note that specifying this parameter here will override the +\m[blue]\fBlog level\fR\m[] +parameter in the +/etc/samba/smb\&.conf +file\&. +This will redirect debug output to STDOUT\&. By default server daemons are logging to a log file\&. +.RE +.PP +\-\-configfile=CONFIGFILE +.RS 4 +The file specified contains the configuration details required by the server\&. The information in this file includes server\-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide\&. See +/etc/samba/smb\&.conf +for more information\&. The default configuration file name is determined at compile time\&. +.RE +.PP +\-\-option=<name>=<value> +.RS 4 +Set the +\fBsmb.conf\fR(5) +option "<name>" to value "<value>" from the command line\&. This overrides compiled\-in defaults and options read from the configuration file\&. If a name or a value includes a space, wrap whole \-\-option=name=value into quotes\&. +.RE +.PP +\-l|\-\-log\-basename=logdirectory +.RS 4 +Base directory name for log/debug files\&. The extension +\fB"\&.progname"\fR +will be appended (e\&.g\&. log\&.smbclient, log\&.smbd, etc\&.\&.\&.)\&. The log file is never removed by the client\&. +.RE +.PP +\-\-leak\-report +.RS 4 +Enable talloc leak reporting on exit\&. +.RE +.PP +\-\-leak\-report\-full +.RS 4 +Enable full talloc leak reporting on exit\&. +.RE +.PP +\-V|\-\-version +.RS 4 +Prints the program version number\&. +.RE +.PP +\-?|\-\-help +.RS 4 +Print a summary of command line options\&. +.RE +.PP +\-\-usage +.RS 4 +Display brief usage message\&. +.RE +.SH "FILES" +.PP +/etc/inetd\&.conf +.RS 4 +If the server is to be run by the +inetd +meta\-daemon, this file must contain suitable startup information for the meta\-daemon\&. +.RE +.PP +/etc/rc +.RS 4 +or whatever initialization script your system uses)\&. +.sp +If running the server as a daemon at startup, this file will need to contain an appropriate startup sequence for the server\&. +.RE +.PP +/etc/services +.RS 4 +If running the server via the meta\-daemon +inetd, this file must contain a mapping of service name (e\&.g\&., netbios\-ssn) to service port (e\&.g\&., 139) and protocol type (e\&.g\&., tcp)\&. +.RE +.PP +/usr/local/samba/lib/smb\&.conf +.RS 4 +This is the default location of the +\fBsmb.conf\fR(5) +server configuration file\&. Other common places that systems install this file are +/usr/samba/lib/smb\&.conf +and +/etc/samba/smb\&.conf\&. +.sp +This file describes all the services the server is to make available to clients\&. See +\fBsmb.conf\fR(5) +for more information\&. +.RE +.SH "LIMITATIONS" +.PP +On some systems +smbd +cannot change uid back to root after a setuid() call\&. Such systems are called trapdoor uid systems\&. If you have such a system, you will be unable to connect from a client (such as a PC) as two different users at once\&. Attempts to connect the second user will result in access denied or similar\&. +.SH "ENVIRONMENT VARIABLES" +.PP +\fBPRINTER\fR +.RS 4 +If no printer name is specified to printable services, most systems will use the value of this variable (or +\fBlp\fR +if this variable is not defined) as the name of the printer to use\&. This is not specific to the server, however\&. +.RE +.SH "PAM INTERACTION" +.PP +Samba uses PAM for authentication (when presented with a plaintext password), for account checking (is this account disabled?) and for session management\&. The degree too which samba supports PAM is restricted by the limitations of the SMB protocol and the +\m[blue]\fBobey pam restrictions\fR\m[] +\fBsmb.conf\fR(5) +parameter\&. When this is set, the following restrictions apply: +.RS +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fIAccount Validation\fR: All accesses to a samba server are checked against PAM to see if the account is valid, not disabled and is permitted to login at this time\&. This also applies to encrypted logins\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fISession Management\fR: When not using share level security, users must pass PAM\*(Aqs session checks before access is granted\&. Note however, that this is bypassed in share level security\&. Note also that some older pam configuration files may need a line added for session support\&. +.RE +.SH "VERSION" +.PP +This man page is part of version 4\&.19\&.2\-git\&.328\&.e4c431e307f150600\&.1\&.23SUSE\-oS15\&.0\-x86_64 of the Samba suite\&. +.SH "DIAGNOSTICS" +.PP +Most diagnostics issued by the server are logged in a specified log file\&. The log file name is specified at compile time, but may be overridden on the command line\&. +.PP +The number and nature of diagnostics available depends on the debug level used by the server\&. If you have problems, set the debug level to 3 and peruse the log files\&. +.PP +Most messages are reasonably self\-explanatory\&. Unfortunately, at the time this man page was created, there are too many diagnostics available in the source code to warrant describing each and every diagnostic\&. At this stage your best bet is still to grep the source code and inspect the conditions that gave rise to the diagnostics you are seeing\&. +.SH "TDB FILES" +.PP +Samba stores it\*(Aqs data in several TDB (Trivial Database) files, usually located in +/var/lib/samba\&. +.PP +(*) information persistent across restarts (but not necessarily important to backup)\&. +.PP +account_policy\&.tdb* +.RS 4 +NT account policy settings such as pw expiration, etc\&.\&.\&. +.RE +.PP +brlock\&.tdb +.RS 4 +byte range locks +.RE +.PP +browse\&.dat +.RS 4 +browse lists +.RE +.PP +gencache\&.tdb +.RS 4 +generic caching db +.RE +.PP +group_mapping\&.tdb* +.RS 4 +group mapping information +.RE +.PP +locking\&.tdb +.RS 4 +share modes & oplocks +.RE +.PP +login_cache\&.tdb* +.RS 4 +bad pw attempts +.RE +.PP +messages\&.tdb +.RS 4 +Samba messaging system +.RE +.PP +netsamlogon_cache\&.tdb* +.RS 4 +cache of user net_info_3 struct from net_samlogon() request (as a domain member) +.RE +.PP +ntdrivers\&.tdb* +.RS 4 +installed printer drivers +.RE +.PP +ntforms\&.tdb* +.RS 4 +installed printer forms +.RE +.PP +ntprinters\&.tdb* +.RS 4 +installed printer information +.RE +.PP +printing/ +.RS 4 +directory containing tdb per print queue of cached lpq output +.RE +.PP +registry\&.tdb +.RS 4 +Windows registry skeleton (connect via regedit\&.exe) +.RE +.PP +smbXsrv_session_global\&.tdb +.RS 4 +session information (e\&.g\&. support for \*(Aqutmp = yes\*(Aq) +.RE +.PP +smbXsrv_tcon_global\&.tdb +.RS 4 +share connections (used to enforce max connections, etc\&.\&.\&.) +.RE +.PP +smbXsrv_open_global\&.tdb +.RS 4 +open file handles (used durable handles, etc\&.\&.\&.) +.RE +.PP +share_info\&.tdb* +.RS 4 +share acls +.RE +.PP +winbindd_cache\&.tdb +.RS 4 +winbindd\*(Aqs cache of user lists, etc\&.\&.\&. +.RE +.PP +winbindd_idmap\&.tdb* +.RS 4 +winbindd\*(Aqs local idmap db +.RE +.PP +wins\&.dat* +.RS 4 +wins database when \*(Aqwins support = yes\*(Aq +.RE +.SH "SIGNALS" +.PP +Sending the +smbd +a SIGHUP will cause it to reload its +smb\&.conf +configuration file within a short period of time\&. +.PP +To shut down a user\*(Aqs +smbd +process it is recommended that +SIGKILL (\-9) +\fINOT\fR +be used, except as a last resort, as this may leave the shared memory area in an inconsistent state\&. The safe way to terminate an +smbd +is to send it a SIGTERM (\-15) signal and wait for it to die on its own\&. +.PP +The debug log level of +smbd +may be raised or lowered using +\fBsmbcontrol\fR(1) +program (SIGUSR[1|2] signals are no longer used since Samba 2\&.2)\&. This is to allow transient problems to be diagnosed, whilst still running at a normally low log level\&. +.PP +Note that as the signal handlers send a debug write, they are not re\-entrant in +smbd\&. This you should wait until +smbd +is in a state of waiting for an incoming SMB before issuing them\&. It is possible to make the signal handlers safe by un\-blocking the signals before the select call and re\-blocking them after, however this would affect performance\&. +.SH "SEE ALSO" +.PP +\fBhosts_access\fR(5), +\fBinetd\fR(8), +\fBnmbd\fR(8), +\fBsmb.conf\fR(5), +\fBsmbclient\fR(1), +\fBtestparm\fR(1), and the Internet RFC\*(Aqs +rfc1001\&.txt, +rfc1002\&.txt\&. In addition the CIFS (formerly SMB) specification is available as a link from the Web page +https://www\&.samba\&.org/cifs/\&. +.SH "AUTHOR" +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. diff --git a/upstream/opensuse-leap-15-6/man8/smrsh.8 b/upstream/opensuse-leap-15-6/man8/smrsh.8 new file mode 100644 index 00000000..a30627be --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/smrsh.8 @@ -0,0 +1,95 @@ +.\" Copyright (c) 1998-2004 Proofpoint, Inc. and its suppliers. +.\" All rights reserved. +.\" Copyright (c) 1993 Eric P. Allman. All rights reserved. +.\" Copyright (c) 1993 +.\" The Regents of the University of California. All rights reserved. +.\" +.\" By using this file, you agree to the terms and conditions set +.\" forth in the LICENSE file which can be found at the top level of +.\" the sendmail distribution. +.\" +.\" +.\" $Id: smrsh.8,v 8.23 2013-11-22 20:52:00 ca Exp $ +.\" +.TH SMRSH 8 "$Date: 2013-11-22 20:52:00 $" +.SH NAME +smrsh \- restricted shell for sendmail +.SH SYNOPSIS +.B smrsh +.B \-c +command +.SH DESCRIPTION +The +.I smrsh +program is intended as a replacement for +.I sh +for use in the ``prog'' mailer in +.IR sendmail (8) +configuration files. +It sharply limits the commands that can be run using the +``|program'' syntax of +.I sendmail +in order to improve the over all security of your system. +Briefly, even if a ``bad guy'' can get sendmail to run a program +without going through an alias or forward file, +.I smrsh +limits the set of programs that he or she can execute. +.PP +Briefly, +.I smrsh +limits programs to be in a single directory, +by default +/usr/lib/sendmail.d/bin/ +allowing the system administrator to choose the set of acceptable commands, +and to the shell builtin commands ``exec'', ``exit'', and ``echo''. +It also rejects any commands with the characters +`\`', `<', `>', `;', `$', `(', `)', `\er' (carriage return), +or `\en' (newline) +on the command line to prevent ``end run'' attacks. +It allows ``||'' and ``&&'' to enable commands like: +``"|exec /usr/local/bin/filter || exit 75"'' +.PP +Initial pathnames on programs are stripped, +so forwarding to ``/usr/bin/vacation'', +``/usr/bin/vacation'', +``/home/server/mydir/bin/vacation'', +and +``vacation'' +all actually forward to +`/usr/lib/sendmail.d/bin/vacation''. +.PP +System administrators should be conservative about populating +the +/usr/lib/sendmail.d/bin/ +directory. +For example, a reasonable additions is +.IR vacation (1), +and the like. +No matter how brow-beaten you may be, +never include any shell or shell-like program +(such as +.IR perl (1)) +in the +/usr/lib/sendmail.d/bin/ +directory. +Note that this does not restrict the use of shell or perl scripts +in the /usr/lib/sendmail.d/bin/ directory (using the ``#!'' syntax); +it simply disallows execution of arbitrary programs. +Also, including mail filtering programs such as +.IR procmail (1) +is a very bad idea. +.IR procmail (1) +allows users to run arbitrary programs in their +.IR procmailrc (5). +.SH COMPILATION +Compilation should be trivial on most systems. +You may need to use \-DSMRSH_PATH=\e"\fIpath\fP\e" +to adjust the default search path +(defaults to ``/bin:/usr/bin'') +and/or \-DSMRSH_CMDDIR=\e"\fIdir\fP\e" +to change the default program directory +(defaults to ``/usr/lib/sendmail.d/bin/''). +.SH FILES +/usr/lib/sendmail.d/bin/ \- default directory for restricted programs on SuSE Linux +.SH SEE ALSO +sendmail(8) diff --git a/upstream/opensuse-leap-15-6/man8/statd.8 b/upstream/opensuse-leap-15-6/man8/statd.8 new file mode 100644 index 00000000..023f9965 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/statd.8 @@ -0,0 +1,468 @@ +.\"@(#)rpc.statd.8" +.\" +.\" Copyright (C) 1999 Olaf Kirch <okir@monad.swb.de> +.\" Modified by Jeffrey A. Uphoff, 1999, 2002, 2005. +.\" Modified by Lon Hohberger, 2000. +.\" Modified by Paul Clements, 2004. +.\" +.\" Rewritten by Chuck Lever <chuck.lever@oracle.com>, 2009. +.\" Copyright 2009 Oracle. All rights reserved. +.\" +.TH RPC.STATD 8 "1 November 2009" +.SH NAME +rpc.statd \- NSM service daemon +.SH SYNOPSIS +.BI "rpc.statd [-dh?FLNvV] [-H " prog "] [-n " my-name "] [-o " outgoing-port ] +.ti +10 +.BI "[-p " listener-port "] [-P " path ] +.ti +10 +.BI "[--nlm-port " port "] [--nlm-udp-port " port ] +.SH DESCRIPTION +File locks are not part of persistent file system state. +Lock state is thus lost when a host reboots. +.PP +Network file systems must also detect when lock state is lost +because a remote host has rebooted. +After an NFS client reboots, an NFS server must release all file locks +held by applications that were running on that client. +After a server reboots, a client must remind the +server of file locks held by applications running on that client. +.PP +For NFS version 2 [RFC1094] and NFS version 3 [RFC1813], the +.I Network Status Monitor +protocol (or NSM for short) +is used to notify NFS peers of reboots. +On Linux, two separate user-space components constitute the NSM service: +.TP +.B rpc.statd +A daemon that listens for reboot notifications from other hosts, and +manages the list of hosts to be notified when the local system reboots +.TP +.B sm-notify +A helper program that notifies NFS peers after the local system reboots +.PP +The local NFS lock manager alerts its local +.B rpc.statd +of each remote peer that should be monitored. +When the local system reboots, the +.B sm-notify +command notifies the NSM service on monitored peers of the reboot. +When a remote reboots, that peer notifies the local +.BR rpc.statd , +which in turn passes the reboot notification +back to the local NFS lock manager. +.SH NSM OPERATION IN DETAIL +The first file locking interaction between an NFS client and server causes +the NFS lock managers on both peers to contact their local NSM service to +store information about the opposite peer. +On Linux, the local lock manager contacts +.BR rpc.statd . +.PP +.B rpc.statd +records information about each monitored NFS peer on persistent storage. +This information describes how to contact a remote peer +in case the local system reboots, +how to recognize which monitored peer is reporting a reboot, +and how to notify the local lock manager when a monitored peer +indicates it has rebooted. +.PP +An NFS client sends a hostname, known as the client's +.IR caller_name , +in each file lock request. +An NFS server can use this hostname to send asynchronous GRANT +calls to a client, or to notify the client it has rebooted. +.PP +The Linux NFS server can provide the client's +.I caller_name +or the client's network address to +.BR rpc.statd . +For the purposes of the NSM protocol, +this name or address is known as the monitored peer's +.IR mon_name . +In addition, the local lock manager tells +.B rpc.statd +what it thinks its own hostname is. +For the purposes of the NSM protocol, +this hostname is known as +.IR my_name . +.PP +There is no equivalent interaction between an NFS server and a client +to inform the client of the server's +.IR caller_name . +Therefore NFS clients do not actually know what +.I mon_name +an NFS server might use in an SM_NOTIFY request. +The Linux NFS client uses the server hostname from the mount command +to identify rebooting NFS servers. +.SS Reboot notification +When the local system reboots, the +.B sm-notify +command reads the list of monitored peers from persistent storage and +sends an SM_NOTIFY request to the NSM service on each listed remote peer. +It uses the +.I mon_name +string as the destination. +To identify which host has rebooted, the +.B sm-notify +command sends the +.I my_name +string recorded when that remote was monitored. +The remote +.B rpc.statd +matches incoming SM_NOTIFY requests using this string, +or the caller's network address, +to one or more peers on its own monitor list. +.PP +If +.B rpc.statd +does not find a peer on its monitor list that matches +an incoming SM_NOTIFY request, +the notification is not forwarded to the local lock manager. +In addition, each peer has its own +.IR "NSM state number" , +a 32-bit integer that is bumped after each reboot by the +.B sm-notify +command. +.B rpc.statd +uses this number to distinguish between actual reboots +and replayed notifications. +.PP +Part of NFS lock recovery is rediscovering +which peers need to be monitored again. +The +.B sm-notify +command clears the monitor list on persistent storage after each reboot. +.SH OPTIONS +.TP +.BR -d , " --no-syslog +Causes +.B rpc.statd +to write log messages on +.I stderr +instead of to the system log, +if the +.B -F +option was also specified. +.TP +.BR -F , " --foreground +Keeps +.B rpc.statd +attached to its controlling terminal so that NSM +operation can be monitored directly or run under a debugger. +If this option is not specified, +.B rpc.statd +backgrounds itself soon after it starts. +.TP +.BR -h , " -?" , " --help +Causes +.B rpc.statd +to display usage information on +.I stderr +and then exit. +.TP +.BI "\-H," "" " \-\-ha-callout " prog +Specifies a high availability callout program. +If this option is not specified, no callouts are performed. +See the +.B High-availability callouts +section below for details. +.TP +.BR -L , " --no-notify +Prevents +.B rpc.statd +from running the +.B sm-notify +command when it starts up, +preserving the existing NSM state number and monitor list. +.IP +Note: the +.B sm-notify +command contains a check to ensure it runs only once after each system reboot. +This prevents spurious reboot notification if +.B rpc.statd +restarts without the +.B -L +option. +.TP +.BI "\-n, " "" "\-\-name " ipaddr " | " hostname +Specifies the bind address used for RPC listener sockets. +The +.I ipaddr +form can be expressed as either an IPv4 or an IPv6 presentation address. +If this option is not specified, +.B rpc.statd +uses a wildcard address as the transport bind address. +.IP +This string is also passed to the +.B sm-notify +command to be used as the source address from which +to send reboot notification requests. +See +.BR sm-notify (8) +for details. +.TP +.BR -N +Causes +.B rpc.statd +to run the +.B sm-notify +command, and then exit. +Since the +.B sm-notify +command can also be run directly, this option is deprecated. +.TP +.BI "\-o," "" " \-\-outgoing\-port " port +Specifies the source port number the +.B sm-notify +command should use when sending reboot notifications. +See +.BR sm-notify (8) +for details. +.TP +.BI "\-p," "" " \-\-port " port +Specifies the port number used for RPC listener sockets. +If this option is not specified, +.B rpc.statd +will try to consult +.IR /etc/services , +if gets port succeed, set the same port for all listener socket, +otherwise chooses a random ephemeral port for each listener socket. +.IP +This option can be used to fix the port value of its listeners when +SM_NOTIFY requests must traverse a firewall between clients and +servers. +.TP +.BI "\-T," "" " \-\-nlm\-port " port +Specifies the port number that +.I lockd +should listen on for +.B NLM +requests. This sets both the TCP and UDP ports unless the UDP port is +set separately. +.TP +.BI "\-U," "" " \-\-nlm\-udp\-port " port +Specifies the UDP port number that +.I lockd +should listen on for +.B NLM +requests. +.TP +.BI "\-P, " "" \-\-state\-directory\-path " pathname" +Specifies the pathname of the parent directory +where NSM state information resides. +If this option is not specified, +.B rpc.statd +uses +.I /var/lib/nfs +by default. +.IP +After starting, +.B rpc.statd +attempts to set its effective UID and GID to the owner +and group of this directory. +.TP +.BR -v ", " -V ", " --version +Causes +.B rpc.statd +to display version information on +.I stderr +and then exit. +.SH CONFIGURATION FILE +Many of the options that can be set on the command line can also be +controlled through values set in the +.B [statd] +or, in some cases, the +.B [lockd] +sections of the +.I /etc/nfs.conf +configuration file. +Values recognized in the +.B [statd] +section include +.BR port , +.BR outgoing-port , +.BR name , +.BR state-directory-path ", and" +.B ha-callout +which each have the same effect as the option with the same name. + +The values recognized in the +.B [lockd] +section include +.B port +and +.B udp-port +which have the same effect as the +.B --nlm-port +and +.B --nlm-udp-port +options, respectively. + +.SH SECURITY +The +.B rpc.statd +daemon must be started as root to acquire privileges needed +to create sockets with privileged source ports, and to access the +state information database. +Because +.B rpc.statd +maintains a long-running network service, however, it drops root privileges +as soon as it starts up to reduce the risk of a privilege escalation attack. +.PP +During normal operation, +the effective user ID it chooses is the owner of the state directory. +This allows it to continue to access files in that directory after it +has dropped its root privileges. +To control which user ID +.B rpc.statd +chooses, simply use +.BR chown (1) +to set the owner of +the state directory. +.PP +You can also protect your +.B rpc.statd +listeners using the +.B tcp_wrapper +library or +.BR iptables (8). +To use the +.B tcp_wrapper +library, add the hostnames of peers that should be allowed access to +.IR /etc/hosts.allow . +Use the daemon name +.B statd +even if the +.B rpc.statd +binary has a different filename. +.P +For further information see the +.BR tcpd (8) +and +.BR hosts_access (5) +man pages. +.SH ADDITIONAL NOTES +Lock recovery after a reboot is critical to maintaining data integrity +and preventing unnecessary application hangs. +To help +.B rpc.statd +match SM_NOTIFY requests to NLM requests, a number of best practices +should be observed, including: +.IP +The UTS nodename of your systems should match the DNS names that NFS +peers use to contact them +.IP +The UTS nodenames of your systems should always be fully qualified domain names +.IP +The forward and reverse DNS mapping of the UTS nodenames should be +consistent +.IP +The hostname the client uses to mount the server should match the server's +.I mon_name +in SM_NOTIFY requests it sends +.PP +Unmounting an NFS file system does not necessarily stop +either the NFS client or server from monitoring each other. +Both may continue monitoring each other for a time in case subsequent +NFS traffic between the two results in fresh mounts and additional +file locking. +.PP +On Linux, if the +.B lockd +kernel module is unloaded during normal operation, +all remote NFS peers are unmonitored. +This can happen on an NFS client, for example, +if an automounter removes all NFS mount +points due to inactivity. +.SS High-availability callouts +.B rpc.statd +can exec a special callout program during processing of +successful SM_MON, SM_UNMON, and SM_UNMON_ALL requests, +or when it receives SM_NOTIFY. +Such a program may be used in High Availability NFS (HA-NFS) +environments to track lock state that may need to be migrated after +a system reboot. +.PP +The name of the callout program is specified with the +.B -H +option. +The program is run with 3 arguments: +The first is either +.B add-client +.B del-client +or +.B sm-notify +depending on the reason for the callout. +The second is the +.I mon_name +of the monitored peer. +The third is the +.I caller_name +of the requesting lock manager for +.B add-client +or +.B del-client +, otherwise it is +.I IP_address +of the caller sending SM_NOTIFY. +The forth is the +.I state_value +in the SM_NOTIFY request. + +.SS IPv6 and TI-RPC support +TI-RPC is a pre-requisite for supporting NFS on IPv6. +If TI-RPC support is built into +.BR rpc.statd , +it attempts to start listeners on network transports marked 'visible' in +.IR /etc/netconfig . +As long as at least one network transport listener starts successfully, +.B rpc.statd +will operate. +.SH ENVIRONMENT +.TP +.B RPC_STATD_NO_NOTIFY= +If set to a positive integer, has the same effect as +.IR \-\-no\-notify . +.SH FILES +.TP 2.5i +.I /var/lib/nfs/sm +directory containing monitor list +.TP 2.5i +.I /var/lib/nfs/sm.bak +directory containing notify list +.TP 2.5i +.I /var/lib/nfs/state +NSM state number for this host +.TP 2.5i +.I /run/run.statd.pid +pid file +.TP 2.5i +.I /etc/netconfig +network transport capability database +.SH SEE ALSO +.BR sm-notify (8), +.BR nfs (5), +.BR rpc.nfsd (8), +.BR rpcbind (8), +.BR tcpd (8), +.BR hosts_access (5), +.BR iptables (8), +.BR netconfig (5) +.sp +RFC 1094 - "NFS: Network File System Protocol Specification" +.br +RFC 1813 - "NFS Version 3 Protocol Specification" +.br +OpenGroup Protocols for Interworking: XNFS, Version 3W - Chapter 11 +.SH AUTHORS +Jeff Uphoff <juphoff@users.sourceforge.net> +.br +Olaf Kirch <okir@monad.swb.de> +.br +H.J. Lu <hjl@gnu.org> +.br +Lon Hohberger <hohberger@missioncriticallinux.com> +.br +Paul Clements <paul.clements@steeleye.com> +.br +Chuck Lever <chuck.lever@oracle.com> diff --git a/upstream/opensuse-leap-15-6/man8/sulogin.8 b/upstream/opensuse-leap-15-6/man8/sulogin.8 new file mode 100644 index 00000000..50ca068d --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/sulogin.8 @@ -0,0 +1,89 @@ +'\" t +.\" Title: sulogin +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "SULOGIN" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +sulogin \- single\-user login +.SH "SYNOPSIS" +.sp +\fBsulogin\fP [options] [\fItty\fP] +.SH "DESCRIPTION" +.sp +\fBsulogin\fP is invoked by \fBinit\fP when the system goes into single\-user mode. +.sp +The user is prompted: +.sp +Give root password for system maintenance (or type Control\-D for normal startup): +.sp +If the root account is locked and \fB\-\-force\fP is specified, no password is required. +.sp +\fBsulogin\fP will be connected to the current terminal, or to the optional \fItty\fP device that can be specified on the command line (typically \fI/dev/console\fP). +.sp +When the user exits from the single\-user shell, or presses control\-D at the prompt, the system will continue to boot. +.SH "OPTIONS" +.sp +\fB\-e\fP, \fB\-\-force\fP +.RS 4 +If the default method of obtaining the root password from the system via \fBgetpwnam\fP(3) fails, then examine \fI/etc/passwd\fP and \fI/etc/shadow\fP to get the password. If these files are damaged or nonexistent, or when root account is locked by \(aq!\(aq or \(aq*\(aq at the begin of the password then \fBsulogin\fP will \fBstart a root shell without asking for a password\fP. +.sp +Only use the \fB\-e\fP option if you are sure the console is physically protected against unauthorized access. +.RE +.sp +\fB\-p\fP, \fB\-\-login\-shell\fP +.RS 4 +Specifying this option causes \fBsulogin\fP to start the shell process as a login shell. +.RE +.sp +\fB\-t\fP, \fB\-\-timeout\fP \fIseconds\fP +.RS 4 +Specify the maximum amount of time to wait for user input. By default, \fBsulogin\fP will wait forever. +.RE +.sp +\fB\-h\fP, \fB\-\-help\fP +.RS 4 +Display help text and exit. +.RE +.sp +\fB\-V\fP, \fB\-\-version\fP +.RS 4 +Display version information and exit. +.RE +.SH "ENVIRONMENT" +.sp +\fBsulogin\fP looks for the environment variable \fBSUSHELL\fP or \fBsushell\fP to determine what shell to start. If the environment variable is not set, it will try to execute root\(cqs shell from \fI/etc/passwd\fP. If that fails, it will fall back to \fI/bin/sh\fP. +.SH "AUTHORS" +.sp +\fBsulogin\fP was written by Miquel van Smoorenburg for sysvinit and later ported to util\-linux by Dave Reisner and Karel Zak. +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBsulogin\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/svcgssd.8 b/upstream/opensuse-leap-15-6/man8/svcgssd.8 new file mode 100644 index 00000000..15ef4c94 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/svcgssd.8 @@ -0,0 +1,75 @@ +.\" +.\" rpc.svcgssd(8) +.\" +.\" Copyright (C) 2003 J. Bruce Fields <bfields@umich.edu> +.TH rpc.svcgssd 8 "12 Jan 2007" +.SH NAME +rpc.svcgssd \- server-side rpcsec_gss daemon +.SH SYNOPSIS +.B "rpc.svcgssd [-n] [-v] [-r] [-i] [-f] [-p principal]" +.SH DESCRIPTION +The rpcsec_gss protocol gives a means of using the gss-api generic security +api to provide security for protocols using rpc (in particular, nfs). Before +exchanging any rpc requests using rpcsec_gss, the rpc client must first +establish a security context with the rpc server. The linux kernel's +implementation of rpcsec_gss depends on the userspace daemon +.B rpc.svcgssd +to handle context establishment on the rpc server. The +daemon uses files in the proc filesystem to communicate with +the kernel. + +.SH OPTIONS +.TP +.B -f +Runs +.B rpc.svcgssd +in the foreground and sends output to stderr (as opposed to syslogd) +.TP +.B -v +Increases the verbosity of the output (can be specified multiple times). +.TP +.B -r +If the rpcsec_gss library supports setting debug level, +increases the verbosity of the output (can be specified multiple times). +.TP +.B -i +If the nfsidmap library supports setting debug level, +increases the verbosity of the output (can be specified multiple times). +.TP +.B -p +Use \fIprincipal\fR instead of the default +.RI nfs/ FQDN @ REALM . +.TP +.B -n +Use the system default credentials +.RI (host/ FQDN @ REALM ) +rather than the default +.RI nfs/ FQDN @ REALM . +.SH CONFIGURATION FILE +Some of the options that can be set on the command line can also be +controlled through values set in the +.B [svcgssd] +section of the +.I /etc/nfs.conf +configuration file. Values recognized include: +.TP +.B principal +If set to +.B system +this is equivalent to the +.B -n +option. If set to any other value, that is used like the +.B -p +option. + +.SH SEE ALSO +.BR rpc.gssd(8), +.SH AUTHORS +.br +Dug Song <dugsong@umich.edu> +.br +Andy Adamson <andros@umich.edu> +.br +Marius Aamodt Eriksen <marius@umich.edu> +.br +J. Bruce Fields <bfields@umich.edu> diff --git a/upstream/opensuse-leap-15-6/man8/swaplabel.8 b/upstream/opensuse-leap-15-6/man8/swaplabel.8 new file mode 100644 index 00000000..15255f39 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/swaplabel.8 @@ -0,0 +1,82 @@ +'\" t +.\" Title: swaplabel +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "SWAPLABEL" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +swaplabel \- print or change the label or UUID of a swap area +.SH "SYNOPSIS" +.sp +\fBswaplabel\fP [\fB\-L\fP \fIlabel\fP] [\fB\-U\fP \fIUUID\fP] \fIdevice\fP +.SH "DESCRIPTION" +.sp +\fBswaplabel\fP will display or change the label or UUID of a swap partition located on \fIdevice\fP (or regular file). +.sp +If the optional arguments \fB\-L\fP and \fB\-U\fP are not given, \fBswaplabel\fP will simply display the current swap\-area label and UUID of \fIdevice\fP. +.sp +If an optional argument is present, then \fBswaplabel\fP will change the appropriate value on \fIdevice\fP. These values can also be set during swap creation using \fBmkswap\fP(8). The \fBswaplabel\fP utility allows changing the label or UUID on an actively used swap device. +.SH "OPTIONS" +.sp +\fB\-h\fP, \fB\-\-help\fP +.RS 4 +Display help text and exit. +.RE +.sp +\fB\-L\fP, \fB\-\-label\fP \fIlabel\fP +.RS 4 +Specify a new \fIlabel\fP for the device. Swap partition labels can be at most 16 characters long. If \fIlabel\fP is longer than 16 characters, \fBswaplabel\fP will truncate it and print a warning message. +.RE +.sp +\fB\-U\fP, \fB\-\-uuid\fP \fIUUID\fP +.RS 4 +Specify a new \fIUUID\fP for the device. The \fIUUID\fP must be in the standard 8\-4\-4\-4\-12 character format, such as is output by \fBuuidgen\fP(1). +.RE +.SH "ENVIRONMENT" +.sp +LIBBLKID_DEBUG=all +.RS 4 +enables libblkid debug output. +.RE +.SH "AUTHORS" +.sp +\fBswaplabel\fP was written by \c +.MTO "jborden\(atbluehost.com" "Jason Borden" "" +and +.MTO "kzak\(atredhat.com" "Karel Zak" "." +.SH "SEE ALSO" +.sp +\fBuuidgen\fP(1), +\fBmkswap\fP(8), +\fBswapon\fP(8) +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBswaplabel\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/swapon.8 b/upstream/opensuse-leap-15-6/man8/swapon.8 new file mode 100644 index 00000000..d39fe5c0 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/swapon.8 @@ -0,0 +1,252 @@ +'\" t +.\" Title: swapon +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "SWAPON" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +swapon, swapoff \- enable/disable devices and files for paging and swapping +.SH "SYNOPSIS" +.sp +\fBswapon\fP [options] [\fIspecialfile\fP...] +.sp +\fBswapoff\fP [\fB\-va\fP] [\fIspecialfile\fP...] +.SH "DESCRIPTION" +.sp +\fBswapon\fP is used to specify devices on which paging and swapping are to take place. +.sp +The device or file used is given by the \fIspecialfile\fP parameter. It may be of the form \fB\-L\fP \fIlabel\fP or \fB\-U\fP \fIuuid\fP to indicate a device by label or uuid. +.sp +Calls to \fBswapon\fP normally occur in the system boot scripts making all swap devices available, so that the paging and swapping activity is interleaved across several devices and files. +.sp +\fBswapoff\fP disables swapping on the specified devices and files. When the \fB\-a\fP flag is given, swapping is disabled on all known swap devices and files (as found in \fI/proc/swaps\fP or \fI/etc/fstab\fP). +.SH "OPTIONS" +.sp +\fB\-a\fP, \fB\-\-all\fP +.RS 4 +All devices marked as "swap" in \fI/etc/fstab\fP are made available, except for those with the "noauto" option. Devices that are already being used as swap are silently skipped. +.RE +.sp +\fB\-d\fP, \fB\-\-discard\fP[\fB=\fP\fIpolicy\fP] +.RS 4 +Enable swap discards, if the swap backing device supports the discard or trim operation. This may improve performance on some Solid State Devices, but often it does not. The option allows one to select between two available swap discard policies: +.sp +\fB\-\-discard=once\fP +.RS 4 +to perform a single\-time discard operation for the whole swap area at swapon; or +.RE +.sp +\fB\-\-discard=pages\fP +.RS 4 +to asynchronously discard freed swap pages before they are available for reuse. +.RE +.sp +If no policy is selected, the default behavior is to enable both discard types. The \fI/etc/fstab\fP mount options \fBdiscard\fP, \fBdiscard=once\fP, or \fBdiscard=pages\fP may also be used to enable discard flags. +.RE +.sp +\fB\-e\fP, \fB\-\-ifexists\fP +.RS 4 +Silently skip devices that do not exist. The \fI/etc/fstab\fP mount option \fBnofail\fP may also be used to skip non\-existing device. +.RE +.sp +\fB\-f\fP, \fB\-\-fixpgsz\fP +.RS 4 +Reinitialize (exec mkswap) the swap space if its page size does not match that of the current running kernel. \fBmkswap\fP(8) initializes the whole device and does not check for bad blocks. +.RE +.sp +\fB\-h\fP, \fB\-\-help\fP +.RS 4 +Display help text and exit. +.RE +.sp +\fB\-L\fP \fIlabel\fP +.RS 4 +Use the partition that has the specified \fIlabel\fP. (For this, access to \fI/proc/partitions\fP is needed.) +.RE +.sp +\fB\-o\fP, \fB\-\-options\fP \fIopts\fP +.RS 4 +Specify swap options by an fstab\-compatible comma\-separated string. For example: +.sp +\fBswapon \-o pri=1,discard=pages,nofail /dev/sda2\fP +.sp +The \fIopts\fP string is evaluated last and overrides all other command line options. +.RE +.sp +\fB\-p\fP, \fB\-\-priority\fP \fIpriority\fP +.RS 4 +Specify the priority of the swap device. \fIpriority\fP is a value between \-1 and 32767. Higher numbers indicate higher priority. See \fBswapon\fP(2) for a full description of swap priorities. Add \fBpri=\fP\fIvalue\fP to the option field of \fI/etc/fstab\fP for use with \fBswapon \-a\fP. When no priority is defined, it defaults to \-1. +.RE +.sp +\fB\-s\fP, \fB\-\-summary\fP +.RS 4 +Display swap usage summary by device. Equivalent to \fBcat /proc/swaps\fP. This output format is DEPRECATED in favour of \fB\-\-show\fP that provides better control on output data. +.RE +.sp +\fB\-\-show\fP[\fB=\fP\fIcolumn\fP...] +.RS 4 +Display a definable table of swap areas. See the \fB\-\-help\fP output for a list of available columns. +.RE +.sp +\fB\-\-output\-all\fP +.RS 4 +Output all available columns. +.RE +.sp +\fB\-\-noheadings\fP +.RS 4 +Do not print headings when displaying \fB\-\-show\fP output. +.RE +.sp +\fB\-\-raw\fP +.RS 4 +Display \fB\-\-show\fP output without aligning table columns. +.RE +.sp +\fB\-\-bytes\fP +.RS 4 +Display swap size in bytes in \fB\-\-show\fP output instead of in user\-friendly units. +.RE +.sp +\fB\-U\fP \fIuuid\fP +.RS 4 +Use the partition that has the specified \fIuuid\fP. +.RE +.sp +\fB\-v\fP, \fB\-\-verbose\fP +.RS 4 +Be verbose. +.RE +.sp +\fB\-V\fP, \fB\-\-version\fP +.RS 4 +Display version information and exit. +.RE +.SH "EXIT STATUS" +.sp +\fBswapoff\fP has the following exit status values since v2.36: +.sp +\fB0\fP +.RS 4 +success +.RE +.sp +\fB2\fP +.RS 4 +system has insufficient memory to stop swapping (OOM) +.RE +.sp +\fB4\fP +.RS 4 +swapoff syscall failed for another reason +.RE +.sp +\fB8\fP +.RS 4 +non\-swapoff syscall system error (out of memory, ...) +.RE +.sp +\fB16\fP +.RS 4 +usage or syntax error +.RE +.sp +\fB32\fP +.RS 4 +all swapoff failed on \fB\-\-all\fP +.RE +.sp +\fB64\fP +.RS 4 +some swapoff succeeded on \fB\-\-all\fP +.RE +.sp +The command \fBswapoff \-\-all\fP returns 0 (all succeeded), 32 (all failed), or 64 (some failed, some succeeded). +.sp ++ +The old versions before v2.36 has no documented exit status, 0 means success in all versions. +.SH "ENVIRONMENT" +.sp +LIBMOUNT_DEBUG=all +.RS 4 +enables \fBlibmount\fP debug output. +.RE +.sp +LIBBLKID_DEBUG=all +.RS 4 +enables \fBlibblkid\fP debug output. +.RE +.SH "FILES" +.sp +\fI/dev/sd??\fP +.RS 4 +standard paging devices +.RE +.sp +\fI/etc/fstab\fP +.RS 4 +ascii filesystem description table +.RE +.SH "NOTES" +.SS "Files with holes" +.sp +The swap file implementation in the kernel expects to be able to write to the file directly, without the assistance of the filesystem. This is a problem on files with holes or on copy\-on\-write files on filesystems like Btrfs. +.sp +Commands like \fBcp\fP(1) or \fBtruncate\fP(1) create files with holes. These files will be rejected by \fBswapon\fP. +.sp +Preallocated files created by \fBfallocate\fP(1) may be interpreted as files with holes too depending of the filesystem. Preallocated swap files are supported on XFS since Linux 4.18. +.sp +The most portable solution to create a swap file is to use \fBdd\fP(1) and \fI/dev/zero\fP. +.SS "Btrfs" +.sp +Swap files on Btrfs are supported since Linux 5.0 on files with nocow attribute. See the \fBbtrfs\fP(5) manual page for more details. +.SS "NFS" +.sp +Swap over \fBNFS\fP may not work. +.SS "Suspend" +.sp +\fBswapon\fP automatically detects and rewrites a swap space signature with old software suspend data (e.g., S1SUSPEND, S2SUSPEND, ...). The problem is that if we don\(cqt do it, then we get data corruption the next time an attempt at unsuspending is made. +.SH "HISTORY" +.sp +The \fBswapon\fP command appeared in 4.0BSD. +.SH "SEE ALSO" +.sp +\fBswapoff\fP(2), +\fBswapon\fP(2), +\fBfstab\fP(5), +\fBinit\fP(8), +\fBfallocate\fP(1), +\fBmkswap\fP(8), +\fBmount\fP(8), +\fBrc\fP(8) +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBswapon\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/switch_root.8 b/upstream/opensuse-leap-15-6/man8/switch_root.8 new file mode 100644 index 00000000..0611125e --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/switch_root.8 @@ -0,0 +1,85 @@ +'\" t +.\" Title: switch_root +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "SWITCH_ROOT" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +switch_root \- switch to another filesystem as the root of the mount tree +.SH "SYNOPSIS" +.sp +\fBswitch_root\fP [\fB\-hV\fP] +.sp +\fBswitch_root\fP \fInewroot init\fP [\fIarg\fP...] +.SH "DESCRIPTION" +.sp +\fBswitch_root\fP moves already mounted \fI/proc\fP, \fI/dev\fP, \fI/sys\fP and \fI/run\fP to \fInewroot\fP and makes \fInewroot\fP the new root filesystem and starts \fIinit\fP process. +.sp +\fBWARNING: switch_root removes recursively all files and directories on the current root filesystem.\fP +.SH "OPTIONS" +.sp +\fB\-h, \-\-help\fP +.RS 4 +Display help text and exit. +.RE +.sp +\fB\-V, \-\-version\fP +.RS 4 +Display version information and exit. +.RE +.SH "EXIT STATUS" +.sp +\fBswitch_root\fP returns 0 on success and 1 on failure. +.SH "NOTES" +.sp +\fBswitch_root\fP will fail to function if \fInewroot\fP is not the root of a mount. If you want to switch root into a directory that does not meet this requirement then you can first use a bind\-mounting trick to turn any directory into a mount point: +.sp +.if n .RS 4 +.nf +.fam C +mount \-\-bind $DIR $DIR +.fam +.fi +.if n .RE +.SH "AUTHORS" +.sp +.MTO "pjones\(atredhat.com" "Peter Jones" "," +.MTO "katzj\(atredhat.com" "Jeremy Katz" "," +.MTO "kzak\(atredhat.com" "Karel Zak" "" +.SH "SEE ALSO" +.sp +\fBchroot\fP(2), +\fBinit\fP(8), +\fBmkinitrd\fP(8), +\fBmount\fP(8) +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBswitch_root\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/systemd-ask-password-console.service.8 b/upstream/opensuse-leap-15-6/man8/systemd-ask-password-console.service.8 new file mode 100644 index 00000000..244a3b7f --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/systemd-ask-password-console.service.8 @@ -0,0 +1,62 @@ +'\" t +.TH "SYSTEMD\-ASK\-PASSWORD\-CONSOLE\&.SERVICE" "8" "" "systemd 254" "systemd-ask-password-console.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" +systemd-ask-password-console.service, systemd-ask-password-console.path, systemd-ask-password-wall.service, systemd-ask-password-wall.path \- Query the user for system passwords on the console and via wall +.SH "SYNOPSIS" +.PP +systemd\-ask\-password\-console\&.service +.PP +systemd\-ask\-password\-console\&.path +.PP +systemd\-ask\-password\-wall\&.service +.PP +systemd\-ask\-password\-wall\&.path +.SH "DESCRIPTION" +.PP +systemd\-ask\-password\-console\&.service +is a system service that queries the user for system passwords (such as hard disk encryption keys and SSL certificate passphrases) on the console\&. It is intended to be used during boot to ensure proper handling of passwords necessary for boot\&. +systemd\-ask\-password\-wall\&.service +is a system service that informs all logged in users for system passwords via +\fBwall\fR(1)\&. It is intended to be used after boot to ensure that users are properly notified\&. +.PP +See the +\m[blue]\fBdeveloper documentation\fR\m[]\&\s-2\u[1]\d\s+2 +for more information about the system password logic\&. +.PP +Note that these services invoke +\fBsystemd-tty-ask-password-agent\fR(1) +with either the +\fB\-\-watch \-\-console\fR +or +\fB\-\-watch \-\-wall\fR +command line parameters\&. +.SH "SEE ALSO" +.PP +\fBsystemd\fR(1), +\fBsystemd-tty-ask-password-agent\fR(1), +\fBwall\fR(1) +.SH "NOTES" +.IP " 1." 4 +developer documentation +.RS 4 +\%https://systemd.io/PASSWORD_AGENTS/ +.RE diff --git a/upstream/opensuse-leap-15-6/man8/systemd-binfmt.service.8 b/upstream/opensuse-leap-15-6/man8/systemd-binfmt.service.8 new file mode 100644 index 00000000..e87b5056 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/systemd-binfmt.service.8 @@ -0,0 +1,67 @@ +'\" t +.TH "SYSTEMD\-BINFMT\&.SERVICE" "8" "" "systemd 254" "systemd-binfmt.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" +systemd-binfmt.service, systemd-binfmt \- Configure additional binary formats for executables at boot +.SH "SYNOPSIS" +.PP +systemd\-binfmt\&.service +.PP +/usr/lib/systemd/systemd\-binfmt +.SH "DESCRIPTION" +.PP +systemd\-binfmt\&.service +is an early boot service that registers additional binary formats for executables in the kernel\&. +.PP +See +\fBbinfmt.d\fR(5) +for information about the configuration of this service\&. +.SH "OPTIONS" +.PP +\fB\-\-unregister\fR +.RS 4 +If passed, instead of registering configured binary formats in the kernel, the reverse operation is executed: all currently registered binary formats are unregistered from the kernel\&. +.RE +.PP +\fB\-\-cat\-config\fR +.RS 4 +Copy the contents of config files to standard output\&. Before each file, the filename is printed as a comment\&. +.RE +.PP +\fB\-\-no\-pager\fR +.RS 4 +Do not pipe output into a pager\&. +.RE +.PP +\fB\-h\fR, \fB\-\-help\fR +.RS 4 +Print a short help text and exit\&. +.RE +.PP +\fB\-\-version\fR +.RS 4 +Print a short version string and exit\&. +.RE +.SH "SEE ALSO" +.PP +\fBsystemd\fR(1), +\fBbinfmt.d\fR(5), +\fBwine\fR(8) diff --git a/upstream/opensuse-leap-15-6/man8/systemd-boot-check-no-failures.service.8 b/upstream/opensuse-leap-15-6/man8/systemd-boot-check-no-failures.service.8 new file mode 100644 index 00000000..58946edc --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/systemd-boot-check-no-failures.service.8 @@ -0,0 +1,40 @@ +'\" t +.TH "SYSTEMD\-BOOT\-CHECK\-NO\-FAILURES\&.SERVICE" "8" "" "systemd 254" "systemd-boot-check-no-failures.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" +systemd-boot-check-no-failures.service, systemd-boot-check-no-failures \- verify that the system booted up cleanly +.SH "SYNOPSIS" +.PP +systemd\-boot\-check\-no\-failures\&.service +.PP +/usr/lib/systemd/system\-boot\-check\-no\-failures +.SH "DESCRIPTION" +.PP +systemd\-boot\-check\-no\-failures\&.service +is a system service that checks whether the system booted up successfully\&. This service implements a very minimal test only: whether there are any failed units on the system\&. This service is disabled by default\&. When enabled, it is ordered before +boot\-complete\&.target, thus ensuring the target cannot be reached when the system booted up with failed services\&. +.PP +Note that due the simple nature of this check this service is probably not suitable for deployment in most scenarios\&. It is primarily useful only as example for developing more fine\-grained checks to order before +boot\-complete\&.target\&. +.SH "SEE ALSO" +.PP +\fBsystemd\fR(1), +\fBsystemd.special\fR(7) diff --git a/upstream/opensuse-leap-15-6/man8/systemd-coredump.8 b/upstream/opensuse-leap-15-6/man8/systemd-coredump.8 new file mode 100644 index 00000000..bc90dc39 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/systemd-coredump.8 @@ -0,0 +1,452 @@ +'\" t +.TH "SYSTEMD\-COREDUMP" "8" "" "systemd 254" "systemd-coredump" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +systemd-coredump, systemd-coredump.socket, systemd-coredump@.service \- Acquire, save and process core dumps +.SH "SYNOPSIS" +.PP +/usr/lib/systemd/systemd\-coredump +.PP +/usr/lib/systemd/systemd\-coredump +\fB\-\-backtrace\fR +.PP +systemd\-coredump@\&.service +.PP +systemd\-coredump\&.socket +.SH "DESCRIPTION" +.PP +systemd\-coredump@\&.service +is a system service to process core dumps\&. It will log a summary of the event to +\fBsystemd-journald.service\fR(8), including information about the process identifier, owner, the signal that killed the process, and the stack trace if possible\&. It may also save the core dump for later processing\&. See the "Information about the crashed process" section below\&. +.PP +The behavior of a specific program upon reception of a signal is governed by a few factors which are described in detail in +\fBcore\fR(5)\&. In particular, the core dump will only be processed when the related resource limits are sufficient\&. +.PP +Core dumps can be written to the journal or saved as a file\&. In both cases, they can be retrieved for further processing, for example in +\fBgdb\fR(1)\&. See +\fBcoredumpctl\fR(1), in particular the +\fBlist\fR +and +\fBdebug\fR +verbs\&. +.PP +By default, +\fBsystemd\-coredump\fR +will log the core dump to the journal, including a backtrace if possible, and store the core dump (an image of the memory contents of the process) itself in an external file in +/var/lib/systemd/coredump\&. These core dumps are deleted after a few days by default; see +/usr/lib/tmpfiles\&.d/systemd\&.conf +for details\&. Note that the removal of core files from the file system and the purging of journal entries are independent, and the core file may be present without the journal entry, and journal entries may point to since\-removed core files\&. Some metadata is attached to core files in the form of extended attributes, so the core files are useful for some purposes even without the full metadata available in the journal entry\&. +.PP +For further details see +\m[blue]\fBsystemd Coredump Handling\fR\m[]\&\s-2\u[1]\d\s+2\&. +.SS "Invocation of systemd\-coredump" +.PP +The +\fBsystemd\-coredump\fR +executable does the actual work\&. It is invoked twice: once as the handler by the kernel, and the second time in the +systemd\-coredump@\&.service +to actually write the data to the journal and process and save the core file\&. +.PP +When the kernel invokes +\fBsystemd\-coredump\fR +to handle a core dump, it runs in privileged mode, and will connect to the socket created by the +systemd\-coredump\&.socket +unit, which in turn will spawn an unprivileged +systemd\-coredump@\&.service +instance to process the core dump\&. Hence +systemd\-coredump\&.socket +and +systemd\-coredump@\&.service +are helper units which do the actual processing of core dumps and are subject to normal service management\&. +.PP +It is also possible to invoke +\fBsystemd\-coredump\fR +with +\fB\-\-backtrace\fR +option\&. In this case, +\fBsystemd\-coredump\fR +expects a journal entry in the journal +\m[blue]\fBJournal Export Format\fR\m[]\&\s-2\u[2]\d\s+2 +on standard input\&. The entry should contain a +\fIMESSAGE=\fR +field and any additional metadata fields the caller deems reasonable\&. +\fBsystemd\-coredump\fR +will append additional metadata fields in the same way it does for core dumps received from the kernel\&. In this mode, no core dump is stored in the journal\&. +.SH "CONFIGURATION" +.PP +For programs started by +\fBsystemd\fR, process resource limits can be set by directive +\fILimitCORE=\fR, see +\fBsystemd.exec\fR(5)\&. +.PP +In order to be used by the kernel to handle core dumps, +\fBsystemd\-coredump\fR +must be configured in +\fBsysctl\fR(8) +parameter +\fIkernel\&.core_pattern\fR\&. The syntax of this parameter is explained in +\fBcore\fR(5)\&. systemd installs the file +/usr/lib/sysctl\&.d/50\-coredump\&.conf +which configures +\fIkernel\&.core_pattern\fR +accordingly\&. This file may be masked or overridden to use a different setting following normal +\fBsysctl.d\fR(5) +rules\&. If the sysctl configuration is modified, it must be updated in the kernel before it takes effect, see +\fBsysctl\fR(8) +and +\fBsystemd-sysctl\fR(8)\&. +.PP +In order to be used in the +\fB\-\-backtrace\fR +mode, an appropriate backtrace handler must be installed on the sender side\&. For example, in case of +\fBpython\fR(1), this means a +\fIsys\&.excepthook\fR +must be installed, see +\m[blue]\fBsystemd\-coredump\-python\fR\m[]\&\s-2\u[3]\d\s+2\&. +.PP +The behavior of +\fBsystemd\-coredump\fR +itself is configured through the configuration file +/etc/systemd/coredump\&.conf +and corresponding snippets +/etc/systemd/coredump\&.conf\&.d/*\&.conf, see +\fBcoredump.conf\fR(5)\&. A new instance of +\fBsystemd\-coredump\fR +is invoked upon receiving every core dump\&. Therefore, changes in these files will take effect the next time a core dump is received\&. +.PP +Resources used by core dump files are restricted in two ways\&. Parameters like maximum size of acquired core dumps and files can be set in files +/etc/systemd/coredump\&.conf +and snippets mentioned above\&. In addition the storage time of core dump files is restricted by +\fBsystemd\-tmpfiles\fR, corresponding settings are by default in +/usr/lib/tmpfiles\&.d/systemd\&.conf\&. The default is to delete core dumps after a few days; see the above file for details\&. +.SS "Disabling coredump processing" +.PP +To disable potentially resource\-intensive processing by +\fBsystemd\-coredump\fR, set +.sp +.if n \{\ +.RS 4 +.\} +.nf +Storage=none +ProcessSizeMax=0 +.fi +.if n \{\ +.RE +.\} +.sp +in +\fBcoredump.conf\fR(5)\&. +.SH "INFORMATION ABOUT THE CRASHED PROCESS" +.PP +\fBcoredumpctl\fR(1) +can be used to retrieve saved core dumps independently of their location, to display information, and to process them e\&.g\&. by passing to the GNU debugger (gdb)\&. +.PP +Data stored in the journal can be also viewed with +\fBjournalctl\fR(1) +as usual (or from any other process, using the +\fBsd-journal\fR(3) +API)\&. The relevant messages have +\fBMESSAGE_ID=fc2e22bc6ee647b6b90729ab34a250b1\fR: +.sp +.if n \{\ +.RS 4 +.\} +.nf +$ journalctl MESSAGE_ID=fc2e22bc6ee647b6b90729ab34a250b1 \-o verbose +\&... +MESSAGE_ID=fc2e22bc6ee647b6b90729ab34a250b1 +COREDUMP_PID=552351 +COREDUMP_UID=1000 +COREDUMP_GID=1000 +COREDUMP_SIGNAL_NAME=SIGSEGV +COREDUMP_SIGNAL=11 +COREDUMP_TIMESTAMP=1614342930000000 +COREDUMP_COMM=Web Content +COREDUMP_EXE=/usr/lib64/firefox/firefox +COREDUMP_USER_UNIT=app\-gnome\-firefox\-552136\&.scope +COREDUMP_CMDLINE=/usr/lib64/firefox/firefox \-contentproc \-childID 5 \-isForBrowser \&... +COREDUMP_CGROUP=/user\&.slice/user\-1000\&.slice/user@1000\&.service/app\&.slice/app\-\&...\&.scope +COREDUMP_FILENAME=/var/lib/systemd/coredump/core\&.Web\&...\&.552351\&.\&...\&.zst +\&... + +.fi +.if n \{\ +.RE +.\} +.PP +The following fields are saved (if known) with the journal entry +.PP +\fICOREDUMP_UID=\fR, \fICOREDUMP_PID=\fR, \fICOREDUMP_GID=\fR +.RS 4 +The process number (PID), owner user number (UID), and group number (GID) of the crashed process\&. +.sp +When the crashed process was part of a container (or in a process or user namespace in general), those are the values as seen +\fIoutside\fR, in the namespace where +systemd\-coredump +is running\&. +.RE +.PP +\fICOREDUMP_TIMESTAMP=\fR +.RS 4 +The time of the crash as reported by the kernel (in μs since the epoch)\&. +.RE +.PP +\fICOREDUMP_RLIMIT=\fR +.RS 4 +The core file size soft resource limit, see +\fBgetrlimit\fR(2)\&. +.RE +.PP +\fICOREDUMP_UNIT=\fR, \fICOREDUMP_SLICE=\fR +.RS 4 +The system unit and slice names\&. +.sp +When the crashed process was in container, those are the units names +\fIoutside\fR, in the main system manager\&. +.RE +.PP +\fICOREDUMP_CGROUP=\fR +.RS 4 +Control group information in the format used in +/proc/self/cgroup\&. On systems with the unified cgroup hierarchy, this is a single path prefixed with +"0::", and multiple paths prefixed with controller numbers on legacy systems\&. +.sp +When the crashed process was in a container, this is the full path, as seen outside of the container\&. +.RE +.PP +\fICOREDUMP_OWNER_UID=\fR, \fICOREDUMP_USER_UNIT=\fR +.RS 4 +The numerical UID of the user owning the login session or systemd user unit of the crashed process, and the user manager unit\&. Both fields are only present for user processes\&. +.sp +When the crashed process was in container, those are the values +\fIoutside\fR, in the main system\&. +.RE +.PP +\fICOREDUMP_SIGNAL_NAME=\fR, \fICOREDUMP_SIGNAL=\fR +.RS 4 +The terminating signal name (with the +"SIG" +prefix +\&\s-2\u[4]\d\s+2) and numerical value\&. (Both are included because signal numbers vary by architecture\&.) +.RE +.PP +\fICOREDUMP_CWD=\fR, \fICOREDUMP_ROOT=\fR +.RS 4 +The current working directory and root directory of the crashed process\&. +.sp +When the crashed process is in a container, those paths are relative to the root of the container\*(Aqs mount namespace\&. +.RE +.PP +\fICOREDUMP_OPEN_FDS=\fR +.RS 4 +Information about open file descriptors, in the following format: +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fIfd\fR:\fI/path/to/file\fR +pos: \&.\&.\&. +flags: \&.\&.\&. +\&.\&.\&. + +\fIfd\fR:\fI/path/to/file\fR +pos: \&.\&.\&. +flags: \&.\&.\&. +\&.\&.\&. + +.fi +.if n \{\ +.RE +.\} +.sp +The first line contains the file descriptor number +\fIfd\fR +and the path, while subsequent lines show the contents of +/proc/\fIpid\fR/fdinfo/\fIfd\fR\&. +.RE +.PP +\fICOREDUMP_EXE=\fR +.RS 4 +The destination of the +/proc/\fIpid\fR/exe +symlink\&. +.sp +When the crashed process is in a container, that path is relative to the root of the container\*(Aqs mount namespace\&. +.RE +.PP +\fICOREDUMP_COMM=\fR, \fICOREDUMP_PROC_STATUS=\fR, \fICOREDUMP_PROC_MAPS=\fR, \fICOREDUMP_PROC_LIMITS=\fR, \fICOREDUMP_PROC_MOUNTINFO=\fR, \fICOREDUMP_ENVIRON=\fR +.RS 4 +Fields that map the per\-process entries in the +/proc/ +filesystem: +/proc/\fIpid\fR/comm +(the command name associated with the process), +/proc/\fIpid\fR/exe +(the filename of the executed command), +/proc/\fIpid\fR/status +(various metadata about the process), +/proc/\fIpid\fR/maps +(memory regions visible to the process and their access permissions), +/proc/\fIpid\fR/limits +(the soft and hard resource limits), +/proc/\fIpid\fR/mountinfo +(mount points in the process\*(Aqs mount namespace), +/proc/\fIpid\fR/environ +(the environment block of the crashed process)\&. +.sp +See +\fBproc\fR(5) +for more information\&. +.RE +.PP +\fICOREDUMP_HOSTNAME=\fR +.RS 4 +The system hostname\&. +.sp +When the crashed process was in container, this is the container hostname\&. +.RE +.PP +\fICOREDUMP_CONTAINER_CMDLINE=\fR +.RS 4 +For processes running in a container, the commandline of the process spawning the container (the first parent process with a different mount namespace)\&. +.RE +.PP +\fICOREDUMP=\fR +.RS 4 +When the core is stored in the journal, the core image itself\&. +.RE +.PP +\fICOREDUMP_FILENAME=\fR +.RS 4 +When the core is stored externally, the path to the core file\&. +.RE +.PP +\fICOREDUMP_TRUNCATED=\fR +.RS 4 +Set to +"1" +when the saved coredump was truncated\&. (A partial core image may still be processed by some tools, though obviously not all information is available\&.) +.RE +.PP +\fICOREDUMP_PACKAGE_NAME=\fR, \fICOREDUMP_PACKAGE_VERSION=\fR, \fICOREDUMP_PACKAGE_JSON=\fR +.RS 4 +If the executable contained \&.package metadata ELF notes, they will be parsed and attached\&. The +\fIpackage\fR +and +\fIpackageVersion\fR +of the \*(Aqmain\*(Aq ELF module (ie: the executable) will be appended individually\&. The JSON\-formatted content of all modules will be appended as a single JSON object, each with the module name as the key\&. For more information about this metadata format and content, see +\m[blue]\fBthe coredump metadata spec\fR\m[]\&\s-2\u[5]\d\s+2\&. +.RE +.PP +\fIMESSAGE=\fR +.RS 4 +The message generated by +\fBsystemd\-coredump\fR +that includes the backtrace if it was successfully generated\&. When +\fBsystemd\-coredump\fR +is invoked with +\fB\-\-backtrace\fR, this field is provided by the caller\&. +.RE +.PP +Various other fields exist in the journal entry, but pertain to the logging process, i\&.e\&. +\fBsystemd\-coredump\fR, not the crashed process\&. See +\fBsystemd.journal-fields\fR(7)\&. +.PP +The following fields are saved (if known) with the external file listed in +\fICOREDUMP_FILENAME=\fR +as extended attributes: +.PP +\fIuser\&.coredump\&.pid\fR, \fIuser\&.coredump\&.uid\fR, \fIuser\&.coredump\&.gid\fR, \fIuser\&.coredump\&.signal\fR, \fIuser\&.coredump\&.timestamp\fR, \fIuser\&.coredump\&.rlimit\fR, \fIuser\&.coredump\&.hostname\fR, \fIuser\&.coredump\&.comm\fR, \fIuser\&.coredump\&.exe\fR +.RS 4 +Those are the same as +\fICOREDUMP_PID=\fR, +\fICOREDUMP_UID=\fR, +\fICOREDUMP_GID=\fR, +\fICOREDUMP_SIGNAL=\fR, +\fICOREDUMP_TIMESTAMP=\fR, +\fICOREDUMP_RLIMIT=\fR, +\fICOREDUMP_HOSTNAME=\fR, +\fICOREDUMP_COMM=\fR, and +\fICOREDUMP_EXE=\fR, described above\&. +.RE +.PP +Those can be viewed using +\fBgetfattr\fR(1)\&. For the core file described in the journal entry shown above: +.sp +.if n \{\ +.RS 4 +.\} +.nf +$ getfattr \-\-absolute\-names \-d /var/lib/systemd/coredump/core\&.Web\&...\&.552351\&.\&...\&.zst +# file: /var/lib/systemd/coredump/core\&.Web\&...\&.552351\&.\&...\&.zst +user\&.coredump\&.pid="552351" +user\&.coredump\&.uid="1000" +user\&.coredump\&.gid="1000" +user\&.coredump\&.signal="11" +user\&.coredump\&.timestamp="1614342930000000" +user\&.coredump\&.comm="Web Content" +user\&.coredump\&.exe="/usr/lib64/firefox/firefox" +\&... +.fi +.if n \{\ +.RE +.\} +.sp +.SH "SEE ALSO" +.PP +\fBcoredump.conf\fR(5), +\fBcoredumpctl\fR(1), +\fBsystemd-journald.service\fR(8), +\fBsystemd-tmpfiles\fR(8), +\fBcore\fR(5), +\fBsysctl.d\fR(5), +\fBsystemd-sysctl.service\fR(8), +\m[blue]\fBsystemd Coredump Handling\fR\m[]\&\s-2\u[1]\d\s+2 +.SH "NOTES" +.IP " 1." 4 +systemd Coredump Handling +.RS 4 +\%https://systemd.io/COREDUMP +.RE +.IP " 2." 4 +Journal Export Format +.RS 4 +\%https://systemd.io/JOURNAL_EXPORT_FORMATS#journal-export-format +.RE +.IP " 3." 4 +systemd-coredump-python +.RS 4 +\%https://github.com/systemd/systemd-coredump-python +.RE +.IP " 4." 4 +\fBkill\fR(1) +expects signal names +\fIwithout\fR +the prefix; +\fBkill\fR(2) +uses the prefix; all systemd tools accept signal names both with and without the prefix. +.IP " 5." 4 +the coredump metadata spec +.RS 4 +\%https://systemd.io/COREDUMP_PACKAGE_METADATA/ +.RE diff --git a/upstream/opensuse-leap-15-6/man8/systemd-debug-generator.8 b/upstream/opensuse-leap-15-6/man8/systemd-debug-generator.8 new file mode 100644 index 00000000..f5e8d603 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/systemd-debug-generator.8 @@ -0,0 +1,81 @@ +'\" t +.TH "SYSTEMD\-DEBUG\-GENERATOR" "8" "" "systemd 254" "systemd-debug-generator" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +systemd-debug-generator \- Generator for enabling a runtime debug shell and masking specific units at boot +.SH "SYNOPSIS" +.PP +/usr/lib/systemd/system\-generators/systemd\-debug\-generator +.SH "DESCRIPTION" +.PP +systemd\-debug\-generator +is a generator that reads the kernel command line and understands three options: +.PP +If the +\fBsystemd\&.mask=\fR +or +\fBrd\&.systemd\&.mask=\fR +option is specified and followed by a unit name, this unit is masked for the runtime (i\&.e\&. for this session \(em from boot to shutdown), similarly to the effect of +\fBsystemctl\fR(1)\*(Aqs +\fBmask\fR +command\&. This is useful to boot with certain units removed from the initial boot transaction for debugging system startup\&. May be specified more than once\&. +\fBrd\&.systemd\&.mask=\fR +is honored only by initial RAM disk (initrd) while +\fBsystemd\&.mask=\fR +is honored only in the main system\&. +.PP +If the +\fBsystemd\&.wants=\fR +or +\fBrd\&.systemd\&.wants=\fR +option is specified and followed by a unit name, a start job for this unit is added to the initial transaction\&. This is useful to start one or more additional units at boot\&. May be specified more than once\&. +\fBrd\&.systemd\&.wants=\fR +is honored only by initial RAM disk (initrd) while +\fBsystemd\&.wants=\fR +is honored only in the main system\&. +.PP +If the +\fBsystemd\&.debug_shell\fR +or +\fBrd\&.systemd\&.debug_shell\fR +option is specified, the debug shell service +"debug\-shell\&.service" +is pulled into the boot transaction and a debug shell will be spawned during early boot\&. By default, +/dev/tty9 +is used, but a specific tty can also be set, either with or without the +/dev/ +prefix\&. Note that the shell may also be turned on persistently by enabling it with +\fBsystemctl\fR(1)\*(Aqs +\fBenable\fR +command\&. +\fBrd\&.systemd\&.debug_shell=\fR +is honored only by initial RAM disk (initrd) while +\fBsystemd\&.debug_shell\fR +is honored only in the main system\&. +.PP +systemd\-debug\-generator +implements +\fBsystemd.generator\fR(7)\&. +.SH "SEE ALSO" +.PP +\fBsystemd\fR(1), +\fBsystemctl\fR(1), +\fBkernel-command-line\fR(7) diff --git a/upstream/opensuse-leap-15-6/man8/systemd-environment-d-generator.8 b/upstream/opensuse-leap-15-6/man8/systemd-environment-d-generator.8 new file mode 100644 index 00000000..a5051534 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/systemd-environment-d-generator.8 @@ -0,0 +1,42 @@ +'\" t +.TH "SYSTEMD\-ENVIRONMENT\-D\-GENERATOR" "8" "" "systemd 254" "systemd-environment-d-generator" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +systemd-environment-d-generator, 30-systemd-environment-d-generator \- Load variables specified by environment\&.d +.SH "SYNOPSIS" +.PP +/usr/lib/systemd/user\-environment\-generators/30\-systemd\-environment\-d\-generator +.SH "DESCRIPTION" +.PP +systemd\-environment\-d\-generator +is a +\fBsystemd.environment-generator\fR(7) +that reads environment configuration specified by +\fBenvironment.d\fR(5) +configuration files and passes it to the +\fBsystemd\fR(1) +user manager instance\&. +.SH "SEE ALSO" +.PP +\fBsystemd\fR(1), +\fBsystemctl\fR(1), +\fBsystemd.environment-generator\fR(7), +\fBsystemd.generator\fR(7) diff --git a/upstream/opensuse-leap-15-6/man8/systemd-getty-generator.8 b/upstream/opensuse-leap-15-6/man8/systemd-getty-generator.8 new file mode 100644 index 00000000..f8bd860b --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/systemd-getty-generator.8 @@ -0,0 +1,105 @@ +'\" t +.TH "SYSTEMD\-GETTY\-GENERATOR" "8" "" "systemd 254" "systemd-getty-generator" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +systemd-getty-generator \- Generator for enabling getty instances on the console +.SH "SYNOPSIS" +.PP +/usr/lib/systemd/system\-generators/systemd\-getty\-generator +.SH "DESCRIPTION" +.PP +systemd\-getty\-generator +is a generator that automatically instantiates +serial\-getty@\&.service +on the kernel consoles, if they can function as ttys and are not provided by the virtual console subsystem\&. It will also instantiate +serial\-getty@\&.service +instances for virtualizer consoles, if execution in a virtualized environment is detected\&. If execution in a container environment is detected, it will instead enable +console\-getty\&.service +for +/dev/console, and +container\-getty@\&.service +instances for additional container pseudo TTYs as requested by the container manager (see +\m[blue]\fBContainer Interface\fR\m[]\&\s-2\u[1]\d\s+2)\&. This should ensure that the user is shown a login prompt at the right place, regardless of which environment the system is started in\&. For example, it is sufficient to redirect the kernel console with a kernel command line argument such as +\fIconsole=\fR +to get both kernel messages and a getty prompt on a serial TTY\&. See +\m[blue]\fBThe kernel\*(Aqs command\-line parameters\fR\m[]\&\s-2\u[2]\d\s+2 +for more information on the +\fIconsole=\fR +kernel parameter\&. +.PP +systemd\-getty\-generator +implements +\fBsystemd.generator\fR(7)\&. +.PP +Further information about configuration of gettys can be found in +\m[blue]\fBsystemd for Administrators, Part XVI: Gettys on Serial Consoles (and Elsewhere)\fR\m[]\&\s-2\u[3]\d\s+2\&. +.SH "KERNEL COMMAND LINE" +.PP +systemd\-getty\-generator +understands the following +\fBkernel-command-line\fR(7) +parameters: +.PP +\fIsystemd\&.getty_auto=\fR +.RS 4 +this options take an optional boolean argument, and default to yes\&. The generator is enabled by default, and a false value may be used to disable it\&. +.RE +.SH "ENVIRONMENT" +.PP +\fI$SYSTEMD_GETTY_AUTO\fR +.RS 4 +This variable takes an optional boolean argument, and default to yes\&. The generator is enabled by default, and a false value may be used to disable it\&. +.RE +.SH "SYSTEM CREDENTIALS" +.PP +\fIgetty\&.ttys\&.serial\fR, \fIgetty\&.ttys\&.container\fR +.RS 4 +These system credentials may be used to spawn additional login prompts on selected TTYs\&. The two credentials should contain a newline\-separated list of TTY names to spawn instances of +serial\-getty@\&.service +(in case of +\fIgetty\&.ttys\&.serial\fR) and +container\-getty@\&.service +(in case of +\fIgetty\&.ttys\&.container\fR) on\&. +.RE +.SH "SEE ALSO" +.PP +\fBsystemd\fR(1), +\fBkernel-command-line\fR(7), +\fBsystemd.system-credentials\fR(7), +\fBagetty\fR(8) +.SH "NOTES" +.IP " 1." 4 +Container + Interface +.RS 4 +\%https://systemd.io/CONTAINER_INTERFACE +.RE +.IP " 2." 4 +The kernel's command-line parameters +.RS 4 +\%https://docs.kernel.org/admin-guide/kernel-parameters.html +.RE +.IP " 3." 4 +systemd for Administrators, Part XVI: Gettys on Serial Consoles (and Elsewhere) +.RS 4 +\%https://0pointer.de/blog/projects/serial-console.html +.RE diff --git a/upstream/opensuse-leap-15-6/man8/systemd-hibernate-resume.service.8 b/upstream/opensuse-leap-15-6/man8/systemd-hibernate-resume.service.8 new file mode 100644 index 00000000..68f808d4 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/systemd-hibernate-resume.service.8 @@ -0,0 +1,49 @@ +'\" t +.TH "SYSTEMD\-HIBERNATE\-RESUME\&.SERVICE" "8" "" "systemd 254" "systemd-hibernate-resume.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" +systemd-hibernate-resume.service, systemd-hibernate-resume \- Resume from hibernation +.SH "SYNOPSIS" +.PP +systemd\-hibernate\-resume\&.service +.PP +/usr/lib/systemd/systemd\-hibernate\-resume +.SH "DESCRIPTION" +.PP +systemd\-hibernate\-resume\&.service +initiates the resume from hibernation\&. +.PP +systemd\-hibernate\-resume +only supports the in\-kernel hibernation implementation, see +\m[blue]\fBSwap suspend\fR\m[]\&\s-2\u[1]\d\s+2\&. Internally, it works by writing the major:minor of specified device node to +/sys/power/resume, along with the offset in memory pages (/sys/power/resume_offset) if supported\&. +.PP +Failing to initiate a resume is not an error condition\&. It may mean that there was no resume image (e\&. g\&. if the system has been simply powered off and not hibernated)\&. In such cases, the boot is ordinarily continued\&. +.SH "SEE ALSO" +.PP +\fBsystemd\fR(1), +\fBsystemd-hibernate-resume-generator\fR(8) +.SH "NOTES" +.IP " 1." 4 +Swap suspend +.RS 4 +\%https://docs.kernel.org/power/swsusp.html +.RE diff --git a/upstream/opensuse-leap-15-6/man8/systemd-hostnamed.service.8 b/upstream/opensuse-leap-15-6/man8/systemd-hostnamed.service.8 new file mode 100644 index 00000000..a55d20ef --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/systemd-hostnamed.service.8 @@ -0,0 +1,118 @@ +'\" t +.TH "SYSTEMD\-HOSTNAMED\&.SERVICE" "8" "" "systemd 254" "systemd-hostnamed.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" +systemd-hostnamed.service, systemd-hostnamed \- Daemon to control system hostname from programs +.SH "SYNOPSIS" +.PP +systemd\-hostnamed\&.service +.PP +/usr/lib/systemd/systemd\-hostnamed +.SH "DESCRIPTION" +.PP +systemd\-hostnamed\&.service +is a system service that may be used to change the system\*(Aqs hostname and related machine metadata from user programs\&. It is automatically activated on request and terminates itself when unused\&. +.PP +It currently offers access to five variables: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +The current hostname (Example: +"dhcp\-192\-168\-47\-11") +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +The static (configured) hostname (Example: +"lennarts\-computer") +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +The pretty hostname (Example: +"Lennart\*(Aqs Computer") +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +A suitable icon name for the local host (Example: +"computer\-laptop") +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +A chassis type (Example: +"tablet") +.RE +.PP +The static hostname is stored in +/etc/hostname, see +\fBhostname\fR(5) +for more information\&. The pretty hostname, chassis type, and icon name are stored in +/etc/machine\-info, see +\fBmachine-info\fR(5)\&. +.PP +The tool +\fBhostnamectl\fR(1) +is a command line client to this service\&. +.PP +See +\fBorg.freedesktop.hostname1\fR(5) +and +\fBorg.freedesktop.LogControl1\fR(5) +for a description of the D\-Bus API\&. +.SH "SEE ALSO" +.PP +\fBsystemd\fR(1), +\fBhostname\fR(5), +\fBmachine-info\fR(5), +\fBhostnamectl\fR(1), +\fBsethostname\fR(2) diff --git a/upstream/opensuse-leap-15-6/man8/systemd-importd.service.8 b/upstream/opensuse-leap-15-6/man8/systemd-importd.service.8 new file mode 100644 index 00000000..c1e66985 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/systemd-importd.service.8 @@ -0,0 +1,54 @@ +'\" t +.TH "SYSTEMD\-IMPORTD\&.SERVICE" "8" "" "systemd 254" "systemd-importd.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" +systemd-importd.service, systemd-importd \- VM and container image import and export service +.SH "SYNOPSIS" +.PP +systemd\-importd\&.service +.PP +/usr/lib/systemd/systemd\-importd +.SH "DESCRIPTION" +.PP +\fBsystemd\-importd\fR +is a system service that allows importing, exporting and downloading of system images suitable for running as VM or containers\&. It is a companion service for +\fBsystemd-machined.service\fR(8), and provides the implementation for +\fBmachinectl\fR(1)\*(Aqs +\fBpull\-raw\fR, +\fBpull\-tar\fR, +\fBimport\-raw\fR, +\fBimport\-tar\fR, +\fBimport\-fs\fR, +\fBexport\-raw\fR, and +\fBexport\-tar\fR +commands\&. +.PP +See +\fBorg.freedesktop.import1\fR(5) +and +\fBorg.freedesktop.LogControl1\fR(5) +for a description of the D\-Bus API\&. +.SH "SEE ALSO" +.PP +\fBsystemd\fR(1), +\fBmachinectl\fR(1), +\fBsystemd-machined.service\fR(8), +\fBsystemd-nspawn\fR(1) diff --git a/upstream/opensuse-leap-15-6/man8/systemd-journal-gatewayd.service.8 b/upstream/opensuse-leap-15-6/man8/systemd-journal-gatewayd.service.8 new file mode 100644 index 00000000..cca2aabd --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/systemd-journal-gatewayd.service.8 @@ -0,0 +1,296 @@ +'\" t +.TH "SYSTEMD\-JOURNAL\-GATEWAYD\&.SERVICE" "8" "" "systemd 254" "systemd-journal-gatewayd.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" +systemd-journal-gatewayd.service, systemd-journal-gatewayd.socket, systemd-journal-gatewayd \- HTTP server for journal events +.SH "SYNOPSIS" +.PP +systemd\-journal\-gatewayd\&.service +.PP +systemd\-journal\-gatewayd\&.socket +.HP \w'\fB/usr/lib/systemd/systemd\-journal\-gatewayd\fR\ 'u +\fB/usr/lib/systemd/systemd\-journal\-gatewayd\fR [OPTIONS...] +.SH "DESCRIPTION" +.PP +\fBsystemd\-journal\-gatewayd\fR +serves journal events over the network\&. Clients must connect using HTTP\&. The server listens on port 19531 by default\&. If +\fB\-\-cert=\fR +is specified, the server expects HTTPS connections\&. +.PP +The program is started by +\fBsystemd\fR(1) +and expects to receive a single socket\&. Use +\fBsystemctl start systemd\-journal\-gatewayd\&.socket\fR +to start the service, and +\fBsystemctl enable systemd\-journal\-gatewayd\&.socket\fR +to have it started on boot\&. +.SH "OPTIONS" +.PP +The following options are understood: +.PP +\fB\-\-cert=\fR +.RS 4 +Specify the path to a file or +\fBAF_UNIX\fR +stream socket to read the server certificate from\&. The certificate must be in PEM format\&. This option switches +\fBsystemd\-journal\-gatewayd\fR +into HTTPS mode and must be used together with +\fB\-\-key=\fR\&. +.RE +.PP +\fB\-\-key=\fR +.RS 4 +Specify the path to a file or +\fBAF_UNIX\fR +stream socket to read the secret server key corresponding to the certificate specified with +\fB\-\-cert=\fR +from\&. The key must be in PEM format\&. +.RE +.PP +\fB\-\-trust=\fR +.RS 4 +Specify the path to a file or +\fBAF_UNIX\fR +stream socket to read a CA certificate from\&. The certificate must be in PEM format\&. +.RE +.PP +\fB\-\-system\fR, \fB\-\-user\fR +.RS 4 +Limit served entries to entries from system services and the kernel, or to entries from services of current user\&. This has the same meaning as +\fB\-\-system\fR +and +\fB\-\-user\fR +options for +\fBjournalctl\fR(1)\&. If neither is specified, all accessible entries are served\&. +.RE +.PP +\fB\-m\fR, \fB\-\-merge\fR +.RS 4 +Serve entries interleaved from all available journals, including other machines\&. This has the same meaning as +\fB\-\-merge\fR +option for +\fBjournalctl\fR(1)\&. +.RE +.PP +\fB\-D \fR\fB\fIDIR\fR\fR, \fB\-\-directory=\fR\fB\fIDIR\fR\fR +.RS 4 +Takes a directory path as argument\&. If specified, +\fBsystemd\-journal\-gatewayd\fR +will serve the specified journal directory +\fIDIR\fR +instead of the default runtime and system journal paths\&. +.RE +.PP +\fB\-\-file=\fR\fB\fIGLOB\fR\fR +.RS 4 +Takes a file glob as an argument\&. Serve entries from the specified journal files matching +\fIGLOB\fR +instead of the default runtime and system journal paths\&. May be specified multiple times, in which case files will be suitably interleaved\&. This has the same meaning as +\fB\-\-file=\fR +option for +\fBjournalctl\fR(1)\&. +.RE +.PP +\fB\-h\fR, \fB\-\-help\fR +.RS 4 +Print a short help text and exit\&. +.RE +.PP +\fB\-\-version\fR +.RS 4 +Print a short version string and exit\&. +.RE +.SH "SUPPORTED URLS" +.PP +The following URLs are recognized: +.PP +/browse +.RS 4 +Interactive browsing\&. +.RE +.PP +/entries[?option1&option2=value\&...] +.RS 4 +Retrieval of events in various formats\&. +.sp +The +\fBAccept:\fR +part of the HTTP header determines the format\&. Supported values are described below\&. +.sp +The +\fBRange:\fR +part of the HTTP header determines the range of events returned\&. Supported values are described below\&. +.sp +GET parameters can be used to modify what events are returned\&. Supported parameters are described below\&. +.RE +.PP +/machine +.RS 4 +Return a JSON structure describing the machine\&. +.sp +Example: +.sp +.if n \{\ +.RS 4 +.\} +.nf +{ "machine_id" : "8cf7ed9d451ea194b77a9f118f3dc446", + "boot_id" : "3d3c9efaf556496a9b04259ee35df7f7", + "hostname" : "fedora", + "os_pretty_name" : "Fedora 19 (Rawhide)", + "virtualization" : "kvm", + \&...} +.fi +.if n \{\ +.RE +.\} +.sp +.RE +.PP +/fields/\fIFIELD_NAME\fR +.RS 4 +Return a list of values of this field present in the logs\&. +.RE +.SH "ACCEPT HEADER" +.PP +\fBAccept: \fR\fB\fIformat\fR\fR +.PP +Recognized formats: +.PP +\fBtext/plain\fR +.RS 4 +The default\&. Plaintext syslog\-like output, one line per journal entry (like +\fBjournalctl \-\-output short\fR)\&. +.RE +.PP +\fBapplication/json\fR +.RS 4 +Entries are formatted as JSON data structures, one per line (like +\fBjournalctl \-\-output json\fR)\&. See +\m[blue]\fBJournal JSON Format\fR\m[]\&\s-2\u[1]\d\s+2 +for more information\&. +.RE +.PP +\fBtext/event\-stream\fR +.RS 4 +Entries are formatted as JSON data structures, wrapped in a format suitable for +\m[blue]\fBServer\-Sent Events\fR\m[]\&\s-2\u[2]\d\s+2 +(like +\fBjournalctl \-\-output json\-sse\fR)\&. +.RE +.PP +\fBapplication/vnd\&.fdo\&.journal\fR +.RS 4 +Entries are serialized into a binary (but mostly text\-based) stream suitable for backups and network transfer (like +\fBjournalctl \-\-output export\fR)\&. See +\m[blue]\fBJournal Export Format\fR\m[]\&\s-2\u[3]\d\s+2 +for more information\&. +.RE +.SH "RANGE HEADER" +.PP +\fBRange: entries=\fR\fB\fIcursor\fR\fR\fB[[:\fR\fB\fInum_skip\fR\fR\fB]:\fR\fB\fInum_entries\fR\fR\fB]\fR +.PP +where +\fIcursor\fR +is a cursor string, +\fInum_skip\fR +is an integer, +\fInum_entries\fR +is an unsigned integer\&. +.PP +Range defaults to all available events\&. +.SH "URL GET PARAMETERS" +.PP +Following parameters can be used as part of the URL: +.PP +follow +.RS 4 +wait for new events (like +\fBjournalctl \-\-follow\fR, except that the number of events returned is not limited)\&. +.RE +.PP +discrete +.RS 4 +Test that the specified cursor refers to an entry in the journal\&. Returns just this entry\&. +.RE +.PP +boot +.RS 4 +Limit events to the current boot of the system (like +\fBjournalctl \-b\fR)\&. +.RE +.PP +\fIKEY\fR=\fImatch\fR +.RS 4 +Match journal fields\&. See +\fBsystemd.journal-fields\fR(7)\&. +.RE +.SH "EXAMPLES" +.PP +Retrieve events from this boot from local journal in +\m[blue]\fBJournal Export Format\fR\m[]\&\s-2\u[3]\d\s+2: +.sp +.if n \{\ +.RS 4 +.\} +.nf +curl \-\-silent \-H\*(AqAccept: application/vnd\&.fdo\&.journal\*(Aq \e + \*(Aqhttp://localhost:19531/entries?boot\*(Aq +.fi +.if n \{\ +.RE +.\} +.PP +Listen for core dumps: +.sp +.if n \{\ +.RS 4 +.\} +.nf +curl \*(Aqhttp://localhost:19531/entries?follow&MESSAGE_ID=fc2e22bc6ee647b6b90729ab34a250b1\*(Aq +.fi +.if n \{\ +.RE +.\} +.SH "SEE ALSO" +.PP +\fBsystemd\fR(1), +\fBjournalctl\fR(1), +\fBsystemd.journal-fields\fR(7), +\fBsystemd-journald.service\fR(8), +\fBsystemd-journal-remote.service\fR(8), +\fBsystemd-journal-upload.service\fR(8) +.SH "NOTES" +.IP " 1." 4 +Journal JSON Format +.RS 4 +\%https://systemd.io/JOURNAL_EXPORT_FORMATS#journal-json-format +.RE +.IP " 2." 4 +Server-Sent Events +.RS 4 +\%https://developer.mozilla.org/en-US/docs/Server-sent_events/Using_server-sent_events +.RE +.IP " 3." 4 +Journal Export Format +.RS 4 +\%https://systemd.io/JOURNAL_EXPORT_FORMATS#journal-export-format +.RE diff --git a/upstream/opensuse-leap-15-6/man8/systemd-journal-remote.service.8 b/upstream/opensuse-leap-15-6/man8/systemd-journal-remote.service.8 new file mode 100644 index 00000000..5b455ece --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/systemd-journal-remote.service.8 @@ -0,0 +1,323 @@ +'\" t +.TH "SYSTEMD\-JOURNAL\-REMOTE\&.SERVICE" "8" "" "systemd 254" "systemd-journal-remote.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" +systemd-journal-remote.service, systemd-journal-remote.socket, systemd-journal-remote \- Receive journal messages over the network +.SH "SYNOPSIS" +.PP +systemd\-journal\-remote\&.service +.PP +systemd\-journal\-remote\&.socket +.HP \w'\fB/usr/lib/systemd/systemd\-journal\-remote\fR\ 'u +\fB/usr/lib/systemd/systemd\-journal\-remote\fR [OPTIONS...] [\-o/\-\-output=\fIDIR\fR|\fIFILE\fR] [SOURCES...] +.SH "DESCRIPTION" +.PP +\fBsystemd\-journal\-remote\fR +is a command to receive serialized journal events and store them to journal files\&. Input streams are in the +\m[blue]\fBJournal Export Format\fR\m[]\&\s-2\u[1]\d\s+2, i\&.e\&. like the output from +\fBjournalctl \-\-output=export\fR\&. For transport over the network, this serialized stream is usually carried over an HTTPS connection\&. +.PP +systemd\-journal\-remote\&.service +is a system service that uses +\fBsystemd\-journal\-remote\fR +to listen for connections\&. +systemd\-journal\-remote\&.socket +configures the network address that +systemd\-journal\-remote\&.service +listens on\&. By default this is port 19532\&. What connections are accepted and how the received data is stored can be configured through the +\fBjournal-remote.conf\fR(5) +configuration file\&. +.SH "SOURCES" +.PP +Sources can be either "active" (\fBsystemd\-journal\-remote\fR +requests and pulls the data), or "passive" (\fBsystemd\-journal\-remote\fR +waits for a connection and then receives events pushed by the other side)\&. +.PP +\fBsystemd\-journal\-remote\fR +can read more than one event stream at a time\&. They will be interleaved in the output file\&. In case of "active" connections, each "source" is one stream, and in case of "passive" connections, each connection can result in a separate stream\&. Sockets can be configured in "accept" mode (i\&.e\&. only one connection), or "listen" mode (i\&.e\&. multiple connections, each resulting in a stream)\&. +.PP +When there are no more connections, and no more can be created (there are no listening sockets), then +\fBsystemd\-journal\-remote\fR +will exit\&. +.PP +Active sources can be specified in the following ways: +.PP +[SOURCES...] +.RS 4 +When +\fB\-\fR +is given as a positional argument, events will be read from standard input\&. Other positional arguments will be treated as filenames to open and read from\&. +.RE +.PP +\fB\-\-url=\fR\fB\fIADDRESS\fR\fR +.RS 4 +With the +\fB\-\-url=\fR\fB\fIADDRESS\fR\fR +option, events will be retrieved using HTTP from +\fIADDRESS\fR\&. This URL should refer to the root of a remote +\fBsystemd-journal-gatewayd\fR(8) +instance, e\&.g\&. http://some\&.host:19531/ or https://some\&.host:19531/\&. +.RE +.PP +\fB\-\-getter=\*(Aq\fR\fB\fIPROG\fR\fR\fB \fR\fB[OPTIONS...]\fR\fB\*(Aq\fR +.RS 4 +Program to invoke to retrieve data\&. The journal event stream must be generated on standard output\&. +.sp +Examples: +.sp +.if n \{\ +.RS 4 +.\} +.nf +\-\-getter=\*(Aqcurl "\-HAccept: application/vnd\&.fdo\&.journal" https://some\&.host:19531/\*(Aq +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +\-\-getter=\*(Aqwget \-\-header="Accept: application/vnd\&.fdo\&.journal" \-O\- https://some\&.host:19531/\*(Aq +.fi +.if n \{\ +.RE +.\} +.RE +.PP +Passive sources can be specified in the following ways: +.PP +\fB\-\-listen\-raw=\fR\fB\fIADDRESS\fR\fR +.RS 4 +\fIADDRESS\fR +must be an address suitable for +\fBListenStream=\fR +(cf\&. +\fBsystemd.socket\fR(5))\&. +\fBsystemd\-journal\-remote\fR +will listen on this socket for connections\&. Each connection is expected to be a stream of journal events\&. +.RE +.PP +\fB\-\-listen\-http=\fR\fB\fIADDRESS\fR\fR, \fB\-\-listen\-https=\fR\fB\fIADDRESS\fR\fR +.RS 4 +\fIADDRESS\fR +must be either a negative integer, in which case it will be interpreted as the (negated) file descriptor number, or an address suitable for +\fBListenStream=\fR +(c\&.f\&. +\fBsystemd.socket\fR(5))\&. In the first case, the server listens on port 19532 by default, and the matching file descriptor must be inherited through +\fI$LISTEN_FDS\fR/\fI$LISTEN_PID\fR\&. In the second case, an HTTP or HTTPS server will be spawned on this port, respectively for +\fB\-\-listen\-http=\fR +and +\fB\-\-listen\-https=\fR\&. Currently, only POST requests to +/upload +with +"Content\-Type: application/vnd\&.fdo\&.journal" +are supported\&. +.RE +.PP +\fI$LISTEN_FDS\fR +.RS 4 +\fBsystemd\-journal\-remote\fR +supports the +\fI$LISTEN_FDS\fR/\fI$LISTEN_PID\fR +protocol\&. Open sockets inherited through socket activation behave like those opened with +\fB\-\-listen\-raw=\fR +described above, unless they are specified as an argument in +\fB\-\-listen\-http=\-\fR\fB\fIn\fR\fR +or +\fB\-\-listen\-https=\-\fR\fB\fIn\fR\fR +above\&. In the latter case, an HTTP or HTTPS server will be spawned using this descriptor and connections must be made over the HTTP protocol\&. +.RE +.PP +\fB\-\-key=\fR +.RS 4 +Takes a path to a SSL secret key file in PEM format\&. Defaults to +/etc/pki/systemd/private/journal\-remote\&.pem\&. This option can be used with +\fB\-\-listen\-https=\fR\&. If the path refers to an +\fBAF_UNIX\fR +stream socket in the file system a connection is made to it and the key read from it\&. +.RE +.PP +\fB\-\-cert=\fR +.RS 4 +Takes a path to a SSL certificate file in PEM format\&. Defaults to +/etc/pki/systemd/certs/journal\-remote\&.pem\&. This option can be used with +\fB\-\-listen\-https=\fR\&. If the path refers to an +\fBAF_UNIX\fR +stream socket in the file system a connection is made to it and the certificate read from it\&. +.RE +.PP +\fB\-\-trust=\fR +.RS 4 +Takes a path to a SSL CA certificate file in PEM format, or +\fBall\fR\&. If +\fBall\fR +is set, then certificate checking will be disabled\&. Defaults to +/etc/pki/systemd/ca/trusted\&.pem\&. This option can be used with +\fB\-\-listen\-https=\fR\&. If the path refers to an +\fBAF_UNIX\fR +stream socket in the file system a connection is made to it and the certificate read from it\&. +.RE +.PP +\fB\-\-gnutls\-log=\fR +.RS 4 +Takes a comma separated list of gnutls logging categories\&. This option can be used with +\fB\-\-listen\-http=\fR +or +\fB\-\-listen\-https=\fR\&. +.RE +.SH "SINKS" +.PP +The location of the output journal can be specified with +\fB\-o\fR +or +\fB\-\-output=\fR\&. +.PP +\fB\-o \fR\fB\fIFILE\fR\fR, \fB\-\-output=\fR\fB\fIFILE\fR\fR +.RS 4 +Will write to this journal file\&. The filename must end with +\&.journal\&. The file will be created if it does not exist\&. If necessary (journal file full, or corrupted), the file will be renamed following normal journald rules and a new journal file will be created in its stead\&. +.RE +.PP +\fB\-o \fR\fB\fIDIR\fR\fR, \fB\-\-output=\fR\fB\fIDIR\fR\fR +.RS 4 +Will create journal files underneath directory +\fIDIR\fR\&. The directory must exist\&. If necessary (journal files over size, or corrupted), journal files will be rotated following normal journald rules\&. Names of files underneath +\fIDIR\fR +will be generated using the rules described below\&. +.RE +.PP +If +\fB\-\-output=\fR +is not used, the output directory +/var/log/journal/remote/ +will be used\&. In case the output file is not specified, journal files will be created underneath the selected directory\&. Files will be called +remote\-\fIhostname\fR\&.journal, where the +\fIhostname\fR +part is the escaped hostname of the source endpoint of the connection, or the numerical address if the hostname cannot be determined\&. +.PP +In the case that "active" sources are given by the positional arguments or +\fB\-\-getter=\fR +option, the output file name must always be given explicitly\&. +.SH "OPTIONS" +.PP +The following options are understood: +.PP +\fB\-\-split\-mode\fR +.RS 4 +One of +\fBnone\fR +or +\fBhost\fR\&. For the first, only one output journal file is used\&. For the latter, a separate output file is used, based on the hostname of the other endpoint of a connection\&. +.sp +In the case that "active" sources are given by the positional arguments or +\fB\-\-getter=\fR +option, the output file name must always be given explicitly and only +\fBnone\fR +is allowed\&. +.RE +.PP +\fB\-\-compress\fR [\fIBOOL\fR] +.RS 4 +If this is set to +"yes" +then compress the data in the journal using XZ\&. The default is +"yes"\&. +.RE +.PP +\fB\-\-seal\fR [\fIBOOL\fR] +.RS 4 +If this is set to +"yes" +then periodically sign the data in the journal using Forward Secure Sealing\&. The default is +"no"\&. +.RE +.PP +\fB\-h\fR, \fB\-\-help\fR +.RS 4 +Print a short help text and exit\&. +.RE +.PP +\fB\-\-version\fR +.RS 4 +Print a short version string and exit\&. +.RE +.SH "EXAMPLES" +.PP +Copy local journal events to a different journal directory: +.sp +.if n \{\ +.RS 4 +.\} +.nf +journalctl \-o export | systemd\-journal\-remote \-o /tmp/dir/foo\&.journal \- + +.fi +.if n \{\ +.RE +.\} +.PP +Retrieve all available events from a remote +\fBsystemd-journal-gatewayd\fR(8) +instance and store them in +/var/log/journal/remote/remote\-some\&.host\&.journal: +.sp +.if n \{\ +.RS 4 +.\} +.nf +systemd\-journal\-remote \-\-url http://some\&.host:19531/ + +.fi +.if n \{\ +.RE +.\} +.PP +Retrieve current boot events and wait for new events from a remote +\fBsystemd-journal-gatewayd\fR(8) +instance, and store them in +/var/log/journal/remote/remote\-some\&.host\&.journal: +.sp +.if n \{\ +.RS 4 +.\} +.nf +systemd\-journal\-remote \-\-url http://some\&.host:19531/entries?boot&follow + +.fi +.if n \{\ +.RE +.\} +.sp +.SH "SEE ALSO" +.PP +\fBjournal-remote.conf\fR(5), +\fBjournalctl\fR(1), +\fBsystemd-journal-gatewayd.service\fR(8), +\fBsystemd-journal-upload.service\fR(8), +\fBsystemd-journald.service\fR(8) +.SH "NOTES" +.IP " 1." 4 +Journal Export Format +.RS 4 +\%https://systemd.io/JOURNAL_EXPORT_FORMATS#journal-export-format +.RE diff --git a/upstream/opensuse-leap-15-6/man8/systemd-journal-upload.service.8 b/upstream/opensuse-leap-15-6/man8/systemd-journal-upload.service.8 new file mode 100644 index 00000000..728d0314 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/systemd-journal-upload.service.8 @@ -0,0 +1,262 @@ +'\" t +.TH "SYSTEMD\-JOURNAL\-UPLOAD\&.SERVICE" "8" "" "systemd 254" "systemd-journal-upload.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" +systemd-journal-upload.service, systemd-journal-upload \- Send journal messages over the network +.SH "SYNOPSIS" +.PP +systemd\-journal\-upload\&.service +.HP \w'\fB/usr/lib/systemd/systemd\-journal\-upload\fR\ 'u +\fB/usr/lib/systemd/systemd\-journal\-upload\fR [OPTIONS...] [\-u/\-\-url=\fIURL\fR] [SOURCES...] +.SH "DESCRIPTION" +.PP +\fBsystemd\-journal\-upload\fR +will upload journal entries to the URL specified with +\fB\-\-url=\fR\&. This program reads journal entries from one or more journal files, similarly to +\fBjournalctl\fR(1)\&. Unless limited by one of the options specified below, all journal entries accessible to the user the program is running as will be uploaded, and then the program will wait and send new entries as they become available\&. +.PP +\fBsystemd\-journal\-upload\fR +transfers the raw content of journal file and uses HTTP as a transport protocol\&. +.PP +systemd\-journal\-upload\&.service +is a system service that uses +\fBsystemd\-journal\-upload\fR +to upload journal entries to a server\&. It uses the configuration in +\fBjournal-upload.conf\fR(5)\&. At least the +\fIURL=\fR +option must be specified\&. +.SH "OPTIONS" +.PP +\fB\-u\fR, \fB\-\-url=\fR\fB[https://]\fR\fB\fIURL\fR\fR\fB[:\fR\fB\fIPORT\fR\fR\fB]\fR, \fB\-\-url=\fR\fB[http://]\fR\fB\fIURL\fR\fR\fB[:\fR\fB\fIPORT\fR\fR\fB]\fR +.RS 4 +Upload to the specified address\&. +\fIURL\fR +may specify either just the hostname or both the protocol and hostname\&. +\fBhttps\fR +is the default\&. The port number may be specified after a colon (":"), otherwise +\fB19532\fR +will be used by default\&. +.RE +.PP +\fB\-\-system\fR, \fB\-\-user\fR +.RS 4 +Limit uploaded entries to entries from system services and the kernel, or to entries from services of current user\&. This has the same meaning as +\fB\-\-system\fR +and +\fB\-\-user\fR +options for +\fBjournalctl\fR(1)\&. If neither is specified, all accessible entries are uploaded\&. +.RE +.PP +\fB\-m\fR, \fB\-\-merge\fR +.RS 4 +Upload entries interleaved from all available journals, including other machines\&. This has the same meaning as +\fB\-\-merge\fR +option for +\fBjournalctl\fR(1)\&. +.RE +.PP +\fB\-\-namespace=\fR\fB\fINAMESPACE\fR\fR +.RS 4 +Takes a journal namespace identifier string as argument\&. Upload entries from the specified journal namespace +\fINAMESPACE\fR +instead of the default namespace\&. This has the same meaning as +\fB\-\-namespace=\fR +option for +\fBjournalctl\fR(1)\&. +.RE +.PP +\fB\-D\fR, \fB\-\-directory=\fR\fB\fIDIR\fR\fR +.RS 4 +Takes a directory path as argument\&. Upload entries from the specified journal directory +\fIDIR\fR +instead of the default runtime and system journal paths\&. This has the same meaning as +\fB\-\-directory=\fR +option for +\fBjournalctl\fR(1)\&. +.RE +.PP +\fB\-\-file=\fR\fB\fIGLOB\fR\fR +.RS 4 +Takes a file glob as an argument\&. Upload entries from the specified journal files matching +\fIGLOB\fR +instead of the default runtime and system journal paths\&. May be specified multiple times, in which case files will be suitably interleaved\&. This has the same meaning as +\fB\-\-file=\fR +option for +\fBjournalctl\fR(1)\&. +.RE +.PP +\fB\-\-cursor=\fR +.RS 4 +Upload entries from the location in the journal specified by the passed cursor\&. This has the same meaning as +\fB\-\-cursor=\fR +option for +\fBjournalctl\fR(1)\&. +.RE +.PP +\fB\-\-after\-cursor=\fR +.RS 4 +Upload entries from the location in the journal +\fIafter\fR +the location specified by the this cursor\&. This has the same meaning as +\fB\-\-after\-cursor=\fR +option for +\fBjournalctl\fR(1)\&. +.RE +.PP +\fB\-\-save\-state\fR[=\fIPATH\fR] +.RS 4 +Upload entries from the location in the journal +\fIafter\fR +the location specified by the cursor saved in file at +\fIPATH\fR +(/var/lib/systemd/journal\-upload/state +by default)\&. After an entry is successfully uploaded, update this file with the cursor of that entry\&. +.RE +.PP +\fB\-\-follow\fR[=\fIBOOL\fR] +.RS 4 +If set to yes, then +\fBsystemd\-journal\-upload\fR +waits for input\&. +.RE +.PP +\fB\-\-key=\fR +.RS 4 +Takes a path to a SSL key file in PEM format, or +\fB\-\fR\&. If +\fB\-\fR +is set, then client certificate authentication checking will be disabled\&. Defaults to +/etc/pki/systemd/private/journal\-upload\&.pem\&. +.RE +.PP +\fB\-\-cert=\fR +.RS 4 +Takes a path to a SSL certificate file in PEM format, or +\fB\-\fR\&. If +\fB\-\fR +is set, then client certificate authentication checking will be disabled\&. Defaults to +/etc/pki/systemd/certs/journal\-upload\&.pem\&. +.RE +.PP +\fB\-\-trust=\fR +.RS 4 +Takes a path to a SSL CA certificate file in PEM format, or +\fB\-\fR/\fBall\fR\&. If +\fB\-\fR/\fBall\fR +is set, then certificate checking will be disabled\&. Defaults to +/etc/pki/systemd/ca/trusted\&.pem\&. +.RE +.PP +\fB\-h\fR, \fB\-\-help\fR +.RS 4 +Print a short help text and exit\&. +.RE +.PP +\fB\-\-version\fR +.RS 4 +Print a short version string and exit\&. +.RE +.SH "EXIT STATUS" +.PP +On success, 0 is returned; otherwise, a non\-zero failure code is returned\&. +.SH "EXAMPLES" +.PP +\fBExample\ \&1.\ \&Setting up certificates for authentication\fR +.PP +Certificates signed by a trusted authority are used to verify that the server to which messages are uploaded is legitimate, and vice versa, that the client is trusted\&. +.PP +A suitable set of certificates can be generated with +\fBopenssl\fR\&. Note, 2048 bits of key length is minimally recommended to use for security reasons: +.sp +.if n \{\ +.RS 4 +.\} +.nf +openssl req \-newkey rsa:2048 \-days 3650 \-x509 \-nodes \e + \-out ca\&.pem \-keyout ca\&.key \-subj \*(Aq/CN=Certificate authority/\*(Aq + +cat >ca\&.conf <<EOF +[ ca ] +default_ca = this + +[ this ] +new_certs_dir = \&. +certificate = ca\&.pem +database = \&./index +private_key = ca\&.key +serial = \&./serial +default_days = 3650 +default_md = default +policy = policy_anything + +[ policy_anything ] +countryName = optional +stateOrProvinceName = optional +localityName = optional +organizationName = optional +organizationalUnitName = optional +commonName = supplied +emailAddress = optional +EOF + +touch index +echo 0001 >serial + +SERVER=server +CLIENT=client + +openssl req \-newkey rsa:2048 \-nodes \-out $SERVER\&.csr \-keyout $SERVER\&.key \-subj "/CN=$SERVER/" +openssl ca \-batch \-config ca\&.conf \-notext \-in $SERVER\&.csr \-out $SERVER\&.pem + +openssl req \-newkey rsa:2048 \-nodes \-out $CLIENT\&.csr \-keyout $CLIENT\&.key \-subj "/CN=$CLIENT/" +openssl ca \-batch \-config ca\&.conf \-notext \-in $CLIENT\&.csr \-out $CLIENT\&.pem +.fi +.if n \{\ +.RE +.\} +.PP +Generated files +ca\&.pem, +server\&.pem, and +server\&.key +should be installed on server, and +ca\&.pem, +client\&.pem, and +client\&.key +on the client\&. The location of those files can be specified using +\fITrustedCertificateFile=\fR, +\fIServerCertificateFile=\fR, and +\fIServerKeyFile=\fR +in +/etc/systemd/journal\-remote\&.conf +and +/etc/systemd/journal\-upload\&.conf, respectively\&. The default locations can be queried by using +\fBsystemd\-journal\-remote \-\-help\fR +and +\fBsystemd\-journal\-upload \-\-help\fR\&. +.SH "SEE ALSO" +.PP +\fBjournal-upload.conf\fR(5), +\fBsystemd-journal-remote.service\fR(8), +\fBjournalctl\fR(1), +\fBsystemd-journald.service\fR(8), +\fBsystemd-journal-gatewayd.service\fR(8) diff --git a/upstream/opensuse-leap-15-6/man8/systemd-journald.service.8 b/upstream/opensuse-leap-15-6/man8/systemd-journald.service.8 new file mode 100644 index 00000000..7f439f04 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/systemd-journald.service.8 @@ -0,0 +1,398 @@ +'\" t +.TH "SYSTEMD\-JOURNALD\&.SERVICE" "8" "" "systemd 254" "systemd-journald.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" +systemd-journald.service, systemd-journald.socket, systemd-journald-dev-log.socket, systemd-journald-audit.socket, systemd-journald@.service, systemd-journald@.socket, systemd-journald-varlink@.socket, systemd-journald \- Journal service +.SH "SYNOPSIS" +.PP +systemd\-journald\&.service +.PP +systemd\-journald\&.socket +.PP +systemd\-journald\-dev\-log\&.socket +.PP +systemd\-journald\-audit\&.socket +.PP +systemd\-journald@\&.service +.PP +systemd\-journald@\&.socket +.PP +systemd\-journald\-varlink@\&.socket +.PP +/usr/lib/systemd/systemd\-journald +.SH "DESCRIPTION" +.PP +systemd\-journald +is a system service that collects and stores logging data\&. It creates and maintains structured, indexed journals based on logging information that is received from a variety of sources: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Kernel log messages, via kmsg +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Simple system log messages, via the +libc +\fBsyslog\fR(3) +call +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Structured system log messages via the native Journal API, see +\fBsd_journal_print\fR(3) +and +\m[blue]\fBNative Journal Protocol\fR\m[]\&\s-2\u[1]\d\s+2 +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Standard output and standard error of service units\&. For further details see below\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Audit records, originating from the kernel audit subsystem +.RE +.PP +The daemon will implicitly collect numerous metadata fields for each log messages in a secure and unfakeable way\&. See +\fBsystemd.journal-fields\fR(7) +for more information about the collected metadata\&. +.PP +Log data collected by the journal is primarily text\-based but can also include binary data where necessary\&. Individual fields making up a log record stored in the journal may be up to 2⁶⁴\-1 bytes in size\&. +.PP +The journal service stores log data either persistently below +/var/log/journal +or in a volatile way below +/run/log/journal/ +(in the latter case it is lost at reboot)\&. By default, log data is stored persistently if +/var/log/journal/ +exists during boot, with an implicit fallback to volatile storage otherwise\&. Use +\fIStorage=\fR +in +\fBjournald.conf\fR(5) +to configure where log data is placed, independently of the existence of +/var/log/journal/\&. +.PP +Note that journald will initially use volatile storage, until a call to +\fBjournalctl \-\-flush\fR +(or sending +\fBSIGUSR1\fR +to journald) will cause it to switch to persistent logging (under the conditions mentioned above)\&. This is done automatically on boot via +"systemd\-journal\-flush\&.service"\&. +.PP +On systems where +/var/log/journal/ +does not exist yet but where persistent logging is desired (and the default +journald\&.conf +is used), it is sufficient to create the directory, and ensure it has the correct access modes and ownership: +.sp +.if n \{\ +.RS 4 +.\} +.nf +mkdir \-p /var/log/journal +systemd\-tmpfiles \-\-create \-\-prefix /var/log/journal +.fi +.if n \{\ +.RE +.\} +.PP +See +\fBjournald.conf\fR(5) +for information about the configuration of this service\&. +.SH "STREAM LOGGING" +.PP +The systemd service manager invokes all service processes with standard output and standard error connected to the journal by default\&. This behaviour may be altered via the +\fIStandardOutput=\fR/\fIStandardError=\fR +unit file settings, see +\fBsystemd.exec\fR(5) +for details\&. The journal converts the log byte stream received this way into individual log records, splitting the stream at newline ("\en", ASCII +\fB10\fR) and +\fBNUL\fR +bytes\&. +.PP +If +systemd\-journald\&.service +is stopped, the stream connections associated with all services are terminated\&. Further writes to those streams by the service will result in +\fBEPIPE\fR +errors\&. In order to react gracefully in this case it is recommended that programs logging to standard output/error ignore such errors\&. If the +\fBSIGPIPE\fR +UNIX signal handler is not blocked or turned off, such write attempts will also result in such process signals being generated, see +\fBsignal\fR(7)\&. To mitigate this issue, systemd service manager explicitly turns off the +\fBSIGPIPE\fR +signal for all invoked processes by default (this may be changed for each unit individually via the +\fIIgnoreSIGPIPE=\fR +option, see +\fBsystemd.exec\fR(5) +for details)\&. After the standard output/standard error streams have been terminated they may not be recovered until the services they are associated with are restarted\&. Note that during normal operation, +systemd\-journald\&.service +stores copies of the file descriptors for those streams in the service manager\&. If +systemd\-journald\&.service +is restarted using +\fBsystemctl restart\fR +or equivalent operation instead of a pair of separate +\fBsystemctl stop\fR +and +\fBsystemctl start\fR +commands (or equivalent operations), these stream connections are not terminated and survive the restart\&. It is thus safe to restart +systemd\-journald\&.service, but stopping it is not recommended\&. +.PP +Note that the log record metadata for records transferred via such standard output/error streams reflect the metadata of the peer the stream was originally created for\&. If the stream connection is passed on to other processes (such as further child processes forked off the main service process), the log records will not reflect their metadata, but will continue to describe the original process\&. This is different from the other logging transports listed above, which are inherently record based and where the metadata is always associated with the individual record\&. +.PP +In addition to the implicit standard output/error logging of services, stream logging is also available via the +\fBsystemd-cat\fR(1) +command line tool\&. +.PP +Currently, the number of parallel log streams +systemd\-journald +will accept is limited to 4096\&. When this limit is reached further log streams may be established but will receive +\fBEPIPE\fR +right from the beginning\&. +.SH "JOURNAL NAMESPACES" +.PP +Journal \*(Aqnamespaces\*(Aq are both a mechanism for logically isolating the log stream of projects consisting of one or more services from the rest of the system and a mechanism for improving performance\&. Multiple journal namespaces may exist simultaneously, each defining its own, independent log stream managed by its own instance of +\fBsystemd\-journald\fR\&. Namespaces are independent of each other, both in the data store and in the IPC interface\&. By default only a single \*(Aqdefault\*(Aq namespace exists, managed by +systemd\-journald\&.service +(and its associated socket units)\&. Additional namespaces are created by starting an instance of the +systemd\-journald@\&.service +service template\&. The instance name is the namespace identifier, which is a short string used for referencing the journal namespace\&. Service units may be assigned to a specific journal namespace through the +\fILogNamespace=\fR +unit file setting, see +\fBsystemd.exec\fR(5) +for details\&. The +\fB\-\-namespace=\fR +switch of +\fBjournalctl\fR(1) +may be used to view the log stream of a specific namespace\&. If the switch is not used the log stream of the default namespace is shown, i\&.e\&. log data from other namespaces is not visible\&. +.PP +Services associated with a specific log namespace may log via syslog, the native logging protocol of the journal and via stdout/stderr; the logging from all three transports is associated with the namespace\&. +.PP +By default only the default namespace will collect kernel and audit log messages\&. +.PP +The +\fBsystemd\-journald\fR +instance of the default namespace is configured through +/etc/systemd/journald\&.conf +(see below), while the other instances are configured through +/etc/systemd/journald@\fINAMESPACE\fR\&.conf\&. The journal log data for the default namespace is placed in +/var/log/journal/\fIMACHINE_ID\fR +(see below) while the data for the other namespaces is located in +/var/log/journal/\fIMACHINE_ID\fR\&.\fINAMESPACE\fR\&. +.SH "SIGNALS" +.PP +SIGUSR1 +.RS 4 +Request that journal data from +/run/ +is flushed to +/var/ +in order to make it persistent (if this is enabled)\&. This must be used after +/var/ +is mounted, as otherwise log data from +/run/ +is never flushed to +/var/ +regardless of the configuration\&. Use the +\fBjournalctl \-\-flush\fR +command to request flushing of the journal files, and wait for the operation to complete\&. See +\fBjournalctl\fR(1) +for details\&. +.RE +.PP +SIGUSR2 +.RS 4 +Request immediate rotation of the journal files\&. Use the +\fBjournalctl \-\-rotate\fR +command to request journal file rotation, and wait for the operation to complete\&. +.RE +.PP +SIGRTMIN+1 +.RS 4 +Request that all unwritten log data is written to disk\&. Use the +\fBjournalctl \-\-sync\fR +command to trigger journal synchronization, and wait for the operation to complete\&. +.RE +.SH "KERNEL COMMAND LINE" +.PP +A few configuration parameters from +journald\&.conf +may be overridden on the kernel command line: +.PP +\fIsystemd\&.journald\&.forward_to_syslog=\fR, \fIsystemd\&.journald\&.forward_to_kmsg=\fR, \fIsystemd\&.journald\&.forward_to_console=\fR, \fIsystemd\&.journald\&.forward_to_wall=\fR +.RS 4 +Enables/disables forwarding of collected log messages to syslog, the kernel log buffer, the system console or wall\&. +.sp +See +\fBjournald.conf\fR(5) +for information about these settings\&. +.RE +.PP +Note that these kernel command line options are only honoured by the default namespace, see above\&. +.SH "ACCESS CONTROL" +.PP +Journal files are, by default, owned and readable by the +"systemd\-journal" +system group but are not writable\&. Adding a user to this group thus enables them to read the journal files\&. +.PP +By default, each user, with a UID outside the range of system users, dynamic service users, and the nobody user, will get their own set of journal files in +/var/log/journal/\&. See +\m[blue]\fBUsers, Groups, UIDs and GIDs on systemd systems\fR\m[]\&\s-2\u[2]\d\s+2 +for more details about UID ranges\&. These journal files will not be owned by the user, however, in order to avoid that the user can write to them directly\&. Instead, file system ACLs are used to ensure the user gets read access only\&. +.PP +Additional users and groups may be granted access to journal files via file system access control lists (ACL)\&. Distributions and administrators may choose to grant read access to all members of the +"wheel" +and +"adm" +system groups with a command such as the following: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# setfacl \-Rnm g:wheel:rx,d:g:wheel:rx,g:adm:rx,d:g:adm:rx /var/log/journal/ +.fi +.if n \{\ +.RE +.\} +.PP +Note that this command will update the ACLs both for existing journal files and for future journal files created in the +/var/log/journal/ +directory\&. +.SH "FILES" +.PP +/etc/systemd/journald\&.conf +.RS 4 +Configure +\fBsystemd\-journald\fR +behavior\&. See +\fBjournald.conf\fR(5)\&. +.RE +.PP +/run/log/journal/\fImachine\-id\fR/*\&.journal, /run/log/journal/\fImachine\-id\fR/*\&.journal~, /var/log/journal/\fImachine\-id\fR/*\&.journal, /var/log/journal/\fImachine\-id\fR/*\&.journal~ +.RS 4 +\fBsystemd\-journald\fR +writes entries to files in +/run/log/journal/\fImachine\-id\fR/ +or +/var/log/journal/\fImachine\-id\fR/ +with the +"\&.journal" +suffix\&. If the daemon is stopped uncleanly, or if the files are found to be corrupted, they are renamed using the +"\&.journal~" +suffix, and +\fBsystemd\-journald\fR +starts writing to a new file\&. +/run/ +is used when +/var/log/journal +is not available, or when +\fBStorage=volatile\fR +is set in the +\fBjournald.conf\fR(5) +configuration file\&. +.sp +When +systemd\-journald +ceases writing to a journal file, it will be renamed to +"\fIoriginal\-name\fR@\fIsuffix\&.journal\fR" +(or +"\fIoriginal\-name\fR@\fIsuffix\&.journal~\fR")\&. Such files are "archived" and will not be written to any more\&. +.sp +In general, it is safe to read or copy any journal file (active or archived)\&. +\fBjournalctl\fR(1) +and the functions in the +\fBsd-journal\fR(3) +library should be able to read all entries that have been fully written\&. +.sp +systemd\-journald +will automatically remove the oldest archived journal files to limit disk use\&. See +\fISystemMaxUse=\fR +and related settings in +\fBjournald.conf\fR(5)\&. +.RE +.PP +/dev/kmsg, /dev/log, /run/systemd/journal/dev\-log, /run/systemd/journal/socket, /run/systemd/journal/stdout +.RS 4 +Sockets and other file node paths that +\fBsystemd\-journald\fR +will listen on and are visible in the file system\&. In addition to these, +\fBsystemd\-journald\fR +can listen for audit events using +\fBnetlink\fR(7), depending on whether +"systemd\-journald\-audit\&.socket" +is enabled or not\&. +.RE +.PP +If journal namespacing is used these paths are slightly altered to include a namespace identifier, see above\&. +.SH "SEE ALSO" +.PP +\fBsystemd\fR(1), +\fBjournalctl\fR(1), +\fBjournald.conf\fR(5), +\fBsystemd.journal-fields\fR(7), +\fBsd-journal\fR(3), +\fBsystemd-coredump\fR(8), +\fBsetfacl\fR(1), +\fBsd_journal_print\fR(3), +\fBpydoc systemd\&.journal\fR +.SH "NOTES" +.IP " 1." 4 +Native Journal Protocol +.RS 4 +\%https://systemd.io/JOURNAL_NATIVE_PROTOCOL +.RE +.IP " 2." 4 +Users, Groups, UIDs and GIDs on systemd systems +.RS 4 +\%https://systemd.io/UIDS-GIDS +.RE diff --git a/upstream/opensuse-leap-15-6/man8/systemd-localed.service.8 b/upstream/opensuse-leap-15-6/man8/systemd-localed.service.8 new file mode 100644 index 00000000..84c0fe34 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/systemd-localed.service.8 @@ -0,0 +1,51 @@ +'\" t +.TH "SYSTEMD\-LOCALED\&.SERVICE" "8" "" "systemd 254" "systemd-localed.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" +systemd-localed.service, systemd-localed \- Locale bus mechanism +.SH "SYNOPSIS" +.PP +systemd\-localed\&.service +.PP +/usr/lib/systemd/systemd\-localed +.SH "DESCRIPTION" +.PP +systemd\-localed\&.service +is a system service that may be used as mechanism to change the system locale settings, as well as the console key mapping and default X11 key mapping\&. +systemd\-localed +is automatically activated on request and terminates itself when it is unused\&. +.PP +The tool +\fBlocalectl\fR(1) +is a command line client to this service\&. +.PP +See +\fBorg.freedesktop.locale1\fR(5) +and +\fBorg.freedesktop.LogControl1\fR(5) +for a description of the D\-Bus API\&. +.SH "SEE ALSO" +.PP +\fBsystemd\fR(1), +\fBlocale.conf\fR(5), +\fBvconsole.conf\fR(5), +\fBlocalectl\fR(1), +\fBloadkeys\fR(1) diff --git a/upstream/opensuse-leap-15-6/man8/systemd-logind.service.8 b/upstream/opensuse-leap-15-6/man8/systemd-logind.service.8 new file mode 100644 index 00000000..098085b5 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/systemd-logind.service.8 @@ -0,0 +1,213 @@ +'\" t +.TH "SYSTEMD\-LOGIND\&.SERVICE" "8" "" "systemd 254" "systemd-logind.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" +systemd-logind.service, systemd-logind \- Login manager +.SH "SYNOPSIS" +.PP +systemd\-logind\&.service +.PP +/usr/lib/systemd/systemd\-logind +.SH "DESCRIPTION" +.PP +\fBsystemd\-logind\fR +is a system service that manages user logins\&. It is responsible for: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Keeping track of users and sessions, their processes and their idle state\&. This is implemented by allocating a systemd slice unit for each user below +user\&.slice, and a scope unit below it for each concurrent session of a user\&. Also, a per\-user service manager is started as system service instance of +user@\&.service +for each logged in user\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Generating and managing session IDs\&. If auditing is available and an audit session ID is already set for a session, then this ID is reused as the session ID\&. Otherwise, an independent session counter is used\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Providing +\m[blue]\fBpolkit\fR\m[]\&\s-2\u[1]\d\s+2\-based access for users for operations such as system shutdown or sleep +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Implementing a shutdown/sleep inhibition logic for applications +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Handling of power/sleep hardware keys +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Multi\-seat management +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Session switch management +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Device access management for users +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Automatic spawning of text logins (gettys) on virtual console activation and user runtime directory management +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Scheduled shutdown +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Sending "wall" messages +.RE +.PP +User sessions are registered with logind via the +\fBpam_systemd\fR(8) +PAM module\&. +.PP +See +\fBlogind.conf\fR(5) +for information about the configuration of this service\&. +.PP +See +\fBsd-login\fR(3) +for information about the basic concepts of logind such as users, sessions and seats\&. +.PP +See +\fBorg.freedesktop.login1\fR(5) +and +\fBorg.freedesktop.LogControl1\fR(5) +for information about the D\-Bus APIs +systemd\-logind +provides\&. +.PP +For more information on the inhibition logic see the +\m[blue]\fBInhibitor Lock Developer Documentation\fR\m[]\&\s-2\u[2]\d\s+2\&. +.PP +If you are interested in writing a display manager that makes use of logind, please have look at +\m[blue]\fBWriting Display Managers\fR\m[]\&\s-2\u[3]\d\s+2\&. If you are interested in writing a desktop environment that makes use of logind, please have look at +\m[blue]\fBWriting Desktop Environments\fR\m[]\&\s-2\u[4]\d\s+2\&. +.SH "SEE ALSO" +.PP +\fBsystemd\fR(1), +\fBsystemd-user-sessions.service\fR(8), +\fBloginctl\fR(1), +\fBlogind.conf\fR(5), +\fBpam_systemd\fR(8), +\fBsd-login\fR(3) +.SH "NOTES" +.IP " 1." 4 +polkit +.RS 4 +\%https://www.freedesktop.org/wiki/Software/polkit +.RE +.IP " 2." 4 +Inhibitor Lock Developer Documentation +.RS 4 +\%https://www.freedesktop.org/wiki/Software/systemd/inhibit +.RE +.IP " 3." 4 +Writing Display Managers +.RS 4 +\%https://www.freedesktop.org/wiki/Software/systemd/writing-display-managers +.RE +.IP " 4." 4 +Writing Desktop Environments +.RS 4 +\%https://www.freedesktop.org/wiki/Software/systemd/writing-desktop-environments +.RE diff --git a/upstream/opensuse-leap-15-6/man8/systemd-machine-id-commit.service.8 b/upstream/opensuse-leap-15-6/man8/systemd-machine-id-commit.service.8 new file mode 100644 index 00000000..78d518eb --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/systemd-machine-id-commit.service.8 @@ -0,0 +1,59 @@ +'\" t +.TH "SYSTEMD\-MACHINE\-ID\-COMMIT\&.SERVICE" "8" "" "systemd 254" "systemd-machine-id-commit.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" +systemd-machine-id-commit.service \- Commit a transient machine ID to disk +.SH "SYNOPSIS" +.PP +systemd\-machine\-id\-commit\&.service +.SH "DESCRIPTION" +.PP +systemd\-machine\-id\-commit\&.service +is an early boot service responsible for committing transient +/etc/machine\-id +files to a writable disk file system\&. See +\fBmachine-id\fR(5) +for more information about machine IDs\&. +.PP +This service is started after +local\-fs\&.target +in case +/etc/machine\-id +is a mount point of its own (usually from a memory file system such as +"tmpfs") and /etc is writable\&. The service will invoke +\fBsystemd\-machine\-id\-setup \-\-commit\fR, which writes the current transient machine ID to disk and unmount the +/etc/machine\-id +file in a race\-free manner to ensure that file is always valid and accessible for other processes\&. See +\fBsystemd-machine-id-setup\fR(1) +for details\&. +.PP +The main use case of this service are systems where +/etc/machine\-id +is read\-only and initially not initialized\&. In this case, the system manager will generate a transient machine ID file on a memory file system, and mount it over +/etc/machine\-id, during the early boot phase\&. This service is then invoked in a later boot phase, as soon as +/etc/ +has been remounted writable and the ID may thus be committed to disk to make it permanent\&. +.SH "SEE ALSO" +.PP +\fBsystemd\fR(1), +\fBsystemd-machine-id-setup\fR(1), +\fBmachine-id\fR(5), +\fBsystemd-firstboot\fR(1) diff --git a/upstream/opensuse-leap-15-6/man8/systemd-machined.service.8 b/upstream/opensuse-leap-15-6/man8/systemd-machined.service.8 new file mode 100644 index 00000000..851bea14 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/systemd-machined.service.8 @@ -0,0 +1,206 @@ +'\" t +.TH "SYSTEMD\-MACHINED\&.SERVICE" "8" "" "systemd 254" "systemd-machined.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" +systemd-machined.service, systemd-machined \- Virtual machine and container registration manager +.SH "SYNOPSIS" +.PP +systemd\-machined\&.service +.PP +/usr/lib/systemd/systemd\-machined +.SH "DESCRIPTION" +.PP +\fBsystemd\-machined\fR +is a system service that keeps track of locally running virtual machines and containers\&. +.PP +\fBsystemd\-machined\fR +is useful for registering and keeping track of both OS containers (containers that share the host kernel but run a full init system of their own and behave in most regards like a full virtual operating system rather than just one virtualized app) and full virtual machines (virtualized hardware running normal operating systems and possibly different kernels)\&. +.PP +\fBsystemd\-machined\fR +should +\fInot\fR +be used for registering/keeping track of application sandbox containers\&. A +\fImachine\fR +in the context of +\fBsystemd\-machined\fR +is supposed to be an abstract term covering both OS containers and full virtual machines, but not application sandboxes\&. +.PP +Machines registered with machined are exposed in various ways in the system\&. For example: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Tools like +\fBps\fR(1) +will show to which machine a specific process belongs in a column of its own, and so will +\m[blue]\fBgnome\-system\-monitor\fR\m[]\&\s-2\u[1]\d\s+2 +or +\fBsystemd-cgls\fR(1)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +systemd\*(Aqs various tools (\fBsystemctl\fR(1), +\fBjournalctl\fR(1), +\fBloginctl\fR(1), +\fBhostnamectl\fR(1), +\fBtimedatectl\fR(1), +\fBlocalectl\fR(1), +\fBmachinectl\fR(1), \&.\&.\&.) support the +\fB\-M\fR +switch to operate on local containers instead of the host system\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBsystemctl list\-machines\fR +will show the system state of all local containers, connecting to the container\*(Aqs init system for that\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +systemctl\*(Aqs +\fB\-\-recursive\fR +switch has the effect of not only showing the locally running services, but recursively showing the services of all registered containers\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +The +\fBmachinectl\fR +command provides access to a number of useful operations on registered containers, such as introspecting them, rebooting, shutting them down, and getting a login prompt on them\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +The +\fBsd-bus\fR(3) +library exposes the +\fBsd_bus_open_system_machine\fR(3) +call to connect to the system bus of any registered container\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +The +\fBnss-mymachines\fR(8) +module makes sure all registered containers can be resolved via normal glibc +\fBgethostbyname\fR(3) +or +\fBgetaddrinfo\fR(3) +calls\&. +.RE +.PP +See +\fBsystemd-nspawn\fR(1) +for some examples on how to run containers with OS tools\&. +.PP +If you are interested in writing a VM or container manager that makes use of machined, please have look at +\m[blue]\fBWriting Virtual Machine or Container Managers\fR\m[]\&\s-2\u[2]\d\s+2\&. Also see the +\m[blue]\fBNew Control Group Interfaces\fR\m[]\&\s-2\u[3]\d\s+2\&. +.PP +The daemon provides both a C library interface (which is shared with +\fBsystemd-logind.service\fR(8)) as well as a D\-Bus interface\&. The library interface may be used to introspect and watch the state of virtual machines/containers\&. The bus interface provides the same but in addition may also be used to register or terminate machines\&. For more information please consult +\fBsd-login\fR(3) +and +\fBorg.freedesktop.machine1\fR(5) +and +\fBorg.freedesktop.LogControl1\fR(5)\&. +.PP +A small companion daemon +\fBsystemd-importd.service\fR(8) +is also available, which implements importing, exporting, and downloading of container and VM images\&. +.PP +For each container registered with +systemd\-machined\&.service +that employs user namespacing, users/groups are synthesized for the used UIDs/GIDs\&. These are made available to the system using the +\m[blue]\fBUser/Group Record Lookup API via Varlink\fR\m[]\&\s-2\u[4]\d\s+2, and thus may be resolved with +\fBuserdbctl\fR(1) +or the usual glibc NSS calls\&. +.SH "SEE ALSO" +.PP +\fBsystemd\fR(1), +\fBmachinectl\fR(1), +\fBsystemd-nspawn\fR(1), +\fBnss-mymachines\fR(8), +\fBsystemd.special\fR(7) +.SH "NOTES" +.IP " 1." 4 +gnome-system-monitor +.RS 4 +\%https://help.gnome.org/users/gnome-system-monitor/ +.RE +.IP " 2." 4 +Writing Virtual Machine or Container Managers +.RS 4 +\%https://www.freedesktop.org/wiki/Software/systemd/writing-vm-managers +.RE +.IP " 3." 4 +New Control Group Interfaces +.RS 4 +\%https://www.freedesktop.org/wiki/Software/systemd/ControlGroupInterface +.RE +.IP " 4." 4 +User/Group Record Lookup API via Varlink +.RS 4 +\%https://systemd.io/USER_GROUP_API +.RE diff --git a/upstream/opensuse-leap-15-6/man8/systemd-poweroff.service.8 b/upstream/opensuse-leap-15-6/man8/systemd-poweroff.service.8 new file mode 100644 index 00000000..e5ae5eda --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/systemd-poweroff.service.8 @@ -0,0 +1,93 @@ +'\" t +.TH "SYSTEMD\-POWEROFF\&.SERVICE" "8" "" "systemd 254" "systemd-poweroff.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" +systemd-poweroff.service, systemd-halt.service, systemd-reboot.service, systemd-kexec.service, systemd-shutdown \- System shutdown logic +.SH "SYNOPSIS" +.PP +systemd\-poweroff\&.service +.PP +systemd\-halt\&.service +.PP +systemd\-reboot\&.service +.PP +systemd\-kexec\&.service +.PP +/usr/lib/systemd/systemd\-shutdown +.PP +/usr/lib/systemd/system\-shutdown/ +.SH "DESCRIPTION" +.PP +systemd\-poweroff\&.service +is a system service that is pulled in by +poweroff\&.target +and is responsible for the actual system power\-off operation\&. Similarly, +systemd\-halt\&.service +is pulled in by +halt\&.target, +systemd\-reboot\&.service +by +reboot\&.target +and +systemd\-kexec\&.service +by +kexec\&.target +to execute the respective actions\&. +.PP +When these services are run, they ensure that PID 1 is replaced by the +/usr/lib/systemd/systemd\-shutdown +tool which is then responsible for the actual shutdown\&. Before shutting down, this binary will try to unmount all remaining file systems (or at least remount them read\-only), disable all remaining swap devices, detach all remaining storage devices and kill all remaining processes\&. +.PP +It is necessary to have this code in a separate binary because otherwise rebooting after an upgrade might be broken\ \&\(em the running PID 1 could still depend on libraries which are not available any more, thus keeping the file system busy, which then cannot be re\-mounted read\-only\&. +.PP +Shortly before executing the actual system power\-off/halt/reboot/kexec +systemd\-shutdown +will run all executables in +/usr/lib/systemd/system\-shutdown/ +and pass one arguments to them: either +"poweroff", +"halt", +"reboot", or +"kexec", depending on the chosen action\&. All executables in this directory are executed in parallel, and execution of the action is not continued before all executables finished\&. Note that these executables are run +\fIafter\fR +all services have been shut down, and after most mounts have been detached (the root file system as well as +/run/ +and various API file systems are still around though)\&. This means any programs dropped into this directory must be prepared to run in such a limited execution environment and not rely on external services or hierarchies such as +/var/ +to be around (or writable)\&. +.PP +Note that +systemd\-poweroff\&.service +(and the related units) should never be executed directly\&. Instead, trigger system shutdown with a command such as +"systemctl poweroff"\&. +.PP +Another form of shutdown is provided by the +\fBsystemd-soft-reboot.service\fR(8) +functionality\&. It reboots only the OS userspace, leaving the kernel, firmware, and hardware as it is\&. +.SH "SEE ALSO" +.PP +\fBsystemd\fR(1), +\fBsystemctl\fR(1), +\fBsystemd.special\fR(7), +\fBreboot\fR(2), +\fBsystemd-suspend.service\fR(8), +\fBsystemd-soft-reboot.service\fR(8), +\fBbootup\fR(7) diff --git a/upstream/opensuse-leap-15-6/man8/systemd-run-generator.8 b/upstream/opensuse-leap-15-6/man8/systemd-run-generator.8 new file mode 100644 index 00000000..01d0fd45 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/systemd-run-generator.8 @@ -0,0 +1,89 @@ +'\" t +.TH "SYSTEMD\-RUN\-GENERATOR" "8" "" "systemd 254" "systemd-run-generator" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +systemd-run-generator \- Generator for invoking commands specified on the kernel command line as system service +.SH "SYNOPSIS" +.PP +/usr/lib/systemd/system\-generators/systemd\-run\-generator +.SH "DESCRIPTION" +.PP +systemd\-run\-generator +is a generator that reads the kernel command line and understands three options: +.PP +If the +\fBsystemd\&.run=\fR +option is specified and followed by a command line, a unit named +kernel\-command\-line\&.service +is generated for it and booted into\&. The service has +\fIType=oneshot\fR +set, and has +\fISuccessAction=exit\fR +and +\fIFailureAction=exit\fR +configured by default, thus ensuring that the system is shut down as soon as the command completes\&. The exit status of the command line is propagated to the invoking container manager, if this applies (which might propagate this further, to the calling shell \(em e\&.g\&. +\fBsystemd-nspawn\fR(7) +does this)\&. If this option is used multiple times the unit file will contain multiple +\fIExecStart=\fR +lines, to execute all commands in order\&. The command is started as regular service, i\&.e\&. with +\fIDefaultDependencies=\fR +on\&. +.PP +Use +\fBsystemd\&.run_success_action=\fR +and +\fBsystemd\&.run_failure_action=\fR +to tweak how to react to the process completing\&. In particular assigning +"none" +will leave the system running after the command completes\&. For further details on supported arguments, see +\fBsystemd.unit\fR(5)\&. +.PP +systemd\-run\-generator +implements +\fBsystemd.generator\fR(7)\&. +.SH "EXAMPLE" +.PP +Use a command like the following to add a user to the user database inside a container run with +\fBsystemd-nspawn\fR(7): +.sp +.if n \{\ +.RS 4 +.\} +.nf +# systemd\-nspawn \-D mycontainer \-b systemd\&.run=\*(Aq"adduser test"\*(Aq +.fi +.if n \{\ +.RE +.\} +.PP +(Note the requirement for double quoting in the command line above\&. The first level of quoting (\*(Aq\*(Aq) is processed and removed by the command shell used to invoke +\fBsystemd\-nspawn\fR\&. The second level of quoting ("") is propagated to the kernel command line of the container and processed and removed by +\fBsystemd\-run\-generator\fR\&. Both together make sure both words of the specified command line +\fBadduser test\fR +end up in the generated unit file together and are neither split apart by the command shell nor by the generator\&.) +.SH "SEE ALSO" +.PP +\fBsystemd\fR(1), +\fBsystemctl\fR(1), +\fBkernel-command-line\fR(7), +\fBsystemd-nspawn\fR(7), +\fBsystemd.unit\fR(5), +\fBsystemd.service\fR(5) diff --git a/upstream/opensuse-leap-15-6/man8/systemd-socket-proxyd.8 b/upstream/opensuse-leap-15-6/man8/systemd-socket-proxyd.8 new file mode 100644 index 00000000..909910cb --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/systemd-socket-proxyd.8 @@ -0,0 +1,234 @@ +'\" t +.TH "SYSTEMD\-SOCKET\-PROXYD" "8" "" "systemd 254" "systemd-socket-proxyd" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +systemd-socket-proxyd \- Bidirectionally proxy local sockets to another (possibly remote) socket +.SH "SYNOPSIS" +.HP \w'\fBsystemd\-socket\-proxyd\fR\ 'u +\fBsystemd\-socket\-proxyd\fR [\fIOPTIONS\fR...] \fIHOST\fR:\fIPORT\fR +.HP \w'\fBsystemd\-socket\-proxyd\fR\ 'u +\fBsystemd\-socket\-proxyd\fR [\fIOPTIONS\fR...] \fIUNIX\-DOMAIN\-SOCKET\-PATH\fR +.SH "DESCRIPTION" +.PP +\fBsystemd\-socket\-proxyd\fR +is a generic socket\-activated network socket forwarder proxy daemon for IPv4, IPv6 and UNIX stream sockets\&. It may be used to bi\-directionally forward traffic from a local listening socket to a local or remote destination socket\&. +.PP +One use of this tool is to provide socket activation support for services that do not natively support socket activation\&. On behalf of the service to activate, the proxy inherits the socket from systemd, accepts each client connection, opens a connection to a configured server for each client, and then bidirectionally forwards data between the two\&. +.PP +This utility\*(Aqs behavior is similar to +\fBsocat\fR(1)\&. The main differences for +\fBsystemd\-socket\-proxyd\fR +are support for socket activation with +"Accept=no" +and an event\-driven design that scales better with the number of connections\&. +.SH "OPTIONS" +.PP +The following options are understood: +.PP +\fB\-h\fR, \fB\-\-help\fR +.RS 4 +Print a short help text and exit\&. +.RE +.PP +\fB\-\-version\fR +.RS 4 +Print a short version string and exit\&. +.RE +.PP +\fB\-\-connections\-max=\fR, \fB\-c\fR +.RS 4 +Sets the maximum number of simultaneous connections, defaults to 256\&. If the limit of concurrent connections is reached further connections will be refused\&. +.RE +.PP +\fB\-\-exit\-idle\-time=\fR +.RS 4 +Sets the time before exiting when there are no connections, defaults to +\fBinfinity\fR\&. Takes a unit\-less value in seconds, or a time span value such as +"5min 20s"\&. +.RE +.SH "EXIT STATUS" +.PP +On success, 0 is returned, a non\-zero failure code otherwise\&. +.SH "EXAMPLES" +.SS "Simple Example" +.PP +Use two services with a dependency and no namespace isolation\&. +.PP +\fBExample\ \&1.\ \&proxy\-to\-nginx\&.socket\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf +[Socket] +ListenStream=80 + +[Install] +WantedBy=sockets\&.target +.fi +.if n \{\ +.RE +.\} +.PP +\fBExample\ \&2.\ \&proxy\-to\-nginx\&.service\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf +[Unit] +Requires=nginx\&.service +After=nginx\&.service +Requires=proxy\-to\-nginx\&.socket +After=proxy\-to\-nginx\&.socket + +[Service] +Type=notify +ExecStart=/usr/lib/systemd/systemd\-socket\-proxyd /run/nginx/socket +PrivateTmp=yes +PrivateNetwork=yes +.fi +.if n \{\ +.RE +.\} +.PP +\fBExample\ \&3.\ \&nginx\&.conf\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf +[\&...] +server { + listen unix:/run/nginx/socket; + [\&...] +.fi +.if n \{\ +.RE +.\} +.PP +\fBExample\ \&4.\ \&Enabling the proxy\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf +# systemctl enable \-\-now proxy\-to\-nginx\&.socket +$ curl http://localhost:80/ +.fi +.if n \{\ +.RE +.\} +.PP +If +nginx\&.service +has +\fIStopWhenUnneeded=\fR +set, then passing +\fB\-\-exit\-idle\-time=\fR +to +\fBsystemd\-socket\-proxyd\fR +allows both services to stop during idle periods\&. +.SS "Namespace Example" +.PP +Similar as above, but runs the socket proxy and the main service in the same private namespace, assuming that +nginx\&.service +has +\fIPrivateTmp=\fR +and +\fIPrivateNetwork=\fR +set, too\&. +.PP +\fBExample\ \&5.\ \&proxy\-to\-nginx\&.socket\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf +[Socket] +ListenStream=80 + +[Install] +WantedBy=sockets\&.target +.fi +.if n \{\ +.RE +.\} +.PP +\fBExample\ \&6.\ \&proxy\-to\-nginx\&.service\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf +[Unit] +Requires=nginx\&.service +After=nginx\&.service +Requires=proxy\-to\-nginx\&.socket +After=proxy\-to\-nginx\&.socket +JoinsNamespaceOf=nginx\&.service + +[Service] +Type=notify +ExecStart=/usr/lib/systemd/systemd\-socket\-proxyd 127\&.0\&.0\&.1:8080 +PrivateTmp=yes +PrivateNetwork=yes +.fi +.if n \{\ +.RE +.\} +.PP +\fBExample\ \&7.\ \&nginx\&.conf\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf +[\&...] +server { + listen 8080; + [\&...] +.fi +.if n \{\ +.RE +.\} +.PP +\fBExample\ \&8.\ \&Enabling the proxy\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf +# systemctl enable \-\-now proxy\-to\-nginx\&.socket +$ curl http://localhost:80/ +.fi +.if n \{\ +.RE +.\} +.SH "SEE ALSO" +.PP +\fBsystemd\fR(1), +\fBsystemd.socket\fR(5), +\fBsystemd.service\fR(5), +\fBsystemctl\fR(1), +\fBsocat\fR(1), +\fBnginx\fR(1), +\fBcurl\fR(1) diff --git a/upstream/opensuse-leap-15-6/man8/systemd-soft-reboot.service.8 b/upstream/opensuse-leap-15-6/man8/systemd-soft-reboot.service.8 new file mode 100644 index 00000000..84476beb --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/systemd-soft-reboot.service.8 @@ -0,0 +1,266 @@ +'\" t +.TH "SYSTEMD\-SOFT\-REBOOT\&.SERVICE" "8" "" "systemd 254" "systemd-soft-reboot.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" +systemd-soft-reboot.service \- Userspace reboot operation +.SH "SYNOPSIS" +.PP +systemd\-soft\-reboot\&.service +.SH "DESCRIPTION" +.PP +systemd\-soft\-reboot\&.service +is a system service that is pulled in by +soft\-reboot\&.target +and is responsible for performing a userspace\-only reboot operation\&. When invoked, it will send the +\fBSIGTERM\fR +signal to any processes left running (but does not follow up with +\fBSIGKILL\fR, and does not wait for the processes to exit)\&. If the +/run/nextroot/ +directory exists (which may be a regular directory, a directory mount point or a symlink to either) then it will switch the file system root to it\&. It then reexecutes the service manager off the (possibly now new) root file system, which will enqueue a new boot transaction as in a normal reboot\&. +.PP +Such a userspace\-only reboot operation permits updating or resetting the entirety of userspace with minimal downtime, as the reboot operation does +\fInot\fR +transition through: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +The second phase of regular shutdown, as implemented by +\fBsystemd-shutdown\fR(8)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +The third phase of regular shutdown, i\&.e\&. the return to the initrd context +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +The hardware reboot operation +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +The firmware initialization +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +The boot loader initialization +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +The kernel initialization +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +The initrd initialization +.RE +.PP +However this form of reboot comes with drawbacks as well: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +The OS update remains incomplete, as the kernel is not reset and continues running\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Kernel settings (such as +/proc/sys/ +settings, a\&.k\&.a\&. "sysctl", or +/sys/ +settings) are not reset\&. +.RE +.PP +These limitations may be addressed by various means, which are outside of the scope of this documentation, such as kernel live\-patching and sufficiently comprehensive +/etc/sysctl\&.d/ +files\&. +.SH "RESOURCE PASS\-THROUGH" +.PP +Various runtime OS resources can passed from a system runtime to the next, through the userspace reboot operation\&. Specifically: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +File descriptors placed in the file descriptor store of services that remain active until the very end are passed to the next boot, where they are placed in the file descriptor store of the same unit\&. For this to work, units must declare +\fIDefaultDependencies=no\fR +(and avoid a manual +\fIConflicts=shutdown\&.target\fR +or similar) to ensure they are not terminated as usual during the system shutdown operation\&. Alternatively, use +\fIFileDescriptorStorePreserve=\fR +to allow the file descriptor store to remain pinned even when the unit is down\&. See +\fBsystemd.service\fR(5) +for details about the file descriptor store\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Similar to this, file descriptors associated with +\&.socket +units remain open (and connectible) if the units are not stopped during the transition\&. (Achieved by +\fIDefaultDependencies=no\fR\&.) +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +The +/run/ +file system remains mounted and populated and may be used to pass state information between such userspace reboot cycles\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Service processes may continue to run over the transition, if they are placed in services that remain active until the very end of shutdown (which again is achieved via +\fIDefaultDependencies=no\fR)\&. They must also be set up to avoid being killed by the aforementioned +\fBSIGTERM\fR +spree (as per +\m[blue]\fBsystemd and Storage Daemons for the Root File System\fR\m[]\&\s-2\u[1]\d\s+2)\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +File system mounts may remain mounted during the transition, and complex storage attached, if configured to remain until the very end of the shutdown process\&. (Also achieved via +\fIDefaultDependencies=no\fR, and by avoiding +\fIConflicts=umount\&.target\fR) +.RE +.PP +Even though passing resources from one soft reboot cycle to the next is possible this way, we strongly suggest to use this functionality sparingly only, as it creates a more fragile system as resources from different versions of the OS and applications might be mixed with unforeseen consequences\&. In particular it\*(Aqs recommended to +\fIavoid\fR +allowing processes to survive the soft reboot operation, as this means code updates will necessarily be incomplete, and processes typically pin various other resources (such as the file system they are backed by), thus increasing memory usage (as two versions of the OS/application/file system might be kept in memory)\&. Leaving processes running during a soft\-reboot operation requires disconnecting the service comprehensively from the rest of the OS, i\&.e\&. minimizing IPC and reducing sharing of resources with the rest of the OS\&. A possible mechanism to achieve this is the concept of +\m[blue]\fBPortable Services\fR\m[]\&\s-2\u[2]\d\s+2, but make sure no resource from the host\*(Aqs OS filesystems is pinned via +\fIBindPaths=\fR +or similar unit settings, otherwise the old, originating filesystem will remain mounted as long as the unit is running\&. +.SH "NOTES" +.PP +Note that because +\fBsystemd-shutdown\fR(8) +is not executed, the executables in +/usr/lib/systemd/system\-shutdown/ +are not executed either\&. +.PP +Note that +systemd\-soft\-reboot\&.service +(and related units) should never be executed directly\&. Instead, trigger system shutdown with a command such as +"systemctl soft\-reboot"\&. +.SH "SEE ALSO" +.PP +\fBsystemd\fR(1), +\fBsystemctl\fR(1), +\fBsystemd.special\fR(7), +\fBsystemd-poweroff.service\fR(8), +\fBsystemd-suspend.service\fR(8), +\fBbootup\fR(7) +.SH "NOTES" +.IP " 1." 4 +systemd and Storage Daemons for the Root File System +.RS 4 +\%https://systemd.io/ROOT_STORAGE_DAEMONS +.RE +.IP " 2." 4 +Portable Services +.RS 4 +\%https://systemd.io/PORTABLE_SERVICES +.RE diff --git a/upstream/opensuse-leap-15-6/man8/systemd-sysctl.service.8 b/upstream/opensuse-leap-15-6/man8/systemd-sysctl.service.8 new file mode 100644 index 00000000..108c38c3 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/systemd-sysctl.service.8 @@ -0,0 +1,173 @@ +'\" t +.TH "SYSTEMD\-SYSCTL\&.SERVICE" "8" "" "systemd 254" "systemd-sysctl.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" +systemd-sysctl.service, systemd-sysctl \- Configure kernel parameters at boot +.SH "SYNOPSIS" +.HP \w'\fB/usr/lib/systemd/systemd\-sysctl\fR\ 'u +\fB/usr/lib/systemd/systemd\-sysctl\fR [OPTIONS...] [\fICONFIGFILE\fR...] +.PP +systemd\-sysctl\&.service +.SH "DESCRIPTION" +.PP +systemd\-sysctl\&.service +is an early boot service that configures +\fBsysctl\fR(8) +kernel parameters by invoking +\fB/usr/lib/systemd/systemd\-sysctl\fR\&. +.PP +When invoked with no arguments, +\fB/usr/lib/systemd/systemd\-sysctl\fR +applies all directives from configuration files listed in +\fBsysctl.d\fR(5)\&. If one or more filenames are passed on the command line, only the directives in these files are applied\&. +.PP +In addition, +\fB\-\-prefix=\fR +option may be used to limit which sysctl settings are applied\&. +.PP +See +\fBsysctl.d\fR(5) +for information about the configuration of sysctl settings\&. After sysctl configuration is changed on disk, it must be written to the files in +/proc/sys/ +before it takes effect\&. It is possible to update specific settings, or simply to reload all configuration, see Examples below\&. +.SH "OPTIONS" +.PP +\fB\-\-prefix=\fR +.RS 4 +Only apply rules with the specified prefix\&. +.RE +.PP +\fB\-\-strict=\fR +.RS 4 +Always return non\-zero exit code on failure (including invalid sysctl variable name and insufficient permissions), unless the sysctl variable name is prefixed with a "\-" character\&. +.RE +.PP +\fB\-\-cat\-config\fR +.RS 4 +Copy the contents of config files to standard output\&. Before each file, the filename is printed as a comment\&. +.RE +.PP +\fB\-\-no\-pager\fR +.RS 4 +Do not pipe output into a pager\&. +.RE +.PP +\fB\-h\fR, \fB\-\-help\fR +.RS 4 +Print a short help text and exit\&. +.RE +.PP +\fB\-\-version\fR +.RS 4 +Print a short version string and exit\&. +.RE +.SH "CREDENTIALS" +.PP +\fBsystemd\-sysctl\fR +supports the service credentials logic as implemented by +\fIImportCredential=\fR/\fILoadCredential=\fR/\fISetCredential=\fR +(see +\fBsystemd.exec\fR(1) +for details)\&. The following credentials are used when passed in: +.PP +\fIsysctl\&.extra\fR +.RS 4 +The contents of this credential may contain additional lines to operate on\&. The credential contents should follow the same format as any other +sysctl\&.d/ +drop\-in configuration file\&. If this credential is passed it is processed after all of the drop\-in files read from the file system\&. The settings configured in the credential hence take precedence over those in the file system\&. +.RE +.PP +Note that by default the +systemd\-sysctl\&.service +unit file is set up to inherit the +"sysctl\&.extra" +credential from the service manager\&. +.SH "EXAMPLES" +.PP +\fBExample\ \&1.\ \&Reset all sysctl settings\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf +systemctl restart systemd\-sysctl +.fi +.if n \{\ +.RE +.\} +.PP +\fBExample\ \&2.\ \&View coredump handler configuration\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf +# sysctl kernel\&.core_pattern +kernel\&.core_pattern = |/usr/libexec/abrt\-hook\-ccpp %s %c %p %u %g %t %P %I +.fi +.if n \{\ +.RE +.\} +.PP +\fBExample\ \&3.\ \&Update coredump handler configuration\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf +# /usr/lib/systemd/systemd\-sysctl \-\-prefix kernel\&.core_pattern +.fi +.if n \{\ +.RE +.\} +.PP +This searches all the directories listed in +\fBsysctl.d\fR(5) +for configuration files and writes +/proc/sys/kernel/core_pattern\&. +.PP +\fBExample\ \&4.\ \&Update coredump handler configuration according to a specific file\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf +# /usr/lib/systemd/systemd\-sysctl 50\-coredump\&.conf +.fi +.if n \{\ +.RE +.\} +.PP +This applies all the settings found in +50\-coredump\&.conf\&. Either +/etc/sysctl\&.d/50\-coredump\&.conf, or +/run/sysctl\&.d/50\-coredump\&.conf, or +/usr/lib/sysctl\&.d/50\-coredump\&.conf +will be used, in the order of preference\&. +.PP +See +\fBsysctl\fR(8) +for various ways to directly apply sysctl settings\&. +.SH "SEE ALSO" +.PP +\fBsystemd\fR(1), +\fBsysctl.d\fR(5), +\fBsysctl\fR(8) diff --git a/upstream/opensuse-leap-15-6/man8/systemd-sysext.8 b/upstream/opensuse-leap-15-6/man8/systemd-sysext.8 new file mode 100644 index 00000000..7a498533 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/systemd-sysext.8 @@ -0,0 +1,414 @@ +'\" t +.TH "SYSTEMD\-SYSEXT" "8" "" "systemd 254" "systemd-sysext" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +systemd-sysext, systemd-sysext.service, systemd-confext, systemd-confext.service \- Activates System Extension Images +.SH "SYNOPSIS" +.HP \w'\fBsystemd\-sysext\fR\ 'u +\fBsystemd\-sysext\fR [OPTIONS...] COMMAND +.PP +.nf +systemd\-sysext\&.service +.fi +.HP \w'\fBsystemd\-confext\fR\ 'u +\fBsystemd\-confext\fR [OPTIONS...] COMMAND +.PP +.nf +systemd\-confext\&.service +.fi +.SH "DESCRIPTION" +.PP +\fBsystemd\-sysext\fR +activates/deactivates system extension images\&. System extension images may \(en dynamically at runtime \(em extend the +/usr/ +and +/opt/ +directory hierarchies with additional files\&. This is particularly useful on immutable system images where a +/usr/ +and/or +/opt/ +hierarchy residing on a read\-only file system shall be extended temporarily at runtime without making any persistent modifications\&. +.PP +System extension images should contain files and directories similar in fashion to regular operating system tree\&. When one or more system extension images are activated, their +/usr/ +and +/opt/ +hierarchies are combined via +"overlayfs" +with the same hierarchies of the host OS, and the host +/usr/ +and +/opt/ +overmounted with it ("merging")\&. When they are deactivated, the mount point is disassembled \(em again revealing the unmodified original host version of the hierarchy ("unmerging")\&. Merging thus makes the extension\*(Aqs resources suddenly appear below the +/usr/ +and +/opt/ +hierarchies as if they were included in the base OS image itself\&. Unmerging makes them disappear again, leaving in place only the files that were shipped with the base OS image itself\&. +.PP +Files and directories contained in the extension images outside of the +/usr/ +and +/opt/ +hierarchies are +\fInot\fR +merged, and hence have no effect when included in a system extension image\&. In particular, files in the +/etc/ +and +/var/ +included in a system extension image will +\fInot\fR +appear in the respective hierarchies after activation\&. +.PP +System extension images are strictly read\-only, and the host +/usr/ +and +/opt/ +hierarchies become read\-only too while they are activated\&. +.PP +System extensions are supposed to be purely additive, i\&.e\&. they are supposed to include only files that do not exist in the underlying basic OS image\&. However, the underlying mechanism (overlayfs) also allows overlaying or removing files, but it is recommended not to make use of this\&. +.PP +System extension images may be provided in the following formats: +.sp +.RS 4 +.ie n \{\ +\h'-04' 1.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 1." 4.2 +.\} +Plain directories or btrfs subvolumes containing the OS tree +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04' 2.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 2." 4.2 +.\} +Disk images with a GPT disk label, following the +\m[blue]\fBDiscoverable Partitions Specification\fR\m[]\&\s-2\u[1]\d\s+2 +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04' 3.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 3." 4.2 +.\} +Disk images lacking a partition table, with a naked Linux file system (e\&.g\&. erofs, squashfs or ext4) +.RE +.PP +These image formats are the same ones that +\fBsystemd-nspawn\fR(1) +supports via its +\fB\-\-directory=\fR/\fB\-\-image=\fR +switches and those that the service manager supports via +\fBRootDirectory=\fR/\fBRootImage=\fR\&. Similar to them they may optionally carry Verity authentication information\&. +.PP +System extensions are searched for in the directories +/etc/extensions/, +/run/extensions/ +and +/var/lib/extensions/\&. The first two listed directories are not suitable for carrying large binary images, however are still useful for carrying symlinks to them\&. The primary place for installing system extensions is +/var/lib/extensions/\&. Any directories found in these search directories are considered directory based extension images; any files with the +\&.raw +suffix are considered disk image based extension images\&. When invoked in the initrd, the additional directory +/\&.extra/sysext/ +is included in the directories that are searched for extension images\&. Note however, that by default a tighter image policy applies to images found there, though, see below\&. This directory is populated by +\fBsystemd-stub\fR(7) +with extension images found in the system\*(Aqs EFI System Partition\&. +.PP +During boot OS extension images are activated automatically, if the +systemd\-sysext\&.service +is enabled\&. Note that this service runs only after the underlying file systems where system extensions may be located have been mounted\&. This means they are not suitable for shipping resources that are processed by subsystems running in earliest boot\&. Specifically, OS extension images are not suitable for shipping system services or +\fBsystemd-sysusers\fR(8) +definitions\&. See the +\m[blue]\fBPortable Services Documentation\fR\m[]\&\s-2\u[2]\d\s+2 +for a simple mechanism for shipping system services in disk images, in a similar fashion to OS extensions\&. Note the different isolation on these two mechanisms: while system extension directly extend the underlying OS image with additional files that appear in a way very similar to as if they were shipped in the OS image itself and thus imply no security isolation, portable services imply service level sandboxing in one way or another\&. The +systemd\-sysext\&.service +service is guaranteed to finish start\-up before +basic\&.target +is reached; i\&.e\&. at the time regular services initialize (those which do not use +\fIDefaultDependencies=no\fR), the files and directories system extensions provide are available in +/usr/ +and +/opt/ +and may be accessed\&. +.PP +Note that there is no concept of enabling/disabling installed system extension images: all installed extension images are automatically activated at boot\&. However, you can place an empty directory named like the extension (no +\&.raw) in +/etc/extensions/ +to "mask" an extension with the same name in a system folder with lower precedence\&. +.PP +A simple mechanism for version compatibility is enforced: a system extension image must carry a +/usr/lib/extension\-release\&.d/extension\-release\&.\fI$name\fR +file, which must match its image name, that is compared with the host +os\-release +file: the contained +\fIID=\fR +fields have to match unless +"_any" +is set for the extension\&. If the extension +\fIID=\fR +is not +"_any", the +\fISYSEXT_LEVEL=\fR +field (if defined) has to match\&. If the latter is not defined, the +\fIVERSION_ID=\fR +field has to match instead\&. If the extension defines the +\fIARCHITECTURE=\fR +field and the value is not +"_any" +it has to match the kernel\*(Aqs architecture reported by +\fBuname\fR(2) +but the used architecture identifiers are the same as for +\fIConditionArchitecture=\fR +described in +\fBsystemd.unit\fR(5)\&. System extensions should not ship a +/usr/lib/os\-release +file (as that would be merged into the host +/usr/ +tree, overriding the host OS version data, which is not desirable)\&. The +extension\-release +file follows the same format and semantics, and carries the same content, as the +os\-release +file of the OS, but it describes the resources carried in the extension image\&. +.PP +The +\fBsystemd\-confext\fR +concept follows the same principle as the +\fBsystemd-sysext\fR(1) +functionality but instead of working on +/usr +and +/opt, +\fBconfext\fR +will extend only +/etc\&. Files and directories contained in the confext images outside of the +/etc/ +hierarchy are +\fInot\fR +merged, and hence have no effect when included in the image\&. Formats for these images are of the same as sysext images\&. The merged hierarchy will be mounted with +"nosuid" +and (if not disabled via +\fB\-\-noexec=false\fR) +"noexec"\&. +.PP +Confexts are looked for in the directories +/run/confexts/, +/var/lib/confexts/, +/usr/lib/confexts/ +and +/usr/local/lib/confexts/\&. The first listed directory is not suitable for carrying large binary images, however is still useful for carrying symlinks to them\&. The primary place for installing configuration extensions is +/var/lib/confexts/\&. Any directories found in these search directories are considered directory based confext images; any files with the +\&.raw +suffix are considered disk image based confext images\&. +.PP +Again, just like sysext images, the confext images will contain a +/etc/extension\-release\&.d/extension\-release\&.\fI$name\fR +file, which must match the image name (with the usual escape hatch of xattr), and again with content being one or more of +\fIID=\fR, +\fIVERSION_ID=\fR, and +\fICONFEXT_LEVEL\fR\&. Confext images will then be checked and matched against the base OS layer\&. +.SH "USES" +.PP +The primary use case for system images are immutable environments where debugging and development tools shall optionally be made available, but not included in the immutable base OS image itself (e\&.g\&. +\fBstrace\fR(1) +and +\fBgdb\fR(1) +shall be an optionally installable addition in order to make debugging/development easier)\&. System extension images should not be misunderstood as a generic software packaging framework, as no dependency scheme is available: system extensions should carry all files they need themselves, except for those already shipped in the underlying host system image\&. Typically, system extension images are built at the same time as the base OS image \(em within the same build system\&. +.PP +Another use case for the system extension concept is temporarily overriding OS supplied resources with newer ones, for example to install a locally compiled development version of some low\-level component over the immutable OS image without doing a full OS rebuild or modifying the nominally immutable image\&. (e\&.g\&. "install" a locally built package with +\fBDESTDIR=/var/lib/extensions/mytest make install && systemd\-sysext refresh\fR, making it available in +/usr/ +as if it was installed in the OS image itself\&.) This case works regardless if the underlying host +/usr/ +is managed as immutable disk image or is a traditional package manager controlled (i\&.e\&. writable) tree\&. +.PP +For the confext case, the OSConfig project aims to perform runtime reconfiguration of OS services\&. Sometimes, there is a need to swap certain configuration parameter values or restart only a specific service without deployment of new code or a complete OS deployment\&. In other words, we want to be able to tie the most frequently configured options to runtime updateable flags that can be changed without a system reboot\&. This will help reduce servicing times when there is a need for changing the OS configuration\&. +.SH "COMMANDS" +.PP +The following commands are understood by both the sysext and confext concepts: +.PP +\fBstatus\fR +.RS 4 +When invoked without any command verb, or when +\fBstatus\fR +is specified the current merge status is shown, separately (for both +/usr/ +and +/opt/ +of sysext and for +/etc/ +of confext)\&. +.RE +.PP +\fBmerge\fR +.RS 4 +Merges all currently installed system extension images into +/usr/ +and +/opt/, by overmounting these hierarchies with an +"overlayfs" +file system combining the underlying hierarchies with those included in the extension images\&. This command will fail if the hierarchies are already merged\&. For confext, the merge happens into the +/etc/ +directory instead\&. +.RE +.PP +\fBunmerge\fR +.RS 4 +Unmerges all currently installed system extension images from +/usr/ +and +/opt/ +for sysext and +/etc/, for confext, by unmounting the +"overlayfs" +file systems created by +\fBmerge\fR +prior\&. +.RE +.PP +\fBrefresh\fR +.RS 4 +A combination of +\fBunmerge\fR +and +\fBmerge\fR: if already mounted the existing +"overlayfs" +instance is unmounted temporarily, and then replaced by a new version\&. This command is useful after installing/removing system extension images, in order to update the +"overlayfs" +file system accordingly\&. If no system extensions are installed when this command is executed, the equivalent of +\fBunmerge\fR +is executed, without establishing any new +"overlayfs" +instance\&. Note that currently there\*(Aqs a brief moment where neither the old nor the new +"overlayfs" +file system is mounted\&. This implies that all resources supplied by a system extension will briefly disappear \(em even if it exists continuously during the refresh operation\&. +.RE +.PP +\fBlist\fR +.RS 4 +A brief list of installed extension images is shown\&. +.RE +.PP +\fB\-h\fR, \fB\-\-help\fR +.RS 4 +Print a short help text and exit\&. +.RE +.PP +\fB\-\-version\fR +.RS 4 +Print a short version string and exit\&. +.RE +.SH "OPTIONS" +.PP +\fB\-\-root=\fR +.RS 4 +Operate relative to the specified root directory, i\&.e\&. establish the +"overlayfs" +mount not on the top\-level host +/usr/ +and +/opt/ +hierarchies for sysext or +/etc/ +for confext, but below some specified root directory\&. +.RE +.PP +\fB\-\-force\fR +.RS 4 +When merging system extensions into +/usr/ +and +/opt/ +for sysext and +/etc/ +for confext, ignore version incompatibilities, i\&.e\&. force merging regardless of whether the version information included in the images matches the host or not\&. +.RE +.PP +\fB\-\-image\-policy=\fR\fB\fIpolicy\fR\fR +.RS 4 +Takes an image policy string as argument, as per +\fBsystemd.image-policy\fR(7)\&. The policy is enforced when operating on system extension disk images\&. If not specified defaults to +"root=verity+signed+encrypted+unprotected+absent:usr=verity+signed+encrypted+unprotected+absent" +for system extensions, i\&.e\&. only the root and +/usr/ +file systems in the image are used\&. For configuration extensions defaults to +"root=verity+signed+encrypted+unprotected+absent"\&. When run in the initrd and operating on a system extension image stored in the +/\&.extra/sysext/ +directory a slightly stricter policy is used by default: +"root=signed+absent:usr=signed+absent", see above for details\&. +.RE +.PP +\fB\-\-noexec=\fR\fIBOOL\fR +.RS 4 +When merging configuration extensions into +/etc/ +the +"MS_NOEXEC" +mount flag is used by default\&. This option can be used to disable it\&. +.RE +.PP +\fB\-\-no\-pager\fR +.RS 4 +Do not pipe output into a pager\&. +.RE +.PP +\fB\-\-no\-legend\fR +.RS 4 +Do not print the legend, i\&.e\&. column headers and the footer with hints\&. +.RE +.PP +\fB\-\-json=\fR\fIMODE\fR +.RS 4 +Shows output formatted as JSON\&. Expects one of +"short" +(for the shortest possible output without any redundant whitespace or line breaks), +"pretty" +(for a pretty version of the same, with indentation and line breaks) or +"off" +(to turn off JSON output, the default)\&. +.RE +.SH "EXIT STATUS" +.PP +On success, 0 is returned\&. +.SH "SEE ALSO" +.PP +\fBsystemd\fR(1), +\fBsystemd-nspawn\fR(1), +\fBsystemd-stub\fR(7) +.SH "NOTES" +.IP " 1." 4 +Discoverable Partitions Specification +.RS 4 +\%https://uapi-group.org/specifications/specs/discoverable_partitions_specification +.RE +.IP " 2." 4 +Portable Services Documentation +.RS 4 +\%https://systemd.io/PORTABLE_SERVICES +.RE diff --git a/upstream/opensuse-leap-15-6/man8/systemd-system-update-generator.8 b/upstream/opensuse-leap-15-6/man8/systemd-system-update-generator.8 new file mode 100644 index 00000000..2ae6d209 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/systemd-system-update-generator.8 @@ -0,0 +1,44 @@ +'\" t +.TH "SYSTEMD\-SYSTEM\-UPDATE\-GENERATOR" "8" "" "systemd 254" "systemd-system-update-generator" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +systemd-system-update-generator \- Generator for redirecting boot to offline update mode +.SH "SYNOPSIS" +.PP +/usr/lib/systemd/system\-generators/systemd\-system\-update\-generator +.SH "DESCRIPTION" +.PP +systemd\-system\-update\-generator +is a generator that automatically redirects the boot process to +system\-update\&.target, if +/system\-update +or +/etc/system\-update +exists\&. This is required to implement the logic explained in the +\fBsystemd.offline-updates\fR(7)\&. +.PP +systemd\-system\-update\-generator +implements +\fBsystemd.generator\fR(7)\&. +.SH "SEE ALSO" +.PP +\fBsystemd\fR(1), +\fBsystemd.special\fR(7) diff --git a/upstream/opensuse-leap-15-6/man8/systemd-sysusers.8 b/upstream/opensuse-leap-15-6/man8/systemd-sysusers.8 new file mode 100644 index 00000000..cf03222f --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/systemd-sysusers.8 @@ -0,0 +1,220 @@ +'\" t +.TH "SYSTEMD\-SYSUSERS" "8" "" "systemd 254" "systemd-sysusers" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +systemd-sysusers, systemd-sysusers.service \- Allocate system users and groups +.SH "SYNOPSIS" +.HP \w'\fBsystemd\-sysusers\fR\ 'u +\fBsystemd\-sysusers\fR [OPTIONS...] [\fICONFIGFILE\fR...] +.PP +systemd\-sysusers\&.service +.SH "DESCRIPTION" +.PP +\fBsystemd\-sysusers\fR +creates system users and groups, based on files in the format described in +\fBsysusers.d\fR(5)\&. +.PP +If invoked with no arguments, it applies all directives from all files found in the directories specified by +\fBsysusers.d\fR(5)\&. When invoked with positional arguments, if option +\fB\-\-replace=\fR\fB\fIPATH\fR\fR +is specified, arguments specified on the command line are used instead of the configuration file +\fIPATH\fR\&. Otherwise, just the configuration specified by the command line arguments is executed\&. The string +"\-" +may be specified instead of a filename to instruct +\fBsystemd\-sysusers\fR +to read the configuration from standard input\&. If the argument is a relative path, all configuration directories are searched for a matching file and the file found that has the highest priority is executed\&. If the argument is an absolute path, that file is used directly without searching of the configuration directories\&. +.SH "OPTIONS" +.PP +The following options are understood: +.PP +\fB\-\-root=\fR\fB\fIroot\fR\fR +.RS 4 +Takes a directory path as an argument\&. All paths will be prefixed with the given alternate +\fIroot\fR +path, including config search paths\&. +.RE +.PP +\fB\-\-image=\fR\fB\fIimage\fR\fR +.RS 4 +Takes a path to a disk image file or block device node\&. If specified all operations are applied to file system in the indicated disk image\&. This is similar to +\fB\-\-root=\fR +but operates on file systems stored in disk images or block devices\&. The disk image should either contain just a file system or a set of file systems within a GPT partition table, following the +\m[blue]\fBDiscoverable Partitions Specification\fR\m[]\&\s-2\u[1]\d\s+2\&. For further information on supported disk images, see +\fBsystemd-nspawn\fR(1)\*(Aqs switch of the same name\&. +.RE +.PP +\fB\-\-image\-policy=\fR\fB\fIpolicy\fR\fR +.RS 4 +Takes an image policy string as argument, as per +\fBsystemd.image-policy\fR(7)\&. The policy is enforced when operating on the disk image specified via +\fB\-\-image=\fR, see above\&. If not specified defaults to the +"*" +policy, i\&.e\&. all recognized file systems in the image are used\&. +.RE +.PP +\fB\-\-replace=\fR\fB\fIPATH\fR\fR +.RS 4 +When this option is given, one or more positional arguments must be specified\&. All configuration files found in the directories listed in +\fBsysusers.d\fR(5) +will be read, and the configuration given on the command line will be handled instead of and with the same priority as the configuration file +\fIPATH\fR\&. +.sp +This option is intended to be used when package installation scripts are running and files belonging to that package are not yet available on disk, so their contents must be given on the command line, but the admin configuration might already exist and should be given higher priority\&. +.PP +\fBExample\ \&1.\ \&RPM installation script for radvd\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf +echo \*(Aqu radvd \- "radvd daemon"\*(Aq | \e + systemd\-sysusers \-\-replace=/usr/lib/sysusers\&.d/radvd\&.conf \- +.fi +.if n \{\ +.RE +.\} +.sp +This will create the radvd user as if +/usr/lib/sysusers\&.d/radvd\&.conf +was already on disk\&. An admin might override the configuration specified on the command line by placing +/etc/sysusers\&.d/radvd\&.conf +or even +/etc/sysusers\&.d/00\-overrides\&.conf\&. +.sp +Note that this is the expanded form, and when used in a package, this would be written using a macro with "radvd" and a file containing the configuration line as arguments\&. +.RE +.PP +\fB\-\-dry\-run\fR +.RS 4 +Process the configuration and figure out what entries would be created, but don\*(Aqt actually write anything\&. +.RE +.PP +\fB\-\-inline\fR +.RS 4 +Treat each positional argument as a separate configuration line instead of a file name\&. +.RE +.PP +\fB\-\-cat\-config\fR +.RS 4 +Copy the contents of config files to standard output\&. Before each file, the filename is printed as a comment\&. +.RE +.PP +\fB\-\-no\-pager\fR +.RS 4 +Do not pipe output into a pager\&. +.RE +.PP +\fB\-h\fR, \fB\-\-help\fR +.RS 4 +Print a short help text and exit\&. +.RE +.PP +\fB\-\-version\fR +.RS 4 +Print a short version string and exit\&. +.RE +.SH "CREDENTIALS" +.PP +\fBsystemd\-sysusers\fR +supports the service credentials logic as implemented by +\fIImportCredential=\fR\fILoadCredential=\fR/\fISetCredential=\fR +(see +\fBsystemd.exec\fR(1) +for details)\&. The following credentials are used when passed in: +.PP +\fIpasswd\&.hashed\-password\&.\fR\fI\fIuser\fR\fR +.RS 4 +A UNIX hashed password string to use for the specified user, when creating an entry for it\&. This is particularly useful for the +"root" +user as it allows provisioning the default root password to use via a unit file drop\-in or from a container manager passing in this credential\&. Note that setting this credential has no effect if the specified user account already exists\&. This credential is hence primarily useful in first boot scenarios or systems that are fully stateless and come up with an empty +/etc/ +on every boot\&. +.RE +.PP +\fIpasswd\&.plaintext\-password\&.\fR\fI\fIuser\fR\fR +.RS 4 +Similar to +"passwd\&.hashed\-password\&.\fIuser\fR" +but expect a literal, plaintext password, which is then automatically hashed before used for the user account\&. If both the hashed and the plaintext credential are specified for the same user the former takes precedence\&. It\*(Aqs generally recommended to specify the hashed version; however in test environments with weaker requirements on security it might be easier to pass passwords in plaintext instead\&. +.RE +.PP +\fIpasswd\&.shell\&.\fR\fI\fIuser\fR\fR +.RS 4 +Specifies the shell binary to use for the specified account when creating it\&. +.RE +.PP +\fIsysusers\&.extra\fR +.RS 4 +The contents of this credential may contain additional lines to operate on\&. The credential contents should follow the same format as any other +sysusers\&.d/ +drop\-in\&. If this credential is passed it is processed after all of the drop\-in files read from the file system\&. +.RE +.PP +Note that by default the +systemd\-sysusers\&.service +unit file is set up to inherit the +"passwd\&.hashed\-password\&.root", +"passwd\&.plaintext\-password\&.root", +"passwd\&.shell\&.root" +and +"sysusers\&.extra" +credentials from the service manager\&. Thus, when invoking a container with an unpopulated +/etc/ +for the first time it is possible to configure the root user\*(Aqs password to be +"systemd" +like this: +.PP +.if n \{\ +.RS 4 +.\} +.nf +# systemd\-nspawn \-\-image=\&... \-\-set\-credential=passwd\&.hashed\-password\&.root:\*(Aq$y$j9T$yAuRJu1o5HioZAGDYPU5d\&.$F64ni6J2y2nNQve90M/p0ZP0ECP/qqzipNyaY9fjGpC\*(Aq \&... +.fi +.if n \{\ +.RE +.\} +.PP +Note again that the data specified in this credential is consulted only when creating an account for the first time, it may not be used for changing the password or shell of an account that already exists\&. +.PP +Use +\fBmkpasswd\fR(1) +for generating UNIX password hashes from the command line\&. +.SH "EXIT STATUS" +.PP +On success, 0 is returned, a non\-zero failure code otherwise\&. +.SH "SEE ALSO" +.PP +\fBsystemd\fR(1), +\fBsysusers.d\fR(5), +\m[blue]\fBUsers, Groups, UIDs and GIDs on systemd systems\fR\m[]\&\s-2\u[2]\d\s+2, +\fBsystemd.exec\fR(1), +\fBmkpasswd\fR(1) +.SH "NOTES" +.IP " 1." 4 +Discoverable Partitions Specification +.RS 4 +\%https://uapi-group.org/specifications/specs/discoverable_partitions_specification +.RE +.IP " 2." 4 +Users, Groups, UIDs and GIDs on systemd systems +.RS 4 +\%https://systemd.io/UIDS-GIDS +.RE diff --git a/upstream/opensuse-leap-15-6/man8/systemd-time-wait-sync.service.8 b/upstream/opensuse-leap-15-6/man8/systemd-time-wait-sync.service.8 new file mode 100644 index 00000000..4b47bd81 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/systemd-time-wait-sync.service.8 @@ -0,0 +1,55 @@ +'\" t +.TH "SYSTEMD\-TIME\-WAIT\-SYNC\&.SERVICE" "8" "" "systemd 254" "systemd-time-wait-sync.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" +systemd-time-wait-sync.service, systemd-time-wait-sync \- Wait until kernel time is synchronized +.SH "SYNOPSIS" +.PP +systemd\-time\-wait\-sync\&.service +.PP +/usr/lib/systemd/systemd\-time\-wait\-sync +.SH "DESCRIPTION" +.PP +systemd\-time\-wait\-sync +is a system service that delays the start of units that are ordered after +time\-sync\&.target +(see +\fBsystemd.special\fR(7) +for details) until the system time has been synchronized with an accurate remote reference time source by +systemd\-timesyncd\&.service\&. +.PP +systemd\-timesyncd\&.service +notifies +systemd\-time\-wait\-sync +about successful synchronization\&. +systemd\-time\-wait\-sync +also tries to detect when the kernel marks the system clock as synchronized, but this detection is not reliable and is intended only as a fallback for compatibility with alternative NTP services that can be used to synchronize time (e\&.g\&., ntpd, chronyd)\&. +.SH "FILES" +.PP +/run/systemd/timesync/synchronized +.RS 4 +The presence of this file indicates to this service that the system clock has been synchronized\&. +.RE +.SH "SEE ALSO" +.PP +\fBsystemd\fR(1), +\fBsystemd.special\fR(7), +\fBsystemd-timesyncd.service\fR(8), diff --git a/upstream/opensuse-leap-15-6/man8/systemd-timedated.service.8 b/upstream/opensuse-leap-15-6/man8/systemd-timedated.service.8 new file mode 100644 index 00000000..309d4765 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/systemd-timedated.service.8 @@ -0,0 +1,154 @@ +'\" t +.TH "SYSTEMD\-TIMEDATED\&.SERVICE" "8" "" "systemd 254" "systemd-timedated.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" +systemd-timedated.service, systemd-timedated \- Time and date bus mechanism +.SH "SYNOPSIS" +.PP +systemd\-timedated\&.service +.PP +/usr/lib/systemd/systemd\-timedated +.SH "DESCRIPTION" +.PP +systemd\-timedated\&.service +is a system service that may be used as a mechanism to change the system clock and timezone, as well as to enable/disable network time synchronization\&. +systemd\-timedated +is automatically activated on request and terminates itself when it is unused\&. +.PP +The tool +\fBtimedatectl\fR(1) +is a command line client to this service\&. +.PP +systemd\-timedated +currently offers access to the following four settings: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +The system time +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +The system timezone +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +A boolean controlling whether the system RTC is in local or UTC timezone +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Whether the time synchronization service is enabled/started or disabled/stopped, see next section\&. +.RE +.PP +See +\fBorg.freedesktop.timedate1\fR(5) +and +\fBorg.freedesktop.LogControl1\fR(5) +for information about the D\-Bus API\&. +.SH "LIST OF NETWORK TIME SYNCHRONIZATION SERVICES" +.PP +\fBsystemd\-timesyncd\fR +will look for files with a +"\&.list" +extension in +ntp\-units\&.d/ +directories\&. Each file is parsed as a list of unit names, one per line\&. Empty lines and lines with comments ("#") are ignored\&. Files are read from +/usr/lib/systemd/ntp\-units\&.d/ +and the corresponding directories under +/etc/, +/run/, +/usr/local/lib/\&. Files in +/etc/ +override files with the same name in +/run/, +/usr/local/lib/, and +/usr/lib/\&. Files in +/run/ +override files with the same name under +/usr/\&. Packages should install their configuration files in +/usr/lib/ +(distribution packages) or +/usr/local/lib/ +(local installs)\&. +.PP +\fBExample\ \&1.\ \&ntp\-units\&.d/ entry for systemd\-timesyncd\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf +# /usr/lib/systemd/ntp\-units\&.d/80\-systemd\-timesync\&.list +systemd\-timesyncd\&.service +.fi +.if n \{\ +.RE +.\} +.PP +If the environment variable +\fI$SYSTEMD_TIMEDATED_NTP_SERVICES\fR +is set, +\fBsystemd\-timesyncd\fR +will parse the contents of that variable as a colon\-separated list of unit names\&. When set, this variable overrides the file\-based list described above\&. +.PP +\fBExample\ \&2.\ \&An override that specifies that chronyd should be used if available\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf +SYSTEMD_TIMEDATED_NTP_SERVICES=chronyd\&.service:systemd\-timesyncd\&.service +.fi +.if n \{\ +.RE +.\} +.SH "SEE ALSO" +.PP +\fBsystemd\fR(1), +\fBtimedatectl\fR(1), +\fBlocaltime\fR(5), +\fBhwclock\fR(8), +\fBsystemd-timesyncd\fR(8) diff --git a/upstream/opensuse-leap-15-6/man8/systemd-tmpfiles.8 b/upstream/opensuse-leap-15-6/man8/systemd-tmpfiles.8 new file mode 100644 index 00000000..ffbc7615 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/systemd-tmpfiles.8 @@ -0,0 +1,492 @@ +'\" t +.TH "SYSTEMD\-TMPFILES" "8" "" "systemd 254" "systemd-tmpfiles" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +systemd-tmpfiles, systemd-tmpfiles-setup.service, systemd-tmpfiles-setup-dev-early.service, systemd-tmpfiles-setup-dev.service, systemd-tmpfiles-clean.service, systemd-tmpfiles-clean.timer \- Creates, deletes and cleans up volatile and temporary files and directories +.SH "SYNOPSIS" +.HP \w'\fBsystemd\-tmpfiles\fR\ 'u +\fBsystemd\-tmpfiles\fR [OPTIONS...] [\fICONFIGFILE\fR...] +.PP +System units: +.sp +.nf +systemd\-tmpfiles\-setup\&.service +systemd\-tmpfiles\-setup\-dev\-early\&.service +systemd\-tmpfiles\-setup\-dev\&.service +systemd\-tmpfiles\-clean\&.service +systemd\-tmpfiles\-clean\&.timer +.fi +.PP +User units: +.sp +.nf +systemd\-tmpfiles\-setup\&.service +systemd\-tmpfiles\-clean\&.service +systemd\-tmpfiles\-clean\&.timer +.fi +.SH "DESCRIPTION" +.PP +\fBsystemd\-tmpfiles\fR +creates, deletes, and cleans up volatile and temporary files and directories, using the configuration file format and location specified in +\fBtmpfiles.d\fR(5)\&. It must be invoked with one or more options +\fB\-\-create\fR, +\fB\-\-remove\fR, and +\fB\-\-clean\fR, to select the respective subset of operations\&. +.PP +By default, directives from all configuration files are applied\&. When invoked with +\fB\-\-replace=\fR\fB\fIPATH\fR\fR, arguments specified on the command line are used instead of the configuration file +\fIPATH\fR\&. Otherwise, if one or more absolute filenames are passed on the command line, only the directives in these files are applied\&. If +"\-" +is specified instead of a filename, directives are read from standard input\&. If only the basename of a configuration file is specified, all configuration directories as specified in +\fBtmpfiles.d\fR(5) +are searched for a matching file and the file found that has the highest priority is executed\&. +.PP +System services (systemd\-tmpfiles\-setup\&.service, +systemd\-tmpfiles\-setup\-dev\-early\&.service, +systemd\-tmpfiles\-setup\-dev\&.service, +systemd\-tmpfiles\-clean\&.service) invoke +\fBsystemd\-tmpfiles\fR +to create system files and to perform system wide cleanup\&. Those services read administrator\-controlled configuration files in +tmpfiles\&.d/ +directories\&. User services (systemd\-tmpfiles\-setup\&.service, +systemd\-tmpfiles\-clean\&.service) also invoke +\fBsystemd\-tmpfiles\fR, but it reads a separate set of files, which includes user\-controlled files under +~/\&.config/user\-tmpfiles\&.d/ +and +~/\&.local/share/user\-tmpfiles\&.d/, and administrator\-controlled files under +/usr/share/user\-tmpfiles\&.d/\&. Users may use this to create and clean up files under their control, but the system instance performs global cleanup and is not influenced by user configuration\&. Note that this means a time\-based cleanup configured in the system instance, such as the one typically configured for +/tmp/, will thus also affect files created by the user instance if they are placed in +/tmp/, even if the user instance\*(Aqs time\-based cleanup is turned off\&. +.PP +To re\-apply settings after configuration has been modified, simply restart +systemd\-tmpfiles\-clean\&.service, which will apply any settings which can be safely executed at runtime\&. To debug +\fBsystemd\-tmpfiles\fR, it may be useful to invoke it directly from the command line with increased log level (see +\fI$SYSTEMD_LOG_LEVEL\fR +below)\&. +.SH "OPTIONS" +.PP +The following options are understood: +.PP +\fB\-\-create\fR +.RS 4 +If this option is passed, all files and directories marked with +\fIf\fR, +\fIF\fR, +\fIw\fR, +\fId\fR, +\fID\fR, +\fIv\fR, +\fIp\fR, +\fIL\fR, +\fIc\fR, +\fIb\fR, +\fIm\fR +in the configuration files are created or written to\&. Files and directories marked with +\fIz\fR, +\fIZ\fR, +\fIt\fR, +\fIT\fR, +\fIa\fR, and +\fIA\fR +have their ownership, access mode and security labels set\&. +.RE +.PP +\fB\-\-clean\fR +.RS 4 +If this option is passed, all files and directories with an age parameter configured will be cleaned up\&. +.RE +.PP +\fB\-\-remove\fR +.RS 4 +If this option is passed, the contents of directories marked with +\fID\fR +or +\fIR\fR, and files or directories themselves marked with +\fIr\fR +or +\fIR\fR +are removed unless an exclusive or shared BSD lock is taken on them (see +\fBflock\fR(2))\&. +.RE +.PP +\fB\-\-user\fR +.RS 4 +Execute "user" configuration, i\&.e\&. +tmpfiles\&.d +files in user configuration directories\&. +.RE +.PP +\fB\-\-boot\fR +.RS 4 +Also execute lines with an exclamation mark\&. Lines that are not safe to be executed on a running system may be marked in this way\&. +\fBsystemd\-tmpfiles\fR +is executed in early boot with +\fB\-\-boot\fR +specified and will execute those lines\&. When invoked again later, it should be called without +\fB\-\-boot\fR\&. +.RE +.PP +\fB\-\-graceful\fR +.RS 4 +Ignore configuration lines pertaining to unknown users or groups\&. This option is intended to be used in early boot before all users or groups have been created\&. +.RE +.PP +\fB\-\-prefix=\fR\fB\fIpath\fR\fR +.RS 4 +Only apply rules with paths that start with the specified prefix\&. This option can be specified multiple times\&. +.RE +.PP +\fB\-\-exclude\-prefix=\fR\fB\fIpath\fR\fR +.RS 4 +Ignore rules with paths that start with the specified prefix\&. This option can be specified multiple times\&. +.RE +.PP +\fB\-E\fR +.RS 4 +A shortcut for +"\-\-exclude\-prefix=/dev \-\-exclude\-prefix=/proc \-\-exclude\-prefix=/run \-\-exclude\-prefix=/sys", i\&.e\&. exclude the hierarchies typically backed by virtual or memory file systems\&. This is useful in combination with +\fB\-\-root=\fR, if the specified directory tree contains an OS tree without these virtual/memory file systems mounted in, as it is typically not desirable to create any files and directories below these subdirectories if they are supposed to be overmounted during runtime\&. +.RE +.PP +\fB\-\-root=\fR\fB\fIroot\fR\fR +.RS 4 +Takes a directory path as an argument\&. All paths will be prefixed with the given alternate +\fIroot\fR +path, including config search paths\&. +.sp +When this option is used, the libc Name Service Switch (NSS) is bypassed for resolving users and groups\&. Instead the files +/etc/passwd +and +/etc/group +inside the alternate root are read directly\&. This means that users/groups not listed in these files will not be resolved, i\&.e\&. LDAP NIS and other complex databases are not considered\&. +.sp +Consider combining this with +\fB\-E\fR +to ensure the invocation does not create files or directories below mount points in the OS image operated on that are typically overmounted during runtime\&. +.RE +.PP +\fB\-\-image=\fR\fB\fIimage\fR\fR +.RS 4 +Takes a path to a disk image file or block device node\&. If specified all operations are applied to file system in the indicated disk image\&. This is similar to +\fB\-\-root=\fR +but operates on file systems stored in disk images or block devices\&. The disk image should either contain just a file system or a set of file systems within a GPT partition table, following the +\m[blue]\fBDiscoverable Partitions Specification\fR\m[]\&\s-2\u[1]\d\s+2\&. For further information on supported disk images, see +\fBsystemd-nspawn\fR(1)\*(Aqs switch of the same name\&. +.sp +Implies +\fB\-E\fR\&. +.RE +.PP +\fB\-\-image\-policy=\fR\fB\fIpolicy\fR\fR +.RS 4 +Takes an image policy string as argument, as per +\fBsystemd.image-policy\fR(7)\&. The policy is enforced when operating on the disk image specified via +\fB\-\-image=\fR, see above\&. If not specified defaults to the +"*" +policy, i\&.e\&. all recognized file systems in the image are used\&. +.RE +.PP +\fB\-\-replace=\fR\fB\fIPATH\fR\fR +.RS 4 +When this option is given, one or more positional arguments must be specified\&. All configuration files found in the directories listed in +\fBtmpfiles.d\fR(5) +will be read, and the configuration given on the command line will be handled instead of and with the same priority as the configuration file +\fIPATH\fR\&. +.sp +This option is intended to be used when package installation scripts are running and files belonging to that package are not yet available on disk, so their contents must be given on the command line, but the admin configuration might already exist and should be given higher priority\&. +.RE +.PP +\fB\-\-cat\-config\fR +.RS 4 +Copy the contents of config files to standard output\&. Before each file, the filename is printed as a comment\&. +.RE +.PP +\fB\-\-no\-pager\fR +.RS 4 +Do not pipe output into a pager\&. +.RE +.PP +\fB\-h\fR, \fB\-\-help\fR +.RS 4 +Print a short help text and exit\&. +.RE +.PP +\fB\-\-version\fR +.RS 4 +Print a short version string and exit\&. +.RE +.PP +It is possible to combine +\fB\-\-create\fR, +\fB\-\-clean\fR, and +\fB\-\-remove\fR +in one invocation (in which case removal and cleanup are executed before creation of new files)\&. For example, during boot the following command line is executed to ensure that all temporary and volatile directories are removed and created according to the configuration file: +.sp +.if n \{\ +.RS 4 +.\} +.nf +systemd\-tmpfiles \-\-remove \-\-create +.fi +.if n \{\ +.RE +.\} +.SH "CREDENTIALS" +.PP +\fBsystemd\-tmpfiles\fR +supports the service credentials logic as implemented by +\fIImportCredential=\fR/\fILoadCredential=\fR/\fISetCredential=\fR +(see +\fBsystemd.exec\fR(1) +for details)\&. The following credentials are used when passed in: +.PP +\fItmpfiles\&.extra\fR +.RS 4 +The contents of this credential may contain additional lines to operate on\&. The credential contents should follow the same format as any other +tmpfiles\&.d/ +drop\-in configuration file\&. If this credential is passed it is processed after all of the drop\-in files read from the file system\&. The lines in the credential can hence augment existing lines of the OS, but not override them\&. +.RE +.PP +Note that by default the +systemd\-tmpfiles\-setup\&.service +unit file (and related unit files) is set up to inherit the +"tmpfiles\&.extra" +credential from the service manager\&. +.SH "ENVIRONMENT" +.PP +\fI$SYSTEMD_LOG_LEVEL\fR +.RS 4 +The maximum log level of emitted messages (messages with a higher log level, i\&.e\&. less important ones, will be suppressed)\&. Either one of (in order of decreasing importance) +\fBemerg\fR, +\fBalert\fR, +\fBcrit\fR, +\fBerr\fR, +\fBwarning\fR, +\fBnotice\fR, +\fBinfo\fR, +\fBdebug\fR, or an integer in the range 0\&...7\&. See +\fBsyslog\fR(3) +for more information\&. +.RE +.PP +\fI$SYSTEMD_LOG_COLOR\fR +.RS 4 +A boolean\&. If true, messages written to the tty will be colored according to priority\&. +.sp +This setting is only useful when messages are written directly to the terminal, because +\fBjournalctl\fR(1) +and other tools that display logs will color messages based on the log level on their own\&. +.RE +.PP +\fI$SYSTEMD_LOG_TIME\fR +.RS 4 +A boolean\&. If true, console log messages will be prefixed with a timestamp\&. +.sp +This setting is only useful when messages are written directly to the terminal or a file, because +\fBjournalctl\fR(1) +and other tools that display logs will attach timestamps based on the entry metadata on their own\&. +.RE +.PP +\fI$SYSTEMD_LOG_LOCATION\fR +.RS 4 +A boolean\&. If true, messages will be prefixed with a filename and line number in the source code where the message originates\&. +.sp +Note that the log location is often attached as metadata to journal entries anyway\&. Including it directly in the message text can nevertheless be convenient when debugging programs\&. +.RE +.PP +\fI$SYSTEMD_LOG_TARGET\fR +.RS 4 +The destination for log messages\&. One of +\fBconsole\fR +(log to the attached tty), +\fBconsole\-prefixed\fR +(log to the attached tty but with prefixes encoding the log level and "facility", see +\fBsyslog\fR(3), +\fBkmsg\fR +(log to the kernel circular log buffer), +\fBjournal\fR +(log to the journal), +\fBjournal\-or\-kmsg\fR +(log to the journal if available, and to kmsg otherwise), +\fBauto\fR +(determine the appropriate log target automatically, the default), +\fBnull\fR +(disable log output)\&. +.RE +.PP +\fI$SYSTEMD_PAGER\fR +.RS 4 +Pager to use when +\fB\-\-no\-pager\fR +is not given; overrides +\fI$PAGER\fR\&. If neither +\fI$SYSTEMD_PAGER\fR +nor +\fI$PAGER\fR +are set, a set of well\-known pager implementations are tried in turn, including +\fBless\fR(1) +and +\fBmore\fR(1), until one is found\&. If no pager implementation is discovered no pager is invoked\&. Setting this environment variable to an empty string or the value +"cat" +is equivalent to passing +\fB\-\-no\-pager\fR\&. +.sp +Note: if +\fI$SYSTEMD_PAGERSECURE\fR +is not set, +\fI$SYSTEMD_PAGER\fR +(as well as +\fI$PAGER\fR) will be silently ignored\&. +.RE +.PP +\fI$SYSTEMD_LESS\fR +.RS 4 +Override the options passed to +\fBless\fR +(by default +"FRSXMK")\&. +.sp +Users might want to change two options in particular: +.PP +\fBK\fR +.RS 4 +This option instructs the pager to exit immediately when +Ctrl+C +is pressed\&. To allow +\fBless\fR +to handle +Ctrl+C +itself to switch back to the pager command prompt, unset this option\&. +.sp +If the value of +\fI$SYSTEMD_LESS\fR +does not include +"K", and the pager that is invoked is +\fBless\fR, +Ctrl+C +will be ignored by the executable, and needs to be handled by the pager\&. +.RE +.PP +\fBX\fR +.RS 4 +This option instructs the pager to not send termcap initialization and deinitialization strings to the terminal\&. It is set by default to allow command output to remain visible in the terminal even after the pager exits\&. Nevertheless, this prevents some pager functionality from working, in particular paged output cannot be scrolled with the mouse\&. +.RE +.sp +See +\fBless\fR(1) +for more discussion\&. +.RE +.PP +\fI$SYSTEMD_LESSCHARSET\fR +.RS 4 +Override the charset passed to +\fBless\fR +(by default +"utf\-8", if the invoking terminal is determined to be UTF\-8 compatible)\&. +.RE +.PP +\fI$SYSTEMD_PAGERSECURE\fR +.RS 4 +Takes a boolean argument\&. When true, the "secure" mode of the pager is enabled; if false, disabled\&. If +\fI$SYSTEMD_PAGERSECURE\fR +is not set at all, secure mode is enabled if the effective UID is not the same as the owner of the login session, see +\fBgeteuid\fR(2) +and +\fBsd_pid_get_owner_uid\fR(3)\&. In secure mode, +\fBLESSSECURE=1\fR +will be set when invoking the pager, and the pager shall disable commands that open or create new files or start new subprocesses\&. When +\fI$SYSTEMD_PAGERSECURE\fR +is not set at all, pagers which are not known to implement secure mode will not be used\&. (Currently only +\fBless\fR(1) +implements secure mode\&.) +.sp +Note: when commands are invoked with elevated privileges, for example under +\fBsudo\fR(8) +or +\fBpkexec\fR(1), care must be taken to ensure that unintended interactive features are not enabled\&. "Secure" mode for the pager may be enabled automatically as describe above\&. Setting +\fISYSTEMD_PAGERSECURE=0\fR +or not removing it from the inherited environment allows the user to invoke arbitrary commands\&. Note that if the +\fI$SYSTEMD_PAGER\fR +or +\fI$PAGER\fR +variables are to be honoured, +\fI$SYSTEMD_PAGERSECURE\fR +must be set too\&. It might be reasonable to completely disable the pager using +\fB\-\-no\-pager\fR +instead\&. +.RE +.PP +\fI$SYSTEMD_COLORS\fR +.RS 4 +Takes a boolean argument\&. When true, +\fBsystemd\fR +and related utilities will use colors in their output, otherwise the output will be monochrome\&. Additionally, the variable can take one of the following special values: +"16", +"256" +to restrict the use of colors to the base 16 or 256 ANSI colors, respectively\&. This can be specified to override the automatic decision based on +\fI$TERM\fR +and what the console is connected to\&. +.RE +.PP +\fI$SYSTEMD_URLIFY\fR +.RS 4 +The value must be a boolean\&. Controls whether clickable links should be generated in the output for terminal emulators supporting this\&. This can be specified to override the decision that +\fBsystemd\fR +makes based on +\fI$TERM\fR +and other conditions\&. +.RE +.SH "UNPRIVILEGED \-\-CLEANUP OPERATION" +.PP +\fBsystemd\-tmpfiles\fR +tries to avoid changing the access and modification times on the directories it accesses, which requires +\fBCAP_FOWNER\fR +privileges\&. When running as non\-root, directories which are checked for files to clean up will have their access time bumped, which might prevent their cleanup\&. +.SH "EXIT STATUS" +.PP +On success, 0 is returned\&. If the configuration was syntactically invalid (syntax errors, missing arguments, \&...), so some lines had to be ignored, but no other errors occurred, +\fB65\fR +is returned (\fBEX_DATAERR\fR +from +/usr/include/sysexits\&.h)\&. If the configuration was syntactically valid, but could not be executed (lack of permissions, creation of files in missing directories, invalid contents when writing to +/sys/ +values, \&...), +\fB73\fR +is returned (\fBEX_CANTCREAT\fR +from +/usr/include/sysexits\&.h)\&. Otherwise, +\fB1\fR +is returned (\fBEXIT_FAILURE\fR +from +/usr/include/stdlib\&.h)\&. +.PP +Note: when creating items, if the target already exists, but is of the wrong type or otherwise does not match the requested state, and forced operation has not been requested with +"+", a message is emitted, but the failure is otherwise ignored\&. +.SH "SEE ALSO" +.PP +\fBsystemd\fR(1), +\fBtmpfiles.d\fR(5) +.SH "NOTES" +.IP " 1." 4 +Discoverable Partitions Specification +.RS 4 +\%https://uapi-group.org/specifications/specs/discoverable_partitions_specification +.RE diff --git a/upstream/opensuse-leap-15-6/man8/systemd-update-done.service.8 b/upstream/opensuse-leap-15-6/man8/systemd-update-done.service.8 new file mode 100644 index 00000000..f7ce689a --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/systemd-update-done.service.8 @@ -0,0 +1,81 @@ +'\" t +.TH "SYSTEMD\-UPDATE\-DONE\&.SERVICE" "8" "" "systemd 254" "systemd-update-done.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" +systemd-update-done.service, systemd-update-done \- Mark /etc/ and /var/ fully updated +.SH "SYNOPSIS" +.PP +systemd\-update\-done\&.service +.PP +/usr/lib/systemd/systemd\-update\-done +.SH "DESCRIPTION" +.PP +systemd\-update\-done\&.service +is a service that is invoked as part of the first boot after the vendor operating system resources in +/usr/ +have been updated\&. This is useful to implement offline updates of +/usr/ +which might require updates to +/etc/ +or +/var/ +on the following boot\&. +.PP +systemd\-update\-done\&.service +updates the file modification time (mtime) of the stamp files +/etc/\&.updated +and +/var/\&.updated +to the modification time of the +/usr/ +directory, unless the stamp files are already newer\&. +.PP +Services that shall run after offline upgrades of +/usr/ +should order themselves before +systemd\-update\-done\&.service, and use the +\fIConditionNeedsUpdate=\fR +(see +\fBsystemd.unit\fR(5)) condition to make sure to run when +/etc/ +or +/var/ +are older than +/usr/ +according to the modification times of the files described above\&. This requires that updates to +/usr/ +are always followed by an update of the modification time of +/usr/, for example by invoking +\fBtouch\fR(1) +on it\&. +.PP +Note that if the +\fIsystemd\&.condition\-needs\-update=\fR +kernel command line option is used it overrides the +\fIConditionNeedsUpdate=\fR +unit condition checks\&. In that case +systemd\-update\-done\&.service +will not reset the condition state until a follow\-up reboot where the kernel switch is not specified anymore\&. +.SH "SEE ALSO" +.PP +\fBsystemd\fR(1), +\fBsystemd.unit\fR(5), +\fBtouch\fR(1) diff --git a/upstream/opensuse-leap-15-6/man8/systemd-update-utmp.service.8 b/upstream/opensuse-leap-15-6/man8/systemd-update-utmp.service.8 new file mode 100644 index 00000000..c58ea8f3 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/systemd-update-utmp.service.8 @@ -0,0 +1,41 @@ +'\" t +.TH "SYSTEMD\-UPDATE\-UTMP\&.SERVICE" "8" "" "systemd 254" "systemd-update-utmp.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" +systemd-update-utmp.service, systemd-update-utmp-runlevel.service, systemd-update-utmp \- Write audit and utmp updates at bootup, runlevel changes and shutdown +.SH "SYNOPSIS" +.PP +systemd\-update\-utmp\&.service +.PP +systemd\-update\-utmp\-runlevel\&.service +.PP +/usr/lib/systemd/systemd\-update\-utmp +.SH "DESCRIPTION" +.PP +systemd\-update\-utmp\-runlevel\&.service +is a service that writes SysV runlevel changes to utmp and wtmp, as well as the audit logs, as they occur\&. +systemd\-update\-utmp\&.service +does the same for system reboots and shutdown requests\&. +.SH "SEE ALSO" +.PP +\fBsystemd\fR(1), +\fButmp\fR(5), +\fBauditd\fR(8) diff --git a/upstream/opensuse-leap-15-6/man8/systemd-user-sessions.service.8 b/upstream/opensuse-leap-15-6/man8/systemd-user-sessions.service.8 new file mode 100644 index 00000000..fd4e5ce0 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/systemd-user-sessions.service.8 @@ -0,0 +1,40 @@ +'\" t +.TH "SYSTEMD\-USER\-SESSIONS\&.SERVICE" "8" "" "systemd 254" "systemd-user-sessions.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" +systemd-user-sessions.service, systemd-user-sessions \- Permit user logins after boot, prohibit user logins at shutdown +.SH "SYNOPSIS" +.PP +systemd\-user\-sessions\&.service +.PP +/usr/lib/systemd/systemd\-user\-sessions +.SH "DESCRIPTION" +.PP +systemd\-user\-sessions\&.service +is a service that controls user logins through +\fBpam_nologin\fR(8)\&. After basic system initialization is complete, it removes +/run/nologin, thus permitting logins\&. Before system shutdown, it creates +/run/nologin, thus prohibiting further logins\&. +.SH "SEE ALSO" +.PP +\fBsystemd\fR(1), +\fBsystemd-logind.service\fR(8), +\fBpam_nologin\fR(8) diff --git a/upstream/opensuse-leap-15-6/man8/systemd-userdbd.service.8 b/upstream/opensuse-leap-15-6/man8/systemd-userdbd.service.8 new file mode 100644 index 00000000..a696713d --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/systemd-userdbd.service.8 @@ -0,0 +1,92 @@ +'\" t +.TH "SYSTEMD\-USERDBD\&.SERVICE" "8" "" "systemd 254" "systemd-userdbd.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" +systemd-userdbd.service, systemd-userdbd \- JSON User/Group Record Query Multiplexer/NSS Compatibility +.SH "SYNOPSIS" +.PP +systemd\-userdbd\&.service +.PP +/usr/lib/systemd/systemd\-userdbd +.SH "DESCRIPTION" +.PP +\fBsystemd\-userdbd\fR +is a system service that multiplexes user/group lookups to all local services that provide JSON user/group record definitions to the system\&. In addition it synthesizes JSON user/group records from classic UNIX/glibc NSS user/group records in order to provide full backwards compatibility\&. It may also pick up statically defined JSON user/group records from drop\-in files in +/etc/userdb/, +/run/userdb/, +/run/host/userdb/ +and +/usr/lib/userdb/\&. +.PP +Most of +\fBsystemd\-userdbd\fR\*(Aqs functionality is accessible through the +\fBuserdbctl\fR(1) +command\&. +.PP +The user and group records this service provides access to follow the +\m[blue]\fBJSON User Records\fR\m[]\&\s-2\u[1]\d\s+2 +and +\m[blue]\fBJSON Group Record\fR\m[]\&\s-2\u[2]\d\s+2 +definitions\&. This service implements the +\m[blue]\fBUser/Group Record Lookup API via Varlink\fR\m[]\&\s-2\u[3]\d\s+2, and multiplexes access other services implementing this API, too\&. It is thus both server and client of this API\&. +.PP +This service provides three distinct +\m[blue]\fBVarlink\fR\m[]\&\s-2\u[4]\d\s+2 +services: +\fBio\&.systemd\&.Multiplexer\fR +provides a single, unified API for querying JSON user and group records\&. Internally it talks to all other user/group record services running on the system in parallel and forwards any information discovered\&. This simplifies clients substantially since they need to talk to a single service only instead of all of them in parallel\&. +\fBio\&.systemd\&.NameServiceSwitch\fR +provides compatibility with classic UNIX/glibc NSS user records, i\&.e\&. converts +\fBstruct passwd\fR +and +\fBstruct group\fR +records as acquired with APIs such as +\fBgetpwnam\fR(1) +to JSON user/group records, thus hiding the differences between the services as much as possible\&. +\fBio\&.systemd\&.DropIn\fR +makes JSON user/group records from the aforementioned drop\-in directories available\&. +.SH "SEE ALSO" +.PP +\fBsystemd\fR(1), +\fBnss-systemd\fR(8), +\fBuserdbctl\fR(1), +\fBsystemd-homed.service\fR(8) +.SH "NOTES" +.IP " 1." 4 +JSON User Records +.RS 4 +\%https://systemd.io/USER_RECORD +.RE +.IP " 2." 4 +JSON Group Record +.RS 4 +\%https://systemd.io/GROUP_RECORD +.RE +.IP " 3." 4 +User/Group Record Lookup API via Varlink +.RS 4 +\%https://systemd.io/USER_GROUP_API +.RE +.IP " 4." 4 +Varlink +.RS 4 +\%https://varlink.org/ +.RE diff --git a/upstream/opensuse-leap-15-6/man8/systemd-xdg-autostart-generator.8 b/upstream/opensuse-leap-15-6/man8/systemd-xdg-autostart-generator.8 new file mode 100644 index 00000000..f51ffa35 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/systemd-xdg-autostart-generator.8 @@ -0,0 +1,119 @@ +'\" t +.TH "SYSTEMD\-XDG\-AUTOSTART\-GENERATOR" "8" "" "systemd 254" "systemd-xdg-autostart-generator" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +systemd-xdg-autostart-generator \- User unit generator for XDG autostart files +.SH "SYNOPSIS" +.PP +/usr/lib/systemd/user\-generators/systemd\-xdg\-autostart\-generator +.SH "DESCRIPTION" +.PP +systemd\-xdg\-autostart\-generator +is a generator that creates \&.service units for +\m[blue]\fBXDG autostart\fR\m[]\&\s-2\u[1]\d\s+2 +files\&. This permits desktop environments to delegate startup of these applications to +\fBsystemd\fR(1) +\&. +.PP +Units created by +systemd\-xdg\-autostart\-generator +can be started by the desktop environment using +"xdg\-desktop\-autostart\&.target"\&. See +\fBsystemd.special\fR(7) +for more details\&. +.PP +XDG autostart may be conditionalized using both standardized and non\-standardized keys\&. In order to handle these, the generator may create one or more +\fIExecCondition=\fR +entries\&. For non\-standardized keys, well\-known helper binaries provided by Desktop Environments are used\&. All external helpers +\fImust\fR +detect their corresponding desktop environment and +\fImust\fR +return success when run in a different environment\&. This is important as all +\fIExecCondition=\fR +directives must succeed for an application to be started\&. +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&1.\ \& Special XDG desktop file entries that are processed +.TS +allbox tab(:); +lB lB. +T{ +Entry +T}:T{ +Handling +T} +.T& +l l +l l +l l +l l +l l +l l. +T{ +\fIHidden=\fR, \fIX\-systemd\-skip=\fR +T}:T{ +No service will be generated if set to true +T} +T{ +\fIOnlyShowIn=\fR, \fINotShowIn=\fR +T}:T{ +\fIExecCondition=\fR using systemd\-xdg\-autostart\-condition +T} +T{ +\fITryExec=\fR +T}:T{ +No service will be generated if the binary does not exist or cannot be executed +T} +T{ +\fIAutostartCondition=\fR (GNOME extension) +T}:T{ +\fIExecCondition=\fR using gnome\-systemd\-autostart\-condition +T} +T{ +\fIX\-GNOME\-Autostart\-Phase=\fR +T}:T{ +No service will be generated if set to any value +T} +T{ +\fIX\-KDE\-autostart\-condition=\fR +T}:T{ +\fIExecCondition=\fR using kde\-systemd\-start\-condition +T} +.TE +.sp 1 +.PP +systemd\-xdg\-autostart\-generator +implements +\fBsystemd.generator\fR(7)\&. +.SH "SEE ALSO" +.PP +\fBsystemd\fR(1), +\fBsystemd.service\fR(5), +\fBsystemd.target\fR(5) +.SH "NOTES" +.IP " 1." 4 +XDG autostart +.RS 4 +\%https://specifications.freedesktop.org/autostart-spec/autostart-spec-latest.html +.RE diff --git a/upstream/opensuse-leap-15-6/man8/tracepath.8 b/upstream/opensuse-leap-15-6/man8/tracepath.8 new file mode 100644 index 00000000..c08cb140 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/tracepath.8 @@ -0,0 +1,139 @@ +'\" t +.TH "TRACEPATH" "8" "" "iputils 20221126" "iputils" +.\" ----------------------------------------------------------------- +.\" * 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" +tracepath \- traces path to a network host discovering MTU along this path +.SH "SYNOPSIS" +.HP \w'\fBtracepath\fR\ 'u +\fBtracepath\fR [\fB\-4\fR] [\fB\-6\fR] [\fB\-n\fR] [\fB\-b\fR] [\fB\-l\ \fR\fB\fIpktlen\fR\fR] [\fB\-m\ \fR\fB\fImax_hops\fR\fR] [\fB\-p\ \fR\fB\fIport\fR\fR] [\fB\-V\fR] {destination} +.SH "DESCRIPTION" +.PP +It traces the network path to +\fIdestination\fR +discovering MTU along this path\&. It uses UDP port +\fIport\fR +or some random port\&. It is similar to +\fBtraceroute\fR\&. However, it does not require superuser privileges and has no fancy options\&. +.PP +\fBtracepath \-6\fR +is a good replacement for +\fBtraceroute6\fR +and classic example of application of Linux error queues\&. The situation with IPv4 is worse, because commercial IP routers do not return enough information in ICMP error messages\&. Probably, it will change, when they are updated\&. For now it uses Van Jacobson\*(Aqs trick, sweeping a range of UDP ports to maintain trace history\&. +.SH "OPTIONS" +.PP +\fB\-4\fR +.RS 4 +Use IPv4 only\&. +.RE +.PP +\fB\-6\fR +.RS 4 +Use IPv6 only\&. +.RE +.PP +\fB\-n\fR +.RS 4 +Print primarily IP addresses numerically\&. +.RE +.PP +\fB\-b\fR +.RS 4 +Print both: Host names and IP addresses\&. +.RE +.PP +\fB\-l\fR +.RS 4 +Sets the initial packet length to +\fIpktlen\fR +instead of 65535 for +\fBIPv4\fR +or 128000 for +\fBIPv6\fR\&. +.RE +.PP +\fB\-m\fR +.RS 4 +Set maximum hops (or maximum TTLs) to +\fImax_hops\fR +instead of 30\&. +.RE +.PP +\fB\-p\fR +.RS 4 +Sets the initial destination port to use\&. +.RE +.PP +\fB\-V\fR +.RS 4 +Print version and exit\&. +.RE +.SH "OUTPUT" +.sp +.if n \{\ +.RS 4 +.\} +.nf +root@mops:~ # tracepath \-6 3ffe:2400:0:109::2 + 1?: [LOCALHOST] pmtu 1500 + 1: dust\&.inr\&.ac\&.ru 0\&.411ms + 2: dust\&.inr\&.ac\&.ru asymm 1 0\&.390ms pmtu 1480 + 2: 3ffe:2400:0:109::2 463\&.514ms reached + Resume: pmtu 1480 hops 2 back 2 + +.fi +.if n \{\ +.RE +.\} +.PP +The first column shows the TTL of the probe, followed by colon\&. Usually the value of TTL is obtained from the reply from the network, but sometimes it does not contain the necessary information and we have to guess it\&. In this case the number is followed by ?\&. +.PP +The second column shows the network hop which replied to the probe\&. It is either the address of the router or the word [LOCALHOST], if the probe was not sent to the network\&. +.PP +The rest of the line shows miscellaneous information about the path to the corresponding network hop\&. It contains the value of RTT, and additionally it can show Path MTU when it changes\&. If the path is asymmetric or the probe finishes before it reaches the prescribed hop, the difference between number of hops in forward and return direction is shown next to the keyword "async"\&. This information is not reliable, e\&.g\&. the third line shows asymmetry of 1\&. This is because the first probe with TTL of 2 was rejected at the first hop due to Path MTU Discovery\&. +.PP +The last line summarizes information about all the paths to the destination\&. It shows detected Path MTU, amount of hops to the destination and our guess about the number of hops from the destination to us, which can be different when the path is asymmetric\&. +.SH "SEE ALSO" +.PP +\fBtraceroute\fR(8), +\fBtraceroute6\fR(8), +\fBping\fR(8)\&. +.SH "AUTHOR" +.PP +\fBtracepath\fR +was written by Alexey Kuznetsov <kuznet@ms2\&.inr\&.ac\&.ru>\&. +.SH "SECURITY" +.PP +No security issues\&. +.PP +This lapidary deserves to be elaborated\&. +\fBtracepath\fR +is not a privileged program, unlike +\fBtraceroute\fR, +\fBping\fR +and other beasts of their kind\&. +\fBtracepath\fR +may be executed by everyone who has enough access to the network to send UDP datagrams to the desired destination using the given port\&. +.SH "AVAILABILITY" +.PP +\fBtracepath\fR +is part of +\fIiputils\fR +package\&. diff --git a/upstream/opensuse-leap-15-6/man8/tune2fs.8 b/upstream/opensuse-leap-15-6/man8/tune2fs.8 new file mode 100644 index 00000000..4b9d77af --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/tune2fs.8 @@ -0,0 +1,849 @@ +.\" Revision 1.0 93/06/3 23:00 chk +.\" Initial revision +.\" +.\" +.TH TUNE2FS 8 "February 2023" "E2fsprogs version 1.47.0" +.SH NAME +tune2fs \- adjust tunable file system parameters on ext2/ext3/ext4 file systems +.SH SYNOPSIS +.B tune2fs +[ +.B \-l +] +[ +.B \-c +.I max-mount-counts +] +[ +.B \-e +.I errors-behavior +] +[ +.B \-f +] +[ +.B \-i +.I interval-between-checks +] +[ +.B \-I +.I new_inode_size +] +[ +.B \-j +] +[ +.B \-J +.I journal-options +] +[ +.B \-m +.I reserved-blocks-percentage +] +[ +.B \-o +.RI [^]mount-options [,...] +] +[ +.B \-r +.I reserved-blocks-count +] +[ +.B \-u +.I user +] +[ +.B \-g +.I group +] +[ +.B \-C +.I mount-count +] +[ +.B \-E +.I extended-options +] +[ +.B \-L +.I volume-label +] +[ +.B \-M +.I last-mounted-directory +] +[ +.B \-O +.RI [^] feature [,...] +] +[ +.B \-Q +.I quota-options +] +[ +.B \-T +.I time-last-checked +] +[ +.B \-U +.I UUID +] +[ +.B \-z +.I undo_file +] +device +.SH DESCRIPTION +.B tune2fs +allows the system administrator to adjust various tunable file system +parameters on Linux ext2, ext3, or ext4 file systems. The current values +of these options can be displayed by using the +.B -l +option to +.BR tune2fs (8) +program, or by using the +.BR dumpe2fs (8) +program. +.PP +The +.I device +specifier can either be a filename (i.e., /dev/sda1), or a LABEL or UUID +specifier: "\fBLABEL=\fIvolume-label\fR" or "\fBUUID=\fIuuid\fR". (i.e., +LABEL=home or UUID=e40486c6-84d5-4f2f-b99c-032281799c9d). +.SH OPTIONS +.TP +.BI \-c " max-mount-counts" +Adjust the number of mounts after which the file system will be checked by +.BR e2fsck (8). +If +.I max-mount-counts +is the string "random", tune2fs will use a random value between 20 and 40. +If +.I max-mount-counts +is 0 or \-1, the number of times the file system is mounted will be disregarded +by +.BR e2fsck (8) +and the kernel. +.sp +Staggering the mount-counts at which file systems are forcibly +checked will avoid all file systems being checked at one time +when using journaled file systems. +.sp +Mount-count-dependent checking is disabled by default to avoid +unanticipated long reboots while e2fsck does its work. If you +are concerned about file system corruptions caused by potential hardware +problems of kernel bugs, a better solution than mount-count-dependent +checking is to use the +.BR e2scrub (8) +program. This does require placing the file system on an LVM volume, +however. +.TP +.BI \-C " mount-count" +Set the number of times the file system has been mounted. +If set to a greater value than the max-mount-counts parameter +set by the +.B \-c +option, +.BR e2fsck (8) +will check the file system at the next reboot. +.TP +.BI \-e " error-behavior" +Change the behavior of the kernel code when errors are detected. +In all cases, a file system error will cause +.BR e2fsck (8) +to check the file system on the next boot. +.I error-behavior +can be one of the following: +.RS 1.2i +.TP 1.2i +.B continue +Continue normal execution. +.TP +.B remount-ro +Remount file system read-only. +.TP +.B panic +Cause a kernel panic. +.RE +.TP +.BI \-E " extended-options" +Set extended options for the file system. Extended options are comma +separated, and may take an argument using the equals ('=') sign. +The following extended options are supported: +.RS 1.2i +.TP +.B clear_mmp +Reset the MMP block (if any) back to the clean state. Use only if +absolutely certain the device is not currently mounted or being +fscked, or major file system corruption can result. Needs '-f'. +.TP +.BI mmp_update_interval= interval +Adjust the initial MMP update interval to +.I interval +seconds. Specifying an +.I interval +of 0 means to use the default interval. The specified interval must +be less than 300 seconds. Requires that the +.B mmp +feature be enabled. +.TP +.BI stride= stride-size +Configure the file system for a RAID array with +.I stride-size +file system blocks. This is the number of blocks read or written to disk +before moving to next disk. This mostly affects placement of file system +metadata like bitmaps at +.BR mke2fs (2) +time to avoid placing them on a single disk, which can hurt the performance. +It may also be used by block allocator. +.TP +.BI stripe_width= stripe-width +Configure the file system for a RAID array with +.I stripe-width +file system blocks per stripe. This is typically be stride-size * N, where +N is the number of data disks in the RAID (e.g. RAID 5 N+1, RAID 6 N+2). +This allows the block allocator to prevent read-modify-write of the +parity in a RAID stripe if possible when the data is written. +.TP +.BI hash_alg= hash-alg +Set the default hash algorithm used for file systems with hashed b-tree +directories. Valid algorithms accepted are: +.IR legacy , +.IR half_md4 , +and +.IR tea . +.TP +.BI encoding= encoding-name +Enable the +.I casefold +feature in the super block and set +.I encoding-name +as the encoding to be used. If +.I encoding-name +is not specified, utf8 is used. The encoding cannot be altered if casefold +was previously enabled. +.TP +.BI encoding_flags= encoding-flags +Define parameters for file name character encoding operations. If a +flag is not changed using this parameter, its default value is used. +.I encoding-flags +should be a comma-separated lists of flags to be enabled. The flags cannot be +altered if casefold was previously enabled. + +The only flag that can be set right now is +.I strict +which means that invalid strings should be rejected by the file system. +In the default configuration, the +.I strict +flag is disabled. +.TP +.BI mount_opts= mount_option_string +Set a set of default mount options which will be used when the file +system is mounted. Unlike the bitmask-based default mount options which +can be specified with the +.B -o +option, +.I mount_option_string +is an arbitrary string with a maximum length of 63 bytes, which is +stored in the superblock. +.IP +The ext4 file system driver will first apply +the bitmask-based default options, and then parse the +.IR mount_option_string , +before parsing the mount options passed from the +.BR mount (8) +program. +.IP +This superblock setting is only honored in 2.6.35+ kernels; +and not at all by the ext2 and ext3 file system drivers. +.TP +.BI orphan_file_size= size +Set size of the file for tracking unlinked but still open inodes and inodes +with truncate in progress. Larger file allows for better scalability, reserving +a few blocks per cpu is ideal. +.TP +.B force_fsck +Set a flag in the file system superblock indicating that errors have been found. +This will force fsck to run at the next mount. +.TP +.B test_fs +Set a flag in the file system superblock indicating that it may be +mounted using experimental kernel code, such as the ext4dev file system. +.TP +.B ^test_fs +Clear the test_fs flag, indicating the file system should only be mounted +using production-level file system code. +.RE +.TP +.B \-f +Force the tune2fs operation to complete even in the face of errors. This +option is useful when removing the +.B has_journal +file system feature from a file system which has +an external journal (or is corrupted +such that it appears to have an external journal), but that +external journal is not available. If the file system appears to require +journal replay, the +.B \-f +flag must be specified twice to proceed. +.sp +.B WARNING: +Removing an external journal from a file system which was not cleanly unmounted +without first replaying the external journal can result in +severe data loss and file system corruption. +.TP +.BI \-g " group" +Set the group which can use the reserved file system blocks. +The +.I group +parameter can be a numerical gid or a group name. If a group name is given, +it is converted to a numerical gid before it is stored in the superblock. +.TP +.B \-i " \fIinterval-between-checks\fR[\fBd\fR|\fBm\fR|\fBw\fR]" +Adjust the maximal time between two file system checks. +No suffix or +.B d +will interpret the number +.I interval-between-checks +as days, +.B m +as months, and +.B w +as weeks. A value of zero will disable the time-dependent checking. +.sp +There are pros and cons to disabling these periodic checks; see the +discussion under the +.B \-c +(mount-count-dependent check) option for details. +.TP +.B \-I +Change the inode size used by the file system. This requires rewriting +the inode table, so it requires that the file system is checked for +consistency first using +.BR e2fsck (8). +This operation can also take a while and the file system can be +corrupted and data lost if it is interrupted while in the middle of +converting the file system. Backing up the file system before changing +inode size is recommended. +.IP +File systems with an inode size of 128 bytes do not support timestamps +beyond January 19, 2038. Inodes which are 256 bytes or larger will +support extended timestamps, project id's, and the ability to store some +extended attributes in the inode table for improved performance. +.TP +.B \-j +Add an ext3 journal to the file system. If the +.B \-J +option is not specified, the default journal parameters will be used to create +an appropriately sized journal (given the size of the file system) +stored within the file system. Note that you must be using a kernel +which has ext3 support in order to actually make use of the journal. +.IP +If this option is used to create a journal on a mounted file system, an +immutable file, +.BR .journal , +will be created in the top-level directory of the file system, as it is +the only safe way to create the journal inode while the file system is +mounted. While the ext3 journal is visible, it is not safe to +delete it, or modify it while the file system is mounted; for this +reason the file is marked immutable. +While checking unmounted file systems, +.BR e2fsck (8) +will automatically move +.B .journal +files to the invisible, reserved journal inode. For all file systems +except for the root file system, this should happen automatically and +naturally during the next reboot cycle. Since the root file system is +mounted read-only, +.BR e2fsck (8) +must be run from a rescue floppy in order to effect this transition. +.IP +On some distributions, such as Debian, if an initial ramdisk is used, +the initrd scripts will automatically convert an ext2 root file system +to ext3 if the +.B /etc/fstab +file specifies the ext3 file system for the root file system in order to +avoid requiring the use of a rescue floppy to add an ext3 journal to +the root file system. +.TP +.BR \-J " journal-options" +Override the default ext3 journal parameters. Journal options are comma +separated, and may take an argument using the equals ('=') sign. +The following journal options are supported: +.RS 1.2i +.TP +.BI size= journal-size +Create a journal stored in the file system of size +.I journal-size +megabytes. The size of the journal must be at least 1024 file system blocks +(i.e., 1MB if using 1k blocks, 4MB if using 4k blocks, etc.) +and may be no more than 10,240,000 file system blocks. +There must be enough free space in the file system to create a journal of +that size. +.TP +.BI fast_commit_size= fast-commit-size +Create an additional fast commit journal area of size +.I fast-commit-size +kilobytes. +This option is only valid if +.B fast_commit +feature is enabled +on the file system. If this option is not specified and if +.B fast_commit +feature is turned on, fast commit area size defaults to +.I journal-size +/ 64 megabytes. The total size of the journal with +.B fast_commit +feature set is +.I journal-size ++ ( +.I fast-commit-size +* 1024) megabytes. The total journal size may be no more than +10,240,000 file system blocks or half the total file system size +(whichever is smaller). +.TP +.BI location =journal-location +Specify the location of the journal. The argument +.I journal-location +can either be specified as a block number, or if the number has a units +suffix (e.g., 'M', 'G', etc.) interpret it as the offset from the +beginning of the file system. +.TP +.BI device= external-journal +Attach the file system to the journal block device located on +.IR external-journal . +The external +journal must have been already created using the command +.IP +.B mke2fs -O journal_dev +.I external-journal +.IP +Note that +.I external-journal +must be formatted with the same block +size as file systems which will be using it. +In addition, while there is support for attaching +multiple file systems to a single external journal, +the Linux kernel and +.BR e2fsck (8) +do not currently support shared external journals yet. +.IP +Instead of specifying a device name directly, +.I external-journal +can also be specified by either +.BI LABEL= label +or +.BI UUID= UUID +to locate the external journal by either the volume label or UUID +stored in the ext2 superblock at the start of the journal. Use +.BR dumpe2fs (8) +to display a journal device's volume label and UUID. See also the +.B -L +option of +.BR tune2fs (8). +.RE +.IP +Only one of the +.BR size " or " device +options can be given for a file system. +.TP +.B \-l +List the contents of the file system superblock, including the current +values of the parameters that can be set via this program. +.TP +.BI \-L " volume-label" +Set the volume label of the file system. +Ext2 file system labels can be at most 16 characters long; if +.I volume-label +is longer than 16 characters, +.B tune2fs +will truncate it and print a warning. For other file systems that +support online label manipulation and are mounted +.B tune2fs +will work as well, but it will not attempt to truncate the +.I volume-label +at all. The volume label can be used by +.BR mount (8), +.BR fsck (8), +and +.BR /etc/fstab (5) +(and possibly others) by specifying +.BI LABEL= volume-label +instead of a block special device name like +.BR /dev/hda5 . +.TP +.BI \-m " reserved-blocks-percentage" +Set the percentage of the file system which may only be allocated +by privileged processes. Reserving some number of file system blocks +for use by privileged processes is done +to avoid file system fragmentation, and to allow system +daemons, such as +.BR syslogd (8), +to continue to function correctly after non-privileged processes are +prevented from writing to the file system. Normally, the default percentage +of reserved blocks is 5%. +.TP +.BI \-M " last-mounted-directory" +Set the last-mounted directory for the file system. +.TP +.BR \-o " [^]\fImount-option\fR[,...]" +Set or clear the indicated default mount options in the file system. +Default mount options can be overridden by mount options specified +either in +.BR /etc/fstab (5) +or on the command line arguments to +.BR mount (8). +Older kernels may not support this feature; in particular, +kernels which predate 2.4.20 will almost certainly ignore the +default mount options field in the superblock. +.IP +More than one mount option can be cleared or set by separating +features with commas. Mount options prefixed with a +caret character ('^') will be cleared in the file system's superblock; +mount options without a prefix character or prefixed with a plus +character ('+') will be added to the file system. +.IP +The following mount options can be set or cleared using +.BR tune2fs : +.RS 1.2i +.TP +.B debug +Enable debugging code for this file system. +.TP +.B bsdgroups +Emulate BSD behavior when creating new files: they will take the group-id +of the directory in which they were created. The standard System V behavior +is the default, where newly created files take on the fsgid of the current +process, unless the directory has the setgid bit set, in which case it takes +the gid from the parent directory, and also gets the setgid bit set if it is +a directory itself. +.TP +.B user_xattr +Enable user-specified extended attributes. +.TP +.B acl +Enable Posix Access Control Lists. +.TP +.B uid16 +Disables 32-bit UIDs and GIDs. This is for interoperability with +older kernels which only store and expect 16-bit values. +.TP +.B journal_data +When the file system is mounted with journaling enabled, all data +(not just metadata) is committed into the journal prior to being written +into the main file system. +.TP +.B journal_data_ordered +When the file system is mounted with journaling enabled, all data is forced +directly out to the main file system prior to its metadata being committed +to the journal. +.TP +.B journal_data_writeback +When the file system is mounted with journaling enabled, data may be +written into the main file system after its metadata has been committed +to the journal. This may increase throughput, however, it may allow old +data to appear in files after a crash and journal recovery. +.TP +.B nobarrier +The file system will be mounted with barrier operations in the journal +disabled. (This option is currently only supported by the ext4 file +system driver in 2.6.35+ kernels.) +.TP +.B block_validity +The file system will be mounted with the block_validity option enabled, +which causes extra checks to be performed after reading or writing from +the file system. This prevents corrupted metadata blocks from causing +file system damage by overwriting parts of the inode table or block +group descriptors. This comes at the cost of increased memory and CPU +overhead, so it is enabled only for debugging purposes. (This option is +currently only supported by the ext4 file system driver in 2.6.35+ +kernels.) +.TP +.B discard +The file system will be mounted with the discard mount option. This will +cause the file system driver to attempt to use the trim/discard feature +of some storage devices (such as SSD's and thin-provisioned drives +available in some enterprise storage arrays) to inform the storage +device that blocks belonging to deleted files can be reused for other +purposes. (This option is currently only supported by the ext4 file +system driver in 2.6.35+ kernels.) +.TP +.B nodelalloc +The file system will be mounted with the nodelalloc mount option. This +will disable the delayed allocation feature. (This option is currently +only supported by the ext4 file system driver in 2.6.35+ kernels.) +.RE +.TP +.BR \-O " [^]\fIfeature\fR[,...]" +Set or clear the indicated file system features (options) in the file system. +More than one file system feature can be cleared or set by separating +features with commas. File System features prefixed with a +caret character ('^') will be cleared in the file system's superblock; +file system features without a prefix character or prefixed with a plus +character ('+') will be added to the file system. For a detailed +description of the file system features, please see the man page +.BR ext4 (5). +.IP +The following file system features can be set or cleared using +.BR tune2fs : +.RS 1.2i +.TP +.B 64bit +Enable the file system to be larger than 2^32 blocks. +.TP +.B casefold +Enable support for file system level casefolding. +The option can be cleared only if filesystem has no +directories with +.B F +attribute. +.TP +.B dir_index +Use hashed b-trees to speed up lookups for large directories. +.TP +.B dir_nlink +Allow more than 65000 subdirectories per directory. +.TP +.B ea_inode +Allow the value of each extended attribute to be placed in the data blocks of a +separate inode if necessary, increasing the limit on the size and number of +extended attributes per file. +.B Tune2fs +currently only supports setting this file system feature. +.TP +.B encrypt +Enable support for file system level encryption. +.B Tune2fs +currently only supports setting this file system feature. +.TP +.B extent +Enable the use of extent trees to store the location of data blocks in inodes. +.B Tune2fs +currently only supports setting this file system feature. +.TP +.B extra_isize +Enable the extended inode fields used by ext4. +.TP +.B filetype +Store file type information in directory entries. +.TP +.B flex_bg +Allow bitmaps and inode tables for a block group to be placed +anywhere on the storage media. \fBTune2fs\fR will not reorganize +the location of the inode tables and allocation bitmaps, as +.BR mke2fs (8) +will do when it creates a freshly formatted file system with +.B flex_bg +enabled. +.TP +.B has_journal +Use a journal to ensure file system consistency even across unclean shutdowns. +Setting the file system feature is equivalent to using the +.B \-j +option. +.TP +.TP +.B fast_commit +Enable fast commit journaling feature to improve fsync latency. +.TP +.B large_dir +Increase the limit on the number of files per directory. +.B Tune2fs +currently only supports setting this file system feature. +.TP +.B huge_file +Support files larger than 2 terabytes in size. +.TP +.B large_file +File System can contain files that are greater than 2GB. +.TP +.B metadata_csum +Store a checksum to protect the contents in each metadata block. +.TP +.B metadata_csum_seed +Allow the file system to store the metadata checksum seed in the +superblock, enabling the administrator to change the UUID of a file system +using the +.B metadata_csum +feature while it is mounted. +.TP +.B mmp +Enable or disable multiple mount protection (MMP) feature. +.TP +.B project +Enable project ID tracking. This is used for project quota tracking. +.TP +.B quota +Enable internal file system quota inodes. +.TP +.B read-only +Force the kernel to mount the file system read-only. +.TP +.B resize_inode +Reserve space so the block group descriptor table may grow in the +future. +.B Tune2fs +only supports clearing this file system feature. +.TP +.B sparse_super +Limit the number of backup superblocks to save space on large file systems. +.B Tune2fs +currently only supports setting this file system feature. +.TP +.B stable_inodes +Prevent the file system from being shrunk or having its UUID changed, in order to +allow the use of specialized encryption settings that make use of the inode +numbers and UUID. +.B Tune2fs +currently only supports setting this file system feature. +.TP +.B uninit_bg +Allow the kernel to initialize bitmaps and inode tables lazily, and to +keep a high watermark for the unused inodes in a file system, to reduce +.BR e2fsck (8) +time. The first e2fsck run after enabling this feature will take the +full time, but subsequent e2fsck runs will take only a fraction of the +original time, depending on how full the file system is. +.TP +.B verity +Enable support for verity protected files. +.B Tune2fs +currently only supports setting this file system feature. +.RE +.IP +After setting or clearing +.BR sparse_super , +.BR uninit_bg , +.BR filetype , +or +.B resize_inode +file system features, +the file system may require being checked using +.BR e2fsck (8) +to return the file system to a consistent state. +.B Tune2fs +will print a message requesting that the system administrator run +.BR e2fsck (8) +if necessary. After setting the +.B dir_index +feature, +.B e2fsck -D +can be run to convert existing directories to the hashed B-tree format. +Enabling certain file system features may prevent the file system from being +mounted by kernels which do not support those features. In particular, the +.B uninit_bg +and +.B flex_bg +features are only supported by the ext4 file system. +.TP +.BI \-r " reserved-blocks-count" +Set the number of reserved file system blocks. +.TP +.BI \-Q " quota-options" +Sets 'quota' feature on the superblock and works on the quota files for the +given quota type. Quota options could be one or more of the following: +.RS 1.2i +.TP +.B [^]usrquota +Sets/clears user quota inode in the superblock. +.TP +.B [^]grpquota +Sets/clears group quota inode in the superblock. +.TP +.B [^]prjquota +Sets/clears project quota inode in the superblock. +.RE +.TP +.BI \-T " time-last-checked" +Set the time the file system was last checked using +.BR e2fsck . +The time is interpreted using the current (local) timezone. +This can be useful in scripts which use a Logical Volume Manager to make +a consistent snapshot of a file system, and then check the file system +during off hours to make sure it hasn't been corrupted due to +hardware problems, etc. If the file system was clean, then this option can +be used to set the last checked time on the original file system. The format +of +.I time-last-checked +is the international date format, with an optional time specifier, i.e. +YYYYMMDD[HH[MM[SS]]]. The keyword +.B now +is also accepted, in which case the last checked time will be set to the +current time. +.TP +.BI \-u " user" +Set the user who can use the reserved file system blocks. +.I user +can be a numerical uid or a user name. If a user name is given, it +is converted to a numerical uid before it is stored in the superblock. +.TP +.BI \-U " UUID" +Set the universally unique identifier (UUID) of the file system to +.IR UUID . +The format of the UUID is a series of hex digits separated by hyphens, +like this: +"c1b9d5a2-f162-11cf-9ece-0020afc76f16". +The +.I UUID +parameter may also be one of the following: +.RS 1.2i +.TP +.I clear +clear the file system UUID +.TP +.I random +generate a new randomly-generated UUID +.TP +.I time +generate a new time-based UUID +.RE +.IP +The UUID may be used by +.BR mount (8), +.BR fsck (8), +and +.BR /etc/fstab (5) +(and possibly others) by specifying +.BI UUID= uuid +instead of a block special device name like +.BR /dev/hda1 . +.IP +See +.BR uuidgen (8) +for more information. +If the system does not have a good random number generator such as +.I /dev/random +or +.IR /dev/urandom , +.B tune2fs +will automatically use a time-based UUID instead of a randomly-generated UUID. +.TP +.BI \-z " undo_file" +Before overwriting a file system block, write the old contents of the block to +an undo file. This undo file can be used with e2undo(8) to restore the old +contents of the file system should something go wrong. If the empty string is +passed as the undo_file argument, the undo file will be written to a file named +tune2fs-\fIdevice\fR.e2undo in the directory specified via the +\fIE2FSPROGS_UNDO_DIR\fR environment variable. + +WARNING: The undo file cannot be used to recover from a power or system crash. +.SH BUGS +We haven't found any bugs yet. That doesn't mean there aren't any... +.SH AUTHOR +.B tune2fs +was written by Remy Card <Remy.Card@linux.org>. It is currently being +maintained by Theodore Ts'o <tytso@alum.mit.edu>. +.B tune2fs +uses the ext2fs library written by Theodore Ts'o <tytso@mit.edu>. +This manual page was written by Christian Kuhtz <chk@data-hh.Hanse.DE>. +Time-dependent checking was added by Uwe Ohse <uwe@tirka.gun.de>. +.SH AVAILABILITY +.B tune2fs +is part of the e2fsprogs package and is available from +http://e2fsprogs.sourceforge.net. +.SH SEE ALSO +.BR debugfs (8), +.BR dumpe2fs (8), +.BR e2fsck (8), +.BR mke2fs (8), +.BR ext4 (5) diff --git a/upstream/opensuse-leap-15-6/man8/tunelp.8 b/upstream/opensuse-leap-15-6/man8/tunelp.8 new file mode 100644 index 00000000..0fba0ed8 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/tunelp.8 @@ -0,0 +1,111 @@ +'\" t +.\" Title: tunelp +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-01-06 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "TUNELP" "8" "2022-01-06" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +tunelp \- set various parameters for the lp device +.SH "SYNOPSIS" +.sp +\fBtunelp\fP [options] \fIdevice\fP +.SH "DESCRIPTION" +.sp +\fBtunelp\fP sets several parameters for the /dev/lp\fI?\fP devices, for better performance (or for any performance at all, if your printer won\(cqt work without it...) Without parameters, it tells whether the device is using interrupts, and if so, which one. With parameters, it sets the device characteristics accordingly. +.SH "OPTIONS" +.sp +\fB\-i\fP, \fB\-\-irq\fP \fIargument\fP +.RS 4 +specifies the IRQ to use for the parallel port in question. If this is set to something non\-zero, \fB\-t\fP and \fB\-c\fP have no effect. If your port does not use interrupts, this option will make printing stop. The command \fBtunelp \-i 0\fP restores non\-interrupt driven (polling) action, and your printer should work again. If your parallel port does support interrupts, interrupt\-driven printing should be somewhat faster and efficient, and will probably be desirable. +.sp +\fBNOTE\fP: This option will have no effect with kernel 2.1.131 or later since the irq is handled by the parport driver. You can change the parport irq for example via \fI/proc/parport/*/irq\fP. Read \fI/usr/src/linux/Documentation/admin\-guide/parport.rst\fP for more details on parport. +.RE +.sp +\fB\-t\fP, \fB\-\-time\fP \fImilliseconds\fP +.RS 4 +is the amount of time in jiffies that the driver waits if the printer doesn\(cqt take a character for the number of tries dictated by the \fB\-c\fP parameter. 10 is the default value. If you want fastest possible printing, and don\(cqt care about system load, you may set this to 0. If you don\(cqt care how fast your printer goes, or are printing text on a slow printer with a buffer, then 500 (5 seconds) should be fine, and will give you very low system load. This value generally should be lower for printing graphics than text, by a factor of approximately 10, for best performance. +.RE +.sp +\fB\-c\fP, \fB\-\-chars\fP \fIcharacters\fP +.RS 4 +is the number of times to try to output a character to the printer before sleeping for \fB\-t\fP \fITIME\fP. It is the number of times around a loop that tries to send a character to the printer. 120 appears to be a good value for most printers in polling mode. 1000 is the default, because there are some printers that become jerky otherwise, but you \fImust\fP set this to \(aq1\(aq to handle the maximal CPU efficiency if you are using interrupts. If you have a very fast printer, a value of 10 might make more sense even if in polling mode. If you have a \fIreally\fP old printer, you can increase this further. +.sp +Setting \fB\-t\fP \fITIME\fP to 0 is equivalent to setting \fB\-c\fP \fICHARS\fP to infinity. +.RE +.sp +\fB\-w\fP, \fB\-\-wait\fP \fImilliseconds\fP +.RS 4 +is the number of usec we wait while playing with the strobe signal. While most printers appear to be able to deal with an extremely short strobe, some printers demand a longer one. Increasing this from the default 1 may make it possible to print with those printers. This may also make it possible to use longer cables. It\(cqs also possible to decrease this value to 0 if your printer is fast enough or your machine is slow enough. +.RE +.sp +\fB\-a\fP, \fB\-\-abort\fP \fI<on|off>\fP +.RS 4 +This is whether to abort on printer error \- the default is not to. If you are sitting at your computer, you probably want to be able to see an error and fix it, and have the printer go on printing. On the other hand, if you aren\(cqt, you might rather that your printer spooler find out that the printer isn\(cqt ready, quit trying, and send you mail about it. The choice is yours. +.RE +.sp +\fB\-o\fP, \fB\-\-check\-status\fP \fI<on|off>\fP +.RS 4 +This option is much like \fB\-a\fP. It makes any \fBopen\fP(2) of this device check to see that the device is on\-line and not reporting any out of paper or other errors. This is the correct setting for most versions of \fBlpd\fP. +.RE +.sp +\fB\-C\fP, \fB\-\-careful\fP \fI<on|off>\fP +.RS 4 +This option adds extra ("careful") error checking. When this option is on, the printer driver will ensure that the printer is on\-line and not reporting any out of paper or other errors before sending data. This is particularly useful for printers that normally appear to accept data when turned off. +.sp +\fBNOTE\fP: This option is obsolete because it\(cqs the default in 2.1.131 kernel or later. +.RE +.sp +\fB\-s\fP, \fB\-\-status\fP +.RS 4 +This option returns the current printer status, both as a decimal number from 0..255, and as a list of active flags. When this option is specified, \fB\-q\fP off, turning off the display of the current IRQ, is implied. +.RE +.sp +\fB\-r\fP, \fB\-\-reset\fP +.RS 4 +This option resets the port. It requires a Linux kernel version of 1.1.80 or later. +.RE +.sp +\fB\-q\fP, \fB\-\-print\-irq\fP \fI<on|off>\fP +.RS 4 +This option sets printing the display of the current IRQ setting. +.RE +.SH "FILES" +.sp +\fI/dev/lp?\fP, +\fI/proc/parport/*/*\fP +.SH "NOTES" +.sp +\fB\-o\fP, \fB\-C\fP, and \fB\-s\fP all require a Linux kernel version of 1.1.76 or later. +.sp +\fB\-C\fP requires a Linux version prior to 2.1.131. +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBtunelp\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/tzselect.8 b/upstream/opensuse-leap-15-6/man8/tzselect.8 new file mode 100644 index 00000000..4578090f --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/tzselect.8 @@ -0,0 +1,125 @@ +.\" This file is in the public domain, so clarified as of +.\" 2009-05-17 by Arthur David Olson. +.TH tzselect 8 "" "Time Zone Database" +.SH NAME +tzselect \- select a timezone +.SH SYNOPSIS +.ie \n(.g .ds - \f(CR-\fP +.el .ds - \- +.ds d " degrees +.ds m " minutes +.ds s " seconds +.ds _ " \& +.if t \{\ +. if \n(.g .if c \(de .if c \(fm .if c \(sd \{\ +. ds d \(de +. ds m \(fm +. ds s \(sd +. ds _ \| +. \} +.\} +.B tzselect +[ +.B \*-c +.I coord +] [ +.B \*-n +.I limit +] [ +.B \*-\*-help +] [ +.B \*-\*-version +] +.SH DESCRIPTION +The +.B tzselect +program asks the user for information about the current location, +and outputs the resulting timezone to standard output. +The output is suitable as a value for the TZ environment variable. +.PP +All interaction with the user is done via standard input and standard error. +.SH OPTIONS +.TP +.BI "\*-c " coord +Instead of asking for continent and then country and then city, +ask for selection from time zones whose largest cities +are closest to the location with geographical coordinates +.I coord. +Use ISO 6709 notation for +.I coord, +that is, a latitude immediately followed by a longitude. The latitude +and longitude should be signed integers followed by an optional +decimal point and fraction: positive numbers represent north and east, +negative south and west. Latitudes with two and longitudes with three +integer digits are treated as degrees; latitudes with four or six and +longitudes with five or seven integer digits are treated as +.I "DDMM, DDDMM, DDMMSS," +or +.I DDDMMSS +representing +.I DD +or +.I DDD +degrees, +.I MM +minutes, +and zero or +.I SS +seconds, with any trailing fractions represent fractional minutes or +(if +.I SS +is present) seconds. The decimal point is that of the current locale. +For example, in the (default) C locale, +.B "\*-c\ +40.689\*-074.045" +specifies 40.689\*d\*_N, 74.045\*d\*_W, +.B "\*-c\ +4041.4\*-07402.7" +specifies 40\*d\*_41.4\*m\*_N, 74\*d\*_2.7\*m\*_W, and +.B "\*-c\ +404121\*-0740240" +specifies 40\*d\*_41\*m\*_21\*s\*_N, 74\*d\*_2\*m\*_40\*s\*_W. +If +.I coord +is not one of the documented forms, the resulting behavior is unspecified. +.TP +.BI "\*-n " limit +When +.B \*-c +is used, display the closest +.I limit +locations (default 10). +.TP +.B "\*-\*-help" +Output help information and exit. +.TP +.B "\*-\*-version" +Output version information and exit. +.SH "ENVIRONMENT VARIABLES" +.TP +\f3AWK\fP +Name of a Posix-compliant +.B awk +program (default: +.BR awk ). +.TP +\f3TZDIR\fP +Name of the directory containing timezone data files (default: +.BR /usr/share/zoneinfo ). +.SH FILES +.TP +\f2TZDIR\fP\f3/iso3166.tab\fP +Table of ISO 3166 2-letter country codes and country names. +.TP +\f2TZDIR\fP\f3/zone1970.tab\fP +Table of country codes, latitude and longitude, timezones, and +descriptive comments. +.TP +\f2TZDIR\fP\f3/\fP\f2TZ\fP +Timezone data file for timezone \f2TZ\fP. +.SH "EXIT STATUS" +The exit status is zero if a timezone was successfully obtained from the user, +nonzero otherwise. +.SH "SEE ALSO" +newctime(3), tzfile(5), zdump(8), zic(8) +.SH NOTES +Applications should not assume that +.BR tzselect 's +output matches the user's political preferences. diff --git a/upstream/opensuse-leap-15-6/man8/umount.8 b/upstream/opensuse-leap-15-6/man8/umount.8 new file mode 100644 index 00000000..bce55254 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/umount.8 @@ -0,0 +1,232 @@ +'\" t +.\" Title: umount +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "UMOUNT" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +umount \- unmount filesystems +.SH "SYNOPSIS" +.sp +\fBumount\fP \fB\-a\fP [\fB\-dflnrv\fP] [\fB\-t\fP \fIfstype\fP] [\fB\-O\fP \fIoption\fP...] +.sp +\fBumount\fP [\fB\-dflnrv\fP] {\fIdirectory\fP|\fIdevice\fP} +.sp +\fBumount\fP \fB\-h\fP|\fB\-V\fP +.SH "DESCRIPTION" +.sp +The \fBumount\fP command detaches the mentioned filesystem(s) from the file hierarchy. A filesystem is specified by giving the directory where it has been mounted. Giving the special device on which the filesystem lives may also work, but is obsolete, mainly because it will fail in case this device was mounted on more than one directory. +.sp +Note that a filesystem cannot be unmounted when it is \(aqbusy\(aq \- for example, when there are open files on it, or when some process has its working directory there, or when a swap file on it is in use. The offending process could even be \fBumount\fP itself \- it opens libc, and libc in its turn may open for example locale files. A lazy unmount avoids this problem, but it may introduce other issues. See \fB\-\-lazy\fP description below. +.SH "OPTIONS" +.sp +\fB\-a\fP, \fB\-\-all\fP +.RS 4 +All of the filesystems described in \fI/proc/self/mountinfo\fP (or in deprecated \fI/etc/mtab\fP) are unmounted, except the proc, devfs, devpts, sysfs, rpc_pipefs and nfsd filesystems. This list of the filesystems may be replaced by \fB\-\-types\fP umount option. +.RE +.sp +\fB\-A\fP, \fB\-\-all\-targets\fP +.RS 4 +Unmount all mountpoints in the current mount namespace for the specified filesystem. The filesystem can be specified by one of the mountpoints or the device name (or UUID, etc.). When this option is used together with \fB\-\-recursive\fP, then all nested mounts within the filesystem are recursively unmounted. This option is only supported on systems where \fI/etc/mtab\fP is a symlink to \fI/proc/mounts\fP. +.RE +.sp +\fB\-c\fP, \fB\-\-no\-canonicalize\fP +.RS 4 +Do not canonicalize paths. The paths canonicalization is based on \fBstat\fP(2) and \fBreadlink\fP(2) system calls. These system calls may hang in some cases (for example on NFS if server is not available). The option has to be used with canonical path to the mount point. +.sp +This option is silently ignored by \fBumount\fP for non\-root users. +.sp +For more details about this option see the \fBmount\fP(8) man page. Note that \fBumount\fP does not pass this option to the \fB/sbin/umount.\fP\fItype\fP helpers. +.RE +.sp +\fB\-d\fP, \fB\-\-detach\-loop\fP +.RS 4 +When the unmounted device was a loop device, also free this loop device. This option is unnecessary for devices initialized by \fBmount\fP(8), in this case "autoclear" functionality is enabled by default. +.RE +.sp +\fB\-\-fake\fP +.RS 4 +Causes everything to be done except for the actual system call or umount helper execution; this \(aqfakes\(aq unmounting the filesystem. It can be used to remove entries from the deprecated \fI/etc/mtab\fP that were unmounted earlier with the \fB\-n\fP option. +.RE +.sp +\fB\-f\fP, \fB\-\-force\fP +.RS 4 +Force an unmount (in case of an unreachable NFS system). +.sp +Note that this option does not guarantee that umount command does not hang. It\(cqs strongly recommended to use absolute paths without symlinks to avoid unwanted readlink and stat system calls on unreachable NFS in \fBumount\fP. +.RE +.sp +\fB\-i\fP, \fB\-\-internal\-only\fP +.RS 4 +Do not call the \fB/sbin/umount.\fP\fIfilesystem\fP helper even if it exists. By default such a helper program is called if it exists. +.RE +.sp +\fB\-l\fP, \fB\-\-lazy\fP +.RS 4 +Lazy unmount. Detach the filesystem from the file hierarchy now, and clean up all references to this filesystem as soon as it is not busy anymore. +.sp +A system reboot would be expected in near future if you\(cqre going to use this option for network filesystem or local filesystem with submounts. The recommended use\-case for \fBumount \-l\fP is to prevent hangs on shutdown due to an unreachable network share where a normal umount will hang due to a downed server or a network partition. Remounts of the share will not be possible. +.RE +.sp +\fB\-N\fP, \fB\-\-namespace\fP \fIns\fP +.RS 4 +Perform umount in the mount namespace specified by \fIns\fP. \fIns\fP is either PID of process running in that namespace or special file representing that namespace. +.sp +\fBumount\fP switches to the namespace when it reads \fI/etc/fstab\fP, writes \fI/etc/mtab\fP (or writes to \fI/run/mount\fP) and calls \fBumount\fP(2) system call, otherwise it runs in the original namespace. It means that the target mount namespace does not have to contain any libraries or other requirements necessary to execute \fBumount\fP(2) command. +.sp +See \fBmount_namespaces\fP(7) for more information. +.RE +.sp +\fB\-n\fP, \fB\-\-no\-mtab\fP +.RS 4 +Unmount without writing in \fI/etc/mtab\fP. +.RE +.sp +\fB\-O\fP, \fB\-\-test\-opts\fP \fIoption\fP... +.RS 4 +Unmount only the filesystems that have the specified option set in \fI/etc/fstab\fP. More than one option may be specified in a comma\-separated list. Each option can be prefixed with \fBno\fP to indicate that no action should be taken for this option. +.RE +.sp +\fB\-q\fP, \fB\-\-quiet\fP +.RS 4 +Suppress "not mounted" error messages. +.RE +.sp +\fB\-R\fP, \fB\-\-recursive\fP +.RS 4 +Recursively unmount each specified directory. Recursion for each directory will stop if any unmount operation in the chain fails for any reason. The relationship between mountpoints is determined by \fI/proc/self/mountinfo\fP entries. The filesystem must be specified by mountpoint path; a recursive unmount by device name (or UUID) is unsupported. Since version 2.37 it umounts also all over\-mounted filesystems (more filesystems on the same mountpoint). +.RE +.sp +\fB\-r\fP, \fB\-\-read\-only\fP +.RS 4 +When an unmount fails, try to remount the filesystem read\-only. +.RE +.sp +\fB\-t\fP, \fB\-\-types\fP \fItype\fP... +.RS 4 +Indicate that the actions should only be taken on filesystems of the specified \fItype\fP. More than one type may be specified in a comma\-separated list. The list of filesystem types can be prefixed with \fBno\fP to indicate that no action should be taken for all of the mentioned types. Note that \fBumount\fP reads information about mounted filesystems from kernel (\fI/proc/mounts\fP) and filesystem names may be different than filesystem names used in the \fI/etc/fstab\fP (e.g., "nfs4" vs. "nfs"). +.RE +.sp +\fB\-v\fP, \fB\-\-verbose\fP +.RS 4 +Verbose mode. +.RE +.sp +\fB\-V\fP, \fB\-\-version\fP +.RS 4 +Display version information and exit. +.RE +.sp +\fB\-h\fP, \fB\-\-help\fP +.RS 4 +Display help text and exit. +.RE +.SH "NON\-SUPERUSER UMOUNTS" +.sp +Normally, only the superuser can umount filesystems. However, when \fIfstab\fP contains the \fBuser\fP option on a line, anybody can umount the corresponding filesystem. For more details see \fBmount\fP(8) man page. +.sp +Since version 2.34 the \fBumount\fP command can be used to perform umount operation also for fuse filesystems if kernel mount table contains user\(cqs ID. In this case fstab \fBuser=\fP mount option is not required. +.sp +Since version 2.35 \fBumount\fP command does not exit when user permissions are inadequate by internal libmount security rules. It drops suid permissions and continue as regular non\-root user. This can be used to support use\-cases where root permissions are not necessary (e.g., fuse filesystems, user namespaces, etc). +.SH "LOOP DEVICE" +.sp +The \fBumount\fP command will automatically detach loop device previously initialized by \fBmount\fP(8) command independently of \fI/etc/mtab\fP. +.sp +In this case the device is initialized with "autoclear" flag (see \fBlosetup\fP(8) output for more details), otherwise it\(cqs necessary to use the option \fB\-\-detach\-loop\fP or call \fBlosetup \-d <device>\fP. The autoclear feature is supported since Linux 2.6.25. +.SH "EXTERNAL HELPERS" +.sp +The syntax of external unmount helpers is: +.RS 3 +.ll -.6i +.sp +\fBumount.\fP\fIsuffix\fP {\fIdirectory\fP|\fIdevice\fP} [\fB\-flnrv\fP] [\fB\-N\fP \fInamespace\fP] [\fB\-t\fP \fItype\fP.\fIsubtype\fP] +.br +.RE +.ll +.sp +where \fIsuffix\fP is the filesystem type (or the value from a \fBuhelper=\fP or \fBhelper=\fP marker in the mtab file). The \fB\-t\fP option can be used for filesystems that have subtype support. For example: +.RS 3 +.ll -.6i +.sp +\fBumount.fuse \-t fuse.sshfs\fP +.br +.RE +.ll +.sp +A \fBuhelper=\fP\fIsomething\fP marker (unprivileged helper) can appear in the \fI/etc/mtab\fP file when ordinary users need to be able to unmount a mountpoint that is not defined in \fI/etc/fstab\fP (for example for a device that was mounted by \fBudisks\fP(1)). +.sp +A \fBhelper=\fP\fItype\fP marker in the mtab file will redirect all unmount requests to the \fB/sbin/umount.\fP\fItype\fP helper independently of UID. +.sp +Note that \fI/etc/mtab\fP is currently deprecated and \fBhelper=\fP and other userspace mount options are maintained by libmount. +.SH "ENVIRONMENT" +.sp +LIBMOUNT_FSTAB=<path> +.RS 4 +overrides the default location of the fstab file (ignored for suid) +.RE +.sp +LIBMOUNT_MTAB=<path> +.RS 4 +overrides the default location of the mtab file (ignored for suid) +.RE +.sp +LIBMOUNT_DEBUG=all +.RS 4 +enables \fBlibmount\fP debug output +.RE +.SH "FILES" +.sp +\fI/etc/mtab\fP +.RS 4 +table of mounted filesystems (deprecated and usually replaced by symlink to \fI/proc/mounts\fP) +.RE +.sp +\fI/etc/fstab\fP +.RS 4 +table of known filesystems +.RE +.sp +\fI/proc/self/mountinfo\fP +.RS 4 +table of mounted filesystems generated by kernel. +.RE +.SH "HISTORY" +.sp +A \fBumount\fP command appeared in Version 6 AT&T UNIX. +.SH "SEE ALSO" +.sp +\fBumount\fP(2), +\fBlosetup\fP(8), +\fBmount_namespaces\fP(7), +\fBmount\fP(8) +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBumount\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/umount.nfs.8 b/upstream/opensuse-leap-15-6/man8/umount.nfs.8 new file mode 100644 index 00000000..15addfa0 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/umount.nfs.8 @@ -0,0 +1,70 @@ +.\"@(#)umount.nfs.8" +.TH UMOUNT.NFS 8 "6 Jun 2006" +.SH NAME +umount.nfs, umount.nfs4 \- unmount a Network File System +.SH SYNOPSIS +.BI "umount.nfs" " dir" " [\-fvnrlh ]" +.SH DESCRIPTION +.BR umount.nfs +and +.BR umount.nfs4 +are a part of +.BR nfs (5) +utilities package, which provides NFS client functionality. + +.BR umount.nfs4 +and +.BR umount.nfs +are meant to be used by the +.BR umount (8) +command for unmounting NFS shares. This subcommand, however, can also be used as a standalone command with limited functionality. + +.I dir +is the directory on which the file system is mounted. + +.SH OPTIONS +.TP +.BI "\-f" +Force unmount the file system in case of unreachable NFS system. +.TP +.BI "\-v" +Be verbose. +.TP +.BI "\-n" +Do not update +.I /etc/mtab. +By default, an entry is created in +.I /etc/mtab +for every mounted file system. Use this option to skip deleting an entry. +.TP +.BI "\-r" +In case unmounting fails, try to mount read-only. +.TP +.BI "\-l" +Lazy unmount. Detach the file system from the file system hierarchy now, and cleanup all references to the file system as soon as it is not busy anymore. +.TP +.BI "\-h" +Print help message. + +.SH NOTE +For further information please refer +.BR nfs (5) +and +.BR umount (8) +manual pages. + +.SH FILES +.TP 18n +.I /etc/fstab +file system table +.TP +.I /etc/mtab +table of mounted file systems + +.PD +.SH "SEE ALSO" +.BR nfs (5), +.BR umount (8), + +.SH "AUTHOR" +Amit Gud <agud@redhat.com> diff --git a/upstream/opensuse-leap-15-6/man8/update-pciids.8 b/upstream/opensuse-leap-15-6/man8/update-pciids.8 new file mode 100644 index 00000000..56d670cf --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/update-pciids.8 @@ -0,0 +1,33 @@ +.TH update-pciids 8 "17 November 2017" "pciutils-3.5.6" "The PCI Utilities" + +.SH NAME +update-pciids \- download new version of the PCI ID list + +.SH SYNOPSIS +.B update-pciids +.RB [ -q ] + +.SH DESCRIPTION +.B update-pciids +fetches the current version of the pci.ids file from the primary distribution +site and installs it. + +This utility requires curl, wget or lynx to be installed. If gzip or bzip2 +are available, it automatically downloads the compressed version of the list. + +.SH OPTIONS +.TP +.B -q +Be quiet and do not report anything except errors. + +.SH FILES +.TP +.B /usr/share/pci.ids +Here we install the new list. + +.SH SEE ALSO +.BR lspci (8), +.BR setpci (8) + +.SH AUTHOR +The PCI Utilities are maintained by Martin Mares <mj@ucw.cz>. diff --git a/upstream/opensuse-leap-15-6/man8/usbhid-dump.8 b/upstream/opensuse-leap-15-6/man8/usbhid-dump.8 new file mode 100644 index 00000000..b8d7c615 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/usbhid-dump.8 @@ -0,0 +1,102 @@ +.\"SPDX-License-Identifier: GPL-2.0-or-later +.\" Copyright Nikolai Kondrashov <spbnick@gmail.com> +.TH usbhid-dump "8" "February 2012" "usbutils-014" "Linux USB Utilities" +.IX usbhid-dump +.SH NAME +usbhid-dump \- dump USB HID device report descriptors and streams +.SH SYNOPSIS +.B usbhid-dump +[OPTION]... +.SH DESCRIPTION +.B usbhid-dump +uses +.B libusb +to dump report descriptors and streams from HID (human interface device) +interfaces of USB devices. By default, it dumps HID interfaces of all +connected USB devices, but could be limited to a subset of them, or to a single +interface, using options. + +NOTE: usbhid-dump detaches kernel drivers from the interfaces it dumps and uses +them exclusively, so no other program receives the input in the meantime. The +report descriptor dumping is instantaneous, but the stream dumping continues +until terminated with SIGINT (^C from the terminal) or a timeout expires. + +If you accidentally start dumping a stream from the USB keyboard you use to +control the terminal, the system will stop receiving the input and you won't +be able to terminate usbhid-dump. Just stop your input and wait until the +timeout expires. The stream dumping will stop, the keyboard will be +reattached to the kernel driver and you will regain control. + +The default stream dumping timeout is 60 seconds and could be changed with the +-t option. +.SH OPTIONS +.TP +.B -h, --help +Output a help message and exit. +.TP +.B -v, --version +Output version information and exit. +.TP +.B -s, -a, --address=bus[:dev] +Limit interfaces by bus number and device address. Both 1-255, decimal. +Zeroes match any bus or device. +.TP +.B -d, -m, --model=vid[:pid] +Limit interfaces by device vendor and product IDs. Both 1-FFFF, hexadecimal. +Zeroes match any vendor or product. +.TP +.B -i, --interface=NUMBER +Limit interfaces by number (0-254), decimal. 255 matches any interface. +.TP +.B -e, --entity=STRING +The entity to dump: either "descriptor", "stream" or "all". The value can be +abbreviated down to one letter. The default is "descriptor". +.TP +.B -t, --stream-timeout=NUMBER +Stream interrupt transfer timeout, ms. Zero means infinity. The default is +60000 (60 seconds). +.TP +.B -p, --stream-paused +Start with the stream dump output paused. +.TP +.B -f, --stream-feedback +Enable stream dumping feedback: print a dot to stderr for every transfer +dumped. +.SH SIGNALS +.TP +.B USR1/USR2 +Pause/resume stream dump output. +.SH OUTPUT FORMAT +.B usbhid-dump +outputs dumps in chunks. Each chunk is separated by an empty line and starts +with the following header line: + +BUS:DEVICE:INTERFACE:ENTITY TIMESTAMP + +Here, BUS, DEVICE and INTERFACE are bus, device and interface numbers +respectively. ENTITY is either "DESCRIPTOR" or "STREAM". TIMESTAMP is +timestamp in seconds since epoch. + +After the header the actual dump data follows as hex bytes. A descriptor +chunk includes the whole report descriptor. Every stream chunk includes a +whole report, usually, but if a report is bigger than endpoint's +wMaxPacketSize, it will span several chunks. +.SH EXAMPLES +.TP +Dump report descriptor for a device with address 3 on bus number 2: +.B usbhid-dump -a 2:3 + +.TP +Dump report stream for a device with vendor ID 0x5543 and product ID 0x0005: +.B usbhid-dump -m 5543:0005 -es + +.TP +Dump report descriptor from interface 1 of a device with vendor ID 0x5543: +.B usbhid-dump -m 5543 -i 1 -ed + +.TP +Dump report streams from all HID interfaces of all USB devices (caution: you will lose control over the terminal if you use USB keyboard): +.B usbhid-dump -es + +.SH AUTHOR +Nikolai Kondrashov <spbnick@gmail.com> diff --git a/upstream/opensuse-leap-15-6/man8/uucico.8 b/upstream/opensuse-leap-15-6/man8/uucico.8 new file mode 100644 index 00000000..8a7f12e4 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/uucico.8 @@ -0,0 +1,276 @@ +'\" +.\" $Id: uucico.8,v 1.20 2002/03/05 22:20:48 ian Rel $ +.\" +.TH uucico 8 "Taylor UUCP 1.07" +.SH NAME +uucico \- UUCP file transfer daemon +.SH SYNOPSIS +.B uucico +[ options ] +.SH DESCRIPTION +The +.I uucico +daemon processes file transfer requests queued by +.I uucp +(1) and +.I uux +(1). It is started when +.I uucp +or +.I uux +is run (unless they are given the +.B \-r +option). It is also typically started periodically using +entries in the +.I crontab +table(s). + +When invoked with +.B \-r1, +.B \-\-master, +.B \-s, +.B \-\-system, +or +.B \-S, +the daemon will place a call to a remote system, running in master +mode. Otherwise the daemon will start in slave mode, accepting a call +from a remote system. Typically a special login name will be set up +for UUCP which automatically invokes +.I uucico +when a call is made. + +When +.I uucico +terminates, it invokes the +.I uuxqt +(8) daemon, unless the +.B \-q +or +.B \-\-nouuxqt +option is given; +.I uuxqt +(8) executes any work orders created by +.I uux +(1) on a remote system, and any work orders created locally which have +received remote files for which they were waiting. + +If a call fails, +.I uucico +will normally refuse to retry the +call until a certain (configurable) amount of time +has passed. This may be overridden by the +.B -f, +.B --force, +or +.B -S +option. + +The +.B \-l, +.B \-\-prompt, +.B \-e, +or +.B \-\-loop +options may be used to force +.I uucico +to produce its own prompts of "login: " and "Password:". When another +daemon calls in, it will see these prompts and log in as usual. The +login name and password will normally be checked against a separate +list kept specially for +.I uucico +rather than the +.I /etc/passwd +file; it is possible on some systems to direct +.I uucico +to use the +.I /etc/passwd +file. The +.B \-l +or +.B \--prompt +option will prompt once and then exit; in this mode the UUCP +administrator or the superuser may use the +.B \-u +or +.B \--login +option to force a login name, in which case +.I uucico +will not prompt for one. +The +.B \-e +or +.B \--loop +option will prompt again after the first session is over; in this mode +.I uucico +will permanently control a port. + +If +.I uucico +receives a SIGQUIT, SIGTERM or SIGPIPE signal, it will cleanly abort +any current conversation with a remote system and exit. If it +receives a SIGHUP signal it will abort any current conversation, but +will continue to place calls to (if invoked with +.B \-r1 +or +.B \-\-master) +and accept calls from (if invoked with +.B \-e +or +.B \-\-loop) +other systems. If it receives a +SIGINT signal it will finish the current conversation, but will not +place or accept any more calls. +.SH OPTIONS +The following options may be given to +.I uucico. +.TP 5 +.B \-r1, \-\-master +Start in master mode (call out to a system); implied by +.B \-s, +.B \-\-system, +or +.B \-S. +If no system is specified, call any system for which work is waiting +to be done. +.TP 5 +.B \-r0, \-\-slave +Start in slave mode. This is the default. +.TP 5 +.B \-s system, \-\-system system +Call the named system. +.TP 5 +.B \-S system +Call the named system, ignoring any required wait. This is equivalent +to +.B \-s system \-f. +.TP 5 +.B \-f, \-\-force +Ignore any required wait for any systems to be called. +.TP 5 +.B \-g, \-\-grade +Limit outgoing call to a given grade. +.TP 5 +.B \-l, \-\-prompt +Prompt for login name and password using "login: " and "Password:". +This allows +.I uucico +to be easily run from +.I inetd +(8). The login name and password are checked against the UUCP +password file, which probably has no connection to the file +.I /etc/passwd. +The +.B \-\-login +option may be used to force a login name, in which cause +.I uucico +will only prompt for a password. +.TP 5 +.B \-p port, \-\-port port +Specify a port to call out on or to listen to. +.TP 5 +.B \-e, \-\-loop +Enter endless loop of login/password prompts and slave mode daemon +execution. The program will not stop by itself; you must use +.I kill +(1) to shut it down. +.TP 5 +.B \-w, \-\-wait +After calling out (to a particular system when +.B \-s, +.B \-\-system, +or +.B \-S +is specified, or to all systems which have work when just +.B \-r1 +or +.B \-\-master +is specified), begin an endless loop as with +.B \-\-loop. +.TP 5 +.B \-q, \-\-nouuxqt +Do not start the +.I uuxqt +(8) daemon when finished. +.TP 5 +.B \-c, \-\-quiet +If no calls are permitted at this time, then don't make the call, but +also do not put an error message in the log file and do not update the +system status (as reported by +.I uustat +(1)). This can be convenient for automated polling scripts, which may +want to simply attempt to call every system rather than worry about +which particular systems may be called at the moment. This option +also suppresses the log message indicating that there is no work to be +done. +.TP 5 +.B \-C, \-\-ifwork +Only call the system named by +.B \-s, +.B \-\-system +or +.B \-S +if there is work for that system. +.TP 5 +.B \-D, \-\-nodetach +Do not detach from the controlling terminal. Normally +.I uucico +detaches from the terminal before each call out to another system and +before invoking +.I uuxqt. +This option prevents this. +.TP 5 +.B \-u name, \-\-login name +Set the login name to use instead of that of the invoking user. This +option may only be used by the UUCP administrator or the superuser. +If used with +.B \-\-prompt, +this will cause +.I uucico +to prompt only for the password, not the login name. +.TP 5 +.B \-z, \-\-try-next +If a call fails after the remote system is reached, try the next +alternate rather than simply exiting. +.TP 5 +.B \-i type, \-\-stdin type +Set the type of port to use when using standard input. The only +support port type is TLI, and this is only available on machines which +support the TLI networking interface. Specifying +.B \-iTLI +causes +.I uucico +to use TLI calls to perform I/O. +.TP 5 +.B \-x type, \-X type, \-\-debug type +Turn on particular debugging types. The following types are +recognized: abnormal, chat, handshake, uucp-proto, proto, port, +config, spooldir, execute, incoming, outgoing. + +Multiple types may be given, separated by commas, and the +.B \-\-debug +option may appear multiple times. A number may also be given, which +will turn on that many types from the foregoing list; for example, +.B \-\-debug 2 +is equivalent to +.B \-\-debug abnormal,chat. + +The debugging output is sent to the debugging file, which may be +printed using +.I uulog -D. +.TP 5 +.B \-I file, \-\-config file +Set configuration file to use. This option may not be available, +depending upon how +.I uucico +was compiled. +.TP 5 +.B \-v, \-\-version +Report version information and exit. +.TP 5 +.B \-\-help +Print a help message and exit. +.SH SEE ALSO +kill(1), uucp(1), uux(1), uustat(1), uuxqt(8) +.SH AUTHOR +Ian Lance Taylor +<ian@airs.com> diff --git a/upstream/opensuse-leap-15-6/man8/uuidd.8 b/upstream/opensuse-leap-15-6/man8/uuidd.8 new file mode 100644 index 00000000..554f0416 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/uuidd.8 @@ -0,0 +1,137 @@ +'\" t +.\" Title: uuidd +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "UUIDD" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +uuidd \- UUID generation daemon +.SH "SYNOPSIS" +.sp +\fBuuidd\fP [options] +.SH "DESCRIPTION" +.sp +The \fBuuidd\fP daemon is used by the UUID library to generate universally unique identifiers (UUIDs), especially time\-based UUIDs, in a secure and guaranteed\-unique fashion, even in the face of large numbers of threads running on different CPUs trying to grab UUIDs. +.SH "OPTIONS" +.sp +\fB\-d\fP, \fB\-\-debug\fP +.RS 4 +Run uuidd in debugging mode. This prevents uuidd from running as a daemon. +.RE +.sp +\fB\-F\fP, \fB\-\-no\-fork\fP +.RS 4 +Do not daemonize using a double\-fork. +.RE +.sp +\fB\-k\fP, \fB\-\-kill\fP +.RS 4 +If currently a uuidd daemon is running, kill it. +.RE +.sp +\fB\-n\fP, \fB\-\-uuids\fP \fInumber\fP +.RS 4 +When issuing a test request to a running \fBuuidd\fP, request a bulk response of \fInumber\fP UUIDs. +.RE +.sp +\fB\-P\fP, \fB\-\-no\-pid\fP +.RS 4 +Do not create a pid file. +.RE +.sp +\fB\-p\fP, \fB\-\-pid\fP \fIpath\fP +.RS 4 +Specify the pathname where the pid file should be written. By default, the pid file is written to \fI{runstatedir}/uuidd/uuidd.pid\fP. +.RE +.sp +\fB\-q\fP, \fB\-\-quiet\fP +.RS 4 +Suppress some failure messages. +.RE +.sp +\fB\-r\fP, \fB\-\-random\fP +.RS 4 +Test uuidd by trying to connect to a running uuidd daemon and request it to return a random\-based UUID. +.RE +.sp +\fB\-S\fP, \fB\-\-socket\-activation\fP +.RS 4 +Do not create a socket but instead expect it to be provided by the calling process. This implies \fB\-\-no\-fork\fP and \fB\-\-no\-pid\fP. This option is intended to be used only with \fBsystemd\fP(1). It needs to be enabled with a configure option. +.RE +.sp +\fB\-s\fP, \fB\-\-socket\fP \fIpath\fP +.RS 4 +Make uuidd use this pathname for the unix\-domain socket. By default, the pathname used is \fI{runstatedir}/uuidd/request\fP. This option is primarily for debugging purposes, since the pathname is hard\-coded in the \fBlibuuid\fP library. +.RE +.sp +\fB\-T\fP, \fB\-\-timeout\fP \fInumber\fP +.RS 4 +Make \fBuuidd\fP exit after \fInumber\fP seconds of inactivity. +.RE +.sp +\fB\-t\fP, \fB\-\-time\fP +.RS 4 +Test \fBuuidd\fP by trying to connect to a running uuidd daemon and request it to return a time\-based UUID. +.RE +.sp +\fB\-V\fP, \fB\-\-version\fP +.RS 4 +Output version information and exit. +.RE +.sp +\fB\-h\fP, \fB\-\-help\fP +.RS 4 +Display help screen and exit. +.RE +.SH "EXAMPLE" +.sp +Start up a daemon, print 42 random keys, and then stop the daemon: +.sp +.if n .RS 4 +.nf +.fam C +uuidd \-p /tmp/uuidd.pid \-s /tmp/uuidd.socket +uuidd \-d \-r \-n 42 \-s /tmp/uuidd.socket +uuidd \-d \-k \-s /tmp/uuidd.socket +.fam +.fi +.if n .RE +.SH "AUTHOR" +.sp +The \fBuuidd\fP daemon was written by \c +.MTO "tytso\(atmit.edu" "Theodore Ts\(cqo" "." +.SH "SEE ALSO" +.sp +\fBuuid\fP(3), +\fBuuidgen\fP(1) +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBuuidd\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/uuxqt.8 b/upstream/opensuse-leap-15-6/man8/uuxqt.8 new file mode 100644 index 00000000..607cff27 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/uuxqt.8 @@ -0,0 +1,87 @@ +'\" +.\" $Id: uuxqt.8,v 1.10 2002/03/05 22:20:48 ian Rel $ +.\" +.TH uuxqt 8 "Taylor UUCP 1.07" +.SH NAME +uuxqt \- UUCP execution daemon +.SH SYNOPSIS +.B uuxqt +[ options ] +.SH DESCRIPTION +The +.I uuxqt +daemon executes commands requested by +.I uux +(1) from either the local system or from remote systems. +It is started automatically by the +.I uucico +(8) daemon (unless +.I uucico +(8) is given the +.B \-q +or +.B \-\-nouuxqt +option). + +There is normally no need to run this command, since it will be +invoked by +.I uucico +(8). However, it can be used to provide greater control over the +processing of the work queue. + +Multiple invocations of +.I uuxqt +may be run at once, as controlled by the +.I max-uuxqts +configuration command. +.SH OPTIONS +The following options may be given to +.I uuxqt. +.TP 5 +.B \-c command, \-\-command command +Only execute requests for the specified command. For example: +.br +.in +0.5i +.nf +uuxqt \-\-command rmail +.fi +.in -0.5i +.TP 5 +.B \-s system, \-\-system system +Only execute requests originating from the specified system. +.TP 5 +.B \-x type, \-\-debug type +Turn on particular debugging types. The following types are +recognized: abnormal, chat, handshake, uucp-proto, proto, port, +config, spooldir, execute, incoming, outgoing. Only abnormal, config, +spooldir and execute are meaningful for +.I uuxqt. + +Multiple types may be given, separated by commas, and the +.B \-\-debug +option may appear multiple times. A number may also be given, which +will turn on that many types from the foregoing list; for example, +.B \-\-debug 2 +is equivalent to +.B \-\-debug abnormal,chat. + +The debugging output is sent to the debugging file, which may be +printed using +.I uulog -D. +.TP 5 +.B \-I file, \-\-config +Set configuration file to use. This option may not be available, +depending upon how +.I uuxqt +was compiled. +.TP 5 +.B \-v, \-\-version +Report version information and exit. +.TP 5 +.B \-\-help +Print a help message and exit. +.SH SEE ALSO +uucp(1), uux(1), uucico(8) +.SH AUTHOR +Ian Lance Taylor +(ian@airs.com) diff --git a/upstream/opensuse-leap-15-6/man8/vcstime.8 b/upstream/opensuse-leap-15-6/man8/vcstime.8 new file mode 100644 index 00000000..46823340 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/vcstime.8 @@ -0,0 +1,25 @@ +.\" Copyright 2003 Alastair McKinstry <mckinstry@computer.org>" +.\" May be distributed under the GNU General Public License" +.TH VCSTIME 8 "22 Jan 2003" "kbd" + +.SH NAME +vcstime \- Show time in upper right hand corner of the console screen + +.SH SYNOPSIS +.B vcstime + +.SH DESCRIPTION +.PP +.B vcstime +shows the current time in the upper right\-hand corner of the console screen. +.PP +This simple program shows the current time in the corner of the console screen. +.PP +It needs to be run by root, in order to have write permissions to +.I /dev/vcsa + + +.SH "AUTHORS" +.B vcstime +was written by Andries Brouwer, based on a suggestion by Miguel de Icaza. +This manual page was Written by Alastair McKinstry, Debian, Jan 2003. diff --git a/upstream/opensuse-leap-15-6/man8/vfs_acl_tdb.8 b/upstream/opensuse-leap-15-6/man8/vfs_acl_tdb.8 new file mode 100644 index 00000000..0f2f2044 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/vfs_acl_tdb.8 @@ -0,0 +1,206 @@ +'\" t +.\" Title: vfs_acl_tdb +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 10/23/2023 +.\" Manual: System Administration tools +.\" Source: Samba 4.19.2-git.328.e4c431e307f150600.1.23SUSE-oS15.0-x86_64 +.\" Language: English +.\" +.TH "VFS_ACL_TDB" "8" "10/23/2023" "Samba 4\&.19\&.2\-git\&.328\&." "System Administration tools" +.\" ----------------------------------------------------------------- +.\" * 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" +vfs_acl_tdb \- Save NTFS\-ACLs in a tdb file +.SH "SYNOPSIS" +.HP \w'\ 'u +vfs objects = acl_tdb +.SH "DESCRIPTION" +.PP +This VFS module is part of the +\fBsamba\fR(7) +suite\&. +.PP +The +vfs_acl_tdb +VFS module stores NTFS Access Control Lists (ACLs) in a tdb file\&. This enables the full mapping of Windows ACLs on Samba servers\&. +.PP +The ACL settings are stored in +$LOCKDIR/file_ntacls\&.tdb\&. +.PP +This module forces the following parameters: +.RS +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +inherit acls = true +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +dos filemode = true +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +force unknown acl user = true +.RE +.sp +.RE +.PP +This module is stackable\&. +.SH "OPTIONS" +.PP +acl_tdb:ignore system acls = [yes|no] +.RS 4 +When set to +\fIyes\fR, a best effort mapping from/to the POSIX ACL layer will +\fInot\fR +be done by this module\&. The default is +\fIno\fR, which means that Samba keeps setting and evaluating both the system ACLs and the NT ACLs\&. This is better if you need your system ACLs be set for local or NFS file access, too\&. If you only access the data via Samba you might set this to yes to achieve better NT ACL compatibility\&. +.sp +If +\fIacl_tdb:ignore system acls\fR +is set to +\fIyes\fR, the following additional settings will be enforced: +.RS +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +create mask = 0666 +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +directory mask = 0777 +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +map archive = no +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +map hidden = no +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +map readonly = no +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +map system = no +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +store dos attributes = yes +.RE +.sp +.RE +.RE +.PP +acl_tdb:default acl style = [posix|windows|everyone] +.RS 4 +This parameter determines the type of ACL that is synthesized in case a file or directory lacks an +\fIsecurity\&.NTACL\fR +xattr\&. +.sp +When set to +\fIposix\fR, an ACL will be synthesized based on the POSIX mode permissions for user, group and others, with an additional ACE for +\fINT Authority\eSYSTEM\fR +will full rights\&. +.sp +When set to +\fIwindows\fR, an ACL is synthesized the same way Windows does it, only including permissions for the owner and +\fINT Authority\eSYSTEM\fR\&. +.sp +When set to +\fIeveryone\fR, an ACL is synthesized giving full permissions to everyone (S\-1\-1\-0)\&. +.sp +The default for this option is +\fIposix\fR\&. +.RE +.SH "AUTHOR" +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. diff --git a/upstream/opensuse-leap-15-6/man8/vfs_acl_xattr.8 b/upstream/opensuse-leap-15-6/man8/vfs_acl_xattr.8 new file mode 100644 index 00000000..721b7792 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/vfs_acl_xattr.8 @@ -0,0 +1,218 @@ +'\" t +.\" Title: vfs_acl_xattr +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 10/23/2023 +.\" Manual: System Administration tools +.\" Source: Samba 4.19.2-git.328.e4c431e307f150600.1.23SUSE-oS15.0-x86_64 +.\" Language: English +.\" +.TH "VFS_ACL_XATTR" "8" "10/23/2023" "Samba 4\&.19\&.2\-git\&.328\&." "System Administration tools" +.\" ----------------------------------------------------------------- +.\" * 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" +vfs_acl_xattr \- Save NTFS\-ACLs in Extended Attributes (EAs) +.SH "SYNOPSIS" +.HP \w'\ 'u +vfs objects = acl_xattr +.SH "DESCRIPTION" +.PP +This VFS module is part of the +\fBsamba\fR(7) +suite\&. +.PP +This module is made for systems which do not support standardized NFS4 ACLs but only a deprecated POSIX ACL draft implementation\&. This is usually the case on Linux systems\&. Systems that do support just use NFSv4 ACLs directly instead of this module\&. Such support is usually provided by the filesystem VFS module specific to the underlying filesystem that supports NFS4 ACLs +.PP +The +vfs_acl_xattr +VFS module stores NTFS Access Control Lists (ACLs) in Extended Attributes (EAs)\&. This enables the full mapping of Windows ACLs on Samba servers even if the ACL implementation is not capable of doing so\&. +.PP +The NT ACLs are stored in the +\fIsecurity\&.NTACL\fR +extended attribute of files and directories in a form containing the Windows SID representing the users and groups in the ACL\&. This is different from the uid and gids stored in local filesystem ACLs and the mapping from users and groups to Windows SIDs must be consistent in order to maintain the meaning of the stored NT ACL That extended attribute is +\fInot\fR +listed by the Linux command +getfattr \-d filename\&. To show the current value, the name of the EA must be specified (e\&.g\&. +getfattr \-n security\&.NTACL filename)\&. +.PP +This module forces the following parameters: +.RS +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +inherit acls = true +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +dos filemode = true +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +force unknown acl user = true +.RE +.sp +.RE +.PP +This module is stackable\&. +.SH "OPTIONS" +.PP +acl_xattr:security_acl_name = NAME +.RS 4 +This option allows to redefine the default location for the NTACL extended attribute (xattr)\&. If not set, NTACL xattrs are written to security\&.NTACL which is a protected location, which means the content of the security\&.NTACL attribute is not accessible from normal users outside of Samba\&. When this option is set to use a user\-defined value, e\&.g\&. user\&.NTACL then any user can potentially access and overwrite this information\&. The module prevents access to this xattr over SMB, but the xattr may still be accessed by other means (eg local access, SSH, NFS)\&. This option must only be used when this consequence is clearly understood and when specific precautions are taken to avoid compromising the ACL content\&. +.RE +.PP +acl_xattr:ignore system acls = [yes|no] +.RS 4 +When set to +\fIyes\fR, a best effort mapping from/to the POSIX draft ACL layer will +\fInot\fR +be done by this module\&. The default is +\fIno\fR, which means that Samba keeps setting and evaluating both the system ACLs and the NT ACLs\&. This is better if you need your system ACLs be set for local or NFS file access, too\&. If you only access the data via Samba you might set this to yes to achieve better NT ACL compatibility\&. +.sp +If +\fIacl_xattr:ignore system acls\fR +is set to +\fIyes\fR, the following additional settings will be enforced: +.RS +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +create mask = 0666 +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +directory mask = 0777 +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +map archive = no +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +map hidden = no +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +map readonly = no +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +map system = no +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +store dos attributes = yes +.RE +.sp +.RE +.RE +.PP +acl_xattr:default acl style = [posix|windows|everyone] +.RS 4 +This parameter determines the type of ACL that is synthesized in case a file or directory lacks an +\fIsecurity\&.NTACL\fR +xattr\&. +.sp +When set to +\fIposix\fR, an ACL will be synthesized based on the POSIX mode permissions for user, group and others, with an additional ACE for +\fINT Authority\eSYSTEM\fR +will full rights\&. +.sp +When set to +\fIwindows\fR, an ACL is synthesized the same way Windows does it, only including permissions for the owner and +\fINT Authority\eSYSTEM\fR\&. +.sp +When set to +\fIeveryone\fR, an ACL is synthesized giving full permissions to everyone (S\-1\-1\-0)\&. +.sp +The default for this option is +\fIposix\fR\&. +.RE +.SH "AUTHOR" +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. diff --git a/upstream/opensuse-leap-15-6/man8/vfs_aio_fork.8 b/upstream/opensuse-leap-15-6/man8/vfs_aio_fork.8 new file mode 100644 index 00000000..f06a1691 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/vfs_aio_fork.8 @@ -0,0 +1,68 @@ +'\" t +.\" Title: vfs_aio_fork +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 10/23/2023 +.\" Manual: System Administration tools +.\" Source: Samba 4.19.2-git.328.e4c431e307f150600.1.23SUSE-oS15.0-x86_64 +.\" Language: English +.\" +.TH "VFS_AIO_FORK" "8" "10/23/2023" "Samba 4\&.19\&.2\-git\&.328\&." "System Administration tools" +.\" ----------------------------------------------------------------- +.\" * 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" +vfs_aio_fork \- implement async I/O in Samba vfs +.SH "SYNOPSIS" +.HP \w'\ 'u +vfs objects = aio_fork +.SH "DESCRIPTION" +.PP +This VFS module is part of the +\fBsamba\fR(7) +suite\&. +.PP +The +aio_fork +VFS module enables async I/O for Samba on platforms where the system level Posix AIO interface is insufficient\&. Posix AIO can suffer from severe limitations\&. For example, on some Linux versions the real\-time signals that it uses are broken under heavy load\&. Other systems only allow AIO when special kernel modules are loaded or only allow a certain system\-wide amount of async requests being scheduled\&. Systems based on glibc (most Linux systems) only allow a single outstanding request per file descriptor\&. +.PP +To work around all these limitations, the aio_fork module was written\&. It uses forked helper processes instead of the internal Posix AIO interface to create asynchronousity for read and write calls\&. It has no parameters, it will create helper processes when async requests come in as needed\&. Idle helper processes will be removed every 30 seconds\&. +.PP +This module is stackable\&. +.SH "EXAMPLES" +.PP +Straight forward use: +.sp +.if n \{\ +.RS 4 +.\} +.nf + \fI[cooldata]\fR + \m[blue]\fBpath = /data/ice\fR\m[] + \m[blue]\fBvfs objects = aio_fork\fR\m[] +.fi +.if n \{\ +.RE +.\} +.SH "VERSION" +.PP +This man page is part of version 4\&.19\&.2\-git\&.328\&.e4c431e307f150600\&.1\&.23SUSE\-oS15\&.0\-x86_64 of the Samba suite\&. +.SH "AUTHOR" +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. diff --git a/upstream/opensuse-leap-15-6/man8/vfs_aio_pthread.8 b/upstream/opensuse-leap-15-6/man8/vfs_aio_pthread.8 new file mode 100644 index 00000000..f80dfd26 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/vfs_aio_pthread.8 @@ -0,0 +1,81 @@ +'\" t +.\" Title: vfs_aio_pthread +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 10/23/2023 +.\" Manual: System Administration tools +.\" Source: Samba 4.19.2-git.328.e4c431e307f150600.1.23SUSE-oS15.0-x86_64 +.\" Language: English +.\" +.TH "VFS_AIO_PTHREAD" "8" "10/23/2023" "Samba 4\&.19\&.2\-git\&.328\&." "System Administration tools" +.\" ----------------------------------------------------------------- +.\" * 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" +vfs_aio_pthread \- implement async open in Samba vfs using a pthread pool +.SH "SYNOPSIS" +.HP \w'\ 'u +vfs objects = aio_pthread +.SH "DESCRIPTION" +.PP +This VFS module is part of the +\fBsamba\fR(7) +suite\&. +.PP +The +aio_pthread +VFS module enables asynchronous opens (for new files) with +\m[blue]\fBaio_pthread:aio open = yes\fR\m[] +on platforms which have the pthreads API available, support the openat() syscall and support per thread credentials (modern Linux kernels)\&. +.PP +The module makes use of the global thread pool which uses the +\m[blue]\fBaio max threads\fR\m[] +option\&. +.PP +This module MUST be listed last in any module stack as the Samba VFS open interface is not thread\-safe\&. This module makes direct openat() system calls and does NOT call the Samba VFS open interfaces\&. +.SH "EXAMPLES" +.PP +Straight forward use: +.sp +.if n \{\ +.RS 4 +.\} +.nf + \fI[cooldata]\fR + \m[blue]\fBpath = /data/ice\fR\m[] + \m[blue]\fBvfs objects = aio_pthread\fR\m[] + \m[blue]\fBaio_pthread:aio open = yes\fR\m[] +.fi +.if n \{\ +.RE +.\} +.SH "OPTIONS" +.PP +aio_pthread:aio open = BOOL +.RS 4 +Try async opens for creating new files\&. +.sp +The default is \*(Aqno\*(Aq\&. +.RE +.SH "VERSION" +.PP +This man page is part of version 4\&.19\&.2\-git\&.328\&.e4c431e307f150600\&.1\&.23SUSE\-oS15\&.0\-x86_64 of the Samba suite\&. +.SH "AUTHOR" +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. diff --git a/upstream/opensuse-leap-15-6/man8/vfs_audit.8 b/upstream/opensuse-leap-15-6/man8/vfs_audit.8 new file mode 100644 index 00000000..c025edf6 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/vfs_audit.8 @@ -0,0 +1,118 @@ +'\" t +.\" Title: vfs_audit +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 10/23/2023 +.\" Manual: System Administration tools +.\" Source: Samba 4.19.2-git.328.e4c431e307f150600.1.23SUSE-oS15.0-x86_64 +.\" Language: English +.\" +.TH "VFS_AUDIT" "8" "10/23/2023" "Samba 4\&.19\&.2\-git\&.328\&." "System Administration tools" +.\" ----------------------------------------------------------------- +.\" * 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" +vfs_audit \- record selected Samba VFS operations in the system log +.SH "SYNOPSIS" +.HP \w'\ 'u +vfs objects = audit +.SH "DESCRIPTION" +.PP +This VFS module is part of the +\fBsamba\fR(7) +suite\&. +.PP +The +vfs_audit +VFS module records selected client operations to the system log using +\fBsyslog\fR(3)\&. +.PP +The following Samba VFS operations are recorded: +.RS 4 +connect +.RE +.RS 4 +disconnect +.RE +.RS 4 +opendir +.RE +.RS 4 +mkdir +.RE +.RS 4 +rmdir +.RE +.RS 4 +open +.RE +.RS 4 +close +.RE +.RS 4 +rename +.RE +.RS 4 +unlink +.RE +.RS 4 +chmod +.RE +.RS 4 +fchmod +.RE +.PP +This module is stackable\&. +.SH "OPTIONS" +.PP +audit:facility = FACILITY +.RS 4 +Log messages to the named +\fBsyslog\fR(3) +facility\&. +.RE +.PP +audit:priority = PRIORITY +.RS 4 +Log messages with the named +\fBsyslog\fR(3) +priority\&. +.RE +.SH "EXAMPLES" +.PP +Log operations on all shares using the LOCAL1 facility and NOTICE priority: +.sp +.if n \{\ +.RS 4 +.\} +.nf + \fI[global]\fR + \m[blue]\fBvfs objects = audit\fR\m[] + \m[blue]\fBaudit:facility = LOCAL1\fR\m[] + \m[blue]\fBaudit:priority = NOTICE\fR\m[] +.fi +.if n \{\ +.RE +.\} +.SH "VERSION" +.PP +This man page is part of version 4\&.19\&.2\-git\&.328\&.e4c431e307f150600\&.1\&.23SUSE\-oS15\&.0\-x86_64 of the Samba suite\&. +.SH "AUTHOR" +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. diff --git a/upstream/opensuse-leap-15-6/man8/vfs_btrfs.8 b/upstream/opensuse-leap-15-6/man8/vfs_btrfs.8 new file mode 100644 index 00000000..774bea1d --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/vfs_btrfs.8 @@ -0,0 +1,109 @@ +'\" t +.\" Title: vfs_btrfs +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 10/23/2023 +.\" Manual: System Administration tools +.\" Source: Samba 4.19.2-git.328.e4c431e307f150600.1.23SUSE-oS15.0-x86_64 +.\" Language: English +.\" +.TH "VFS_BTRFS" "8" "10/23/2023" "Samba 4\&.19\&.2\-git\&.328\&." "System Administration tools" +.\" ----------------------------------------------------------------- +.\" * 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" +vfs_btrfs \- Utilize features provided by the Btrfs filesystem +.SH "SYNOPSIS" +.HP \w'\ 'u +vfs objects = btrfs +.SH "DESCRIPTION" +.PP +This VFS module is part of the +\fBsamba\fR(8) +suite\&. +.PP +The +vfs_btrfs +VFS module exposes Btrfs specific features for use by Samba\&. +.PP +Btrfs allows for multiple files to share the same on\-disk data through the use cloned ranges\&. When an SMB client issues a request to copy duplicate data (via FSCTL_SRV_COPYCHUNK), this module maps the request to a Btrfs clone range IOCTL, instead of performing reads and writes required by a traditional copy\&. Doing so saves storage capacity and greatly reduces disk IO\&. +.PP +This module also exposes Btrfs per\-file compression support to SMB clients via the get/set compression fsctls\&. +.PP +Btrfs snapshots can be manipulated by Samba\*(Aqs FSRVP server\&. Snapshot manipulation using this module is currently considered experimental, and is therefore disabled by default\&. The +vfs_snapper +module is instead recommended for this purpose\&. +.PP +This module is stackable\&. +.SH "OPTIONS" +.PP +btrfs: manipulate snapshots = [yes|no] +.RS 4 +When set to +\fIyes\fR, experimental support for the creation and deletion of snapshots via corresponding Btrfs IOCTLs will be enabled\&. The default is +\fIno\fR, which means that such requests are passed through to any underlying VFS module\&. +.RE +.SH "CONFIGURATION" +.PP +vfs_btrfs +requires that the underlying share path is a Btrfs subvolume\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf + \fI[share]\fR + \m[blue]\fBvfs objects = btrfs\fR\m[] + \m[blue]\fBbtrfs: manipulate snapshots = no\fR\m[] + +.fi +.if n \{\ +.RE +.\} +.PP +To use the experimental snapshot manipulation functionality provided by this module, it must be explicitly enabled, and Samba\*(Aqs FSRVP server must be running\&. +.PP +The +vfs_shadow_copy +module can be used to expose snapshots created by +vfs_btrfs +to Windows Explorer as file / directory "previous versions"\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf + \fI[global]\fR + \m[blue]\fBregistry shares = yes\fR\m[] + \m[blue]\fBinclude = registry\fR\m[] + + \fI[share]\fR + \m[blue]\fBvfs objects = btrfs shadow_copy\fR\m[] + \m[blue]\fBbtrfs: manipulate snapshots = yes\fR\m[] + +.fi +.if n \{\ +.RE +.\} +.SH "VERSION" +.PP +This man page is part of version 4\&.19\&.2\-git\&.328\&.e4c431e307f150600\&.1\&.23SUSE\-oS15\&.0\-x86_64 of the Samba suite\&. +.SH "AUTHOR" +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. diff --git a/upstream/opensuse-leap-15-6/man8/vfs_cacheprime.8 b/upstream/opensuse-leap-15-6/man8/vfs_cacheprime.8 new file mode 100644 index 00000000..a245df74 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/vfs_cacheprime.8 @@ -0,0 +1,121 @@ +'\" t +.\" Title: vfs_cacheprime +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 10/23/2023 +.\" Manual: System Administration tools +.\" Source: Samba 4.19.2-git.328.e4c431e307f150600.1.23SUSE-oS15.0-x86_64 +.\" Language: English +.\" +.TH "VFS_CACHEPRIME" "8" "10/23/2023" "Samba 4\&.19\&.2\-git\&.328\&." "System Administration tools" +.\" ----------------------------------------------------------------- +.\" * 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" +vfs_cacheprime \- prime the kernel file data cache +.SH "SYNOPSIS" +.HP \w'\ 'u +vfs objects = cacheprime +.SH "DESCRIPTION" +.PP +This VFS module is part of the +\fBsamba\fR(7) +suite\&. +.PP +The +vfs_cacheprime +VFS module reads chunks of file data near the range requested by clients in order to make sure the data is present in the kernel file data cache at the time when it is actually requested by clients\&. +.PP +The size of the disk read operations performed by +vfs_cacheprime +is determined by the cacheprime:rsize option\&. All disk read operations are aligned on boundaries that are a multiple of this size\&. Each range of the file data is primed at most once during the time the client has the file open\&. +.PP +This module is stackable\&. +.SH "OPTIONS" +.PP +cacheprime:rsize = BYTES +.RS 4 +The number of bytes with which to prime the kernel data cache\&. +.sp +The following suffixes may be applied to BYTES: +.RS +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +K +\- BYTES is a number of kilobytes +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +M +\- BYTES is a number of megabytes +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +G +\- BYTES is a number of gigabytes +.RE +.sp +.RE +.RE +.SH "EXAMPLES" +.PP +For a hypothetical disk array, it is necessary to ensure that all read operations are of size 1 megabyte (1048576 bytes), and aligned on 1 megabyte boundaries: +.sp +.if n \{\ +.RS 4 +.\} +.nf + \fI[hypothetical]\fR + \m[blue]\fBvfs objects = cacheprime\fR\m[] + \m[blue]\fBcacheprime:rsize = 1M\fR\m[] +.fi +.if n \{\ +.RE +.\} +.SH "CAVEATS" +.PP +cacheprime +is not a substitute for a general\-purpose readahead mechanism\&. It is intended for use only in very specific environments where disk operations must be aligned and sized to known values (as much as that is possible)\&. +.SH "VERSION" +.PP +This man page is part of version 4\&.19\&.2\-git\&.328\&.e4c431e307f150600\&.1\&.23SUSE\-oS15\&.0\-x86_64 of the Samba suite\&. +.SH "AUTHOR" +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. diff --git a/upstream/opensuse-leap-15-6/man8/vfs_cap.8 b/upstream/opensuse-leap-15-6/man8/vfs_cap.8 new file mode 100644 index 00000000..46ae4f96 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/vfs_cap.8 @@ -0,0 +1,69 @@ +'\" t +.\" Title: vfs_cap +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 10/23/2023 +.\" Manual: System Administration tools +.\" Source: Samba 4.19.2-git.328.e4c431e307f150600.1.23SUSE-oS15.0-x86_64 +.\" Language: English +.\" +.TH "VFS_CAP" "8" "10/23/2023" "Samba 4\&.19\&.2\-git\&.328\&." "System Administration tools" +.\" ----------------------------------------------------------------- +.\" * 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" +vfs_cap \- CAP encode filenames +.SH "SYNOPSIS" +.HP \w'\ 'u +vfs objects = cap +.SH "DESCRIPTION" +.PP +This VFS module is part of the +\fBsamba\fR(7) +suite\&. +.PP +CAP (Columbia Appletalk Protocol) encoding is a technique for representing non\-ASCII filenames in ASCII\&. The +vfs_cap +VFS module translates filenames to and from CAP format, allowing users to name files in their native encoding\&. +.PP +CAP encoding is most commonly used in Japanese language environments\&. +.PP +This module is stackable\&. +.SH "EXAMPLES" +.PP +On a system using GNU libiconv, use CAP encoding to support users in the Shift_JIS locale: +.sp +.if n \{\ +.RS 4 +.\} +.nf + \fI[global]\fR + \m[blue]\fBdos charset = CP932\fR\m[] + \m[blue]\fBdos charset = CP932\fR\m[] + \m[blue]\fBvfs objects = cap\fR\m[] +.fi +.if n \{\ +.RE +.\} +.SH "VERSION" +.PP +This man page is part of version 4\&.19\&.2\-git\&.328\&.e4c431e307f150600\&.1\&.23SUSE\-oS15\&.0\-x86_64 of the Samba suite\&. +.SH "AUTHOR" +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. diff --git a/upstream/opensuse-leap-15-6/man8/vfs_catia.8 b/upstream/opensuse-leap-15-6/man8/vfs_catia.8 new file mode 100644 index 00000000..c38d369f --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/vfs_catia.8 @@ -0,0 +1,126 @@ +'\" t +.\" Title: vfs_catia +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 10/23/2023 +.\" Manual: System Administration tools +.\" Source: Samba 4.19.2-git.328.e4c431e307f150600.1.23SUSE-oS15.0-x86_64 +.\" Language: English +.\" +.TH "VFS_CATIA" "8" "10/23/2023" "Samba 4\&.19\&.2\-git\&.328\&." "System Administration tools" +.\" ----------------------------------------------------------------- +.\" * 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" +vfs_catia \- translate illegal characters in Catia filenames +.SH "SYNOPSIS" +.HP \w'\ 'u +vfs objects = catia +.SH "DESCRIPTION" +.PP +This VFS module is part of the +\fBsamba\fR(7) +suite\&. +.PP +The Catia CAD package commonly creates filenames that use characters that are illegal in CIFS filenames\&. The +vfs_catia +VFS module implements a character mapping so that these files can be shared with CIFS clients\&. +.PP +This module is stackable\&. +.PP +The parameter "catia:mappings" specifies the mapping on a per\-character basis, see below\&. +.SH "OPTIONS" +.PP +catia:mappings = SERVER_HEX_CHAR:CLIENT_HEX_CHAR +.RS 4 +SERVER_HEX_CHAR specifies a 0x prefixed hexedecimal character code that, when included in a Samba server\-side filename, will be mapped to CLIENT_HEX_CHAR for the CIFS client\&. +.sp +The same mapping occurs in the opposite direction\&. Multiple character mappings are separated by a comma\&. +.RE +.SH "EXAMPLES" +.PP +Map server\-side quotation\-marks (") to client\-side diaeresis (\(ad) on filenames in the [CAD] share: +.sp +.if n \{\ +.RS 4 +.\} +.nf + \fI[CAD]\fR + \m[blue]\fBpath = /data/cad\fR\m[] + \m[blue]\fBvfs objects = catia\fR\m[] + \m[blue]\fBcatia:mappings = 0x22:0xa8\fR\m[] +.fi +.if n \{\ +.RE +.\} +.PP +Perform comprehensive mapping of common Catia filename characters: +.sp +.if n \{\ +.RS 4 +.\} +.nf + \fI[CAD]\fR + \m[blue]\fBpath = /data/cad\fR\m[] + \m[blue]\fBvfs objects = catia\fR\m[] + \m[blue]\fBcatia:mappings = 0x22:0xa8,0x2a:0xa4,0x2f:0xf8,0x3a:0xf7,0x3c:0xab,0x3e:0xbb,0x3f:0xbf,0x5c:0xff,0x7c:0xa6\fR\m[] +.fi +.if n \{\ +.RE +.\} +.PP +Server\-side filename to be translated (Note that the path delimiter "/" is not used here): +.PP +a\ea:a*a?a"a<a>a|a +.PP +Resulting filename, as seen by the client: +.PP +aÿa\(dia\(Csa\(r?a\(ada\(Foa\(Fca\(bba +.SH "CAVEATS" +.PP +Character mapping must work in BOTH directions (server \-> client and client \-> server) to get unique and existing file names! +.PP +A NOT working example: +.sp +.if n \{\ +.RS 4 +.\} +.nf + \fI[CAD]\fR + \m[blue]\fBpath = /data/cad\fR\m[] + \m[blue]\fBvfs objects = catia\fR\m[] + \m[blue]\fBcatia:mappings = 0x3a:0x5f\fR\m[] +.fi +.if n \{\ +.RE +.\} +.PP +Here the colon ":" is mapped to the underscore "_"\&. +.PP +Assuming a server\-side filename "a:should_work", which is translated to "a_should_work" for the client\&. +.PP +BUT the reverse mapping from client "a_should_work" to server will result in "a:should:work" \- something like "file not found" will be returned\&. +.SH "VERSION" +.PP +This man page is part of Samba versions from 3\&.5\&.0 to 4\&.0\&.6\&. +.SH "AUTHOR" +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. +.PP +New version written by Guenter Kukkukk kukks@samba\&.org diff --git a/upstream/opensuse-leap-15-6/man8/vfs_commit.8 b/upstream/opensuse-leap-15-6/man8/vfs_commit.8 new file mode 100644 index 00000000..bd8fb4a0 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/vfs_commit.8 @@ -0,0 +1,122 @@ +'\" t +.\" Title: vfs_commit +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 10/23/2023 +.\" Manual: System Administration tools +.\" Source: Samba 4.19.2-git.328.e4c431e307f150600.1.23SUSE-oS15.0-x86_64 +.\" Language: English +.\" +.TH "VFS_COMMIT" "8" "10/23/2023" "Samba 4\&.19\&.2\-git\&.328\&." "System Administration tools" +.\" ----------------------------------------------------------------- +.\" * 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" +vfs_commit \- flush dirty data at specified intervals +.SH "SYNOPSIS" +.HP \w'\ 'u +vfs objects = commit +.SH "DESCRIPTION" +.PP +This VFS module is part of the +\fBsamba\fR(7) +suite\&. +.PP +The +vfs_commit +VFS module keeps track of the amount of data written to a file and synchronizes it to disk when a specified amount accumulates\&. +.PP +vfs_commit +is useful in two circumstances\&. First, if you have very precious data, the impact of unexpected power loss can be minimized by a small commit:dthresh value\&. Secondly, write performance can be improved on some systems by flushing file data early and at regular intervals\&. +.PP +This module is stackable\&. +.SH "OPTIONS" +.PP +commit:dthresh = BYTES +.RS 4 +Synchronize file data each time the specified number of bytes has been written\&. +.sp +The following suffixes may be applied to BYTES: +.RS +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +K +\- BYTES is a number of kilobytes +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +M +\- BYTES is a number of megabytes +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +G +\- BYTES is a number of gigabytes +.RE +.sp +.RE +.RE +.SH "EXAMPLES" +.PP +Synchronize the file data on the [precious] share after every 512 kilobytes (524288 bytes) of data is written: +.sp +.if n \{\ +.RS 4 +.\} +.nf + \fI[precious]\fR + \m[blue]\fBpath = /data/precious\fR\m[] + \m[blue]\fBvfs objects = commit\fR\m[] + \m[blue]\fBcommit:dthresh = 512K\fR\m[] +.fi +.if n \{\ +.RE +.\} +.SH "CAVEATS" +.PP +On some systems, the data synchronization performed by +commit +may reduce performance\&. +.SH "VERSION" +.PP +This man page is part of version 4\&.19\&.2\-git\&.328\&.e4c431e307f150600\&.1\&.23SUSE\-oS15\&.0\-x86_64 of the Samba suite\&. +.SH "AUTHOR" +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. diff --git a/upstream/opensuse-leap-15-6/man8/vfs_crossrename.8 b/upstream/opensuse-leap-15-6/man8/vfs_crossrename.8 new file mode 100644 index 00000000..d547abae --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/vfs_crossrename.8 @@ -0,0 +1,95 @@ +'\" t +.\" Title: vfs_crossrename +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 10/23/2023 +.\" Manual: System Administration tools +.\" Source: Samba 4.19.2-git.328.e4c431e307f150600.1.23SUSE-oS15.0-x86_64 +.\" Language: English +.\" +.TH "VFS_CROSSRENAME" "8" "10/23/2023" "Samba 4\&.19\&.2\-git\&.328\&." "System Administration tools" +.\" ----------------------------------------------------------------- +.\" * 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" +vfs_crossrename \- server side rename files across filesystem boundaries +.SH "SYNOPSIS" +.HP \w'\ 'u +vfs objects = crossrename +.SH "DESCRIPTION" +.PP +This VFS module is part of the +\fBsamba\fR(7) +suite\&. +.PP +The +vfs_crossrename +VFS module allows server side rename operations even if source and target are on different physical devices\&. A "move" in Explorer is usually a rename operation if it is inside of a single share or device\&. Usually such a rename operation returns NT_STATUS_NOT_SAME_DEVICE and the client has to move the file by manual copy and delete operations\&. If the rename by copy is done by the server this can be much more efficient\&. vfs_crossrename tries to do this server\-side cross\-device rename operation\&. +.PP +There are however limitations that this module currently does not solve: +.PP +.RS 4 +.PP +The ACLs of files are not preserved, +.RE +.PP +.RS 4 +.PP +meta data in EAs are not preserved, +.RE +.PP +.RS 4 +.PP +renames of whole subdirectories cannot be done recursively, in that case we still return STATUS_NOT_SAME_DEVICE and let the client decide what to do, +.RE +.PP +.RS 4 +.PP +rename operations of huge files can cause hangs on the client because clients expect a rename operation to return fast\&. +.RE +.PP +This module is stackable\&. +.SH "OPTIONS" +.PP +crossrename:sizelimit = BYTES +.RS 4 +server\-side cross\-device\-renames are only done for files if the filesize is not larger than the defined size in MiB to prevent timeouts\&. The default sizelimit is 20 (MiB) +.RE +.SH "EXAMPLES" +.PP +To add server\-side cross\-device renames inside of a share for all files sized up to 50MB: +.sp +.if n \{\ +.RS 4 +.\} +.nf + \fI[testshare]\fR + \m[blue]\fBpath = /data/mounts\fR\m[] + \m[blue]\fBvfs objects = crossrename\fR\m[] + \m[blue]\fBcrossrename:sizelimit = 50\fR\m[] +.fi +.if n \{\ +.RE +.\} +.SH "VERSION" +.PP +This man page is part of version 4\&.19\&.2\-git\&.328\&.e4c431e307f150600\&.1\&.23SUSE\-oS15\&.0\-x86_64 of the Samba suite\&. +.SH "AUTHOR" +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. diff --git a/upstream/opensuse-leap-15-6/man8/vfs_default_quota.8 b/upstream/opensuse-leap-15-6/man8/vfs_default_quota.8 new file mode 100644 index 00000000..fd84d109 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/vfs_default_quota.8 @@ -0,0 +1,92 @@ +'\" t +.\" Title: vfs_default_quota +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 10/23/2023 +.\" Manual: System Administration tools +.\" Source: Samba 4.19.2-git.328.e4c431e307f150600.1.23SUSE-oS15.0-x86_64 +.\" Language: English +.\" +.TH "VFS_DEFAULT_QUOTA" "8" "10/23/2023" "Samba 4\&.19\&.2\-git\&.328\&." "System Administration tools" +.\" ----------------------------------------------------------------- +.\" * 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" +vfs_default_quota \- store default quota records for Windows clients +.SH "SYNOPSIS" +.HP \w'\ 'u +vfs objects = default_quota +.SH "DESCRIPTION" +.PP +This VFS module is part of the +\fBsamba\fR(7) +suite\&. +.PP +Many common quota implementations only store quotas for users and groups, but do not store a default quota\&. The +vfs_default_quota +module allows Samba to store default quota values which can be examined using the Windows Explorer interface\&. +.PP +By default, Samba returns NO_LIMIT the default quota and refuses to update them\&. +vfs_default_quota +maps the default quota to the quota record of a user\&. By default the root user is taken because quota limits for root are typically not enforced\&. +.PP +This module is stackable\&. +.SH "OPTIONS" +.PP +default_quota:uid = UID +.RS 4 +UID specifies the user ID of the quota record where the default user quota values are stored\&. +.RE +.PP +default_quota:gid = GID +.RS 4 +GID specifies the group ID of the quota record where the default group quota values are stored\&. +.RE +.PP +default_quota:uid nolimit = BOOL +.RS 4 +If this parameter is True, then the user whose quota record is storing the default user quota will be reported as having a quota of NO_LIMIT\&. Otherwise, the stored values will be reported\&. +.RE +.PP +default_quota:gid nolimit = BOOL +.RS 4 +If this parameter is True, then the group whose quota record is storing the default group quota will be reported as having a quota of NO_LIMIT\&. Otherwise, the stored values will be reported\&. +.RE +.SH "EXAMPLES" +.PP +Store the default quota record in the quota record for the user with ID 65535 and report that user as having no quota limits: +.sp +.if n \{\ +.RS 4 +.\} +.nf + \fI[global]\fR + \m[blue]\fBvfs objects = default_quota\fR\m[] + \m[blue]\fBdefault_quota:uid = 65535\fR\m[] + \m[blue]\fBdefault_quota:uid nolimit = yes\fR\m[] +.fi +.if n \{\ +.RE +.\} +.SH "VERSION" +.PP +This man page is part of version 4\&.19\&.2\-git\&.328\&.e4c431e307f150600\&.1\&.23SUSE\-oS15\&.0\-x86_64 of the Samba suite\&. +.SH "AUTHOR" +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. diff --git a/upstream/opensuse-leap-15-6/man8/vfs_dirsort.8 b/upstream/opensuse-leap-15-6/man8/vfs_dirsort.8 new file mode 100644 index 00000000..96d9d41d --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/vfs_dirsort.8 @@ -0,0 +1,65 @@ +'\" t +.\" Title: vfs_dirsort +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 10/23/2023 +.\" Manual: System Administration tools +.\" Source: Samba 4.19.2-git.328.e4c431e307f150600.1.23SUSE-oS15.0-x86_64 +.\" Language: English +.\" +.TH "VFS_DIRSORT" "8" "10/23/2023" "Samba 4\&.19\&.2\-git\&.328\&." "System Administration tools" +.\" ----------------------------------------------------------------- +.\" * 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" +vfs_dirsort \- Sort directory contents +.SH "SYNOPSIS" +.HP \w'\ 'u +vfs objects = dirsort +.SH "DESCRIPTION" +.PP +This VFS module is part of the +\fBsamba\fR(7) +suite\&. +.PP +The +vfs_dirsort +module sorts directory entries alphabetically before sending them to the client\&. +.PP +Please be aware that adding this module might have negative performance implications for large directories\&. +.SH "EXAMPLES" +.PP +Sort directories for all shares: +.sp +.if n \{\ +.RS 4 +.\} +.nf + \fI[global]\fR + \m[blue]\fBvfs objects = dirsort\fR\m[] +.fi +.if n \{\ +.RE +.\} +.SH "VERSION" +.PP +This man page is part of version 4\&.19\&.2\-git\&.328\&.e4c431e307f150600\&.1\&.23SUSE\-oS15\&.0\-x86_64 of the Samba suite\&. +.SH "AUTHOR" +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. diff --git a/upstream/opensuse-leap-15-6/man8/vfs_expand_msdfs.8 b/upstream/opensuse-leap-15-6/man8/vfs_expand_msdfs.8 new file mode 100644 index 00000000..df5577cc --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/vfs_expand_msdfs.8 @@ -0,0 +1,62 @@ +'\" t +.\" Title: vfs_expand_msdfs +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 10/23/2023 +.\" Manual: System Administration tools +.\" Source: Samba 4.19.2-git.328.e4c431e307f150600.1.23SUSE-oS15.0-x86_64 +.\" Language: English +.\" +.TH "VFS_EXPAND_MSDFS" "8" "10/23/2023" "Samba 4\&.19\&.2\-git\&.328\&." "System Administration tools" +.\" ----------------------------------------------------------------- +.\" * 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" +vfs_expand_msdfs \- Expand msdfs links depending on client IP +.SH "SYNOPSIS" +.HP \w'\ 'u +vfs objects = expand_msdfs +.SH "DESCRIPTION" +.PP +This VFS module is part of the +\fBsamba\fR(7) +suite\&. +.PP +With this module, the link target is not directly a server and share, but this module expects the target to reference a file, containing a table\&. The file is referenced by means of the msdfs symlink target according to msdfs:@table\-filename@/share\&. The file table\-filename is supposed to contain a list of destinations that are looked at from top to bottom: +.sp +.if n \{\ +.RS 4 +.\} +.nf +192\&.168\&.234 local\&.samba\&.org +192\&.168 remote\&.samba\&.org + default\&.samba\&.org + +.fi +.if n \{\ +.RE +.\} +.PP +With this, clients from network 192\&.168\&.234/24 are redirected to host local\&.samba\&.org, clients from 192\&.168/16 are redirected to remote\&.samba\&.org and all other clients go to default\&.samba\&.org\&. +.SH "VERSION" +.PP +This man page is part of version 4\&.19\&.2\-git\&.328\&.e4c431e307f150600\&.1\&.23SUSE\-oS15\&.0\-x86_64 of the Samba suite\&. +.SH "AUTHOR" +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. diff --git a/upstream/opensuse-leap-15-6/man8/vfs_extd_audit.8 b/upstream/opensuse-leap-15-6/man8/vfs_extd_audit.8 new file mode 100644 index 00000000..0649823b --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/vfs_extd_audit.8 @@ -0,0 +1,61 @@ +'\" t +.\" Title: vfs_extd_audit +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 10/23/2023 +.\" Manual: System Administration tools +.\" Source: Samba 4.19.2-git.328.e4c431e307f150600.1.23SUSE-oS15.0-x86_64 +.\" Language: English +.\" +.TH "VFS_EXTD_AUDIT" "8" "10/23/2023" "Samba 4\&.19\&.2\-git\&.328\&." "System Administration tools" +.\" ----------------------------------------------------------------- +.\" * 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" +vfs_extd_audit \- record selected Samba VFS operations +.SH "SYNOPSIS" +.HP \w'\ 'u +vfs objects = extd_audit +.SH "DESCRIPTION" +.PP +This VFS module is part of the +\fBsamba\fR(7) +suite\&. +.PP +The +extd_audit +VFS module records selected client operations to both the +\fBsmbd\fR(8) +log and system log (using +\fBsyslog\fR(3))\&. +.PP +Other than logging to the +\fBsmbd\fR(8) +log, +vfs_extd_audit +is identical to +\fBvfs_audit\fR(8)\&. +.PP +This module is stackable\&. +.SH "VERSION" +.PP +This man page is part of version 4\&.19\&.2\-git\&.328\&.e4c431e307f150600\&.1\&.23SUSE\-oS15\&.0\-x86_64 of the Samba suite\&. +.SH "AUTHOR" +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. diff --git a/upstream/opensuse-leap-15-6/man8/vfs_fake_perms.8 b/upstream/opensuse-leap-15-6/man8/vfs_fake_perms.8 new file mode 100644 index 00000000..c1fa4855 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/vfs_fake_perms.8 @@ -0,0 +1,64 @@ +'\" t +.\" Title: vfs_fake_perms +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 10/23/2023 +.\" Manual: System Administration tools +.\" Source: Samba 4.19.2-git.328.e4c431e307f150600.1.23SUSE-oS15.0-x86_64 +.\" Language: English +.\" +.TH "VFS_FAKE_PERMS" "8" "10/23/2023" "Samba 4\&.19\&.2\-git\&.328\&." "System Administration tools" +.\" ----------------------------------------------------------------- +.\" * 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" +vfs_fake_perms \- enable read only Roaming Profiles +.SH "SYNOPSIS" +.HP \w'\ 'u +vfs objects = fake_perms +.SH "DESCRIPTION" +.PP +This VFS module is part of the +\fBsamba\fR(7) +suite\&. +.PP +The +vfs_fake_perms +VFS module was created to allow Roaming Profile files and directories to be set (on the Samba server under UNIX) as read only\&. This module will, if installed on the Profiles share, report to the client that the Profile files and directories are writeable\&. This satisfies the client even though the files will never be overwritten as the client logs out or shuts down\&. +.PP +This module is stackable\&. +.SH "EXAMPLES" +.sp +.if n \{\ +.RS 4 +.\} +.nf + \fI[Profiles]\fR + \m[blue]\fBpath = /profiles\fR\m[] + \m[blue]\fBvfs objects = fake_perms\fR\m[] +.fi +.if n \{\ +.RE +.\} +.SH "VERSION" +.PP +This man page is part of version 4\&.19\&.2\-git\&.328\&.e4c431e307f150600\&.1\&.23SUSE\-oS15\&.0\-x86_64 of the Samba suite\&. +.SH "AUTHOR" +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. diff --git a/upstream/opensuse-leap-15-6/man8/vfs_fileid.8 b/upstream/opensuse-leap-15-6/man8/vfs_fileid.8 new file mode 100644 index 00000000..ef6fcd94 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/vfs_fileid.8 @@ -0,0 +1,218 @@ +'\" t +.\" Title: vfs_fileid +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 10/23/2023 +.\" Manual: System Administration tools +.\" Source: Samba 4.19.2-git.328.e4c431e307f150600.1.23SUSE-oS15.0-x86_64 +.\" Language: English +.\" +.TH "VFS_FILEID" "8" "10/23/2023" "Samba 4\&.19\&.2\-git\&.328\&." "System Administration tools" +.\" ----------------------------------------------------------------- +.\" * 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" +vfs_fileid \- Generates file_id structs with unique device id values for cluster setups\&. It also adds ways to deliberately break lock coherency for specific inodes +.SH "SYNOPSIS" +.HP \w'\ 'u +vfs objects = fileid +.SH "DESCRIPTION" +.PP +This VFS module is part of the +\fBsamba\fR(7) +suite\&. +.PP +Samba uses file_id structs to uniquely identify files for locking purpose\&. By default the file_id contains the device and inode number returned by the +stat() +system call\&. As the file_id is a unique identifier of a file, it must be the same on all nodes in a cluster setup\&. This module overloads the +SMB_VFS_FILE_ID_CREATE() +operation and generates the device number based on the configured algorithm (see the "fileid:algorithm" option)\&. +.PP +When using the fsname or fsid algorithm a +stat() +and +statfs() +call is required for all mounted file systems to generate the file_id\&. If e\&.g\&. an NFS file system is unresponsive such a call might block and the smbd process will become unresponsive\&. Use the "fileid:fstype deny", "fileid:fstype allow", "fileid:mntdir deny", or "fileid:mntdir allow" options to ignore potentially unresponsive file systems\&. +.SH "OPTIONS" +.PP +fileid:algorithm = ALGORITHM +.RS 4 +Available algorithms are +fsname, +fsid, +next_module\&. The default value is +fsname\&. As well as the following legacy algorithms: +fsname_nodirs, +fsname_norootdir, +fsname_norootdir_ext +and +hostname\&. +.sp +The +fsname +algorithm generates device id by hashing the kernel device name\&. +.sp +The +fsid +algorithm generates the device id from the +f_fsid +returned from the +statfs() +syscall\&. +.sp +The +next_module +algorithm lets the next vfs module in the module chain generate the id\&. This is mainly used in combination with the various \*(Aqnolock\*(Aq features the fileid module provides\&. +.sp +The legacy +hostname +algorithm generates unique devid by hashing the hostname and low level device id\&. It also implies +fileid:nolock_all_inodes=yes\&. This can be used to deliberately break lock coherency in a cluster and with +fileid:nolock_max_slots +also between local processes within a node\&. NOTE: Do not use this without knowing what you are doing! It breaks SMB semantics and it can lead to data corruption! This implies +fileid:nolock_all_inodes=yes\&. +.sp +The legacy +fsname_nodirs +algorithm is an alias for using the +fsname +algorithm together with +fileid:nolock_all_dirs=yes\&. NOTE: Do not use this without knowing what you are doing! It breaks SMB semantics! See +fileid:nolock_paths +for a more fine grained approach\&. +.sp +The legacy +fsname_norootdir +algorithm is an alias for using the +fsname +algorithm together with +fileid:nolock_paths= \(lq\&.\(rq\&. It means this can be used to deliberately break lock coherency in a cluster for the root directory of a share\&. +.sp +The legacy +fsname_norootdir_ext +algorithm is an alias for using the +fsname +algorithm together with +fileid:nolock_paths= \(lq\&.\(rq +and +fileid:nolock_max_slots = 18446744073709551615\&. It means this can be used to deliberately break lock coherency completely for the root directory of a share\&. Even local processes are no longer lock coherent\&. +.RE +.PP +fileid:mapping = ALGORITHM +.RS 4 +This option is the legacy version of the +fileid:algorithm +option, which was used in earlier versions of fileid mapping feature in custom Samba 3\&.0 versions\&. +.RE +.PP +fileid:fstype deny = LIST +.RS 4 +List of file system types to be ignored for file_id generation\&. +.RE +.PP +fileid:fstype allow = LIST +.RS 4 +List of file system types to be allowed for file_id generation\&. If this option is set, file system types not listed here are ignored\&. +.RE +.PP +fileid:mntdir deny = LIST +.RS 4 +List of file system mount points to be ignored for file_id generation\&. +.RE +.PP +fileid:mntdir allow = LIST +.RS 4 +List of file system mount points to be allowed for file_id generation\&. If this option is set, file system mount points not listed here are ignored\&. +.RE +.PP +fileid:nolock_max_slots = NUMBER(1\-18446744073709551615) +.RS 4 +This option alters the behavior of the +nolock +algorithm in a ways that it also breaks the lock coherency between individual processes on the same host\&. The default is to have just 1 concurrent slot available per host\&. By incressing the number of slots you can specify how many concurrent processes can work on a given inode without contention, the number should typically be larger than the a number of logical cpus, maybe 2 times of num_cpus\&. +.RE +.PP +fileid:nolock_all_dirs = BOOL +.RS 4 +This option triggers the use of the fileid nolock behavior for all directory inodes, which can be used to deliberately break the lock coherency for all directories\&. NOTE: Do not use this without knowing what you are doing! It breaks SMB semantics! See +fileid:nolock_paths +for a more fine grained approach\&. +.RE +.PP +fileid:nolock_all_inodes = BOOL +.RS 4 +This option triggers the use of the fileid nolock algorithm for all directoriy inode, which can be used to deliberately break the lock coherency for all directories\&. NOTE: Do not use this without knowing what you are doing! It breaks SMB semantics and it can lead to data corruption! See +fileid:nolock_paths +for a more fine grained approach\&. +.RE +.PP +fileid:nolock_paths = LIST +.RS 4 +This option specifies a path list referring to files and/or directories, which should use fileid nolock algorithm in order to deliberately break the lock coherency for them\&. The specified paths can be relative to the share root directory or absolute\&. The names are case sensitive unix pathnames! Note all paths are only evaluated at tree connect time, when the share is being connected, from there on only the related device and inode numbers from the stat() syscall are compared\&. Non existing paths will generate a log level 0 message\&. NOTE: This option should be used with care as it breaks SMB semantics! But it may help in situation where a specific (commonly read\-only) inode is highly contended\&. +.RE +.PP +fileid:nolockinode = NUMBER +.RS 4 +This legacy option triggers use of the fileid nolock behavior for the configured inode, while ignoring and device id\&. This can be used to deliberately break lock coherency for the corresponding file or directory in a cluster\&. Using the +fileid:nolock_paths +option is much more flexible and simpler to use\&. +.RE +.SH "EXAMPLES" +.PP +Usage of the +fileid +module with the +fsid +algorithm: +.sp +.if n \{\ +.RS 4 +.\} +.nf + \fI[global]\fR + \m[blue]\fBvfs objects = fileid\fR\m[] + \m[blue]\fBfileid:algorithm = fsid\fR\m[] +.fi +.if n \{\ +.RE +.\} +.PP +Usage of the +fileid +module in order avoid load on heavily contended (most likely read\-only) inodes\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf + \fI[global]\fR + \m[blue]\fBvfs objects = fileid\fR\m[] + \m[blue]\fBfileid:algorithm = next_module\fR\m[] + \m[blue]\fBfileid:nolock_paths = \&. ContendedFolder1 /path/to/contended\&.exe\fR\m[] + \m[blue]\fBfileid:nolock_max_slots = 256\fR\m[] +.fi +.if n \{\ +.RE +.\} +.SH "VERSION" +.PP +This man page is part of version 4\&.19\&.2\-git\&.328\&.e4c431e307f150600\&.1\&.23SUSE\-oS15\&.0\-x86_64 of the Samba suite\&. +.SH "AUTHOR" +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. diff --git a/upstream/opensuse-leap-15-6/man8/vfs_fruit.8 b/upstream/opensuse-leap-15-6/man8/vfs_fruit.8 new file mode 100644 index 00000000..1253f403 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/vfs_fruit.8 @@ -0,0 +1,536 @@ +'\" t +.\" Title: vfs_fruit +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 10/23/2023 +.\" Manual: System Administration tools +.\" Source: Samba 4.19.2-git.328.e4c431e307f150600.1.23SUSE-oS15.0-x86_64 +.\" Language: English +.\" +.TH "VFS_FRUIT" "8" "10/23/2023" "Samba 4\&.19\&.2\-git\&.328\&." "System Administration tools" +.\" ----------------------------------------------------------------- +.\" * 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" +vfs_fruit \- Enhanced OS X and Netatalk interoperability +.SH "SYNOPSIS" +.HP \w'\ 'u +vfs objects = fruit +.SH "DESCRIPTION" +.PP +This VFS module is part of the +\fBsamba\fR(7) +suite\&. +.PP +The +vfs_fruit +module provides enhanced compatibility with Apple SMB clients and interoperability with a Netatalk 3 AFP fileserver\&. +.PP +The module should be stacked with +vfs_catia +if enabling character conversion and must be stacked with +vfs_streams_xattr, see the example section for the correct config\&. +.PP +The module enables alternate data streams (ADS) support for a share, intercepts the OS X special streams "AFP_AfpInfo" and "AFP_Resource" and handles them in a special way\&. All other named streams are deferred to +vfs_streams_xattr +which must be loaded together with +vfs_fruit\&. +.PP +Be careful when mixing shares with and without vfs_fruit\&. OS X clients negotiate SMB2 AAPL protocol extensions on the first tcon, so mixing shares with and without fruit will globally disable AAPL if the first tcon is without fruit\&. +.PP +Having shares with ADS support enabled for OS X client is worthwhile because it resembles the behaviour of Apple\*(Aqs own SMB server implementation and it avoids certain severe performance degradations caused by Samba\*(Aqs case sensitivity semantics\&. +.PP +The OS X metadata and resource fork stream can be stored in a way compatible with Netatalk 3 by setting +fruit:resource = file +and +fruit:metadata = netatalk\&. +.PP +OS X maps NTFS illegal characters to the Unicode private range in SMB requests\&. By setting +fruit:encoding = native, all mapped characters are converted to native ASCII characters\&. +.PP +Finally, share access modes are optionally checked against Netatalk AFP sharing modes by setting +fruit:locking = netatalk\&. +.PP +This module is not stackable other than described in this manpage\&. +.SH "GLOBAL OPTIONS" +.PP +The following options must be set in the global smb\&.conf section and won\*(Aqt take effect when set per share\&. +.PP +fruit:aapl = yes | no +.RS 4 +A +\fIglobal\fR +option whether to enable Apple\*(Aqs SMB2+ extension codenamed AAPL\&. Default +\fIyes\fR\&. This extension enhances several deficiencies when connecting from Macs: +.RS +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +directory enumeration is enriched with Mac relevant filesystem metadata (UNIX mode, FinderInfo, resource fork size and effective permission), as a result the Mac client doesn\*(Aqt need to fetch this metadata individually per directory entry resulting in an often tremendous performance increase\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +The ability to query and modify the UNIX mode of directory entries\&. +.RE +.sp +.RE +There\*(Aqs a set of per share options that come into play when +\fIfruit:aapl\fR +is enabled\&. These options, listed below, can be used to disable the computation of specific Mac metadata in the directory enumeration context, all are enabled by default: +.RS +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +readdir_attr:aapl_rsize = yes | no +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +readdir_attr:aapl_finder_info = yes | no +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +readdir_attr:aapl_max_access = yes | no +.RE +.sp +.RE +See below for a description of these options\&. +.RE +.PP +fruit:nfs_aces = yes | no +.RS 4 +A +\fIglobal\fR +option whether support for querying and modifying the UNIX mode of directory entries via NFS ACEs is enabled, default +\fIyes\fR\&. +.RE +.PP +fruit:copyfile = yes | no +.RS 4 +A +\fIglobal\fR +option whether to enable OS X specific copychunk ioctl that requests a copy of a whole file along with all attached metadata\&. +.sp +WARNING: the copyfile request is blocking the client while the server does the copy\&. +.sp +The default is +\fIno\fR\&. +.RE +.PP +fruit:model = MacSamba +.RS 4 +This option defines the model string inside the AAPL extension and will determine the appearance of the icon representing the Samba server in the Finder window\&. +.sp +The default is +\fIMacSamba\fR\&. +.RE +.SH "OPTIONS" +.PP +The following options can be set either in the global smb\&.conf section or per share\&. +.PP +fruit:resource = [ file | xattr | stream ] +.RS 4 +Controls where the OS X resource fork is stored\&. +.sp +Due to a spelling bug in all Samba versions older then 4\&.6\&.0, this option can also be given as +\fIfruit:ressource\fR, ie with two s\&. +.sp +Settings: +.RS +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +file (default) +\- use a \&._ AppleDouble file compatible with OS X and Netatalk +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +xattr +\- use a xattr, requires a filesystem with large xattr support and a file IO API compatible with xattrs, this boils down to Solaris and derived platforms and ZFS +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +stream (experimental) +\- pass the stream on to the next module in the VFS stack\&. +\fIWarning: \fR +this option should not be used with the +\fIstreams_xattr\fR +module due to the extended attributes size limitations of most filesystems\&. +.RE +.sp +.RE +.RE +.PP +fruit:time machine = [ yes | no ] +.RS 4 +Controls if Time Machine support via the FULLSYNC volume capability is advertised to clients\&. +.RS +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +yes +\- Enables Time Machine support for this share\&. Also registers the share with mDNS in case Samba is built with mDNS support\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +no (default) +Disables advertising Time Machine support\&. +.RE +.sp +.RE +This option enforces the following settings per share (or for all shares if enabled globally): +.RS +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +durable handles = yes +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +kernel oplocks = no +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +kernel share modes = no +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +posix locking = no +.RE +.sp +.RE +.RE +.PP +fruit:time machine max size = SIZE [K|M|G|T|P] +.RS 4 +Useful for Time Machine: limits the reported disksize, thus preventing Time Machine from using the whole real disk space for backup\&. The option takes a number plus an optional unit\&. +.sp +\fIIMPORTANT\fR: This is an approximated calculation that only takes into account the contents of Time Machine sparsebundle images\&. Therefore you +\fIMUST NOT\fR +use this volume to store other content when using this option, because it would NOT be accounted\&. +.sp +The calculation works by reading the band size from the Info\&.plist XML file of the sparsebundle, reading the bands/ directory counting the number of band files, and then multiplying one with the other\&. +.RE +.PP +fruit:metadata = [ stream | netatalk ] +.RS 4 +Controls where the OS X metadata stream is stored: +.RS +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +netatalk (default) +\- use Netatalk compatible xattr +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +stream +\- pass the stream on to the next module in the VFS stack +.RE +.sp +.RE +.RE +.PP +fruit:locking = [ netatalk | none ] +.RS 4 + +.RS +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +none (default) +\- no cross protocol locking +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +netatalk +\- use cross protocol locking with Netatalk +.RE +.sp +.RE +.RE +.PP +fruit:encoding = [ native | private ] +.RS 4 +Controls how the set of illegal NTFS ASCII character, commonly used by OS X clients, are stored in the filesystem\&. +.sp +\fIImportant:\fR +this is known to not fully work with +\fIfruit:metadata=stream\fR +or +\fIfruit:resource=stream\fR\&. +.RS +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +private (default) +\- store characters as encoded by the OS X client: mapped to the Unicode private range +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +native +\- store characters with their native ASCII value\&. +\fIImportant\fR: this option requires the use of +\fIvfs_catia\fR +in the VFS module stack as shown in the examples section\&. +.RE +.sp +.RE +.RE +.PP +fruit:veto_appledouble = yes | no +.RS 4 +\fINote:\fR +this option only applies when +\fIfruit:resource\fR +is set to +\fIfile\fR +(the default)\&. +.sp +When +\fIfruit:resource\fR +is set to +\fIfile\fR, vfs_fruit may create \&._ AppleDouble files\&. This options controls whether these \&._ AppleDouble files are vetoed which prevents the client from accessing them\&. +.sp +Vetoing \&._ files may break some applications, e\&.g\&. extracting Mac ZIP archives from Mac clients fails, because they contain \&._ files\&. +rsync +will also be unable to sync files beginning with underscores, as the temporary files it uses for these will start with \&._ and so cannot be created\&. +.sp +Setting this option to false will fix this, but the abstraction leak of exposing the internally created \&._ files may have other unknown side effects\&. +.sp +The default is +\fIyes\fR\&. +.RE +.PP +fruit:posix_rename = yes | no +.RS 4 +Whether to enable POSIX directory rename behaviour for OS X clients\&. Without this, directories can\*(Aqt be renamed if any client has any file inside it (recursive!) open\&. +.sp +The default is +\fIyes\fR\&. +.RE +.PP +readdir_attr:aapl_rsize = yes | no +.RS 4 +Return resource fork size in SMB2 FIND responses\&. +.sp +The default is +\fIyes\fR\&. +.RE +.PP +readdir_attr:aapl_finder_info = yes | no +.RS 4 +Return FinderInfo in SMB2 FIND responses\&. +.sp +The default is +\fIyes\fR\&. +.RE +.PP +readdir_attr:aapl_max_access = yes | no +.RS 4 +Return the user\*(Aqs effective maximum permissions in SMB2 FIND responses\&. This is an expensive computation, setting this to off pretends the use has maximum effective permissions\&. +.sp +The default is +\fIyes\fR\&. +.RE +.PP +fruit:wipe_intentionally_left_blank_rfork = yes | no +.RS 4 +Whether to wipe Resource Fork data that matches the special 286 bytes sized placeholder blob that macOS client create on occasion\&. The blob contains a string +\(lqThis resource fork intentionally left blank\(rq, the remaining bytes being mostly zero\&. There being no one use of this data, it is probably safe to discard it\&. When this option is enabled, this module truncates the Resource Fork stream to 0 bytes\&. +.sp +The default is +\fIno\fR\&. +.RE +.PP +fruit:delete_empty_adfiles = yes | no +.RS 4 +Whether to delete empty AppleDouble files\&. Empty means that the resource fork entry in the AppleDouble files is of size 0, or the size is exactly 286 bytes and the content matches a special boilerplate resource fork created my macOS\&. +.sp +The default is +\fIno\fR\&. +.RE +.PP +fruit:zero_file_id = yes | no +.RS 4 +Whether to return zero to queries of on\-disk file identifier if the client has negotiated AAPL\&. +.sp +Mac applications and / or the Mac SMB client code expect the on\-disk file identifier to have the semantics of HFS+ Catalog Node Identifier (CNID)\&. Samba provides File\-IDs based on a file\*(Aqs inode number which gets recycled across file creation and deletion and can therefore not be used for Mac client\&. Returning a file identifier of zero causes the Mac client to stop using and trusting the file id returned from the server\&. +.sp +The default is +\fIyes\fR\&. +.RE +.PP +fruit:convert_adouble = yes | no +.RS 4 +Whether an attempt shall be made to convert \&._ AppleDouble sidecar files to native streams (xattrs when using vfs_streams_xattr)\&. The main use case for this conversion is transparent migration from a server config without streams support where the macOS client created those AppleDouble sidecar files\&. +.sp +The default is +\fIyes\fR\&. +.RE +.SH "EXAMPLES" +.sp +.if n \{\ +.RS 4 +.\} +.nf + \fI[share]\fR + \m[blue]\fBvfs objects = catia fruit streams_xattr\fR\m[] + \m[blue]\fBfruit:resource = file\fR\m[] + \m[blue]\fBfruit:metadata = netatalk\fR\m[] + \m[blue]\fBfruit:locking = netatalk\fR\m[] + \m[blue]\fBfruit:encoding = native\fR\m[] +.fi +.if n \{\ +.RE +.\} +.SH "AUTHOR" +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. diff --git a/upstream/opensuse-leap-15-6/man8/vfs_full_audit.8 b/upstream/opensuse-leap-15-6/man8/vfs_full_audit.8 new file mode 100644 index 00000000..5487c796 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/vfs_full_audit.8 @@ -0,0 +1,507 @@ +'\" t +.\" Title: vfs_full_audit +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 10/23/2023 +.\" Manual: System Administration tools +.\" Source: Samba 4.19.2-git.328.e4c431e307f150600.1.23SUSE-oS15.0-x86_64 +.\" Language: English +.\" +.TH "VFS_FULL_AUDIT" "8" "10/23/2023" "Samba 4\&.19\&.2\-git\&.328\&." "System Administration tools" +.\" ----------------------------------------------------------------- +.\" * 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" +vfs_full_audit \- record Samba VFS operations in the system log +.SH "SYNOPSIS" +.HP \w'\ 'u +vfs objects = full_audit +.SH "DESCRIPTION" +.PP +This VFS module is part of the +\fBsamba\fR(7) +suite\&. +.PP +The +vfs_full_audit +VFS module records selected client operations to the system log using +\fBsyslog\fR(3)\&. +.PP +vfs_full_audit +is able to record the complete set of Samba VFS operations: +.RS 4 +aio_force +.RE +.RS 4 +audit_file +.RE +.RS 4 +brl_lock_windows +.RE +.RS 4 +brl_unlock_windows +.RE +.RS 4 +chdir +.RE +.RS 4 +close +.RE +.RS 4 +closedir +.RE +.RS 4 +connect +.RE +.RS 4 +connectpath +.RE +.RS 4 +create_dfs_pathat +.RE +.RS 4 +create_file +.RE +.RS 4 +disconnect +.RE +.RS 4 +disk_free +.RE +.RS 4 +durable_cookie +.RE +.RS 4 +durable_disconnect +.RE +.RS 4 +durable_reconnect +.RE +.RS 4 +fallocate +.RE +.RS 4 +fchflags +.RE +.RS 4 +fchmod +.RE +.RS 4 +fchown +.RE +.RS 4 +fcntl +.RE +.RS 4 +fdopendir +.RE +.RS 4 +fget_compression +.RE +.RS 4 +fget_dos_attributes +.RE +.RS 4 +fget_nt_acl +.RE +.RS 4 +fgetxattr +.RE +.RS 4 +file_id_create +.RE +.RS 4 +filesystem_sharemode +.RE +.RS 4 +flistxattr +.RE +.RS 4 +fntimes +.RE +.RS 4 +freaddir_attr +.RE +.RS 4 +fremovexattr +.RE +.RS 4 +fs_capabilities +.RE +.RS 4 +fsctl +.RE +.RS 4 +fset_dos_attributes +.RE +.RS 4 +fset_nt_acl +.RE +.RS 4 +fsetxattr +.RE +.RS 4 +fs_file_id +.RE +.RS 4 +fstat +.RE +.RS 4 +fstatat +.RE +.RS 4 +fstreaminfo +.RE +.RS 4 +fsync_recv +.RE +.RS 4 +fsync_send +.RE +.RS 4 +ftruncate +.RE +.RS 4 +get_alloc_size +.RE +.RS 4 +get_dfs_referrals +.RE +.RS 4 +get_dos_attributes_recv +.RE +.RS 4 +get_dos_attributes_send +.RE +.RS 4 +getlock +.RE +.RS 4 +get_quota +.RE +.RS 4 +get_real_filename +.RE +.RS 4 +get_real_filename_at +.RE +.RS 4 +get_shadow_copy_data +.RE +.RS 4 +getwd +.RE +.RS 4 +getxattrat_recv +.RE +.RS 4 +getxattrat_send +.RE +.RS 4 +is_offline +.RE +.RS 4 +lchown +.RE +.RS 4 +linkat +.RE +.RS 4 +linux_setlease +.RE +.RS 4 +lock +.RE +.RS 4 +lseek +.RE +.RS 4 +lstat +.RE +.RS 4 +mkdirat +.RE +.RS 4 +mknodat +.RE +.RS 4 +ntimes +.RE +.RS 4 +offload_read_recv +.RE +.RS 4 +offload_read_send +.RE +.RS 4 +offload_write_recv +.RE +.RS 4 +offload_write_send +.RE +.RS 4 +open +.RE +.RS 4 +openat +.RE +.RS 4 +parent_pathname +.RE +.RS 4 +pread +.RE +.RS 4 +pread_recv +.RE +.RS 4 +pread_send +.RE +.RS 4 +pwrite +.RE +.RS 4 +pwrite_recv +.RE +.RS 4 +pwrite_send +.RE +.RS 4 +read +.RE +.RS 4 +read_dfs_pathat +.RE +.RS 4 +readdir +.RE +.RS 4 +readlinkat +.RE +.RS 4 +realpath +.RE +.RS 4 +recvfile +.RE +.RS 4 +removexattr +.RE +.RS 4 +renameat +.RE +.RS 4 +rewinddir +.RE +.RS 4 +sendfile +.RE +.RS 4 +set_compression +.RE +.RS 4 +set_offline +.RE +.RS 4 +set_quota +.RE +.RS 4 +snap_check_path +.RE +.RS 4 +snap_create +.RE +.RS 4 +snap_delete +.RE +.RS 4 +stat +.RE +.RS 4 +statvfs +.RE +.RS 4 +strict_lock_check +.RE +.RS 4 +symlinkat +.RE +.RS 4 +sys_acl_blob_get_fd +.RE +.RS 4 +sys_acl_delete_def_fd +.RE +.RS 4 +sys_acl_get_fd +.RE +.RS 4 +sys_acl_set_fd +.RE +.RS 4 +translate_name +.RE +.RS 4 +unlinkat +.RE +.RS 4 +write +.RE +.PP +In addition to these operations, +vfs_full_audit +recognizes the special operation names "all" and "none ", which refer to all the VFS operations and none of the VFS operations respectively\&. +.PP +If an unknown operation name is used (for example an operation name is miss\-spelled), the module will fail to load and clients will be refused connections to a share using this module\&. +.PP +vfs_full_audit +records operations in fixed format consisting of fields separated by \*(Aq|\*(Aq characters\&. The format is: +.sp +.if n \{\ +.RS 4 +.\} +.nf + smbd_audit: PREFIX|OPERATION|RESULT|FILE + +.fi +.if n \{\ +.RE +.\} +.PP +The record fields are: +.RS +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +PREFIX +\- the result of the full_audit:prefix string after variable substitutions +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +OPERATION +\- the name of the VFS operation +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +RESULT +\- whether the operation succeeded or failed +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +FILE +\- the name of the file or directory the operation was performed on +.RE +.sp +.RE +.PP +This module is stackable\&. +.SH "OPTIONS" +.PP +full_audit:prefix = STRING +.RS 4 +Prepend audit messages with STRING\&. STRING is processed for standard substitution variables listed in +\fBsmb.conf\fR(5)\&. The default prefix is "%u|%I"\&. +.RE +.PP +full_audit:success = LIST +.RS 4 +LIST is a list of VFS operations that should be recorded if they succeed\&. Operations are specified using the names listed above\&. Operations can be unset by prefixing the names with "!"\&. The default is none operations\&. +.RE +.PP +full_audit:failure = LIST +.RS 4 +LIST is a list of VFS operations that should be recorded if they failed\&. Operations are specified using the names listed above\&. Operations can be unset by prefixing the names with "!"\&. The default is none operations\&. +.RE +.PP +full_audit:facility = FACILITY +.RS 4 +Log messages to the named +\fBsyslog\fR(3) +facility\&. +.RE +.PP +full_audit:priority = PRIORITY +.RS 4 +Log messages with the named +\fBsyslog\fR(3) +priority\&. +.RE +.PP +full_audit:syslog = true/false +.RS 4 +Log messages to syslog (default) or as a debug level 1 message\&. +.RE +.PP +full_audit:log_secdesc = true/false +.RS 4 +Log an sddl form of the security descriptor coming in when a client sets an acl\&. Defaults to false\&. +.RE +.SH "EXAMPLES" +.PP +Log file and directory open operations on the [records] share using the LOCAL7 facility and ALERT priority, including the username and IP address\&. Logging excludes the open VFS function on failures: +.sp +.if n \{\ +.RS 4 +.\} +.nf + \fI[records]\fR + \m[blue]\fBpath = /data/records\fR\m[] + \m[blue]\fBvfs objects = full_audit\fR\m[] + \m[blue]\fBfull_audit:prefix = %u|%I\fR\m[] + \m[blue]\fBfull_audit:success = open opendir\fR\m[] + \m[blue]\fBfull_audit:failure = all !open\fR\m[] + \m[blue]\fBfull_audit:facility = LOCAL7\fR\m[] + \m[blue]\fBfull_audit:priority = ALERT\fR\m[] +.fi +.if n \{\ +.RE +.\} +.SH "VERSION" +.PP +This man page is part of version 4\&.19\&.2\-git\&.328\&.e4c431e307f150600\&.1\&.23SUSE\-oS15\&.0\-x86_64 of the Samba suite\&. +.SH "AUTHOR" +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. diff --git a/upstream/opensuse-leap-15-6/man8/vfs_glusterfs_fuse.8 b/upstream/opensuse-leap-15-6/man8/vfs_glusterfs_fuse.8 new file mode 100644 index 00000000..53606b37 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/vfs_glusterfs_fuse.8 @@ -0,0 +1,84 @@ +'\" t +.\" Title: vfs_glusterfs_fuse +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 10/23/2023 +.\" Manual: System Administration tools +.\" Source: Samba 4.19.2-git.328.e4c431e307f150600.1.23SUSE-oS15.0-x86_64 +.\" Language: English +.\" +.TH "VFS_GLUSTERFS_FUSE" "8" "10/23/2023" "Samba 4\&.19\&.2\-git\&.328\&." "System Administration tools" +.\" ----------------------------------------------------------------- +.\" * 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" +vfs_glusterfs_fuse \- Utilize features provided by GlusterFS +.SH "SYNOPSIS" +.HP \w'\ 'u +vfs objects = glusterfs_fuse +.SH "DESCRIPTION" +.PP +This VFS module is part of the +\fBsamba\fR(8) +suite\&. +.PP +GlusterFS (http://www\&.gluster\&.org) is an Open Source clustered file system capable of scaling to several peta\-bytes\&. With its FUSE based native client, GlusterFS is available as a POSIX compliant file system and can hence be shared by Samba without additional steps\&. +.PP +The +vfs_glusterfs_fuse +VFS module provides an enhanced way to access a Gluster filesystem using a Gluster FUSE mount\&. It provides support for the +get_real_filename +VFS call which enhances file access performance by avoiding multiple expensive case folding lookup calls to detect the appropriate case of an existing filename\&. +.PP +Furthermore, this module implements a substitute file\-id mechanism\&. The default file\-id mechanism is not working correctly for gluster fuse mount re\-exports, so in order to avoid data loss, users exporting gluster fuse mounts with Samba should enable this module\&. +.PP +This module can be combined with other modules, but it should be the last module in the +vfs objects +list\&. Modules added to this list to the right of the glusterfs entry may not have any effect at all\&. +.SH "CONFIGURATION" +.PP +A basic configuration looks like this\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf + \fI[share]\fR + \m[blue]\fBvfs objects = glusterfs_fuse\fR\m[] + \m[blue]\fBpath = /absolute/path_of_fusemount\fR\m[] + +.fi +.if n \{\ +.RE +.\} +.PP +Note that +vfs_glusterfs_fuse +requires a Gluster mount\&. For accessing glusterfs directly over the GFAPI library please use the +vfs_glusterfs +module\&. +.SH "OPTIONS" +.PP +This module does currently have no further options\&. +.SH "VERSION" +.PP +This man page is part of version 4\&.19\&.2\-git\&.328\&.e4c431e307f150600\&.1\&.23SUSE\-oS15\&.0\-x86_64 of the Samba suite\&. +.SH "AUTHOR" +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. diff --git a/upstream/opensuse-leap-15-6/man8/vfs_io_uring.8 b/upstream/opensuse-leap-15-6/man8/vfs_io_uring.8 new file mode 100644 index 00000000..2ce002a9 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/vfs_io_uring.8 @@ -0,0 +1,84 @@ +'\" t +.\" Title: vfs_io_uring +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 10/23/2023 +.\" Manual: System Administration tools +.\" Source: Samba 4.19.2-git.328.e4c431e307f150600.1.23SUSE-oS15.0-x86_64 +.\" Language: English +.\" +.TH "VFS_IO_URING" "8" "10/23/2023" "Samba 4\&.19\&.2\-git\&.328\&." "System Administration tools" +.\" ----------------------------------------------------------------- +.\" * 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" +vfs_io_uring \- Implement async io in Samba vfs using io_uring of Linux (>= 5\&.1)\&. +.SH "SYNOPSIS" +.HP \w'\ 'u +vfs objects = io_uring +.SH "DESCRIPTION" +.PP +This VFS module is part of the +\fBsamba\fR(7) +suite\&. +.PP +The +io_uring +VFS module enables asynchronous pread, pwrite and fsync using the io_uring infrastructure of Linux (>= 5\&.1)\&. This provides much less overhead compared to the usage of the pthreadpool for async io\&. +.PP +This module SHOULD be listed last in any module stack as it requires real kernel file descriptors\&. +.SH "EXAMPLES" +.PP +Straight forward use: +.sp +.if n \{\ +.RS 4 +.\} +.nf + \fI[cooldata]\fR + \m[blue]\fBpath = /data/ice\fR\m[] + \m[blue]\fBvfs objects = io_uring\fR\m[] +.fi +.if n \{\ +.RE +.\} +.SH "OPTIONS" +.PP +io_uring:num_entries = NUMBER_OF_QUEUE_ENTRIES +.RS 4 +The number of entries in the submission queue\&. The maximum allowed value depends on the kernel version and the kernel will roundup the value to a power of 2\&. +.sp +The default is \*(Aq128\*(Aq\&. +.RE +.PP +io_uring:sqpoll = BOOL +.RS 4 +Use the IORING_SETUP_SQPOLL feature\&. +.sp +The default is \*(Aqno\*(Aq\&. +.RE +.SH "SEE ALSO" +.PP +\fBio_uring_setup\fR(2)\&. +.SH "VERSION" +.PP +This man page is part of version 4\&.19\&.2\-git\&.328\&.e4c431e307f150600\&.1\&.23SUSE\-oS15\&.0\-x86_64 of the Samba suite\&. +.SH "AUTHOR" +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. diff --git a/upstream/opensuse-leap-15-6/man8/vfs_linux_xfs_sgid.8 b/upstream/opensuse-leap-15-6/man8/vfs_linux_xfs_sgid.8 new file mode 100644 index 00000000..9801f814 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/vfs_linux_xfs_sgid.8 @@ -0,0 +1,70 @@ +'\" t +.\" Title: vfs_syncops +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 10/23/2023 +.\" Manual: System Administration tools +.\" Source: Samba 4.19.2-git.328.e4c431e307f150600.1.23SUSE-oS15.0-x86_64 +.\" Language: English +.\" +.TH "VFS_SYNCOPS" "8" "10/23/2023" "Samba 4\&.19\&.2\-git\&.328\&." "System Administration tools" +.\" ----------------------------------------------------------------- +.\" * 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" +vfs_linux_xfs_sgid \- Workaround XFS sgid bit not inherited +.SH "SYNOPSIS" +.HP \w'\ 'u +vfs objects = linux_xfs_sgid +.SH "DESCRIPTION" +.PP +This VFS module is part of the +\fBsamba\fR(7) +suite\&. +.PP +vfs_linux_xfs_sgid +is a VFS module to work around an old Linux XFS bug fixed in 3\&.11: the SGID bit is not inherited during mkdir when a default ACL is set (https://web\&.archive\&.org/web/20160320180937/http://oss\&.sgi\&.com/bugzilla/show_bug\&.cgi?id=280 +fixed by +https://git\&.kernel\&.org/pub/scm/linux/kernel/git/torvalds/linux\&.git/commit/?id=42c49d7f249c2487f36d3314753d5d8ebcee8249)\&. The +vfs_linux_xfs_sgid +VFS module will work around this bug by manually setting the SGID bit after a +mkdir +if the parent directory had the SGID bit set\&. +.PP +This module is stackable\&. +.SH "EXAMPLES" +.PP +Add syncops functionality for [share]: +.sp +.if n \{\ +.RS 4 +.\} +.nf + \fI[share]\fR + \m[blue]\fBvfs objects = linux_xfs_sgid\fR\m[] +.fi +.if n \{\ +.RE +.\} +.SH "VERSION" +.PP +This man page is part of version 4\&.19\&.2\-git\&.328\&.e4c431e307f150600\&.1\&.23SUSE\-oS15\&.0\-x86_64 of the Samba suite\&. +.SH "AUTHOR" +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. diff --git a/upstream/opensuse-leap-15-6/man8/vfs_media_harmony.8 b/upstream/opensuse-leap-15-6/man8/vfs_media_harmony.8 new file mode 100644 index 00000000..86141c4c --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/vfs_media_harmony.8 @@ -0,0 +1,144 @@ +'\" t +.\" Title: vfs_media_harmony +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 10/23/2023 +.\" Manual: System Administration tools +.\" Source: Samba 4.19.2-git.328.e4c431e307f150600.1.23SUSE-oS15.0-x86_64 +.\" Language: English +.\" +.TH "VFS_MEDIA_HARMONY" "8" "10/23/2023" "Samba 4\&.19\&.2\-git\&.328\&." "System Administration tools" +.\" ----------------------------------------------------------------- +.\" * 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" +vfs_media_harmony \- Allow multiple Avid clients to share a network drive\&. +.SH "SYNOPSIS" +.HP \w'\ 'u +vfs objects = media_harmony +.SH "DESCRIPTION" +.PP +This VFS module is part of the +\fBsamba\fR(7) +suite\&. +.PP +The +vfs_media_harmony +VFS module allows Avid editorial workstations to share a network drive\&. It does this by: +.RS +.sp +.RS 4 +.ie n \{\ +\h'-04' 1.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 1." 4.2 +.\} +Giving each client their own copy of the Avid msmMMOB\&.mdb and msmFMID\&.pmr files and Creating directories\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04' 2.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 2." 4.2 +.\} +Allowing each client to explicitly control the write time the Avid application sees on Avid media directories\&. +.RE +.sp +.RE +.PP +This module is stackable\&. +.SH "CONFIGURATION" +.PP +vfs_media_harmony +automatically redirects requests from clients for Avid database files or an Avid Creating directory to a client\-specific version of the file\&. No configuration beyond enabling the module is needed to get this portion of its functionality working\&. +.PP +If Mac and Windows Avid clients will be accessing the same folder, they should be given separate share definitions, with hidden Mac files vetoed on the Windows share\&. See EXAMPLES\&. +.PP +To allow each client to control when the Avid application refreshes their Avid databases, create files for each client and each Avid media directory with the name [avid_dir_name]_[client_ip_address]_[client_username]\&. To trigger Avid database refreshes, update the write time on those files\&. See EXAMPLES\&. +.PP +It is also necessary for the +cache locked write times = no +option to be set for clients to be able to control their Avid media folder write times\&. +.SH "EXAMPLES" +.PP +Enable media_harmony for Mac and Windows clients: +.sp +.if n \{\ +.RS 4 +.\} +.nf + \fI[avid_mac]\fR + \m[blue]\fBpath = /avid\fR\m[] + \m[blue]\fBvfs objects = media_harmony\fR\m[] + \m[blue]\fBcache locked write times = no\fR\m[] + \fI[avid_win]\fR + \m[blue]\fBpath = /avid\fR\m[] + \m[blue]\fBvfs objects = media_harmony\fR\m[] + \m[blue]\fBcache locked write times = no\fR\m[] + \m[blue]\fBveto files = /\&.DS_Store/\&._@/\&.Trash@/\&.Spotlight@/\&.hidden/\&.hotfiles@/\&.vol/\fR\m[] + \m[blue]\fBdelete veto files = yes\fR\m[] +.fi +.if n \{\ +.RE +.\} +.PP +Create the files that will allow users david and susan to control their own Avid database refreshes: +.sp +.if n \{\ +.RS 4 +.\} +.nf + touch \*(Aq/avid/OMFI MediaFiles_192\&.168\&.1\&.10_david\*(Aq \e + \*(Aq/avid/OMFI MediaFiles_192\&.168\&.1\&.11_susan\*(Aq \e + \*(Aq/avid/Avid MediaFiles/MXF/1_192\&.168\&.1\&.10_david\*(Aq \e + \*(Aq/avid/Avid MediaFiles/MXF/1_192\&.168\&.1\&.11_susan\*(Aq +.fi +.if n \{\ +.RE +.\} +.PP +Trigger an Avid database refresh for user david: +.sp +.if n \{\ +.RS 4 +.\} +.nf + touch \*(Aq/avid/OMFI MediaFiles_192\&.168\&.1\&.10_david\*(Aq \e + \*(Aq/avid/Avid MediaFiles/MXF/1_192\&.168\&.1\&.10_david\*(Aq +.fi +.if n \{\ +.RE +.\} +.PP +If you have a large number of Avid media folders to manage, you can give each editor a suitably modified version of examples/scripts/vfs/media_harmony/trigger_avid_update\&.py to create and update these files\&. +.SH "CAVEATS" +.PP +vfs_media_harmony +is designed to work with Avid editing applications that look in the Avid MediaFiles or OMFI MediaFiles directories for media\&. It is not designed to work as expected in all circumstances for general use\&. For example: It is possible to open a client\-specific file such as msmMMOB\&.mdb_192\&.168\&.1\&.10_userx even though it doesn\*(Aqt show up in a directory listing\&. +.SH "VERSION" +.PP +This man page is part of version 4\&.19\&.2\-git\&.328\&.e4c431e307f150600\&.1\&.23SUSE\-oS15\&.0\-x86_64 of the Samba suite\&. +.SH "AUTHOR" +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. diff --git a/upstream/opensuse-leap-15-6/man8/vfs_offline.8 b/upstream/opensuse-leap-15-6/man8/vfs_offline.8 new file mode 100644 index 00000000..c6300816 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/vfs_offline.8 @@ -0,0 +1,65 @@ +'\" t +.\" Title: vfs_offline +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 10/23/2023 +.\" Manual: System Administration tools +.\" Source: Samba 4.19.2-git.328.e4c431e307f150600.1.23SUSE-oS15.0-x86_64 +.\" Language: English +.\" +.TH "VFS_OFFLINE" "8" "10/23/2023" "Samba 4\&.19\&.2\-git\&.328\&." "System Administration tools" +.\" ----------------------------------------------------------------- +.\" * 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" +vfs_offline \- Mark all files as offline +.SH "SYNOPSIS" +.HP \w'\ 'u +vfs objects = offline +.SH "DESCRIPTION" +.PP +This VFS module is part of the +\fBsamba\fR(7) +suite\&. +.PP +The +vfs_offline +module marks all files in the share as having the offline DOS attribute\&. +.PP +Files with the offline DOS attribute are handled differently by the Windows SMB client, as well as by Windows Explorer\&. In particular, Windows Explorer does not read those files for the sole purpose of drawing a thumbnail, as it normally does\&. This can improve user experience with some remote file systems\&. +.SH "EXAMPLES" +.PP +Mark all files in a share as offline: +.sp +.if n \{\ +.RS 4 +.\} +.nf + \fI[remote]\fR + \m[blue]\fBvfs objects = offline\fR\m[] +.fi +.if n \{\ +.RE +.\} +.SH "VERSION" +.PP +This man page is part of version 4\&.19\&.2\-git\&.328\&.e4c431e307f150600\&.1\&.23SUSE\-oS15\&.0\-x86_64 of the Samba suite\&. +.SH "AUTHOR" +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. diff --git a/upstream/opensuse-leap-15-6/man8/vfs_preopen.8 b/upstream/opensuse-leap-15-6/man8/vfs_preopen.8 new file mode 100644 index 00000000..3f9cc524 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/vfs_preopen.8 @@ -0,0 +1,155 @@ +'\" t +.\" Title: vfs_preopen +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 10/23/2023 +.\" Manual: System Administration tools +.\" Source: Samba 4.19.2-git.328.e4c431e307f150600.1.23SUSE-oS15.0-x86_64 +.\" Language: English +.\" +.TH "VFS_PREOPEN" "8" "10/23/2023" "Samba 4\&.19\&.2\-git\&.328\&." "System Administration tools" +.\" ----------------------------------------------------------------- +.\" * 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" +vfs_preopen \- Hide read latencies for applications reading numbered files +.SH "SYNOPSIS" +.HP \w'\ 'u +vfs objects = preopen +.SH "DESCRIPTION" +.PP +This VFS module is part of the +\fBsamba\fR(7) +suite\&. +.PP +This module assists applications that want to read numbered files in sequence with very strict latency requirements\&. One area where this happens in video streaming applications that want to read one file per frame\&. +.PP +When you use this module, a number of helper processes is started that speculatively open files and read a number of bytes to prime the file system cache, so that later on when the real application\*(Aqs request comes along, no disk access is necessary\&. +.PP +This module is stackable\&. +.SH "OPTIONS" +.PP +preopen:posix\-basic\-regex = BOOL (default: no) +.RS 4 +preopen:posix\-basic\-regex = yes +changes the meaning of the +preopen:names +option\&. Further details are described there\&. +.RE +.PP +preopen:names = /pattern1/pattern2/ +.RS 4 +preopen:names specifies the file name pattern(s) which should trigger the preopen helpers to do their work\&. We assume that the files are numbered incrementally\&. So if your file names are numbered FRAME00000\&.frm FRAME00001\&.frm and so on you would list them as +preopen:names=/FRAME*\&.frm/\&. The default algorithm uses the first (at least 3) digits it finds in order to calculate the name of the next frames\&. +.sp +preopen:posix\-basic\-regex = yes +changes the meaning of the +preopen:names +option\&. It means \*(AqPOSIX Basic Regular Expression\*(Aq strings are used as patterns\&. The key is each pattern requires exactly one \*(Aqsubexpression\*(Aq starting with \*(Aq\e(\*(Aq and ending with \*(Aq\e)\*(Aq in order to specify the position of the digits representing the incrementing frame numbers\&. Given a file names like Movie7599Frame0v1234\&.txt, Movie7599Frame1v1234\&.txt, Movie7599Frame2v1234\&.txt up to Movie7599Frame9v1234\&.txt you can use +preopen:names = /\&.*Frame\e([0\-9]\e)\&.*\e\&.txt/ +in order to match just a single digits, this might not be a real world example, but it shows the flexibility that is possible here\&. +.RE +.PP +preopen:num_bytes = BYTES +.RS 4 +Specifies the number of bytes the helpers should speculatively read, defaults to 1\&. +.RE +.PP +preopen:helpers = NUM\-PROCS +.RS 4 +Number of forked helper processes, defaults to 1\&. +.RE +.PP +preopen:queuelen = NUM\-FILES +.RS 4 +Number of files that should be speculatively opened\&. Defaults to the 10 subsequent files\&. +.RE +.PP +preopen:nomatch_log_level = LOGLEVEL +.RS 4 +In order to debug or audit the usage of the preopen logic you can use this option to specify at what log level details about filenames not matching any pattern from \*(Aqpreopen:names\*(Aq are logged\&. +.sp +Defaults to the log level 5\&. See also +\fBsmb.conf\fR(5) +in the \*(Aq\m[blue]\fBlog level\fR\m[]\*(Aq section for special handling of the \*(Aqpreopen\*(Aq debug class\&. +.RE +.PP +preopen:match_log_level = LOGLEVEL +.RS 4 +In order to debug or audit the usage of the preopen logic you can use this option to specify at what log level details about filenames actually matching a pattern from \*(Aqpreopen:names\*(Aq are logged\&. +.sp +See also \*(Aqpreopen:founddigits_log_level\*(Aq and \*(Aqpreopen:push_log_level\*(Aq\&. +.sp +Defaults to the log level 5\&. See also +\fBsmb.conf\fR(5) +in the \*(Aq\m[blue]\fBlog level\fR\m[]\*(Aq section for special handling of the \*(Aqpreopen\*(Aq debug class\&. +.RE +.PP +preopen:nodigits_log_level = LOGLEVEL +.RS 4 +In order to debug or audit problems with the preopen configuration you can use this option to specify at what log level details about filenames actually matching a pattern from \*(Aqpreopen:names\*(Aq, but at the same time don\*(Aqt contain the expected digits, are logged\&. This is typically something the administrator wants to notice and adjust the configuration in order to define more precisely where to find the digits in the filename\&. +.sp +Defaults to the log level 1\&. See also +\fBsmb.conf\fR(5) +in the \*(Aq\m[blue]\fBlog level\fR\m[]\*(Aq section for special handling of the \*(Aqpreopen\*(Aq debug class\&. +.RE +.PP +preopen:founddigits_log_level = LOGLEVEL +.RS 4 +In order to debug or audit the usage of the preopen logic you can use this option to specify at what log level details about filenames actually matching a pattern from \*(Aqpreopen:names\*(Aq, and at the same time having valid expected digits, are logged\&. This means enough information is available in order to queue preopens\&. +.sp +Defaults to the log level 3\&. See also +\fBsmb.conf\fR(5) +in the \*(Aq\m[blue]\fBlog level\fR\m[]\*(Aq section for special handling of the \*(Aqpreopen\*(Aq debug class\&. +.RE +.PP +preopen:reset_log_level = LOGLEVEL +.RS 4 +If a matching filename belongs to a different pattern from \*(Aqpreopen:names\*(Aq, a different parent directory or differs in a significant way from the last filename that was found before, the module needs to reset it\*(Aqs internal queue state\&. This means that no more preopens will be pushed to helper processes belonging to the former queue state\&. In order to debug or audit such queue resets you can use this option to specify at what log level details are logged\&. +.sp +Defaults to the log level 5\&. See also +\fBsmb.conf\fR(5) +in the \*(Aq\m[blue]\fBlog level\fR\m[]\*(Aq section for special handling of the \*(Aqpreopen\*(Aq debug class\&. +.RE +.PP +preopen:push_log_level = LOGLEVEL +.RS 4 +In order to debug or audit the usage of the preopen logic you can use this option to specify at what log level details about filenames actually pushed to preopen helper processes are logged\&. This means they will actually be preopened soon\&. +.sp +Defaults to the log level 3\&. See also +\fBsmb.conf\fR(5) +in the \*(Aq\m[blue]\fBlog level\fR\m[]\*(Aq section for special handling of the \*(Aqpreopen\*(Aq debug class\&. +.RE +.PP +preopen:queue_log_level = LOGLEVEL +.RS 4 +In order to debug details about internal queue processing you can use this option to specify at what log level the details are logged\&. +.sp +Defaults to the log level 10\&. See also +\fBsmb.conf\fR(5) +in the \*(Aq\m[blue]\fBlog level\fR\m[]\*(Aq section for special handling of the \*(Aqpreopen\*(Aq debug class\&. +.RE +.SH "VERSION" +.PP +This man page is part of version 4\&.19\&.2\-git\&.328\&.e4c431e307f150600\&.1\&.23SUSE\-oS15\&.0\-x86_64 of the Samba suite\&. +.SH "AUTHOR" +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. +.PP +The PREOPEN VFS module was created with contributions from Volker Lendecke and the developers at IBM\&. diff --git a/upstream/opensuse-leap-15-6/man8/vfs_readahead.8 b/upstream/opensuse-leap-15-6/man8/vfs_readahead.8 new file mode 100644 index 00000000..8e618850 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/vfs_readahead.8 @@ -0,0 +1,121 @@ +'\" t +.\" Title: vfs_readahead +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 10/23/2023 +.\" Manual: System Administration tools +.\" Source: Samba 4.19.2-git.328.e4c431e307f150600.1.23SUSE-oS15.0-x86_64 +.\" Language: English +.\" +.TH "VFS_READAHEAD" "8" "10/23/2023" "Samba 4\&.19\&.2\-git\&.328\&." "System Administration tools" +.\" ----------------------------------------------------------------- +.\" * 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" +vfs_readahead \- pre\-load the kernel buffer cache +.SH "SYNOPSIS" +.HP \w'\ 'u +vfs objects = readahead +.SH "DESCRIPTION" +.PP +This VFS module is part of the +\fBsamba\fR(7) +suite\&. +.PP +This +vfs_readahead +VFS module detects read requests at multiples of a given offset (hex 0x80000 by default) and then tells the kernel via either the readahead system call (on Linux) or the posix_fadvise system call to pre\-fetch this data into the buffer cache\&. +.PP +This module is useful for Windows Vista clients reading data using the Windows Explorer program, which asynchronously does multiple file read requests at offset boundaries of 0x80000 bytes\&. +.PP +The offset multiple used is given by the readahead:offset option, which defaults to 0x80000\&. +.PP +The size of the disk read operations performed by +vfs_readahead +is determined by the readahead:length option\&. By default this is set to the same value as the readahead:offset option and if not set explicitly will use the current value of readahead:offset\&. +.PP +This module is stackable\&. +.SH "OPTIONS" +.PP +readahead:offset = BYTES +.RS 4 +The offset multiple that causes readahead to be requested of the kernel buffer cache\&. +.RE +.PP +readahead:length = BYTES +.RS 4 +The number of bytes requested to be read into the kernel buffer cache on each readahead call\&. +.RE +.PP +The following suffixes may be applied to BYTES: +.RS +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +K +\- BYTES is a number of kilobytes +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +M +\- BYTES is a number of megabytes +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +G +\- BYTES is a number of gigabytes +.RE +.SH "EXAMPLES" +.sp +.if n \{\ +.RS 4 +.\} +.nf + \fI[hypothetical]\fR + \m[blue]\fBvfs objects = readahead\fR\m[] +.fi +.if n \{\ +.RE +.\} +.SH "VERSION" +.PP +This man page is part of version 4\&.19\&.2\-git\&.328\&.e4c431e307f150600\&.1\&.23SUSE\-oS15\&.0\-x86_64 of the Samba suite\&. +.SH "AUTHOR" +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. diff --git a/upstream/opensuse-leap-15-6/man8/vfs_readonly.8 b/upstream/opensuse-leap-15-6/man8/vfs_readonly.8 new file mode 100644 index 00000000..727c516d --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/vfs_readonly.8 @@ -0,0 +1,87 @@ +'\" t +.\" Title: vfs_readonly +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 10/23/2023 +.\" Manual: System Administration tools +.\" Source: Samba 4.19.2-git.328.e4c431e307f150600.1.23SUSE-oS15.0-x86_64 +.\" Language: English +.\" +.TH "VFS_READONLY" "8" "10/23/2023" "Samba 4\&.19\&.2\-git\&.328\&." "System Administration tools" +.\" ----------------------------------------------------------------- +.\" * 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" +vfs_readonly \- make a Samba share read only for a specified time period +.SH "SYNOPSIS" +.HP \w'\ 'u +vfs objects = readonly +.SH "DESCRIPTION" +.PP +This VFS module is part of the +\fBsamba\fR(7) +suite\&. +.PP +The +vfs_readonly +VFS module marks a share as read only for all clients connecting within the configured time period\&. Clients connecting during this time will be denied write access to all files in the share, irrespective of their actual access privileges\&. +.PP +This module is stackable\&. +.SH "OPTIONS" +.PP +readonly:period = BEGIN, END +.RS 4 +Only mark the share as read only if the client connection was made between the times marked by the BEGIN and END date specifiers\&. The syntax of these date specifiers is the same as that accepted by the \-d option of GNU +\fBdate\fR(1)\&. +.RE +.SH "EXAMPLES" +.PP +Mark all shares read only: +.sp +.if n \{\ +.RS 4 +.\} +.nf + \fI[global]\fR + \m[blue]\fBvfs objects = readonly\fR\m[] +.fi +.if n \{\ +.RE +.\} +.PP +Mark the [backup] share as read only during business hours: +.sp +.if n \{\ +.RS 4 +.\} +.nf + \fI[backup]\fR + \m[blue]\fBpath = /readonly\fR\m[] + \m[blue]\fBvfs objects = readonly\fR\m[] + \m[blue]\fBreadonly:period = readonly:period = "today 9:00","today 17:00"\fR\m[] +.fi +.if n \{\ +.RE +.\} +.SH "VERSION" +.PP +This man page is part of version 4\&.19\&.2\-git\&.328\&.e4c431e307f150600\&.1\&.23SUSE\-oS15\&.0\-x86_64 of the Samba suite\&. +.SH "AUTHOR" +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. diff --git a/upstream/opensuse-leap-15-6/man8/vfs_recycle.8 b/upstream/opensuse-leap-15-6/man8/vfs_recycle.8 new file mode 100644 index 00000000..bf49f483 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/vfs_recycle.8 @@ -0,0 +1,142 @@ +'\" t +.\" Title: vfs_recycle +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 10/23/2023 +.\" Manual: System Administration tools +.\" Source: Samba 4.19.2-git.328.e4c431e307f150600.1.23SUSE-oS15.0-x86_64 +.\" Language: English +.\" +.TH "VFS_RECYCLE" "8" "10/23/2023" "Samba 4\&.19\&.2\-git\&.328\&." "System Administration tools" +.\" ----------------------------------------------------------------- +.\" * 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" +vfs_recycle \- Samba VFS recycle bin +.SH "SYNOPSIS" +.HP \w'\ 'u +vfs objects = recycle +.SH "DESCRIPTION" +.PP +This VFS module is part of the +\fBsamba\fR(7) +suite\&. +.PP +The +vfs_recycle +intercepts file deletion requests and moves the affected files to a temporary repository rather than deleting them immediately\&. This gives the same effect as the Recycle Bin on Windows computers\&. +.PP +The Recycle Bin will not appear in Windows Explorer views of the network file system (share) nor on any mapped drive\&. Instead, a directory called \&.recycle will be automatically created when the first file is deleted and recycle:repository is not configured\&. If recycle:repository is configured, the name of the created directory depends on recycle:repository\&. Users can recover files from the recycle bin\&. If the recycle:keeptree option has been specified, deleted files will be found in a path identical with that from which the file was deleted\&. +.PP +This module is stackable\&. +.SH "OPTIONS" +.PP +recycle:repository = PATH +.RS 4 +Path of the directory where deleted files should be moved\&. +.sp +If this option is not set, the default path \&.recycle is used\&. +.RE +.PP +recycle:directory_mode = MODE +.RS 4 +Set MODE to the octal mode the recycle repository should be created with\&. The recycle repository will be created when first file is deleted\&. If recycle:subdir_mode is not set, MODE also applies to subdirectories\&. +.sp +If this option is not set, the default mode 0700 is used\&. +.RE +.PP +recycle:subdir_mode = MODE +.RS 4 +Set MODE to the octal mode with which sub directories of the recycle repository should be created\&. +.sp +If this option is not set, subdirectories will be created with the mode from recycle:directory_mode\&. +.RE +.PP +recycle:keeptree = BOOL +.RS 4 +Specifies whether the directory structure should be preserved or whether the files in a directory that is being deleted should be kept separately in the repository\&. +.RE +.PP +recycle:versions = BOOL +.RS 4 +If this option is True, two files with the same name that are deleted will both be kept in the repository\&. Newer deleted versions of a file will be called "Copy #x of filename"\&. +.RE +.PP +recycle:touch = BOOL +.RS 4 +Specifies whether a file\*(Aqs access date should be updated when the file is moved to the repository\&. +.RE +.PP +recycle:touch_mtime = BOOL +.RS 4 +Specifies whether a file\*(Aqs last modified date should be updated when the file is moved to the repository\&. +.RE +.PP +recycle:minsize = BYTES +.RS 4 +Files that are smaller than the number of bytes specified by this parameter will not be put into the repository\&. +.RE +.PP +recycle:maxsize = BYTES +.RS 4 +Files that are larger than the number of bytes specified by this parameter will not be put into the repository\&. +.RE +.PP +recycle:exclude = LIST +.RS 4 +List of files that should not be put into the repository when deleted, but deleted in the normal way\&. Wildcards such as * and ? are supported\&. +.RE +.PP +recycle:exclude_dir = LIST +.RS 4 +List of directories whose files should not be put into the repository when deleted, but deleted in the normal way\&. Wildcards such as * and ? are supported\&. +.RE +.PP +recycle:noversions = LIST +.RS 4 +Specifies a list of paths (wildcards such as * and ? are supported) for which no versioning should be used\&. Only useful when recycle:versions is enabled\&. +.RE +.SH "EXAMPLES" +.PP +Move files "deleted" on +\fIshare\fR +to +\fI/data/share/\&.recycle\fR +instead of deleting them: +.sp +.if n \{\ +.RS 4 +.\} +.nf + \fI[share]\fR + \m[blue]\fBpath = /data/share\fR\m[] + \m[blue]\fBvfs objects = recycle\fR\m[] + \m[blue]\fBrecycle:repository = \&.recycle\fR\m[] + \m[blue]\fBrecycle:keeptree = yes\fR\m[] + \m[blue]\fBrecycle:versions = yes\fR\m[] +.fi +.if n \{\ +.RE +.\} +.SH "VERSION" +.PP +This man page is part of version 4\&.19\&.2\-git\&.328\&.e4c431e307f150600\&.1\&.23SUSE\-oS15\&.0\-x86_64 of the Samba suite\&. +.SH "AUTHOR" +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. diff --git a/upstream/opensuse-leap-15-6/man8/vfs_shadow_copy.8 b/upstream/opensuse-leap-15-6/man8/vfs_shadow_copy.8 new file mode 100644 index 00000000..4448513c --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/vfs_shadow_copy.8 @@ -0,0 +1,173 @@ +'\" t +.\" Title: vfs_shadow_copy +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 10/23/2023 +.\" Manual: System Administration tools +.\" Source: Samba 4.19.2-git.328.e4c431e307f150600.1.23SUSE-oS15.0-x86_64 +.\" Language: English +.\" +.TH "VFS_SHADOW_COPY" "8" "10/23/2023" "Samba 4\&.19\&.2\-git\&.328\&." "System Administration tools" +.\" ----------------------------------------------------------------- +.\" * 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" +vfs_shadow_copy \- Expose snapshots to Windows clients as shadow copies\&. +.SH "SYNOPSIS" +.HP \w'\ 'u +vfs objects = shadow_copy +.SH "DESCRIPTION" +.PP +This VFS module is part of the +\fBsamba\fR(7) +suite\&. +.PP +The +vfs_shadow_copy +VFS module functionality that is similar to Microsoft Shadow Copy services\&. When setup properly, this module allows Microsoft Shadow Copy clients to browse "shadow copies" on Samba shares\&. +.PP +This module is stackable\&. +.SH "CONFIGURATION" +.PP +vfs_shadow_copy +relies on a filesystem snapshot implementation\&. Many common filesystems have native support for this\&. +.PP +Filesystem snapshots must be mounted on specially named directories in order to be recognized by +vfs_shadow_copy\&. The snapshot mount points must be immediate children of a the directory being shared\&. +.PP +The snapshot naming convention is @GMT\-YYYY\&.MM\&.DD\-hh\&.mm\&.ss, where: +.RS +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +YYYY +is the 4 digit year +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +MM +is the 2 digit month +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +DD +is the 2 digit day +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +hh +is the 2 digit hour +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +mm +is the 2 digit minute +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +ss +is the 2 digit second\&. +.RE +.sp +.RE +.PP +The +vfs_shadow_copy +snapshot naming convention can be produced with the following +\fBdate\fR(1) +command: +.sp +.if n \{\ +.RS 4 +.\} +.nf + TZ=GMT date +@GMT\-%Y\&.%m\&.%d\-%H\&.%M\&.%S + +.fi +.if n \{\ +.RE +.\} +.SH "EXAMPLES" +.PP +Add shadow copy support to user home directories: +.sp +.if n \{\ +.RS 4 +.\} +.nf + \fI[homes]\fR + \m[blue]\fBvfs objects = shadow_copy\fR\m[] +.fi +.if n \{\ +.RE +.\} +.SH "CAVEATS" +.PP +This is not a backup, archival, or version control solution\&. +.PP +With Samba or Windows servers, +vfs_shadow_copy +is designed to be an end\-user tool only\&. It does not replace or enhance your backup and archival solutions and should in no way be considered as such\&. Additionally, if you need version control, implement a version control system\&. +.SH "VERSION" +.PP +This man page is part of version 4\&.19\&.2\-git\&.328\&.e4c431e307f150600\&.1\&.23SUSE\-oS15\&.0\-x86_64 of the Samba suite\&. +.SH "AUTHOR" +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. diff --git a/upstream/opensuse-leap-15-6/man8/vfs_shadow_copy2.8 b/upstream/opensuse-leap-15-6/man8/vfs_shadow_copy2.8 new file mode 100644 index 00000000..4b1adaa1 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/vfs_shadow_copy2.8 @@ -0,0 +1,525 @@ +'\" t +.\" Title: vfs_shadow_copy2 +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 10/23/2023 +.\" Manual: System Administration tools +.\" Source: Samba 4.19.2-git.328.e4c431e307f150600.1.23SUSE-oS15.0-x86_64 +.\" Language: English +.\" +.TH "VFS_SHADOW_COPY2" "8" "10/23/2023" "Samba 4\&.19\&.2\-git\&.328\&." "System Administration tools" +.\" ----------------------------------------------------------------- +.\" * 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" +vfs_shadow_copy2 \- Expose snapshots to Windows clients as shadow copies\&. +.SH "SYNOPSIS" +.HP \w'\ 'u +vfs objects = shadow_copy2 +.SH "DESCRIPTION" +.PP +This VFS module is part of the +\fBsamba\fR(7) +suite\&. +.PP +The +vfs_shadow_copy2 +VFS module offers a functionality similar to Microsoft Shadow Copy services\&. When set up properly, this module allows Microsoft Shadow Copy clients to browse through file system snapshots as "shadow copies" on Samba shares\&. +.PP +This is a second implementation of a shadow copy module which has the following additional features (compared to the original +\fBshadow_copy\fR(8) +module): +.RS +.sp +.RS 4 +.ie n \{\ +\h'-04' 1.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 1." 4.2 +.\} +There is no need any more to populate your share\*(Aqs root directory with symlinks to the snapshots if the file system stores the snapshots elsewhere\&. Instead, you can flexibly configure the module where to look for the file system snapshots\&. This can be very important when you have thousands of shares, or use [homes]\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04' 2.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 2." 4.2 +.\} +Snapshot directories need not be in one fixed central place but can be located anywhere in the directory tree\&. This mode helps to support file systems that offer snapshotting of particular subtrees, for example the GPFS independent file sets\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04' 3.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 3." 4.2 +.\} +Vanity naming for snapshots: snapshots can be named in any format compatible with str[fp]time conversions\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04' 4.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 4." 4.2 +.\} +Timestamps can be represented in localtime rather than UTC\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04' 5.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 5." 4.2 +.\} +The inode number of the files can optionally be altered to be different from the original\&. This fixes the \*(Aqrestore\*(Aq button in the Windows GUI to work without a sharing violation when serving from file systems, like GPFS, that return the same device and inode number for the snapshot file and the original\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04' 6.\h'+01'\c +.\} +.el \{\ +.sp -1 +.IP " 6." 4.2 +.\} +Shadow copy results are by default sorted before being sent to the client\&. This is beneficial for filesystems that don\*(Aqt read directories alphabetically (the default unix)\&. Sort ordering can be configured and sorting can be turned off completely if the file system sorts its directory listing\&. +.RE +.sp +.RE +.PP +This module is stackable\&. +.SH "CONFIGURATION" +.PP +vfs_shadow_copy2 +relies on a filesystem snapshot implementation\&. Many common filesystems have native support for this\&. +.PP +Filesystem snapshots must be available under specially named directories in order to be recognized by +vfs_shadow_copy2\&. These snapshot directory is typically a direct subdirectory of the share root\*(Aqs mountpoint but there are other modes that can be configured with the parameters described in detail below\&. +.PP +The snapshot at a given point in time is expected in a subdirectory of the snapshot directory where the snapshot\*(Aqs directory is expected to be a formatted version of the snapshot time\&. The default format which can be changed with the +shadow:format +option is @GMT\-YYYY\&.MM\&.DD\-hh\&.mm\&.ss, where: +.RS +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +YYYY +is the 4 digit year +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +MM +is the 2 digit month +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +DD +is the 2 digit day +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +hh +is the 2 digit hour +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +mm +is the 2 digit minute +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +ss +is the 2 digit second\&. +.RE +.sp +.RE +.PP +The +vfs_shadow_copy2 +snapshot naming convention can be produced with the following +\fBdate\fR(1) +command: +.sp +.if n \{\ +.RS 4 +.\} +.nf + TZ=GMT date +@GMT\-%Y\&.%m\&.%d\-%H\&.%M\&.%S + +.fi +.if n \{\ +.RE +.\} +.SH "OPTIONS" +.PP +shadow:mountpoint = MOUNTPOINT +.RS 4 +With this parameter, one can specify the mount point of the filesystem that contains the share path\&. Usually this mount point is automatically detected\&. But for some constellations, in particular tests, it can be convenient to be able to specify it\&. +.sp +Example: shadow:mountpoint = /path/to/filesystem +.sp +Default: shadow:mountpoint = NOT SPECIFIED +.RE +.PP +shadow:snapdir = SNAPDIR +.RS 4 +Path to the directory where the file system of the share keeps its snapshots\&. If an absolute path is specified, it is used as\-is\&. If a relative path is specified, then it is taken relative to the mount point of the filesystem of the share root\&. (See +shadow:mountpoint\&.) +.sp +Note that +shadow:snapdirseverywhere +depends on this parameter and needs a relative path\&. Setting an absolute path disables +shadow:snapdirseverywhere\&. +.sp +Note that the +shadow:crossmountpoints +option also requires a relative snapdir\&. Setting an absolute path disables +shadow:crossmountpoints\&. +.sp +Example: shadow:snapdir = /some/absolute/path +.sp +Default: shadow:snapdir = \&.snapshots +.RE +.PP +shadow:basedir = BASEDIR +.RS 4 +The basedir option allows one to specify a directory between the share\*(Aqs mount point and the share root, relative to which the file system\*(Aqs snapshots are taken\&. +.sp +For example, if +.RS +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +basedir = mountpoint/rel_basedir +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +share_root = basedir/rel_share_root +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +snapshot_path = mountpoint/snapdir +.sp +or +snapshot_path = snapdir +if snapdir is absolute +.RE +.sp +.RE +then the snapshot of a +file = mountpoint/rel_basedir/rel_share_root/rel_file +at a time TIME will be found under +snapshot_path/FS_GMT_TOKEN(TIME)/rel_share_root/rel_file, where FS_GMT_TOKEN(TIME) is the timestamp string belonging to TIME in the format required by the file system\&. (See +shadow:format\&.) +.sp +The default for the basedir is the mount point of the file system of the share root (see +shadow:mountpoint)\&. +.sp +Note that the +shadow:snapdirseverywhere +and +shadow:crossmountpoints +options are incompatible with +shadow:basedir +and disable the basedir setting\&. +.RE +.PP +shadow:snapsharepath = SNAPSHAREPATH +.RS 4 +With this parameter, one can specify the path of the share\*(Aqs root directory in snapshots, relative to the snapshot\*(Aqs root directory\&. It is an alternative method to +shadow:basedir, allowing greater control\&. +.sp +For example, if within each snapshot the files of the share have a +path/to/share/ +prefix, then +shadow:snapsharepath +can be set to +path/to/share\&. +.sp +With this parameter, it is no longer assumed that a snapshot represents an image of the original file system or a portion of it\&. For example, a system could perform backups of only files contained in shares, and then expose the backup files in a logical structure: +.RS +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +share1/ +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +share2/ +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\&.\&.\&./ +.RE +.sp +.RE +Note that the +shadow:snapdirseverywhere +and the +shadow:basedir +options are incompatible with +shadow:snapsharepath +and disable +shadow:snapsharepath +setting\&. +.sp +Example: shadow:snapsharepath = path/to/share +.sp +Default: shadow:snapsharepath = NOT SPECIFIED +.RE +.PP +shadow:sort = asc/desc +.RS 4 +By default, this module sorts the shadow copy data alphabetically before sending it to the client\&. With this parameter, one can specify the sort order\&. Possible known values are desc (descending, the default) and asc (ascending)\&. If the file system lists directories alphabetically sorted, one can turn off sorting in this module by specifying any other value\&. +.sp +Example: shadow:sort = asc +.sp +Example: shadow:sort = none +.sp +Default: shadow:sort = desc +.RE +.PP +shadow:localtime = yes/no +.RS 4 +This is an optional parameter that indicates whether the snapshot names are in UTC/GMT or in local time\&. If it is disabled then UTC/GMT is expected\&. +.sp +shadow:localtime = no +.RE +.PP +shadow:format = format specification for snapshot names +.RS 4 +This is an optional parameter that specifies the format specification for the naming of snapshots in the file system\&. The format must be compatible with the conversion specifications recognized by str[fp]time\&. +.sp +Default: shadow:format = "@GMT\-%Y\&.%m\&.%d\-%H\&.%M\&.%S" +.RE +.PP +shadow:sscanf = yes/no +.RS 4 +This parameter can be used to specify that the time in format string is given as an unsigned long integer (%lu) rather than a time strptime() can parse\&. The result must be a unix time_t time\&. +.sp +Default: shadow:sscanf = no +.RE +.PP +shadow:fixinodes = yes/no +.RS 4 +If you enable +shadow:fixinodes +then this module will modify the apparent inode number of files in the snapshot directories using a hash of the files path\&. This is needed for snapshot systems where the snapshots have the same device:inode number as the original files (such as happens with GPFS snapshots)\&. If you don\*(Aqt set this option then the \*(Aqrestore\*(Aq button in the shadow copy UI will fail with a sharing violation\&. +.sp +Default: shadow:fixinodes = no +.RE +.PP +shadow:snapdirseverywhere = yes/no +.RS 4 +If you enable +shadow:snapdirseverywhere +then this module will look out for snapshot directories in the current working directory and all parent directories, stopping at the mount point by default\&. But see +shadow:crossmountpoints +how to change that behaviour\&. +.sp +An example where this is needed are independent filesets in IBM\*(Aqs GPFS, but other filesystems might support snapshotting only particular subtrees of the filesystem as well\&. +.sp +Note that +shadow:snapdirseverywhere +depends on +shadow:snapdir +and needs it to be a relative path\&. Setting an absolute snapdir path disables +shadow:snapdirseverywhere\&. +.sp +Note that this option is incompatible with the +shadow:basedir +option and removes the +shadow:basedir +setting by itself\&. +.sp +Example: shadow:snapdirseverywhere = yes +.sp +Default: shadow:snapdirseverywhere = no +.RE +.PP +shadow:crossmountpoints = yes/no +.RS 4 +This option is effective in the case of +shadow:snapdirseverywhere = yes\&. Setting this option makes the module not stop at the first mount point encountered when looking for snapdirs, but lets it search potentially all through the path instead\&. +.sp +An example where this is needed are independent filesets in IBM\*(Aqs GPFS, but other filesystems might support snapshotting only particular subtrees of the filesystem as well\&. +.sp +Note that +shadow:crossmountpoints +depends on +shadow:snapdir +and needs it to be a relative path\&. Setting an absolute snapdir path disables +shadow:crossmountpoints\&. +.sp +Note that this option is incompatible with the +shadow:basedir +option and removes the +shadow:basedir +setting by itself\&. +.sp +Example: shadow:crossmountpoints = yes +.sp +Default: shadow:crossmountpoints = no +.RE +.PP +shadow:snapprefix +.RS 4 +With growing number of snapshots file\-systems need some mechanism to differentiate one set of snapshots from other, e\&.g\&. monthly, weekly, manual, special events, etc\&. Therefore these file\-systems provide different ways to tag snapshots, e\&.g\&. provide a configurable way to name snapshots, which is not just based on time\&. With only +shadow:format +it is very difficult to filter these snapshots\&. With this optional parameter, one can specify a variable prefix component for names of the snapshot directories in the file\-system\&. If this parameter is set, together with the +shadow:format +and +shadow:delimiter +parameters it determines the possible names of snapshot directories in the file\-system\&. The option only supports Basic Regular Expression (BRE)\&. +.RE +.PP +shadow:delimiter +.RS 4 +This optional parameter is used as a delimiter between +shadow:snapprefix +and +shadow:format\&. This parameter is used only when +shadow:snapprefix +is set\&. +.sp +Default: shadow:delimiter = "_GMT" +.RE +.SH "EXAMPLES" +.PP +Add shadow copy support to user home directories: +.sp +.if n \{\ +.RS 4 +.\} +.nf + \fI[homes]\fR + \m[blue]\fBvfs objects = shadow_copy2\fR\m[] + \m[blue]\fBshadow:snapdir = /data/snapshots\fR\m[] + \m[blue]\fBshadow:basedir = /data/home\fR\m[] + \m[blue]\fBshadow:sort = desc\fR\m[] +.fi +.if n \{\ +.RE +.\} +.SH "CAVEATS" +.PP +This is not a backup, archival, or version control solution\&. +.PP +With Samba or Windows servers, +vfs_shadow_copy2 +is designed to be an end\-user tool only\&. It does not replace or enhance your backup and archival solutions and should in no way be considered as such\&. Additionally, if you need version control, implement a version control system\&. +.SH "VERSION" +.PP +This man page is part of version 4\&.19\&.2\-git\&.328\&.e4c431e307f150600\&.1\&.23SUSE\-oS15\&.0\-x86_64 of the Samba suite\&. +.SH "AUTHOR" +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. diff --git a/upstream/opensuse-leap-15-6/man8/vfs_shell_snap.8 b/upstream/opensuse-leap-15-6/man8/vfs_shell_snap.8 new file mode 100644 index 00000000..3e7f4cba --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/vfs_shell_snap.8 @@ -0,0 +1,220 @@ +'\" t +.\" Title: vfs_shell_snap +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 10/23/2023 +.\" Manual: System Administration tools +.\" Source: Samba 4.19.2-git.328.e4c431e307f150600.1.23SUSE-oS15.0-x86_64 +.\" Language: English +.\" +.TH "VFS_SHELL_SNAP" "8" "10/23/2023" "Samba 4\&.19\&.2\-git\&.328\&." "System Administration tools" +.\" ----------------------------------------------------------------- +.\" * 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" +vfs_shell_snap \- Shell script callouts for snapshot creation and deletion +.SH "SYNOPSIS" +.HP \w'\ 'u +vfs objects = shell_snap +.SH "DESCRIPTION" +.PP +This VFS module is part of the +\fBsamba\fR(8) +suite\&. +.PP +The +vfs_shell_snap +VFS provides shell\-script callouts for snapshot creation and deletion operations issued by remote clients using the File Server Remote VSS Protocol (FSRVP)\&. +.PP +The following shell callouts may be configured in smb\&.conf: +.PP +\m[blue]\fBshell_snap:check path command\fR\m[] +.RS +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Called when an FSRVP client wishes to check whether a given share supports snapshot create/delete requests\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +The command is called with a single +\fIshare_path\fR +argument\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +The command must return 0 if +\fIshare_path\fR +is capable of being snapshotted\&. +.RE +.sp +.RE +.PP +\m[blue]\fBshell_snap:create command\fR\m[] +.RS +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Called when an FSRVP client wishes to create a snapshot\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +The command is called with a single +\fIshare_path\fR +argument\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +The command must return 0 status if the snapshot was successfully taken\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +The command must output the path of the newly created snapshot to stdout\&. +.RE +.sp +.RE +.PP +\m[blue]\fBshell_snap:delete command\fR\m[] +.RS +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Called when an FSRVP client wishes to delete a snapshot\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +The command is called with +\fIbase_share_path\fR +and +\fIsnapshot_share_path\fR +arguments\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +The command must return 0 status if the snapshot was successfully removed\&. +.RE +.sp +.RE +All commands are executed as the authenticated FSRVP client user\&. +.PP +This module is stackable\&. +.SH "CONFIGURATION" +.sp +.if n \{\ +.RS 4 +.\} +.nf + \fI[share]\fR + \m[blue]\fBvfs objects = shell_snap\fR\m[] + \m[blue]\fBshell_snap:check path command = snap_check_path\&.sh\fR\m[] + \m[blue]\fBshell_snap:create command = snap_create\&.sh\fR\m[] + \m[blue]\fBshell_snap:delete command = snap_delete\&.sh\fR\m[] + +.fi +.if n \{\ +.RE +.\} +.PP +Samba\*(Aqs FSRVP server must be configured in the [global] section: +.sp +.if n \{\ +.RS 4 +.\} +.nf + \fI[global]\fR + \m[blue]\fBregistry shares = yes\fR\m[] + \m[blue]\fBinclude = registry\fR\m[] + +.fi +.if n \{\ +.RE +.\} +.SH "VERSION" +.PP +This man page is part of version 4\&.19\&.2\-git\&.328\&.e4c431e307f150600\&.1\&.23SUSE\-oS15\&.0\-x86_64 of the Samba suite\&. +.SH "AUTHOR" +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. diff --git a/upstream/opensuse-leap-15-6/man8/vfs_snapper.8 b/upstream/opensuse-leap-15-6/man8/vfs_snapper.8 new file mode 100644 index 00000000..a4a9e7fa --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/vfs_snapper.8 @@ -0,0 +1,90 @@ +'\" t +.\" Title: vfs_snapper +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 10/23/2023 +.\" Manual: System Administration tools +.\" Source: Samba 4.19.2-git.328.e4c431e307f150600.1.23SUSE-oS15.0-x86_64 +.\" Language: English +.\" +.TH "VFS_SNAPPER" "8" "10/23/2023" "Samba 4\&.19\&.2\-git\&.328\&." "System Administration tools" +.\" ----------------------------------------------------------------- +.\" * 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" +vfs_snapper \- Expose snapshots managed by snapper as shadow\-copies +.SH "SYNOPSIS" +.HP \w'\ 'u +vfs objects = snapper +.SH "DESCRIPTION" +.PP +This VFS module is part of the +\fBsamba\fR(8) +suite\&. +.PP +The +vfs_snapper +VFS module exposes snapshots managed by snapper for use by Samba\&. This provides the ability for remote SMB clients to access shadow\-copies via Windows Explorer using the "previous versions" dialog\&. +.PP +Snapshots can also be created and remove remotely, using the File Server Remote VSS Protocol (FSRVP)\&. Snapshot creation and deletion requests are forwarded to snapper via DBus\&. +.PP +This module is stackable\&. +.SH "CONFIGURATION" +.PP +The underlying share path must have a corresponding snapper configuration file\&. The snapshot directory tree must allow access for relevant users\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf + \fI[share]\fR + \m[blue]\fBvfs objects = snapper\fR\m[] + +.fi +.if n \{\ +.RE +.\} +.PP +For remote snapshot creation and deletion, Samba\*(Aqs FSRVP server must be configured in the [global] section: +.sp +.if n \{\ +.RS 4 +.\} +.nf + \fI[global]\fR + \m[blue]\fBregistry shares = yes\fR\m[] + \m[blue]\fBinclude = registry\fR\m[] + +.fi +.if n \{\ +.RE +.\} +.SH "PERMISSIONS" +.PP +Snapper stores snapshots under a \&.snapshots subdirectory\&. This directory must permit traversal for any users wishing to access snapshots via the Windows Explorer previous versions dialog\&. By default, traversal is forbidden for all non\-root users\&. Additionally, users must be granted permission to list snapshots managed by snapper, via snapper\*(Aqs ALLOW_USERS or ALLOW_GROUPS options\&. Snapper can grant these users and groups \&.snapshots traversal access automatically via the SYNC_ACL option\&. +.PP +Remote snapshot creation and deletion is only permitted by Samba for Active Directory administrators, backup operators, or users explicitly granted SeBackupPrivilege\&. Snapper must also permit creation and deletion for the appropriate user, via snapper\*(Aqs ALLOW_USERS or ALLOW_GROUPS options\&. +.PP +The DiskShadow\&.exe FSRVP client initially authenticates as the Active Directory computer account\&. This account must therefore be granted the same permissions as the user account issuing the snapshot creation and deletion requests\&. +.SH "VERSION" +.PP +This man page is part of version 4\&.19\&.2\-git\&.328\&.e4c431e307f150600\&.1\&.23SUSE\-oS15\&.0\-x86_64 of the Samba suite\&. +.SH "AUTHOR" +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. diff --git a/upstream/opensuse-leap-15-6/man8/vfs_streams_depot.8 b/upstream/opensuse-leap-15-6/man8/vfs_streams_depot.8 new file mode 100644 index 00000000..4bba707a --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/vfs_streams_depot.8 @@ -0,0 +1,98 @@ +'\" t +.\" Title: vfs_streams_depot +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 10/23/2023 +.\" Manual: System Administration tools +.\" Source: Samba 4.19.2-git.328.e4c431e307f150600.1.23SUSE-oS15.0-x86_64 +.\" Language: English +.\" +.TH "VFS_STREAMS_DEPOT" "8" "10/23/2023" "Samba 4\&.19\&.2\-git\&.328\&." "System Administration tools" +.\" ----------------------------------------------------------------- +.\" * 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" +vfs_streams_depot \- EXPERIMENTAL module to store alternate data streams in a central directory\&. +.SH "SYNOPSIS" +.HP \w'\ 'u +vfs objects = streams_depot +.SH "DESCRIPTION" +.PP +This +\fIEXPERIMENTAL\fR +VFS module is part of the +\fBsamba\fR(7) +suite\&. +.PP +The +vfs_streams_depot +enables storing of NTFS alternate data streams in the file system\&. As a normal posix file system does not support the concept of multiple data streams per file, the streams_depot module stores the data in files in a separate directory\&. +.SH "OPTIONS" +.PP +streams_depot:directory = PATH +.RS 4 +Path of the directory where the alternate data streams should be stored\&. Defaults to the sharepath/\&.streams\&. +.RE +.PP +streams_depot:delete_lost = [ yes | no ] +.RS 4 +In the case of an already existing data streams directory for a newly created file the streams directory will be renamed to "lost\-%lu", random()\&. With this option lost stream directories will be removed instead of renamed\&. +.RS +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +no(default) +\- rename lost streams to "lost\-%lu", random()\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +yes +\- remove lost streams\&. +.RE +.sp +.RE +.RE +.SH "EXAMPLES" +.sp +.if n \{\ +.RS 4 +.\} +.nf + \fI[share]\fR + \m[blue]\fBvfs objects = streams_depot\fR\m[] +.fi +.if n \{\ +.RE +.\} +.SH "AUTHOR" +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. diff --git a/upstream/opensuse-leap-15-6/man8/vfs_streams_xattr.8 b/upstream/opensuse-leap-15-6/man8/vfs_streams_xattr.8 new file mode 100644 index 00000000..cf963dc1 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/vfs_streams_xattr.8 @@ -0,0 +1,76 @@ +'\" t +.\" Title: vfs_streams_xattr +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 10/23/2023 +.\" Manual: System Administration tools +.\" Source: Samba 4.19.2-git.328.e4c431e307f150600.1.23SUSE-oS15.0-x86_64 +.\" Language: English +.\" +.TH "VFS_STREAMS_XATTR" "8" "10/23/2023" "Samba 4\&.19\&.2\-git\&.328\&." "System Administration tools" +.\" ----------------------------------------------------------------- +.\" * 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" +vfs_streams_xattr \- Store alternate data streams in posix xattrs +.SH "SYNOPSIS" +.HP \w'\ 'u +vfs objects = streams_xattr +.SH "DESCRIPTION" +.PP +This VFS module is part of the +\fBsamba\fR(7) +suite\&. +.PP +The +vfs_streams_xattr +enables storing of NTFS alternate data streams in the file system\&. As a normal posix file system does not support the concept of multiple data streams per file, the streams_xattr module stores the data in posix extended attributes (xattrs)\&. The name of these attributes by default is user\&.DosStream\&."ADS\-NAME"\&. The prefix "user\&.DosStream\&." can be changed with the module option +streams_xattr:prefix, but be aware that this will also expose those ADS over the SMB extended attributes interface\&. +.PP +The file system that is shared with this module enabled must support xattrs\&. +.PP +Please note that most file systems have severe limitations on the size of xattrs\&. So this module might work for applications like IE that stores small zone information in streams but will fail for applications that store serious amounts of data in ADSs\&. +.SH "OPTIONS" +.PP +streams_xattr:prefix = STRING +.RS 4 +Name prefix used when storing an ADS in an xattr, defaults to +user\&.DosStream\&.\&. Changing this will also expose ADS over the SMB extended attributes interface\&. +.RE +.PP +streams_xattr:store_stream_type = [yes|no] +.RS 4 +Whether the xattr names for Alternate Data Streams of type "$DATA" are suffixed by the stream type string ":$DATA"\&. The default is +yes\&. +.RE +.SH "EXAMPLES" +.sp +.if n \{\ +.RS 4 +.\} +.nf + \fI[share]\fR + \m[blue]\fBvfs objects = streams_xattr\fR\m[] +.fi +.if n \{\ +.RE +.\} +.SH "AUTHOR" +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. diff --git a/upstream/opensuse-leap-15-6/man8/vfs_syncops.8 b/upstream/opensuse-leap-15-6/man8/vfs_syncops.8 new file mode 100644 index 00000000..84090390 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/vfs_syncops.8 @@ -0,0 +1,82 @@ +'\" t +.\" Title: vfs_syncops +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 10/23/2023 +.\" Manual: System Administration tools +.\" Source: Samba 4.19.2-git.328.e4c431e307f150600.1.23SUSE-oS15.0-x86_64 +.\" Language: English +.\" +.TH "VFS_SYNCOPS" "8" "10/23/2023" "Samba 4\&.19\&.2\-git\&.328\&." "System Administration tools" +.\" ----------------------------------------------------------------- +.\" * 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" +vfs_syncops \- Ensure meta data operations are performed synchronously\&. +.SH "SYNOPSIS" +.HP \w'\ 'u +vfs objects = syncops +.SH "DESCRIPTION" +.PP +This VFS module is part of the +\fBsamba\fR(7) +suite\&. +.PP +Some filesystems (even some journaled filesystems) require that a fsync() be performed on many meta data operations to ensure that the operation is guaranteed to remain in the filesystem after a power failure\&. This is particularly important for some cluster filesystems which are participating in a node failover system with clustered Samba\&. On those filesystems the +vfs_syncops +VFS module provides a way to perform those operations safely\&. +.PP +This module is stackable\&. +.SH "CONFIGURATION" +.PP +Most of the performance loss with the +vfs_syncops +VFS module is in fsync on close()\&. You can disable that with +syncops:onclose = no +that can be set either globally or per share\&. +.PP +On certain filesystems that only require the last data written to be fsync()\*(Aqed, you can disable the metadata synchronization of this module with +syncops:onmeta = no\&. This option can be set either globally or per share\&. +.PP +The +vfs_syncops +VFS module can also be disabled completely for a share with +syncops:disable = true\&. +.SH "EXAMPLES" +.PP +Add syncops functionality for [share]: +.sp +.if n \{\ +.RS 4 +.\} +.nf + \fI[share]\fR + \m[blue]\fBpath = /data/share\fR\m[] + \m[blue]\fBvfs objects = syncops\fR\m[] + \m[blue]\fBsyncops:onclose = no\fR\m[] +.fi +.if n \{\ +.RE +.\} +.SH "VERSION" +.PP +This man page is part of version 4\&.19\&.2\-git\&.328\&.e4c431e307f150600\&.1\&.23SUSE\-oS15\&.0\-x86_64 of the Samba suite\&. +.SH "AUTHOR" +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. diff --git a/upstream/opensuse-leap-15-6/man8/vfs_time_audit.8 b/upstream/opensuse-leap-15-6/man8/vfs_time_audit.8 new file mode 100644 index 00000000..dbc189cc --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/vfs_time_audit.8 @@ -0,0 +1,80 @@ +'\" t +.\" Title: vfs_time_audit +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 10/23/2023 +.\" Manual: System Administration tools +.\" Source: Samba 4.19.2-git.328.e4c431e307f150600.1.23SUSE-oS15.0-x86_64 +.\" Language: English +.\" +.TH "VFS_TIME_AUDIT" "8" "10/23/2023" "Samba 4\&.19\&.2\-git\&.328\&." "System Administration tools" +.\" ----------------------------------------------------------------- +.\" * 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" +vfs_time_audit \- samba vfs module to log slow VFS operations +.SH "SYNOPSIS" +.HP \w'\ 'u +vfs objects = time_audit +.SH "DESCRIPTION" +.PP +This VFS module is part of the +\fBsamba\fR(7) +suite\&. +.PP +The +time_audit +VFS module logs system calls that take longer than the number of milliseconds defined by the variable +time_audit:timeout\&. It will log the calls and the time spent in it\&. +.PP +It\*(Aqs kind of comparable with +strace \-T +and is helpful to reveal performance problems with the underlying file and storage subsystems\&. +.PP +This module is stackable\&. +.SH "OPTIONS" +.PP +time_audit:timeout = number of milliseconds +.RS 4 +VFS calls that take longer than the defined number of milliseconds that should be logged\&. The default is 10000 (10s)\&. +.RE +.SH "EXAMPLES" +.PP +This would log VFS calls that take longer than 3 seconds: +.sp +.if n \{\ +.RS 4 +.\} +.nf + \fI[sample_share]\fR + \m[blue]\fBpath = /test/sample_share\fR\m[] + \m[blue]\fBvfs objects = time_audit\fR\m[] + \m[blue]\fBtime_audit:timeout = 3000\fR\m[] +.fi +.if n \{\ +.RE +.\} +.SH "VERSION" +.PP +This man page is part of version 4\&.19\&.2\-git\&.328\&.e4c431e307f150600\&.1\&.23SUSE\-oS15\&.0\-x86_64 of the Samba suite\&. +.SH "AUTHOR" +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. +.PP +The time_audit VFS module was created with contributions from Abhidnya Chirmule\&. diff --git a/upstream/opensuse-leap-15-6/man8/vfs_unityed_media.8 b/upstream/opensuse-leap-15-6/man8/vfs_unityed_media.8 new file mode 100644 index 00000000..265756df --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/vfs_unityed_media.8 @@ -0,0 +1,117 @@ +'\" t +.\" Title: vfs_unityed_media +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 10/23/2023 +.\" Manual: System Administration tools +.\" Source: Samba 4.19.2-git.328.e4c431e307f150600.1.23SUSE-oS15.0-x86_64 +.\" Language: English +.\" +.TH "VFS_UNITYED_MEDIA" "8" "10/23/2023" "Samba 4\&.19\&.2\-git\&.328\&." "System Administration tools" +.\" ----------------------------------------------------------------- +.\" * 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" +vfs_unityed_media \- Allow multiple Avid clients to share a network drive\&. +.SH "SYNOPSIS" +.HP \w'\ 'u +vfs objects = unityed_media +.SH "DESCRIPTION" +.PP +This VFS module is part of the +\fBsamba\fR(7) +suite\&. +.PP +Unityed Media is related with Media Harmony VFS, the main difference between Unityed Media and Media Harmony is that Unityed Media doesn\*(Aqt need manual refreshing of media directories\&. Unityed Media handles your media files in a similar way to the way Unity, ISIS, EditShare or another dedicated solution does\&. Without client\-side application and on hardware of your choice\&. +.PP +This module is stackable\&. +.SH "CONFIGURATION" +.PP +If Mac and Windows Avid clients will be accessing the same folder, they should be given separate share definitions, with hidden Mac files vetoed on the Windows share\&. See EXAMPLES\&. +.SH "OPTIONS" +.PP +unityed_media:clientid = user | hostname | ip +.RS 4 +Controls what client related identifier is appended to user specific paths: +.RS +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +user (default) +\- use the username\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +hostname +\- use the hostname\&. Note this will not work with OS X clients as these always send a generic string ("workstation") to the server\&.\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +ip +\- use the client\*(Aqs IP address\&. NOTE: this is untested and may not work at all\&. +.RE +.sp +.RE +.RE +.SH "EXAMPLES" +.PP +Enable unityed_media for Mac and Windows clients: +.sp +.if n \{\ +.RS 4 +.\} +.nf + \fI[avid_mac]\fR + \m[blue]\fBpath = /avid\fR\m[] + \m[blue]\fBvfs objects = unityed_media\fR\m[] + \fI[avid_win]\fR + \m[blue]\fBpath = /avid\fR\m[] + \m[blue]\fBvfs objects = unityed_media\fR\m[] + \m[blue]\fBveto files = /\&.DS_Store/\&._@/\&.Trash@/\&.Spotlight@/\&.hidden/\&.hotfiles@/\&.vol/\fR\m[] + \m[blue]\fBdelete veto files = yes\fR\m[] +.fi +.if n \{\ +.RE +.\} +.SH "VERSION" +.PP +This man page is part of version 4\&.19\&.2\-git\&.328\&.e4c431e307f150600\&.1\&.23SUSE\-oS15\&.0\-x86_64 of the Samba suite\&. +.SH "AUTHOR" +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. diff --git a/upstream/opensuse-leap-15-6/man8/vfs_virusfilter.8 b/upstream/opensuse-leap-15-6/man8/vfs_virusfilter.8 new file mode 100644 index 00000000..b54e5739 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/vfs_virusfilter.8 @@ -0,0 +1,341 @@ +'\" t +.\" Title: vfs_virusfilter +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 10/23/2023 +.\" Manual: System Administration tools +.\" Source: Samba 4.8 +.\" Language: English +.\" +.TH "VFS_VIRUSFILTER" "8" "10/23/2023" "Samba 4\&.8" "System Administration tools" +.\" ----------------------------------------------------------------- +.\" * 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" +vfs_virusfilter \- On access virus scanner +.SH "SYNOPSIS" +.HP \w'\ 'u +vfs objects = virusfilter +.SH "DESCRIPTION" +.PP +This is a set of various Samba VFS modules to scan and filter virus files on Samba file services with an anti\-virus scanner\&. +.PP +This module is stackable\&. +.SH "OPTIONS" +.PP +virusfilter:scanner +.RS 4 +The antivirus scan\-engine\&. +.RS +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fIsophos\fR, the Sophos AV scanner +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fIfsav\fR, the F\-Secure AV scanner +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fIclamav\fR, the ClamAV scanner +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fIdummy\fR, dummy scanner used in tests\&. Checks against the +\fIinfected files\fR +parameter and flags any name that matches as infected\&. +.RE +.sp +.RE +.RE +.PP +virusfilter:socket path = PATH +.RS 4 +Path of local socket for the virus scanner\&. +.sp +If this option is not set, the default path depends on the configured AV scanning engine\&. +.sp +For the +\fIsophos\fRbackend the default is +\fI/var/run/savdi/sssp\&.sock\fR\&. +.sp +For the +\fIfsav\fR +backend the default is +\fI/tmp/\&.fsav\-0\fR\&. +.sp +For the +\fIclamav\fR +backend the default is +\fI/var/run/clamav/clamd\&.ctl\fR\&. +.RE +.PP +virusfilter:connect timeout = 30000 +.RS 4 +Controls how long to wait on connecting to the virus scanning process before timing out\&. Value is in milliseconds\&. +.sp +If this option is not set, the default is 30000\&. +.RE +.PP +virusfilter:io timeout = 60000 +.RS 4 +Controls how long to wait on communications with the virus scanning process before timing out\&. Value is in milliseconds\&. +.sp +If this option is not set, the default is 60000\&. +.RE +.PP +virusfilter:scan on open = yes +.RS 4 +This option controls whether files are scanned on open\&. +.sp +If this option is not set, the default is yes\&. +.RE +.PP +virusfilter:scan on close = no +.RS 4 +This option controls whether files are scanned on close\&. +.sp +If this option is not set, the default is no\&. +.RE +.PP +virusfilter:max file size = 100000000 +.RS 4 +This is the largest sized file, in bytes, which will be scanned\&. +.sp +If this option is not set, the default is 100MB\&. +.RE +.PP +virusfilter:min file size = 10 +.RS 4 +This is the smallest sized file, in bytes, which will be scanned\&. +.sp +If this option is not set, the default is 10\&. +.RE +.PP +virusfilter:infected file action = nothing +.RS 4 +What to do with an infected file\&. The options are nothing, quarantine, rename, delete\&. +.sp +If this option is not set, the default is nothing\&. +.RE +.PP +virusfilter:infected file errno on open = EACCES +.RS 4 +What errno to return on open if the file is infected\&. +.sp +If this option is not set, the default is EACCES\&. +.RE +.PP +virusfilter:infected file errno on close = 0 +.RS 4 +What errno to return on close if the file is infected\&. +.sp +If this option is not set, the default is 0\&. +.RE +.PP +virusfilter:quarantine directory = PATH +.RS 4 +Where to move infected files\&. This path must be an absolute path\&. +.sp +If this option is not set, the default is "\&.quarantine" relative to the share path\&. +.RE +.PP +virusfilter:quarantine prefix = virusfilter\&. +.RS 4 +Prefix for quarantined files\&. +.sp +If this option is not set, the default is "virusfilter\&."\&. +.RE +.PP +virusfilter:quarantine suffix = \&.infected +.RS 4 +Suffix for quarantined files\&. This option is only used if keep name is true\&. Otherwise it is ignored\&. +.sp +If this option is not set, the default is "\&.infected"\&. +.RE +.PP +virusfilter:rename prefix = virusfilter\&. +.RS 4 +Prefix for infected files\&. +.sp +If this option is not set, the default is "virusfilter\&."\&. +.RE +.PP +virusfilter:rename suffix = \&.infected +.RS 4 +Suffix for infected files\&. +.sp +If this option is not set, the default is "\&.infected"\&. +.RE +.PP +virusfilter:quarantine keep tree = yes +.RS 4 +If keep tree is set, the directory structure relative to the share is maintained in the quarantine directory\&. +.sp +If this option is not set, the default is yes\&. +.RE +.PP +virusfilter:quarantine keep name = yes +.RS 4 +Should the file name be left unmodified other than adding a suffix and/or prefix and a random suffix name as defined in virusfilter:rename prefix and virusfilter:rename suffix\&. +.sp +If this option is not set, the default is yes\&. +.RE +.PP +virusfilter:infected file command = @SAMBA_DATADIR@/bin/virusfilter\-notify \-\-mail\-to virusmaster@example\&.com \-\-cc "%U@example\&.com" \-\-from samba@example\&.com \-\-subject\-prefix "Samba: Infected File: " +.RS 4 +External command to run on an infected file is found\&. +.sp +If this option is not set, the default is none\&. +.RE +.PP +virusfilter:scan archive = true +.RS 4 +This defines whether or not to scan archives\&. +.sp +Sophos and F\-Secure support this and it defaults to false\&. +.RE +.PP +virusfilter:max nested scan archive = 1 +.RS 4 +This defines the maximum depth to search nested archives\&. +.sp +The Sophos and F\-Secure support this and it defaults to 1\&. +.RE +.PP +virusfilter:scan mime = true +.RS 4 +This defines whether or not to scan mime files\&. +.sp +Only the +\fIfsav\fRscanner supports this option and defaults to false\&. +.RE +.PP +virusfilter:scan error command = @SAMBA_DATADIR@/bin/virusfilter\-notify \-\-mail\-to virusmaster@example\&.com \-\-from samba@example\&.com \-\-subject\-prefix "Samba: Scan Error: " +.RS 4 +External command to run on scan error\&. +.sp +If this option is not set, the default is none\&. +.RE +.PP +virusfilter:exclude files = empty +.RS 4 +Files to exclude from scanning\&. +.sp +If this option is not set, the default is empty\&. +.RE +.PP +virusfilter:infected files = empty +.RS 4 +Files that virusfilter +\fIdummy\fR +flags as infected\&. +.sp +If this option is not set, the default is empty\&. +.RE +.PP +virusfilter:block access on error = false +.RS 4 +Controls whether or not access should be blocked on a scanning error\&. +.sp +If this option is not set, the default is false\&. +.RE +.PP +virusfilter:scan error errno on open = EACCES +.RS 4 +What errno to return on open if there is an error in scanning the file and block access on error is true\&. +.sp +If this option is not set, the default is EACCES\&. +.RE +.PP +virusfilter:scan error errno on close = 0 +.RS 4 +What errno to return on close if there is an error in scanning the file and block access on error is true\&. +.sp +If this option is not set, the default is 0\&. +.RE +.PP +virusfilter:cache entry limit = 100 +.RS 4 +The maximum number of entries in the scanning results cache\&. Due to how Samba\*(Aqs memcache works, this is approximate\&. +.sp +If this option is not set, the default is 100\&. +.RE +.PP +virusfilter:cache time limit = 10 +.RS 4 +The maximum number of seconds that a scanning result will stay in the results cache\&. \-1 disables the limit\&. 0 disables caching\&. +.sp +If this option is not set, the default is 10\&. +.RE +.PP +virusfilter:quarantine directory mode = 0755 +.RS 4 +This is the octet mode for the quarantine directory and its sub\-directories as they are created\&. +.sp +If this option is not set, the default is 0755 or S_IRUSR | S_IWUSR | S_IXUSR | S_IRGRP | S_IXGRP | S_IROTH | S_IXOTH\&. +.sp +Permissions must be such that all users can read and search\&. I\&.E\&. don\*(Aqt mess with this unless you really know what you are doing\&. +.RE +.PP +virusfilter:block suspected file = false +.RS 4 +With this option on, suspected malware will be blocked as well\&. Only the +\fIfsav\fRscanner supports this option\&. +.sp +If this option is not set, the default is false\&. +.RE +.SH "NOTES" +.PP +This module can scan other than default streams, if the alternative datastreams are each backed as separate files, such as with the vfs module streams_depot\&. +.PP +For proper operation the streams support module must be before the virusfilter module in your vfs objects list (i\&.e\&. streams_depot must be called before virusfilter module)\&. +.PP +This module is intended for security in depth by providing virus scanning capability on the server\&. It is not intended to be used in lieu of proper client based security\&. Other modules for security may exist and may be desirable for security in depth on the server\&. +.SH "AUTHOR" +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. diff --git a/upstream/opensuse-leap-15-6/man8/vfs_widelinks.8 b/upstream/opensuse-leap-15-6/man8/vfs_widelinks.8 new file mode 100644 index 00000000..fdf5a850 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/vfs_widelinks.8 @@ -0,0 +1,59 @@ +'\" t +.\" Title: vfs_widelinks +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 10/23/2023 +.\" Manual: System Administration tools +.\" Source: Samba 4.19.2-git.328.e4c431e307f150600.1.23SUSE-oS15.0-x86_64 +.\" Language: English +.\" +.TH "VFS_WIDELINKS" "8" "10/23/2023" "Samba 4\&.19\&.2\-git\&.328\&." "System Administration tools" +.\" ----------------------------------------------------------------- +.\" * 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" +vfs_widelinks \- make a Samba share ignore filesystem symbolic links inside a share +.SH "SYNOPSIS" +.HP \w'\ 'u +vfs objects = widelinks +.SH "DESCRIPTION" +.PP +This VFS module is part of the +\fBsamba\fR(7) +suite\&. +.PP +The +vfs_widelinks +VFS module hides the existence of symbolic links in the filesystem inside a share\&. It is used in Samba version 4\&.13 and above to implement the +smb\&.conf"wide links = yes" functionality that used to be inside the core smbd code\&. The module should not be loaded explicitly by smb\&.conf as part of the "vfs objects =" parameter, but is loaded implicitly when "wide links = yes" is enabled\&. This is to prevent existing smb\&.conf files from having to be modified to keep the existing insecure "wide links" functionality on a share\&. +.PP +Please note that "wide links = yes" functionality is a deliberately insecure option, and should never be used in Samba installations\&. On Linux, bind mounts can be used instead to implement anything "wide links = yes" can enable\&. This module has been created to provide backwards compatibility with existing users of "wide links = yes" installations, but this use cannot be recommended and is not endorsed by the Samba developers\&. +.PP +Note that this implicit loading may become explicit in a later Samba release, and administrators wishing to keep the insecure "wide links" functionality may have to add this module into their "vfs objects =" module list\&. The Samba project release notes and this manpage will be updated to reflect this when this change is made\&. +.PP +This module is stackable\&. +.SH "EXAMPLES" +.PP +No examples listed\&. This module is implicitly loaded by smbd as needed\&. +.SH "VERSION" +.PP +This man page is part of version 4\&.19\&.2\-git\&.328\&.e4c431e307f150600\&.1\&.23SUSE\-oS15\&.0\-x86_64 of the Samba suite\&. +.SH "AUTHOR" +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. diff --git a/upstream/opensuse-leap-15-6/man8/vfs_worm.8 b/upstream/opensuse-leap-15-6/man8/vfs_worm.8 new file mode 100644 index 00000000..39638652 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/vfs_worm.8 @@ -0,0 +1,74 @@ +'\" t +.\" Title: vfs_worm +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 10/23/2023 +.\" Manual: System Administration tools +.\" Source: Samba 4.19.2-git.328.e4c431e307f150600.1.23SUSE-oS15.0-x86_64 +.\" Language: English +.\" +.TH "VFS_WORM" "8" "10/23/2023" "Samba 4\&.19\&.2\-git\&.328\&." "System Administration tools" +.\" ----------------------------------------------------------------- +.\" * 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" +vfs_worm \- disallows writes for older file +.SH "SYNOPSIS" +.HP \w'\ 'u +vfs objects = worm +.SH "DESCRIPTION" +.PP +This VFS module is part of the +\fBsamba\fR(7) +suite\&. +.PP +The +vfs_worm +module controls the writability of files and folders depending on their change time and a adjustable grace period\&. +.PP +If the change time of a file or directory is older than the specified grace period, the write access will be denied, independent of further access controls (e\&.g\&. by the filesystem)\&. +.PP +In the case that the grace period is not exceed, the worm module will not impact any access controls\&. +.SH "OPTIONS" +.PP +worm:grace_period = SECONDS +.RS 4 +Period in seconds which defines the time how long the write access should be handled by the normal access controls\&. After this grace period the file or directory becomes read only\&. +.RE +.SH "EXAMPLES" +.PP +Deny the write access to files and folders, which are older than five minutes (300 seconds): +.sp +.if n \{\ +.RS 4 +.\} +.nf + \fI[wormshare]\fR + \m[blue]\fBvfs objects = worm\fR\m[] + \m[blue]\fBworm:grace_period = 300\fR\m[] +.fi +.if n \{\ +.RE +.\} +.SH "VERSION" +.PP +This man page is part of version 4\&.19\&.2\-git\&.328\&.e4c431e307f150600\&.1\&.23SUSE\-oS15\&.0\-x86_64 of the Samba suite\&. +.SH "AUTHOR" +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. diff --git a/upstream/opensuse-leap-15-6/man8/vfs_xattr_tdb.8 b/upstream/opensuse-leap-15-6/man8/vfs_xattr_tdb.8 new file mode 100644 index 00000000..b15d90b0 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/vfs_xattr_tdb.8 @@ -0,0 +1,56 @@ +'\" t +.\" Title: vfs_xattr_tdb +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 10/23/2023 +.\" Manual: System Administration tools +.\" Source: Samba 4.19.2-git.328.e4c431e307f150600.1.23SUSE-oS15.0-x86_64 +.\" Language: English +.\" +.TH "VFS_XATTR_TDB" "8" "10/23/2023" "Samba 4\&.19\&.2\-git\&.328\&." "System Administration tools" +.\" ----------------------------------------------------------------- +.\" * 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" +vfs_xattr_tdb \- Save Extended Attributes (EAs) in a tdb file +.SH "SYNOPSIS" +.HP \w'\ 'u +vfs objects = xattr_tdb +.SH "DESCRIPTION" +.PP +This VFS module is part of the +\fBsamba\fR(7) +suite\&. +.PP +The +vfs_xattr_tdb +VFS module stores Extended Attributes (EAs) in a tdb file\&. This enables the usage of Extended Attributes on OS and filesystems which do not support Extended Attributes by themselves\&. +.PP +This module is stackable\&. +.SH "OPTIONS" +.PP +xattr_tdb:file = PATH +.RS 4 +Name of the tdb file the EAs are stored in\&. If this option is not set, the default filename +xattr\&.tdb +is used\&. +.RE +.SH "AUTHOR" +.PP +The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&. diff --git a/upstream/opensuse-leap-15-6/man8/warnquota.8 b/upstream/opensuse-leap-15-6/man8/warnquota.8 new file mode 100644 index 00000000..4226c457 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/warnquota.8 @@ -0,0 +1,125 @@ +.TH WARNQUOTA 8 +.SH NAME +warnquota \- send mail to users over quota +.SH SYNOPSIS +.B warnquota +[ +.B \-ugsid +] [ +.B \-F +.I quotaformat +] [ +.B \-q +.I quotatab +] [ +.B \-c +.I configfile +] [ +.B \-a +.I adminsfile +] [ +.IR filesystem ... +] +.SH DESCRIPTION +.B warnquota +checks the disk quota for specified local filesystems (or for each local +filesystem if none specified) and mails a warning message to those users who +have reached their softlimit. It is typically run via +.BR cron (8). +.TP +.B -F, --format=\f2quotaformat\f1 +Perform setting for specified format (ie. don't perform format autodetection). +Possible format names are: +.B vfsold +Original quota format with 16-bit UIDs / GIDs, +.B vfsv0 +Quota format with 32-bit UIDs / GIDs, 64-bit space usage, 32-bit inode usage and limits, +.B vfsv1 +Quota format with 64-bit quota limits and usage, +.B xfs +Quota on XFS filesystem. +.TP +.B -q, --quota-tab=\f2quotatab\f1 +Use +.I quotatab +instead of +.I /etc/quotatab +as file with device description strings (see +.BR quotatab (5) +for syntax). +.TP +.B -c, --config=\f2configfile\f1 +Use +.I configfile +instead of +.I /etc/warnquota.conf +as configuration file (see +.BR warnquota.conf (5) +for syntax). +.TP +.B -a, --admins-file=\f2adminsfile\f1 +Use +.I adminsfile +instead of +.I /etc/quotagrpadmins +as a file with administrators of the groups (see +.BR quotagrpadmins (5) +for syntax). +.TP +.B -u, --user +check whether users are not exceeding quotas (default). +.TP +.B -g, --group +check whether groups are not exceeding quotas. If group is exceeding quota +a mail is sent to the user specified in /etc/quotagrpadmins. +.TP +.B -s, --human-readable[=\f2units\f1] +Try to report used space, number of used inodes and limits in more appropriate +units than the default ones. Units can be also specified explicitely by an +optional argument in format [ +.BR kgt +],[ +.BR kgt +] where the first character specifies space units and the second character +specifies inode units. +.TP +.B -i, --no-autofs +ignore mountpoints mounted by automounter. +.TP +.B -d, --no-details +do not attach quota report in email. +.SH FILES +.PD 0 +.TP 20 +.B aquota.user +quota file at the filesystem root (version 2 quota, non-XFS filesystems) +.TP +.B quota.user +quota file at the filesystem root (version 1 quota, non-XFS filesystems) +.TP +.B /etc/warnquota.conf +configuration file +.TP +.B /etc/quotatab +device description +.TP +.B /etc/quotagrpadmins +administrators of the groups +.TP +.B /etc/mtab +default filesystems +.TP +.B /etc/passwd +default set of users +.PD +.SH "SEE ALSO" +.BR quota (1), +.BR quotatab (5), +.BR quotagrpadmins (5), +.BR warnquota.conf (5), +.BR cron (8), +.BR edquota (8). +.SH AUTHORS +.BR warnquota (8) +was written by Marco van Wieringen <mvw@planets.elm.net>, modifications by Jan Kara <jack@suse.cz>. +This reference page written by Heiko Schlittermann <heiko@lotte.sax.de>, modifications by Jan Kara diff --git a/upstream/opensuse-leap-15-6/man8/wdctl.8 b/upstream/opensuse-leap-15-6/man8/wdctl.8 new file mode 100644 index 00000000..4131c558 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/wdctl.8 @@ -0,0 +1,114 @@ +'\" t +.\" Title: wdctl +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "WDCTL" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +wdctl \- show hardware watchdog status +.SH "SYNOPSIS" +.sp +\fBwdctl\fP [options] [\fIdevice\fP...] +.SH "DESCRIPTION" +.sp +Show hardware watchdog status. The default device is \fI/dev/watchdog\fP. If more than one device is specified then the output is separated by one blank line. +.sp +If the device is already used or user has no permissions to read from the device, then \fBwdctl\fP reads data from sysfs. In this case information about supported features (flags) might be missing. +.sp +Note that the number of supported watchdog features is hardware specific. +.SH "OPTIONS" +.sp +\fB\-f\fP, \fB\-\-flags\fP \fIlist\fP +.RS 4 +Print only the specified flags. +.RE +.sp +\fB\-F\fP, \fB\-\-noflags\fP +.RS 4 +Do not print information about flags. +.RE +.sp +\fB\-I\fP, \fB\-\-noident\fP +.RS 4 +Do not print watchdog identity information. +.RE +.sp +\fB\-n\fP, \fB\-\-noheadings\fP +.RS 4 +Do not print a header line for flags table. +.RE +.sp +\fB\-o\fP, \fB\-\-output\fP \fIlist\fP +.RS 4 +Define the output columns to use in table of watchdog flags. If no output arrangement is specified, then a default set is used. Use \fB\-\-help\fP to get list of all supported columns. +.RE +.sp +\fB\-O\fP, \fB\-\-oneline\fP +.RS 4 +Print all wanted information on one line in key="value" output format. +.RE +.sp +\fB\-r\fP, \fB\-\-raw\fP +.RS 4 +Use the raw output format. +.RE +.sp +\fB\-s\fP, \fB\-settimeout\fP \fIseconds\fP +.RS 4 +Set the watchdog timeout in seconds. +.RE +.sp +\fB\-T\fP, \fB\-\-notimeouts\fP +.RS 4 +Do not print watchdog timeouts. +.RE +.sp +\fB\-x\fP, \fB\-\-flags\-only\fP +.RS 4 +Same as \fB\-I \-T\fP. +.RE +.sp +\fB\-V\fP, \fB\-\-version\fP +.RS 4 +Display version information and exit. +.RE +.sp +\fB\-h\fP, \fB\-\-help\fP +.RS 4 +Display help text and exit. +.RE +.SH "AUTHORS" +.sp +.MTO "kzak\(atredhat.com" "Karel Zak" "," +.MTO "lennart\(atpoettering.net" "Lennart Poettering" "" +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBwdctl\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/wipefs.8 b/upstream/opensuse-leap-15-6/man8/wipefs.8 new file mode 100644 index 00000000..8b479f15 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/wipefs.8 @@ -0,0 +1,166 @@ +'\" t +.\" Title: wipefs +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "WIPEFS" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +wipefs \- wipe a signature from a device +.SH "SYNOPSIS" +.sp +\fBwipefs\fP [options] \fIdevice\fP... +.sp +\fBwipefs\fP [\fB\-\-backup\fP] \fB\-o\fP \fIoffset device\fP... +.sp +\fBwipefs\fP [\fB\-\-backup\fP] \fB\-a\fP \fIdevice\fP... +.SH "DESCRIPTION" +.sp +\fBwipefs\fP can erase filesystem, raid or partition\-table signatures (magic strings) from the specified \fIdevice\fP to make the signatures invisible for libblkid. \fBwipefs\fP does not erase the filesystem itself nor any other data from the device. +.sp +When used without any options, \fBwipefs\fP lists all visible filesystems and the offsets of their basic signatures. The default output is subject to change. So whenever possible, you should avoid using default outputs in your scripts. Always explicitly define expected columns by using \fB\-\-output\fP \fIcolumns\-list\fP in environments where a stable output is required. +.sp +\fBwipefs\fP calls the BLKRRPART ioctl when it has erased a partition\-table signature to inform the kernel about the change. The ioctl is called as the last step and when all specified signatures from all specified devices are already erased. This feature can be used to wipe content on partitions devices as well as partition table on a disk device, for example by \fBwipefs \-a /dev/sdc1 /dev/sdc2 /dev/sdc\fP. +.sp +Note that some filesystems and some partition tables store more magic strings on the device (e.g., FAT, ZFS, GPT). The \fBwipefs\fP command (since v2.31) lists all the offset where a magic strings have been detected. +.sp +When option \fB\-a\fP is used, all magic strings that are visible for \fBlibblkid\fP(3) are erased. In this case the \fBwipefs\fP scans the device again after each modification (erase) until no magic string is found. +.sp +Note that by default \fBwipefs\fP does not erase nested partition tables on non\-whole disk devices. For this the option \fB\-\-force\fP is required. +.SH "OPTIONS" +.sp +\fB\-a\fP, \fB\-\-all\fP +.RS 4 +Erase all available signatures. The set of erased signatures can be restricted with the \fB\-t\fP option. +.RE +.sp +\fB\-b\fP, \fB\-\-backup\fP +.RS 4 +Create a signature backup to the file \fI$HOME/wipefs\-<devname>\-<offset>.bak\fP. For more details see the \fBEXAMPLE\fP section. +.RE +.sp +\fB\-f\fP, \fB\-\-force\fP +.RS 4 +Force erasure, even if the filesystem is mounted. This is required in order to erase a partition\-table signature on a block device. +.RE +.sp +\fB\-h\fP, \fB\-\-help\fP +.RS 4 +Display help text and exit. +.RE +.sp +\fB\-J\fP, \fB\-\-json\fP +.RS 4 +Use JSON output format. +.RE +.sp +\fB\-\-lock\fP[=\fImode\fP] +.RS 4 +Use exclusive BSD lock for device or file it operates. The optional argument \fImode\fP can be \fByes\fP, \fBno\fP (or 1 and 0) or \fBnonblock\fP. If the \fImode\fP argument is omitted, it defaults to \fB"yes"\fP. This option overwrites environment variable \fB$LOCK_BLOCK_DEVICE\fP. The default is not to use any lock at all, but it\(cqs recommended to avoid collisions with udevd or other tools. +.RE +.sp +\fB\-i\fP, \fB\-\-noheadings\fP +.RS 4 +Do not print a header line. +.RE +.sp +\fB\-O\fP, \fB\-\-output\fP \fIlist\fP +.RS 4 +Specify which output columns to print. Use \fB\-\-help\fP to get a list of all supported columns. +.RE +.sp +\fB\-n\fP, \fB\-\-no\-act\fP +.RS 4 +Causes everything to be done except for the \fBwrite\fP(2) call. +.RE +.sp +\fB\-o\fP, \fB\-\-offset\fP \fIoffset\fP +.RS 4 +Specify the location (in bytes) of the signature which should be erased from the device. The \fIoffset\fP number may include a "0x" prefix; then the number will be interpreted as a hex value. It is possible to specify multiple \fB\-o\fP options. +.sp +The \fIoffset\fP argument may be followed by the multiplicative suffixes KiB (=1024), MiB (=1024*1024), and so on for GiB, TiB, PiB, EiB, ZiB and YiB (the "iB" is optional, e.g., "K" has the same meaning as "KiB"), or the suffixes KB (=1000), MB (=1000*1000), and so on for GB, TB, PB, EB, ZB and YB. +.RE +.sp +\fB\-p\fP, \fB\-\-parsable\fP +.RS 4 +Print out in parsable instead of printable format. Encode all potentially unsafe characters of a string to the corresponding hex value prefixed by \(aq\(rsx\(aq. +.RE +.sp +\fB\-q\fP, \fB\-\-quiet\fP +.RS 4 +Suppress any messages after a successful signature wipe. +.RE +.sp +\fB\-t\fP, \fB\-\-types\fP \fIlist\fP +.RS 4 +Limit the set of printed or erased signatures. More than one type may be specified in a comma\-separated list. The list or individual types can be prefixed with \(aqno\(aq to specify the types on which no action should be taken. For more details see \fBmount\fP(8). +.RE +.sp +\fB\-V\fP, \fB\-\-version\fP +.RS 4 +Display version information and exit. +.RE +.SH "ENVIRONMENT" +.sp +LIBBLKID_DEBUG=all +.RS 4 +enables \fBlibblkid\fP(3) debug output. +.RE +.sp +LOCK_BLOCK_DEVICE=<mode> +.RS 4 +use exclusive BSD lock. The mode is "1" or "0". See \fB\-\-lock\fP for more details. +.RE +.SH "EXAMPLES" +.sp +\fBwipefs /dev/sda\fP* +.RS 4 +Prints information about sda and all partitions on sda. +.RE +.sp +\fBwipefs \-\-all \-\-backup /dev/sdb\fP +.RS 4 +Erases all signatures from the device \fI/dev/sdb\fP and creates a signature backup file \fI~/wipefs\-sdb\-<offset>.bak\fP for each signature. +.RE +.sp +\fBdd if=~/wipefs\-sdb\-0x00000438.bak of=/dev/sdb seek=$0x00000438 bs=1 conv=notrunc\fP +.RS 4 +Restores an ext2 signature from the backup file \fI~/wipefs\-sdb\-0x00000438.bak\fP. +.RE +.SH "AUTHORS" +.sp +.MTO "kzak\(atredhat.com" "Karel Zak" "" +.SH "SEE ALSO" +.sp +\fBblkid\fP(8), +\fBfindfs\fP(8) +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBwipefs\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file diff --git a/upstream/opensuse-leap-15-6/man8/xfs_admin.8 b/upstream/opensuse-leap-15-6/man8/xfs_admin.8 new file mode 100644 index 00000000..4794d677 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/xfs_admin.8 @@ -0,0 +1,199 @@ +.TH xfs_admin 8 +.SH NAME +xfs_admin \- change parameters of an XFS filesystem +.SH SYNOPSIS +.B xfs_admin +[ +.B \-eflpu +] [ +.BI \-O " featurelist" +] [ +.BR "\-c 0" | 1 +] [ +.B \-L +.I label +] [ +.B \-U +.I uuid +] [ +.B \-r +.I rtdev +] +.I device +[ +.I logdev +] +.br +.B xfs_admin \-V +.SH DESCRIPTION +.B xfs_admin +uses the +.BR xfs_db (8) +command to modify various parameters of a filesystem. +.PP +Devices that are mounted cannot be modified. +Administrators must unmount filesystems before +.BR xfs_admin " or " xfs_db (8) +can convert parameters. +A number of parameters of a mounted filesystem can be examined +and modified using the +.BR xfs_growfs (8) +command. +.PP +The optional +.B logdev +parameter specifies the device special file where the filesystem's external +log resides. +This is required only for filesystems that use an external log. +See the +.B mkfs.xfs \-l +option, and refer to +.BR xfs (5) +for a detailed description of the XFS log. +.SH OPTIONS +.TP +.B \-e +Enables unwritten extent support on a filesystem that does not +already have this enabled (for legacy filesystems, it can't be +disabled anymore at mkfs time). +.IP +This option only applies to the deprecated V4 format. +.TP +.B \-f +Specifies that the filesystem image to be processed is stored in a +regular file at +.I device +(see the +.B mkfs.xfs \-d +.I file +option). +.TP +.B \-j +Enables version 2 log format (journal format supporting larger +log buffers). +.IP +This option only applies to the deprecated V4 format. +.TP +.B \-l +Print the current filesystem label. +.TP +.B \-p +Enable 32bit project identifier support (PROJID32BIT feature). +.IP +This option only applies to the deprecated V4 format. +.TP +.B \-u +Print the current filesystem UUID (Universally Unique IDentifier). +.TP +.BR "\-c 0" | 1 +Enable (1) or disable (0) lazy-counters in the filesystem. +.IP +Lazy-counters may not be disabled on Version 5 superblock filesystems +(i.e. those with metadata CRCs enabled). +.IP +In other words, this option only applies to the deprecated V4 format. +.IP +This operation may take quite a bit of time on large filesystems as the +entire filesystem needs to be scanned when this option is changed. +.IP +With lazy-counters enabled, the superblock is not modified or logged on +every change of the free-space and inode counters. Instead, enough +information is kept in other parts of the filesystem to be able to +maintain the counter values without needing to keep them in the +superblock. This gives significant improvements in performance on some +configurations and metadata intensive workloads. +.TP +.BI \-L " label" +Set the filesystem label to +.IR label . +XFS filesystem labels can be at most 12 characters long; if +.I label +is longer than 12 characters, +.B xfs_admin +will truncate it and print a warning message. +The filesystem label can be cleared using the special "\c +.B \-\-\c +" value for +.IR label . +.TP +.BI \-O " feature1" = "status" , "feature2" = "status..." +Add or remove features on an existing V5 filesystem. +The features should be specified as a comma-separated list. +.I status +should be either 0 to disable the feature or 1 to enable the feature. +Note, however, that most features cannot be disabled. +.IP +.B NOTE: +Administrators must ensure the filesystem is clean by running +.B xfs_repair -n +to inspect the filesystem before performing the upgrade. +If corruption is found, recovery procedures (e.g. reformat followed by +restoration from backup; or running +.B xfs_repair +without the +.BR -n ) +must be followed to clean the filesystem. +.IP +Supported features are as follows: +.RS 0.7i +.TP 0.4i +.B inobtcount +Keep a count the number of blocks in each inode btree in the AGI. +This reduces mount time by speeding up metadata space reservation calculations. +The filesystem cannot be downgraded after this feature is enabled. +Once enabled, the filesystem will not be writable by older kernels. +This feature was added to Linux 5.10. +.TP 0.4i +.B bigtime +Upgrade a filesystem to support larger timestamps up to the year 2486. +The filesystem cannot be downgraded after this feature is enabled. +Once enabled, the filesystem will not be mountable by older kernels. +This feature was added to Linux 5.10. +.TP 0.4i +.B nrext64 +Upgrade a filesystem to support large per-inode extent counters. The maximum +data fork extent count will be 2^48 - 1, while the maximum attribute fork +extent count will be 2^32 - 1. The filesystem cannot be downgraded after this +feature is enabled. Once enabled, the filesystem will not be mountable by +older kernels. This feature was added to Linux 5.19. +.RE +.TP +.BI \-U " uuid" +Set the UUID of the filesystem to +.IR uuid . +A sample UUID looks like this: "c1b9d5a2-f162-11cf-9ece-0020afc76f16". +The +.I uuid +may also be +.BR nil , +which will set the filesystem UUID to the null UUID. +The +.I uuid +may also be +.BR generate , +which will generate a new UUID for the filesystem. Note that on CRC-enabled +filesystems, this will set an incompatible flag such that older kernels will +not be able to mount the filesystem. To remove this incompatible flag, use +.BR restore , +which will restore the original UUID and remove the incompatible +feature flag as needed. +.TP +.BI \-r " rtdev" +Specifies the device special file where the filesystem's realtime section +resides. +Only for those filesystems which use a realtime section. +.TP +.B \-V +Prints the version number and exits. +.PP +The +.BR mount (8) +manual entry describes how to mount a filesystem using its label or UUID, +rather than its block special device name. +.SH SEE ALSO +.BR mkfs.xfs (8), +.BR mount (8), +.BR xfs_db (8), +.BR xfs_growfs (8), +.BR xfs_repair (8), +.BR xfs (5). diff --git a/upstream/opensuse-leap-15-6/man8/xfs_bmap.8 b/upstream/opensuse-leap-15-6/man8/xfs_bmap.8 new file mode 100644 index 00000000..9ec7f52b --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/xfs_bmap.8 @@ -0,0 +1,101 @@ +.TH xfs_bmap 8 +.SH NAME +xfs_bmap \- print block mapping for an XFS file +.SH SYNOPSIS +.B xfs_bmap +[ +.B \-adelpv +] [ +.B \-n +.I num_extents +] +.I file +.br +.B xfs_bmap \-V +.SH DESCRIPTION +.B xfs_bmap +prints the map of disk blocks used by files in an XFS filesystem. +The map lists each +.I extent +used by the file, as well as regions +in the file that do not have any corresponding blocks (holes). +Each line of the listings takes the following form: +.PP +.RS +.IR extent ": [" startoffset .. endoffset "]: " startblock .. endblock +.RE +.PP +Holes are marked by replacing the +.IR startblock .. endblock " with " hole . +All the file offsets and disk blocks are in units of 512-byte blocks, +no matter what the filesystem's block size is. +.PP +.SH OPTIONS +.TP +.B \-a +If this option is specified, information about the file's +attribute fork is printed instead of the default data fork. +.TP +.B \-e +If this option is used, +.B xfs_bmap +obtains all delayed allocation extents, and does not flush dirty pages +to disk before querying extent data. With the +.B \-v +option, the +.I flags +column will show which extents have not yet been allocated. +.TP +.B \-l +If this option is used, then +.IP +.RS 1.2i +.RI < nblocks "> blocks" +.RE +.IP +will be appended to each line. +.I nblocks +is the length of the extent described on the line in units of 512-byte blocks. +.IP +This flag has no effect if the +.B \-v +option is used. +.TP +.BI \-n " num_extents" +If this option is given, +.B xfs_bmap +will display at most +.I num_extents +extents. In the absence of +.BR \-n ", " xfs_bmap +will display all extents in the file. +.TP +.B \-p +If this option is used, +.B xfs_bmap +obtains all unwritten (preallocated) extents that do not contain written +data. With the +.B \-v +option, the +.I flags +column will show which extents are preallocated/unwritten. +.TP +.B \-v +Shows verbose information. When this flag is specified, additional AG +specific information is appended to each line in the following form: +.IP +.RS 1.2i +.IR agno " (" startagoffset .. endagoffset ") " nblocks " " flags +.RE +.IP +A second +.B \-v +option will print out the +.I flags +legend. +.TP +.B \-V +Prints the version number and exits. +.SH SEE ALSO +.BR xfs_fsr (8), +.BR xfs (5). diff --git a/upstream/opensuse-leap-15-6/man8/xfs_copy.8 b/upstream/opensuse-leap-15-6/man8/xfs_copy.8 new file mode 100644 index 00000000..1eaf85d5 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/xfs_copy.8 @@ -0,0 +1,151 @@ +.TH xfs_copy 8 +.SH NAME +xfs_copy \- copy the contents of an XFS filesystem +.SH SYNOPSIS +.B xfs_copy +[ +.B \-bd +] [ +.B \-L +.I log +] +.I source target1 +[ +.I target2 +\&... ] +.br +.B xfs_copy \-V +.SH DESCRIPTION +.B xfs_copy +copies an XFS filesystem to one or more targets in parallel (see +.BR xfs (5)). +The first +.RI ( source ) +argument must be the pathname of the device or file containing the +XFS filesystem. The remaining arguments specify one or more +.I target +devices or file names. If the pathnames specify devices, a +copy of the source XFS filesystem is created on each device. The +.I target +can also be the name of a regular file, in which case an image of the +source XFS filesystem is created in that file. If the file does not exist, +.B xfs_copy +creates the file. The length of the resulting file is equal to the size +of the source filesystem. However, if the file is created on an XFS +filesystem, the file consumes roughly the amount of space actually +used in the source filesystem by the filesystem and the XFS log. +The space saving is because +.B xfs_copy +seeks over free blocks instead of copying them and the XFS filesystem +supports sparse files efficiently. +.PP +.B xfs_copy +should only be used to copy unmounted filesystems, read-only mounted +filesystems, or frozen filesystems (see +.BR xfs_freeze (8)). +Otherwise, the generated filesystem(s) would be inconsistent or corrupt. +.PP +.B xfs_copy +does not alter the source filesystem in any way. Each new (target) +filesystem is identical to the original filesystem except that new +filesystems each have a new unique filesystem identifier (UUID). +Therefore, if both the old and new filesystems will be used as +separate distinct filesystems, +.B xfs_copy +or +.BR xfsdump (8)/ xfsrestore (8) +should be used to generate the new filesystem(s) instead of +.BR dd (1) +or other programs that do block-by-block disk copying. +.PP +.B xfs_copy +uses synchronous writes to ensure that write errors are +detected. +.PP +.B xfs_copy +uses +.BR pthreads (7) +to perform simultaneous parallel writes. +.B xfs_copy +creates one additional thread for each target to be written. +All threads die if +.B xfs_copy +terminates or aborts. +.SH OPTIONS +.TP +.B \-d +Create a duplicate (true clone) filesystem. This should be done only +if the new filesystem will be used as a replacement for the original +filesystem (such as in the case of disk replacement). +.TP +.B \-b +The buffered option can be used to ensure direct IO is not attempted +to any of the target files. This is useful when the filesystem holding +the target file does not support direct IO. +.TP +.BI \-L " log" +Specifies the location of the +.I log +if the default location of +.I /var/tmp/xfs_copy.log.XXXXXX +is not desired. +.TP +.B \-V +Prints the version number and exits. +.SH DIAGNOSTICS +.B xfs_copy +reports errors to both +.B stderr +and in more detailed form to a generated log file whose name is of the form +.I /var/tmp/xfs_copy.log.XXXXXX +or a log file specified by the +.B \-L +option. If +.B xfs_copy +detects a write error on a target, the copy of that one target is aborted +and an error message is issued to both stderr and the log file, but +the rest of the copies continue. When +.B xfs_copy +terminates, all aborted targets are reported to both +.B stderr +and the log file. +.PP +If all targets abort or if there is an error reading the source filesystem, +.B xfs_copy +immediately aborts. +.PP +.B xfs_copy +returns an exit code of 0 if all targets are successfully +copied and an exit code of 1 if any target fails. +.SH NOTES +When moving filesystems from one disk to another, if the original +filesystem is significantly smaller than the new filesystem, and will +be made larger, we recommend that +.BR mkfs.xfs "(8) and " xfsdump (8)/ xfsrestore (8) +be used instead of using +.B xfs_copy +and +.BR xfs_growfs (8). +The filesystem layout resulting from using +.BR xfs_copy / xfs_growfs +is almost always worse than the result of using +.BR mkfs.xfs / xfsdump / xfsrestore +but in the case of small filesystems, the differences can have a +significant performance impact. This is due to the way +.BR xfs_growfs (8) +works, and not due to any shortcoming in +.B xfs_copy +itself. +.SH CAVEATS +.B xfs_copy +does not copy XFS filesystems that have a real-time section +or XFS filesystems with external logs. In both cases, +.B xfs_copy +aborts with an error message. +.SH SEE ALSO +.BR mkfs.xfs (8), +.BR xfsdump (8), +.BR xfsrestore (8), +.BR xfs_freeze (8), +.BR xfs_growfs (8), +.BR xfs (5). diff --git a/upstream/opensuse-leap-15-6/man8/xfs_db.8 b/upstream/opensuse-leap-15-6/man8/xfs_db.8 new file mode 100644 index 00000000..f53ddd67 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/xfs_db.8 @@ -0,0 +1,2402 @@ +.TH xfs_db 8 +.SH NAME +xfs_db \- debug an XFS filesystem +.SH SYNOPSIS +.B xfs_db +[ +.B \-c +.I cmd +] ... [ +.BR \-i | r | x | F +] [ +.B \-f +] [ +.B \-l +.I logdev +] [ +.B \-p +.I progname +] +.I device +.br +.B xfs_db \-V +.SH DESCRIPTION +.B xfs_db +is used to examine an XFS filesystem. Under rare circumstances it can also +be used to modify an XFS filesystem, but that task is normally left to +.BR xfs_repair (8) +or to scripts such as +.BR xfs_admin (8) +that run +.BR xfs_db . +.PP +.SH OPTIONS +.TP +.BI \-c " cmd" +.B xfs_db +commands may be run interactively (the default) or as arguments +on the command line. Multiple +.B \-c +arguments may be given. The commands are run in the sequence given, +then the program exits. +.TP +.B \-f +Specifies that the filesystem image to be processed is stored in a +regular file at +.I device +(see the +.BR mkfs.xfs "(8) " -d +.I file +option). +This might happen if an image copy of a filesystem has been made into +an ordinary file with +.BR xfs_copy (8). +.TP +.B \-F +Specifies that we want to continue even if the superblock magic is not +correct. For use in +.BR xfs_metadump . +.TP +.B \-i +Allows execution on a mounted filesystem, provided it is mounted read-only. +Useful for shell scripts +which must only operate on filesystems in a guaranteed consistent state +(either unmounted or mounted read-only). These semantics are slightly +different to that of the +.B -r +option. +.TP +.BI \-l " logdev" +Specifies the device where the filesystems external log resides. +Only for those filesystems which use an external log. See the +.BR mkfs.xfs "(8) " \-l +option, and refer to +.BR xfs (5) +for a detailed description of the XFS log. +.TP +.BI \-p " progname" +Set the program name to +.I progname +for prompts and some error messages, the default value is +.BR xfs_db . +.TP +.B -r +Open +.I device +or +.I filename +read-only. This option is required if the filesystem is mounted. +It is only necessary to omit this flag if a command that changes data +.RB ( write ", " blocktrash ", " crc ) +is to be used. +.TP +.B \-x +Specifies expert mode. +This enables the +.RB ( write ", " blocktrash ", " crc +invalidate/revalidate) commands. +.TP +.B \-V +Prints the version number and exits. +.SH CONCEPTS +.B xfs_db +commands can be broken up into two classes. Most commands are for +the navigation and display of data structures in the filesystem. +Other commands are for scanning the filesystem in some way. +.PP +Commands which are used to navigate the filesystem structure take arguments +which reflect the names of filesystem structure fields. +There can be multiple field names separated by dots when the underlying +structures are nested, as in C. +The field names can be indexed (as an array index) +if the underlying field is an array. +The array indices can be specified as a range, two numbers separated by a dash. +.PP +.B xfs_db +maintains a current address in the filesystem. +The granularity of the address is a filesystem structure. +This can be a filesystem block, +an inode or quota (smaller than a filesystem block), +or a directory block (could be larger than a filesystem block). +There are a variety of commands to set the current address. +Associated with the current address is the current data type, +which is the structural type of this data. +Commands which follow the structure of the filesystem always set the type +as well as the address. +Commands which examine pieces of an individual file (inode) need the current +inode to be set, this is done with the +.B inode +command. +.PP +The current address/type information is actually maintained in a +stack that can be explicitly manipulated with the +.BR push ", " pop ", and " stack +commands. +This allows for easy examination of a nested filesystem structure. +Also, the last several locations visited are stored in a ring buffer +which can be manipulated with the +.BR forward ", " back ", and " ring +commands. +.PP +XFS filesystems are divided into a small number of allocation groups. +.B xfs_db +maintains a notion of the current allocation group which is +manipulated by some commands. The initial allocation group is 0. +.SH COMMANDS +.PP +Many commands have extensive online help. Use the +.B help +command for more details on any command. +.TP +.B a +See the +.B addr +command. +.TP +.BI ablock " filoff" +Set current address to the offset +.I filoff +(a filesystem block number) in the attribute area of the current inode. +.TP +.BI "addr [" field-expression ] +Set current address to the value of the +.IR field-expression . +This is used to "follow" a reference in one structure to the object +being referred to. If no argument is given, the current address is printed. +.TP +.BI "agf [" agno ] +Set current address to the AGF block for allocation group +.IR agno . +If no argument is given, use the current allocation group. +.TP +.BI "agfl [" agno ] +Set current address to the AGFL block for allocation group +.IR agno . +If no argument is given, use the current allocation group. +.TP +.BI "agi [" agno ] +Set current address to the AGI block for allocation group +.IR agno . +If no argument is given, use the current allocation group. +.TP +.BI "agresv [" agno ] +Displays the length, free block count, per-AG reservation size, and per-AG +reservation usage for a given AG. +If no argument is given, display information for all AGs. +.TP +.BI "attr_remove [\-r|\-u|\-s] [\-n] " name +Remove the specified extended attribute from the current file. +.RS 1.0i +.TP 0.4i +.B \-r +Sets the attribute in the root namespace. +Only one namespace option can be specified. +.TP +.B \-u +Sets the attribute in the user namespace. +Only one namespace option can be specified. +.TP +.B \-s +Sets the attribute in the secure namespace. +Only one namespace option can be specified. +.TP +.B \-n +Do not enable 'noattr2' mode on V4 filesystems. +.RE +.TP +.BI "attr_set [\-r|\-u|\-s] [\-n] [\-R|\-C] [\-v " namelen "] " name +Sets an extended attribute on the current file with the given name. +.RS 1.0i +.TP 0.4i +.B \-r +Sets the attribute in the root namespace. +Only one namespace option can be specified. +.TP +.B \-u +Sets the attribute in the user namespace. +Only one namespace option can be specified. +.TP +.B \-s +Sets the attribute in the secure namespace. +Only one namespace option can be specified. +.TP +.B \-n +Do not enable 'noattr2' mode on V4 filesystems. +.TP +.B \-R +Replace the attribute. +The command will fail if the attribute does not already exist. +.TP +.B \-C +Create the attribute. +The command will fail if the attribute already exists. +.TP +.B \-v +Set the attribute value to a string of this length containing the letter 'v'. +.RE +.TP +.B b +See the +.B back +command. +.TP +.B back +Move to the previous location in the position ring. +.TP +.B blockfree +Free block usage information collected by the last execution of the +.B blockget +command. This must be done before another +.B blockget +command can be given, presumably with different arguments than the previous one. +.TP +.BI "blockget [\-npvs] [\-b " bno "] ... [\-i " ino "] ..." +Get block usage and check filesystem consistency. +The information is saved for use by a subsequent +.BR blockuse ", " ncheck ", or " blocktrash +command. +.RS 1.0i +.TP 0.4i +.B \-b +is used to specify filesystem block numbers about which verbose +information should be printed. +.TP +.B \-i +is used to specify inode numbers about which verbose information +should be printed. +.TP +.B \-n +is used to save pathnames for inodes visited, this is used to support the +.BR xfs_ncheck (8) +command. It also means that pathnames will be printed for inodes that have +problems. This option uses a lot of memory so is not enabled by default. +.TP +.B \-p +causes error messages to be prefixed with the filesystem name being +processed. This is useful if several copies of +.B xfs_db +are run in parallel. +.TP +.B \-s +restricts output to severe errors only. This is useful if the output is +too long otherwise. +.TP +.B \-v +enables verbose output. Messages will be printed for every block and +inode processed. +.RE +.TP +.BI "blocktrash [-z] [\-o " offset "] [\-n " count "] [\-x " min "] [\-y " max "] [\-s " seed "] [\-0|1|2|3] [\-t " type "] ..." +Trash randomly selected filesystem metadata blocks. +Trashing occurs to randomly selected bits in the chosen blocks. +This command is available only in debugging versions of +.BR xfs_db . +It is useful for testing +.BR xfs_repair "(8). +.RS 1.0i +.TP 0.4i +.BR \-0 " | " -1 " | " -2 " | " -3 +These are used to set the operating mode for +.BR blocktrash . +Only one can be used: +.B \-0 +changed bits are cleared; +.B \-1 +changed bits are set; +.B -2 +changed bits are inverted; +.B -3 +changed bits are randomized. +.TP +.B \-n +supplies the +.I count +of block-trashings to perform (default 1). +.TP +.B \-o +supplies the bit +.I offset +at which to start trashing the block. If the value is preceded by a '+', the +trashing will start at a randomly chosen offset that is larger than the value +supplied. The default is to randomly choose an offset anywhere in the block. +.TP +.B \-s +supplies a +.I seed +to the random processing. +.TP +.B \-t +gives a +.I type +of blocks to be selected for trashing. Multiple +.B \-t +options may be given. If no +.B \-t +options are given then all metadata types can be trashed. +.TP +.B \-x +sets the +.I minimum +size of bit range to be trashed. The default value is 1. +.TP +.B \-y +sets the +.I maximum +size of bit range to be trashed. The default value is 1024. +.TP +.B \-z +trashes the block at the top of the stack. It is not necessary to +run +.BI blockget +if this option is supplied. +.RE +.TP +.BI "blockuse [\-n] [\-c " count ] +Print usage for current filesystem block(s). +For each block, the type and (if any) inode are printed. +.RS 1.0i +.TP 0.4i +.B \-c +specifies a +.I count +of blocks to process. The default value is 1 (the current block only). +.TP +.B \-n +specifies that file names should be printed. The prior +.B blockget +command must have also specified the +.B \-n +option. +.RE +.TP +.BI "bmap [\-a] [\-d] [" block " [" len ]] +Show the block map for the current inode. +The map display can be restricted to an area of the file with the +.I block +and +.I len +arguments. If +.I block +is given and +.I len +is omitted then 1 is assumed for len. +.IP +The +.B \-a +and +.B \-d +options are used to select the attribute or data +area of the inode, if neither option is given then both areas are shown. +.TP +.B btdump [-a] [-i] +If the cursor points to a btree node, dump the btree from that block downward. +If instead the cursor points to an inode, dump the data fork block mapping btree if there is one. +If the cursor points to a directory or extended attribute btree node, dump that. +By default, only records stored in the btree are dumped. +.RS 1.0i +.TP 0.4i +.B \-a +If the cursor points at an inode, dump the extended attribute block mapping btree, if present. +.TP +.B \-i +Dump all keys and pointers in intermediate btree nodes, and all records in leaf btree nodes. +.RE +.TP +.BI "btheight [\-b " blksz "] [\-n " recs "] [\-w " max "|" min "|" absmax "] btree types..." +For a given number of btree records and a btree type, report the number of +records and blocks for each level of the btree, and the total number of blocks. +The btree type must be given after the options. + +A raw btree geometry can be provided in the format +"record_bytes:key_bytes:ptr_bytes:header_type", where header_type is one of +"short", "long", "shortcrc", or "longcrc". + +The supported btree types are: +.IR bnobt , +.IR cntbt , +.IR inobt , +.IR finobt , +.IR bmapbt , +.IR refcountbt , +and +.IR rmapbt . +The magic value +.I all +can be used to walk through all btree types. + +Options are as follows: +.RS 1.0i +.TP 0.4i +.B \-b +is used to override the btree block size. +The default is the filesystem block size. +.TP +.B \-n +is used to specify the number of records to store. +This argument is required. +.TP +.B \-w absmax +shows the maximum possible height for the given btree types. +.TP +.B \-w max +shows only the best case scenario, which is when the btree blocks are +maximally loaded. +.TP +.B \-w min +shows only the worst case scenario, which is when the btree blocks are +half full. +.RE +.TP +.B check +See the +.B blockget +command. +.TP +.BI "convert " "type number" " [" "type number" "] ... " type +Convert from one address form to another. +The known +.IR type s, +with alternate names, are: +.RS 1.0i +.PD 0 +.HP +.B agblock +or +.B agbno +(filesystem block within an allocation group) +.HP +.B agino +or +.B aginode +(inode number within an allocation group) +.HP +.B agnumber +or +.B agno +(allocation group number) +.HP +.B bboff +or +.B daddroff +(byte offset in a +.BR daddr ) +.HP +.B blkoff +or +.B fsboff or +.B agboff +(byte offset in a +.B agblock +or +.BR fsblock ) +.HP +.B byte +or +.B fsbyte +(byte address in filesystem) +.HP +.B daddr +or +.B bb +(disk address, 512-byte blocks) +.HP +.B fsblock +or +.B fsb +or +.B fsbno +(filesystem block, see the +.B fsblock +command) +.HP +.B ino +or +.B inode +(inode number) +.HP +.B inoidx +or +.B offset +(index of inode in filesystem block) +.HP +.B inooff +or +.B inodeoff +(byte offset in inode) +.PD +.RE +.IP +Only conversions that "make sense" are allowed. +The compound form (with more than three arguments) is useful for +conversions such as +.B convert agno +.I ag +.B agbno +.I agb +.BR fsblock . +.TP +.B crc [\-i|\-r|\-v] +Invalidates, revalidates, or validates the CRC (checksum) +field of the current structure, if it has one. +This command is available only on CRC-enabled filesystems. +With no argument, validation is performed. +Each command will display the resulting CRC value and state. +.RS 1.0i +.TP 0.4i +.B \-i +Invalidate the structure's CRC value (incrementing it by one), +and write it to disk. +.TP +.B \-r +Recalculate the current structure's correct CRC value, and write it to disk. +.TP +.B \-v +Validate and display the current value and state of the structure's CRC. +.RE +.TP +.BI "daddr [" d ] +Set current address to the daddr (512 byte block) given by +.IR d . +If no value for +.I d +is given, the current address is printed, expressed as a daddr. +The type is set to +.B data +(uninterpreted). +.TP +.BI dblock " filoff" +Set current address to the offset +.I filoff +(a filesystem block number) in the data area of the current inode. +.TP +.BI "debug [" flagbits ] +Set debug option bits. These are used for debugging +.BR xfs_db . +If no value is given for +.IR flagbits , +print the current debug option bits. These are for the use of the implementor. +.TP +.BI "dquot [" \-g | \-p | \-u ] " id" +Set current address to a group, project or user quota block for the given ID. Defaults to user quota. +.TP +.BI "dump_iunlinked [-a " agno " ] [-b " bucket " ] [-q] [-v]" +Dump the contents of unlinked buckets. + +Options include: +.RS 1.0i +.TP 0.4i +.B \-a +Print only this AG's unlinked buckets. +.TP 0.4i +.B \-b +Print only this bucket within each AGI. +.TP 0.4i +.B \-q +Only print the essentials. +.TP 0.4i +.B \-v +Print resource usage of each file on the unlinked lists. +.RE +.TP +.BI "echo [" arg "] ..." +Echo the arguments to the output. +.TP +.B f +See the +.B forward +command. +.TP +.B forward +Move forward to the next entry in the position ring. +.TP +.B frag [\-adflqRrv] +Get file fragmentation data. This prints information about fragmentation +of file data in the filesystem (as opposed to fragmentation of freespace, +for which see the +.B freesp +command). Every file in the filesystem is examined to see how far from ideal +its extent mappings are. A summary is printed giving the totals. +.RS 1.0i +.TP 0.4i +.B \-v +sets verbosity, every inode has information printed for it. +The remaining options select which inodes and extents are examined. +If no options are given then all are assumed set, +otherwise just those given are enabled. +.TP +.B \-a +enables processing of attribute data. +.TP +.B \-d +enables processing of directory data. +.TP +.B \-f +enables processing of regular file data. +.TP +.B \-l +enables processing of symbolic link data. +.TP +.B \-q +enables processing of quota file data. +.TP +.B \-R +enables processing of realtime control file data. +.TP +.B \-r +enables processing of realtime file data. +.RE +.TP +.BI "freesp [\-bcds] [\-A " alignment "] [\-a " ag "] ... [\-e " i "] [\-h " h1 "] ... [\-m " m ] +Summarize free space for the filesystem. The free blocks are examined +and totalled, and displayed in the form of a histogram, with a count +of extents in each range of free extent sizes. +.RS 1.0i +.TP 0.4i +.B \-A +reports only free extents with starting blocks aligned to +.I alignment +blocks. +.TP +.B \-a +adds +.I ag +to the list of allocation groups to be processed. If no +.B \-a +options are given then all allocation groups are processed. +.TP +.B \-b +specifies that the histogram buckets are binary-sized, with the starting +sizes being the powers of 2. +.TP +.B \-c +specifies that +.B freesp +will search the by-size (cnt) space Btree instead of the default +by-block (bno) space Btree. +.TP +.B \-d +specifies that every free extent will be displayed. +.TP +.B \-e +specifies that the histogram buckets are +equal-sized, with the size specified as +.IR i . +.TP +.B \-h +specifies a starting block number for a histogram bucket as +.IR h1 . +Multiple +.BR \-h 's +are given to specify the complete set of buckets. +.TP +.B \-m +specifies that the histogram starting block numbers are powers of +.IR m . +This is the general case of +.BR \-b . +.TP +.B \-s +specifies that a final summary of total free extents, +free blocks, and the average free extent size is printed. +.RE +.TP +.B fsb +See the +.B fsblock +command. +.TP +.BI "fsblock [" fsb ] +Set current address to the fsblock value given by +.IR fsb . +If no value for +.I fsb +is given the current address is printed, expressed as an fsb. +The type is set to +.B data +(uninterpreted). XFS filesystem block numbers are computed +.RI (( agno " << " agshift ") | " agblock ) +where +.I agshift +depends on the size of an allocation group. Use the +.B convert +command to convert to and from this form. Block numbers given for file blocks +(for instance from the +.B bmap +command) are in this form. +.TP +.BI "fsmap [ " start " ] [ " end " ] +Prints the mapping of disk blocks used by an XFS filesystem. The map +lists each extent used by files, allocation group metadata, +journalling logs, and static filesystem metadata, as well as any +regions that are unused. All blocks, offsets, and lengths are specified +in units of 512-byte blocks, no matter what the filesystem's block size is. +.BI "The optional " start " and " end " arguments can be used to constrain +the output to a particular range of disk blocks. +.TP +.BI "fuzz [\-c] [\-d] " "field action" +Write garbage into a specific structure field on disk. +Expert mode must be enabled to use this command. +The operation happens immediately; there is no buffering. +.IP +The fuzz command can take the following +.IR action "s" +against a field: +.RS 1.0i +.TP 0.4i +.B zeroes +Clears all bits in the field. +.TP 0.4i +.B ones +Sets all bits in the field. +.TP 0.4i +.B firstbit +Flips the first bit in the field. +For a scalar value, this is the highest bit. +.TP 0.4i +.B middlebit +Flips the middle bit in the field. +.TP 0.4i +.B lastbit +Flips the last bit in the field. +For a scalar value, this is the lowest bit. +.TP 0.4i +.B add +Adds a small value to a scalar field. +.TP 0.4i +.B sub +Subtracts a small value from a scalar field. +.TP 0.4i +.B random +Randomizes the contents of the field. +.RE +.IP +The following switches affect the write behavior: +.RS 1.0i +.TP 0.4i +.B \-c +Skip write verifiers and CRC recalculation; allows invalid data to be written +to disk. +.TP 0.4i +.B \-d +Skip write verifiers but perform CRC recalculation; allows invalid data to be +written to disk to test detection of invalid data. +.RE +.TP +.BI hash [-d]" strings +Prints the hash value of +.I string +using the hash function of the XFS directory and attribute implementation. + +If the +.B \-d +option is specified, the directory-specific hash function is used. +This only makes a difference on filesystems with ascii case-insensitive +lookups enabled. +.TP +.BI "hashcoll [-a] [-s seed] [-n " nr "] [-p " path "] -i | " names... +Create directory entries or extended attributes names that all have the same +hash value. +The metadump name obfuscation algorithm is used here. +Names are written to standard output, with a NULL between each name for use +with xargs -0. +.RS 1.0i +.PD 0 +.TP 0.4i +.TP 0.4i +.B \-a +Create extended attribute names. +.TP 0.4i +.B \-i +Read the first name to create from standard input. +Up to 255 bytes are read. +If this option is not specified, first names are taken from the command line. +.TP 0.4i +.BI \-n " nr" +Create this many duplicated names. +The default is to create one name. +.TP 0.4i +.BI \-p " path" +Create directory entries or extended attributes in this file instead of +writing the names to standard output. +.TP 0.4i +.BI \-s " seed" +Seed the random number generator with this value. +.PD +.RE +.TP +.BI "help [" command ] +Print help for one or all commands. +.TP +.B info +Displays selected geometry information about the filesystem. +The output will have the same format that +.BR "mkfs.xfs" "(8)" +prints when creating a filesystem or +.BR "xfs_info" "(8)" +prints when querying a filesystem. +.TP +.BI "inode [" inode# ] +Set the current inode number. If no +.I inode# +is given, print the current inode number. +.TP +.BI "iunlink [-n " nr " ]" +Allocate inodes and put them on the unlinked list. + +Options include: +.RS 1.0i +.TP 0.4i +.B \-n +Create this number of unlinked inodes. +If not specified, 1 inode will be created. +.RE +.TP +.BI "label [" label ] +Set the filesystem label. The filesystem label can be used by +.BR mount (8) +instead of using a device special file. +The maximum length of an XFS label is 12 characters \- use of a longer +.I label +will result in truncation and a warning will be issued. If no +.I label +is given, the current filesystem label is printed. +.TP +.BI "log [stop | start " filename ] +Start logging output to +.IR filename , +stop logging, or print the current logging status. +.TP +.BI "logformat [\-c " cycle "] [\-s " sunit "]" +Reformats the log to the specified log cycle and log stripe unit. +This has the effect of clearing the log destructively. +If the log cycle is not specified, the log is reformatted to the current cycle. +If the log stripe unit is not specified, the stripe unit from the filesystem +superblock is used. +.TP +.B logres +Print transaction reservation size information for each transaction type. +This makes it easier to find discrepancies in the reservation calculations +between xfsprogs and the kernel, which will help when diagnosing minimum +log size calculation errors. +.TP +.BI "ls [\-i] [" paths "]..." +List the contents of a directory. +If a path resolves to a directory, the directory will be listed. +If no paths are supplied and the IO cursor points at a directory inode, +the contents of that directory will be listed. + +The output format is: +directory cookie, inode number, file type, hash, name length, name. +.RS 1.0i +.TP 0.4i +.B \-i +Resolve each of the given paths to an inode number and print that number. +If no paths are given and the IO cursor points to an inode, print the inode +number. +.RE +.TP +.BI "metadump [\-egow] " filename +Dumps metadata to a file. See +.BR xfs_metadump (8) +for more information. +.TP +.BI "ncheck [\-s] [\-i " ino "] ..." +Print name-inode pairs. A +.B blockget \-n +command must be run first to gather the information. +.RS 1.0i +.TP 0.4i +.B \-i +specifies an inode number to be printed. If no +.B \-i +options are given then all inodes are printed. +.TP +.B \-s +specifies that only setuid and setgid files are printed. +.RE +.TP +.B p +See the +.B print +command. +.TP +.BI "path " dir_path +Walk the directory tree to an inode using the supplied path. +Absolute and relative paths are supported. +.TP +.B pop +Pop location from the stack. +.TP +.BI "print [" field-expression "] ..." +Print field values. +If no argument is given, print all fields in the current structure. +.TP +.BI "push [" command ] +Push location to the stack. If +.I command +is supplied, set the current location to the results of +.I command +after pushing the old location. +.TP +.B q +See the +.B quit +command. +.TP +.B quit +Exit +.BR xfs_db . +.TP +.BI "ring [" index ] +Show position ring (if no +.I index +argument is given), or move to a specific entry in the position ring given by +.IR index . +.TP +.BI "sb [" agno ] +Set current address to SB header in allocation group +.IR agno . +If no +.I agno +is given, use the current allocation group number. +.TP +.BI "source " source-file +Process commands from +.IR source-file . +.B source +commands can be nested. +.TP +.B stack +View the location stack. +.TP +.BI "type [" type ] +Set the current data type to +.IR type . +If no argument is given, show the current data type. +The possible data types are: +.BR agf ", " agfl ", " agi ", " attr ", " bmapbta ", " bmapbtd , +.BR bnobt ", " cntbt ", " data ", " dir ", " dir2 ", " dqblk , +.BR inobt ", " inode ", " log ", " refcntbt ", " rmapbt ", " rtbitmap , +.BR rtsummary ", " sb ", " symlink " and " text . +See the TYPES section below for more information on these data types. +.TP +.BI "timelimit [" OPTIONS ] +Print the minimum and maximum supported values for inode timestamps, +quota expiration timers, and quota grace periods supported by this +filesystem. +Options include: +.RS 1.0i +.TP 0.4i +.B \--bigtime +Print the time limits of an XFS filesystem with the +.B bigtime +feature enabled. +.TP 0.4i +.B \--classic +Print the time limits of a classic XFS filesystem. +.TP 0.4i +.B \--compact +Print all limits as raw values on a single line. +.TP 0.4i +.B \--pretty +Print the timestamps in the current locale's date and time format instead of +raw seconds since the Unix epoch. +.RE +.TP +.BI "uuid [" uuid " | " generate " | " rewrite " | " restore ] +Set the filesystem universally unique identifier (UUID). +The filesystem UUID can be used by +.BR mount (8) +instead of using a device special file. +The +.I uuid +can be set directly to the desired UUID, or it can +be automatically generated using the +.B generate +option. These options will both write the UUID into every copy of the +superblock in the filesystem. On a CRC-enabled filesystem, this will +set an incompatible superblock flag, and the filesystem will not be +mountable with older kernels. This can be reverted with the +.B restore +option, which will copy the original UUID back into place and clear +the incompatible flag as needed. +.B rewrite +copies the current UUID from the primary superblock +to all secondary copies of the superblock. +If no argument is given, the current filesystem UUID is printed. +.TP +.BI "version [" feature " | " "versionnum features2" ] +Enable selected features for a filesystem (certain features can +be enabled on an unmounted filesystem, after +.BR mkfs.xfs (8) +has created the filesystem). +Support for unwritten extents can be enabled using the +.B extflg +option. Support for version 2 log format can be enabled using the +.B log2 +option. Support for extended attributes can be enabled using the +.B attr1 +or +.B attr2 +option. Once enabled, extended attributes cannot be disabled, but the user +may toggle between +.B attr1 +and +.B attr2 +at will (older kernels may not support the newer version). +.IP +If no argument is given, the current version and feature bits are printed. +With one argument, this command will write the updated version number +into every copy of the superblock in the filesystem. +If two arguments are given, they will be used as numeric values for the +.I versionnum +and +.I features2 +bits respectively, and their string equivalent reported +(but no modifications are made). +.TP +.BI "write [\-c|\-d] [" "field value" "] ..." +Write a value to disk. +Specific fields can be set in structures (struct mode), +or a block can be set to data values (data mode), +or a block can be set to string values (string mode, for symlink blocks). +The operation happens immediately: there is no buffering. +.IP +Struct mode is in effect when the current type is structural, +i.e. not data. For struct mode, the syntax is "\c +.B write +.I field value\c +". +.IP +Data mode is in effect when the current type is data. In this case the +contents of the block can be shifted or rotated left or right, or filled +with a sequence, a constant value, or a random value. In this mode +.B write +with no arguments gives more information on the allowed commands. +.RS 1.0i +.TP 0.4i +.B \-c +Skip write verifiers and CRC recalculation; allows invalid data to be written +to disk. +.TP 0.4i +.B \-d +Skip write verifiers but perform CRC recalculation. +This allows invalid data to be written to disk to +test detection of invalid data. (This is not possible for some types.) +.RE +.SH TYPES +This section gives the fields in each structure type and their meanings. +Note that some types of block cover multiple actual structures, +for instance directory blocks. +.TP 1.0i +.B agf +The AGF block is the header for block allocation information; +it is in the second 512-byte block of each allocation group. +The following fields are defined: +.RS 1.4i +.PD 0 +.TP 1.2i +.B magicnum +AGF block magic number, 0x58414746 ('XAGF'). +.TP +.B versionnum +version number, currently 1. +.TP +.B seqno +sequence number starting from 0. +.TP +.B length +size in filesystem blocks of the allocation group. All allocation +groups except the last one of the filesystem have the superblock's +.B agblocks +value here. +.TP +.B bnoroot +block number of the root of the Btree holding free space +information sorted by block number. +.TP +.B cntroot +block number of the root of the Btree holding free space +information sorted by block count. +.TP +.B bnolevel +number of levels in the by-block-number Btree. +.TP +.B cntlevel +number of levels in the by-block-count Btree. +.TP +.B flfirst +index into the AGFL block of the first active entry. +.TP +.B fllast +index into the AGFL block of the last active entry. +.TP +.B flcount +count of active entries in the AGFL block. +.TP +.B freeblks +count of blocks represented in the freespace Btrees. +.TP +.B longest +longest free space represented in the freespace Btrees. +.TP +.B btreeblks +number of blocks held in the AGF Btrees. +.PD +.RE +.TP +.B agfl +The AGFL block contains block numbers for use of the block allocator; +it is in the fourth 512-byte block of each allocation group. +Each entry in the active list is a block number within the allocation group +that can be used for any purpose if space runs low. +The AGF block fields +.BR flfirst ", " fllast ", and " flcount +designate which entries are currently active. +Entry space is allocated in a circular manner within the AGFL block. +Fields defined: +.RS 1.4i +.PD 0 +.TP 1.2i +.B bno +array of all block numbers. Even those which are not active are printed. +.PD +.RE +.TP +.B agi +The AGI block is the header for inode allocation information; +it is in the third 512-byte block of each allocation group. +Fields defined: +.RS 1.4i +.PD 0 +.TP 1.2i +.B magicnum +AGI block magic number, 0x58414749 ('XAGI'). +.TP +.B versionnum +version number, currently 1. +.TP +.B seqno +sequence number starting from 0. +.TP +.B length +size in filesystem blocks of the allocation group. +.TP +.B count +count of inodes allocated. +.TP +.B root +block number of the root of the Btree holding inode allocation information. +.TP +.B level +number of levels in the inode allocation Btree. +.TP +.B freecount +count of allocated inodes that are not in use. +.TP +.B newino +last inode number allocated. +.TP +.B dirino +unused. +.TP +.B unlinked +an array of inode numbers within the allocation group. The entries +in the AGI block are the heads of lists which run through the inode +.B next_unlinked +field. These inodes are to be unlinked the next time the filesystem is mounted. +.PD +.RE +.TP +.B attr +An attribute fork is organized as a Btree with the actual data embedded +in the leaf blocks. The root of the Btree is found in block 0 of the fork. +The index (sort order) of the Btree is the hash value of the attribute name. +All the blocks contain a +.B blkinfo +structure at the beginning, see type +.B dir +for a description. Nonleaf blocks are identical in format to those for +version 1 and version 2 directories, see type +.B dir +for a description. Leaf blocks can refer to "local" or "remote" attribute +values. Local values are stored directly in the leaf block. +Leaf blocks contain the following fields: +.RS 1.4i +.PD 0 +.TP 1.2i +.B hdr +header containing a +.B blkinfo +structure +.B info +(magic number 0xfbee), a +.B count +of active entries, +.B usedbytes +total bytes of names and values, the +.B firstused +byte in the name area, +.B holes +set if the block needs compaction, and array +.B freemap +as for +.B dir +leaf blocks. +.TP +.B entries +array of structures containing a +.BR hashval , +.B nameidx +(index into the block of the name), and flags +.BR incomplete , +.BR root , +and +.BR local . +.TP +.B nvlist +array of structures describing the attribute names and values. Fields +always present: +.B valuelen +(length of value in bytes), +.BR namelen , +and +.BR name . +Fields present for local values: +.B value +(value string). Fields present for remote values: +.B valueblk +(fork block number of containing the value). +.PD +.RE +.IP +Remote values are stored in an independent block in the attribute fork. +Prior to v5, value blocks had no structure, but in v5 they acquired a header +structure with the following fields: +.RS 1.4i +.PD 0 +.TP 1.2i +.B magic +attr3 remote block magic number, 0x5841524d ('XARM'). +.TP +.B offset +Byte offset of this data block within the overall attribute value. +.TP +.B bytes +Number of bytes stored in this block. +.TP +.B crc +Checksum of the attribute block contents. +.TP +.B uuid +Filesystem UUID. +.TP +.B owner +Inode that owns this attribute value. +.TP +.B bno +Block offset of this block within the inode's attribute fork. +.TP +.B lsn +Log serial number of the last time this block was logged. +.TP +.B data +The attribute value data. +.PD +.RE +.TP +.B bmapbt +Files with many extents in their data or attribute fork will have the +extents described by the contents of a Btree for that fork, +instead of being stored directly in the inode. +Each bmap Btree starts with a root block contained within the inode. +The other levels of the Btree are stored in filesystem blocks. +The blocks are linked to sibling left and right blocks at each level, +as well as by pointers from parent to child blocks. +Each block contains the following fields: +.RS 1.4i +.PD 0 +.TP 1.2i +.B magic +bmap Btree block magic number, 0x424d4150 ('BMAP'). +.TP +.B level +level of this block above the leaf level. +.TP +.B numrecs +number of records or keys in the block. +.TP +.B leftsib +left (logically lower) sibling block, 0 if none. +.TP +.B rightsib +right (logically higher) sibling block, 0 if none. +.TP +.B recs +[leaf blocks only] array of extent records. +Each record contains +.BR startoff , +.BR startblock , +.BR blockcount , +and +.B extentflag +(1 if the extent is unwritten). +.TP +.B keys +[non-leaf blocks only] array of key records. These are the first key +value of each block in the level below this one. Each record contains +.BR startoff . +.TP +.B ptrs +[non-leaf blocks only] array of child block pointers. +Each pointer is a filesystem block number to the next level in the Btree. +.PD +.RE +.TP +.B bnobt +There is one set of filesystem blocks forming the by-block-number +allocation Btree for each allocation group. The root block of this +Btree is designated by the +.B bnoroot +field in the corresponding AGF block. +The blocks are linked to sibling left and right blocks at each level, +as well as by pointers from parent to child blocks. +Each block has the following fields: +.RS 1.4i +.PD 0 +.TP 1.2i +.B magic +BNOBT block magic number, 0x41425442 ('ABTB'). +.TP +.B level +level number of this block, 0 is a leaf. +.TP +.B numrecs +number of data entries in the block. +.TP +.B leftsib +left (logically lower) sibling block, 0 if none. +.TP +.B rightsib +right (logically higher) sibling block, 0 if none. +.TP +.B recs +[leaf blocks only] array of freespace records. Each record contains +.B startblock +and +.BR blockcount . +.TP +.B keys +[non-leaf blocks only] array of key records. These are the first value +of each block in the level below this one. Each record contains +.B startblock +and +.BR blockcount . +.TP +.B ptrs +[non-leaf blocks only] array of child block pointers. Each pointer is a +block number within the allocation group to the next level in the Btree. +.PD +.RE +.TP +.B cntbt +There is one set of filesystem blocks forming the by-block-count +allocation Btree for each allocation group. The root block of this +Btree is designated by the +.B cntroot +field in the corresponding AGF block. The blocks are linked to sibling +left and right blocks at each level, as well as by pointers from parent +to child blocks. Each block has the following fields: +.RS 1.4i +.PD 0 +.TP 1.2i +.B magic +CNTBT block magic number, 0x41425443 ('ABTC'). +.TP +.B level +level number of this block, 0 is a leaf. +.TP +.B numrecs +number of data entries in the block. +.TP +.B leftsib +left (logically lower) sibling block, 0 if none. +.TP +.B rightsib +right (logically higher) sibling block, 0 if none. +.TP +.B recs +[leaf blocks only] array of freespace records. Each record contains +.B startblock +and +.BR blockcount . +.TP +.B keys +[non-leaf blocks only] array of key records. These are the first value +of each block in the level below this one. Each record contains +.B blockcount +and +.BR startblock . +.TP +.B ptrs +[non-leaf blocks only] array of child block pointers. Each pointer is a +block number within the allocation group to the next level in the Btree. +.PD +.RE +.TP +.B data +User file blocks, and other blocks whose type is unknown, have this +type for display purposes in +.BR xfs_db . +The block data is displayed in hexadecimal format. +.TP +.B dir +A version 1 directory is organized as a Btree with the directory data +embedded in the leaf blocks. The root of the Btree is found in block 0 +of the file. The index (sort order) of the Btree is the hash value of +the entry name. All the blocks contain a +.B blkinfo +structure at the beginning with the following fields: +.RS 1.4i +.PD 0 +.TP 1.2i +.B forw +next sibling block. +.TP +.B back +previous sibling block. +.TP +.B magic +magic number for this block type. +.RE +.IP + +The non-leaf (node) blocks have the following fields: +.RS 1.4i +.TP 1.2i +.B hdr +header containing a +.B blkinfo +structure +.B info +(magic number 0xfebe), the +.B count +of active entries, and the +.B level +of this block above the leaves. +.TP +.B btree +array of entries containing +.B hashval +and +.B before +fields. The +.B before +value is a block number within the directory file to the child block, the +.B hashval +is the last hash value in that block. +.RE +.IP + +The leaf blocks have the following fields: +.RS 1.4i +.TP 1.2i +.B hdr +header containing a +.B blkinfo +structure +.B info +(magic number 0xfeeb), the +.B count +of active entries, +.B namebytes +(total name string bytes), +.B holes +flag (block needs compaction), and +.B freemap +(array of +.BR base ", " size +entries for free regions). +.TP +.B entries +array of structures containing +.BR hashval , +.B nameidx +(byte index into the block of the name string), and +.BR namelen . +.TP +.B namelist +array of structures containing +.B inumber +and +.BR name . +.RE +.PD +.TP +.B dir2 +A version 2 directory has four kinds of blocks. +Data blocks start at offset 0 in the file. +There are two kinds of data blocks: single-block directories have +the leaf information embedded at the end of the block, data blocks +in multi-block directories do not. +Node and leaf blocks start at offset 32GiB (with either a single +leaf block or the root node block). +Freespace blocks start at offset 64GiB. +The node and leaf blocks form a Btree, with references to the data +in the data blocks. +The freespace blocks form an index of longest free spaces within the +data blocks. +.IP +A single-block directory block contains the following fields: +.RS 1.4i +.PD 0 +.TP 1.2i +.B bhdr +header containing +.B magic +number 0x58443242 ('XD2B') and an array +.B bestfree +of the longest 3 free spaces in the block +.RB ( offset ", " length ). +.TP +.B bu +array of union structures. Each element is either an entry or a freespace. +For entries, there are the following fields: +.BR inumber , +.BR namelen , +.BR name , +and +.BR tag . +For freespace, there are the following fields: +.B freetag +(0xffff), +.BR length , +and +.BR tag . +The +.B tag +value is the byte offset in the block of the start of the entry it +is contained in. +.TP +.B bleaf +array of leaf entries containing +.B hashval +and +.BR address . +The +.B address +is a 64-bit word offset into the file. +.TP +.B btail +tail structure containing the total +.B count +of leaf entries and +.B stale +count of unused leaf entries. +.RE +.IP + +A data block contains the following fields: +.RS 1.4i +.TP 1.2i +.B dhdr +header containing +.B magic +number 0x58443244 ('XD2D') and an array +.B bestfree +of the longest 3 free spaces in the block +.RB ( offset ", " length ). +.TP +.B du +array of union structures as for +.BR bu . +.RE +.IP + +Leaf blocks have two possible forms. If the Btree consists of a single +leaf then the freespace information is in the leaf block, +otherwise it is in separate blocks and the root of the Btree is +a node block. A leaf block contains the following fields: +.RS 1.4i +.TP 1.2i +.B lhdr +header containing a +.B blkinfo +structure +.B info +(magic number 0xd2f1 for the single leaf case, 0xd2ff for the true +Btree case), the total +.B count +of leaf entries, and +.B stale +count of unused leaf entries. +.TP +.B lents +leaf entries, as for +.BR bleaf . +.TP +.B lbests +[single leaf only] array of values which represent the longest freespace +in each data block in the directory. +.TP +.B ltail +[single leaf only] tail structure containing +.B bestcount +count of +.BR lbests . +.RE +.IP + +A node block is identical to that for types +.B attr +and +.BR dir . + +A freespace block contains the following fields: +.RS 1.4i +.TP 1.2i +.B fhdr +header containing +.B magic +number 0x58443246 ('XD2F'), +.B firstdb +first data block number covered by this freespace block, +.B nvalid +number of valid entries, and +.B nused +number of entries representing real data blocks. +.TP +.B fbests +array of values as for +.BR lbests . +.PD +.RE +.TP +.B dqblk +The quota information is stored in files referred to by the superblock +.B uquotino +and +.B pquotino +fields. Each filesystem block in a quota file contains a constant number of +quota entries. The quota entry size is currently 136 bytes, so with a 4KiB +filesystem block size there are 30 quota entries per block. The +.B dquot +command is used to locate these entries in the filesystem. +The file entries are indexed by the user or project identifier +to determine the block and offset. +Each quota entry has the following fields: +.RS 1.4i +.PD 0 +.TP 1.5i +.B magic +magic number, 0x4451 ('DQ'). +.TP +.B version +version number, currently 1. +.TP +.B flags +flags, values include 0x01 for user quota, 0x02 for project quota. +.TP +.B id +user or project identifier. +.TP +.B blk_hardlimit +absolute limit on blocks in use. +.TP +.B blk_softlimit +preferred limit on blocks in use. +.TP +.B ino_hardlimit +absolute limit on inodes in use. +.TP +.B ino_softlimit +preferred limit on inodes in use. +.TP +.B bcount +blocks actually in use. +.TP +.B icount +inodes actually in use. +.TP +.B itimer +time when service will be refused if soft limit is violated for inodes. +.TP +.B btimer +time when service will be refused if soft limit is violated for blocks. +.TP +.B iwarns +number of warnings issued about inode limit violations. +.TP +.B bwarns +number of warnings issued about block limit violations. +.TP +.B rtb_hardlimit +absolute limit on realtime blocks in use. +.TP +.B rtb_softlimit +preferred limit on realtime blocks in use. +.TP +.B rtbcount +realtime blocks actually in use. +.TP +.B rtbtimer +time when service will be refused if soft limit is violated for realtime blocks. +.TP +.B rtbwarns +number of warnings issued about realtime block limit violations. +.PD +.RE +.TP +.B inobt +There is one set of filesystem blocks forming the inode allocation Btree for +each allocation group. The root block of this Btree is designated by the +.B root +field in the corresponding AGI block. +The blocks are linked to sibling left and right blocks at each level, +as well as by pointers from parent to child blocks. +Each block has the following fields: +.RS 1.4i +.PD 0 +.TP 1.2i +.B magic +INOBT block magic number, 0x49414254 ('IABT'). +.TP +.B level +level number of this block, 0 is a leaf. +.TP +.B numrecs +number of data entries in the block. +.TP +.B leftsib +left (logically lower) sibling block, 0 if none. +.TP +.B rightsib +right (logically higher) sibling block, 0 if none. +.TP +.B recs +[leaf blocks only] array of inode records. Each record contains +.B startino +allocation-group relative inode number, +.B freecount +count of free inodes in this chunk, and +.B free +bitmap, LSB corresponds to inode 0. +.TP +.B keys +[non-leaf blocks only] array of key records. These are the first value of each +block in the level below this one. Each record contains +.BR startino . +.TP +.B ptrs +[non-leaf blocks only] array of child block pointers. Each pointer is a +block number within the allocation group to the next level in the Btree. +.PD +.RE +.TP +.B inode +Inodes are allocated in "chunks" of 64 inodes each. Usually a chunk is +multiple filesystem blocks, although there are cases with large filesystem +blocks where a chunk is less than one block. The inode Btree (see +.B inobt +above) refers to the inode numbers per allocation group. The inode numbers +directly reflect the location of the inode block on disk. Use the +.B inode +command to point +.B xfs_db +to a specific inode. Each inode contains four regions: +.BR core , +.BR next_unlinked , +.BR u ", and " +.BR a . +.B core +contains the fixed information. +.B next_unlinked +is separated from the core due to journaling considerations, see type +.B agi +field +.BR unlinked . +.B u +is a union structure that is different in size and format depending +on the type and representation of the file data ("data fork"). +.B a +is an optional union structure to describe attribute data, +that is different in size, format, and location depending on the presence +and representation of attribute data, and the size of the +.B u +data ("attribute fork"). +.B xfs_db +automatically selects the proper union members based on information +in the inode. +.IP +The following are fields in the inode core: +.RS 1.4i +.PD 0 +.TP 1.2i +.B magic +inode magic number, 0x494e ('IN'). +.TP +.B mode +mode and type of file, as described in +.BR chmod (2), +.BR mknod (2), +and +.BR stat (2). +.TP +.B version +inode version, 1 or 2. +.TP +.B format +format of +.B u +union data (0: xfs_dev_t, 1: local file \- in-inode directory or symlink, +2: extent list, 3: Btree root, 4: unique id [unused]). +.TP +.B nlinkv1 +number of links to the file in a version 1 inode. +.TP +.B nlinkv2 +number of links to the file in a version 2 inode. +.TP +.B projid_lo +owner's project id (low word; version 2 inode only). +.B projid_hi +owner's project id (high word; version 2 inode only). +.TP +.B uid +owner's user id. +.TP +.B gid +owner's group id. +.TP +.B atime +time last accessed (seconds and nanoseconds). +.TP +.B mtime +time last modified. +.TP +.B ctime +time created or inode last modified. +.TP +.B size +number of bytes in the file. +.TP +.B nblocks +total number of blocks in the file including indirect and attribute. +.TP +.B extsize +basic/minimum extent size for the file. +.TP +.B nextents +number of extents in the data fork. +.TP +.B naextents +number of extents in the attribute fork. +.TP +.B forkoff +attribute fork offset in the inode, in 64-bit words from the start of +.BR u . +.TP +.B aformat +format of +.B a +data (1: local attribute data, 2: extent list, 3: Btree root). +.TP +.B dmevmask +DMAPI event mask. +.TP +.B dmstate +DMAPI state information. +.TP +.B newrtbm +file is the realtime bitmap and is "new" format. +.TP +.B prealloc +file has preallocated data space after EOF. +.TP +.B realtime +file data is in the realtime subvolume. +.TP +.B gen +inode generation number. +.RE +.IP + +The following fields are in the +.B u +data fork union: +.RS 1.4i +.TP 1.2i +.B bmbt +bmap Btree root. This looks like a +.B bmapbtd +block with redundant information removed. +.TP +.B bmx +array of extent descriptors. +.TP +.B dev +dev_t for the block or character device. +.TP +.B sfdir +shortform (in-inode) version 1 directory. This consists of a +.B hdr +containing the +.B parent +inode number and a +.B count +of active entries in the directory, followed by an array +.B list +of +.B hdr.count +entries. Each such entry contains +.BR inumber , +.BR namelen , +and +.B name +string. +.TP +.B sfdir2 +shortform (in-inode) version 2 directory. This consists of a +.B hdr +containing a +.B count +of active entries in the directory, an +.B i8count +of entries with inumbers that don't fit in a 32-bit value, and the +.B parent +inode number, followed by an array +.B list +of +.B hdr.count +entries. Each such entry contains +.BR namelen , +a saved +.B offset +used when the directory is converted to a larger form, a +.B name +string, and the +.BR inumber . +.TP +.B symlink +symbolic link string value. +.RE +.IP + +The following fields are in the +.B a +attribute fork union if it exists: +.RS 1.4i +.TP 1.2i +.B bmbt +bmap Btree root, as above. +.TP +.B bmx +array of extent descriptors. +.TP +.B sfattr +shortform (in-inode) attribute values. This consists of a +.B hdr +containing a +.B totsize +(total size in bytes) and a +.B count +of active entries, followed by an array +.B list +of +.B hdr.count +entries. Each such entry contains +.BR namelen , +.BR valuelen , +.BR root +flag, +.BR name , +and +.BR value . +.PD +.RE +.TP +.B log +Log blocks contain the journal entries for XFS. +It's not useful to examine these with +.BR xfs_db , +use +.BR xfs_logprint (8) +instead. +.TP +.B refcntbt +There is one set of filesystem blocks forming the reference count Btree for +each allocation group. The root block of this Btree is designated by the +.B refcntroot +field in the corresponding AGF block. The blocks are linked to sibling left +and right blocks at each level, as well as by pointers from parent to child +blocks. Each block has the following fields: +.RS 1.4i +.PD 0 +.TP 1.2i +.B magic +REFC block magic number, 0x52334643 ('R3FC'). +.TP +.B level +level number of this block, 0 is a leaf. +.TP +.B numrecs +number of data entries in the block. +.TP +.B leftsib +left (logically lower) sibling block, 0 if none. +.TP +.B rightsib +right (logically higher) sibling block, 0 if none. +.TP +.B recs +[leaf blocks only] array of reference count records. Each record contains +.BR startblock , +.BR blockcount , +and +.BR refcount . +.TP +.B keys +[non-leaf blocks only] array of key records. These are the first value +of each block in the level below this one. Each record contains +.BR startblock . +.TP +.B ptrs +[non-leaf blocks only] array of child block pointers. Each pointer is a +block number within the allocation group to the next level in the Btree. +.PD +.RE +.TP +.B rmapbt +There is one set of filesystem blocks forming the reverse mapping Btree for +each allocation group. The root block of this Btree is designated by the +.B rmaproot +field in the corresponding AGF block. The blocks are linked to sibling left +and right blocks at each level, as well as by pointers from parent to child +blocks. Each block has the following fields: +.RS 1.4i +.PD 0 +.TP 1.2i +.B magic +RMAP block magic number, 0x524d4233 ('RMB3'). +.TP +.B level +level number of this block, 0 is a leaf. +.TP +.B numrecs +number of data entries in the block. +.TP +.B leftsib +left (logically lower) sibling block, 0 if none. +.TP +.B rightsib +right (logically higher) sibling block, 0 if none. +.TP +.B recs +[leaf blocks only] array of reference count records. Each record contains +.BR startblock , +.BR blockcount , +.BR owner , +.BR offset , +.BR attr_fork , +.BR bmbt_block , +and +.BR unwritten . +.TP +.B keys +[non-leaf blocks only] array of double-key records. The first ("low") key +contains the first value of each block in the level below this one. The second +("high") key contains the largest key that can be used to identify any record +in the subtree. Each record contains +.BR startblock , +.BR owner , +.BR offset , +.BR attr_fork , +and +.BR bmbt_block . +.TP +.B ptrs +[non-leaf blocks only] array of child block pointers. Each pointer is a +block number within the allocation group to the next level in the Btree. +.PD +.RE +.TP +.B rtbitmap +If the filesystem has a realtime subvolume, then the +.B rbmino +field in the superblock refers to a file that contains the realtime bitmap. +Each bit in the bitmap file controls the allocation of a single realtime extent +(set == free). The bitmap is processed in 32-bit words, the LSB of a word is +used for the first extent controlled by that bitmap word. The +.B atime +field of the realtime bitmap inode contains a counter +that is used to control where the next new realtime file will start. +.TP +.B rtsummary +If the filesystem has a realtime subvolume, then the +.B rsumino +field in the superblock refers to a file that contains the realtime summary +data. The summary file contains a two-dimensional array of 16-bit values. +Each value counts the number of free extent runs +(consecutive free realtime extents) +of a given range of sizes that starts in a given bitmap block. +The size ranges are binary buckets (low size in the bucket is a power of 2). +There are as many size ranges as are necessary given the size of the +realtime subvolume. +The first dimension is the size range, +the second dimension is the starting bitmap block number +(adjacent entries are for the same size, adjacent bitmap blocks). +.TP +.B sb +There is one sb (superblock) structure per allocation group. +It is the first disk block in the allocation group. +Only the first one (block 0 of the filesystem) is actually used; +the other blocks are redundant information for +.BR xfs_repair (8) +to use if the first superblock is damaged. Fields defined: +.RS 1.4i +.PD 0 +.TP 1.2i +.B magicnum +superblock magic number, 0x58465342 ('XFSB'). +.TP +.B blocksize +filesystem block size in bytes. +.TP +.B dblocks +number of filesystem blocks present in the data subvolume. +.TP +.B rblocks +number of filesystem blocks present in the realtime subvolume. +.TP +.B rextents +number of realtime extents that +.B rblocks +contain. +.TP +.B uuid +unique identifier of the filesystem. +.TP +.B logstart +starting filesystem block number of the log (journal). +If this value is 0 the log is "external". +.TP +.B rootino +root inode number. +.TP +.B rbmino +realtime bitmap inode number. +.TP +.B rsumino +realtime summary data inode number. +.TP +.B rextsize +realtime extent size in filesystem blocks. +.TP +.B agblocks +size of an allocation group in filesystem blocks. +.TP +.B agcount +number of allocation groups. +.TP +.B rbmblocks +number of realtime bitmap blocks. +.TP +.B logblocks +number of log blocks (filesystem blocks). +.TP +.B versionnum +filesystem version information. +This value is currently 1, 2, 3, or 4 in the low 4 bits. +If the low bits are 4 then the other bits have additional meanings. +1 is the original value. +2 means that attributes were used. +3 means that version 2 inodes (large link counts) were used. +4 is the bitmask version of the version number. +In this case, the other bits are used as flags +(0x0010: attributes were used, +0x0020: version 2 inodes were used, +0x0040: quotas were used, +0x0080: inode cluster alignment is in force, +0x0100: data stripe alignment is in force, +0x0200: the +.B shared_vn +field is used, +0x1000: unwritten extent tracking is on, +0x2000: version 2 directories are in use). +.TP +.B sectsize +sector size in bytes, currently always 512. +This is the size of the superblock and the other header blocks. +.TP +.B inodesize +inode size in bytes. +.TP +.B inopblock +number of inodes per filesystem block. +.TP +.B fname +obsolete, filesystem name. +.TP +.B fpack +obsolete, filesystem pack name. +.TP +.B blocklog +log2 of +.BR blocksize . +.TP +.B sectlog +log2 of +.BR sectsize . +.TP +.B inodelog +log2 of +.BR inodesize . +.TP +.B inopblog +log2 of +.BR inopblock . +.TP +.B agblklog +log2 of +.B agblocks +(rounded up). +.TP +.B rextslog +log2 of +.BR rextents . +.TP +.B inprogress +.BR mkfs.xfs (8) +or +.BR xfs_copy (8) +aborted before completing this filesystem. +.TP +.B imax_pct +maximum percentage of filesystem space used for inode blocks. +.TP +.B icount +number of allocated inodes. +.TP +.B ifree +number of allocated inodes that are not in use. +.TP +.B fdblocks +number of free data blocks. +.TP +.B frextents +number of free realtime extents. +.TP +.B uquotino +user quota inode number. +.TP +.B pquotino +project quota inode number; this is currently unused. +.TP +.B qflags +quota status flags +(0x01: user quota accounting is on, +0x02: user quota limits are enforced, +0x04: quotacheck has been run on user quotas, +0x08: project quota accounting is on, +0x10: project quota limits are enforced, +0x20: quotacheck has been run on project quotas). +.TP +.B flags +random flags. 0x01: only read-only mounts are allowed. +.TP +.B shared_vn +shared version number (shared readonly filesystems). +.TP +.B inoalignmt +inode chunk alignment in filesystem blocks. +.TP +.B unit +stripe or RAID unit. +.TP +.B width +stripe or RAID width. +.TP +.B dirblklog +log2 of directory block size (filesystem blocks). +.PD +.RE +.TP +.B symlink +Symbolic link blocks are used only when the symbolic link value does +not fit inside the inode. The block content is just the string value. +Bytes past the logical end of the symbolic link value have arbitrary values. +.TP +.B text +User file blocks, and other blocks whose type is unknown, +have this type for display purposes in +.BR xfs_db . +The block data is displayed in two columns: Hexadecimal format +and printable ASCII chars. +.SH DIAGNOSTICS +Many messages can come from the +.B check +.RB ( blockget ) +command. +If the filesystem is completely corrupt, a core dump might +be produced instead of the message +.RS +.I device +.B is not a valid filesystem +.RE +.PP +If the filesystem is very large (has many files) then +.B check +might run out of memory. In this case the message +.RS +.B out of memory +.RE +is printed. +.PP +The following is a description of the most likely problems and the associated +messages. +Most of the diagnostics produced are only meaningful with an understanding +of the structure of the filesystem. +.TP +.BI "agf_freeblks " n ", counted " m " in ag " a +The freeblocks count in the allocation group header for allocation group +.I a +doesn't match the number of blocks counted free. +.TP +.BI "agf_longest " n ", counted " m " in ag " a +The longest free extent in the allocation group header for allocation group +.I a +doesn't match the longest free extent found in the allocation group. +.TP +.BI "agi_count " n ", counted " m " in ag " a +The allocated inode count in the allocation group header for allocation group +.I a +doesn't match the number of inodes counted in the allocation group. +.TP +.BI "agi_freecount " n ", counted " m " in ag " a +The free inode count in the allocation group header for allocation group +.I a +doesn't match the number of inodes counted free in the allocation group. +.TP +.BI "block " a/b " expected inum 0 got " i +The block number is specified as a pair +(allocation group number, block in the allocation group). +The block is used multiple times (shared), between multiple inodes. +This message usually follows a message of the next type. +.TP +.BI "block " a/b " expected type unknown got " y +The block is used multiple times (shared). +.TP +.BI "block " a/b " type unknown not expected +.SH SEE ALSO +.BR mkfs.xfs (8), +.BR xfs_admin (8), +.BR xfs_copy (8), +.BR xfs_logprint (8), +.BR xfs_metadump (8), +.BR xfs_ncheck (8), +.BR xfs_repair (8), +.BR mount (8), +.BR chmod (2), +.BR mknod (2), +.BR stat (2), +.BR xfs (5). diff --git a/upstream/opensuse-leap-15-6/man8/xfs_estimate.8 b/upstream/opensuse-leap-15-6/man8/xfs_estimate.8 new file mode 100644 index 00000000..2594eb87 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/xfs_estimate.8 @@ -0,0 +1,105 @@ +.TH xfs_estimate 8 +.SH NAME +xfs_estimate \- estimate the space that an XFS filesystem will take +.SH SYNOPSIS +.nf +\f3xfs_estimate\f1 [ \f3\-h\f1 ] [ \f3\-b\f1 blocksize ] [ \f3\-i\f1 logsize ] + [ \f3\-e\f1 logsize ] [ \f3\-v\f1 ] directory ... +.br +.B xfs_estimate \-V +.fi +.SH DESCRIPTION +For each \f2directory\f1 argument, +.I xfs_estimate +estimates the space that directory would take if it were copied to an XFS +filesystem. +.I xfs_estimate +does not cross mount points. +The following definitions +are used: +.PD 0 +.IP +KB = *1024 +.IP +MB = *1024*1024 +.IP +GB = *1024*1024*1024 +.PD +.PP +The +.I xfs_estimate +options are: +.TP +\f3\-b\f1 \f2blocksize\f1 +Use +.I blocksize +instead of the default blocksize of 4096 bytes. +The modifier +.B k +can be used +after the number to indicate multiplication by 1024. +For example, +.sp .8v +.RS + \f4xfs_estimate \-b 64k /\f1 +.RE +.IP +requests an estimate of the space required by the directory / on an +XFS filesystem using a blocksize of 64K (65536) bytes. +.TP +.B \-v +Display more information, formatted. +.TP +.B \-h +Display usage message. +.TP +\f3\-i, \-e\f1 \f2logsize\f1 +Use +.I logsize +instead of the default log size of 1000 blocks. +.B \-i +refers to an internal log, while +.B \-e +refers to an external log. +The modifiers +.B k +or +.B m +can be used +after the number to indicate multiplication by 1024 or 1048576, respectively. +.IP +For example, +.sp .8v +.RS + \f4xfs_estimate \-i 1m /\f1 +.RE +.IP +requests an estimate of the space required by the directory / on an +XFS filesystem using an internal log of 1 megabyte. +.TP +.B \-V +Print the version number and exits. +.SH EXAMPLES +.nf +.sp 8v +% \f4xfs_estimate \-e 10m /var/tmp\f1\f7 +/var/tmp will take about 4.2 megabytes + with the external log using 2560 blocks or about 10.0 megabytes +.fi +.nf +.sp .8v +% \f4xfs_estimate \-v \-e 10m /var/tmp\f1\f7 +directory bsize blocks megabytes logsize +/var/tmp 4096 792 4.0MB 10485760 +.fi +.nf +.sp .8v +% \f4xfs_estimate \-v /var/tmp\f1\f7 +directory bsize blocks megabytes logsize +/var/tmp 4096 3352 14.0MB 10485760 +.fi +.nf +.sp .8v +% \f4xfs_estimate /var/tmp\f1\f7 +/var/tmp will take about 14.0 megabytes +.fi diff --git a/upstream/opensuse-leap-15-6/man8/xfs_freeze.8 b/upstream/opensuse-leap-15-6/man8/xfs_freeze.8 new file mode 100644 index 00000000..c581ad77 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/xfs_freeze.8 @@ -0,0 +1,83 @@ +.TH xfs_freeze 8 +.SH NAME +xfs_freeze \- suspend access to an XFS filesystem +.SH SYNOPSIS +.B xfs_freeze +[ +.B \-f +| +.B \-u +] +.I mount-point +.br +.B xfs_freeze \-V +.fi +.SH DESCRIPTION +.B xfs_freeze +suspends and resumes access to an XFS filesystem (see +.BR xfs (5)). +.PP +.B xfs_freeze +halts new access to the filesystem and creates a stable image on disk. +.B xfs_freeze +is intended to be used with volume managers and hardware RAID devices +that support the creation of snapshots. +.PP +The +.I mount-point +argument is the pathname of the directory where the filesystem +is mounted. +The filesystem must be mounted to be frozen (see +.BR mount (8)). +.PP +.PP +The +.B \-f +flag requests the specified XFS filesystem to be +frozen from new modifications. +When this is selected, all ongoing transactions in the filesystem +are allowed to complete, new write system calls are halted, other +calls which modify the filesystem are halted, and all dirty data, +metadata, and log information are written to disk. +Any process attempting to write to the frozen filesystem will block +waiting for the filesystem to be unfrozen. +.PP +Note that even after freezing, the on-disk filesystem can contain +information on files that are still in the process of unlinking. +These files will not be unlinked until the filesystem is unfrozen +or a clean mount of the snapshot is complete. +.PP +The +.B \-u +flag is used to un-freeze the filesystem and allow +operations to continue. +Any filesystem modifications that were blocked by the freeze are +unblocked and allowed to complete. +.PP +The +.B \-V +flag prints the version number and exits. +.PP +Unless +.B \-V +is specified, one of +.B \-f +or +.B \-u +must be supplied to +.BR xfs_freeze . +.SH NOTES +A copy of a frozen XFS filesystem will usually have the same universally +unique identifier (UUID) as the original, and thus may be prevented from +being mounted. +The XFS +.B nouuid +mount option can be used to circumvent this issue. +.PP +In Linux kernel version 2.6.29, the interface which XFS uses to freeze +and unfreeze was elevated to the VFS, so that this tool can now be +used on many other Linux filesystems. +.SH SEE ALSO +.BR xfs (5), +.BR lvm (8), +.BR mount (8). diff --git a/upstream/opensuse-leap-15-6/man8/xfs_fsr.8 b/upstream/opensuse-leap-15-6/man8/xfs_fsr.8 new file mode 100644 index 00000000..0a162b60 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/xfs_fsr.8 @@ -0,0 +1,187 @@ +.TH xfs_fsr 8 +.SH NAME +xfs_fsr \- filesystem reorganizer for XFS +.SH SYNOPSIS +.nf +\f3xfs_fsr\f1 [\f3\-vdg\f1] \c +[\f3\-t\f1 seconds] [\f3\-p\f1 passes] [\f3\-f\f1 leftoff] [\f3\-m\f1 mtab] +\f3xfs_fsr\f1 [\f3\-vdg\f1] \c +[xfsdev | file] ... +.br +.B xfs_fsr \-V +.fi +.SH DESCRIPTION +.I xfs_fsr +is applicable only to XFS filesystems. +.PP +.I xfs_fsr +improves the organization of mounted filesystems. +The reorganization algorithm operates on one file at a time, +compacting or otherwise improving the layout of +the file extents (contiguous blocks of file data). +.PP +The following options are accepted by +.IR xfs_fsr . +The +.BR \-m , +.BR \-t , +and +.B \-f +options have no meaning if any filesystems +or files are specified on the command line. +.TP 13 +.BI \-m " mtab" +Use this file for the list of filesystems to reorganize. +The default is to use +.IR /etc/mtab . +.TP +.BI \-t " seconds" +How long to reorganize. +The default is 7200 seconds (2 hours). +.TP +.BI \-p " passes" +Number of passes before terminating global re-org. +The default is 10 passes. +.TP +.BI \-f " leftoff" +Use this file instead of +.I /var/tmp/.fsrlast +to read the state of where to start and as the file +to store the state of where reorganization left off. +.TP +.B \-v +Verbose. +Print cryptic information about +each file being reorganized. +.TP +.B \-d +Debug. Print even more cryptic information. +.TP +.B \-g +Print to syslog (default if stdout not a tty). +.TP +.B \-V +Prints the version number and exits. + +.PP +When invoked with no arguments +.I xfs_fsr +reorganizes all regular files in all mounted filesystems. +.I xfs_fsr +makes many cycles over +.I /etc/mtab +each time making a single pass over each XFS filesystem. +Each pass goes through and selects files +that have the largest number of extents. It attempts +to defragment the top 10% of these files on each pass. +.PP +It runs for up to two hours after which it records the filesystem +where it left off, so it can start there the next time. +This information is stored in the file +.I /var/tmp/.fsrlast_xfs. +If the information found here +is somehow inconsistent or out of date +it is ignored +and reorganization starts at the beginning of the first +filesystem found in +.IR /etc/mtab . +.PP +.I xfs_fsr +can be called with one or more arguments +naming filesystems (block device name), +and files to reorganize. +In this mode +.I xfs_fsr +does not read or write +.I /var/tmp/.fsrlast_xfs +nor does it run for a fixed time interval. +It makes one pass through each specified regular file and +all regular files in each specified filesystem. +A command line name referring to a symbolic link +(except to a file system device), +FIFO, or UNIX domain socket +generates a warning message, but is otherwise ignored. +While traversing the filesystem these types +of files are silently skipped. +.SH FILES +.PD 0 +.TP 21 +/etc/mtab +contains default list of filesystems to reorganize. +.TP 21 +/var/tmp/.fsrlast_xfs +records the state where reorganization left off. +.PD +.SH "SEE ALSO" +xfs_fsr(8), +mkfs.xfs(8), +xfs_ncheck(8), +xfs(5). +.SH "NOTES" +.I xfs_fsr +improves the layout of extents for each file by copying the entire +file to a temporary location and then interchanging the data extents +of the target and temporary files in an atomic manner. +This method requires that enough free disk space be available to copy +any given file and that the space be less fragmented than the original +file. +It also requires the owner of the file to have enough remaining +filespace quota to do the copy on systems running quotas. +.I xfs_fsr +generates a warning message if space is not sufficient to improve +the target file. +.PP +A temporary file used in improving a file given on the command line +is created in the same parent directory of the target file and +is prefixed by the string '\f3.fsr\f1'. +The temporary files used in improving an entire XFS device are stored +in a directory at the root of the target device and use the same +naming scheme. +The temporary files are unlinked upon creation so data will not be +readable by any other process. +.PP +.I xfs_fsr +does not operate on files that are currently mapped in memory. +A 'file busy' error can be seen for these files if the verbose +flag (\f3-v\f1) is set. +.PP +Files marked as no\-defrag will be skipped. The +.IR xfs_io (8) +chattr command with the f attribute can be used to set or clear +this flag. Files and directories created in a directory with the +no\-defrag flag will inherit the attribute. +.PP +An entry in +.I /etc/mtab +or the file specified using the +.B \-m +option must have the +.B rw +option specified for read and write access. +If this option is not present, then +.I xfs_fsr +skips the +filesystem described by that line. +See the +.IR fstab (5) +reference page for +more details. +.PP +In general we do not foresee the need to run +.I xfs_fsr +on system partitions such as +.IR / , +.I /boot +and +.I /usr +as in general these will not suffer from fragmentation. +There are also issues with defragmenting files +.IR lilo (8) +uses to boot your system. It is recommended that these files +should be flagged as no\-defrag with the +.IR xfs_io (8) +chattr command. Should these files be moved by +.I xfs_fsr +then you must rerun +.I lilo +before you reboot or you may have an unbootable system. diff --git a/upstream/opensuse-leap-15-6/man8/xfs_growfs.8 b/upstream/opensuse-leap-15-6/man8/xfs_growfs.8 new file mode 100644 index 00000000..a0126927 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/xfs_growfs.8 @@ -0,0 +1,170 @@ +.\" Verbatim blocks taken from openssl req manpage content +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. + +.TH xfs_growfs 8 +.SH NAME +xfs_growfs \- expand an XFS filesystem +.SH SYNOPSIS +.B xfs_growfs +[ +.B \-dilnrx +] [ +.B \-D +.I size +] [ +.B \-e +.I rtextsize +] [ +.B \-L +.I size +] [ +.B \-m +.I maxpct +] [ +.B \-t +.I mtab +] [ +.B \-R +.I size +] +[ +.I mount-point +| +.I block-device +] + +.br +.B xfs_growfs \-V +.SH DESCRIPTION +.B xfs_growfs +expands an existing XFS filesystem (see +.BR xfs (5)). +The +.I mount-point +argument is the pathname of the directory where the filesystem +is mounted. The +.I block-device +argument is the device name of a mounted XFS filesystem. +The filesystem must be mounted to be grown (see +.BR mount (8)). +The existing contents of the filesystem are undisturbed, and the added space +becomes available for additional file storage. +.SH OPTIONS +.TP +.BI "\-d | \-D " size +Specifies that the data section of the filesystem should be resized. If the +.B \-D +.I size +option is given, the data section is changed to that +.IR size , +otherwise the data section is grown to the largest size possible with the +.B \-d +option. The size is expressed in filesystem blocks. A filesystem with only +1 AG cannot be shrunk further, and a filesystem cannot be shrunk to the point +where it would only have 1 AG. +.TP +.B \-e +Allows the real-time extent size to be specified. In +.BR mkfs.xfs (8) +this is specified with +.B \-r extsize=\c +.IR nnnn . +.TP +.B \-i +The new log is an internal log (inside the data section). +.B [NOTE: This option is not implemented] +.TP +.BI "\-l | \-L " size +Specifies that the log section of the filesystem should be grown, +shrunk, or moved. If the +.B \-L +.I size +option is given, the log section is changed to be that +.IR size , +if possible. The size is expressed in filesystem blocks. +The size of an internal log must be smaller than the size +of an allocation group (this value is printed at +.BR mkfs (8) +time). If neither +.B \-i +nor +.B \-x +is given with +.BR \-l , +the log continues to be internal or external as it was before. +.B [NOTE: These options are not implemented] +.TP +.B \-m +Specify a new value for the maximum percentage +of space in the filesystem that can be allocated as inodes. In +.BR mkfs.xfs (8) +this is specified with +.B -i maxpct=\c +.IR nn . +.TP +.B \-n +Specifies that no change to the filesystem is to be made. +The filesystem geometry is printed, and argument checking is performed, +but no growth occurs. +.B See output examples below. +.TP +.BI "\-r | \-R " size +Specifies that the real-time section of the filesystem should be grown. If the +.B \-R +.I size +option is given, the real-time section is grown to that size, otherwise +the real-time section is grown to the largest size possible with the +.B \-r +option. The size is expressed in filesystem blocks. +The filesystem does not need to have contained a real-time section before +the +.B xfs_growfs +operation. +.TP +.B \-t +Specifies an alternate mount table file (default is +.I /proc/mounts +if it exists, else +.IR /etc/mtab ). +This is used when working with filesystems mounted without writing to +.I /etc/mtab +file - refer to +.BR mount (8) +for further details. +.TP +.B \-V +Prints the version number and exits. The +.I mount-point +argument is not required with +.BR \-V . +.PP +.B xfs_growfs +is most often used in conjunction with +logical volumes +(see +.BR md (4) +and +.BR lvm (8) +on Linux). +However, it can also be used on a regular disk partition, for example if a +partition has been enlarged while retaining the same starting block. +.SH PRACTICAL USE +Filesystems normally occupy all of the space on the device where they +reside. In order to grow a filesystem, it is necessary to provide added +space for it to occupy. Therefore there must be at least one spare new +disk partition available. Adding the space is often done through the use +of a logical volume manager. +.SH SEE ALSO +.BR mkfs.xfs (8), +.BR xfs_info (8), +.BR md (4), +.BR lvm (8), +.BR mount (8). diff --git a/upstream/opensuse-leap-15-6/man8/xfs_info.8 b/upstream/opensuse-leap-15-6/man8/xfs_info.8 new file mode 100644 index 00000000..429356a8 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/xfs_info.8 @@ -0,0 +1,97 @@ +.\" Verbatim blocks taken from openssl req manpage content +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. + +.TH xfs_info 8 +.SH NAME +xfs_info \- display XFS filesystem geometry information +.SH SYNOPSIS +.B xfs_info +[ +.B \-t +.I mtab +] +[ +.I mount-point +| +.I block-device +| +.I file-image +] +.br +.B xfs_info \-V +.SH DESCRIPTION +.B xfs_info +displays geometry information about an existing XFS filesystem. +The +.I mount-point +argument is the pathname of a directory where the filesystem +is mounted. +The +.I block-device +or +.I file-image +contain a raw XFS filesystem. +The existing contents of the filesystem are undisturbed. +.SH OPTIONS +.TP +.B \-t +Specifies an alternate mount table file (default is +.I /proc/mounts +if it exists, else +.IR /etc/mtab ). +This is used when working with filesystems mounted without writing to +.I /etc/mtab +file - refer to +.BR mount (8) +for further details. +This option has no effect with the +.IR block-device " or " file-image +parameters. +.TP +.B \-V +Prints the version number and exits. The +.I mount-point +argument is not required with +.BR \-V . +.SH "EXAMPLES" + +Understanding xfs_info output. +.PP +Suppose one has the following "xfs_info /dev/sda" output: +.PP +.RS 2 +.Vb +\&meta-data=/dev/pmem0 isize=512 agcount=8, agsize=5974144 blks +\& = sectsz=512 attr=2, projid32bit=1 +\& = crc=1 finobt=1, sparse=1, rmapbt=1 +\& = reflink=1 +\&data = bsize=4096 blocks=47793152, imaxpct=25 +\& = sunit=32 swidth=128 blks +\&naming =version 2 bsize=4096 ascii-ci=0, ftype=1 +\&log =internal log bsize=4096 blocks=23336, version=2 +\& = sectsz=512 sunit=0 blks, lazy-count=1 +\&realtime =none extsz=4096 blocks=0, rtextents=0 +.Ve +.RE +.PP + +Here, the data section of the output indicates "bsize=4096", +meaning the data block size for this filesystem is 4096 bytes. +This section also shows "sunit=32 swidth=128 blks", which means +the stripe unit is 32*4096 bytes = 128 kibibytes and the stripe +width is 128*4096 bytes = 512 kibibytes. +A single stripe of this filesystem therefore consists +of four stripe units (128 blocks / 32 blocks per unit). +.SH SEE ALSO +.BR mkfs.xfs (8), +.BR md (4), +.BR lvm (8), +.BR mount (8). diff --git a/upstream/opensuse-leap-15-6/man8/xfs_io.8 b/upstream/opensuse-leap-15-6/man8/xfs_io.8 new file mode 100644 index 00000000..ef7087b3 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/xfs_io.8 @@ -0,0 +1,1527 @@ +.TH xfs_io 8 +.SH NAME +xfs_io \- debug the I/O path of an XFS filesystem +.SH SYNOPSIS +.B xfs_io +[ +.B \-adfimrRstxT +] [ +.B \-c +.I cmd +] ... [ +.B \-C +.I cmd +] ... [ +.B \-p +.I prog +] +.I [ file ] +.br +.B xfs_io \-V +.SH DESCRIPTION +.B xfs_io +is a debugging tool like +.BR xfs_db (8), +but is aimed at examining the regular file I/O paths rather than the +raw XFS volume itself. +These code paths include not only the obvious read/write/mmap interfaces +for manipulating files, but also cover all of the XFS extensions (such +as space preallocation, additional inode flags, etc). +.SH OPTIONS +.B xfs_io +commands may be run interactively (the default) or as arguments on the +command line. +Interactive mode always runs commands on the current open file, whilst commands +run from the command line may be repeated on all open files rather than just the current +open file. +In general, open file iteration will occur for commands that operate on file +content or state. In contrast, commands that operate on filesystem or +system-wide state will only be run on the current file regardless of how many +files are currently open. +Multiple arguments may be given on the command line and they are run in the +sequence given. The program exits one all commands have +been run. +.TP 1.0i +.BI \-c " cmd" +Run the specified command on all currently open files. +To maintain compatibility with historical usage, commands that can not be run on +all open files will still be run but only execute once on the current open file. +Multiple +.B \-c +arguments may be given and may be interleaved on the command line in any order +with +.B \-C +commands. +.TP +.BI \-C " cmd" +Run the specified command only on the current open file. +Multiple +.B \-C +arguments may be given and may be interleaved on the command line in any order +with +.B \-c +commands. +.TP +.BI \-p " prog" +Set the program name for prompts and some error messages, +the default value is +.BR xfs_io . +.TP +.B \-f +Create +.I file +if it does not already exist. +.TP +.B \-r +Open +.I file +read-only, initially. This is required if +.I file +is immutable or append-only. +.TP +.B \-i +Start an idle thread. The purpose of this idle thread is to test io +from a multi threaded process. With single threaded process, +the file table is not shared and file structs are not reference counted. +Spawning an idle thread can help detecting file struct reference leaks. +.TP +.B \-x +Expert mode. Dangerous commands are only available in this mode. +These commands also tend to require additional privileges. +.TP +.B \-V +Prints the version number and exits. +.PP +The other +.BR open (2) +options described below are also available from the command line. +.SH CONCEPTS +.B xfs_io +maintains a number of open files and memory mappings. +Files can be initially opened on the command line (optionally), +and additional files can also be opened later. +.PP +.B xfs_io +commands can be broken up into three groups. +Some commands are aimed at doing regular file I/O - read, write, +sync, space preallocation, etc. +.PP +The second set of commands exist for manipulating memory mapped regions +of a file - mapping, accessing, storing, unmapping, flushing, etc. +.PP +The remaining commands are for the navigation and display of data +structures relating to the open files, mappings, and the filesystems +where they reside. +.PP +Many commands have extensive online help. Use the +.B help +command for more details on any command. +.SH FILE I/O COMMANDS +.TP +.BI "file [ " N " ]" +Display a list of all open files and (optionally) switch to an alternate +current open file. +.TP +.BI "open [[ \-acdfrstRTPL ] " path " ]" +Closes the current file, and opens the file specified by +.I path +instead. Without any arguments, displays statistics about the current +file \- see the +.B stat +command. +.RS 1.0i +.PD 0 +.TP 0.4i +.B \-a +opens append-only (O_APPEND). +.TP +.B \-d +opens for direct I/O (O_DIRECT). +.TP +.B \-f +creates the file if it doesn't already exist (O_CREAT). +.TP +.B \-r +opens read-only (O_RDONLY). +.TP +.B \-s +opens for synchronous I/O (O_SYNC). +.TP +.B \-t +truncates on open (O_TRUNC). +.TP +.B \-n +opens in non-blocking mode if possible (O_NONBLOCK). +.TP +.B \-T +create a temporary file not linked into the filesystem namespace +(O_TMPFILE). The pathname passed must refer to a directory which +is treated as virtual parent for the newly created invisible file. +Can not be used together with the +.B \-r +option. +.TP +.B \-R +marks the file as a realtime XFS file after +opening it, if it is not already marked as such. +.TP +.B \-P +opens the path as a referent only (O_PATH). This is incompatible with other +flags specifying other O_xxx flags apart from +.BR \-L . +.TP +.B \-L +doesn't follow symlinks (O_NOFOLLOW). This is incompatible with other +flags specifying other O_xxx flags apart from +.BR \-P . +.PD +.RE +.TP +.B o +See the +.B open +command. +.TP +.B close +Closes the current open file, marking the next open file as current +(if one exists). +.TP +.B c +See the +.B close +command. +.TP +.B chmod \-r | \-w +Change the mode of the currently open file. The +.B \-r +option will set the file permissions to read-only (0444), whilst the +.B \-w +option will set the file permissions to read-write (0644). This allows xfs_io to +set up mismatches between the file permissions and the open file descriptor +read/write mode to exercise permission checks inside various syscalls. +.TP +.BI "pread [ \-b " bsize " ] [ \-qv ] [ \-FBR [ \-Z " seed " ] ] [ \-V " vectors " ] " "offset length" +Reads a range of bytes in a specified blocksize from the given +.IR offset . +.RS 1.0i +.PD 0 +.TP 0.4i +.B \-b +can be used to set the blocksize into which the +.BR read (2) +requests will be split. The default blocksize is 4096 bytes. +.TP +.B \-q +quiet mode, do not write anything to standard output. +.TP +.B \-v +dump the contents of the buffer after reading, +by default only the count of bytes actually read is dumped. +.TP +.B \-F +read the buffers in a forward sequential direction. +.TP +.B \-B +read the buffers in a reverse sequential direction. +.TP +.B \-R +read the buffers in the give range in a random order. +.TP +.B \-Z seed +specify the random number seed used for random reads. +.TP +.B \-V vectors +Use the vectored IO read syscall +.BR preadv (2) +with a number of blocksize length iovecs. The number of iovecs is set by the +.I vectors +parameter. +.PD +.RE +.TP +.B r +See the +.B pread +command. +.TP +.BI "pwrite [ \-i " file " ] [ \-qdDwNOW ] [ \-s " skip " ] [ \-b " size " ] [ \-S " seed " ] [ \-FBR [ \-Z " zeed " ] ] [ \-V " vectors " ] " "offset length" +Writes a range of bytes in a specified blocksize from the given +.IR offset . +The bytes written can be either a set pattern or read in from another +file before writing. +.RS 1.0i +.PD 0 +.TP 0.4i +.B \-i +allows an input +.I file +to be specified as the source of the data to be written. +.TP +.B \-q +quiet mode, do not write anything to standard output. +.TP +.B \-d +causes direct I/O, rather than the usual buffered +I/O, to be used when reading the input file. +.TP +.B \-w +call +.BR fdatasync (2) +once all writes are complete (included in timing results) +.TP +.B \-N +Perform the +.BR pwritev2 (2) +call with +.IR RWF_NOWAIT . +.TP +.B \-D +Perform the +.BR pwritev2 (2) +call with +.IR RWF_DSYNC . +.TP +.B \-O +perform pwrite once and return the (maybe partial) bytes written. +.TP +.B \-W +call +.BR fsync (2) +once all writes are complete (included in timing results) +.TP +.B \-s +specifies the number of bytes to +.I skip +from the start of the input file before starting to read. +.TP +.B \-b +used to set the blocksize into which the +.BR write (2) +requests will be split. The default blocksize is 4096 bytes. +.TP +.B \-S +used to set the (repeated) fill pattern which +is used when the data to write is not coming from a file. +The default buffer fill pattern value is 0xcdcdcdcd. +.TP +.B \-F +write the buffers in a forward sequential direction. +.TP +.B \-B +write the buffers in a reverse sequential direction. +.TP +.B \-R +write the buffers in the give range in a random order. +.TP +.B \-Z seed +specify the random number seed used for random write +.TP +.B \-V vectors +Use the vectored IO write syscall +.BR pwritev (2) +with a number of blocksize length iovecs. The number of iovecs is set by the +.I vectors +parameter. +.RE +.PD +.TP +.B w +See the +.B pwrite +command. +.TP +.BI "bmap [ \-adelpv ] [ \-n " nx " ]" +Prints the block mapping for the current open file. Refer to the +.BR xfs_bmap (8) +manual page for complete documentation. +.TP +.BI "fiemap [ \-alv ] [ \-n " nx " ] [ " offset " [ " len " ]]" +Prints the block mapping for the current open file using the fiemap +ioctl. Options behave as described in the +.BR xfs_bmap (8) +manual page. +.PP +.RS +Optionally, this command also supports passing the start offset +from where to begin the mapping and the length of that region. +The kernel will return any full extents which intersect with the requested +range, and the +.B fiemap +command will print them in their entirety. If the requested range starts +or ends in a hole, +.B fiemap +will print the hole, truncated to the requested range. +.RE +.TP +.BI "extsize [ \-R | \-D ] [ " value " ]" +Display and/or modify the preferred extent size used when allocating +space for the currently open file. If the +.B \-R +option is specified, a recursive descent is performed +for all directory entries below the currently open file +.RB ( \-D +can be used to restrict the output to directories only). +If the target file is a directory, then the inherited extent size +is set for that directory (new files created in that directory +inherit that extent size). +The +.I value +should be specified in bytes, or using one of the usual units suffixes +(k, m, g, b, etc). The extent size is always reported in units of bytes. +.TP +.BI "cowextsize [ \-R | \-D ] [ " value " ]" +Display and/or modify the preferred copy-on-write extent size used +when allocating space for the currently open file. If the +.B \-R +option is specified, a recursive descent is performed +for all directory entries below the currently open file +.RB ( \-D +can be used to restrict the output to directories only). +If the target file is a directory, then the inherited CoW extent size +is set for that directory (new files created in that directory +inherit that CoW extent size). +The +.I value +should be specified in bytes, or using one of the usual units suffixes +(k, m, g, b, etc). The extent size is always reported in units of bytes. +.TP +.BI "allocsp " size " 0" +Sets the size of the file to +.I size +and zeroes any additional space allocated using the +XFS_IOC_ALLOCSP/XFS_IOC_FREESP system call described in the +.BR xfsctl (3) +manual page. +.B allocsp +and +.B freesp +do exactly the same thing. + +These commands are no longer supported as of Linux 5.17. +.TP +.BI "freesp " size " 0" +See the +.B allocsp +command. +.TP +.BI "fadvise [ \-r | \-s | [[ \-d | \-n | \-w ] " "offset length " ]] +On platforms which support it, allows hints be given to the system +regarding the expected I/O patterns on the file. +The range arguments are required by some advise commands ([*] below), and +the others must have no range arguments. +With no arguments, the POSIX_FADV_NORMAL advice is implied (default readahead). +.RS 1.0i +.PD 0 +.TP 0.4i +.B \-d +the data will not be accessed again in the near future (POSIX_FADV_DONTNEED[*]). +.TP +.B \-n +data will be accessed once and not be reused (POSIX_FADV_NOREUSE[*]). +.TP +.B \-r +expect access to data in random order (POSIX_FADV_RANDOM), which sets readahead to zero. +.TP +.B \-s +expect access to data in sequential order (POSIX_FADV_SEQUENTIAL), +which doubles the default readahead on the file. +.TP +.B \-w +advises the specified data will be needed again (POSIX_FADV_WILLNEED[*]) +which forces the maximum readahead. +.RE +.PD +.TP +.B fdatasync +Calls +.BR fdatasync (2) +to flush the file's in-core data to disk. +.TP +.B fsync +Calls +.BR fsync (2) +to flush all in-core file state to disk. +.TP +.B s +See the +.B fsync +command. +.TP +.BI "sync_range [ \-a | \-b | \-w ] offset length " +On platforms which support it, allows control of syncing a range of the file to +disk. With no options, SYNC_FILE_RANGE_WRITE is implied on the range supplied. +.RS 1.0i +.PD 0 +.TP 0.4i +.B \-a +wait for IO in the given range to finish after writing +(SYNC_FILE_RANGE_WAIT_AFTER). +.TP +.B \-b +wait for IO in the given range to finish before writing +(SYNC_FILE_RANGE_WAIT_BEFORE). +.TP +.B \-w +start writeback of dirty data in the given range (SYNC_FILE_RANGE_WRITE). +.RE +.PD +.TP +.B sync +Calls +.BR sync (2) +to flush all filesystems' in-core data to disk. +.TP +.B syncfs +Calls +.BR syncfs (2) +to flush this filesystem's in-core data to disk. +.TP +.BI resvsp " offset length" +Allocates reserved, unwritten space for part of a file using the +XFS_IOC_RESVSP system call described in the +.BR xfsctl (3) +manual page. +.TP +.BI unresvsp " offset length" +Frees reserved space for part of a file using the XFS_IOC_UNRESVSP +system call described in the +.BR xfsctl (3) +manual page. +.TP +.BI "falloc [ \-k ]" " offset length" +Allocates reserved, unwritten space for part of a file using the +fallocate routine as described in the +.BR fallocate (2) +manual page. +.RS 1.0i +.PD 0 +.TP 0.4i +.B \-k +will set the FALLOC_FL_KEEP_SIZE flag as described in +.BR fallocate (2). +.PD +.RE +.TP +.BI fcollapse " offset length" +Call fallocate with FALLOC_FL_COLLAPSE_RANGE flag as described in the +.BR fallocate (2) +manual page to de-allocates blocks and eliminates the hole created in this process +by shifting data blocks into the hole. +.TP +.BI finsert " offset length" +Call fallocate with FALLOC_FL_INSERT_RANGE flag as described in the +.BR fallocate (2) +manual page to create the hole by shifting data blocks. +.TP +.BI fpunch " offset length" +Punches (de-allocates) blocks in the file by calling fallocate with +the FALLOC_FL_PUNCH_HOLE flag as described in the +.BR fallocate (2) +manual page. +.TP +.BI funshare " offset length" +Call fallocate with FALLOC_FL_UNSHARE_RANGE flag as described in the +.BR fallocate (2) +manual page to unshare all shared blocks within the range. +.TP +.BI "fzero [ \-k ]" " offset length" +Call fallocate with FALLOC_FL_ZERO_RANGE flag as described in the +.BR fallocate (2) +manual page to allocate and zero blocks within the range. +With the +.B -k +option, use the FALLOC_FL_KEEP_SIZE flag as well. +.TP +.BI zero " offset length" +Call xfsctl with +.B XFS_IOC_ZERO_RANGE +as described in the +.BR xfsctl (3) +manual page to allocate and zero blocks within the range. +.TP +.BI truncate " offset" +Truncates the current file at the given offset using +.BR ftruncate (2). +.TP +.BI "sendfile [ \-q ] \-i " srcfile " | \-f " N " [ " "offset length " ] +On platforms which support it, allows a direct in-kernel copy between +two file descriptors. The current open file is the target, the source +must be specified as another open file +.RB ( \-f ) +or by path +.RB ( \-i ). +.RS 1.0i +.B \-q +quiet mode, do not write anything to standard output. +.RE +.TP +.BI "readdir [ -v ] [ -o " offset " ] [ -l " length " ] " +Read a range of directory entries from a given offset of a directory. +.RS 1.0i +.PD 0 +.TP 0.4i +.B \-v +verbose mode - dump dirent content as defined in +.BR readdir (3) +.TP +.B \-o +specify starting +.I offset +.TP +.B \-l +specify total +.I length +to read (in bytes) +.RE +.PD +.TP +.BI "seek \-a | \-d | \-h [ \-r ] [ \-s ] offset" +On platforms that support the +.BR lseek (2) +.B SEEK_DATA +and +.B SEEK_HOLE +options, display the offsets of the specified segments. +.RS 1.0i +.PD 0 +.TP 0.4i +.B \-a +Display both +.B data +and +.B hole +segments starting at the specified +.B offset. +.TP +.B \-d +Display the +.B data +segment starting at the specified +.B offset. +.TP +.B \-h +Display the +.B hole +segment starting at the specified +.B offset. +.TP +.B \-r +Recursively display all the specified segments starting at the specified +.B offset. +.TP +.B \-s +Display the starting lseek(2) offset. This offset will be a calculated value when +both data and holes are displayed together or performing a recusively display. +.RE +.PD +.TP +.BI "reflink [ \-C ] [ \-q ] src_file [src_offset dst_offset length]" +On filesystems that support the +.B FICLONERANGE +or +.B BTRFS_IOC_CLONE_RANGE +ioctls, map +.I length +bytes at offset +.I dst_offset +in the open file to the same physical blocks that are mapped at offset +.I src_offset +in the file +.I src_file +, replacing any contents that may already have been there. If a program +writes into a reflinked block range of either file, the dirty blocks will be +cloned, written to, and remapped ("copy on write") in the affected file, +leaving the other file(s) unchanged. If src_offset, dst_offset, and length +are omitted, all contents of src_file will be reflinked into the open file. +.RS 1.0i +.PD 0 +.TP 0.4i +.B \-C +Print timing statistics in a condensed format. +.TP +.B \-q +Do not print timing statistics at all. +.RE +.PD +.TP +.BI "dedupe [ \-C ] [ \-q ] src_file src_offset dst_offset length" +On filesystems that support the +.B FIDEDUPERANGE +or +.B BTRFS_IOC_FILE_EXTENT_SAME +ioctls, map +.I length +bytes at offset +.I dst_offset +in the open file to the same physical blocks that are mapped at offset +.I src_offset +in the file +.I src_file +, but only if the contents of both ranges are identical. This is known as +block-based deduplication. If a program writes into a reflinked block range of +either file, the dirty blocks will be cloned, written to, and remapped ("copy +on write") in the affected file, leaving the other file(s) unchanged. +.RS 1.0i +.PD 0 +.TP 0.4i +.B \-C +Print timing statistics in a condensed format. +.TP +.B \-q +Do not print timing statistics at all. +.RE +.PD +.TP +.BI "copy_range [ -s " src_offset " ] [ -d " dst_offset " ] [ -l " length " ] src_file | \-f " N +On filesystems that support the +.BR copy_file_range (2) +system call, copies data from the source file into the current open file. +The source must be specified either by path +.RB ( src_file ) +or as another open file +.RB ( \-f ). +If +.I length +is not specified, this command copies data from +.I src_offset +to the end of +.BI src_file +into the dst_file at +.IR dst_offset . +.RS 1.0i +.PD 0 +.TP 0.4i +.B \-s +Copy data from +.I src_file +beginning from +.IR src_offset . +.TP +.B \-d +Copy data into the open file beginning at +.IR dst_offset . +.TP +.B \-l +Copy up to +.I length +bytes of data. +.RE +.PD +.TP +.BI swapext " donor_file " +Swaps extent forks between files. The current open file is the target. The donor +file is specified by path. Note that file data is not copied (file content moves +with the fork(s)). +.TP +.BI "set_encpolicy [ \-c " mode " ] [ \-n " mode " ] [ \-f " flags " ] [ \-v " version " ] [ " keyspec " ]" +On filesystems that support encryption, assign an encryption policy to the +current file. +.I keyspec +is a hex string which specifies the encryption key to use. For v1 encryption +policies, +.I keyspec +must be a 16-character hex string (8 bytes). For v2 policies, +.I keyspec +must be a 32-character hex string (16 bytes). If unspecified, an all-zeroes +value is used. +.RS 1.0i +.PD 0 +.TP 0.4i +.BI \-c " mode" +contents encryption mode (e.g. AES-256-XTS) +.TP +.BI \-n " mode" +filenames encryption mode (e.g. AES-256-CTS) +.TP +.BI \-f " flags" +policy flags (numeric) +.TP +.BI \-v " version" +policy version. Defaults to 1 or 2 depending on the length of +.IR keyspec ; +or to 1 if +.I keyspec +is unspecified. +.RE +.PD +.TP +.BI "get_encpolicy [ \-1 ] [ \-t ]" +On filesystems that support encryption, display the encryption policy of the +current file. +.RS 1.0i +.PD 0 +.TP 0.4i +.BI \-1 +Use only the old ioctl to get the encryption policy. This only works if the +file has a v1 encryption policy. +.TP +.BI \-t +Test whether v2 encryption policies are supported. Prints "supported", +"unsupported", or an error message. +.RE +.PD +.TP +.BI "add_enckey [ \-d " descriptor " ] [ \-k " key_id " ]" +On filesystems that support encryption, add an encryption key to the filesystem +containing the currently open file. By default, the raw key in binary +(typically 64 bytes long) is read from standard input. +.RS 1.0i +.PD 0 +.TP 0.4i +.BI \-d " descriptor" +key descriptor, as a 16-character hex string (8 bytes). If given, the key will +be available for use by v1 encryption policies that use this descriptor. +Otherwise, the key is added as a v2 policy key, and on success the resulting +"key identifier" will be printed. +.TP +.BI \-k " key_id" +ID of kernel keyring key of type "fscrypt-provisioning". If given, the raw key +will be taken from here rather than from standard input. +.RE +.PD +.TP +.BI "rm_enckey [ -a ] " keyspec +On filesystems that support encryption, remove an encryption key from the +filesystem containing the currently open file. +.I keyspec +is a hex string specifying the key to remove, as a 16-character "key descriptor" +or a 32-character "key identifier". +.RS 1.0i +.PD 0 +.TP 0.4i +.BI \-a +Remove the key for all users who have added it, not just the current user. This +is a privileged operation. +.RE +.PD +.TP +.BI "enckey_status " keyspec +On filesystems that support encryption, display the status of an encryption key. +.I keyspec +is a hex string specifying the key for which to display the status, as a +16-character "key descriptor" or a 32-character "key identifier". +.TP +.BR lsattr " [ " \-R " | " \-D " | " \-a " | " \-v " ]" +List extended inode flags on the currently open file. If the +.B \-R +option is specified, a recursive descent is performed +for all directory entries below the currently open file +.RB ( \-D +can be used to restrict the output to directories only). +This is a depth first descent, it does not follow symlinks and +it also does not cross mount points. + +The current inode flag letters are documented below. +Please refer to the +.BR ioctl_xfs_fsgetxattr "(2)" +documentation for more details about what they mean. + +.PD 0 +.RS +.TP 0.5i +.B r +realtime file (XFS_XFLAG_REALTIME) + +.TP +.B p +prealloc (XFS_XFLAG_PREALLOC) + +.TP +.B i +immutable (XFS_XFLAG_IMMUTABLE) + +.TP +.B a +append only (XFS_XFLAG_APPEND) + +.TP +.B s +synchronous file writes (XFS_XFLAG_SYNC) + +.TP +.B A +noatime (XFS_XFLAG_NOATIME) + +.TP +.B d +nodump (XFS_XFLAG_NODUMP) + +.TP +.B t +inherit realtime flag (XFS_XFLAG_RTINHERIT)" + +.TP +.B P +inherit project id (XFS_XFLAG_PROJINHERIT) + +.TP +.B n +no symlink creation (XFS_XFLAG_NOSYMLINKS) + +.TP +.B e +extent size hint (XFS_XFLAG_EXTSIZE) + +.TP +.B E +inherit extent size hint (XFS_XFLAG_EXTSZINHERIT) + +.TP +.B f +nodefrag (XFS_XFLAG_NODEFRAG) + +.TP +.B S +filestream allocator (XFS_XFLAG_FILESTREAM) + +.TP +.B x +direct access persistent memory (XFS_XFLAG_DAX) + +.TP +.B C +copy on write extent hint (XFS_XFLAG_COWEXTSIZE) + +.TP +.B X +has extended attributes (XFS_XFLAG_HASATTR) +.RE + +.TP +.BR chattr " [ " \-R " | " \-D " ] [ " + / \-riasAdtPneEfSxC " ]" +Change extended inode flags on the currently open file. The +.B \-R +and +.B \-D +options have the same meaning as above. + +See the +.B lsattr +command above for the list of inode flag letters. + +.TP +.BI "flink " path +Link the currently open file descriptor into the filesystem namespace. +.TP +.BR stat " [ " \-v "|" \-r " ]" +Selected statistics from +.BR stat (2) +and the XFS_IOC_GETXATTR system call on the current file. If the +.B \-v +option is specified, the atime (last access), mtime +(last modify), and ctime (last change) timestamps are also displayed. The +.B \-r +option dumps raw fields from the stat structure. +.TP +.BI "statx [ \-v|\-r ][ \-m " basic " | \-m " all " | -m " <mask> " ][ \-FD ]" +Selected statistics from +.BR stat (2) +and the XFS_IOC_GETXATTR system call on the current file. +.RS 1.0i +.PD 0 +.TP 0.4i +.B \-v +Show timestamps. +.TP +.B \-r +Dump raw statx structure values. +.TP +.B \-m basic +Set the field mask for the statx call to STATX_BASIC_STATS. +.TP +.B \-m all +Set the the field mask for the statx call to STATX_ALL (default). +.TP +.B \-m <mask> +Specify a numeric field mask for the statx call. +.TP +.B \-F +Force the attributes to be synced with the server. +.TP +.B \-D +Don't sync attributes with the server. +.PD +.RE +.TP +.BR chproj " [ " \-R | \-D " ]" +Modifies the project identifier associated with the current path. The +.B \-R +option will recursively descend if the current path is a directory. The +.B \-D +option will also recursively descend, only setting modifying projects +on subdirectories. See the +.BR xfs_quota (8) +manual page for more information about project identifiers. +.TP +.BR lsproj " [ " \-R | \-D " ]" +Displays the project identifier associated with the current path. The +.B \-R +and +.B \-D +options behave as described above, in +.B chproj. +.TP +.BR parent " [ " \-cpv " ]" +By default this command prints out the parent inode numbers, +inode generation numbers and basenames of all the hardlinks which +point to the inode of the current file. +.RS 1.0i +.PD 0 +.TP 0.4i +.B \-p +the output is similar to the default output except pathnames up to +the mount-point are printed out instead of the component name. +.TP +.B \-c +the file's filesystem will check all the parent attributes for consistency. +.TP +.B \-v +verbose output will be printed. +.RE +.IP +.B [NOTE: Not currently operational on Linux.] +.RE +.PD +.TP +.BI utimes " atime_sec atime_nsec mtime_sec mtime_nsec" +The utimes command changes the atime and mtime of the current file. +sec uses UNIX timestamp notation and is the seconds elapsed since +1970-01-01 00:00:00 UTC. +nsec is the nanoseconds since the sec. This value needs to be in +the range 0-999999999 with UTIME_NOW and UTIME_OMIT being exceptions. +Each (sec, nsec) pair constitutes a single timestamp value. + + +.SH MEMORY MAPPED I/O COMMANDS +.TP +.BI "mmap [ " N " | [[ \-rwxS ] [\-s " size " ] " "offset length " ]] +With no arguments, +.B mmap +shows the current mappings. Specifying a single numeric argument +.I N +sets the current mapping. If two arguments are specified (a range specified by +.I offset +and +.IR length ), +a new mapping is created spanning the range, and the protection mode can +be given as a combination of PROT_READ +.RB ( \-r ), +PROT_WRITE +.RB ( \-w ), +and PROT_EXEC +.RB ( \-x ). +The mapping will be created with the MAP_SHARED flag by default, or with the +Linux specific (MAP_SYNC | MAP_SHARED_VALIDATE) flags if +.B -S +is given. +.BI \-s " size" +is used to do a mmap(size) && munmap(size) operation at first, try to reserve some +extendible free memory space, if +.I size +is bigger than +.I length +parameter. But there's not guarantee that the memory after +.I length +( up to +.I size +) will stay free. +.B e.g. +"mmap -rw -s 8192 1024" will mmap 0 ~ 1024 bytes memory, but try to reserve 1024 ~ 8192 +free space(no guarantee). This free space will helpful for "mremap 8192" without +MREMAP_MAYMOVE flag. +.TP +.B mm +See the +.B mmap +command. +.TP +.BI "mremap [ \-f <new_address> ] [ \-m ] " new_length +Changes the current mapping size to +.IR new_length . +Whether the mapping may be moved is controlled by the flags passed; +MREMAP_FIXED +.RB ( \-f ), +or MREMAP_MAYMOVE +.RB ( \-m ). +.IR new_length +specifies a page-aligned address to which the mapping must be moved. It +can be set to 139946004389888, 4096k or 1g etc. +.TP +.B mrm +See the +.B mremap +command. +.TP +.B munmap +Unmaps the current memory mapping. +.TP +.B mu +See the +.B munmap +command. +.TP +.BI "mread [ \-f | \-v ] [ \-r ] [" " offset length " ] +Accesses a segment of the current memory mapping, optionally dumping it to +the standard output stream (with +.B \-v +or +.B \-f +option) for inspection. The accesses are performed sequentially from the start +.I offset +by default, but can also be done from the end backwards through the +mapping if the +.B \-r +option in specified. +The two verbose modes differ only in the relative offsets they display, the +.B \-f +option is relative to file start, whereas +.B \-v +shows offsets relative to the start of the mapping. +.TP +.B mr +See the +.B mread +command. +.TP +.BI "mwrite [ \-r ] [ \-S " seed " ] [ " "offset length " ] +Stores a byte into memory for a range within a mapping. +The default stored value is 'X', repeated to fill the range specified, +but this can be changed using the +.B \-S +option. +The memory stores are performed sequentially from the start offset by default, +but can also be done from the end backwards through the mapping if the +.B \-r +option in specified. +.TP +.B mw +See the +.B mwrite +command. +.TP +.BI "msync [ \-i ] [ \-a | \-s ] [ " "offset length " ] +Writes all modified copies of pages over the specified range (or entire +mapping if no range specified) to their backing storage locations. +Also, optionally invalidates +.RB ( \-i ) +so that subsequent references to the pages will be obtained from their +backing storage locations (instead of cached copies). +The flush can be done synchronously +.RB ( \-s) +or asynchronously +.RB ( \-a ). +.TP +.B ms +See the +.B msync +command. +.TP +.BI "madvise [ \-d | \-r | \-s | \-w ] [ " "offset length " ] +Modifies page cache behavior when operating on the current mapping. +The range arguments are required by some advise commands ([*] below). +With no arguments, the POSIX_MADV_NORMAL advice is implied (default readahead). +.RS 1.0i +.PD 0 +.TP 0.4i +.B \-d +the pages will not be needed (POSIX_MADV_DONTNEED[*]). +.TP +.B \-r +expect random page references (POSIX_MADV_RANDOM), which sets readahead to zero. +.TP +.B \-s +expect sequential page references (POSIX_MADV_SEQUENTIAL), +which doubles the default readahead on the file. +.TP +.B \-w +advises the specified pages will be needed again (POSIX_MADV_WILLNEED[*]) +which forces the maximum readahead. +.RE +.PD +.TP +.B mincore +Dumps a list of pages or ranges of pages that are currently in core, +for the current memory mapping. + +.SH FILESYSTEM COMMANDS +.TP +.BI "bulkstat [ \-a " agno " ] [ \-d ] [ \-e " endino " ] [ \-n " batchsize " ] [ \-q ] [ \-s " startino " ] [ \-v " version" ] +Display raw stat information about a bunch of inodes in an XFS filesystem. +Options are as follows: +.RS 1.0i +.PD 0 +.TP +.BI \-a " agno" +Display only results from the given allocation group. +If not specified, all results returned will be displayed. +.TP +.BI \-d +Print debugging information about call results. +.TP +.BI \-e " endino" +Stop displaying records when this inode number is reached. +Defaults to stopping when the system call stops returning results. +.TP +.BI \-n " batchsize" +Retrieve at most this many records per call. +Defaults to 4,096. +.TP +.BI \-q +Run quietly. +Does not parse or output retrieved bulkstat information. +.TP +.BI \-s " startino" +Display inode allocation records starting with this inode. +Defaults to the first inode in the filesystem. +If the given inode is not allocated, results will begin with the next allocated +inode in the filesystem. +.TP +.BI \-v " version" +Use a particular version of the kernel interface. +Currently supported versions are 1 and 5. +.RE +.PD +.TP +.BI "bulkstat_single [ \-d ] [ \-v " version " ] [ " inum... " | " special... " ] +Display raw stat information about individual inodes in an XFS filesystem. +The +.B \-d +and +.B \-v +options are the same as the +.B bulkstat +command. +Arguments must be inode numbers or any of the special values: +.RS 1.0i +.PD 0 +.TP +.B root +Display information about the root directory inode. +.RE +.PD +.TP +.B freeze +Suspend all write I/O requests to the filesystem of the current file. +Only available in expert mode and requires privileges. +.TP +.B thaw +Undo the effects of a filesystem freeze operation. +Only available in expert mode and requires privileges. +.TP +.BI "inject [ " tag " ]" +Inject errors into a filesystem to observe filesystem behavior at +specific points under adverse conditions. Without the +.I tag +argument, displays the list of error tags available. +Only available in expert mode and requires privileges. +.TP +.BI "resblks [ " blocks " ]" +Get and/or set count of reserved filesystem blocks using the +XFS_IOC_GET_RESBLKS or XFS_IOC_SET_RESBLKS system calls. +Note \-\- this can be useful for exercising out of space behavior. +Only available in expert mode and requires privileges. +.TP +.BR shutdown " [ " \-f " ]" +Force the filesystem to shut down, preventing any further IO. +XFS and other filesystems implement this functionality, although implementation +details may differ slightly. +Only available in expert mode and requires privileges. +.PP +.RS +By default, the filesystem will not attempt to flush completed transactions to +disk before shutting down the filesystem. This simulates a disk failure or +crash. +.RE +.RS 1.0i +.PD 0 +.TP 0.4i +.B \-f +Force the filesystem to flush all completed transactions to disk before shutting +down, matching XFS behavior when critical corruption is encountered. +.PD +.RE +.TP +.B statfs [ -c ] [ -g ] [ -s ] +Report selected statistics on the filesystem where the current file resides. +The default behavior is to enable all three reporting options: +.RS 1.0i +.PD 0 +.TP +.BI \-c +Display +.B XFS_IOC_FSCOUNTERS +summary counter data. +.TP +.BI \-g +Display +.B XFS_IOC_FSGEOMETRY +filesystem geometry data. +.TP +.BI \-s +Display +.BR statfs (2) +data. +.TP +.RE +.PD +.TP +.BI "inode [ [ -n ] " number " ] [ -v ]" +The inode command queries physical information about an inode. With +no arguments, it will return 1 or 0, indicating whether or not any +inode numbers greater than 32 bits are currently in use in the filesystem. +If given an inode +.I number +as an argument, the command will return the same inode +.I number +if it is in use, or 0 if not. With +.BI \-n " number" +, the next used inode number after this +.I number +will be returned, or zero if the supplied inode number is the highest one +in use. With +.B \-v +the command will also report the number of bits (32 or 64) used by the +inode +.I number +printed in the result; if no inode +.I number +was specified on the command line, the maximum possible inode number in +the system will be printed along with its size. +.PD +.TP +.BI "inumbers [ \-a " agno " ] [ \-d ] [ \-e " endino " ] [ \-n " batchsize " ] [ \-s " startino " ] [ \-v " version " ] +Prints allocation information about groups of inodes in an XFS filesystem. +Callers can use this information to figure out which inodes are allocated. +Options are as follows: +.RS 1.0i +.PD 0 +.TP +.BI \-a " agno" +Display only results from the given allocation group. +If not specified, all results returned will be displayed. +.TP +.BI \-d +Print debugging information about call results. +.TP +.BI \-e " endino" +Stop displaying records when this inode number is reached. +Defaults to stopping when the system call stops returning results. +.TP +.BI \-n " batchsize" +Retrieve at most this many records per call. +Defaults to 4,096. +.TP +.BI \-s " startino" +Display inode allocation records starting with this inode. +Defaults to the first inode in the filesystem. +If the given inode is not allocated, results will begin with the next allocated +inode in the filesystem. +.TP +.BI \-v " version" +Use a particular version of the kernel interface. +Currently supported versions are 1 and 5. +.RE +.PD +.TP +.BI "scrub " type " [ " agnumber " | " "ino" " " "gen" " ]" +Scrub internal XFS filesystem metadata. The +.BI type +parameter specifies which type of metadata to scrub. +For AG metadata, one AG number must be specified. +For file metadata, the scrub is applied to the open file unless the +inode number and generation number are specified. +.RE +.PD +.TP +.BI "repair " type " [ " agnumber " | " "ino" " " "gen" " ]" +Repair internal XFS filesystem metadata. The +.BI type +parameter specifies which type of metadata to repair. +For AG metadata, one AG number must be specified. +For file metadata, the repair is applied to the open file unless the +inode number and generation number are specified. +.TP +.BI "label" " " "[ -c | -s " label " ] " +On filesystems that support online label manipulation, get, set, or clear the +filesystem label. With no options, print the current filesystem label. The +.B \-c +option clears the filesystem label by setting it to the null string. The +.BI "\-s " label +option sets the filesystem label to +.IR label . +If the label is longer than the filesystem will accept, +.B xfs_io +will print an error message. XFS filesystem labels can be at most 12 +characters long. +.TP +.BI "fsmap [ \-d | \-l | \-r ] [ \-m | \-v ] [ \-n " nx " ] [ " start " ] [ " end " ] +Prints the mapping of disk blocks used by the filesystem hosting the current +file. The map lists each extent used by files, allocation group metadata, +journalling logs, and static filesystem metadata, as well as any +regions that are unused. +Each line of the listings takes the following form: +.PP +.RS +.IR extent ": " major ":" minor " [" startblock .. endblock "]: " owner " " startoffset .. endoffset " " length +.PP +Static filesystem metadata, allocation group metadata, btrees, +journalling logs, and free space are marked by replacing the +.IR startoffset .. endoffset +with the appropriate marker. +All blocks, offsets, and lengths are specified in units of 512-byte +blocks, no matter what the filesystem's block size is. +The optional +.I start +and +.I end +arguments can be used to constrain the output to a particular range of +disk blocks. +If these two options are specified, exactly one of +.BR "-d" ", " "-l" ", or " "-r" +must also be set. +.RE +.RS 1.0i +.PD 0 +.TP +.BI \-d +Display only extents from the data device. +This option only applies for XFS filesystems. +.TP +.BI \-l +Display only extents from the external log device. +This option only applies to XFS filesystems. +.TP +.BI \-r +Display only extents from the realtime device. +This option only applies to XFS filesystems. +.TP +.BI \-m +Display results in a machine readable format (CSV). +This option is not compatible with the +.B \-v +flag. +The columns of the output are: extent number, device major, device minor, +physical start, physical end, owner, offset start, offset end, length. +The start, end, and length numbers are provided in units of 512b. +The owner field is a special string that takes the form: + +.RS 1.0i +.PD 0 +.TP 0.4i +.I inode_%lld_data +for inode data. +.TP +.I inode_%lld_data_bmbt +for inode data extent maps. +.TP +.I inode_%lld_attr +for inode extended attribute data. +.TP +.I inode_%lld_attr_bmbt +for inode extended attribute extent maps. +.TP +.I special_%u:%u +for other filesystem metadata. +.PD +.RE + +.TP +.BI \-n " num_extents" +If this option is given, +.B fsmap +obtains the extent list of the file in groups of +.I num_extents +extents. +In the absence of +.BR "-n" ", " "fsmap" +queries the system for extents in groups of 131,072 records. +.TP +.B \-v +Shows verbose information. +When this flag is specified, additional AG specific information is +appended to each line in the following form: +.IP +.RS 1.2i +.IR agno " (" startagblock .. endagblock ") " nblocks " " flags +.RE +.IP +A second +.B \-v +option will print out the +.I flags +legend. +This option is not compatible with the +.B \-m +flag. +.RE +.PD +.TP +.B fsuuid +Print the mounted filesystem UUID. + + +.SH OTHER COMMANDS +.TP +.BR "help [ " command " ]" +Display a brief description of one or all commands. +.TP +.B print +Display a list of all open files and memory mapped regions. +The current file and current mapping are distinguishable from +any others. +.TP +.B p +See the +.B print +command. +.TP +.B quit +Exit +.BR xfs_io . +.TP +.B q +See the +.B quit +command. +.TP +.BI "log_writes \-d " device " \-m " mark +Create a mark named +.I mark +in the dm-log-writes log specified by +.I device. +This is intended to be equivalent to the shell command: + +.B dmsetup message +.I device +.B 0 mark +.I mark +.PD +.RE +.TP +.B lw +See the +.B log_writes +command. +.TP +.B crc32cselftest +Test the internal crc32c implementation to make sure that it computes results +correctly. +.SH SEE ALSO +.BR mkfs.xfs (8), +.BR xfsctl (3), +.BR xfs_bmap (8), +.BR xfs_db (8), +.BR xfs (5), +.BR fdatasync (2), +.BR fstat (2), +.BR fstatfs (2), +.BR fsync (2), +.BR ftruncate (2), +.BR futimens (3), +.BR mmap (2), +.BR msync (2), +.BR open (2), +.BR pread (2), +.BR pwrite (2), +.BR readdir (3), +.BR dmsetup (8). diff --git a/upstream/opensuse-leap-15-6/man8/xfs_logprint.8 b/upstream/opensuse-leap-15-6/man8/xfs_logprint.8 new file mode 100644 index 00000000..16e881ee --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/xfs_logprint.8 @@ -0,0 +1,108 @@ +.TH xfs_logprint 8 +.SH NAME +xfs_logprint \- print the log of an XFS filesystem +.SH SYNOPSIS +.B xfs_logprint +[ +.I options +] +.I device +.SH DESCRIPTION +.B xfs_logprint +prints the log of an XFS filesystem (see +.BR xfs (5)). +The +.I device +argument is the pathname of the partition or logical volume +containing the filesystem. The +.I device +can be a regular file if the +.B \-f +option is used. The contents of the filesystem remain undisturbed. +There are two major modes of operation in +.BR xfs_logprint . +.PP +One mode is better for filesystem operation debugging. +It is called the transactional view and is enabled through the +.B \-t +option. The transactional view prints only the portion of the log that +pertains to recovery. In other words, it prints out complete transactions +between the tail and the head. This view tries to display each transaction +without regard to how they are split across log records. +.PP +The second mode starts printing out information from the beginning of the log. +Some error blocks might print out in the beginning because the last log +record usually overlaps the oldest log record. A message is +printed when the physical end of the log is reached and when the +logical end of the log is reached. A log record view is displayed +one record at a time. Transactions that span log records may not be +decoded fully. +.SH OPTIONS +.TP +.B \-b +Extract and print buffer information. Only used in transactional view. +.TP +.B \-c +Attempt to continue when an error is detected. +.TP +.BI \-C " filename" +Copy the log from the filesystem to the file +.IR filename . +The log itself is not printed. +.TP +.B \-d +Dump the log from front to end, printing where each log record is located +on disk. +.TP +.B \-D +Do not decode anything; just print data. +.TP +.B \-e +Exit when an error is found in the log. Normally, +.B xfs_logprint +tries to continue and unwind from bad logs. +However, sometimes it just dies in bad ways. +Using this option prevents core dumps. +.TP +.B \-f +Specifies that the filesystem image to be processed is stored in a +regular file at +.I device +(see the +.BR mkfs.xfs "(8) " -d +.I file +option). +This might happen if an image copy of a filesystem has been made into +an ordinary file with +.BR xfs_copy (8). +.TP +.BI \-l " logdev" +External log device. Only for those filesystems which use an external log. +.TP +.B \-i +Extract and print inode information. Only used in transactional view. +.TP +.B \-q +Extract and print quota information. Only used in transactional view. +.TP +.B \-n +Do not try and interpret log data; just interpret log header information. +.TP +.B \-o +Also print buffer data in hex. +Normally, buffer data is just decoded, so better information can be printed. +.TP +.BI \-s " start-block" +Override any notion of where to start printing. +.TP +.B \-t +Print out the transactional view. +.TP +.B \-v +Print "overwrite" data. +.TP +.B \-V +Prints the version number and exits. +.SH SEE ALSO +.BR mkfs.xfs (8), +.BR mount (8). diff --git a/upstream/opensuse-leap-15-6/man8/xfs_mdrestore.8 b/upstream/opensuse-leap-15-6/man8/xfs_mdrestore.8 new file mode 100644 index 00000000..72f3b297 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/xfs_mdrestore.8 @@ -0,0 +1,64 @@ +.TH xfs_mdrestore 8 +.SH NAME +xfs_mdrestore \- restores an XFS metadump image to a filesystem image +.SH SYNOPSIS +.B xfs_mdrestore +[ +.B \-gi +] +.I source +.I target +.br +.B xfs_mdrestore +.B \-i +.I source +.br +.B xfs_mdrestore \-V +.SH DESCRIPTION +.B xfs_mdrestore +is a debugging tool that restores a metadata image generated by +.BR xfs_metadump (8) +to a filesystem. The +.I source +argument specifies the location of the metadump image and the +.I target +argument specifies the destination for the filesystem image. +If the +.I source +is \-, then the metadata image is read from stdin. This allows the output of +be another program such as a compression application to be redirected to +.BR xfs_mdrestore . +The +.I target +can be either a file or a device. +.PP +.B xfs_mdrestore +should not be used to restore metadata onto an existing filesystem unless +you are completely certain the +.I target +can be destroyed. +.PP +.SH OPTIONS +.TP +.B \-g +Shows restore progress on stdout. +.TP +.B \-i +Shows metadump information on stdout. If no +.I target +is specified, exits after displaying information. Older metadumps man not +include any descriptive information. +.TP +.B \-V +Prints the version number and exits. +.SH DIAGNOSTICS +.B xfs_mdrestore +returns an exit code of 0 if all the metadata is successfully restored or +1 if an error occurs. +.SH SEE ALSO +.BR xfs_metadump (8), +.BR xfs_repair (8), +.BR xfs (5) +.SH BUGS +Email bug reports to +.BR linux-xfs@vger.kernel.org . diff --git a/upstream/opensuse-leap-15-6/man8/xfs_metadump.8 b/upstream/opensuse-leap-15-6/man8/xfs_metadump.8 new file mode 100644 index 00000000..c0e79d77 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/xfs_metadump.8 @@ -0,0 +1,172 @@ +.TH xfs_metadump 8 +.SH NAME +xfs_metadump \- copy XFS filesystem metadata to a file +.SH SYNOPSIS +.B xfs_metadump +[ +.B \-aefFgow +] [ +.B \-m +.I max_extents +] [ +.B \-l +.I logdev +] +.I source +.I target +.br +.B xfs_metadump \-V +.SH DESCRIPTION +.B xfs_metadump +is a debugging tool that copies the metadata from an XFS filesystem to a file. +The +.I source +argument must be the pathname of the device or file +containing the XFS filesystem and the +.I target +argument specifies the destination file name. +If +.I target +is \-, then the output is sent to stdout. This allows the output to be +redirected to another program such as a compression application. +.PP +.B xfs_metadump +may only be used to copy unmounted filesystems, or read-only mounted +filesystems. +.PP +.B xfs_metadump +does not alter the source filesystem in any way. The +.I target +image is a contiguous (non-sparse) file containing all the +filesystem's metadata and indexes to where the blocks were copied from. +.PP +By default, +.B xfs_metadump +obfuscates most file (regular file, directory and symbolic link) names +and extended attribute names to allow the dumps to be sent without +revealing confidential information. Extended attribute values are zeroed +and no data is copied. The only exceptions are file or attribute names +that are 4 or less characters in length. Also file names that span extents +(this can only occur with the +.BR mkfs.xfs (8) +options where +.B \-n +.I size +> +.B \-b +.IR size ) +are not obfuscated. Names between 5 and 8 characters in length inclusively +are partially obfuscated. +.PP +.B xfs_metadump +cannot obfuscate metadata in the filesystem log. Log +recovery of an obfuscated metadump image may expose clear-text +metadata and/or cause filesystem corruption in the restored image. +It is recommended that the source filesystem first be mounted and +unmounted, if possible, to ensure that the log is clean. +A subsequent invocation of +.B xfs_metadump +will capture a clean log and obfuscate all metadata correctly. +.PP +If a metadump must be produced from a filesystem with a dirty log, +it is recommended that obfuscation be turned off with -o option, if +metadata such as filenames is not considered sensitive. If obfuscation +is required on a metadump with a dirty log, please inform the recipient +of the metadump image about this situation. +.PP +.B xfs_metadump +should not be used for any purposes other than for debugging and reporting +filesystem problems. The most common usage scenario for this tool is when +.BR xfs_repair (8) +fails to repair a filesystem and a metadump image can be sent for +analysis. +.PP +The file generated by +.B xfs_metadump +can be restored to filesystem image (minus the data) using the +.BR xfs_mdrestore (8) +tool. +.PP +.SH OPTIONS +.TP +.B \-a +Copies entire metadata blocks. Normally, +.B xfs_metadump +will zero any stale +bytes interspersed with in-use metadata. Use this option to copy full metadata +blocks, to provide more debugging information for a corrupted filesystem. Note +that the extra data will be unobfuscated. +.TP +.B \-e +Stops the dump on a read error. Normally, it will ignore read errors and copy +all the metadata that is accessible. +.TP +.B \-f +Specifies that the filesystem image to be processed is stored in a regular file +(see the +.B mkfs.xfs -d +file option). This can also happen if an image copy of a filesystem has +been made into an ordinary file with +.BR xfs_copy (8). +.TP +.B \-F +Specifies that we want to continue even if the superblock magic is not correct. +If the source is truly not an XFS filesystem, the resulting image will be useless, +and xfs_metadump may crash. +.TP +.B \-g +Shows dump progress. This is sent to stdout if the +.I target +is a file or to stderr if the +.I target +is stdout. +.TP +.BI \-l " logdev" +For filesystems which use an external log, this specifies the device where the +external log resides. The external log is not copied, only internal logs are +copied. +.TP +.B \-m +Set the maximum size of an allowed metadata extent. Extremely large metadata +extents are likely to be corrupt, and will be skipped if they exceed +this value. The default size is 2097151 blocks. +.TP +.B \-o +Disables obfuscation of file names and extended attributes. +.TP +.B \-w +Prints warnings of inconsistent metadata encountered to stderr. Bad metadata +is still copied. +.TP +.B \-V +Prints the version number and exits. +.SH DIAGNOSTICS +.B xfs_metadump +returns an exit code of 0 if all readable metadata is successfully copied or +1 if a write error occurs or a read error occurs and the +.B \-e +option used. +.SH NOTES +As +.B xfs_metadump +copies metadata only, it does not matter if the +.I source +filesystem has a realtime section or not. If the filesystem has an external +log, it is not copied. Internal logs are copied and any outstanding log +transactions are not obfuscated if they contain names. +.PP +.B xfs_metadump +is a shell wrapper around the +.BR xfs_db (8) +.B metadump +command. +.SH SEE ALSO +.BR xfs_repair (8), +.BR xfs_mdrestore (8), +.BR xfs_freeze (8), +.BR xfs_db (8), +.BR xfs_copy (8), +.BR xfs (5) +.SH BUGS +Email bug reports to +.BR linux-xfs@vger.kernel.org . diff --git a/upstream/opensuse-leap-15-6/man8/xfs_mkfile.8 b/upstream/opensuse-leap-15-6/man8/xfs_mkfile.8 new file mode 100644 index 00000000..abaa4e60 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/xfs_mkfile.8 @@ -0,0 +1,43 @@ +.TH xfs_mkfile 8 +.SH NAME +xfs_mkfile \- create an XFS file +.SH SYNOPSIS +.B xfs_mkfile +[ +.B \-v +] [ +.B \-n +] [ +.B \-p +] +.I size\c +.RB [ k | b | m | g ] +.IR filename " ..." +.br +.B xfs_mkfile \-V +.SH DESCRIPTION +.B xfs_mkfile +creates one or more files. The file is padded with zeroes by default. +The default size is in bytes, but it can be +flagged as kilobytes, blocks, megabytes, or gigabytes with the +.BR k , +.BR b , +.BR m , +or +.B g +suffixes, respectively. +.SH OPTIONS +.TP +.B \-v +Verbose. Report the names and sizes of created files. +.TP +.B \-n +No bytes. Create a holey file - that is, do not write out any data, just +seek to end of file and write a block. +.TP +.B \-p +Preallocate. The file is preallocated, then overwritten with zeroes, +then truncated to the desired size. +.TP +.B \-V +Prints the version number and exits. diff --git a/upstream/opensuse-leap-15-6/man8/xfs_ncheck.8 b/upstream/opensuse-leap-15-6/man8/xfs_ncheck.8 new file mode 100644 index 00000000..5ae72b25 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/xfs_ncheck.8 @@ -0,0 +1,74 @@ +.TH xfs_ncheck 8 +.SH NAME +xfs_ncheck \- generate pathnames from i-numbers for XFS +.SH SYNOPSIS +.B xfs_ncheck +[ +.B \-i +.I ino +] ... [ +.B \-f +] [ +.B \-s +] [ +.B \-l +.I logdev +] +.I device +.br +.B xfs_ncheck \-V +.SH DESCRIPTION +.B xfs_ncheck +with no +.B \-i +arguments generates an inode number and pathname list of all +files on the given filesystem. Names of directory files are followed by +.BR /. . +The output is not sorted in any particular order. +The filesystem to be examined is specified by the +.I device +argument, which should be the disk or volume device for the filesystem. +Filesystems stored in files can also be checked, using the +.B \-f +flag. +.SH OPTIONS +.TP 0.9i +.B \-f +Specifies that the filesystem image to be processed is stored in a +regular file at +.I device +(see the +.B mkfs.xfs \-d +.I \f2file\f1 +option). This might happen if an image copy +of a filesystem has been made into an ordinary file. +.TP +.BI \-l " logdev" +Specifies the device where the filesystem's external log resides. +Only for those filesystems which use an external log. See the +.B mkfs.xfs \-l +option, and refer to +.BR xfs (5) +for a detailed description of the XFS log. +.TP +.B \-s +Limits the report to special files and files with setuserid mode. +This option may be used to detect violations of security policy. +.TP +.BI \-i " ino" +Limits the report to only those files whose inode numbers follow. +May be given multiple times to select multiple inode numbers. +.TP +.B \-V +Prints the version number and exits. +.PP +If the filesystem is seriously corrupted, or very busy and looks +like it is corrupt, a message of the form that would be generated by the +.BR xfs_db (8) +"check" command may appear. +.PP +.B xfs_ncheck +is only useful with XFS filesystems. +.SH SEE ALSO +.BR mkfs.xfs (8), +.BR xfs (5). diff --git a/upstream/opensuse-leap-15-6/man8/xfs_quota.8 b/upstream/opensuse-leap-15-6/man8/xfs_quota.8 new file mode 100644 index 00000000..840bc598 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/xfs_quota.8 @@ -0,0 +1,779 @@ +.TH xfs_quota 8 +.SH NAME +xfs_quota \- manage use of quota on XFS filesystems +.SH SYNOPSIS +.B xfs_quota +[ +.B \-x +] [ +.B \-f +] [ +.B \-p +.I prog +] [ +.B \-c +.I cmd +] ... [ +.B \-d +.I project +] ... [ +.B \-D +.I projects_file +] [ +.B \-P +.I projid_file +] [ +.IR path " ... ]" +.br +.B xfs_quota \-V +.SH DESCRIPTION +.B xfs_quota +is a utility for reporting and editing various aspects of filesystem quota. +.PP +The options to +.B xfs_quota +are: +.TP 1.0i +.BI \-c " cmd" +.B xfs_quota +commands may be run interactively (the default) or as arguments on +the command line. Multiple +.B \-c +arguments may be given. +The commands are run in the sequence given, then the program exits. +.TP +.BI \-p " prog" +Set the program name for prompts and some error messages, +the default value is +.BR xfs_quota . +.TP +.B \-x +Enable expert mode. +All of the administrative commands (see the ADMINISTRATOR COMMANDS +section below) which allow modifications to the quota system are +available only in expert mode. +.TP +.B \-f +Enable foreign filesystem mode. +A limited number of user and administrative commands are available for +use on some foreign (non-XFS) filesystems. +.TP +.BI \-d " project" +Project names or numeric identifiers may be specified with this option, +which restricts the output of the individual +.B xfs_quota +commands to the set of projects specified. Multiple +.B \-d +arguments may be given. +.TP +.BI \-D " projects_file" +Specify a file containing the mapping of numeric project identifiers +to directory trees. +.I /etc/projects +as default, if this option is none. +.TP +.BI \-P " projid_file" +Specify a file containing the mapping of numeric project identifiers +to project names. +.I /etc/projid +as default, if this option is none. +.TP +.B \-V +Prints the version number and exits. +.PP +The optional +.I path +argument(s) can be used to specify mount points or device files +which identify XFS filesystems. The output of the individual +.B xfs_quota +commands will then be restricted to the set of filesystems specified. +.PP +This manual page is divided into two sections \- firstly, +information for users of filesystems with quota enabled, and the +.B xfs_quota +commands of interest to such users; and then information which is +useful only to administrators of XFS filesystems using quota and the +quota commands which allow modifications to the quota system. +.PP +Note that common to almost all of the individual commands described +below are the options for specifying which quota types are of interest +\- user quota +.RB ( \-u ), +group quota +.RB ( \-g ), +and/or project quota +.RB ( \-p ). +Also, several commands provide options to operate on "blocks used" +.RB ( \-b ), +"inodes used" +.RB ( \-i ), +and/or "realtime blocks used" +.RB ( \-r ). +.PP +Many commands also have extensive online help. Use the +.B help +command for more details on any command. +.SH QUOTA OVERVIEW +.PP +In most computing environments, disk space is not infinite. +The quota subsystem provides a mechanism to control usage of disk space. +Quotas can be set for each individual user on any/all of the local +filesystems. +The quota subsystem warns users when they exceed their allotted limit, +but allows some extra space for current work (hard limit/soft limit). +In addition, XFS filesystems with limit enforcement turned off can be +used as an effective disk usage accounting system. +.SS Users' View of Disk Quotas +To most users, disk quotas are either of no concern or a fact of life +that cannot be avoided. +There are two possible quotas that can be imposed \- a limit can be set +on the amount of space a user can occupy, and there may be a limit on +the number of files (inodes) they can own. +.PP +The +.B quota +command provides information on the quotas that have been +set by the system administrators and current usage. +.PP +There are four numbers for each limit: current usage, soft limit +(quota), hard limit, and time limit. +The soft limit is the number of 1K-blocks (or files) that the user is +expected to remain below. +The hard limit cannot be exceeded. +If a user's usage reaches the hard limit, further requests for space +(or attempts to create a file) fail with the "Quota exceeded" (EDQUOT) +error. +.PP +When a user exceeds the soft limit, the timer is enabled. +Any time the quota drops below the soft limits, the timer is disabled. +If the timer pops, the particular limit that has been exceeded is treated +as if the hard limit has been reached, and no more resources are allocated +to the user. +The only way to reset this condition, short of turning off limit +enforcement or increasing the limit, is to reduce usage below quota. +Only the superuser (i.e. a sufficiently capable process) can set the +time limits and this is done on a per filesystem basis. +.SS Surviving When the Quota Limit Is Reached +In most cases, the only way for a user to recover from over-quota +conditions is to abort whatever activity is in progress on the filesystem +that has reached its limit, remove sufficient files to bring the limit +back below quota, and retry the failed program. +.br +However, if a user is in the editor and a write fails because of an over +quota situation, that is not a suitable course of action. +It is most likely that initially attempting to write the file has truncated +its previous contents, so if the editor is aborted without correctly writing +the file, not only are the recent changes lost, but possibly much, or even +all, of the contents that previously existed. +.br +There are several possible safe exits for a user caught in this situation. +They can use the editor shell escape command to examine their file space +and remove surplus files. Alternatively, using +.BR sh (1), +they can suspend +the editor, remove some files, then resume it. +A third possibility is to write the file to some other filesystem (perhaps +to a file on +.IR /tmp ) +where the user's quota has not been exceeded. +Then after rectifying the quota situation, the file can be moved back to the +filesystem it belongs on. +.SS Default Quotas +The XFS quota subsystem allows a default quota to be enforced +for any user, group or project which does not have a quota limit +explicitly set. +These limits are stored in and displayed as ID 0's limits, although they +do not actually limit ID 0. +.SH USER COMMANDS +.TP +.B print +Lists all paths with devices/project identifiers. +The path list can come from several places \- the command line, +the mount table, and the +.I /etc/projects +file. +.TP +.B df +See the +.B free +command. +.HP +.B quota +[ +.BR \-g " | " \-p " | " \-u +] [ +.B \-bir +] [ +.B \-hnNv +] [ +.B \-f +.I file +] [ +.I ID +| +.I name +] ... +.br +Show individual usage and limits, for a single user +.I name +or numeric user +.IR ID . +The +.B \-h +option reports in a "human-readable" format similar to the +.BR df (1) +command. The +.B \-n +option reports the numeric IDs rather than the name. The +.B \-N +option omits the header. The +.B \-v +option outputs verbose information. The +.B \-f +option sends the output to +.I file +instead of stdout. +.HP +.B free +[ +.B \-bir +] [ +.B \-hN +] [ +.B \-f +.I file +] +.br +Reports filesystem usage, much like the +.BR df (1) +utility. +It can show usage for +.BR b locks, +.BR i node, +and/or +.BR r ealtime +block space, and shows used, free, and total available. +If project quota are in use (see the DIRECTORY TREE QUOTA section below), +it will also report utilisation for those projects (directory trees). The +.B \-h +option reports in a "human-readable" format. The +.B \-N +option omits the header. The +.B \-f +option outputs the report to +.I file +instead of stdout. +.HP +.B help +[ +.I command +] +.br +Online help for all commands, or one specific +.IR command . +.TP +.B quit +Exit +.BR xfs_quota . +.TP +.B q +See the +.B quit +command. +.SH QUOTA ADMINISTRATION +The XFS quota system differs to that of other filesystems +in a number of ways. +Most importantly, XFS considers quota information as +filesystem metadata and uses journaling to provide a higher level +guarantee of consistency. +As such, it is administered differently, in particular: +.IP 1. +The +.B quotacheck +command has no effect on XFS filesystems. +The first time quota accounting is turned on (at mount time), XFS does +an automatic quotacheck internally; afterwards, the quota system will +always be completely consistent until quotas are manually turned off. +.IP 2. +There is no need for quota file(s) in the root of the XFS filesystem. +.IP 3. +XFS distinguishes between quota accounting and limit enforcement. +Quota accounting must be turned on at the time of mounting the XFS +filesystem. +However, it is possible to turn on/off limit enforcement any time +quota accounting is turned on. +The "quota" option to the +.B mount +command turns on both (user) quota accounting and enforcement. +The "uqnoenforce" option must be used to turn on user accounting with +limit enforcement disabled. +.IP 4. +Turning on quotas on the root filesystem is slightly different from +the above. +For Linux XFS, the quota mount flags must be passed in with the +"rootflags=" boot parameter. +.IP 5. +It is useful to use the +.B state +to monitor the XFS quota subsystem +at various stages \- it can be used to see if quotas are turned on, +and also to monitor the space occupied by the quota system itself.. +.IP 6. +There is a mechanism built into +.B xfsdump +that allows quota limit information to be backed up for later +restoration, should the need arise. +.IP 7. +Quota limits cannot be set before turning on quotas on. +.IP 8. +XFS filesystems keep quota accounting on the superuser (user ID zero), +and the tool will display the superuser's usage information. +However, limits are never enforced on the superuser (nor are they +enforced for group and project ID zero). +.IP 9. +XFS filesystems perform quota accounting whether the user has quota +limits or not. +.IP 10. +XFS supports the notion of project quota, which can be used to +implement a form of directory tree quota (i.e. to restrict a +directory tree to only being able to use up a component of the +filesystems available space; or simply to keep track of the +amount of space used, or number of inodes, within the tree). +.SH ADMINISTRATOR COMMANDS +.HP +.B path +[ +.I N +] +.br +Lists all paths with devices/project identifiers or set the current +path to the +.IR N th +list entry (the current path is used by many +of the commands described here, it identifies the filesystem toward +which a command is directed). +The path list can come from several places \- the command line, +the mount table, and the +.I /etc/projects +file. +.HP +.B report +[ +.B \-gpu +] [ +.B \-bir +] [ +.B \-ahntlLNU +] [ +.B \-f +.I file +] +.br +Report filesystem quota information. +This reports all quota usage for a filesystem, for the specified +quota type +.RB ( u / g / p +and/or +.BR b locks/ i nodes/ r ealtime). +It reports blocks in 1KB units by default. The +.B \-h +option reports in a "human-readable" format similar to the +.BR df (1) +command. The +.B \-f +option outputs the report to +.I file +instead of stdout. The +.B \-a +option reports on all filesystems. By default, outputs the name of +the user/group/project. If no name is defined for a given ID, outputs +the numeric ID instead. The +.B \-n +option outputs the numeric ID instead of the name. The +.B \-L +and +.B \-U +options specify lower and/or upper ID bounds to report on. If upper/lower +bounds are specified, then by default only the IDs will be displayed +in output; with the +.B \-l +option, a lookup will be performed to translate these IDs to names. The +.B \-N +option reports information without the header line. The +.B \-t +option performs a terse report. +.HP +.B state +[ +.B \-gpu +] [ +.B \-av +] [ +.B \-f +.I file +] +.br +Report overall quota state information. +This reports on the state of quota accounting, quota enforcement, +and the number of extents being used by quota metadata within the +filesystem. The +.B \-f +option outputs state information to +.I file +instead of stdout. The +.B \-a +option reports state on all filesystems and not just the current path. +.HP +.B limit +[ +.BR \-g " | " \-p " | " \-u +] +.BI bsoft= N +| +.BI bhard= N +| +.BI isoft= N +| +.BI ihard= N +| +.BI rtbsoft= N +| +.BI rtbhard= N +.B \-d +| +.I id +| +.I name +.br +Set quota block limits (bhard/bsoft), inode count limits (ihard/isoft) +and/or realtime block limits (rtbhard/rtbsoft) to N, where N is a +number representing bytes or inodes. +For block limits, a number with a s/b/k/m/g/t/p/e multiplication suffix +as described in +.BR mkfs.xfs (8) +is also accepted. +For inode limits, no suffixes are allowed. +The +.B \-d +option (defaults) can be used to set the default value +that will be used, otherwise a specific +.BR u ser/ g roup/ p roject +.I name +or numeric +.IR id entifier +must be specified. +.HP +.B timer +[ +.BR \-g " | " \-p " | " \-u +] [ +.B \-bir +] +.I value +[ +.B -d +| +.I id +| +.I name +] +.br +Allows the quota enforcement timeout (i.e. the amount of time allowed +to pass before the soft limits are enforced as the hard limits) to +be modified. The current timeout setting can be displayed using the +.B state +command. +.br +When setting the default timer via the +.B \-d +option, or for +.B id +0, or if no argument is given after +.I value +the +.I value +argument is a number of seconds indicating the relative amount of time after +soft limits are exceeded, before hard limits are enforced. +.br +When setting any other individual timer by +.I id +or +.I name, +the +.I value +is the number of seconds from now, at which time the hard limits will be enforced. +This allows extending the grace time of an individual user who has exceeded soft +limits. +.br +For +.I value, +units of \&'minutes', 'hours', 'days', and 'weeks' are also understood +(as are their abbreviations 'm', 'h', 'd', and 'w'). +.br +.HP +.B warn +[ +.BR \-g " | " \-p " | " \-u +] [ +.B \-bir +] +.I value +.B -d +| +.I id +| +.I name +.br +Allows the quota warnings limit (i.e. the number of times a warning +will be send to someone over quota) to be viewed and modified. The +.B \-d +option (defaults) can be used to set the default time +that will be used, otherwise a specific +.BR u ser/ g roup/ p roject +.I name +or numeric +.IR id entifier +must be specified. +.B NOTE: this feature is not currently implemented. +.TP +.BR enable " [ " \-gpu " ] [ " \-v " ]" +Switches on quota enforcement for the filesystem identified by the +current path. +This requires the filesystem to have been mounted with quota enabled, +and for accounting to be currently active. The +.B \-v +option (verbose) displays the state after the operation has completed. +.TP +.BR disable " [ " \-gpu " ] [ " \-v " ]" +Disables quota enforcement, while leaving quota accounting active. The +.B \-v +option (verbose) displays the state after the operation has completed. +.TP +.BR off " [ " \-gpu " ] [ " \-v " ]" +Permanently switches quota off for the filesystem identified by the +current path. +Quota can only be switched back on subsequently by unmounting and +then mounting again. +.TP +.BR remove " [ " \-gpu " ] [ " \-v " ]" +Remove any space allocated to quota metadata from the filesystem +identified by the current path. +Quota must not be enabled on the filesystem, else this operation will +report an error. +.HP +.B dump +[ +.BR \-g " | " \-p " | " \-u +] [ +.BR \-L " | " \-U +] [ +.B \-f +.I file +] +.br +Dump out quota limit information for backup utilities, either to +standard output (default) or to a +.IR file . +The +.B \-L +and +.B \-U +options specify lower and/or upper ID bounds to dump. +This is only the limits, not the usage information, of course. +.HP +.B restore +[ +.BR \-g " | " \-p " | " \-u +] [ +.B \-f +.I file +] +.br +Restore quota limits from a backup +.IR file . +The file must be in the format produced by the +.B dump +command. +.HP +.B quot +[ +.BR \-g " | " \-p " | " \-u +] [ +.B \-bir +] [ +.B \-acnv +] [ +.B \-f +.I file +] +.br +Summarize filesystem ownership, by user, group or project. +This command uses a special XFS "bulkstat" interface to quickly scan +an entire filesystem and report usage information. +This command can be used even when filesystem quota are not enabled, +as it is a full-filesystem scan (it may also take a long time...). The +.B \-a +option displays information on all filesystems. The +.B \-c +option displays a histogram instead of a report. The +.B \-n +option displays numeric IDs rather than names. The +.B \-v +option displays verbose information. The +.B \-f +option send the output to +.I file +instead of stdout. +.HP +.B project +[ +.B \-cCs +[ +.B \-d +.I depth +] +[ +.B \-p +.I path +] +.I id +| +.I name +] +.br +The +.BR \-c , +.BR \-C , +and +.B \-s +options allow the directory tree quota mechanism to be maintained. +.BR \-d +allows one to limit recursion level when processing project directories +and +.BR \-p +allows one to specify project paths at command line ( instead of +.I /etc/projects +). All options are discussed in detail below. +.SH DIRECTORY TREE QUOTA +The project quota mechanism in XFS can be used to implement a form of +directory tree quota, where a specified directory and all of the files +and subdirectories below it (i.e. a tree) can be restricted to using +a subset of the available space in the filesystem. +.PP +A managed tree must be setup initially using the +.B \-s +option to the +.B project +command. The specified project name or identifier is matched to one +or more trees defined in +.IR /etc/projects , +and these trees are then recursively descended +to mark the affected inodes as being part of that tree. +This process sets an inode flag and the project identifier on every file +in the affected tree. +Once this has been done, new files created in the tree will automatically +be accounted to the tree based on their project identifier. +An attempt to create a hard link to a file in the tree will only succeed +if the project identifier matches the project identifier for the tree. +The +.B xfs_io +utility can be used to set the project ID for an arbitrary file, but this +can only be done by a privileged user. +.PP +A previously setup tree can be cleared from project quota control through +use of the +.B project \-C +option, which will recursively descend +the tree, clearing the affected inodes from project quota control. +.PP +Finally, the +.B project \-c +option can be used to check whether a +tree is setup, it reports nothing if the tree is correct, otherwise it +reports the paths of inodes which do not have the project ID of the rest +of the tree, or if the inode flag is not set. +.PP +Option +.B \-d +can be used to limit recursion level (\-1 is infinite, 0 is top level only, +1 is first level ... ). +Option +.B \-p +adds possibility to specify project paths in command line without a need +for +.I /etc/projects +to exist. Note that if projects file exists then it is also used. + +.SH EXAMPLES +Enabling quota enforcement on an XFS filesystem (restrict a user +to a set amount of space). +.nf +.sp +.in +5 +# mount \-o uquota /dev/xvm/home /home +# xfs_quota \-x \-c 'limit bsoft=500m bhard=550m tanya' /home +# xfs_quota \-x \-c report /home +.in -5 +.fi +.PP +Enabling project quota on an XFS filesystem (restrict files in +log file directories to only using 1 gigabyte of space). +.nf +.sp +.in +5 +# mount \-o prjquota /dev/xvm/var /var +# echo 42:/var/log >> /etc/projects +# echo logfiles:42 >> /etc/projid +# xfs_quota \-x \-c 'project \-s logfiles' /var +# xfs_quota \-x \-c 'limit \-p bhard=1g logfiles' /var +.in -5 +.fi +.PP +Same as above without a need for configuration files. +.nf +.sp +.in +5 +# rm \-f /etc/projects /etc/projid +# mount \-o prjquota /dev/xvm/var /var +# xfs_quota \-x \-c 'project \-s \-p /var/log 42' /var +# xfs_quota \-x \-c 'limit \-p bhard=1g 42' /var +.in -5 +.fi +.SH CAVEATS +.PP +The XFS allocation mechanism will always reserve the +maximum amount of space required before proceeding with an allocation. +If insufficient space for this reservation is available, due to the +block quota limit being reached for example, this may result in the +allocation failing even though there is sufficient space. +Quota enforcement can thus sometimes happen in situations where the +user is under quota and the end result of some operation would still +have left the user under quota had the operation been allowed to run +its course. +This additional overhead is typically in the range of tens of blocks. +.PP +Both of these properties are unavoidable side effects of the way XFS +operates, so should be kept in mind when assigning block limits. +.SH BUGS +Quota support for filesystems with realtime subvolumes is not yet +implemented, nor is the quota warning mechanism (the Linux +.BR warnquota (8) +tool can be used to provide similar functionality on that platform). +.SH FILES +.PD 0 +.TP 20 +.I /etc/projects +Mapping of numeric project identifiers to directories trees. +.TP +.I /etc/projid +Mapping of numeric project identifiers to project names. +.PD + +.SH SEE ALSO +.BR df (1), +.BR mount (1), +.BR sync (2), +.BR projid (5), +.BR projects (5). +.BR xfs (5). +.BR warnquota (8), diff --git a/upstream/opensuse-leap-15-6/man8/xfs_repair.8 b/upstream/opensuse-leap-15-6/man8/xfs_repair.8 new file mode 100644 index 00000000..6625b47a --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/xfs_repair.8 @@ -0,0 +1,601 @@ +.TH xfs_repair 8 +.SH NAME +xfs_repair \- repair an XFS filesystem +.SH SYNOPSIS +.B xfs_repair +[ +.B \-dfLPv +] [ +.BR \-n " | " -e +] [ +.B \-m +.I maxmem +] [ +.BI \-c " subopt" = value +] [ +.B \-o +.I subopt\c +[\c +.B =\c +.IR value ] +] [ +.B \-t +.I interval +] [ +.B \-l +.I logdev +] [ +.B \-r +.I rtdev +] +.I device +.br +.B xfs_repair \-V +.SH DESCRIPTION +.B xfs_repair +repairs corrupt or damaged XFS filesystems +(see +.BR xfs (5)). +The filesystem is specified using the +.I device +argument which should be the device name of the disk partition or +volume containing the filesystem. If given the name of a block device, +.B xfs_repair +will attempt to find the raw device associated +with the specified block device and will use the raw device instead. +.PP +Regardless, the filesystem to be repaired +must be unmounted, +otherwise, the resulting filesystem may be inconsistent or corrupt. +.SH OPTIONS +.TP +.B \-f +Specifies that the filesystem image to be processed is stored in a +regular file at +.I device +(see the +.B mkfs.xfs \-d +.I file +option). This might happen if an image copy +of a filesystem has been copied or written into an ordinary file. +This option implies that any external log or realtime section +is also in an ordinary file. +.TP +.B \-L +Force Log Zeroing. +Forces +.B xfs_repair +to zero the log even if it is dirty (contains metadata changes). +When using this option the filesystem will likely appear to be corrupt, +and can cause the loss of user files and/or data. See the +.B "DIRTY LOGS" +section for more information. +.TP +.BI \-l " logdev" +Specifies the device special file where the filesystem's external +log resides. Only for those filesystems which use an external log. +See the +.B mkfs.xfs \-l +option, and refer to +.BR xfs (5) +for a detailed description of the XFS log. +.TP +.BI \-r " rtdev" +Specifies the device special file where the filesystem's realtime +section resides. Only for those filesystems which use a realtime section. +See the +.B mkfs.xfs \-r +option, and refer to +.BR xfs (5) +for a detailed description of the XFS realtime section. +.TP +.B \-n +No modify mode. Specifies that +.B xfs_repair +should not modify the filesystem but should only scan the +filesystem and indicate what repairs would have been made. This option cannot +be used together with +.BR \-e . +.TP +.B \-P +Disable prefetching of inode and directory blocks. Use this option if +you find +.B xfs_repair +gets stuck and stops proceeding. Interrupting a stuck +.B xfs_repair +is safe. +.TP +.BI \-m " maxmem" +Specifies the approximate maximum amount of memory, in megabytes, to use for +.BR xfs_repair . +.B xfs_repair +has its own internal block cache which will scale out up to the lesser of the +process's virtual address limit or about 75% of the system's physical RAM. +This option overrides these limits. +.IP +.B NOTE: +These memory limits are only approximate and may use more than the specified +limit. +.TP +.BI \-c " subopt" = value +Change filesystem parameters. Refer to +.BR xfs_admin (8) +for information on changing filesystem parameters. +.HP +.B \-o +.I subopt\c +[\c +.B =\c +.IR value ] +.br +Override what the program might conclude about the filesystem +if left to its own devices. +.IP +The +.IR subopt ions +supported are: +.RS 1.0i +.TP +.BI bhash= bhashsize +overrides the default buffer cache hash size. The total number of +buffer cache entries are limited to 8 times this amount. The default +size is set to use up the remainder of 75% of the system's physical +RAM size. +.TP +.BI ag_stride= ags_per_concat_unit +This creates additional processing threads to parallel process +AGs that span multiple concat units. This can significantly +reduce repair times on concat based filesystems. +.TP +.BI force_geometry +Check the filesystem even if geometry information could not be validated. +Geometry information can not be validated if only a single allocation +group exists and thus we do not have a backup superblock available, or +if there are two allocation groups and the two superblocks do not +agree on the filesystem geometry. Only use this option if you validated +the geometry yourself and know what you are doing. If In doubt run +in no modify mode first. +.TP +.BI noquota +Don't validate quota counters at all. +Quotacheck will be run during the next mount to recalculate all values. +.RE +.TP +.B \-t " interval" +Modify reporting interval, specified in seconds. During long runs +.B xfs_repair +outputs its progress every 15 minutes. Reporting is only activated when +ag_stride is enabled. +.TP +.B \-v +Verbose output. May be specified multiple times to increase verbosity. +.TP +.B \-d +Repair dangerously. Allow +.B xfs_repair +to repair an XFS filesystem mounted read only. This is typically done +on a root filesystem from single user mode, immediately followed by a reboot. +.TP +.B \-e +If any metadata corruption was repaired, the status returned is 4 instead of the +usual 0. This option cannot be used together with +.BR \-n . +.TP +.B \-V +Prints the version number and exits. +.SS Checks Performed +The correctness of the crc32c checksum implementation will be tested +before examining the filesystem. +If the test fails, the program will abort. + +Inconsistencies corrected include the following: +.IP 1. +Inode and inode blockmap (addressing) checks: +bad magic number in inode, +bad magic numbers in inode blockmap blocks, +extents out of order, +incorrect number of records in inode blockmap blocks, +blocks claimed that are not in a legal data area of the filesystem, +blocks that are claimed by more than one inode. +.IP 2. +Inode allocation map checks: +bad magic number in inode map blocks, +inode state as indicated by map (free or in-use) inconsistent +with state indicated by the inode, +inodes referenced by the filesystem that do not appear in +the inode allocation map, +inode allocation map referencing blocks that do not appear +to contain inodes. +.IP 3. +Size checks: +number of blocks claimed by inode inconsistent with inode size, +directory size not block aligned, +inode size not consistent with inode format. +.IP 4. +Directory checks: +bad magic numbers in directory blocks, +incorrect number of entries in a directory block, +bad freespace information in a directory leaf block, +entry pointing to an unallocated (free) or out +of range inode, +overlapping entries, +missing or incorrect dot and dotdot entries, +entries out of hashvalue order, +incorrect internal directory pointers, +directory type not consistent with inode format and size. +.IP 5. +Pathname checks: +files or directories not referenced by a pathname starting from +the filesystem root, +illegal pathname components. +.IP 6. +Link count checks: +link counts that do not agree with the number of +directory references to the inode. +.IP 7. +Freemap checks: +blocks claimed free by the freemap but also claimed by an inode, +blocks unclaimed by any inode but not appearing in the freemap. +.IP 8. +Super Block checks: +total free block and/or free i-node count incorrect, +filesystem geometry inconsistent, +secondary and primary superblocks contradictory. +.PP +Orphaned files and directories (allocated, in-use but unreferenced) are +reconnected by placing them in the +.I lost+found +directory. +The name assigned is the inode number. +.SS Disk Errors +.B xfs_repair +aborts on most disk I/O errors. Therefore, if you are trying +to repair a filesystem that was damaged due to a disk drive failure, +steps should be taken to ensure that all blocks in the filesystem are +readable and writable before attempting to use +.B xfs_repair +to repair the filesystem. A possible method is using +.BR dd (8) +to copy the data onto a good disk. +.SS lost+found +The directory +.I lost+found +does not have to already exist in the filesystem being repaired. +If the directory does not exist, it is automatically created if required. +If it already exists, it will be checked for consistency and if valid +will be used for additional orphaned files. Invalid +.I lost+found +directories are removed and recreated. Existing files in a valid +.I lost+found +are not removed or renamed. +.SS Corrupted Superblocks +XFS has both primary and secondary superblocks. +.B xfs_repair +uses information in the primary superblock +to automatically find and validate the primary superblock +against the secondary superblocks before proceeding. +Should the primary be too corrupted to be useful in locating +the secondary superblocks, the program scans the filesystem +until it finds and validates some secondary superblocks. +At that point, it generates a primary superblock. +.SS Quotas +If quotas are in use, it is possible that +.B xfs_repair +will clear some or all of the filesystem quota information. +If so, the program issues a warning just before it terminates. +If all quota information is lost, quotas are disabled and the +program issues a warning to that effect. +.PP +Note that +.B xfs_repair +does not check the validity of quota limits. It is recommended +that you check the quota limit information manually after +.BR xfs_repair . +Also, space usage information is automatically regenerated the +next time the filesystem is mounted with quotas turned on, so the +next quota mount of the filesystem may take some time. +.SH DIAGNOSTICS +.B xfs_repair +issues informative messages as it proceeds +indicating what it has found that is abnormal or any corrective +action that it has taken. +Most of the messages are completely understandable only to those +who are knowledgeable about the structure of the filesystem. +Some of the more common messages are explained here. +Note that the language of the messages is slightly different if +.B xfs_repair +is run in no-modify mode because the program is not changing anything on disk. +No-modify mode indicates what it would do to repair the filesystem +if run without the no-modify flag. +.PP +.B disconnected inode +.IB ino , +.B moving to lost+found +.IP +An inode numbered +.I ino +was not connected to the filesystem +directory tree and was reconnected to the +.I lost+found +directory. The inode is assigned the name of its inode number +.RI ( ino ). +If a +.I lost+found +directory does not exist, it is automatically created. +.PP +.B disconnected dir inode +.IB ino , +.B moving to lost+found +.IP +As above only the inode is a directory inode. +If a directory inode is attached to +.IR lost+found , +all of its children (if any) stay attached to the directory and therefore +get automatically reconnected when the directory is reconnected. +.PP +.B imap claims in-use inode +.I ino +.B is free, correcting imap +.IP +The inode allocation map thinks that inode +.I ino +is free whereas examination of the inode indicates that the +inode may be in use (although it may be disconnected). +The program updates the inode allocation map. +.PP +.B imap claims free inode +.I ino +.B is in use, correcting imap +.IP +The inode allocation map thinks that inode +.I ino +is in use whereas examination of the inode indicates that the +inode is not in use and therefore is free. +The program updates the inode allocation map. +.PP +.B resetting inode +.I ino +.B nlinks from +.I x +.B to +.I y +.IP +The program detected a mismatch between the +number of valid directory entries referencing inode +.I ino +and the number of references recorded in the inode and corrected the +the number in the inode. +.PP +.I fork-type +.B fork in ino +.I ino +.B claims used block +.I bno +.IP +Inode +.I ino +claims a block +.I bno +that is used (claimed) by either another inode or the filesystem +itself for metadata storage. The +.I fork-type +is either +.B data +or +.B attr +indicating whether the problem lies in the portion of the +inode that tracks regular data or the portion of the inode +that stores XFS attributes. +If the inode is a real-time (rt) inode, the message says so. +Any inode that claims blocks used by the filesystem is deleted. +If two or more inodes claim the same block, they are both deleted. +.PP +.I fork-type +.B fork in ino +.I ino +.B claims dup extent ... +.IP +Inode +.I ino +claims a block in an extent known to be claimed more than once. +The offset in the inode, start and length of the extent is given. +The message is slightly different +if the inode is a real-time (rt) inode and the extent is therefore +a real-time (rt) extent. +.PP +.B inode +.I ino +.B \- bad extent ... +.IP +An extent record in the blockmap of inode +.I ino +claims blocks that are out of the legal range of the filesystem. +The message supplies the start, end, and file offset of the extent. +The message is slightly different if the extent is a real-time (rt) extent. +.PP +.B bad +.I fork-type +.B fork in inode +.I ino +.IP +There was something structurally wrong or inconsistent with the +data structures that map offsets to filesystem blocks. +.PP +.B cleared inode +.I ino +.IP +There was something wrong with the inode that +was uncorrectable so the program freed the inode. +This usually happens because the inode claims +blocks that are used by something else or the inode itself +is badly corrupted. Typically, this message +is preceded by one or more messages indicating why the +inode needed to be cleared. +.PP +.B bad attribute fork in inode +.IR ino , +.B clearing attr fork +.IP +There was something wrong with the portion of the inode that +stores XFS attributes (the attribute fork) so the program reset +the attribute fork. +As a result of this, all attributes on that inode are lost. +.PP +.B correcting nextents for inode +.IR ino , +.B was +.I x +.B \- counted +.I y +.IP +The program found that the number of extents used to store +the data in the inode is wrong and corrected the number. +The message refers to nextents if the count is wrong +on the number of extents used to store attribute information. +.PP +.B entry +.I name +.B in dir +.I dir_ino +.B not consistent with .. value +.BI ( xxxx ) +.B in dir ino +.IB ino , +.B junking entry +.I name +.B in directory inode +.I dir_ino +.IP +The entry +.I name +in directory inode +.I dir_ino +references a directory inode +.IR ino . +However, the ..\& entry in directory +.I ino +does not point back to directory +.IR dir_ino , +so the program deletes the entry +.I name +in directory inode +.IR dir_ino . +If the directory inode +.I ino +winds up becoming a disconnected inode as a result of this, it is moved to +.I lost+found +later. +.PP +.B entry +.I name +.B in dir +.I dir_ino +.B references already connected dir ino +.IB ino , +.B junking entry +.I name +.B in directory inode +.I dir_ino +.IP +The entry +.I name +in directory inode +.I dir_ino +points to a directory inode +.I ino +that is known to be a child of another directory. +Therefore, the entry is invalid and is deleted. +This message refers to an entry in a small directory. +If this were a large directory, the last phrase would read +"will clear entry". +.PP +.B entry references free inode +.I ino +.B in directory +.IB dir_ino , +.B will clear entry +.IP +An entry in directory inode +.I dir_ino +references an inode +.I ino +that is known to be free. The entry is therefore invalid and is deleted. +This message refers to a large directory. +If the directory were small, the message would read "junking entry ...". +.SH EXIT STATUS +.B xfs_repair \-n +(no modify mode) +will return a status of 1 if filesystem corruption was detected and +0 if no filesystem corruption was detected. +.B xfs_repair +run without the \-n option will always return a status code of 0 if +it completes without problems, unless the flag +.B -e +is used. If it is used, then status 4 is reported when any issue with the +filesystem was found, but could be fixed. If a runtime error is encountered during +operation, it will return a status of 1. In this case, +.B xfs_repair +should be restarted. If +.B xfs_repair is unable +to proceed due to a dirty log, it will return a status of 2. See below. +.SH DIRTY LOGS +Due to the design of the XFS log, a dirty log can only be replayed +by the kernel, on a machine having the same CPU architecture as the +machine which was writing to the log. +.B xfs_repair +cannot replay a dirty log and will exit with a status code of 2 +when it detects a dirty log. +.PP +In this situation, the log can be replayed by mounting and immediately +unmounting the filesystem on the same class of machine that crashed. +Please make sure that the machine's hardware is reliable before +replaying to avoid compounding the problems. +.PP +If mounting fails, the log can be erased by running +.B xfs_repair +with the -L option. +All metadata updates in progress at the time of the crash will be lost, +which may cause significant filesystem damage. +This should +.B only +be used as a last resort. +.SH BUGS +The filesystem to be checked and repaired must have been +unmounted cleanly using normal system administration procedures +(the +.BR umount (8) +command or system shutdown), not as a result of a crash or system reset. +If the filesystem has not been unmounted cleanly, mount it and unmount +it cleanly before running +.BR xfs_repair . +.PP +.B xfs_repair +does not do a thorough job on XFS extended attributes. +The structure of the attribute fork will be consistent, +but only the contents of attribute forks that will fit into +an inode are checked. +This limitation will be fixed in the future. +.PP +The no-modify mode +.RB ( \-n +option) is not completely accurate. +It does not catch inconsistencies in the freespace and inode +maps, particularly lost blocks or subtly corrupted maps (trees). +.PP +The no-modify mode can generate repeated warnings about +the same problems because it cannot fix the problems as they +are encountered. +.PP +If a filesystem fails to be repaired, a metadump image can be generated +with +.BR xfs_metadump (8) +and be sent to an XFS maintainer to be analysed and +.B xfs_repair +fixed and/or improved. +.SH SEE ALSO +.BR dd (1), +.BR mkfs.xfs (8), +.BR umount (8), +.BR xfs_admin (8), +.BR xfs_metadump (8), +.BR xfs (5). diff --git a/upstream/opensuse-leap-15-6/man8/xfs_rtcp.8 b/upstream/opensuse-leap-15-6/man8/xfs_rtcp.8 new file mode 100644 index 00000000..40e9097e --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/xfs_rtcp.8 @@ -0,0 +1,53 @@ +.TH xfs_rtcp 8 +.SH NAME +xfs_rtcp \- XFS realtime copy command +.SH SYNOPSIS +.B xfs_rtcp +[ +.B \-e +.I extsize +] [ +.B -p +] +.IR source " ... " target +.br +.B xfs_rtcp \-V +.SH DESCRIPTION +.B xfs_rtcp +copies a file to the realtime partition on an XFS filesystem. +If there is more than one +.I source +and +.IR target , +the final argument (the +.IR target ) +must be a directory which already exists. +.SH OPTIONS +.TP +.BI \-e " extsize" +Sets the extent size of the destination realtime file. +.TP +.B \-p +Use if the size of the source file is not an even multiple of +the block size of the destination filesystem. When +.B \-p +is specified +.B xfs_rtcp +will pad the destination file to a size which is an even multiple +of the filesystem block size. +This is necessary since the realtime file is created using +direct I/O and the minimum I/O is the filesystem block size. +.TP +.B \-V +Prints the version number and exits. +.SH SEE ALSO +.BR xfs (5), +.BR mkfs.xfs (8), +.BR mount (8). +.SH CAVEATS +Currently, realtime partitions are not supported under the Linux +version of XFS, and use of a realtime partition +.B WILL CAUSE CORRUPTION +on the data partition. As such, this command is made available for curious +.B DEVELOPERS ONLY +at this point in time. diff --git a/upstream/opensuse-leap-15-6/man8/xfs_scrub.8 b/upstream/opensuse-leap-15-6/man8/xfs_scrub.8 new file mode 100644 index 00000000..e881ae76 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/xfs_scrub.8 @@ -0,0 +1,176 @@ +.TH xfs_scrub 8 +.SH NAME +xfs_scrub \- check and repair the contents of a mounted XFS filesystem +.SH SYNOPSIS +.B xfs_scrub +[ +.B \-abCemnTvx +] +.I mount-point +.br +.B xfs_scrub \-V +.SH DESCRIPTION +.B xfs_scrub +attempts to check and repair all metadata in a mounted XFS filesystem. +.PP +.B WARNING! +This program is +.BR EXPERIMENTAL "," +which means that its behavior and interface +could change at any time! +.PP +.B xfs_scrub +asks the kernel to scrub all metadata objects in the filesystem. +Metadata records are scanned for obviously bad values and then +cross-referenced against other metadata. +The goal is to establish a reasonable confidence about the consistency +of the overall filesystem by examining the consistency of individual +metadata records against the other metadata in the filesystem. +Damaged metadata can be rebuilt from other metadata if there exists +redundant data structures which are intact. +.PP +Filesystem corruption and optimization opportunities will be logged to +the standard error stream. +Enabling verbose mode will increase the amount of status information +sent to the output. +.PP +If the kernel scrub reports that metadata needs repairs or optimizations and +the user does not pass +.B -n +on the command line, this program will ask the kernel to make the repairs and +to perform the optimizations. +See the sections about optimizations and repairs for a list of optimizations +and repairs known to this program. +The kernel may not support repairing or optimizing the filesystem. +If this is the case, the filesystem must be unmounted and +.BR xfs_repair (8) +run on the filesystem to fix the problems. +.SH OPTIONS +.TP +.BI \-a " errors" +Abort if more than this many errors are found on the filesystem. +.TP +.B \-b +Run in background mode. +If the option is specified once, only run a single scrubbing thread at a +time. +If given more than once, an artificial delay of 100us is added to each +scrub call to reduce CPU overhead even further. +.TP +.BI \-C " fd" +This option causes xfs_scrub to write progress information to the +specified file description so that the progress of the filesystem check +can be monitored. +If the file description is a tty, a fancy progress bar is rendered. +Otherwise, a simple numeric status dump compatible with the +.B fsck -C +format is output. +.TP +.B \-e +Specifies what happens when errors are detected. +If +.IR shutdown +is given, the filesystem will be taken offline if errors are found. +If +.IR continue +is given, no action is taken if errors are found; this is the default +behavior. +.TP +.B \-k +Do not call TRIM on the free space. +.TP +.BI \-m " file" +Search this file for mounted filesystems instead of /etc/mtab. +.TP +.B \-n +Only check filesystem metadata. +Do not repair or optimize anything. +.TP +.BI \-T +Print timing and memory usage information for each phase. +.TP +.B \-v +Enable verbose mode, which prints periodic status updates. +.TP +.B \-V +Prints the version number and exits. +.TP +.B \-x +Read all file data extents to look for disk errors. +.B xfs_scrub +will issue O_DIRECT reads to the block device directly. +If the block device is a SCSI disk, it will instead issue READ VERIFY commands +directly to the disk. +If media errors are found, the error report will include the disk offset, in +bytes. +If the media errors affect a file, the report will also include the inode +number and file offset, in bytes. +These actions will confirm that all file data blocks can be read from storage. +.SH OPTIMIZATIONS +Optimizations supported by this program include, but are not limited to: +.IP \[bu] 2 +Instructing the underlying storage to discard unused extents via the +.B TRIM +ioctl. +.IP \[bu] +Updating secondary superblocks to match the primary superblock. +.IP \[bu] +Turning off shared block write checks for files that no longer share blocks. +.SH REPAIRS +Repairs are performed by calling into the kernel. +This limits the scope of repair activities to rebuilding primary data +structures from secondary data structures, or secondary structures from +primary structures. +The existence of secondary data structures may require features that can +only be turned on from +.BR mkfs.xfs (8). +If errors cannot be repaired, the filesystem must be +unmounted and +.BR xfs_repair (8) +run. +Repairs supported by the kernel include, but are not limited to: +.IP \[bu] 2 +Reconstructing extent allocation data. +.IP \[bu] +Rebuilding free space information. +.IP \[bu] +Rebuilding inode indexes. +.IP \[bu] +Fixing minor corruptions of inode records. +.IP \[bu] +Recalculating reference count information. +.IP \[bu] +Reconstructing reverse mapping data from primary extent allocation data. +.IP \[bu] +Scheduling a quotacheck for the next mount. +.PP +If corrupt metadata is successfully repaired, this program will log that +a repair has succeeded instead of a corruption report. +.SH EXIT CODE +The exit code returned by +.B xfs_scrub +is the sum of the following conditions: +.br +\ 0\ \-\ No errors +.br +\ 1\ \-\ File system errors left uncorrected +.br +\ 2\ \-\ File system optimizations possible +.br +\ 4\ \-\ Operational error +.br +\ 8\ \-\ Usage or syntax error +.br +.SH CAVEATS +.B xfs_scrub +is an immature utility! +Do not run this program unless you have backups of your data! +This program takes advantage of in-kernel scrubbing to verify a given +data structure with locks held and can keep the filesystem busy for a +long time. +The kernel must be new enough to support the SCRUB_METADATA ioctl. +.PP +If errors are found and cannot be repaired, the filesystem must be +unmounted and repaired. +.SH SEE ALSO +.BR xfs_repair (8). diff --git a/upstream/opensuse-leap-15-6/man8/xfs_scrub_all.8 b/upstream/opensuse-leap-15-6/man8/xfs_scrub_all.8 new file mode 100644 index 00000000..74548802 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/xfs_scrub_all.8 @@ -0,0 +1,42 @@ +.TH xfs_scrub_all 8 +.SH NAME +xfs_scrub_all \- scrub all mounted XFS filesystems +.SH SYNOPSIS +.B xfs_scrub_all +[ +.B \-hV +] +.SH DESCRIPTION +.B xfs_scrub_all +attempts to read and check all the metadata on all mounted XFS filesystems. +The online scrub is performed via the +.B xfs_scrub +tool, either by running it directly or by using systemd to start it +in a restricted fashion. +Mounted filesystems are mapped to physical storage devices so that scrub +operations can be run in parallel so long as no two scrubbers access +the same device simultaneously. +.SH OPTIONS +.TP +.B \-h +Display help. +.TP +.B \-V +Prints the version number and exits. +.SH EXIT CODE +The exit code returned by +.B xfs_scrub_all +is the sum of the following conditions: +.br +\ 0\ \-\ No errors +.br +\ 4\ \-\ File system errors left uncorrected +.br +\ 8\ \-\ Operational error +.br +\ 16\ \-\ Usage or syntax error +.TP +These are the same error codes returned by xfs_scrub. +.br +.SH SEE ALSO +.BR xfs_scrub (8). diff --git a/upstream/opensuse-leap-15-6/man8/xfs_spaceman.8 b/upstream/opensuse-leap-15-6/man8/xfs_spaceman.8 new file mode 100644 index 00000000..ece840d7 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/xfs_spaceman.8 @@ -0,0 +1,214 @@ +.TH xfs_spaceman 8 +.SH NAME +xfs_spaceman \- show free space information about an XFS filesystem +.SH SYNOPSIS +.B xfs_spaceman +[ +.B \-c +.I cmd +] +.I file +.br +.B xfs_spaceman \-V +.SH DESCRIPTION +.B xfs_spaceman +reports and controls free space usage in an XFS filesystem. +.SH OPTIONS +.TP 1.0i +.BI \-c " cmd" +.B xfs_spaceman +commands may be run interactively (the default) or as arguments on +the command line. Multiple +.B \-c +arguments may be given. The commands are run in the sequence given, +then the program exits. + +.SH COMMANDS +.TP +.BI "freesp [ \-dgrs ] [-a agno]... [ \-b | \-e bsize | \-h bsize | \-m factor ]" +With no arguments, +.B freesp +shows a histogram of all free space extents in the filesystem. +The command takes the following options: + +.RS 1.0i +.PD 0 +.TP 0.4i +.B \-a agno +Collect free space information from this allocation group. +This option can be specified multiple times to collect from multiple groups. + +.TP +.B \-b +This argument establishes that the histogram bin sizes are successive powers of two. +This is the default, and is mutually exclusive with the +.BR "-e" ", " "-h" ", and " "-m" " options." + +.TP +.B \-d +Print debugging information such as the raw free space extent information. + +.TP +.B \-g +Print the free space block and extent counts for each AG. + +.TP +.B \-e bsize +Set all histogram bin sizes to a specific value. +This option is mutually exclusive with the +.BR "-b" ", " "-h" ", and " "-m" " options." + +.TP +.B \-h bsize +Create a histogram bin with a lower bound of this value. +The upper bound of this bin will be one less than the lower bound of the +next highest histogram bin. +This option can be given multiple times to control the exact bin sizes. +This option is mutually exclusive with the +.BR "-b" ", " "-e" ", and " "-m" " options." + +.TP +.B \-m factor +Create each histogram bin with a size that is this many times the size +of the prvious bin created. +This option is mutually exclusive with the +.BR "-b" ", " "-e" ", and " "-h" " options." + +.TP +.B \-r +Query the realtime device for free space information. + +.TP +.B \-s +Display a summary of the free space information found. +.PD +.RE +.TP +.B info +Displays selected geometry information about the filesystem. +The opened file must be a mount point of a XFS filesystem. +The output will have the same format that +.BR "xfs_info" "(8)" +prints when querying a filesystem. +.TP +.BI "health [ \-a agno] [ \-c ] [ \-f ] [ \-i inum ] [ \-q ] [ paths ]" +Reports the health of the given group of filesystem metadata. +.RS 1.0i +.PD 0 +.TP 0.4i +.B \-a agno +Report on the health of the given allocation group. +.TP +.B \-c +Scan all inodes in the filesystem and report each file's health status. +If the +.B \-a +option is given, scan only the inodes in that AG. +.TP +.B \-f +Report on the health of metadata that affect the entire filesystem. +.TP +.B \-i inum +Report on the health of a specific inode. +.TP +.B \-q +Report only unhealthy metadata. +.TP +.B paths +Report on the health of the files at the given path. +.PD +.RE +.TP +.BR "help [ " command " ]" +Display a brief description of one or all commands. +.TP +.BI "prealloc [ \-u id ] [ \-g id ] [ -p id ] [ \-m minlen ] [ \-s ]" +Removes speculative preallocation. +If no +.BR "-u" ", " "-g" ", or " "-p" +options are given, this command acts on all files. +The command takes the following options: + +.RS 1.0i +.PD 0 +.TP 0.4i +.B \-u uid +Clear all speculative preallocations for files with this user id. +This option can be given in combination with the +.B "-g" " and " "-p" +options. + +.TP +.B \-g gid +Clear all speculative preallocations for files with this group id. +This option can be given in combination with the +.B "-u" " and " "-p" +options. + +.TP +.B \-p pid +Clear all speculative preallocations for files with this project id. +This option can be given in combination with the +.B "-u" " and " "-g" +options. + +.TP +.B \-m minlen +Ignore all files smaller than this size. +Units can be supplied for this argument. + +.TP +.B \-s +Wait for removal to complete. +.PD +.RE +.TP +.B print +Display a list of all open files. +.TP +.B quit +Exit +.BR xfs_spaceman . +.TP +.BI "trim ( \-a agno | \-f | " "offset" " " "length" " ) [ -m minlen ]" +Instructs the underlying storage device to release all storage that may +be backing free space in the filesystem. +The command takes the following options: +(One of +.BR -a ", " -f ", or the " +.IR offset / length +pair are required.) + +.RS 1.0i +.PD 0 +.TP 0.4i +.B \-a agno +Trim free space extents in the given allocation group. +This option is mutually exclusive with the +.BR "-f" " option and the " +.IR "offset" "/" "length" " options." + +.TP +.B \-f +Trim all free space in the filesystem. +This option is mutually exclusive with the +.BR "-a" " option and the " +.IR "offset" "/" "length" " options." + +.TP +.IR "option" ", " "length" +Trim all free space within the physical range defined by the +.I offset +and +.I length +from this filesystem. +Units can be appended to these arguments. +This option is mutually exclusive with the +.BR "-a" " and " "-f" " options." + +.TP +.B \-m minlen +Do not trim free space extents shorter than this length. +Units can be appended to this argument. +.PD +.RE diff --git a/upstream/opensuse-leap-15-6/man8/xqmstats.8 b/upstream/opensuse-leap-15-6/man8/xqmstats.8 new file mode 100644 index 00000000..a36a138a --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/xqmstats.8 @@ -0,0 +1,38 @@ +.\" 2004, Max Vozeler <max@hinterhof.net> +.\" Released under the Gnu GPL +.TH XQMSTATS 8 "April 2, 2004" "" "quota" +.SH NAME +.B xqmstats +\- Display XFS quota manager statistics from /proc +.SH SYNOPSIS +.I /usr/sbin/xqmstats +.SH DESCRIPTION +.B xqmstat +queries the kernel for the XFS Quota Manager dquot statistics. +It displays: +.P +.PD 0 +.RS 4 +.IP \[bu] +Reclaims +.IP \[bu] +Missed reclaims +.IP \[bu] +Dquot dups +.IP \[bu] +Cache misses +.IP \[bu] +Cache hits +.IP \[bu] +Dquot wants +.IP \[bu] +Shake reclaims +.IP \[bu] +Inact reclaims +.RE +.PD +.SH OPTIONS +None. +.SH SEE ALSO +.BR quotastats (1), +.BR quota (1). diff --git a/upstream/opensuse-leap-15-6/man8/xtables-legacy.8 b/upstream/opensuse-leap-15-6/man8/xtables-legacy.8 new file mode 100644 index 00000000..6db7d2cb --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/xtables-legacy.8 @@ -0,0 +1,78 @@ +.\" +.\" (C) Copyright 2016-2017, Arturo Borrero Gonzalez <arturo@netfilter.org> +.\" +.\" %%%LICENSE_START(GPLv2+_DOC_FULL) +.\" This is free documentation; you can redistribute it and/or +.\" modify it under the terms of the GNU General Public License as +.\" published by the Free Software Foundation; either version 2 of +.\" the License, or (at your option) any later version. +.\" +.\" The GNU General Public License's references to "object code" +.\" and "executables" are to be interpreted as the output of any +.\" document formatting or typesetting system, including +.\" intermediate and printed output. +.\" +.\" This manual is distributed in the hope that it will be useful, +.\" but WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.\" GNU General Public License for more details. +.\" +.\" You should have received a copy of the GNU General Public +.\" License along with this manual; if not, see +.\" <http://www.gnu.org/licenses/>. +.\" %%%LICENSE_END +.\" +.TH XTABLES-LEGACY 8 "June 2018" + +.SH NAME +xtables-legacy \(em iptables using old getsockopt/setsockopt-based kernel api + +.SH DESCRIPTION +\fBxtables-legacy\fP are the original versions of iptables that use +old getsockopt/setsockopt-based kernel interface. +This kernel interface has some limitations, therefore iptables can also +be used with the newer nf_tables based API. +See +.B xtables\-nft(8) +for information about the xtables-nft variants of iptables. + +.SH USAGE +The xtables-legacy-multi binary can be linked to the traditional names: + +.nf + /sbin/iptables -> /sbin/iptables\-legacy\-multi + /sbin/ip6tables -> /sbin/ip6tables\-legacy\-multi + /sbin/iptables\-save -> /sbin/ip6tables\-legacy\-multi + /sbin/iptables\-restore -> /sbin/ip6tables\-legacy\-multi +.fi + +The iptables version string will indicate whether the legacy API (get/setsockopt) or +the new nf_tables API is used: +.nf + iptables \-V + iptables v1.7 (legacy) +.fi + +.SH LIMITATIONS + +When inserting a rule using +iptables \-A or iptables \-I, iptables first needs to retrieve the current active +ruleset, change it to include the new rule, and then commit back the result. +This means that if two instances of iptables are running concurrently, one of the +updates might be lost. This can be worked around partially with the \-\-wait option. + +There is also no method to monitor changes to the ruleset, except periodically calling +iptables-legacy-save and checking for any differences in output. + +.B xtables\-monitor(8) +will need the +.B xtables\-nft(8) +versions to work, it cannot display changes made using the +.B iptables-legacy +tools. + +.SH SEE ALSO +\fBxtables\-nft(8)\fP, \fBxtables\-translate(8)\fP + +.SH AUTHORS +Rusty Russell originally wrote iptables, in early consultation with Michael Neuling. diff --git a/upstream/opensuse-leap-15-6/man8/xtables-monitor.8 b/upstream/opensuse-leap-15-6/man8/xtables-monitor.8 new file mode 100644 index 00000000..7f60e17c --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/xtables-monitor.8 @@ -0,0 +1,93 @@ +.TH XTABLES\-MONITOR 8 "" "iptables 1.8.7" "iptables 1.8.7" +.SH NAME +xtables-monitor \(em show changes to rule set and trace-events +.SH SYNOPSIS +\fBxtables\-monitor\fP [\fB\-t\fP] [\fB\-e\fP] [\fB\-4\fP|\fB|\-6\fB] +.PP +\ +.SH DESCRIPTION +.PP +.B xtables-monitor +is used to monitor changes to the ruleset or to show rule evaluation events +for packets tagged using the TRACE target. +.B xtables-monitor +will run until the user aborts execution, typically by using CTRL-C. +.RE +.SH OPTIONS +\fB\-e\fP, \fB\-\-event\fP +.TP +Watch for updates to the rule set. +Updates include creation of new tables, chains and rules and +the name of the program that caused the rule update. +.TP +\fB\-t\fP, \fB\-\-trace\fP +Watch for trace events generated by packets that have been tagged +using the TRACE target. +.TP +\fB\-4\fP +Restrict output to IPv4. +.TP +\fB\-6\fP +Restrict output to IPv6. +.SH EXAMPLE OUTPUT +.TP +.B xtables-monitor \-\-trace + + 1 TRACE: 2 fc475095 raw:PREROUTING:rule:0x3:CONTINUE \-4 \-t raw \-A PREROUTING \-p icmp \-j TRACE + 2 PACKET: 0 fc475095 IN=lo LL=0x304 0000000000000000000000000800 SRC=127.0.0.1 DST=127.0.0.1 LEN=84 TOS=0x0 TTL=64 ID=38349DF + 3 TRACE: 2 fc475095 raw:PREROUTING:return: + 4 TRACE: 2 fc475095 raw:PREROUTING:policy:ACCEPT + 5 TRACE: 2 fc475095 filter:INPUT:return: + 6 TRACE: 2 fc475095 filter:INPUT:policy:DROP + 7 TRACE: 2 0df9d3d8 raw:PREROUTING:rule:0x3:CONTINUE \-4 \-t raw \-A PREROUTING \-p icmp \-j TRACE +.PP +The first line shows a packet entering rule set evaluation. +The protocol number is shown (AF_INET in this case), then a packet +identifier number that allows to correlate messages coming from rule set evaluation of +this packet. After this, the rule that was matched by the packet is shown. +This is the TRACE rule that turns on tracing events for this packet. + +The second line dumps information about the packet. Incoming interface +and packet headers such as source and destination addresses are shown. + +The third line shows that the packet completed traversal of the raw table +PREROUTING chain, and is returning, followed by use the chain policy to make accept/drop +decision (the example shows accept being applied). +The fifth line shows that the packet leaves the filter INPUT chain, i.e., no rules in the filter tables +INPUT chain matched the packet. +It then got DROPPED by the policy of the INPUT table, as shown by line six. +The last line shows another packet arriving \-\- the packet id is different. + +When using the TRACE target, it is usually a good idea to only select packets +that are relevant, for example via +.nf +iptables \-t raw \-A PREROUTING \-p tcp \-\-dport 80 \-\-syn \-m limit \-\-limit 1/s \-j TRACE +.fi +.TP +.B xtables-monitor \-\-event + 1 EVENT: nft: NEW table: table filter ip flags 0 use 4 handle 444 + 2 EVENT: # nft: ip filter INPUT use 2 type filter hook input prio 0 policy drop packets 0 bytes 0 + 3 EVENT: # nft: ip filter FORWARD use 0 type filter hook forward prio 0 policy accept packets 0 bytes 0 + 4 EVENT: # nft: ip filter OUTPUT use 0 type filter hook output prio 0 policy accept packets 0 bytes 0 + 5 EVENT: \-4 \-t filter \-N TCP + 6 EVENT: \-4 \-t filter \-A TCP \-s 192.168.0.0/16 \-p tcp \-m tcp \-\-dport 22 \-j ACCEPT + 7 EVENT: \-4 \-t filter \-A TCP \-p tcp \-m multiport \-\-dports 80,443 \-j ACCEPT + 8 EVENT: \-4 \-t filter \-A INPUT \-p tcp \-j TCP + 9 EVENT: \-4 \-t filter \-A INPUT \-m conntrack \-\-ctstate RELATED,ESTABLISHED \-j ACCEPT + 10 NEWGEN: GENID=13904 PID=25167 NAME=iptables-nftables-restore +.PP +This example shows event monitoring. Line one shows creation of a table (filter in this case), followed +by three base hooks INPUT, FORWARD and OUTPUT. The iptables-nftables tools all create tables and base +chains automatically when needed, so this is expected when a table was not yet initialized or when it is +re-created from scratch by iptables-nftables-restore. Line five shows a new user-defined chain (TCP) +being added, followed by addition a few rules. the last line shows that a new ruleset generation has +become active, i.e., the rule set changes are now active. This also lists the process id and the programs name. +.SH LIMITATIONS +.B xtables-monitor +only works with rules added using iptables-nftables, rules added using +iptables-legacy cannot be monitored. +.SH BUGS +Should be reported or by sending email to netfilter-devel@vger.kernel.org or +by filing a report on https://bugzilla.netfilter.org/. +.SH SEE ALSO +\fBiptables\fP(8), \fBxtables\fP(8), \fBnft\fP(8) diff --git a/upstream/opensuse-leap-15-6/man8/xtables-nft.8 b/upstream/opensuse-leap-15-6/man8/xtables-nft.8 new file mode 100644 index 00000000..702bf954 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/xtables-nft.8 @@ -0,0 +1,208 @@ +.\" +.\" (C) Copyright 2016-2017, Arturo Borrero Gonzalez <arturo@netfilter.org> +.\" +.\" %%%LICENSE_START(GPLv2+_DOC_FULL) +.\" This is free documentation; you can redistribute it and/or +.\" modify it under the terms of the GNU General Public License as +.\" published by the Free Software Foundation; either version 2 of +.\" the License, or (at your option) any later version. +.\" +.\" The GNU General Public License's references to "object code" +.\" and "executables" are to be interpreted as the output of any +.\" document formatting or typesetting system, including +.\" intermediate and printed output. +.\" +.\" This manual is distributed in the hope that it will be useful, +.\" but WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.\" GNU General Public License for more details. +.\" +.\" You should have received a copy of the GNU General Public +.\" License along with this manual; if not, see +.\" <http://www.gnu.org/licenses/>. +.\" %%%LICENSE_END +.\" +.TH XTABLES-NFT 8 "June 2018" + +.SH NAME +xtables-nft \(em iptables using nftables kernel api + +.SH DESCRIPTION +\fBxtables-nft\fP are versions of iptables that use the nftables API. +This is a set of tools to help the system administrator migrate the +ruleset from \fBiptables(8)\fP, \fBip6tables(8)\fP, \fBarptables(8)\fP, and +\fBebtables(8)\fP to \fBnftables(8)\fP. + +The \fBxtables-nft\fP set is composed of several commands: +.IP \[bu] 2 +iptables\-nft +.IP \[bu] +iptables\-nft\-save +.IP \[bu] +iptables\-nft\-restore +.IP \[bu] +ip6tables\-nft +.IP \[bu] +ip6tables\-nft\-save +.IP \[bu] +ip6tables\-nft\-restore +.IP \[bu] +arptables\-nft +.IP \[bu] +ebtables\-nft + +These tools use the libxtables framework extensions and hook to the nf_tables +kernel subsystem using the \fBnft_compat\fP module. + +.SH USAGE +The xtables-nft tools allow you to manage the nf_tables backend using the +native syntax of \fBiptables(8)\fP, \fBip6tables(8)\fP, \fBarptables(8)\fP, and +\fBebtables(8)\fP. + +You should use the xtables-nft tools exactly the same way as you would use the +corresponding original tools. + +Adding a rule will result in that rule being added to the nf_tables kernel +subsystem instead. +Listing the ruleset will use the nf_tables backend as well. + +When these tools were designed, the main idea was to replace each legacy binary +with a symlink to the xtables-nft program, for example: + +.nf + /sbin/iptables -> /usr/sbin/iptables\-nft\-multi + /sbin/ip6tables -> /usr/sbin/ip6tables\-nft\-multi + /sbin/arptables -> /usr/sbin/arptables\-nft\-multi + /sbin/ebtables -> /usr/sbin/ebtables\-nft\-multi +.fi + +The iptables version string will indicate whether the legacy API (get/setsockopt) or +the new nf_tables api is used: +.nf + iptables \-V + iptables v1.7 (nf_tables) +.fi + +.SH DIFFERENCES TO LEGACY IPTABLES + +Because the xtables-nft tools use the nf_tables kernel API, rule additions +and deletions are always atomic. Unlike iptables-legacy, iptables-nft \-A .. +will NOT need to retrieve the current ruleset from the kernel, change it, and +re-load the altered ruleset. Instead, iptables-nft will tell the kernel to add +one rule. For this reason, the iptables-legacy \-\-wait option is a no-op in +iptables-nft. + +Use of the xtables-nft tools allow monitoring ruleset changes using the +.B xtables\-monitor(8) +command. + +When using \-j TRACE to debug packet traversal to the ruleset, note that you will need to use +.B xtables\-monitor(8) +in \-\-trace mode to obtain monitoring trace events. + +.SH EXAMPLES +One basic example is creating the skeleton ruleset in nf_tables from the +xtables-nft tools, in a fresh machine: + +.nf + root@machine:~# iptables\-nft \-L + [...] + root@machine:~# ip6tables\-nft \-L + [...] + root@machine:~# arptables\-nft \-L + [...] + root@machine:~# ebtables\-nft \-L + [...] + root@machine:~# nft list ruleset + table ip filter { + chain INPUT { + type filter hook input priority 0; policy accept; + } + + chain FORWARD { + type filter hook forward priority 0; policy accept; + } + + chain OUTPUT { + type filter hook output priority 0; policy accept; + } + } + table ip6 filter { + chain INPUT { + type filter hook input priority 0; policy accept; + } + + chain FORWARD { + type filter hook forward priority 0; policy accept; + } + + chain OUTPUT { + type filter hook output priority 0; policy accept; + } + } + table bridge filter { + chain INPUT { + type filter hook input priority \-200; policy accept; + } + + chain FORWARD { + type filter hook forward priority \-200; policy accept; + } + + chain OUTPUT { + type filter hook output priority \-200; policy accept; + } + } + table arp filter { + chain INPUT { + type filter hook input priority 0; policy accept; + } + + chain FORWARD { + type filter hook forward priority 0; policy accept; + } + + chain OUTPUT { + type filter hook output priority 0; policy accept; + } + } +.fi + +(please note that in fresh machines, listing the ruleset for the first time +results in all tables an chain being created). + +To migrate your complete filter ruleset, in the case of \fBiptables(8)\fP, +you would use: + +.nf + root@machine:~# iptables\-legacy\-save > myruleset # reads from x_tables + root@machine:~# iptables\-nft\-restore myruleset # writes to nf_tables +.fi +or +.nf + root@machine:~# iptables\-legacy\-save | iptables-translate-restore | less +.fi + +to see how rules would look like in the nft +\fBnft(8)\fP +syntax. + +.SH LIMITATIONS +You should use \fBLinux kernel >= 4.17\fP. + +The CLUSTERIP target is not supported. + +To get up-to-date information about this, please head to +\fBhttp://wiki.nftables.org/\fP. + +.SH SEE ALSO +\fBnft(8)\fP, \fBxtables\-translate(8)\fP, \fBxtables\-monitor(8)\fP + +.SH AUTHORS +The nftables framework is written by the Netfilter project +(https://www.netfilter.org). + +This manual page was written by Arturo Borrero Gonzalez +<arturo@debian.org> for the Debian project, but may be used by others. + +This documentation is free/libre under the terms of the GPLv2+. diff --git a/upstream/opensuse-leap-15-6/man8/xtables-translate.8 b/upstream/opensuse-leap-15-6/man8/xtables-translate.8 new file mode 100644 index 00000000..3dc72760 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/xtables-translate.8 @@ -0,0 +1,136 @@ +.\" +.\" (C) Copyright 2018, Arturo Borrero Gonzalez <arturo@netfilter.org> +.\" +.\" %%%LICENSE_START(GPLv2+_DOC_FULL) +.\" This is free documentation; you can redistribute it and/or +.\" modify it under the terms of the GNU General Public License as +.\" published by the Free Software Foundation; either version 2 of +.\" the License, or (at your option) any later version. +.\" +.\" The GNU General Public License's references to "object code" +.\" and "executables" are to be interpreted as the output of any +.\" document formatting or typesetting system, including +.\" intermediate and printed output. +.\" +.\" This manual is distributed in the hope that it will be useful, +.\" but WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.\" GNU General Public License for more details. +.\" +.\" You should have received a copy of the GNU General Public +.\" License along with this manual; if not, see +.\" <http://www.gnu.org/licenses/>. +.\" %%%LICENSE_END +.\" +.TH IPTABLES-TRANSLATE 8 "May 14, 2019" + +.SH NAME +iptables-translate \(em translation tool to migrate from iptables to nftables +.P +ip6tables-translate \(em translation tool to migrate from ip6tables to nftables +.SH DESCRIPTION +There is a set of tools to help the system administrator translate a given +ruleset from \fBiptables(8)\fP and \fBip6tables(8)\fP to \fBnftables(8)\fP. + +The available commands are: + +.IP \[bu] 2 +iptables-translate +.IP \[bu] +iptables-restore-translate +.IP \[bu] 2 +ip6tables-translate +.IP \[bu] +ip6tables-restore-translate + +.SH USAGE +They take as input the original \fBiptables(8)\fP/\fBip6tables(8)\fP syntax and +output the native \fBnftables(8)\fP syntax. + +The \fBiptables-restore-translate\fP tool reads a ruleset in the syntax +produced by \fBiptables-save(8)\fP. Likewise, the +\fBip6tables-restore-translate\fP tool reads one produced by +\fBip6tables-save(8)\fP. No ruleset modifications occur, these tools are +text converters only. + +The \fBiptables-translate\fP reads a command line as if it was entered to +\fBiptables(8)\fP, and \fBip6tables-translate\fP reads a command like as if it +was entered to \fBip6tables(8)\fP. + +.SH EXAMPLES +Basic operation examples. + +Single command translation: + +.nf +root@machine:~# iptables-translate -A INPUT -p tcp --dport 22 -m conntrack --ctstate NEW -j ACCEPT +nft add rule ip filter INPUT tcp dport 22 ct state new counter accept + +root@machine:~# ip6tables-translate -A FORWARD -i eth0 -o eth3 -p udp -m multiport --dports 111,222 -j ACCEPT +nft add rule ip6 filter FORWARD iifname eth0 oifname eth3 meta l4proto udp udp dport { 111,222} counter accept +.fi + +Whole ruleset translation: + +.nf +root@machine:~# iptables-save > save.txt +root@machine:~# cat save.txt +# Generated by iptables-save v1.6.0 on Sat Dec 24 14:26:40 2016 +*filter +:INPUT ACCEPT [5166:1752111] +:FORWARD ACCEPT [0:0] +:OUTPUT ACCEPT [5058:628693] +-A FORWARD -p tcp -m tcp --dport 22 -m conntrack --ctstate NEW -j ACCEPT +COMMIT +# Completed on Sat Dec 24 14:26:40 2016 + +root@machine:~# iptables-restore-translate -f save.txt +# Translated by iptables-restore-translate v1.6.0 on Sat Dec 24 14:26:59 2016 +add table ip filter +add chain ip filter INPUT { type filter hook input priority 0; } +add chain ip filter FORWARD { type filter hook forward priority 0; } +add chain ip filter OUTPUT { type filter hook output priority 0; } +add rule ip filter FORWARD tcp dport 22 ct state new counter accept + +root@machine:~# iptables-restore-translate -f save.txt > ruleset.nft +root@machine:~# nft -f ruleset.nft +root@machine:~# nft list ruleset +table ip filter { + chain INPUT { + type filter hook input priority 0; policy accept; + } + + chain FORWARD { + type filter hook forward priority 0; policy accept; + tcp dport ssh ct state new counter packets 0 bytes 0 accept + } + + chain OUTPUT { + type filter hook output priority 0; policy accept; + } +} +.fi + + +.SH LIMITATIONS +Some (few) extensions may be not supported (or fully-supported) for whatever +reason (for example, they were considered obsolete, or we didn't have the time +to work on them). + +There are no translations available for \fBebtables(8)\fP and +\fBarptables(8)\fP. + +To get up-to-date information about this, please head to +\fBhttps://wiki.nftables.org/\fP. + +.SH SEE ALSO +\fBnft(8)\fP, \fBiptables(8)\fP + +.SH AUTHORS +The nftables framework is written by the Netfilter project +(https://www.netfilter.org). + +This manual page was written by Arturo Borrero Gonzalez +<arturo@netfilter.org>. + +This documentation is free/libre under the terms of the GPLv2+. diff --git a/upstream/opensuse-leap-15-6/man8/zdump.8 b/upstream/opensuse-leap-15-6/man8/zdump.8 new file mode 100644 index 00000000..f77c0c79 --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/zdump.8 @@ -0,0 +1,231 @@ +.\" This file is in the public domain, so clarified as of +.\" 2009-05-17 by Arthur David Olson. +.TH zdump 8 "" "Time Zone Database" +.SH NAME +zdump \- timezone dumper +.SH SYNOPSIS +.B zdump +[ +.I option +\&... ] [ +.I timezone +\&... ] +.SH DESCRIPTION +.ie '\(lq'' .ds lq \&"\" +.el .ds lq \(lq\" +.ie '\(rq'' .ds rq \&"\" +.el .ds rq \(rq\" +.de q +\\$3\*(lq\\$1\*(rq\\$2 +.. +.ie \n(.g .ds - \f(CR-\fP +.el .ds - \- +The +.B zdump +program prints the current time in each +.I timezone +named on the command line. +.SH OPTIONS +.TP +.B \*-\*-version +Output version information and exit. +.TP +.B \*-\*-help +Output short usage message and exit. +.TP +.B \*-i +Output a description of time intervals. For each +.I timezone +on the command line, output an interval-format description of the +timezone. See +.q "INTERVAL FORMAT" +below. +.TP +.B \*-v +Output a verbose description of time intervals. +For each +.I timezone +on the command line, +print the times at the two extreme time values, +the times (if present) at and just beyond the boundaries of years that +.BR localtime (3) +and +.BR gmtime (3) +can represent, and +the times both one second before and exactly at +each detected time discontinuity. +Each line is followed by +.BI isdst= D +where +.I D +is positive, zero, or negative depending on whether +the given time is daylight saving time, standard time, +or an unknown time type, respectively. +Each line is also followed by +.BI gmtoff= N +if the given local time is known to be +.I N +seconds east of Greenwich. +.TP +.B \*-V +Like +.BR \*-v , +except omit output concerning extreme time and year values. +This generates output that is easier to compare to that of +implementations with different time representations. +.TP +.BI "\*-c " \fR[\fIloyear , \fR]\fIhiyear +Cut off interval output at the given year(s). +Cutoff times are computed using the proleptic Gregorian calendar with year 0 +and with Universal Time (UT) ignoring leap seconds. +Cutoffs are at the start of each year, where the lower-bound +timestamp is inclusive and the upper is exclusive; for example, +.B "\*-c 1970,2070" +selects transitions on or after 1970-01-01 00:00:00 UTC +and before 2070-01-01 00:00:00 UTC. +The default cutoff is +.BR \*-500,2500 . +.TP +.BI "\*-t " \fR[\fIlotime , \fR]\fIhitime +Cut off interval output at the given time(s), +given in decimal seconds since 1970-01-01 00:00:00 +Coordinated Universal Time (UTC). +The +.I timezone +determines whether the count includes leap seconds. +As with +.BR \*-c , +the cutoff's lower bound is inclusive and its upper bound is exclusive. +.SH "INTERVAL FORMAT" +The interval format is a compact text representation that is intended +to be both human- and machine-readable. It consists of an empty line, +then a line +.q "TZ=\fIstring\fP" +where +.I string +is a double-quoted string giving the timezone, a second line +.q "\*- \*- \fIinterval\fP" +describing the time interval before the first transition if any, and +zero or more following lines +.q "\fIdate time interval\fP", +one line for each transition time and following interval. Fields are +separated by single tabs. +.PP +Dates are in +.IR yyyy - mm - dd +format and times are in 24-hour +.IR hh : mm : ss +format where +.IR hh <24. +Times are in local time immediately after the transition. A +time interval description consists of a UT offset in signed +.RI \(+- hhmmss +format, a time zone abbreviation, and an isdst flag. An abbreviation +that equals the UT offset is omitted; other abbreviations are +double-quoted strings unless they consist of one or more alphabetic +characters. An isdst flag is omitted for standard time, and otherwise +is a decimal integer that is unsigned and positive (typically 1) for +daylight saving time and negative for unknown. +.PP +In times and in UT offsets with absolute value less than 100 hours, +the seconds are omitted if they are zero, and +the minutes are also omitted if they are also zero. Positive UT +offsets are east of Greenwich. The UT offset \*-00 denotes a UT +placeholder in areas where the actual offset is unspecified; by +convention, this occurs when the UT offset is zero and the time zone +abbreviation begins with +.q "\*-" +or is +.q "zzz". +.PP +In double-quoted strings, escape sequences represent unusual +characters. The escape sequences are \es for space, and \e", \e\e, +\ef, \en, \er, \et, and \ev with their usual meaning in the C +programming language. E.g., the double-quoted string +\*(lq"CET\es\e"\e\e"\*(rq represents the character sequence \*(lqCET +"\e\*(rq.\"" +.PP +.ne 9 +Here is an example of the output, with the leading empty line omitted. +(This example is shown with tab stops set far enough apart so that the +tabbed columns line up.) +.nf +.sp +.if \n(.g .ft CR +.if t .in +.5i +.if n .in +2 +.nr w \w'1896-01-13 'u+\n(.i +.ta \w'1896-01-13 'u +\w'12:01:26 'u +\w'-103126 'u +\w'HWT 'u +TZ="Pacific/Honolulu" +- - -103126 LMT +1896-01-13 12:01:26 -1030 HST +1933-04-30 03 -0930 HDT 1 +1933-05-21 11 -1030 HST +1942-02-09 03 -0930 HWT 1 +1945-08-14 13:30 -0930 HPT 1 +1945-09-30 01 -1030 HST +1947-06-08 02:30 -10 HST +.in +.if \n(.g .ft +.sp +.fi +Here, local time begins 10 hours, 31 minutes and 26 seconds west of +UT, and is a standard time abbreviated LMT. Immediately after the +first transition, the date is 1896-01-13 and the time is 12:01:26, and +the following time interval is 10.5 hours west of UT, a standard time +abbreviated HST. Immediately after the second transition, the date is +1933-04-30 and the time is 03:00:00 and the following time interval is +9.5 hours west of UT, is abbreviated HDT, and is daylight saving time. +Immediately after the last transition the date is 1947-06-08 and the +time is 02:30:00, and the following time interval is 10 hours west of +UT, a standard time abbreviated HST. +.PP +.ne 10 +Here are excerpts from another example: +.nf +.sp +.if \n(.g .ft CR +.if t .in +.5i +.if n .in +2 +TZ="Europe/Astrakhan" +- - +031212 LMT +1924-04-30 23:47:48 +03 +1930-06-21 01 +04 +1981-04-01 01 +05 1 +1981-09-30 23 +04 +\&... +2014-10-26 01 +03 +2016-03-27 03 +04 +.in +.if \n(.g .ft +.sp +.fi +This time zone is east of UT, so its UT offsets are positive. Also, +many of its time zone abbreviations are omitted since they duplicate +the text of the UT offset. +.SH LIMITATIONS +Time discontinuities are found by sampling the results returned by +.BR localtime (3) +at twelve-hour intervals. +This works in all real-world cases; +one can construct artificial time zones for which this fails. +.PP +In the +.B \*-v +and +.B \*-V +output, +.q "UT" +denotes the value returned by +.BR gmtime (3), +which uses UTC for modern timestamps and some other UT flavor for +timestamps that predate the introduction of UTC. +No attempt is currently made to have the output use +.q "UTC" +for newer and +.q "UT" +for older timestamps, partly because the exact date of the +introduction of UTC is problematic. +.SH SEE ALSO +.BR tzfile (5), +.BR zic (8) diff --git a/upstream/opensuse-leap-15-6/man8/zic.8 b/upstream/opensuse-leap-15-6/man8/zic.8 new file mode 100644 index 00000000..c467efef --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/zic.8 @@ -0,0 +1,903 @@ +.\" This file is in the public domain, so clarified as of +.\" 2009-05-17 by Arthur David Olson. +.TH zic 8 "" "Time Zone Database" +.SH NAME +zic \- timezone compiler +.SH SYNOPSIS +.B zic +[ +.I option +\&... ] [ +.I filename +\&... ] +.SH DESCRIPTION +.ie '\(lq'' .ds lq \&"\" +.el .ds lq \(lq\" +.ie '\(rq'' .ds rq \&"\" +.el .ds rq \(rq\" +.de q +\\$3\*(lq\\$1\*(rq\\$2 +.. +.ie '\(la'' .ds < < +.el .ds < \(la +.ie '\(ra'' .ds > > +.el .ds > \(ra +.ie \n(.g \{\ +. ds : \: +. ds - \f(CR-\fP +.\} +.el \{\ +. ds : +. ds - \- +.\} +.ds d " degrees +.ds m " minutes +.ds s " seconds +.ds _ " \& +.if t \{\ +. if \n(.g .if c \(de .if c \(fm .if c \(sd \{\ +. ds d \(de +. ds m \(fm +. ds s \(sd +. ds _ \| +. \} +.\} +The +.B zic +program reads text from the file(s) named on the command line +and creates the timezone information format (TZif) files +specified in this input. +If a +.I filename +is +.q "\*-" , +standard input is read. +.SH OPTIONS +.TP +.B "\*-\*-version" +Output version information and exit. +.TP +.B \*-\*-help +Output short usage message and exit. +.TP +.BI "\*-b " bloat +Output backward-compatibility data as specified by +.IR bloat . +If +.I bloat +is +.BR fat , +generate additional data entries that work around potential bugs or +incompatibilities in older software, such as software that mishandles +the 64-bit generated data. +If +.I bloat +is +.BR slim , +keep the output files small; this can help check for the bugs +and incompatibilities. +The default is +.BR slim , +as software that mishandles 64-bit data typically +mishandles timestamps after the year 2038 anyway. +Also see the +.B \*-r +option for another way to alter output size. +.TP +.BI "\*-d " directory +Create time conversion information files in the named directory rather than +in the standard directory named below. +.TP +.BI "\*-l " timezone +Use +.I timezone +as local time. +.B zic +will act as if the input contained a link line of the form +.sp +.ti +.5i +.ta \w'Link\0\0'u +\w'\fItimezone\fP\0\0'u +Link \fItimezone\fP localtime +.sp +If +.I timezone +is +.BR \*- , +any already-existing link is removed. +.TP +.BI "\*-L " leapsecondfilename +Read leap second information from the file with the given name. +If this option is not used, +no leap second information appears in output files. +.TP +.BI "\*-p " timezone +Use +.IR timezone 's +rules when handling nonstandard +TZ strings like "EET\*-2EEST" that lack transition rules. +.B zic +will act as if the input contained a link line of the form +.sp +.ti +.5i +Link \fItimezone\fP posixrules +.sp +Unless +.I timezone is +.q "\*-" , +this option is obsolete and poorly supported. +Among other things it should not be used for timestamps after the year 2037, +and it should not be combined with +.B "\*-b slim" +if +.IR timezone 's +transitions are at standard time or Universal Time (UT) instead of local time. +.sp +If +.I timezone +is +.BR \*- , +any already-existing link is removed. +.TP +.BR "\*-r " "[\fB@\fP\fIlo\fP][\fB/@\fP\fIhi\fP]" +Limit the applicability of output files +to timestamps in the range from +.I lo +(inclusive) to +.I hi +(exclusive), where +.I lo +and +.I hi +are possibly signed decimal counts of seconds since the Epoch +(1970-01-01 00:00:00 UTC). +Omitted counts default to extreme values. +The output files use UT offset 0 and abbreviation +.q "\*-00" +in place of the omitted timestamp data. +For example, +.q "zic \*-r @0" +omits data intended for negative timestamps (i.e., before the Epoch), and +.q "zic \*-r @0/@2147483648" +outputs data intended only for nonnegative timestamps that fit into +31-bit signed integers. +On platforms with GNU +.BR date , +.q "zic \*-r @$(date +%s)" +omits data intended for past timestamps. +Although this option typically reduces the output file's size, +the size can increase due to the need to represent the timestamp range +boundaries, particularly if +.I hi +causes a TZif file to contain explicit entries for +.RI pre- hi +transitions rather than concisely representing them +with an extended POSIX TZ string. +Also see the +.B "\*-b slim" +option for another way to shrink output size. +.TP +.BI "\*-R @" hi +Generate redundant trailing explicit transitions for timestamps +that occur less than +.I hi +seconds since the Epoch, even though the transitions could be +more concisely represented via the extended POSIX TZ string. +This option does not affect the represented timestamps. +Although it accommodates nonstandard TZif readers +that ignore the extended POSIX TZ string, +it increases the size of the altered output files. +.TP +.BI "\*-t " file +When creating local time information, put the configuration link in +the named file rather than in the standard location. +.TP +.B \*-v +Be more verbose, and complain about the following situations: +.RS +.PP +The input specifies a link to a link, +something not supported by some older parsers, including +.B zic +itself through release 2022e. +.PP +A year that appears in a data file is outside the range +of representable years. +.PP +A time of 24:00 or more appears in the input. +Pre-1998 versions of +.B zic +prohibit 24:00, and pre-2007 versions prohibit times greater than 24:00. +.PP +A rule goes past the start or end of the month. +Pre-2004 versions of +.B zic +prohibit this. +.PP +A time zone abbreviation uses a +.B %z +format. +Pre-2015 versions of +.B zic +do not support this. +.PP +A timestamp contains fractional seconds. +Pre-2018 versions of +.B zic +do not support this. +.PP +The input contains abbreviations that are mishandled by pre-2018 versions of +.B zic +due to a longstanding coding bug. +These abbreviations include +.q L +for +.q Link , +.q mi +for +.q min , +.q Sa +for +.q Sat , +and +.q Su +for +.q Sun . +.PP +The output file does not contain all the information about the +long-term future of a timezone, because the future cannot be summarized as +an extended POSIX TZ string. For example, as of 2023 this problem +occurs for Morocco's daylight-saving rules, as these rules are based +on predictions for when Ramadan will be observed, something that +an extended POSIX TZ string cannot represent. +.PP +The output contains data that may not be handled properly by client +code designed for older +.B zic +output formats. These compatibility issues affect only timestamps +before 1970 or after the start of 2038. +.PP +The output contains a truncated leap second table, +which can cause some older TZif readers to misbehave. +This can occur if the +.B "\*-L" +option is used, and either an Expires line is present or +the +.B "\*-r" +option is also used. +.PP +The output file contains more than 1200 transitions, +which may be mishandled by some clients. +The current reference client supports at most 2000 transitions; +pre-2014 versions of the reference client support at most 1200 +transitions. +.PP +A time zone abbreviation has fewer than 3 or more than 6 characters. +POSIX requires at least 3, and requires implementations to support +at least 6. +.PP +An output file name contains a byte that is not an ASCII letter, +.q "\*-" , +.q "/" , +or +.q "_" ; +or it contains a file name component that contains more than 14 bytes +or that starts with +.q "\*-" . +.RE +.SH FILES +Input files use the format described in this section; output files use +.BR tzfile (5) +format. +.PP +Input files should be text files, that is, they should be a series of +zero or more lines, each ending in a newline byte and containing at +most 2048 bytes counting the newline, and without any NUL bytes. +The input text's encoding +is typically UTF-8 or ASCII; it should have a unibyte representation +for the POSIX Portable Character Set (PPCS) +\*<https://pubs\*:.opengroup\*:.org/\*:onlinepubs/\*:9699919799/\*:basedefs/\*:V1_chap06\*:.html\*> +and the encoding's non-unibyte characters should consist entirely of +non-PPCS bytes. Non-PPCS characters typically occur only in comments: +although output file names and time zone abbreviations can contain +nearly any character, other software will work better if these are +limited to the restricted syntax described under the +.B \*-v +option. +.PP +Input lines are made up of fields. +Fields are separated from one another by one or more white space characters. +The white space characters are space, form feed, carriage return, newline, +tab, and vertical tab. +Leading and trailing white space on input lines is ignored. +An unquoted sharp character (#) in the input introduces a comment which extends +to the end of the line the sharp character appears on. +White space characters and sharp characters may be enclosed in double quotes +(") if they're to be used as part of a field. +Any line that is blank (after comment stripping) is ignored. +Nonblank lines are expected to be of one of three types: +rule lines, zone lines, and link lines. +.PP +Names must be in English and are case insensitive. +They appear in several contexts, and include month and weekday names +and keywords such as +.BR "maximum" , +.BR "only" , +.BR "Rolling" , +and +.BR "Zone" . +A name can be abbreviated by omitting all but an initial prefix; any +abbreviation must be unambiguous in context. +.PP +A rule line has the form +.nf +.ti +.5i +.ta \w'Rule\0\0'u +\w'NAME\0\0'u +\w'FROM\0\0'u +\w'1973\0\0'u +\w'\*-\0\0'u +\w'Apr\0\0'u +\w'lastSun\0\0'u +\w'2:00w\0\0'u +\w'1:00d\0\0'u +.sp +Rule NAME FROM TO \*- IN ON AT SAVE LETTER/S +.sp +For example: +.ti +.5i +.sp +Rule US 1967 1973 \*- Apr lastSun 2:00w 1:00d D +.sp +.fi +The fields that make up a rule line are: +.TP "\w'LETTER/S'u" +.B NAME +Gives the name of the rule set that contains this line. +The name must start with a character that is neither +an ASCII digit nor +.q \*- +nor +.q + . +To allow for future extensions, +an unquoted name should not contain characters from the set +.ie \n(.g .q \f(CR!$%&\(aq()*,/:;<=>?@[\e]\(ha\(ga{|}\(ti\fP . +.el .ie t .q \f(CW!$%&'()*,/:;<=>?@[\e]^\(ga{|}~\fP . +.el .q !$%&'()*,/:;<=>?@[\e]^`{|}~ . +.TP +.B FROM +Gives the first year in which the rule applies. +Any signed integer year can be supplied; the proleptic Gregorian calendar +is assumed, with year 0 preceding year 1. +The word +.B minimum +(or an abbreviation) means the indefinite past. +The word +.B maximum +(or an abbreviation) means the indefinite future. +Rules can describe times that are not representable as time values, +with the unrepresentable times ignored; this allows rules to be portable +among hosts with differing time value types. +.TP +.B TO +Gives the final year in which the rule applies. +In addition to +.B minimum +and +.B maximum +(as above), +the word +.B only +(or an abbreviation) +may be used to repeat the value of the +.B FROM +field. +.TP +.B \*- +Is a reserved field and should always contain +.q \*- +for compatibility with older versions of +.BR zic . +It was previously known as the +.B TYPE +field, which could contain values to allow a +separate script to further restrict in which +.q types +of years the rule would apply. +.TP +.B IN +Names the month in which the rule takes effect. +Month names may be abbreviated. +.TP +.B ON +Gives the day on which the rule takes effect. +Recognized forms include: +.nf +.in +.5i +.sp +.ta \w'Sun<=25\0\0'u +5 the fifth of the month +lastSun the last Sunday in the month +lastMon the last Monday in the month +Sun>=8 first Sunday on or after the eighth +Sun<=25 last Sunday on or before the 25th +.fi +.in -.5i +.sp +A weekday name (e.g., +.BR "Sunday" ) +or a weekday name preceded by +.q "last" +(e.g., +.BR "lastSunday" ) +may be abbreviated or spelled out in full. +There must be no white space characters within the +.B ON +field. +The +.q <= +and +.q >= +constructs can result in a day in the neighboring month; +for example, the IN-ON combination +.q "Oct Sun>=31" +stands for the first Sunday on or after October 31, +even if that Sunday occurs in November. +.TP +.B AT +Gives the time of day at which the rule takes effect, +relative to 00:00, the start of a calendar day. +Recognized forms include: +.nf +.in +.5i +.sp +.ta \w'00:19:32.13\0\0'u +2 time in hours +2:00 time in hours and minutes +01:28:14 time in hours, minutes, and seconds +00:19:32.13 time with fractional seconds +12:00 midday, 12 hours after 00:00 +15:00 3 PM, 15 hours after 00:00 +24:00 end of day, 24 hours after 00:00 +260:00 260 hours after 00:00 +\*-2:30 2.5 hours before 00:00 +\*- equivalent to 0 +.fi +.in -.5i +.sp +Although +.B zic +rounds times to the nearest integer second +(breaking ties to the even integer), the fractions may be useful +to other applications requiring greater precision. +The source format does not specify any maximum precision. +Any of these forms may be followed by the letter +.B w +if the given time is local or +.q "wall clock" +time, +.B s +if the given time is standard time without any adjustment for daylight saving, +or +.B u +(or +.B g +or +.BR z ) +if the given time is universal time; +in the absence of an indicator, +local (wall clock) time is assumed. +These forms ignore leap seconds; for example, +if a leap second occurs at 00:59:60 local time, +.q "1:00" +stands for 3601 seconds after local midnight instead of the usual 3600 seconds. +The intent is that a rule line describes the instants when a +clock/calendar set to the type of time specified in the +.B AT +field would show the specified date and time of day. +.TP +.B SAVE +Gives the amount of time to be added to local standard time when the rule is in +effect, and whether the resulting time is standard or daylight saving. +This field has the same format as the +.B AT +field +except with a different set of suffix letters: +.B s +for standard time and +.B d +for daylight saving time. +The suffix letter is typically omitted, and defaults to +.B s +if the offset is zero and to +.B d +otherwise. +Negative offsets are allowed; in Ireland, for example, daylight saving +time is observed in winter and has a negative offset relative to +Irish Standard Time. +The offset is merely added to standard time; for example, +.B zic +does not distinguish a 10:30 standard time plus an 0:30 +.B SAVE +from a 10:00 standard time plus a 1:00 +.BR SAVE . +.TP +.B LETTER/S +Gives the +.q "variable part" +(for example, the +.q "S" +or +.q "D" +in +.q "EST" +or +.q "EDT" ) +of time zone abbreviations to be used when this rule is in effect. +If this field is +.q \*- , +the variable part is null. +.PP +A zone line has the form +.sp +.nf +.ti +.5i +.ta \w'Zone\0\0'u +\w'Asia/Amman\0\0'u +\w'STDOFF\0\0'u +\w'Jordan\0\0'u +\w'FORMAT\0\0'u +Zone NAME STDOFF RULES FORMAT [UNTIL] +.sp +For example: +.sp +.ti +.5i +Zone Asia/Amman 2:00 Jordan EE%sT 2017 Oct 27 01:00 +.sp +.fi +The fields that make up a zone line are: +.TP "\w'STDOFF'u" +.B NAME +The name of the timezone. +This is the name used in creating the time conversion information file for the +timezone. +It should not contain a file name component +.q ".\&" +or +.q ".." ; +a file name component is a maximal substring that does not contain +.q "/" . +.TP +.B STDOFF +The amount of time to add to UT to get standard time, +without any adjustment for daylight saving. +This field has the same format as the +.B AT +and +.B SAVE +fields of rule lines, except without suffix letters; +begin the field with a minus sign if time must be subtracted from UT. +.TP +.B RULES +The name of the rules that apply in the timezone or, +alternatively, a field in the same format as a rule-line SAVE column, +giving the amount of time to be added to local standard time +and whether the resulting time is standard or daylight saving. +If this field is +.B \*- +then standard time always applies. +When an amount of time is given, only the sum of standard time and +this amount matters. +.TP +.B FORMAT +The format for time zone abbreviations. +The pair of characters +.B %s +is used to show where the +.q "variable part" +of the time zone abbreviation goes. +Alternatively, a format can use the pair of characters +.B %z +to stand for the UT offset in the form +.RI \(+- hh , +.RI \(+- hhmm , +or +.RI \(+- hhmmss , +using the shortest form that does not lose information, where +.IR hh , +.IR mm , +and +.I ss +are the hours, minutes, and seconds east (+) or west (\-) of UT. +Alternatively, +a slash (/) +separates standard and daylight abbreviations. +To conform to POSIX, a time zone abbreviation should contain only +alphanumeric ASCII characters, +.q "+" +and +.q "\*-". +By convention, the time zone abbreviation +.q "\*-00" +is a placeholder that means local time is unspecified. +.TP +.B UNTIL +The time at which the UT offset or the rule(s) change for a location. +It takes the form of one to four fields YEAR [MONTH [DAY [TIME]]]. +If this is specified, +the time zone information is generated from the given UT offset +and rule change until the time specified, which is interpreted using +the rules in effect just before the transition. +The month, day, and time of day have the same format as the IN, ON, and AT +fields of a rule; trailing fields can be omitted, and default to the +earliest possible value for the missing fields. +.IP +The next line must be a +.q "continuation" +line; this has the same form as a zone line except that the +string +.q "Zone" +and the name are omitted, as the continuation line will +place information starting at the time specified as the +.q "until" +information in the previous line in the file used by the previous line. +Continuation lines may contain +.q "until" +information, just as zone lines do, indicating that the next line is a further +continuation. +.PP +If a zone changes at the same instant that a rule would otherwise take +effect in the earlier zone or continuation line, the rule is ignored. +A zone or continuation line +.I L +with a named rule set starts with standard time by default: +that is, any of +.IR L 's +timestamps preceding +.IR L 's +earliest rule use the rule in effect after +.IR L 's +first transition into standard time. +In a single zone it is an error if two rules take effect at the same +instant, or if two zone changes take effect at the same instant. +.PP +If a continuation line subtracts +.I N +seconds from the UT offset after a transition that would be +interpreted to be later if using the continuation line's UT offset and +rules, the +.q "until" +time of the previous zone or continuation line is interpreted +according to the continuation line's UT offset and rules, and any rule +that would otherwise take effect in the next +.I N +seconds is instead assumed to take effect simultaneously. +For example: +.br +.ne 7 +.nf +.in +2m +.ta \w'# Rule\0\0'u +\w'NAME\0\0'u +\w'FROM\0\0'u +\w'2006\0\0'u +\w'\*-\0\0'u +\w'Oct\0\0'u +\w'lastSun\0\0'u +\w'2:00\0\0'u +\w'SAVE\0\0'u +.sp +# Rule NAME FROM TO \*- IN ON AT SAVE LETTER/S +Rule US 1967 2006 - Oct lastSun 2:00 0 S +Rule US 1967 1973 - Apr lastSun 2:00 1:00 D +.ta \w'Zone\0\0America/Menominee\0\0'u +\w'STDOFF\0\0'u +\w'RULES\0\0'u +\w'FORMAT\0\0'u +# Zone\0\0NAME STDOFF RULES FORMAT [UNTIL] +Zone\0\0America/Menominee \*-5:00 \*- EST 1973 Apr 29 2:00 + \*-6:00 US C%sT +.sp +.in +.fi +Here, an incorrect reading would be there were two clock changes on 1973-04-29, +the first from 02:00 EST (\*-05) to 01:00 CST (\*-06), +and the second an hour later from 02:00 CST (\*-06) to 03:00 CDT (\*-05). +However, +.B zic +interprets this more sensibly as a single transition from 02:00 CST (\*-05) to +02:00 CDT (\*-05). +.PP +A link line has the form +.sp +.nf +.ti +.5i +.ta \w'Link\0\0'u +\w'Europe/Istanbul\0\0'u +Link TARGET LINK-NAME +.sp +For example: +.sp +.ti +.5i +Link Europe/Istanbul Asia/Istanbul +.sp +.fi +The +.B TARGET +field should appear as the +.B NAME +field in some zone line or as the +.B LINK-NAME +field in some link line. +The +.B LINK-NAME +field is used as an alternative name for that zone; +it has the same syntax as a zone line's +.B NAME +field. +Links can chain together, although the behavior is unspecified if a +chain of one or more links does not terminate in a Zone name. +A link line can appear before the line that defines the link target. +For example: +.sp +.ne 3 +.nf +.in +2m +.ta \w'Zone\0\0'u +\w'Greenwich\0\0'u +Link Greenwich G_M_T +Link Etc/GMT Greenwich +Zone Etc/GMT\0\00\0\0\*-\0\0GMT +.sp +.in +.fi +The two links are chained together, and G_M_T, Greenwich, and Etc/GMT +all name the same zone. +.PP +Except for continuation lines, +lines may appear in any order in the input. +However, the behavior is unspecified if multiple zone or link lines +define the same name. +.PP +The file that describes leap seconds can have leap lines and an +expiration line. +Leap lines have the following form: +.nf +.ti +.5i +.ta \w'Leap\0\0'u +\w'YEAR\0\0'u +\w'MONTH\0\0'u +\w'DAY\0\0'u +\w'HH:MM:SS\0\0'u +\w'CORR\0\0'u +.sp +Leap YEAR MONTH DAY HH:MM:SS CORR R/S +.sp +For example: +.ti +.5i +.sp +Leap 2016 Dec 31 23:59:60 + S +.sp +.fi +The +.BR YEAR , +.BR MONTH , +.BR DAY , +and +.B HH:MM:SS +fields tell when the leap second happened. +The +.B CORR +field +should be +.q "+" +if a second was added +or +.q "\*-" +if a second was skipped. +The +.B R/S +field +should be (an abbreviation of) +.q "Stationary" +if the leap second time given by the other fields should be interpreted as UTC +or +(an abbreviation of) +.q "Rolling" +if the leap second time given by the other fields should be interpreted as +local (wall clock) time. +.PP +Rolling leap seconds were implemented back when it was not +clear whether common practice was rolling or stationary, +with concerns that one would see +Times Square ball drops where there'd be a +.q "3... 2... 1... leap... Happy New Year" +countdown, placing the leap second at +midnight New York time rather than midnight UTC. +However, this countdown style does not seem to have caught on, +which means rolling leap seconds are not used in practice; +also, they are not supported if the +.B \*-r +option is used. +.PP +The expiration line, if present, has the form: +.nf +.ti +.5i +.ta \w'Expires\0\0'u +\w'YEAR\0\0'u +\w'MONTH\0\0'u +\w'DAY\0\0'u +.sp +Expires YEAR MONTH DAY HH:MM:SS +.sp +For example: +.ti +.5i +.sp +Expires 2020 Dec 28 00:00:00 +.sp +.fi +The +.BR YEAR , +.BR MONTH , +.BR DAY , +and +.B HH:MM:SS +fields give the expiration timestamp in UTC for the leap second table. +.br +.ne 22 +.SH "EXTENDED EXAMPLE" +Here is an extended example of +.B zic +input, intended to illustrate many of its features. +.nf +.in +2m +.ta \w'# Rule\0\0'u +\w'NAME\0\0'u +\w'FROM\0\0'u +\w'1973\0\0'u +\w'\*-\0\0'u +\w'Apr\0\0'u +\w'lastSun\0\0'u +\w'2:00\0\0'u +\w'SAVE\0\0'u +.sp +# Rule NAME FROM TO \*- IN ON AT SAVE LETTER/S +Rule Swiss 1941 1942 \*- May Mon>=1 1:00 1:00 S +Rule Swiss 1941 1942 \*- Oct Mon>=1 2:00 0 \*- +.sp .5 +Rule EU 1977 1980 \*- Apr Sun>=1 1:00u 1:00 S +Rule EU 1977 only \*- Sep lastSun 1:00u 0 \*- +Rule EU 1978 only \*- Oct 1 1:00u 0 \*- +Rule EU 1979 1995 \*- Sep lastSun 1:00u 0 \*- +Rule EU 1981 max \*- Mar lastSun 1:00u 1:00 S +Rule EU 1996 max \*- Oct lastSun 1:00u 0 \*- +.sp +.ta \w'# Zone\0\0'u +\w'Europe/Zurich\0\0'u +\w'0:29:45.50\0\0'u +\w'RULES\0\0'u +\w'FORMAT\0\0'u +# Zone NAME STDOFF RULES FORMAT [UNTIL] +Zone Europe/Zurich 0:34:08 \*- LMT 1853 Jul 16 + 0:29:45.50 \*- BMT 1894 Jun + 1:00 Swiss CE%sT 1981 + 1:00 EU CE%sT +.sp +Link Europe/Zurich Europe/Vaduz +.sp +.in +.fi +In this example, the EU rules are for the European Union +and for its predecessor organization, the European Communities. +The timezone is named Europe/Zurich and it has the alias Europe/Vaduz. +This example says that Zurich was 34 minutes and 8 +seconds east of UT until 1853-07-16 at 00:00, when the legal offset +was changed to +7\*d\*_26\*m\*_22.50\*s, +which works out to 0:29:45.50; +.B zic +treats this by rounding it to 0:29:46. +After 1894-06-01 at 00:00 the UT offset became one hour +and Swiss daylight saving rules (defined with lines beginning with +.q "Rule Swiss") +apply. From 1981 to the present, EU daylight saving rules have +applied, and the UTC offset has remained at one hour. +.PP +In 1941 and 1942, daylight saving time applied from the first Monday +in May at 01:00 to the first Monday in October at 02:00. +The pre-1981 EU daylight-saving rules have no effect +here, but are included for completeness. Since 1981, daylight +saving has begun on the last Sunday in March at 01:00 UTC. +Until 1995 it ended the last Sunday in September at 01:00 UTC, +but this changed to the last Sunday in October starting in 1996. +.PP +For purposes of display, +.q "LMT" +and +.q "BMT" +were initially used, respectively. Since +Swiss rules and later EU rules were applied, the time zone abbreviation +has been CET for standard time and CEST for daylight saving +time. +.SH FILES +.TP +.I /etc/localtime +Default local timezone file. +.TP +.I /usr/share/zoneinfo +Default timezone information directory. +.SH NOTES +For areas with more than two types of local time, +you may need to use local standard time in the +.B AT +field of the earliest transition time's rule to ensure that +the earliest transition time recorded in the compiled file is correct. +.PP +If, +for a particular timezone, +a clock advance caused by the start of daylight saving +coincides with and is equal to +a clock retreat caused by a change in UT offset, +.B zic +produces a single transition to daylight saving at the new UT offset +without any change in local (wall clock) time. +To get separate transitions +use multiple zone continuation lines +specifying transition instants using universal time. +.SH SEE ALSO +.BR tzfile (5), +.BR zdump (8) diff --git a/upstream/opensuse-leap-15-6/man8/zramctl.8 b/upstream/opensuse-leap-15-6/man8/zramctl.8 new file mode 100644 index 00000000..e0f1f57d --- /dev/null +++ b/upstream/opensuse-leap-15-6/man8/zramctl.8 @@ -0,0 +1,158 @@ +'\" t +.\" Title: zramctl +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.15 +.\" Date: 2022-02-14 +.\" Manual: System Administration +.\" Source: util-linux 2.37.4 +.\" Language: English +.\" +.TH "ZRAMCTL" "8" "2022-02-14" "util\-linux 2.37.4" "System Administration" +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.ss \n[.ss] 0 +.nh +.ad l +.de URL +\fI\\$2\fP <\\$1>\\$3 +.. +.als MTO URL +.if \n[.g] \{\ +. mso www.tmac +. am URL +. ad l +. . +. am MTO +. ad l +. . +. LINKSTYLE blue R < > +.\} +.SH "NAME" +zramctl \- set up and control zram devices +.SH "SYNOPSIS" +.sp +Get info: +.RS 4 +\fBzramctl\fP [options] +.RE +.sp +Reset zram: +.RS 4 +\fBzramctl\fP \fB\-r\fP \fIzramdev\fP... +.RE +.sp +Print name of first unused zram device: +.RS 4 +\fBzramctl\fP \fB\-f\fP +.RE +.sp +Set up a zram device: +.RS 4 +\fBzramctl\fP [\fB\-f\fP | \fIzramdev\fP] [\fB\-s\fP \fIsize\fP] [\fB\-t\fP \fInumber\fP] [\fB\-a\fP \fIalgorithm\fP] +.RE +.SH "DESCRIPTION" +.sp +\fBzramctl\fP is used to quickly set up zram device parameters, to reset zram devices, and to query the status of used zram devices. +.sp +If no option is given, all non\-zero size zram devices are shown. +.sp +Note that \fIzramdev\fP node specified on command line has to already exist. The command \fBzramctl\fP creates a new \fI/dev/zram<N>\fP nodes only when \fB\-\-find\fP option specified. It\(cqs possible (and common) that after system boot \fI/dev/zram<N>\fP nodes are not created yet. +.SH "OPTIONS" +.sp +\fB\-a\fP, \fB\-\-algorithm lzo\fP|\fBlz4\fP|\fBlz4hc\fP|\fBdeflate\fP|\fB842\fP +.RS 4 +Set the compression algorithm to be used for compressing data in the zram device. +.RE +.sp +\fB\-f\fP, \fB\-\-find\fP +.RS 4 +Find the first unused zram device. If a \fB\-\-size\fP argument is present, then initialize the device. +.RE +.sp +\fB\-n\fP, \fB\-\-noheadings\fP +.RS 4 +Do not print a header line in status output. +.RE +.sp +\fB\-o\fP, \fB\-\-output\fP \fIlist\fP +.RS 4 +Define the status output columns to be used. If no output arrangement is specified, then a default set is used. Use \fB\-\-help\fP to get a list of all supported columns. +.RE +.sp +\fB\-\-output\-all\fP +.RS 4 +Output all available columns. +.RE +.sp +\fB\-\-raw\fP +.RS 4 +Use the raw format for status output. +.RE +.sp +\fB\-r\fP, \fB\-\-reset\fP +.RS 4 +Reset the options of the specified zram device(s). Zram device settings can be changed only after a reset. +.RE +.sp +\fB\-s\fP, \fB\-\-size\fP \fIsize\fP +.RS 4 +Create a zram device of the specified \fIsize\fP. Zram devices are aligned to memory pages; when the requested \fIsize\fP is not a multiple of the page size, it will be rounded up to the next multiple. When not otherwise specified, the unit of the \fIsize\fP parameter is bytes. +.sp +The \fIsize\fP argument may be followed by the multiplicative suffixes KiB (=1024), MiB (=1024*1024), and so on for GiB, TiB, PiB, EiB, ZiB and YiB (the "iB" is optional, e.g., "K" has the same meaning as "KiB") or the suffixes KB (=1000), MB (=1000*1000), and so on for GB, TB, PB, EB, ZB and YB. +.RE +.sp +\fB\-t\fP, \fB\-\-streams\fP \fInumber\fP +.RS 4 +Set the maximum number of compression streams that can be used for the device. The default is use all CPUs and one stream for kernels older than 4.6. +.RE +.sp +\fB\-V\fP, \fB\-\-version\fP +.RS 4 +Display version information and exit. +.RE +.sp +\fB\-h\fP, \fB\-\-help\fP +.RS 4 +Display help text and exit. +.RE +.SH "EXIT STATUS" +.sp +\fBzramctl\fP returns 0 on success, nonzero on failure. +.SH "FILES" +.sp +\fI/dev/zram[0..N]\fP +.RS 4 +zram block devices +.RE +.SH "EXAMPLE" +.sp +The following commands set up a zram device with a size of one gigabyte and use it as swap device. +.sp +.if n .RS 4 +.nf +.fam C + # zramctl \-\-find \-\-size 1024M + /dev/zram0 + # mkswap /dev/zram0 + # swapon /dev/zram0 + ... + # swapoff /dev/zram0 + # zramctl \-\-reset /dev/zram0 +.fam +.fi +.if n .RE +.SH "AUTHORS" +.sp +.MTO "nefelim4ag\(atgmail.com" "Timofey Titovets" "," +.MTO "kzak\(atredhat.com" "Karel Zak" "" +.SH "SEE ALSO" +.sp +.URL "http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/admin\-guide/blockdev/zram.rst" "Linux kernel documentation" "" +.SH "REPORTING BUGS" +.sp +For bug reports, use the issue tracker at \c +.URL "https://github.com/karelzak/util\-linux/issues" "" "." +.SH "AVAILABILITY" +.sp +The \fBzramctl\fP command is part of the util\-linux package which can be downloaded from \c +.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."
\ No newline at end of file |