ericonr
/
util-linux
mirror of https://github.com/ericonr/util-linux.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Asciidoc: Review sys-utils man pages, part 2

This commit is contained in:
Mario Blättermann 2021-03-26 17:19:27 +01:00
parent fc86ec98de
commit 4eab78d379
31 changed files with 1184 additions and 1146 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

195
sys-utils/hwclock.8.adoc
View File

@ -35,135 +35,136 @@ The following functions are mutually exclusive, only one can be given at a time.
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 *The Adjust Function*.
*--getepoch*; *--setepoch*::
These functions are for Alpha machines only, and are only available through the Linux kernel RTC driver. +
{nbsp} +
They are used to read and set the kernel's 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's BIOS sets the year counter in the Hardware Clock to contain the number of full years since 1952, then the kernel's Hardware Clock epoch value must be 1952. +
{nbsp} +
The *­--setepoch* function requires using the *­--epoch* option to specify the year. For example: +
{nbsp} +
**hwclock --setepoch --epoch=1952** +
{nbsp} +
The RTC driver attempts to guess the correct epoch value, so setting it may not be required. +
{nbsp} +
This epoch value is used whenever *­hwclock* reads or sets the Hardware Clock on an Alpha machine. For ISA machines the kernel uses the fixed Hardware Clock epoch of 1900.
These functions are for Alpha machines only, and are only available through the Linux kernel RTC driver.
+
They are used to read and set the kernel's 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's BIOS sets the year counter in the Hardware Clock to contain the number of full years since 1952, then the kernel's Hardware Clock epoch value must be 1952.
+
The *­--setepoch* function requires using the *­--epoch* option to specify the year. For example:
+
**hwclock --setepoch --epoch=1952**
+
The RTC driver attempts to guess the correct epoch value, so setting it may not be required.
+
This epoch value is used whenever *­hwclock* reads or sets the Hardware Clock on an Alpha machine. For ISA machines the kernel uses the fixed Hardware Clock epoch of 1900.
*--predict*::
Predict what the Hardware Clock will read in the future based upon the time given by the *--date* option and the information in _{ADJTIME_PATH}_. This is useful, for example, to account for drift when setting a Hardware Clock wakeup (aka alarm). See *­rtcwake*(8). +
{nbsp} +
Do not use this function if the Hardware Clock is being modified by anything other than the current operating system's *­hwclock* command, such as ­'11 minute mode' or from dual-booting another OS.
Predict what the Hardware Clock will read in the future based upon the time given by the *--date* option and the information in _{ADJTIME_PATH}_. This is useful, for example, to account for drift when setting a Hardware Clock wakeup (aka alarm). See *­rtcwake*(8).
+
Do not use this function if the Hardware Clock is being modified by anything other than the current operating system's *­hwclock* command, such as ­'11 minute mode' or from dual-booting another OS.
*-r*, *--show*; *--get*::
Read the Hardware Clock and print its time to standard output in the *ISO 8601* format. The time shown is always in local time, even if you keep your Hardware Clock in UTC. See the *­--localtime* option. +
{nbsp} +
Showing the Hardware Clock time is the default when no function is specified. +
{nbsp} +
The *--get* function also applies drift correction to the time read, based upon the information in _{ADJTIME_PATH}_. Do not use this function if the Hardware Clock is being modified by anything other than the current operating system's *­hwclock* command, such as ­'11 minute mode' or from dual-booting another OS.
Read the Hardware Clock and print its time to standard output in the *ISO 8601* format. The time shown is always in local time, even if you keep your Hardware Clock in UTC. See the *­--localtime* option.
+
Showing the Hardware Clock time is the default when no function is specified.
+
The *--get* function also applies drift correction to the time read, based upon the information in _{ADJTIME_PATH}_. Do not use this function if the Hardware Clock is being modified by anything other than the current operating system's *­hwclock* command, such as ­'11 minute mode' or from dual-booting another OS.
*-s*, *--hctosys*::
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 *The Adjust Function*. +
{nbsp} +
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 *­--hctosys* function does this based upon the information in the _{ADJTIME_PATH}_ file or the command line arguments *­--localtime* and *--utc*. Note: no daylight saving adjustment is made. See the discussion below, under *LOCAL vs UTC*. +
{nbsp} +
The kernel also keeps a timezone value, the *­--hctosys* function sets it to the timezone configured for the system. The system timezone is configured by the TZ environment variable or the _­/etc/localtime_ file, as *­tzset*(3) would interpret them. The obsolete _tz_dsttime_ field of the kernel's timezone value is set to zero. (For details on what this field used to mean, see *­settimeofday*(2).) +
{nbsp} +
When used in a startup script, making the *­--hctosys* function the first caller of *­settimeofday*(2) from boot, it will set the NTP ­'11 minute mode' timescale via the _­persistent_clock_is_local_ kernel variable. If the Hardware Clock's timescale configuration is changed then a reboot is required to inform the kernel. See the discussion below, under *Automatic Hardware Clock Synchronization by the Kernel*. +
{nbsp} +
This is a good function to use in one of the system startup scripts before the file systems are mounted read/write. +
{nbsp} +
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's ­'11 minute mode', then *­--hctosys* will set the time incorrectly by including drift compensation. +
{nbsp} +
Drift compensation can be inhibited by setting the drift factor in _{ADJTIME_PATH}_ to zero. This setting will be persistent as long as the *­--update-drift* option is not used with *­--systohc* at shutdown (or anywhere else). Another way to inhibit this is by using the *­--noadjfile* option when calling the *­--hctosys* function. A third method is to delete the _{ADJTIME_PATH}_ file. *Hwclock* 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 *hwclock --localtime --adjust*; 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. +
{nbsp} +
A condition under which inhibiting *hwclock*'s 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's value, then when this instance is started again the drift correction applied will be incorrect. +
{nbsp} +
For *hwclock*'s drift correction to work properly it is imperative that nothing changes the Hardware Clock while its Linux instance is not running.
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 *The Adjust Function*.
+
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 *­--hctosys* function does this based upon the information in the _{ADJTIME_PATH}_ file or the command line arguments *­--localtime* and *--utc*. Note: no daylight saving adjustment is made. See the discussion below, under *LOCAL vs UTC*.
+
The kernel also keeps a timezone value, the *­--hctosys* function sets it to the timezone configured for the system. The system timezone is configured by the TZ environment variable or the _­/etc/localtime_ file, as *­tzset*(3) would interpret them. The obsolete _tz_dsttime_ field of the kernel's timezone value is set to zero. (For details on what this field used to mean, see *­settimeofday*(2).)
+
When used in a startup script, making the *­--hctosys* function the first caller of *­settimeofday*(2) from boot, it will set the NTP ­'11 minute mode' timescale via the _­persistent_clock_is_local_ kernel variable. If the Hardware Clock's timescale configuration is changed then a reboot is required to inform the kernel. See the discussion below, under *Automatic Hardware Clock Synchronization by the Kernel*.
+
This is a good function to use in one of the system startup scripts before the file systems are mounted read/write.
+
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's ­'11 minute mode', then *­--hctosys* will set the time incorrectly by including drift compensation.
+
Drift compensation can be inhibited by setting the drift factor in _{ADJTIME_PATH}_ to zero. This setting will be persistent as long as the *­--update-drift* option is not used with *­--systohc* at shutdown (or anywhere else). Another way to inhibit this is by using the *­--noadjfile* option when calling the *­--hctosys* function. A third method is to delete the _{ADJTIME_PATH}_ file. *Hwclock* 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 *hwclock --localtime --adjust*; 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.
+
A condition under which inhibiting *hwclock*'s 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's value, then when this instance is started again the drift correction applied will be incorrect.
+
For *hwclock*'s drift correction to work properly it is imperative that nothing changes the Hardware Clock while its Linux instance is not running.
*--set*::
Set the Hardware Clock to the time given by the *--date* option, and update the timestamps in _{ADJTIME_PATH}_. With the *­--update-drift* option also (re)calculate the drift factor. Try it without the option if *­--set* fails. See *­--update-drift* below.
Set the Hardware Clock to the time given by the *--date* option, and update the timestamps in _{ADJTIME_PATH}_. With the *­--update-drift* option also (re)calculate the drift factor. Try it without the option if *­--set* fails. See *­--update-drift* below.
*--systz*::
This is an alternate to the *­--hctosys* 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. +
{nbsp} +
It does the following things that are detailed above in the *­--hctosys* function: +
{nbsp} +
* Corrects the System Clock timescale to UTC as needed. Only instead of accomplishing this by setting the System Clock, *hwclock* simply informs the kernel and it handles the change.
* Sets the kernel's NTP ­'11 minute mode' timescale.
* Sets the kernel's timezone. +
{nbsp} +
The first two are only available on the first call of ­*settimeofday*(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.
This is an alternate to the *­--hctosys* 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.
+
It does the following things that are detailed above in the *­--hctosys* function:
* Corrects the System Clock timescale to UTC as needed. Only instead of accomplishing this by setting the System Clock, *hwclock* simply informs the kernel and it handles the change.
* Sets the kernel's NTP ­'11 minute mode' timescale.
* Sets the kernel's timezone.
The first two are only available on the first call of ­*settimeofday*(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.
*-w*, *--systohc*::
Set the Hardware Clock from the System Clock, and update the timestamps in _{ADJTIME_PATH}_. With the *­--update-drift* option also (re)calculate the drift factor. Try it without the option if *­--systohc* fails. See *­--update-drift* below.
Set the Hardware Clock from the System Clock, and update the timestamps in _{ADJTIME_PATH}_. With the *­--update-drift* option also (re)calculate the drift factor. Try it without the option if *­--systohc* fails. See *­--update-drift* below.
*-V*, *--version*::
Display version information and exit.
Display version information and exit.
*-h*, *--help*::
Display help text and exit.
Display help text and exit.
== OPTIONS
**--adjfile=**__filename__::
Override the default _{ADJTIME_PATH}_ file path.
Override the default _{ADJTIME_PATH}_ file path.
**­--date=**__date_string__::
This option must be used with the *--set* or *­--predict* functions, otherwise it is ignored. +
{nbsp} +
*hwclock --set --date='16:45'* +
*hwclock --predict --date='2525-08-14 07:11:05'* +
{nbsp} +
The argument must be in local time, even if you keep your Hardware Clock in UTC. See the *­--localtime* option. Therefore, the argument should not include any timezone information. It also should not be a relative time like "+5 minutes", because *­hwclock*'s precision depends upon correlation between the argument's 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.
This option must be used with the *--set* or *­--predict* functions, otherwise it is ignored.
+
*hwclock --set --date='16:45'*
+
*hwclock --predict --date='2525-08-14 07:11:05'*
+
The argument must be in local time, even if you keep your Hardware Clock in UTC. See the *­--localtime* option. Therefore, the argument should not include any timezone information. It also should not be a relative time like "+5 minutes", because *­hwclock*'s precision depends upon correlation between the argument's 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.
**­--delay=**__seconds__::
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. +
{nbsp} +
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.
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.
+
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.
*-D*, *--debug*::
Use *--verbose*. The *­--debug* option has been deprecated and may be repurposed or removed in a future release.
Use *--verbose*. The *­--debug* option has been deprecated and may be repurposed or removed in a future release.
*--directisa*::
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 *­hwclock* to use explicit I/O instructions to access the Hardware Clock. Without this option, *­hwclock* 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 *--rtc* option.
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 *­hwclock* to use explicit I/O instructions to access the Hardware Clock. Without this option, *­hwclock* 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 *--rtc* option.
**--epoch=**__year__::
This option is required when using the *­--setepoch* function. The minimum _year_ value is 1900. The maximum is system dependent (*ULONG_MAX - 1*).
This option is required when using the *­--setepoch* function. The minimum _year_ value is 1900. The maximum is system dependent (*ULONG_MAX - 1*).
*-f*, **--rtc=**__filename__::
Override *­hwclock*'s default rtc device file name. Otherwise it will use the first one found in this order: _/dev/rtc0_ _/dev/rtc_ _/dev/misc/rtc_ For *IA-64:* _/dev/efirtc_ _/dev/misc/efirtc_
Override *­hwclock*'s default rtc device file name. Otherwise it will use the first one found in this order: _/dev/rtc0_, _/dev/rtc_, _/dev/misc/rtc_. For *IA-64:* _/dev/efirtc_ _/dev/misc/efirtc_
*-l*, *--localtime*; *-u*, *--utc*::
Indicate which timescale the Hardware Clock is set to. +
{nbsp} +
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 *­--localtime* or *--utc* options give this information to the *­hwclock* 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. +
{nbsp} +
If you specify neither *--utc* nor *­--localtime* then the one last given with a set function (*--set*, *­--systohc*, or *­--adjust*), as recorded in _{ADJTIME_PATH}_, will be used. If the adjtime file doesn't exist, the default is UTC. +
{nbsp} +
Note: daylight saving time changes may be inconsistent when the Hardware Clock is kept in local time. See the discussion below, under *LOCAL vs UTC*.
Indicate which timescale the Hardware Clock is set to.
+
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 *­--localtime* or *--utc* options give this information to the *­hwclock* 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.
+
If you specify neither *--utc* nor *­--localtime* then the one last given with a set function (*--set*, *­--systohc*, or *­--adjust*), as recorded in _{ADJTIME_PATH}_, will be used. If the adjtime file doesn't exist, the default is UTC.
+
Note: daylight saving time changes may be inconsistent when the Hardware Clock is kept in local time. See the discussion below, under *LOCAL vs UTC*.
*--noadjfile*::
Disable the facilities provided by _{ADJTIME_PATH}_. *­hwclock* will not read nor write to that file with this option. Either *--utc* or *­--localtime* must be specified when using this option.
Disable the facilities provided by _{ADJTIME_PATH}_. *­hwclock* will not read nor write to that file with this option. Either *--utc* or *­--localtime* must be specified when using this option.
*--test*::
Do not actually change anything on the system, that is, the Clocks or _{ADJTIME_PATH}_ (*­--verbose* is implicit with this option).
Do not actually change anything on the system, that is, the Clocks or _{ADJTIME_PATH}_ (*­--verbose* is implicit with this option).
*--update-drift*::
Update the Hardware Clock's drift factor in _{ADJTIME_PATH}_. It can only be used with *--set* or *­--systohc*. +
{nbsp} +
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. +
{nbsp} +
This option was added in v2.26, because it is typical for systems to call *­hwclock --systohc* at shutdown; with the old behaviour this would automatically (re)calculate the drift factor which caused several problems: +
{nbsp} +
* When using NTP with an ­'11 minute mode' kernel the drift factor would be clobbered to near zero.
* It would not allow the use of 'cold' drift correction. With most configurations using 'cold' drift will yield favorable results. Cold, means when the machine is turned off which can have a significant impact on the drift factor.
* (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.
* Significantly increased system shutdown times (as of v2.31 when not using *­--update-drift* the RTC is not read).
Update the Hardware Clock's drift factor in _{ADJTIME_PATH}_. It can only be used with *--set* or *­--systohc*.
+
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.
+
This option was added in v2.26, because it is typical for systems to call *­hwclock --systohc* at shutdown; with the old behaviour this would automatically (re)calculate the drift factor which caused several problems:
+
* When using NTP with an ­'11 minute mode' kernel the drift factor would be clobbered to near zero.
* It would not allow the use of 'cold' drift correction. With most configurations using 'cold' drift will yield favorable results. Cold, means when the machine is turned off which can have a significant impact on the drift factor.
* (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.
* Significantly increased system shutdown times (as of v2.31 when not using *­--update-drift* the RTC is not read).
Having *­hwclock* calculate the drift factor is a good starting point, but for optimal results it will likely need to be adjusted by directly editing the _{ADJTIME_PATH}_ file. For most configurations once a machine's 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 *The Adjust Function*.
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.
*-v*, *--verbose*::
Display more details about what *­hwclock* is doing internally.
Display more details about what *­hwclock* is doing internally.
== NOTES
@ -285,22 +286,22 @@ As a rule, cold drift will work best for most use cases. This should be true eve
*Steps to calculate cold drift:*
1::
*Ensure that NTP daemon will not be launched at startup.*
*Ensure that NTP daemon will not be launched at startup.*
2::
The _System Clock_ time must be correct at shutdown!
The _System Clock_ time must be correct at shutdown!
3::
Shut down the system.
Shut down the system.
4::
Let an extended period pass without changing the Hardware Clock.
Let an extended period pass without changing the Hardware Clock.
5::
Start the system.
Start the system.
6::
Immediately use *hwclock* to set the correct time, adding the *­--update-drift* option.
Immediately use *hwclock* to set the correct time, adding the *­--update-drift* option.
Note: if step 6 uses *­--systohc*, then the System Clock must be set correctly (step 6a) just before doing so.
@ -329,7 +330,7 @@ There are two separate databases in the zoneinfo system, posix and 'right'. 'Rig
To configure a system to use a particular database all of the files located in its directory must be copied to the root of _­/usr/share/zoneinfo_. Files are never used directly from the posix or 'right' subdirectories, e.g., ­TZ='_right/Europe/Dublin_'. This habit was becoming so common that the upstream zoneinfo project restructured the system's file tree by moving the posix and 'right' subdirectories out of the zoneinfo directory and into sibling directories:
_/usr/share/zoneinfo_ _/usr/share/zoneinfo-posix_ _/usr/share/zoneinfo-leaps_
_/usr/share/zoneinfo_, _/usr/share/zoneinfo-posix_, _/usr/share/zoneinfo-leaps_
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 'right' 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 *hwclock* needs the UTC timezone file; they fetch it from the root of _­/usr/share/zoneinfo_ , 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.
@ -340,29 +341,29 @@ Attempting to mix and match files from these separate databases will not work, b
One of the following exit values will be returned:
*EXIT_SUCCESS* ('0' on POSIX systems)::
Successful program execution.
Successful program execution.
*EXIT_FAILURE* ('1' on POSIX systems)::
The operation failed or the command syntax was not valid.
The operation failed or the command syntax was not valid.
== ENVIRONMENT
*TZ*::
If this variable is set its value takes precedence over the system configured timezone.
If this variable is set its value takes precedence over the system configured timezone.
*TZDIR*::
If this variable is set its value takes precedence over the system configured timezone database directory path.
If this variable is set its value takes precedence over the system configured timezone database directory path.
== FILES
_{ADJTIME_PATH}_::
The configuration and state file for hwclock.
The configuration and state file for hwclock.
_/etc/localtime_::
The system timezone file.
The system timezone file.
_/usr/share/zoneinfo/_::
The system timezone database directory.
The system timezone database directory.
Device files *hwclock* may try for Hardware Clock access: _/dev/rtc0_ _/dev/rtc_ _/dev/misc/rtc_ _/dev/efirtc_ _/dev/misc/efirtc_

12
sys-utils/ipcmk.1.adoc
View File

@ -27,24 +27,24 @@ ipcmk - make various IPC resources
Resources can be specified with these options:
*-M*, *--shmem* _size_::
Create a shared memory segment of _size_ bytes. The _size_ argument may be followed by the multiplicative suffixes KiB (=1024), MiB (=1024*1024), and so on for GiB, etc. (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, etc.
Create a shared memory segment of _size_ bytes. The _size_ argument may be followed by the multiplicative suffixes KiB (=1024), MiB (=1024*1024), and so on for GiB, etc. (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, etc.
*-Q*, *--queue*::
Create a message queue.
Create a message queue.
*-S*, *--semaphore* _number_::
Create a semaphore array with _number_ of elements.
Create a semaphore array with _number_ of elements.
Other options are:
*-p*, *--mode* _mode_::
Access permissions for the resource. Default is 0644.
Access permissions for the resource. Default is 0644.
*-V*, *--version*::
Display version information and exit.
Display version information and exit.
*-h*, *--help*::
Display help text and exit.
Display help text and exit.
== AUTHORS

26
sys-utils/ipcrm.1.adoc
View File

@ -9,6 +9,7 @@ May be distributed under the GNU General Public License
:man source: util-linux {release-version}
:page-layout: base
:command: ipcrm
:asterisk: *
== NAME
@ -35,37 +36,38 @@ The details of the removes are described in *shmctl*(2), *msgctl*(2), and *semct
== OPTIONS
*-a*, *--all* [*shm*] [*msg*] [*sem*]::
Remove all resources. When an option argument is provided, the removal is performed only for the specified resource types. +
{nbsp} +
_Warning!_ Do not use *-a* if you are unsure how the software using the resources might react to missing objects. Some programs create these resources at startup and may not have any code to deal with an unexpected disappearance.
Remove all resources. When an option argument is provided, the removal is performed only for the specified resource types.
+
_Warning!_ Do not use *-a* if you are unsure how the software using the resources might react to missing objects. Some programs create these resources at startup and may not have any code to deal with an unexpected disappearance.
*-M*, *--shmem-key* _shmkey_::
Remove the shared memory segment created with _shmkey_ after the last detach is performed.
Remove the shared memory segment created with _shmkey_ after the last detach is performed.
*-m*, *--shmem-id* _shmid_::
Remove the shared memory segment identified by _shmid_ after the last detach is performed.
Remove the shared memory segment identified by _shmid_ after the last detach is performed.
*-Q*, *--queue-key* _msgkey_::
Remove the message queue created with _msgkey_.
Remove the message queue created with _msgkey_.
*-q*, *--queue-id* _msgid_::
Remove the message queue identified by _msgid_.
Remove the message queue identified by _msgid_.
*-S*, *--semaphore-key* _semkey_::
Remove the semaphore created with _semkey_.
Remove the semaphore created with _semkey_.
*-s*, *--semaphore-id* _semid_::
Remove the semaphore identified by _semid_.
Remove the semaphore identified by _semid_.
*-V*, *--version*::
Display version information and exit.
Display version information and exit.
*-h*, *--help*::
Display help text and exit.
Display help text and exit.
== NOTES
In its first Linux implementation, *ipcrm* used the deprecated syntax shown in the second line of the *SYNOPSIS*. Functionality present in other +++*+++nix implementations of *ipcrm* has since been added, namely the ability to delete resources by key (not just identifier), and to respect the same command-line syntax. For backward compatibility the previous syntax is still supported.
//TRANSLATORS: Keep {asterisk} untranslated; it expands to "*nix".
In its first Linux implementation, *ipcrm* used the deprecated syntax shown in the second line of the *SYNOPSIS*. Functionality present in other {asterisk}nix implementations of *ipcrm* has since been added, namely the ability to delete resources by key (not just identifier), and to respect the same command-line syntax. For backward compatibility the previous syntax is still supported.
== SEE ALSO

30
sys-utils/ipcs.1.adoc
View File

@ -25,60 +25,60 @@ ipcs - show information on IPC facilities
== OPTIONS
*-i*, *--id* _id_::
Show full details on just the one resource element identified by _id_. This option needs to be combined with one of the three resource options: *-m*, *-q* or *-s*.
Show full details on just the one resource element identified by _id_. This option needs to be combined with one of the three resource options: *-m*, *-q* or *-s*.
*-h*, *--help*::
Display help text and exit.
Display help text and exit.
*-V*, *--version*::
Display version information and exit.
Display version information and exit.
=== Resource options
*-m*, *--shmems*::
Write information about active shared memory segments.
Write information about active shared memory segments.
*-q*, *--queues*::
Write information about active message queues.
Write information about active message queues.
*-s*, *--semaphores*::
Write information about active semaphore sets.
Write information about active semaphore sets.
*-a*, *--all*::
Write information about all three resources (default).
Write information about all three resources (default).
=== Output formats
Of these options only one takes effect: the last one specified.
*-c*, *--creator*::
Show creator and owner.
Show creator and owner.
*-l*, *--limits*::
Show resource limits.
Show resource limits.
*-p*, *--pid*::
Show PIDs of creator and last operator.
Show PIDs of creator and last operator.
*-t*, *--time*::
Write time information. The time of the last control operation that changed the access permissions for all facilities, the time of the last *msgsnd*(2) and *msgrcv*(2) operations on message queues, the time of the last *shmat*(2) and *shmdt*(2) operations on shared memory, and the time of the last *semop*(2) operation on semaphores.
Write time information. The time of the last control operation that changed the access permissions for all facilities, the time of the last *msgsnd*(2) and *msgrcv*(2) operations on message queues, the time of the last *shmat*(2) and *shmdt*(2) operations on shared memory, and the time of the last *semop*(2) operation on semaphores.
*-u*, *--summary*::
Show status summary.
Show status summary.
=== Representation
These affect only the *-l* (*--limits*) option.
*-b*, *--bytes*::
Print sizes in bytes.
Print sizes in bytes.
*--human*::
Print sizes in human-readable format.
Print sizes in human-readable format.
== CONFORMING TO
The Linux ipcs utility is not fully compatible to the POSIX ipcs utility. The Linux version does not support the POSIX *-a*, *-b* and *-o* options, but does support the *-l* and *-u* options not defined by POSIX. A portable application shall not use the *-a*, *-b*, *-o*, *-l*, and *-u* options.
The Linux *ipcs* utility is not fully compatible to the POSIX *ipcs* utility. The Linux version does not support the POSIX *-a*, *-b* and *-o* options, but does support the *-l* and *-u* options not defined by POSIX. A portable application shall not use the *-a*, *-b*, *-o*, *-l*, and *-u* options.
== NOTES

26
sys-utils/irqtop.1.adoc
View File

@ -23,44 +23,44 @@ The default output is subject to change. So whenever possible, you should avoid
== OPTIONS
*-o*, *--output* _list_::
Specify which output columns to print. Use *--help* to get a list of all supported columns. The default list of columns may be extended if list is specified in the format _+list_.
Specify which output columns to print. Use *--help* to get a list of all supported columns. The default list of columns may be extended if list is specified in the format _+list_.
*-d*, *--delay* _seconds_::
Update interrupt output every _seconds_ intervals.
Update interrupt output every _seconds_ intervals.
*-s*, *--sort* _column_::
Specify sort criteria by column name. See *--help* output to get column names. The sort criteria may be changes in interactive mode.
Specify sort criteria by column name. See *--help* output to get column names. The sort criteria may be changes in interactive mode.
*-S*, *--softirq*::
Show softirqs information.
Show softirqs information.
*-V*, *--version*::
Display version information and exit.
Display version information and exit.
*-h*, *--help*::
Display help text and exit.
Display help text and exit.
== INTERACTIVE MODE KEY COMMANDS
*i*::
sort by short irq name or number field
sort by short irq name or number field
*t*::
sort by total count of interrupts (the default)
sort by total count of interrupts (the default)
*d*::
sort by delta count of interrupts
sort by delta count of interrupts
*n*::
sort by long descriptive name field
sort by long descriptive name field
*q Q*::
stop updates and exit program
stop updates and exit program
== AUTHORS
mailto:pizhenwei@bytedance.com[Zhenwei Pi] +
mailto:kerolasa@iki.fi[Sami Kerola] +
mailto:pizhenwei@bytedance.com[Zhenwei Pi],
mailto:kerolasa@iki.fi[Sami Kerola],
mailto:kzak@redhat.com[Karel Zak]
include::../man-common/bugreports.adoc[]

56
sys-utils/ldattach.8.adoc
View File

@ -33,87 +33,87 @@ With no arguments, *ldattach* prints usage information.
Depending on the kernel release, the following line disciplines are supported:
*TTY*(*0*)::
The default line discipline, providing transparent operation (raw mode) as well as the habitual terminal line editing capabilities (cooked mode).
The default line discipline, providing transparent operation (raw mode) as well as the habitual terminal line editing capabilities (cooked mode).
*SLIP*(*1*)::
Serial Line IP (SLIP) protocol processor for transmitting TCP/IP packets over serial lines.
Serial Line IP (SLIP) protocol processor for transmitting TCP/IP packets over serial lines.
*MOUSE*(*2*)::
Device driver for RS232 connected pointing devices (serial mice).
Device driver for RS232 connected pointing devices (serial mice).
*PPP*(*3*)::
Point to Point Protocol (PPP) processor for transmitting network packets over serial lines.
Point to Point Protocol (PPP) processor for transmitting network packets over serial lines.
*STRIP*(*4*); *AX25*(*5*); *X25*(*6*)::
Line driver for transmitting X.25 packets over asynchronous serial lines.
Line driver for transmitting X.25 packets over asynchronous serial lines.
*6PACK*(*7*); *R3964*(*9*)::
Driver for Simatic R3964 module.
Driver for Simatic R3964 module.
*IRDA*(*11*)::
Linux IrDa (infrared data transmission) driver - see http://irda.sourceforge.net/
Linux IrDa (infrared data transmission) driver - see http://irda.sourceforge.net/
*HDLC*(*13*)::
Synchronous HDLC driver.
Synchronous HDLC driver.
*SYNC_PPP*(*14*)::
Synchronous PPP driver.
Synchronous PPP driver.
*HCI*(*15*)::
Bluetooth HCI UART driver.
Bluetooth HCI UART driver.
*GIGASET_M101*(*16*)::
Driver for Siemens Gigaset M101 serial DECT adapter.
Driver for Siemens Gigaset M101 serial DECT adapter.
*PPS*(*18*)::
Driver for serial line Pulse Per Second (PPS) source.
Driver for serial line Pulse Per Second (PPS) source.
*GSM0710*(*21*)::
Driver for GSM 07.10 multiplexing protocol modem (CMUX).
Driver for GSM 07.10 multiplexing protocol modem (CMUX).
== OPTIONS
*-1*, *--onestopbit*::
Set the number of stop bits of the serial line to one.
Set the number of stop bits of the serial line to one.
*-2*, *--twostopbits*::
Set the number of stop bits of the serial line to two.
Set the number of stop bits of the serial line to two.
*-7*, *--sevenbits*::
Set the character size of the serial line to 7 bits.
Set the character size of the serial line to 7 bits.
*-8*, *--eightbits*::
Set the character size of the serial line to 8 bits.
Set the character size of the serial line to 8 bits.
*-d*, *--debug*::
Keep *ldattach* in the foreground so that it can be interrupted or debugged, and to print verbose messages about its progress to standard error output.
Keep *ldattach* in the foreground so that it can be interrupted or debugged, and to print verbose messages about its progress to standard error output.
*-e*, *--evenparity*::
Set the parity of the serial line to even.
Set the parity of the serial line to even.
*-i*, *--iflag* [*-*]****__value__...::
Set the specified bits in the c_iflag word of the serial line. The given _value_ may be a number or a symbolic name. If _value_ 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.
*-i*, *--iflag* [*-*]_value_...::
Set the specified bits in the c_iflag word of the serial line. The given _value_ may be a number or a symbolic name. If _value_ 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.
*-n*, *--noparity*::
Set the parity of the serial line to none.
Set the parity of the serial line to none.
*-o*, *--oddparity*::
Set the parity of the serial line to odd.
Set the parity of the serial line to odd.
*-s*, *--speed* _value_::
Set the speed (the baud rate) of the serial line to the specified _value_.
Set the speed (the baud rate) of the serial line to the specified _value_.
*-c*, *--intro-command* _string_::
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 ´AT+CMUX=0BSOLr´ is commonly suitable to switch the modem into the CMUX mode.
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 'AT+CMUX=0\r' is commonly suitable to switch the modem into the CMUX mode.
*-p*, *--pause* _value_::
Sleep for _value_ seconds before the invocation of ldattach. Default is one second.
Sleep for _value_ seconds before the invocation of ldattach. Default is one second.
*-V*, *--version*::
Display version information and exit.
Display version information and exit.
*-h*, *--help*::
Display help text and exit.
Display help text and exit.
== AUTHORS

54
sys-utils/losetup.8.adoc
View File

@ -51,73 +51,73 @@ The loop device setup is not an atomic operation when used with *--find*, and *l
The _size_ and _offset_ 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.
*-a*, *--all*::
Show the status of all loop devices. Note that not all information is accessible for non-root users. See also *--list*. The old output format (as printed without *--list)* is deprecated.
Show the status of all loop devices. Note that not all information is accessible for non-root users. See also *--list*. The old output format (as printed without *--list)* is deprecated.
*-d*, *--detach* _loopdev_...::
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 *EBUSY* error anymore if device is actively used by system, but it is marked by autoclear flag and destroyed later.
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 *EBUSY* error anymore if device is actively used by system, but it is marked by autoclear flag and destroyed later.
*-D*, *--detach-all*::
Detach all associated loop devices.
Detach all associated loop devices.
*-f*, *--find* [_file_]::
Find the first unused loop device. If a _file_ argument is present, use the found device as loop device. Otherwise, just print its name.
Find the first unused loop device. If a _file_ argument is present, use the found device as loop device. Otherwise, just print its name.
*--show*::
Display the name of the assigned loop device if the *-f* option and a _file_ argument are present.
Display the name of the assigned loop device if the *-f* option and a _file_ argument are present.
*-L*, *--nooverlap*::
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 *--find*.
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 *--find*.
*-j*, *--associated* _file_ [*-o* _offset_]::
Show the status of all loop devices associated with the given _file_.
Show the status of all loop devices associated with the given _file_.
*-o*, *--offset* _offset_::
The data start is moved _offset_ bytes into the specified file or device. The _offset_ may be followed by the multiplicative suffixes; see above.
The data start is moved _offset_ bytes into the specified file or device. The _offset_ may be followed by the multiplicative suffixes; see above.
*--sizelimit* _size_::
The data end is set to no more than _size_ bytes after the data start. The _size_ may be followed by the multiplicative suffixes; see above.
The data end is set to no more than _size_ bytes after the data start. The _size_ may be followed by the multiplicative suffixes; see above.
*-b*, *--sector-size* _size_::
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.
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.
*-c*, *--set-capacity* _loopdev_::
Force the loop driver to reread the size of the file associated with the specified loop device.
Force the loop driver to reread the size of the file associated with the specified loop device.
*-P*, *--partscan*::
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 *--sector-size* together with *--partscan*.
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 *--sector-size* together with *--partscan*.
*-r*, *--read-only*::
Set up a read-only loop device.
Set up a read-only loop device.
*--direct-io*[**=on**|*off*]::
Enable or disable direct I/O for the backing file. The optional argument can be either *on* or *off*. If the argument is omitted, it defaults to *off*.
Enable or disable direct I/O for the backing file. The optional argument can be either *on* or *off*. If the argument is omitted, it defaults to *off*.
*-v*, *--verbose*::
Verbose mode.
Verbose mode.
*-l*, *--list*::
If a loop device or the *-a* 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 *--output*, *--noheadings*, *--raw*, and *--json*.
If a loop device or the *-a* 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 *--output*, *--noheadings*, *--raw*, and *--json*.
*-O*, *--output* _column_[,_column_]...::
Specify the columns that are to be printed for the *--list* output. Use *--help* to get a list of all supported columns.
Specify the columns that are to be printed for the *--list* output. Use *--help* to get a list of all supported columns.
*--output-all*::
Output all available columns.
Output all available columns.
*-n*, *--noheadings*::
Don't print headings for *--list* output format.
Don't print headings for *--list* output format.
*--raw*::
Use the raw *--list* output format.
Use the raw *--list* output format.
*-J*, *--json*::
Use JSON format for *--list* output.
Use JSON format for *--list* output.
*-V*, *--version*::
Display version information and exit.
Display version information and exit.
*-h*, *--help*::
Display help text and exit.
Display help text and exit.
== ENCRYPTION
@ -134,15 +134,15 @@ Since version 2.37 *losetup* uses *LOOP_CONFIGURE* ioctl to setup a new loop dev
== ENVIRONMENT
LOOPDEV_DEBUG=all::
enables debug output.
enables debug output.
== FILES
_/dev/loop[0..N]_::
loop block devices
loop block devices
_/dev/loop-control_::
loop control device
loop control device
== EXAMPLE
@ -159,7 +159,7 @@ The following commands can be used as an example of using the loop device.
== AUTHORS
mailto:kzak@redhat.com[Karel Zak], based on the original version from mailto:tytso@athena.mit.edu[Theodore Ts'o.]
mailto:kzak@redhat.com[Karel Zak], based on the original version from mailto:tytso@athena.mit.edu[Theodore Ts'o].
include::../man-common/bugreports.adoc[]

114
sys-utils/lscpu.1.adoc
View File

@ -33,117 +33,117 @@ The cache sizes are reported as summary from all CPUs. The versions before v2.34
Note that topology elements (core, socket, etc.) use a sequential unique ID starting from zero, but CPU logical numbers follow the kernel where there is no guarantee of sequential numbering.
*CPU*::
The logical CPU number of a CPU as used by the Linux kernel.
The logical CPU number of a CPU as used by the Linux kernel.
*CORE*::
The logical core number. A core can contain several CPUs.
The logical core number. A core can contain several CPUs.
*SOCKET*::
The logical socket number. A socket can contain several cores.
The logical socket number. A socket can contain several cores.
*CLUSTER*::
The logical cluster number. A cluster can contain several cores.
The logical cluster number. A cluster can contain several cores.
*BOOK*::
The logical book number. A book can contain several sockets.
The logical book number. A book can contain several sockets.
*DRAWER*::
The logical drawer number. A drawer can contain several books.
The logical drawer number. A drawer can contain several books.
*NODE*::
The logical NUMA node number. A node can contain several drawers.
The logical NUMA node number. A node can contain several drawers.
*CACHE*::
Information about how caches are shared between CPUs.
Information about how caches are shared between CPUs.
*ADDRESS*::
The physical address of a CPU.
The physical address of a CPU.
*ONLINE*::
Indicator that shows whether the Linux instance currently makes use of the CPU.
Indicator that shows whether the Linux instance currently makes use of the CPU.
*CONFIGURED*::
Indicator that shows if the hypervisor has allocated the CPU to the virtual hardware on which the Linux instance runs. CPUs that are configured can be set online by the Linux instance. This column contains data only if your hardware system and hypervisor support dynamic CPU resource allocation.
Indicator that shows if the hypervisor has allocated the CPU to the virtual hardware on which the Linux instance runs. CPUs that are configured can be set online by the Linux instance. This column contains data only if your hardware system and hypervisor support dynamic CPU resource allocation.
*POLARIZATION*::
This column contains data for Linux instances that run on virtual hardware with a hypervisor that can switch the CPU dispatching mode (polarization). The polarization can be: +
{nbsp} +
*horizontal*;;
The workload is spread across all available CPUs.
*vertical*;;
The workload is concentrated on few CPUs. +
{nbsp} +
For vertical polarization, the column also shows the degree of concentration, high, medium, or low. This column contains data only if your hardware system and hypervisor support CPU polarization.
This column contains data for Linux instances that run on virtual hardware with a hypervisor that can switch the CPU dispatching mode (polarization). The polarization can be:
+
*horizontal*;;
The workload is spread across all available CPUs.
*vertical*;;
The workload is concentrated on few CPUs.
+
For vertical polarization, the column also shows the degree of concentration, high, medium, or low. This column contains data only if your hardware system and hypervisor support CPU polarization.
*MAXMHZ*::
Maximum megahertz value for the CPU. Useful when *lscpu* is used as hardware inventory information gathering tool. Notice that the megahertz value is dynamic, and driven by CPU governor depending on current resource need.
Maximum megahertz value for the CPU. Useful when *lscpu* is used as hardware inventory information gathering tool. Notice that the megahertz value is dynamic, and driven by CPU governor depending on current resource need.
*MINMHZ*::
Minimum megahertz value for the CPU.
Minimum megahertz value for the CPU.
== OPTIONS
*-a*, *--all*::
Include lines for online and offline CPUs in the output (default for *-e*). This option may only be specified together with option *-e* or *-p*.
Include lines for online and offline CPUs in the output (default for *-e*). This option may only be specified together with option *-e* or *-p*.
*-B*, *--bytes*::
Print the sizes in bytes rather than in a human-readable format.
Print the sizes in bytes rather than in a human-readable format.
*-b*, *--online*::
Limit the output to online CPUs (default for *-p*). This option may only be specified together with option *-e* or *-p*.
Limit the output to online CPUs (default for *-p*). This option may only be specified together with option *-e* or *-p*.
*-C*, *--caches*[=_list_]::
Display details about CPU caches. For details about available information see *--help* output. +
{nbsp} +
If the _list_ argument is omitted, all columns for which data is available are included in the command output. +
{nbsp} +
When specifying the _list_ argument, the string of option, equal sign (=), and _list_ must not contain any blanks or other whitespace. Examples: '*-C=NAME,ONE-SIZE*' or '*--caches=NAME,ONE-SIZE*'. +
{nbsp} +
The default list of columns may be extended if list is specified in the format +list (e.g., lscpu -C=+ALLOC-POLICY).
Display details about CPU caches. For details about available information see *--help* output.
+
If the _list_ argument is omitted, all columns for which data is available are included in the command output.
+
When specifying the _list_ argument, the string of option, equal sign (=), and _list_ must not contain any blanks or other whitespace. Examples: '*-C=NAME,ONE-SIZE*' or '*--caches=NAME,ONE-SIZE*'.
+
The default list of columns may be extended if list is specified in the format +list (e.g., lscpu -C=+ALLOC-POLICY).
*-c*, *--offline*::
Limit the output to offline CPUs. This option may only be specified together with option *-e* or *-p*.
Limit the output to offline CPUs. This option may only be specified together with option *-e* or *-p*.
*-e*, *--extended*[=_list_]::
Display the CPU information in human-readable format. +
{nbsp} +
If the _list_ argument is omitted, all columns for which data is available are included in the command output. +
{nbsp} +
When specifying the _list_ argument, the string of option, equal sign (=), and _list_ must not contain any blanks or other whitespace. Examples: '*-e=cpu,node*' or '*--extended=cpu,node*'. +
{nbsp} +
The default list of columns may be extended if list is specified in the format +list (e.g., lscpu -e=+MHZ).
Display the CPU information in human-readable format.
+
If the _list_ argument is omitted, all columns for which data is available are included in the command output.
+
When specifying the _list_ argument, the string of option, equal sign (=), and _list_ must not contain any blanks or other whitespace. Examples: '*-e=cpu,node*' or '*--extended=cpu,node*'.
+
The default list of columns may be extended if list is specified in the format +list (e.g., lscpu -e=+MHZ).
*-h*, *--help*::
Display help text and exit.
Display help text and exit.
*-J*, *--json*::
Use JSON output format for the default summary or extended output (see *--extended*).
Use JSON output format for the default summary or extended output (see *--extended*).
*-p*, *--parse*[=_list_]::
Optimize the command output for easy parsing. +
{nbsp} +
If the _list_ argument is omitted, the command output is compatible with earlier versions of *lscpu*. In this compatible format, two commas are used to separate CPU cache columns. If no CPU caches are identified the cache column is omitted. If the _list_ argument is used, cache columns are separated with a colon (:). +
{nbsp} +
When specifying the _list_ argument, the string of option, equal sign (=), and _list_ must not contain any blanks or other whitespace. Examples: '*-p=cpu,node*' or '*--parse=cpu,node*'. +
{nbsp} +
The default list of columns may be extended if list is specified in the format +list (e.g., lscpu -p=+MHZ).
Optimize the command output for easy parsing.
+
If the _list_ argument is omitted, the command output is compatible with earlier versions of *lscpu*. In this compatible format, two commas are used to separate CPU cache columns. If no CPU caches are identified the cache column is omitted. If the _list_ argument is used, cache columns are separated with a colon (:).
+
When specifying the _list_ argument, the string of option, equal sign (=), and _list_ must not contain any blanks or other whitespace. Examples: '*-p=cpu,node*' or '*--parse=cpu,node*'.
+
The default list of columns may be extended if list is specified in the format +list (e.g., lscpu -p=+MHZ).
*-s*, *--sysroot* _directory_::
Gather CPU data for a Linux instance other than the instance from which the *lscpu* command is issued. The specified _directory_ is the system root of the Linux instance to be inspected.
Gather CPU data for a Linux instance other than the instance from which the *lscpu* command is issued. The specified _directory_ is the system root of the Linux instance to be inspected.
*-x*, *--hex*::
Use hexadecimal masks for CPU sets (for example "ff"). The default is to print the sets in list format (for example 0,1). Note that before version 2.30 the mask has been printed with 0x prefix.
Use hexadecimal masks for CPU sets (for example "ff"). The default is to print the sets in list format (for example 0,1). Note that before version 2.30 the mask has been printed with 0x prefix.
*-y*, *--physical*::
Display physical IDs for all columns with topology elements (core, socket, etc.). Other than logical IDs, which are assigned by *lscpu*, physical IDs are platform-specific values that are provided by the kernel. Physical IDs are not necessarily unique and they might not be arranged sequentially. If the kernel could not retrieve a physical ID for an element *lscpu* prints the dash (-) character. +
{nbsp} +
The CPU logical numbers are not affected by this option.
Display physical IDs for all columns with topology elements (core, socket, etc.). Other than logical IDs, which are assigned by *lscpu*, physical IDs are platform-specific values that are provided by the kernel. Physical IDs are not necessarily unique and they might not be arranged sequentially. If the kernel could not retrieve a physical ID for an element *lscpu* prints the dash (-) character.
+
The CPU logical numbers are not affected by this option.
*-V*, *--version*::
Display version information and exit.
Display version information and exit.
*--output-all*::
Output all available columns. This option must be combined with either *--extended*, *--parse* or *--caches*.
Output all available columns. This option must be combined with either *--extended*, *--parse* or *--caches*.
== BUGS
@ -155,8 +155,8 @@ On virtual hardware the number of cores per socket, etc. can be wrong.
== AUTHORS
mailto:qcai@redhat.com[Cai Qian] +
mailto:kzak@redhat.com[Karel Zak] +
mailto:qcai@redhat.com[Cai Qian],
mailto:kzak@redhat.com[Karel Zak],
mailto:heiko.carstens@de.ibm.com[Heiko Carstens]
== SEE ALSO

48
sys-utils/lsipc.1.adoc
View File

@ -21,79 +21,79 @@ lsipc - show information on IPC facilities currently employed in the system
== OPTIONS
*-i*, *--id* _id_::
Show full details on just the one resource element identified by _id_. This option needs to be combined with one of the three resource options: *-m*, *-q* or *-s*. It is possible to override the default output format for this option with the *--list*, *--raw*, *--json* or *--export* option.
Show full details on just the one resource element identified by _id_. This option needs to be combined with one of the three resource options: *-m*, *-q* or *-s*. It is possible to override the default output format for this option with the *--list*, *--raw*, *--json* or *--export* option.
*-g*, *--global*::
Show system-wide usage and limits of IPC resources. This option may be combined with one of the three resource options: *-m*, *-q* or *-s*. The default is to show information about all resources.
Show system-wide usage and limits of IPC resources. This option may be combined with one of the three resource options: *-m*, *-q* or *-s*. The default is to show information about all resources.
*-h*, *--help*::
Display help text and exit.
Display help text and exit.
*-V*, *--version*::
Display version information and exit.
Display version information and exit.
=== Resource options
*-m*, *--shmems*::
Write information about active shared memory segments.
Write information about active shared memory segments.
*-q*, *--queues*::
Write information about active message queues.
Write information about active message queues.
*-s*, *--semaphores*::
Write information about active semaphore sets.
Write information about active semaphore sets.
=== Output formatting
*-c*, *--creator*::
Show creator and owner.
Show creator and owner.
*-e*, *--export*::
Produce output in the form of key="value" pairs. All potentially unsafe value characters are hex-escaped (\x<code>). The key (variable name) will be modified to contain only characters allowed for a shell variable identifiers, for example, USE_PCT instead of USE%.
Produce output in the form of key="value" pairs. All potentially unsafe value characters are hex-escaped (\x<code>). The key (variable name) will be modified to contain only characters allowed for a shell variable identifiers, for example, USE_PCT instead of USE%.
*-J*, *--json*::
Use the JSON output format.
Use the JSON output format.
*-l*, *--list*::
Use the list output format. This is the default, except when *--id* is used.
Use the list output format. This is the default, except when *--id* is used.
*-n*, *--newline*::
Display each piece of information on a separate line.
Display each piece of information on a separate line.
*--noheadings*::
Do not print a header line.
Do not print a header line.
*--notruncate*::
Don't truncate output.
Don't truncate output.
*-o*, *--output* _list_::
Specify which output columns to print. Use *--help* to get a list of all supported columns.
Specify which output columns to print. Use *--help* to get a list of all supported columns.
*-b*, *--bytes*::
Print size in bytes rather than in human readable format.
Print size in bytes rather than in human readable format.
*-r*, *--raw*::
Raw output (no columnation).
Raw output (no columnation).
*-t*, *--time*::
Write time information. The time of the last control operation that changed the access permissions for all facilities, the time of the last *msgsnd*(2) and *msgrcv*(2) operations on message queues, the time of the last *shmat*(2) and *shmdt*(2) operations on shared memory, and the time of the last *semop*(2) operation on semaphores.
Write time information. The time of the last control operation that changed the access permissions for all facilities, the time of the last *msgsnd*(2) and *msgrcv*(2) operations on message queues, the time of the last *shmat*(2) and *shmdt*(2) operations on shared memory, and the time of the last *semop*(2) operation on semaphores.
*--time-format* _type_::
Display dates in short, full or iso format. The default is short, this time format is designed to be space efficient and human readable.
Display dates in short, full or iso format. The default is short, this time format is designed to be space efficient and human readable.
*-P*, *--numeric-perms*::
Print numeric permissions in PERMS column.
Print numeric permissions in PERMS column.
== EXIT STATUS
0::
if OK,
if OK,
1::
if incorrect arguments specified,
if incorrect arguments specified,
2::
if a serious error occurs.
if a serious error occurs.
== HISTORY
@ -101,7 +101,7 @@ The *lsipc* utility is inspired by the *ipcs*(1) utility.
== AUTHORS
mailto:ooprala@redhat.com[Ondrej Oprala] +
mailto:ooprala@redhat.com[Ondrej Oprala],
mailto:kzak@redhat.com[Karel Zak]
== SEE ALSO

20
sys-utils/lsirq.1.adoc
View File

@ -23,33 +23,33 @@ The default output is subject to change. So whenever possible, you should avoid
== OPTIONS
*-n*, *--noheadings*::
Don't print headings.
Don't print headings.
*-o*, *--output* _list_::
Specify which output columns to print. Use *--help* to get a list of all supported columns. The default list of columns may be extended if list is specified in the format _+list_.
Specify which output columns to print. Use *--help* to get a list of all supported columns. The default list of columns may be extended if list is specified in the format _+list_.
*-s*, *--sort* _column_::
Specify sort criteria by column name. See *--help* output to get column names.
Specify sort criteria by column name. See *--help* output to get column names.
*-J*, *--json*::
Use JSON output format.
Use JSON output format.
*-P*, *--pairs*::
Produce output in the form of key="value" pairs. All potentially unsafe characters are hex-escaped (\x<code>).
Produce output in the form of key="value" pairs. All potentially unsafe characters are hex-escaped (\x<code>).
*-S*, *--softirq*::
Show softirqs information.
Show softirqs information.
*-V*, *--version*::
Display version information and exit.
Display version information and exit.
*-h*, *--help*::
Display help text and exit.
Display help text and exit.
== AUTHORS
mailto:pizhenwei@bytedance.com[Zhenwei Pi] +
mailto:kerolasa@iki.fi[Sami Kerola] +
mailto:pizhenwei@bytedance.com[Zhenwei Pi],
mailto:kerolasa@iki.fi[Sami Kerola],
mailto:kzak@redhat.com[Karel Zak]
include::../man-common/bugreports.adoc[]

26
sys-utils/lsmem.1.adoc
View File

@ -31,43 +31,43 @@ Use the *--help* option to see the columns description.
== OPTIONS
*-a*, *--all*::
List each individual memory block, instead of combining memory blocks with similar attributes.
List each individual memory block, instead of combining memory blocks with similar attributes.
*-b*, *--bytes*::
Print the SIZE column in bytes rather than in a human-readable format.
Print the SIZE column in bytes rather than in a human-readable format.
*-h*, *--help*::
Display help text and exit.
Display help text and exit.
*-J*, *--json*::
Use JSON output format.
Use JSON output format.
*-n*, *--noheadings*::
Do not print a header line.
Do not print a header line.
*-o*, *--output* _list_::
Specify which output columns to print. Use *--help* to get a list of all supported columns. The default list of columns may be extended if _list_ is specified in the format **+**__list__ (e.g., *lsmem -o +NODE*).
Specify which output columns to print. Use *--help* to get a list of all supported columns. The default list of columns may be extended if _list_ is specified in the format **+**__list__ (e.g., *lsmem -o +NODE*).
*--output-all*::
Output all available columns.
Output all available columns.
*-P*, *--pairs*::
Produce output in the form of key="value" pairs. All potentially unsafe value characters are hex-escaped (\x<code>).
Produce output in the form of key="value" pairs. All potentially unsafe value characters are hex-escaped (\x<code>).
*-r*, *--raw*::
Produce output in raw format. All potentially unsafe characters are hex-escaped (\x<code>).
Produce output in raw format. All potentially unsafe characters are hex-escaped (\x<code>).
*-S*, *--split* _list_::
Specify which columns (attributes) use to split memory blocks to ranges. The supported columns are STATE, REMOVABLE, NODE and ZONES, or "none". The other columns are silently ignored. For more details see DESCRIPTION above.
Specify which columns (attributes) use to split memory blocks to ranges. The supported columns are STATE, REMOVABLE, NODE and ZONES, or "none". The other columns are silently ignored. For more details see DESCRIPTION above.
*-s*, *--sysroot* _directory_::
Gather memory data for a Linux instance other than the instance from which the *lsmem* command is issued. The specified _directory_ is the system root of the Linux instance to be inspected.
Gather memory data for a Linux instance other than the instance from which the *lsmem* command is issued. The specified _directory_ is the system root of the Linux instance to be inspected.
*-V*, *--version*::
Display version information and exit.
Display version information and exit.
*--summary*[=_when_]::
This option controls summary lines output. The optional argument _when_ can be *never*, *always* or *only*. If the _when_ argument is omitted, it defaults to *"only"*. The summary output is suppressed for *--raw*, *--pairs* and *--json*.
This option controls summary lines output. The optional argument _when_ can be *never*, *always* or *only*. If the _when_ argument is omitted, it defaults to *"only"*. The summary output is suppressed for *--raw*, *--pairs* and *--json*.
== AUTHORS

28
sys-utils/lsns.8.adoc
View File

@ -32,42 +32,42 @@ Note that *lsns* reads information directly from the _/proc_ filesystem and for
== OPTIONS
*-J*, *--json*::
Use JSON output format.
Use JSON output format.
*-l*, *--list*::
Use list output format.
Use list output format.
*-n*, *--noheadings*::
Do not print a header line.
Do not print a header line.
*-o*, *--output* _list_::
Specify which output columns to print. Use *--help* to get a list of all supported columns. +
{nbsp} +
The default list of columns may be extended if _list_ is specified in the format **+**__list__ (e.g., *lsns -o +PATH*).
Specify which output columns to print. Use *--help* to get a list of all supported columns.
+
The default list of columns may be extended if _list_ is specified in the format **+**__list__ (e.g., *lsns -o +PATH*).
*--output-all*::
Output all available columns.
Output all available columns.
*-p*, *--task* _PID_::
Display only the namespaces held by the process with this _PID_.
Display only the namespaces held by the process with this _PID_.
*-r*, *--raw*::
Use the raw output format.
Use the raw output format.
*-t*, *--type* _type_::
Display the specified _type_ of namespaces only. The supported types are *mnt*, *net*, *ipc*, *user*, *pid*, *uts*, *cgroup* and *time*. This option may be given more than once.
Display the specified _type_ of namespaces only. The supported types are *mnt*, *net*, *ipc*, *user*, *pid*, *uts*, *cgroup* and *time*. This option may be given more than once.
*-u*, *--notruncate*::
Do not truncate text in columns.
Do not truncate text in columns.
*-W*, *--nowrap*::
Do not use multi-line text in columns.
Do not use multi-line text in columns.
*-V*, *--version*::
Display version information and exit.
Display version information and exit.
*-h*, *--help*::
Display help text and exit.
Display help text and exit.
== AUTHORS

904
sys-utils/mount.8.adoc
View File

File diff suppressed because it is too large Load Diff

20
sys-utils/mountpoint.1.adoc
View File

@ -23,40 +23,40 @@ mountpoint - see if a directory or file is a mountpoint
== OPTIONS
*-d*, *--fs-devno*::
Show the major/minor numbers of the device that is mounted on the given directory.
Show the major/minor numbers of the device that is mounted on the given directory.
*-q*, *--quiet*::
Be quiet - don't print anything.
Be quiet - don't print anything.
*--nofollow*::
Do not follow symbolic link if it the last element of the _directory_ path.
Do not follow symbolic link if it the last element of the _directory_ path.
*-x*, *--devno*::
Show the major/minor numbers of the given blockdevice on standard output.
Show the major/minor numbers of the given blockdevice on standard output.
*-V*, *--version*::
Display version information and exit.
Display version information and exit.
*-h*, *--help*::
Display help text and exit.
Display help text and exit.
== EXIT STATUS
*mountpoint* has the following exit status values:
*0*::
success; the directory is a mountpoint, or device is block device on *--devno*
success; the directory is a mountpoint, or device is block device on *--devno*
*1*::
failure; incorrect invocation, permissions or system error
failure; incorrect invocation, permissions or system error
*32*::
failure; the directory is not a mountpoint, or device is not a block device on *--devno*
failure; the directory is not a mountpoint, or device is not a block device on *--devno*
== ENVIRONMENT
LIBMOUNT_DEBUG=all::
enables libmount debug output.
enables libmount debug output.
== NOTES

108
sys-utils/nsenter.1.adoc
View File

@ -21,118 +21,118 @@ The *nsenter* command executes _program_ in the namespace(s) that are specified
Enterable namespaces are:
*mount namespace*::
Mounting and unmounting filesystems will not affect the rest of the system, except for filesystems which are explicitly marked as shared (with *mount --make-shared*; see _/proc/self/mountinfo_ for the *shared* flag). For further details, see *mount_namespaces*(7) and the discussion of the *CLONE_NEWNS* flag in *clone*(2).
Mounting and unmounting filesystems will not affect the rest of the system, except for filesystems which are explicitly marked as shared (with *mount --make-shared*; see _/proc/self/mountinfo_ for the *shared* flag). For further details, see *mount_namespaces*(7) and the discussion of the *CLONE_NEWNS* flag in *clone*(2).
*UTS namespace*::
Setting hostname or domainname will not affect the rest of the system. For further details, see *uts_namespaces*(7).
Setting hostname or domainname will not affect the rest of the system. For further details, see *uts_namespaces*(7).
*IPC namespace*::
The process will have an independent namespace for POSIX message queues as well as System V message queues, semaphore sets and shared memory segments. For further details, see *ipc_namespaces*(7).
The process will have an independent namespace for POSIX message queues as well as System V message queues, semaphore sets and shared memory segments. For further details, see *ipc_namespaces*(7).
*network namespace*::
The process will have independent IPv4 and IPv6 stacks, IP routing tables, firewall rules, the _/proc/net_ and _/sys/class/net_ directory trees, sockets, etc. For further details, see *network_namespaces*(7).
The process will have independent IPv4 and IPv6 stacks, IP routing tables, firewall rules, the _/proc/net_ and _/sys/class/net_ directory trees, sockets, etc. For further details, see *network_namespaces*(7).
*PID namespace*::
Children will have a set of PID to process mappings separate from the *nsenter* process. *nsenter* will fork by default if changing the PID namespace, so that the new program and its children share the same PID namespace and are visible to each other. If *--no-fork* is used, the new program will be exec'ed without forking. For further details, see *pid_namespaces*(7).
Children will have a set of PID to process mappings separate from the *nsenter* process. *nsenter* will fork by default if changing the PID namespace, so that the new program and its children share the same PID namespace and are visible to each other. If *--no-fork* is used, the new program will be exec'ed without forking. For further details, see *pid_namespaces*(7).
*user namespace*::
The process will have a distinct set of UIDs, GIDs and capabilities. For further details, see *user_namespaces*(7).
The process will have a distinct set of UIDs, GIDs and capabilities. For further details, see *user_namespaces*(7).
*cgroup namespace*::
The process will have a virtualized view of _/proc/self/cgroup_, and new cgroup mounts will be rooted at the namespace cgroup root. For further details, see *cgroup_namespaces*(7).
The process will have a virtualized view of _/proc/self/cgroup_, and new cgroup mounts will be rooted at the namespace cgroup root. For further details, see *cgroup_namespaces*(7).
*time namespace*::
The process can have a distinct view of *CLOCK_MONOTONIC* and/or *CLOCK_BOOTTIME* which can be changed using _/proc/self/timens_offsets_. For further details, see *time_namespaces*(7).
The process can have a distinct view of *CLOCK_MONOTONIC* and/or *CLOCK_BOOTTIME* which can be changed using _/proc/self/timens_offsets_. For further details, see *time_namespaces*(7).
== OPTIONS
Various of the options below that relate to namespaces take an optional _file_ argument. This should be one of the _/proc/[pid]/ns/+++*+++_ files described in *namespaces*(7), or the pathname of a bind mount that was created on one of those files.
//TRANSLATORS: Keep {asterisk} untranslated.
Various of the options below that relate to namespaces take an optional _file_ argument. This should be one of the _/proc/[pid]/ns/{asterisk}_ files described in *namespaces*(7), or the pathname of a bind mount that was created on one of those files.
//TRANSLATORS: Keep {asterisk} untranslated.
*-a*, *--all*::
Enter all namespaces of the target process by the default _/proc/[pid]/ns/+++*+++_ namespace paths. The default paths to the target process namespaces may be overwritten by namespace specific options (e.g., *--all --mount*=[_path_]). +
{nbsp} +
The user namespace will be ignored if the same as the caller's current user namespace. It prevents a caller that has dropped capabilities from regaining those capabilities via a call to setns(). See *setns*(2) for more details.
Enter all namespaces of the target process by the default _/proc/[pid]/ns/{asterisk}_ namespace paths. The default paths to the target process namespaces may be overwritten by namespace specific options (e.g., *--all --mount*=[_path_]).
+
The user namespace will be ignored if the same as the caller's current user namespace. It prevents a caller that has dropped capabilities from regaining those capabilities via a call to setns(). See *setns*(2) for more details.
*-t*, *--target* _PID_::
Specify a target process to get contexts from. The paths to the contexts specified by _pid_ are: +
{nbsp} +
____
/proc/_pid_/ns/mnt;;
the mount namespace
/proc/_pid_/ns/uts;;
the UTS namespace
/proc/_pid_/ns/ipc;;
the IPC namespace
/proc/_pid_/ns/net;;
the network namespace
/proc/_pid_/ns/pid;;
the PID namespace
/proc/_pid_/ns/user;;
the user namespace
/proc/_pid_/ns/cgroup;;
the cgroup namespace
/proc/_pid_/ns/time;;
the time namespace
/proc/_pid_/root;;
the root directory
/proc/_pid_/cwd;;
the working directory respectively
____
Specify a target process to get contexts from. The paths to the contexts specified by _pid_ are:
/proc/_pid_/ns/mnt;;
the mount namespace
/proc/_pid_/ns/uts;;
the UTS namespace
/proc/_pid_/ns/ipc;;
the IPC namespace
/proc/_pid_/ns/net;;
the network namespace
/proc/_pid_/ns/pid;;
the PID namespace
/proc/_pid_/ns/user;;
the user namespace
/proc/_pid_/ns/cgroup;;
the cgroup namespace
/proc/_pid_/ns/time;;
the time namespace
/proc/_pid_/root;;
the root directory
/proc/_pid_/cwd;;
the working directory respectively
*-m*, *--mount*[=_file_]::
Enter the mount namespace. If no file is specified, enter the mount namespace of the target process. If _file_ is specified, enter the mount namespace specified by _file_.
Enter the mount namespace. If no file is specified, enter the mount namespace of the target process. If _file_ is specified, enter the mount namespace specified by _file_.
*-u*, *--uts*[=_file_]::
Enter the UTS namespace. If no file is specified, enter the UTS namespace of the target process. If _file_ is specified, enter the UTS namespace specified by _file_.
Enter the UTS namespace. If no file is specified, enter the UTS namespace of the target process. If _file_ is specified, enter the UTS namespace specified by _file_.
*-i*, *--ipc*[=_file_]::
Enter the IPC namespace. If no file is specified, enter the IPC namespace of the target process. If _file_ is specified, enter the IPC namespace specified by _file_.
Enter the IPC namespace. If no file is specified, enter the IPC namespace of the target process. If _file_ is specified, enter the IPC namespace specified by _file_.
*-n*, *--net*[=_file_]::
Enter the network namespace. If no file is specified, enter the network namespace of the target process. If _file_ is specified, enter the network namespace specified by _file_.
Enter the network namespace. If no file is specified, enter the network namespace of the target process. If _file_ is specified, enter the network namespace specified by _file_.
*-p*, *--pid*[=_file_]::
Enter the PID namespace. If no file is specified, enter the PID namespace of the target process. If _file_ is specified, enter the PID namespace specified by _file_.
Enter the PID namespace. If no file is specified, enter the PID namespace of the target process. If _file_ is specified, enter the PID namespace specified by _file_.
*-U*, *--user*[=_file_]::
Enter the user namespace. If no file is specified, enter the user namespace of the target process. If _file_ is specified, enter the user namespace specified by _file_. See also the *--setuid* and *--setgid* options.
Enter the user namespace. If no file is specified, enter the user namespace of the target process. If _file_ is specified, enter the user namespace specified by _file_. See also the *--setuid* and *--setgid* options.
*-C*, *--cgroup*[=_file_]::
Enter the cgroup namespace. If no file is specified, enter the cgroup namespace of the target process. If _file_ is specified, enter the cgroup namespace specified by _file_.
Enter the cgroup namespace. If no file is specified, enter the cgroup namespace of the target process. If _file_ is specified, enter the cgroup namespace specified by _file_.
*-T*, *--time*[=_file_]::
Enter the time namespace. If no file is specified, enter the time namespace of the target process. If _file_ is specified, enter the time namespace specified by _file_.
Enter the time namespace. If no file is specified, enter the time namespace of the target process. If _file_ is specified, enter the time namespace specified by _file_.
*-G*, *--setgid* _gid_::
Set the group ID which will be used in the entered namespace and drop supplementary groups. *nsenter* always sets GID for user namespaces, the default is 0.
Set the group ID which will be used in the entered namespace and drop supplementary groups. *nsenter* always sets GID for user namespaces, the default is 0.
*-S*, *--setuid* _uid_::
Set the user ID which will be used in the entered namespace. *nsenter* always sets UID for user namespaces, the default is 0.
Set the user ID which will be used in the entered namespace. *nsenter* always sets UID for user namespaces, the default is 0.
*--preserve-credentials*::
Don't modify UID and GID when enter user namespace. The default is to drops supplementary groups and sets GID and UID to 0.
Don't modify UID and GID when enter user namespace. The default is to drops supplementary groups and sets GID and UID to 0.
*-r*, *--root*[=_directory_]::
Set the root directory. If no directory is specified, set the root directory to the root directory of the target process. If directory is specified, set the root directory to the specified directory.
Set the root directory. If no directory is specified, set the root directory to the root directory of the target process. If directory is specified, set the root directory to the specified directory.
*-w*, *--wd*[=_directory_]::
Set the working directory. If no directory is specified, set the working directory to the working directory of the target process. If directory is specified, set the working directory to the specified directory.
Set the working directory. If no directory is specified, set the working directory to the working directory of the target process. If directory is specified, set the working directory to the specified directory.
*-F*, *--no-fork*::
Do not fork before exec'ing the specified program. By default, when entering a PID namespace, *nsenter* calls *fork* before calling *exec* so that any children will also be in the newly entered PID namespace.
Do not fork before exec'ing the specified program. By default, when entering a PID namespace, *nsenter* calls *fork* before calling *exec* so that any children will also be in the newly entered PID namespace.
*-Z*, *--follow-context*::
Set the SELinux security context used for executing a new process according to already running process specified by *--target* PID. (The util-linux has to be compiled with SELinux support otherwise the option is unavailable.)
Set the SELinux security context used for executing a new process according to already running process specified by *--target* PID. (The util-linux has to be compiled with SELinux support otherwise the option is unavailable.)
*-V*, *--version*::
Display version information and exit.
Display version information and exit.
*-h*, *--help*::
Display help text and exit.
Display help text and exit.
== AUTHORS
mailto:biederm@xmission.com[Eric Biederman] +
mailto:biederm@xmission.com[Eric Biederman],
mailto:kzak@redhat.com[Karel Zak]
== SEE ALSO

4
sys-utils/pivot_root.8.adoc
View File

@ -29,10 +29,10 @@ Note that *exec chroot* changes the running executable, which is necessary if th
== OPTIONS
*-V*, *--version*::
Display version information and exit.
Display version information and exit.
*-h*, *--help*::
Display help text and exit.
Display help text and exit.
== EXAMPLE

64
sys-utils/prlimit.1.adoc
View File

@ -10,6 +10,7 @@ May be distributed under the GNU General Public License
:man source: util-linux {release-version}
:page-layout: base
:command: prlimit
:colon: :
== NAME
@ -31,83 +32,84 @@ The _limits_ parameter is composed of a soft and a hard value, separated by a co
Because of the nature of limits, the soft limit must be lower or equal to the high limit (also called the ceiling). To see all available resource limits, refer to the RESOURCE OPTIONS section.
* _soft_+++:+++_hard_ Specify both limits.
* _soft_+++:+++ Specify only the soft limit.
* +++:+++_hard_ Specify only the hard limit.
//TRANSLATORS: Keep {colon} untranslated.
* _soft_{colon}_hard_ Specify both limits.
* _soft_{colon} Specify only the soft limit.
* {colon}__hard__ Specify only the hard limit.
* _value_ Specify both limits to the same value.
== GENERAL OPTIONS
*-h, --help*::
Display help text and exit.
Display help text and exit.
*--noheadings*::
Do not print a header line.
Do not print a header line.
*-o, --output* _list_::
Define the output columns to use. If no output arrangement is specified, then a default set is used. Use *--help* to get a list of all supported columns.
Define the output columns to use. If no output arrangement is specified, then a default set is used. Use *--help* to get a list of all supported columns.
*-p, --pid*::
Specify the process id; if none is given, the running process will be used.
Specify the process id; if none is given, the running process will be used.
*--raw*::
Use the raw output format.
Use the raw output format.
*--verbose*::
Verbose mode.
Verbose mode.
*-V, --version*::
Display version information and exit.
Display version information and exit.
== RESOURCE OPTIONS
*-c, --core*[=_limits_]::
Maximum size of a core file.
Maximum size of a core file.
*-d, --data*[=_limits_]::
Maximum data size.
Maximum data size.
*-e, --nice*[=_limits_]::
Maximum nice priority allowed to raise.
Maximum nice priority allowed to raise.
*-f, --fsize*[=_limits_]::
Maximum file size.
Maximum file size.
*-i, --sigpending*[=_limits_]::
Maximum number of pending signals.
Maximum number of pending signals.
*-l, --memlock*[=_limits_]::
Maximum locked-in-memory address space.
Maximum locked-in-memory address space.
*-m, --rss*[=_limits_]::
Maximum Resident Set Size (RSS).
Maximum Resident Set Size (RSS).
*-n, --nofile*[=_limits_]::
Maximum number of open files.
Maximum number of open files.
*-q, --msgqueue*[=_limits_]::
Maximum number of bytes in POSIX message queues.
Maximum number of bytes in POSIX message queues.
*-r, --rtprio*[=_limits_]::
Maximum real-time priority.
Maximum real-time priority.
*-s, --stack*[=_limits_]::
Maximum size of the stack.
Maximum size of the stack.
*-t, --cpu*[=_limits_]::
CPU time, in seconds.
CPU time, in seconds.
*-u, --nproc*[=_limits_]::
Maximum number of processes.
Maximum number of processes.
*-v, --as*[=_limits_]::
Address space limit.
Address space limit.
*-x, --locks*[=_limits_]::
Maximum number of file locks held.
Maximum number of file locks held.
*-y, --rttime*[=_limits_]::
Timeout for real-time tasks.
Timeout for real-time tasks.
== NOTES
@ -116,19 +118,19 @@ The *prlimit* system call is supported since Linux 2.6.36, older kernels will br
== EXAMPLES
*prlimit --pid 13134*::
Display limit values for all current resources.
Display limit values for all current resources.
*prlimit --pid 13134 --rss --nofile=1024:4095*::
Display the limits of the RSS, and set the soft and hard limits for the number of open files to 1024 and 4095, respectively.
Display the limits of the RSS, and set the soft and hard limits for the number of open files to 1024 and 4095, respectively.
*prlimit --pid 13134 --nproc=512:*::
Modify only the soft limit for the number of processes.
Modify only the soft limit for the number of processes.
*prlimit --pid $$ --nproc=unlimited*::
Set for the current process both the soft and ceiling values for the number of processes to unlimited.
Set for the current process both the soft and ceiling values for the number of processes to unlimited.
*prlimit --cpu=10 sort -u hugefile*::
Set both the soft and hard CPU time limit to ten seconds and run 'sort'.
Set both the soft and hard CPU time limit to ten seconds and run 'sort'.
== AUTHORS

30
sys-utils/readprofile.8.adoc
View File

@ -25,48 +25,48 @@ The *readprofile* command uses the _/proc/profile_ information to print ascii da
== OPTIONS
*-a*, *--all*::
Print all symbols in the mapfile. By default the procedures with reported ticks are not printed.
Print all symbols in the mapfile. By default the procedures with reported ticks are not printed.
*-b*, *--histbin*::
Print individual histogram-bin counts.
Print individual histogram-bin counts.
*-i*, *--info*::
Info. This makes *readprofile* 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 *make config*), or in the kernel's command line. If the *-t* (terse) switch is used together with *-i* only the decimal number is printed.
Info. This makes *readprofile* 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 *make config*), or in the kernel's command line. If the *-t* (terse) switch is used together with *-i* only the decimal number is printed.
*-m*, *--mapfile* _mapfile_::
Specify a mapfile, which by default is _/usr/src/linux/System.map_. You should specify the map file on cmdline if your current kernel isn't the last one you compiled, or if you keep System.map elsewhere. If the name of the map file ends with _.gz_ it is decompressed on the fly.
Specify a mapfile, which by default is _/usr/src/linux/System.map_. You should specify the map file on cmdline if your current kernel isn't the last one you compiled, or if you keep System.map elsewhere. If the name of the map file ends with _.gz_ it is decompressed on the fly.
*-M*, *--multiplier* _multiplier_::
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.
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.
*-p*, *--profile* _pro-file_::
Specify a different profiling buffer, which by default is _/proc/profile_. Using a different pro-file is useful if you want to `freeze' the kernel profiling at some time and read it later. The _/proc/profile_ file can be copied using *cat*(1) or *cp*(1). There is no more support for compressed profile buffers, like in *readprofile-1.1*, because the program needs to know the size of the buffer in advance.
Specify a different profiling buffer, which by default is _/proc/profile_. Using a different pro-file is useful if you want to `freeze' the kernel profiling at some time and read it later. The _/proc/profile_ file can be copied using *cat*(1) or *cp*(1). There is no more support for compressed profile buffers, like in *readprofile-1.1*, because the program needs to know the size of the buffer in advance.
*-r*, *--reset*::
Reset the profiling buffer. This can only be invoked by root, because _/proc/profile_ is readable by everybody but writable only by the superuser. However, you can make *readprofile* set-user-ID 0, in order to reset the buffer without gaining privileges.
Reset the profiling buffer. This can only be invoked by root, because _/proc/profile_ is readable by everybody but writable only by the superuser. However, you can make *readprofile* set-user-ID 0, in order to reset the buffer without gaining privileges.
*-s, --counters*::
Print individual counters within functions.
Print individual counters within functions.
*-v*, *--verbose*::
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.
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.
*-V*, *--version*::
Display version information and exit.
Display version information and exit.
*-h*, *--help*::
Display help text and exit.
Display help text and exit.
== FILES
_/proc/profile_::
A binary snapshot of the profiling buffer.
A binary snapshot of the profiling buffer.
_/usr/src/linux/System.map_::
The symbol table for the kernel.
The symbol table for the kernel.
_/usr/src/linux/*_::
The program being profiled :-)
The program being profiled :-)
== BUGS
@ -104,7 +104,7 @@ Look at all the kernel information, with ram addresses:
readprofile -av | less
....
Browse a `frozen' profile buffer for a non current kernel:
Browse a 'frozen' profile buffer for a non current kernel:
....
readprofile -p ~/profile.freeze -m /zImage.map.gz

14
sys-utils/renice.1.adoc
View File

@ -55,27 +55,27 @@ renice - alter priority of running processes
== OPTIONS
*-n*, *--priority* _priority_::
Specify the scheduling _priority_ to be used for the process, process group, or user. Use of the option *-n* or *--priority* is optional, but when used it must be the first argument.
Specify the scheduling _priority_ to be used for the process, process group, or user. Use of the option *-n* or *--priority* is optional, but when used it must be the first argument.
*-g*, *--pgrp*::
Interpret the succeeding arguments as process group IDs.
Interpret the succeeding arguments as process group IDs.
*-p*, *--pid*::
Interpret the succeeding arguments as process IDs (the default).
Interpret the succeeding arguments as process IDs (the default).
*-u*, *--user*::
Interpret the succeeding arguments as usernames or UIDs.
Interpret the succeeding arguments as usernames or UIDs.
*-V*, *--version*::
Display version information and exit.
Display version information and exit.
*-h*, *--help*::
Display help text and exit.
Display help text and exit.
== FILES
_/etc/passwd_::
to map user names to user IDs
to map user names to user IDs
== NOTES

26
sys-utils/rfkill.8.adoc
View File

@ -25,45 +25,45 @@ The default output is subject to change. So whenever possible, you should avoid
== OPTIONS
*-J*, *--json*::
Use JSON output format.
Use JSON output format.
*-n*, *--noheadings*::
Do not print a header line.
Do not print a header line.
*-o*, *--output*::
Specify which output columns to print. Use *--help* to get a list of available columns.
Specify which output columns to print. Use *--help* to get a list of available columns.
*--output-all*::
Output all available columns.
Output all available columns.
*-r*, *--raw*::
Use the raw output format.
Use the raw output format.
*--help*::
Display help text and exit.
Display help text and exit.
*--version*::
Display version information and exit.
Display version information and exit.
== COMMANDS
*help*::
Display help text and exit.
Display help text and exit.
*event*::
Listen for rfkill events and display them on stdout.
Listen for rfkill events and display them on stdout.
*list* [__id__|_type_ ...]::
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 *list* command _id_ or _type_ scope is appropriate before setting *block* or *unblock*. Special _all_ type string will match everything. Use of multiple _ID_ or _type_ arguments is supported.
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 *list* command _id_ or _type_ scope is appropriate before setting *block* or *unblock*. Special _all_ type string will match everything. Use of multiple _ID_ or _type_ arguments is supported.
**block id**|*type* [...]::
Disable the corresponding device.
Disable the corresponding device.
**unblock id**|*type* [...]::
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.
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.
**toggle id**|*type* [...]::
Enable or disable the the corresponding device.
Enable or disable the the corresponding device.
== EXAMPLE
....

73
sys-utils/rtcwake.8.adoc
View File

@ -31,13 +31,13 @@ The suspend setup may be interrupted by active hardware; for example wireless US
== OPTIONS
*-A*, *--adjfile* _file_::
Specify an alternative path to the adjust file.
Specify an alternative path to the adjust file.
*-a*, *--auto*::
Read the clock mode (whether the hardware clock is set to UTC or local time) from the _adjtime_ file, where *hwclock*(8) stores that information. This is the default.
Read the clock mode (whether the hardware clock is set to UTC or local time) from the _adjtime_ file, where *hwclock*(8) stores that information. This is the default.
*--date* _timestamp_::
Set the wakeup time to the value of the timestamp. Format of the timestamp can be any of the following:
Set the wakeup time to the value of the timestamp. Format of the timestamp can be any of the following:
[cols=",",]
|===
@ -52,55 +52,64 @@ The suspend setup may be interrupted by active hardware; for example wireless US
|===
*-d*, *--device* _device_::
Use the specified _device_ instead of *rtc0* as realtime clock. This option is only relevant if your system has more than one RTC. You may specify *rtc1*, *rtc2*, ... here.
Use the specified _device_ instead of *rtc0* as realtime clock. This option is only relevant if your system has more than one RTC. You may specify *rtc1*, *rtc2*, ... here.
*-l*, *--local*::
Assume that the hardware clock is set to local time, regardless of the contents of the _adjtime_ file.
Assume that the hardware clock is set to local time, regardless of the contents of the _adjtime_ file.
*--list-modes*::
List available *--mode* option arguments.
List available *--mode* option arguments.
*-m*, *--mode* _mode_::
Go into the given standby state. Valid values for _mode_ are: +
*standby*;;
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.
*freeze*;;
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.)
*mem*;;
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.
*disk*;;
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.
*off*;;
ACPI state S5 (Poweroff). This is done by calling '/sbin/shutdown'. Not officially supported by ACPI, but it usually works.
*no*;;
Don't suspend, only set the RTC wakeup time.
*on*;;
Don't suspend, but read the RTC device until an alarm time appears. This mode is useful for debugging.
*disable*;;
Disable a previously set alarm.
*show*;;
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".
Go into the given standby state. Valid values for _mode_ are:
*standby*;;
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.
*freeze*;;
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.)
*mem*;;
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.
*disk*;;
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.
*off*;;
ACPI state S5 (Poweroff). This is done by calling '/sbin/shutdown'. Not officially supported by ACPI, but it usually works.
*no*;;
Don't suspend, only set the RTC wakeup time.
*on*;;
Don't suspend, but read the RTC device until an alarm time appears. This mode is useful for debugging.
*disable*;;
Disable a previously set alarm.
*show*;;
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".
*-n*, *--dry-run*::
This option does everything apart from actually setting up the alarm, suspending the system, or waiting for the alarm.
This option does everything apart from actually setting up the alarm, suspending the system, or waiting for the alarm.
*-s*, *--seconds* _seconds_::
Set the wakeup time to _seconds_ in the future from now.
Set the wakeup time to _seconds_ in the future from now.
*-t*, *--time* _time_t_::
Set the wakeup time to the absolute time _time_t_. _time_t_ is the time in seconds since 1970-01-01, 00:00 UTC. Use the *date*(1) tool to convert between human-readable time and _time_t_.
Set the wakeup time to the absolute time _time_t_. _time_t_ is the time in seconds since 1970-01-01, 00:00 UTC. Use the *date*(1) tool to convert between human-readable time and _time_t_.
*-u*, *--utc*::
Assume that the hardware clock is set to UTC (Universal Time Coordinated), regardless of the contents of the _adjtime_ file.
Assume that the hardware clock is set to UTC (Universal Time Coordinated), regardless of the contents of the _adjtime_ file.
*-v*, *--verbose*::
Be verbose.
Be verbose.
*-V*, *--version*::
Display version information and exit.
Display version information and exit.
*-h*, *--help*::
Display help text and exit.
Display help text and exit.
== NOTES

36
sys-utils/setarch.8.adoc
View File

@ -29,52 +29,52 @@ Since version 2.33 the _arch_ command line argument is optional and *setarch* ma
== OPTIONS
*--list*::
List the architectures that *setarch* knows about. Whether *setarch* can actually set each of these architectures depends on the running kernel.
List the architectures that *setarch* knows about. Whether *setarch* can actually set each of these architectures depends on the running kernel.
*--uname-2.6*::
Causes the _program_ to see a kernel version number beginning with 2.6. Turns on *UNAME26*.
Causes the _program_ to see a kernel version number beginning with 2.6. Turns on *UNAME26*.
*-v*, *--verbose*::
Be verbose.
Be verbose.
*-3*, *--3gb*::
Specifies _program_ should use a maximum of 3GB of address space. Supported on x86. Turns on *ADDR_LIMIT_3GB*.
Specifies _program_ should use a maximum of 3GB of address space. Supported on x86. Turns on *ADDR_LIMIT_3GB*.
*--4gb*::
This option has no effect. It is retained for backward compatibility only, and may be removed in future releases.
This option has no effect. It is retained for backward compatibility only, and may be removed in future releases.
*-B*, *--32bit*::
Limit the address space to 32 bits to emulate hardware. Supported on ARM and Alpha. Turns on *ADDR_LIMIT_32BIT*.
Limit the address space to 32 bits to emulate hardware. Supported on ARM and Alpha. Turns on *ADDR_LIMIT_32BIT*.
*-F*, *--fdpic-funcptrs*::
Treat user-space function pointers to signal handlers as pointers to address descriptors. This option has no effect on architectures that do not support *FDPIC* ELF binaries. In kernel v4.14 support is limited to ARM, Blackfin, Fujitsu FR-V, and SuperH CPU architectures.
Treat user-space function pointers to signal handlers as pointers to address descriptors. This option has no effect on architectures that do not support *FDPIC* ELF binaries. In kernel v4.14 support is limited to ARM, Blackfin, Fujitsu FR-V, and SuperH CPU architectures.
*-I*, *--short-inode*::
Obsolete bug emulation flag. Turns on *SHORT_INODE*.
Obsolete bug emulation flag. Turns on *SHORT_INODE*.
*-L*, *--addr-compat-layout*::
Provide legacy virtual address space layout. Use when the _program_ binary does not have *PT_GNU_STACK* ELF header. Turns on *ADDR_COMPAT_LAYOUT*.
Provide legacy virtual address space layout. Use when the _program_ binary does not have *PT_GNU_STACK* ELF header. Turns on *ADDR_COMPAT_LAYOUT*.
*-R*, *--addr-no-randomize*::
Disables randomization of the virtual address space. Turns on *ADDR_NO_RANDOMIZE*.
Disables randomization of the virtual address space. Turns on *ADDR_NO_RANDOMIZE*.
*-S*, *--whole-seconds*::
Obsolete bug emulation flag. Turns on *WHOLE_SECONDS*.
Obsolete bug emulation flag. Turns on *WHOLE_SECONDS*.
*-T*, *--sticky-timeouts*::
This makes *select*(2), *pselect*(2), and *ppoll*(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 _program_ depends on this behavior. For more details see the timeout description in *select*(2) manual page. Turns on *STICKY_TIMEOUTS*.
This makes *select*(2), *pselect*(2), and *ppoll*(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 _program_ depends on this behavior. For more details see the timeout description in *select*(2) manual page. Turns on *STICKY_TIMEOUTS*.
*-X*, *--read-implies-exec*::
If this is set then *mmap*(3p) *PROT_READ* will also add the *PROT_EXEC* 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 *READ_IMPLIES_EXEC*.
If this is set then *mmap*(3p) *PROT_READ* will also add the *PROT_EXEC* 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 *READ_IMPLIES_EXEC*.
*-Z*, *--mmap-page-zero*::
SVr4 bug emulation that will set *mmap*(3p) page zero as read-only. Use when _program_ depends on this behavior, and the source code is not available to be fixed. Turns on *MMAP_PAGE_ZERO*.
SVr4 bug emulation that will set *mmap*(3p) page zero as read-only. Use when _program_ depends on this behavior, and the source code is not available to be fixed. Turns on *MMAP_PAGE_ZERO*.
*-V*, *--version*::
Display version information and exit.
Display version information and exit.
*-h*, *--help*::
Display help text and exit.
Display help text and exit.
== EXAMPLE
@ -87,8 +87,8 @@ setarch ppc32 --32bit rpmbuild --target=ppc --rebuild foo.src.rpm
== AUTHORS
mailto:sopwith@redhat.com[Elliot Lee] +
mailto:jnovy@redhat.com[Jindrich Novy] +
mailto:sopwith@redhat.com[Elliot Lee],
mailto:jnovy@redhat.com[Jindrich Novy],
mailto:kzak@redhat.com[Karel Zak]
== SEE ALSO

74
sys-utils/setpriv.1.adoc
View File

@ -23,77 +23,77 @@ In comparison to *su*(1) and *runuser*(1), *setpriv* neither uses PAM, nor does
== OPTIONS
*--clear-groups*::
Clear supplementary groups.
Clear supplementary groups.
*-d*, *--dump*::
Dump the current privilege state. This option can be specified more than once to show extra, mostly useless, information. Incompatible with all other options.
Dump the current privilege state. This option can be specified more than once to show extra, mostly useless, information. Incompatible with all other options.
*--groups* _group_...::
Set supplementary groups. The argument is a comma-separated list of GIDs or names.
Set supplementary groups. The argument is a comma-separated list of GIDs or names.
*--inh-caps* (*+*|*-*)_cap_...::
*--ambient-caps* (*+*|*-*)_cap_...::
*--bounding-set* (*+*|*-*)_cap_...::
Set the inheritable capabilities, ambient capabilities or the capability bounding set. See *capabilities*(7). The argument is a comma-separated list of **+**__cap__ and **-**__cap__ entries, which add or remove an entry respectively. _cap_ can either be a human-readable name as seen in *capabilities*(7) without the _cap__ prefix or of the format *cap_N*, where _N_ is the internal capability index used by Linux. *+all* and *-all* can be used to add or remove all caps. +
{nbsp} +
The set of capabilities starts out as the current inheritable set for *--inh-caps*, the current ambient set for *--ambient-caps* and the current bounding set for *--bounding-set*. +
{nbsp} +
Note the following restrictions (detailed in *capabilities*(7)) regarding modifications to these capability sets: +
{nbsp} +
* A capability can be added to the inheritable set only if it is currently present in the bounding set.
* A capability can be added to the ambient set only if it is currently present in both the permitted and inheritable sets.
* Notwithstanding the syntax offered by *setpriv*, the kernel does not permit capabilities to be added to the bounding set. +
{nbsp} +
If you drop a capability from the bounding set without also dropping it from the inheritable set, you are likely to become confused. Do not do that.
Set the inheritable capabilities, ambient capabilities or the capability bounding set. See *capabilities*(7). The argument is a comma-separated list of **+**__cap__ and **-**__cap__ entries, which add or remove an entry respectively. _cap_ can either be a human-readable name as seen in *capabilities*(7) without the _cap__ prefix or of the format *cap_N*, where _N_ is the internal capability index used by Linux. *+all* and *-all* can be used to add or remove all caps.
+
The set of capabilities starts out as the current inheritable set for *--inh-caps*, the current ambient set for *--ambient-caps* and the current bounding set for *--bounding-set*.
+
Note the following restrictions (detailed in *capabilities*(7)) regarding modifications to these capability sets:
* A capability can be added to the inheritable set only if it is currently present in the bounding set.
* A capability can be added to the ambient set only if it is currently present in both the permitted and inheritable sets.
* Notwithstanding the syntax offered by *setpriv*, the kernel does not permit capabilities to be added to the bounding set.
If you drop a capability from the bounding set without also dropping it from the inheritable set, you are likely to become confused. Do not do that.
*--keep-groups*::
Preserve supplementary groups. Only useful in conjunction with *--rgid*, *--egid*, or *--regid*.
Preserve supplementary groups. Only useful in conjunction with *--rgid*, *--egid*, or *--regid*.
*--init-groups*::
Initialize supplementary groups using initgroups3. Only useful in conjunction with *--ruid* or *--reuid*.
Initialize supplementary groups using initgroups3. Only useful in conjunction with *--ruid* or *--reuid*.
*--list-caps*::
List all known capabilities. This option must be specified alone.
List all known capabilities. This option must be specified alone.
*--no-new-privs*::
Set the _no_new_privs_ bit. With this bit set, *execve*(2) will not grant new privileges. For example, the set-user-ID and set-group-ID bits as well as file capabilities will be disabled. (Executing binaries with these bits set will still work, but they will not gain privileges. Certain LSMs, especially AppArmor, may result in failures to execute certain programs.) This bit is inherited by child processes and cannot be unset. See *prctl*(2) and _Documentation/prctl/no_new_privs.txt_ in the Linux kernel source. +
{nbsp} +
The _no_new_privs_ bit is supported since Linux 3.5.
Set the _no_new_privs_ bit. With this bit set, *execve*(2) will not grant new privileges. For example, the set-user-ID and set-group-ID bits as well as file capabilities will be disabled. (Executing binaries with these bits set will still work, but they will not gain privileges. Certain LSMs, especially AppArmor, may result in failures to execute certain programs.) This bit is inherited by child processes and cannot be unset. See *prctl*(2) and _Documentation/prctl/no_new_privs.txt_ in the Linux kernel source.
+
The _no_new_privs_ bit is supported since Linux 3.5.
*--rgid* _gid_, *--egid* _gid_, *--regid* _gid_::
Set the real, effective, or both GIDs. The _gid_ argument can be given as a textual group name. +
{nbsp} +
For safety, you must specify one of *--clear-groups*, *--groups*, *--keep-groups*, or *--init-groups* if you set any primary _gid_.
Set the real, effective, or both GIDs. The _gid_ argument can be given as a textual group name.
+
For safety, you must specify one of *--clear-groups*, *--groups*, *--keep-groups*, or *--init-groups* if you set any primary _gid_.
*--ruid* _uid_, *--euid* _uid_, *--reuid* _uid_::
Set the real, effective, or both UIDs. The _uid_ argument can be given as a textual login name. +
{nbsp} +
Setting a _uid_ or _gid_ does not change capabilities, although the exec call at the end might change capabilities. This means that, if you are root, you probably want to do something like: +
{nbsp} +
*setpriv --reuid=1000 --regid=1000 --inh-caps=-all*
Set the real, effective, or both UIDs. The _uid_ argument can be given as a textual login name.
+
Setting a _uid_ or _gid_ does not change capabilities, although the exec call at the end might change capabilities. This means that, if you are root, you probably want to do something like:
+
*setpriv --reuid=1000 --regid=1000 --inh-caps=-all*
*--securebits* (**+**|*-*)__securebit__...::
Set or clear securebits. The argument is a comma-separated list. The valid securebits are _noroot_, _noroot_locked_, _no_setuid_fixup_, _no_setuid_fixup_locked_, and _keep_caps_locked_. _keep_caps_ is cleared by *execve*(2) and is therefore not allowed.
Set or clear securebits. The argument is a comma-separated list. The valid securebits are _noroot_, _noroot_locked_, _no_setuid_fixup_, _no_setuid_fixup_locked_, and _keep_caps_locked_. _keep_caps_ is cleared by *execve*(2) and is therefore not allowed.
**--pdeathsig keep**|**clear**|*<signal>*::
Keep, clear or set the parent death signal. Some LSMs, most notably SELinux and AppArmor, clear the signal when the process' credentials change. Using *--pdeathsig keep* will restore the parent death signal after changing credentials to remedy that situation.
Keep, clear or set the parent death signal. Some LSMs, most notably SELinux and AppArmor, clear the signal when the process' credentials change. Using *--pdeathsig keep* will restore the parent death signal after changing credentials to remedy that situation.
*--selinux-label* _label_::
Request a particular SELinux transition (using a transition on exec, not dyntrans). This will fail and cause *setpriv* to abort if SELinux is not in use, and the transition may be ignored or cause *execve*(2) to fail at SELinux's whim. (In particular, this is unlikely to work in conjunction with _no_new_privs_.) This is similar to *runcon*(1).
Request a particular SELinux transition (using a transition on exec, not dyntrans). This will fail and cause *setpriv* to abort if SELinux is not in use, and the transition may be ignored or cause *execve*(2) to fail at SELinux's whim. (In particular, this is unlikely to work in conjunction with _no_new_privs_.) This is similar to *runcon*(1).
*--apparmor-profile* _profile_::
Request a particular AppArmor profile (using a transition on exec). This will fail and cause *setpriv* to abort if AppArmor is not in use, and the transition may be ignored or cause *execve*(2) to fail at AppArmor's whim.
Request a particular AppArmor profile (using a transition on exec). This will fail and cause *setpriv* to abort if AppArmor is not in use, and the transition may be ignored or cause *execve*(2) to fail at AppArmor's whim.
*--reset-env*::
Clears all the environment variables except *TERM*; initializes the environment variables *HOME*, *SHELL*, *USER*, *LOGNAME* according to the user's passwd entry; sets *PATH* to _/usr/local/bin:/bin:/usr/bin_ for a regular user and to _/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin_ for root. +
{nbsp} +
The environment variable *PATH* may be different on systems where _/bin_ and _/sbin_ are merged into _/usr_. The environment variable *SHELL* defaults to */bin/sh* if none is given in the user's passwd entry.
Clears all the environment variables except *TERM*; initializes the environment variables *HOME*, *SHELL*, *USER*, *LOGNAME* according to the user's passwd entry; sets *PATH* to _/usr/local/bin:/bin:/usr/bin_ for a regular user and to _/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin_ for root.
+
The environment variable *PATH* may be different on systems where _/bin_ and _/sbin_ are merged into _/usr_. The environment variable *SHELL* defaults to */bin/sh* if none is given in the user's passwd entry.
*-V*, *--version*::
Display version information and exit.
Display version information and exit.
*-h*, *--help*::
Display help text and exit.
Display help text and exit.
== NOTES

10
sys-utils/setsid.1.adoc
View File

@ -23,19 +23,19 @@ setsid - run a program in a new session
== OPTIONS
*-c*, *--ctty*::
Set the controlling terminal to the current one.
Set the controlling terminal to the current one.
*-f*, *--fork*::
Always create a new process.
Always create a new process.
*-w*, *--wait*::
Wait for the execution of the program to end, and return the exit status of this program as the exit status of *setsid*.
Wait for the execution of the program to end, and return the exit status of this program as the exit status of *setsid*.
*-V*, *--version*::
Display version information and exit.
Display version information and exit.
*-h*, *--help*::
Display help text and exit.
Display help text and exit.
== AUTHORS

80
sys-utils/swapon.8.adoc
View File

@ -29,109 +29,113 @@ Calls to *swapon* normally occur in the system boot scripts making all swap devi
== OPTIONS
*-a*, *--all*::
All devices marked as "swap" in _/etc/fstab_ are made available, except for those with the "noauto" option. Devices that are already being used as swap are silently skipped.
All devices marked as "swap" in _/etc/fstab_ are made available, except for those with the "noauto" option. Devices that are already being used as swap are silently skipped.
*-d*, *--discard*[**=**__policy__]::
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:
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:
*--discard=once*::: to perform a single-time discard operation for the whole swap area at swapon; or +
*--discard=pages*::: to asynchronously discard freed swap pages before they are available for reuse. +
*--discard=once*;;
to perform a single-time discard operation for the whole swap area at swapon; or
*--discard=pages*;;
to asynchronously discard freed swap pages before they are available for reuse.
+
If no policy is selected, the default behavior is to enable both discard types. The _/etc/fstab_ mount options *discard*, *discard=once*, or *discard=pages* may also be used to enable discard flags.
*-e*, *--ifexists*::
Silently skip devices that do not exist. The _/etc/fstab_ mount option *nofail* may also be used to skip non-existing device.
Silently skip devices that do not exist. The _/etc/fstab_ mount option *nofail* may also be used to skip non-existing device.
*-f*, *--fixpgsz*::
Reinitialize (exec mkswap) the swap space if its page size does not match that of the current running kernel. *mkswap*(8) initializes the whole device and does not check for bad blocks.
Reinitialize (exec mkswap) the swap space if its page size does not match that of the current running kernel. *mkswap*(8) initializes the whole device and does not check for bad blocks.
*-h*, *--help*::
Display help text and exit.
Display help text and exit.
*-L* _label_::
Use the partition that has the specified _label_. (For this, access to _/proc/partitions_ is needed.)
Use the partition that has the specified _label_. (For this, access to _/proc/partitions_ is needed.)
*-o*, *--options* _opts_::
Specify swap options by an fstab-compatible comma-separated string. For example: +
{nbsp} +
*swapon -o pri=1,discard=pages,nofail /dev/sda2* +
{nbsp} +
The _opts_ string is evaluated last and overrides all other command line options.
Specify swap options by an fstab-compatible comma-separated string. For example:
+
*swapon -o pri=1,discard=pages,nofail /dev/sda2*
+
The _opts_ string is evaluated last and overrides all other command line options.
*-p*, *--priority* _priority_::
Specify the priority of the swap device. _priority_ is a value between -1 and 32767. Higher numbers indicate higher priority. See *swapon*(2) for a full description of swap priorities. Add **pri=**__value__ to the option field of _/etc/fstab_ for use with *swapon -a*. When no priority is defined, it defaults to -1.
Specify the priority of the swap device. _priority_ is a value between -1 and 32767. Higher numbers indicate higher priority. See *swapon*(2) for a full description of swap priorities. Add **pri=**__value__ to the option field of _/etc/fstab_ for use with *swapon -a*. When no priority is defined, it defaults to -1.
*-s*, *--summary*::
Display swap usage summary by device. Equivalent to *cat /proc/swaps*. This output format is DEPRECATED in favour of *--show* that provides better control on output data.
Display swap usage summary by device. Equivalent to *cat /proc/swaps*. This output format is DEPRECATED in favour of *--show* that provides better control on output data.
*--show*[**=**__column__...]::
Display a definable table of swap areas. See the *--help* output for a list of available columns.
Display a definable table of swap areas. See the *--help* output for a list of available columns.
*--output-all*::
Output all available columns.
Output all available columns.
*--noheadings*::
Do not print headings when displaying *--show* output.
Do not print headings when displaying *--show* output.
*--raw*::
Display *--show* output without aligning table columns.
Display *--show* output without aligning table columns.
*--bytes*::
Display swap size in bytes in *--show* output instead of in user-friendly units.
Display swap size in bytes in *--show* output instead of in user-friendly units.
*-U* _uuid_::
Use the partition that has the specified _uuid_.
Use the partition that has the specified _uuid_.
*-v*, *--verbose*::
Be verbose.
Be verbose.
*-V*, *--version*::
Display version information and exit.
Display version information and exit.
== EXIT STATUS
*swapoff* has the following exit status values since v2.36:
*0*::
success
success
*2*::
system has insufficient memory to stop swapping (OOM)
system has insufficient memory to stop swapping (OOM)
*4*::
swapoff syscall failed for another reason
swapoff syscall failed for another reason
*8*::
non-swapoff syscall system error (out of memory, ...)
non-swapoff syscall system error (out of memory, ...)
*16*::
usage or syntax error
usage or syntax error
*32*::
all swapoff failed on *--all*
all swapoff failed on *--all*
*64*::
some swapoff succeeded on *--all* +
{nbsp} +
The command *swapoff --all* returns 0 (all succeeded), 32 (all failed), or 64 (some failed, some succeeded). +
{nbsp} +
The old versions before v2.36 has no documented exit status, 0 means success in all versions.
some swapoff succeeded on *--all*
The command *swapoff --all* returns 0 (all succeeded), 32 (all failed), or 64 (some failed, some succeeded).
+
The old versions before v2.36 has no documented exit status, 0 means success in all versions.
== ENVIRONMENT
LIBMOUNT_DEBUG=all::
enables *libmount* debug output.
enables *libmount* debug output.
LIBBLKID_DEBUG=all::
enables *libblkid* debug output.
enables *libblkid* debug output.
== FILES
_/dev/sd??_::
standard paging devices
standard paging devices
_/etc/fstab_::
ascii filesystem description table
ascii filesystem description table
== NOTES

8
sys-utils/switch_root.8.adoc
View File

@ -25,10 +25,10 @@ switch_root - switch to another filesystem as the root of the mount tree
== OPTIONS
*-h, --help*::
Display help text and exit.
Display help text and exit.
*-V, --version*::
Display version information and exit.
Display version information and exit.
== EXIT STATUS
@ -44,8 +44,8 @@ mount --bind $DIR $DIR
== AUTHORS
mailto:pjones@redhat.com[Peter Jones] +
mailto:katzj@redhat.com[Jeremy Katz] +
mailto:pjones@redhat.com[Peter Jones],
mailto:katzj@redhat.com[Jeremy Katz],
mailto:kzak@redhat.com[Karel Zak]
== SEE ALSO

34
sys-utils/tunelp.8.adoc
View File

@ -21,44 +21,44 @@ tunelp - set various parameters for the lp device
== OPTIONS
*-i*, *--irq* _argument_::
specifies the IRQ to use for the parallel port in question. If this is set to something non-zero, *-t* and *-c* have no effect. If your port does not use interrupts, this option will make printing stop. The command *tunelp -i 0* 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. +
{nbsp} +
NOTE: 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 _/proc/parport/*/irq_. Read _/usr/src/linux/Documentation/admin-guide/parport.rst_ for more details on parport.
specifies the IRQ to use for the parallel port in question. If this is set to something non-zero, *-t* and *-c* have no effect. If your port does not use interrupts, this option will make printing stop. The command *tunelp -i 0* 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.
+
*NOTE*: 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 _/proc/parport/*/irq_. Read _/usr/src/linux/Documentation/admin-guide/parport.rst_ for more details on parport.
*-t*, *--time* _milliseconds_::
is the amount of time in jiffies that the driver waits if the printer doesn't take a character for the number of tries dictated by the *-c* parameter. 10 is the default value. If you want fastest possible printing, and don't care about system load, you may set this to 0. If you don't 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.
is the amount of time in jiffies that the driver waits if the printer doesn't take a character for the number of tries dictated by the *-c* parameter. 10 is the default value. If you want fastest possible printing, and don't care about system load, you may set this to 0. If you don't 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.
*-c*, *--chars* _characters_::
is the number of times to try to output a character to the printer before sleeping for *-t* _TIME_. 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 _must_ set this to `1' 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 _really_ old printer, you can increase this further. +
{nbsp} +
Setting *-t* _TIME_ to 0 is equivalent to setting *-c* _CHARS_ to infinity.
is the number of times to try to output a character to the printer before sleeping for *-t* _TIME_. 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 _must_ set this to '1' 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 _really_ old printer, you can increase this further.
+
Setting *-t* _TIME_ to 0 is equivalent to setting *-c* _CHARS_ to infinity.
*-w*, *--wait* _milliseconds_::
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's also possible to decrease this value to 0 if your printer is fast enough or your machine is slow enough.
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's also possible to decrease this value to 0 if your printer is fast enough or your machine is slow enough.
*-a*, *--abort* _<on|off>_::
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't, you might rather that your printer spooler find out that the printer isn't ready, quit trying, and send you mail about it. The choice is yours.
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't, you might rather that your printer spooler find out that the printer isn't ready, quit trying, and send you mail about it. The choice is yours.
*-o*, *--check-status* _<on|off>_::
This option is much like *-a*. It makes any *open*(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 *lpd*.
This option is much like *-a*. It makes any *open*(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 *lpd*.
*-C*, *--careful* _<on|off>_::
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. +
{nbsp} +
*NOTE*: This option is obsolete because it's the default in 2.1.131 kernel or later.
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.
+
*NOTE*: This option is obsolete because it's the default in 2.1.131 kernel or later.
*-s*, *--status*::
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, *-q* off, turning off the display of the current IRQ, is implied.
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, *-q* off, turning off the display of the current IRQ, is implied.
*-r*, *--reset*::
This option resets the port. It requires a Linux kernel version of 1.1.80 or later.
This option resets the port. It requires a Linux kernel version of 1.1.80 or later.
*-q*, *--print-irq* _<on|off>_::
This option sets printing the display of the current IRQ setting.
This option sets printing the display of the current IRQ setting.
== FILES
_/dev/lp?_ +
_/dev/lp?_,
_/proc/parport/*/*_
== NOTES

72
sys-utils/umount.8.adoc
View File

@ -52,70 +52,70 @@ Note that a filesystem cannot be unmounted when it is 'busy' - for example, when
== OPTIONS
*-a*, *--all*::
All of the filesystems described in _/proc/self/mountinfo_ (or in deprecated _/etc/mtab_) are unmounted, except the proc, devfs, devpts, sysfs, rpc_pipefs and nfsd filesystems. This list of the filesystems may be replaced by *--types* umount option.
All of the filesystems described in _/proc/self/mountinfo_ (or in deprecated _/etc/mtab_) are unmounted, except the proc, devfs, devpts, sysfs, rpc_pipefs and nfsd filesystems. This list of the filesystems may be replaced by *--types* umount option.
*-A*, *--all-targets*::
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 *--recursive*, then all nested mounts within the filesystem are recursively unmounted. This option is only supported on systems where _/etc/mtab_ is a symlink to _/proc/mounts_.
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 *--recursive*, then all nested mounts within the filesystem are recursively unmounted. This option is only supported on systems where _/etc/mtab_ is a symlink to _/proc/mounts_.
*-c*, *--no-canonicalize*::
Do not canonicalize paths. The paths canonicalization is based on *stat*(2) and *readlink*(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. +
{nbsp} +
This option is silently ignored by *umount* for non-root users. +
{nbsp} +
For more details about this option see the *mount*(8) man page. Note that *umount* does not pass this option to the **/sbin/umount.**__type__ helpers.
Do not canonicalize paths. The paths canonicalization is based on *stat*(2) and *readlink*(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.
+
This option is silently ignored by *umount* for non-root users.
+
For more details about this option see the *mount*(8) man page. Note that *umount* does not pass this option to the **/sbin/umount.**__type__ helpers.
*-d*, *--detach-loop*::
When the unmounted device was a loop device, also free this loop device. This option is unnecessary for devices initialized by *mount*(8), in this case "autoclear" functionality is enabled by default.
When the unmounted device was a loop device, also free this loop device. This option is unnecessary for devices initialized by *mount*(8), in this case "autoclear" functionality is enabled by default.
*--fake*::
Causes everything to be done except for the actual system call or umount helper execution; this 'fakes' unmounting the filesystem. It can be used to remove entries from the deprecated _/etc/mtab_ that were unmounted earlier with the *-n* option.
Causes everything to be done except for the actual system call or umount helper execution; this 'fakes' unmounting the filesystem. It can be used to remove entries from the deprecated _/etc/mtab_ that were unmounted earlier with the *-n* option.
*-f*, *--force*::
Force an unmount (in case of an unreachable NFS system). +
{nbsp} +
Note that this option does not guarantee that umount command does not hang. It's strongly recommended to use absolute paths without symlinks to avoid unwanted readlink and stat system calls on unreachable NFS in *umount*.
Force an unmount (in case of an unreachable NFS system).
+
Note that this option does not guarantee that umount command does not hang. It's strongly recommended to use absolute paths without symlinks to avoid unwanted readlink and stat system calls on unreachable NFS in *umount*.
*-i*, *--internal-only*::
Do not call the **/sbin/umount.**__filesystem__ helper even if it exists. By default such a helper program is called if it exists.
Do not call the **/sbin/umount.**__filesystem__ helper even if it exists. By default such a helper program is called if it exists.
*-l*, *--lazy*::
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. +
{nbsp} +
A system reboot would be expected in near future if you're going to use this option for network filesystem or local filesystem with submounts. The recommended use-case for *umount -l* 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.
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.
+
A system reboot would be expected in near future if you're going to use this option for network filesystem or local filesystem with submounts. The recommended use-case for *umount -l* 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.
*-N*, *--namespace* _ns_::
Perform umount in the mount namespace specified by _ns_. _ns_ is either PID of process running in that namespace or special file representing that namespace. +
{nbsp} +
*umount* switches to the namespace when it reads _/etc/fstab_, writes _/etc/mtab_ (or writes to _/run/mount_) and calls *umount*(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 *umount*(2) command. +
{nbsp} +
See *mount_namespaces*(7) for more information.
Perform umount in the mount namespace specified by _ns_. _ns_ is either PID of process running in that namespace or special file representing that namespace.
+
*umount* switches to the namespace when it reads _/etc/fstab_, writes _/etc/mtab_ (or writes to _/run/mount_) and calls *umount*(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 *umount*(2) command.
+
See *mount_namespaces*(7) for more information.
*-n*, *--no-mtab*::
Unmount without writing in _/etc/mtab_.
Unmount without writing in _/etc/mtab_.
*-O*, *--test-opts* _option_...::
Unmount only the filesystems that have the specified option set in _/etc/fstab_. More than one option may be specified in a comma-separated list. Each option can be prefixed with *no* to indicate that no action should be taken for this option.
Unmount only the filesystems that have the specified option set in _/etc/fstab_. More than one option may be specified in a comma-separated list. Each option can be prefixed with *no* to indicate that no action should be taken for this option.
*-q*, *--quiet*::
Suppress "not mounted" error messages.
Suppress "not mounted" error messages.
*-R*, *--recursive*::
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 _/proc/self/mountinfo_ 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).
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 _/proc/self/mountinfo_ 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).
*-r*, *--read-only*::
When an unmount fails, try to remount the filesystem read-only.
When an unmount fails, try to remount the filesystem read-only.
*-t*, *--types* _type_...::
Indicate that the actions should only be taken on filesystems of the specified _type_. More than one type may be specified in a comma-separated list. The list of filesystem types can be prefixed with *no* to indicate that no action should be taken for all of the mentioned types. Note that *umount* reads information about mounted filesystems from kernel (_/proc/mounts_) and filesystem names may be different than filesystem names used in the _/etc/fstab_ (e.g., "nfs4" vs. "nfs").
Indicate that the actions should only be taken on filesystems of the specified _type_. More than one type may be specified in a comma-separated list. The list of filesystem types can be prefixed with *no* to indicate that no action should be taken for all of the mentioned types. Note that *umount* reads information about mounted filesystems from kernel (_/proc/mounts_) and filesystem names may be different than filesystem names used in the _/etc/fstab_ (e.g., "nfs4" vs. "nfs").
*-v*, *--verbose*::
Verbose mode.
Verbose mode.
*-V*, *--version*::
Display version information and exit.
Display version information and exit.
*-h*, *--help*::
Display help text and exit.
Display help text and exit.
== NON-SUPERUSER UMOUNTS
@ -154,24 +154,24 @@ Note that _/etc/mtab_ is currently deprecated and *helper=* and other userspace
== ENVIRONMENT
LIBMOUNT_FSTAB=<path>::
overrides the default location of the fstab file (ignored for suid)
overrides the default location of the fstab file (ignored for suid)
LIBMOUNT_MTAB=<path>::
overrides the default location of the mtab file (ignored for suid)
overrides the default location of the mtab file (ignored for suid)
LIBMOUNT_DEBUG=all::
enables *libmount* debug output
enables *libmount* debug output
== FILES
_/etc/mtab_::
table of mounted filesystems (deprecated and usually replaced by symlink to _/proc/mounts_)
table of mounted filesystems (deprecated and usually replaced by symlink to _/proc/mounts_)
_/etc/fstab_::
table of known filesystems
table of known filesystems
_/proc/self/mountinfo_::
table of mounted filesystems generated by kernel.
table of mounted filesystems generated by kernel.
== HISTORY

82
sys-utils/unshare.1.adoc
View File

@ -25,114 +25,114 @@ By default, a new namespace persists only as long as it has member processes. A
The following types of namespaces can be created with *unshare*:
*mount namespace*::
Mounting and unmounting filesystems will not affect the rest of the system, except for filesystems which are explicitly marked as shared (with *mount --make-shared*; see _/proc/self/mountinfo_ or *findmnt -o+PROPAGATION* for the *shared* flags). For further details, see *mount_namespaces*(7). +
{nbsp} +
*unshare* since util-linux version 2.27 automatically sets propagation to *private* in a new mount namespace to make sure that the new namespace is really unshared. It's possible to disable this feature with option *--propagation unchanged*. Note that *private* is the kernel default.
Mounting and unmounting filesystems will not affect the rest of the system, except for filesystems which are explicitly marked as shared (with *mount --make-shared*; see _/proc/self/mountinfo_ or *findmnt -o+PROPAGATION* for the *shared* flags). For further details, see *mount_namespaces*(7).
+
*unshare* since util-linux version 2.27 automatically sets propagation to *private* in a new mount namespace to make sure that the new namespace is really unshared. It's possible to disable this feature with option *--propagation unchanged*. Note that *private* is the kernel default.
*UTS namespace*::
Setting hostname or domainname will not affect the rest of the system. For further details, see *uts_namespaces*(7).
Setting hostname or domainname will not affect the rest of the system. For further details, see *uts_namespaces*(7).
*IPC namespace*::
The process will have an independent namespace for POSIX message queues as well as System V ­message queues, semaphore sets and shared memory segments. For further details, see *ipc_namespaces*(7).
The process will have an independent namespace for POSIX message queues as well as System V ­message queues, semaphore sets and shared memory segments. For further details, see *ipc_namespaces*(7).
*network namespace*::
The process will have independent IPv4 and IPv6 stacks, IP routing tables, firewall rules, the _/proc/net_ and _/sys/class/net_ directory trees, sockets, etc. For further details, see *network_namespaces*(7).
The process will have independent IPv4 and IPv6 stacks, IP routing tables, firewall rules, the _/proc/net_ and _/sys/class/net_ directory trees, sockets, etc. For further details, see *network_namespaces*(7).
*PID namespace*::
Children will have a distinct set of PID-to-process mappings from their parent. For further details, see *pid_namespaces*(7).
Children will have a distinct set of PID-to-process mappings from their parent. For further details, see *pid_namespaces*(7).
*cgroup namespace*::
The process will have a virtualized view of _/proc/self/cgroup_, and new cgroup mounts will be rooted at the namespace cgroup root. For further details, see *cgroup_namespaces*(7).
The process will have a virtualized view of _/proc/self/cgroup_, and new cgroup mounts will be rooted at the namespace cgroup root. For further details, see *cgroup_namespaces*(7).
*user namespace*::
The process will have a distinct set of UIDs, GIDs and capabilities. For further details, see *user_namespaces*(7).
The process will have a distinct set of UIDs, GIDs and capabilities. For further details, see *user_namespaces*(7).
*time namespace*::
The process can have a distinct view of *CLOCK_MONOTONIC* and/or *CLOCK_BOOTTIME* which can be changed using _/proc/self/timens_offsets_. For further details, see *time_namespaces*(7).
The process can have a distinct view of *CLOCK_MONOTONIC* and/or *CLOCK_BOOTTIME* which can be changed using _/proc/self/timens_offsets_. For further details, see *time_namespaces*(7).
== OPTIONS
*-i*, *--ipc*[**=**__file__]::
Unshare the IPC namespace. If _file_ is specified, then a persistent namespace is created by a bind mount.
Unshare the IPC namespace. If _file_ is specified, then a persistent namespace is created by a bind mount.
*-m*, *--mount*[**=**__file__]::
Unshare the mount namespace. If _file_ is specified, then a persistent namespace is created by a bind mount. Note that _file_ must be located on a mount whose propagation type is not *shared* (or an error results). Use the command *findmnt -o+PROPAGATION* when not sure about the current setting. See also the examples below.
Unshare the mount namespace. If _file_ is specified, then a persistent namespace is created by a bind mount. Note that _file_ must be located on a mount whose propagation type is not *shared* (or an error results). Use the command *findmnt -o+PROPAGATION* when not sure about the current setting. See also the examples below.
*-n*, *--net*[**=**__file__]::
Unshare the network namespace. If _file_ is specified, then a persistent namespace is created by a bind mount.
Unshare the network namespace. If _file_ is specified, then a persistent namespace is created by a bind mount.
*-p*, *--pid*[**=**__file__]::
Unshare the PID namespace. If _file_ is specified, then a persistent namespace is created by a bind mount. (Creation of a persistent PID namespace will fail if the *--fork* option is not also specified.) +
{nbsp} +
See also the *--fork* and *--mount-proc* options.
Unshare the PID namespace. If _file_ is specified, then a persistent namespace is created by a bind mount. (Creation of a persistent PID namespace will fail if the *--fork* option is not also specified.)
+
See also the *--fork* and *--mount-proc* options.
*-u*, *--uts*[**=**__file__]::
Unshare the UTS namespace. If _file_ is specified, then a persistent namespace is created by a bind mount.
Unshare the UTS namespace. If _file_ is specified, then a persistent namespace is created by a bind mount.
*-U*, *--user*[**=**__file__]::
Unshare the user namespace. If _file_ is specified, then a persistent namespace is created by a bind mount.
Unshare the user namespace. If _file_ is specified, then a persistent namespace is created by a bind mount.
*-C*, *--cgroup*[**=**__file__]::
Unshare the cgroup namespace. If _file_ is specified, then persistent namespace is created by bind mount.
Unshare the cgroup namespace. If _file_ is specified, then persistent namespace is created by bind mount.
*-T*, *--time*[**=**__file__]::
Unshare the time namespace. If _file_ is specified, then a persistent namespace is created by a bind mount. The *--monotonic* and *--boottime* options can be used to specify the corresponding offset in the time namespace.
Unshare the time namespace. If _file_ is specified, then a persistent namespace is created by a bind mount. The *--monotonic* and *--boottime* options can be used to specify the corresponding offset in the time namespace.
*-f*, *--fork*::
Fork the specified _program_ as a child process of *unshare* rather than running it directly. This is useful when creating a new PID namespace. Note that when *unshare* is waiting for the child process, then it ignores *SIGINT* and *SIGTERM* and does not forward any signals to the child. It is necessary to send signals to the child process.
Fork the specified _program_ as a child process of *unshare* rather than running it directly. This is useful when creating a new PID namespace. Note that when *unshare* is waiting for the child process, then it ignores *SIGINT* and *SIGTERM* and does not forward any signals to the child. It is necessary to send signals to the child process.
*--keep-caps*::
When the *--user* option is given, ensure that capabilities granted in the user namespace are preserved in the child process.
When the *--user* option is given, ensure that capabilities granted in the user namespace are preserved in the child process.
*--kill-child*[**=**__signame__]::
When *unshare* terminates, have _signame_ be sent to the forked child process. Combined with *--pid* this allows for an easy and reliable killing of the entire process tree below *unshare*. If not given, _signame_ defaults to *SIGKILL*. This option implies *--fork*.
When *unshare* terminates, have _signame_ be sent to the forked child process. Combined with *--pid* this allows for an easy and reliable killing of the entire process tree below *unshare*. If not given, _signame_ defaults to *SIGKILL*. This option implies *--fork*.
*--mount-proc*[**=**__mountpoint__]::
Just before running the program, mount the proc filesystem at _mountpoint_ (default is _/proc_). This is useful when creating a new PID namespace. It also implies creating a new mount namespace since the _/proc_ mount would otherwise mess up existing programs on the system. The new proc filesystem is explicitly mounted as private (with *MS_PRIVATE*|*MS_REC*).
Just before running the program, mount the proc filesystem at _mountpoint_ (default is _/proc_). This is useful when creating a new PID namespace. It also implies creating a new mount namespace since the _/proc_ mount would otherwise mess up existing programs on the system. The new proc filesystem is explicitly mounted as private (with *MS_PRIVATE*|*MS_REC*).
**--map-user=**__uid|name__::
Run the program only after the current effective user ID has been mapped to _uid_. If this option is specified multiple times, the last occurrence takes precedence. This option implies *--user*.
Run the program only after the current effective user ID has been mapped to _uid_. If this option is specified multiple times, the last occurrence takes precedence. This option implies *--user*.
**--map-group=**__gid|name__::
Run the program only after the current effective group ID has been mapped to _gid_. If this option is specified multiple times, the last occurrence takes precedence. This option implies *--setgroups=deny* and *--user*.
Run the program only after the current effective group ID has been mapped to _gid_. If this option is specified multiple times, the last occurrence takes precedence. This option implies *--setgroups=deny* and *--user*.
*-r*, *--map-root-user*::
Run the program only after the current effective user and group IDs have been mapped to the superuser UID and GID in the newly created user namespace. This makes it possible to conveniently gain capabilities needed to manage various aspects of the newly created namespaces (such as configuring interfaces in the network namespace or mounting filesystems in the mount namespace) even when run unprivileged. As a mere convenience feature, it does not support more sophisticated use cases, such as mapping multiple ranges of UIDs and GIDs. This option implies *--setgroups=deny* and *--user*. This option is equivalent to *--map-user=0 --map-group=0*.
Run the program only after the current effective user and group IDs have been mapped to the superuser UID and GID in the newly created user namespace. This makes it possible to conveniently gain capabilities needed to manage various aspects of the newly created namespaces (such as configuring interfaces in the network namespace or mounting filesystems in the mount namespace) even when run unprivileged. As a mere convenience feature, it does not support more sophisticated use cases, such as mapping multiple ranges of UIDs and GIDs. This option implies *--setgroups=deny* and *--user*. This option is equivalent to *--map-user=0 --map-group=0*.
*-c*, *--map-current-user*::
Run the program only after the current effective user and group IDs have been mapped to the same UID and GID in the newly created user namespace. This option implies *--setgroups=deny* and *--user*. This option is equivalent to *--map-user=$(id -ru) --map-group=$(id -rg)*.
Run the program only after the current effective user and group IDs have been mapped to the same UID and GID in the newly created user namespace. This option implies *--setgroups=deny* and *--user*. This option is equivalent to *--map-user=$(id -ru) --map-group=$(id -rg)*.
**--propagation private**|**shared**|**slave**|*unchanged*::
Recursively set the mount propagation flag in the new mount namespace. The default is to set the propagation to _private_. It is possible to disable this feature with the argument *unchanged*. The option is silently ignored when the mount namespace (*--mount*) is not requested.
Recursively set the mount propagation flag in the new mount namespace. The default is to set the propagation to _private_. It is possible to disable this feature with the argument *unchanged*. The option is silently ignored when the mount namespace (*--mount*) is not requested.
**--setgroups allow**|*deny*::
Allow or deny the *setgroups*(2) system call in a user namespace. +
{nbsp} +
To be able to call *setgroups*(2), the calling process must at least have *CAP_SETGID*. But since Linux 3.19 a further restriction applies: the kernel gives permission to call ­*setgroups*(2) only after the GID map (**/proc/**__pid__*/gid_map*) has been set. The GID map is writable by root when ­*setgroups*(2) is enabled (i.e., *allow*, the default), and the GID map becomes writable by unprivileged processes when ­*setgroups*(2) is permanently disabled (with *deny*).
Allow or deny the *setgroups*(2) system call in a user namespace.
+
To be able to call *setgroups*(2), the calling process must at least have *CAP_SETGID*. But since Linux 3.19 a further restriction applies: the kernel gives permission to call ­*setgroups*(2) only after the GID map (**/proc/**__pid__*/gid_map*) has been set. The GID map is writable by root when ­*setgroups*(2) is enabled (i.e., *allow*, the default), and the GID map becomes writable by unprivileged processes when ­*setgroups*(2) is permanently disabled (with *deny*).
*-R*, **--root=**__dir__::
run the command with root directory set to _dir_.
run the command with root directory set to _dir_.
*-w*, **--wd=**__dir__::
change working directory to _dir_.
change working directory to _dir_.
*-S*, *--setuid* _uid_::
Set the user ID which will be used in the entered namespace.
Set the user ID which will be used in the entered namespace.
*-G*, *--setgid* _gid_::
Set the group ID which will be used in the entered namespace and drop supplementary groups.
Set the group ID which will be used in the entered namespace and drop supplementary groups.
*--monotonic* _offset_::
Set the offset of *CLOCK_MONOTONIC* which will be used in the entered time namespace. This option requires unsharing a time namespace with *--time*.
Set the offset of *CLOCK_MONOTONIC* which will be used in the entered time namespace. This option requires unsharing a time namespace with *--time*.
*--boottime* _offset_::
Set the offset of *CLOCK_BOOTTIME* which will be used in the entered time namespace. This option requires unsharing a time namespace with *--time*.
Set the offset of *CLOCK_BOOTTIME* which will be used in the entered time namespace. This option requires unsharing a time namespace with *--time*.
*-V*, *--version*::
Display version information and exit.
Display version information and exit.
*-h*, *--help*::
Display help text and exit.
Display help text and exit.
== NOTES
@ -230,7 +230,7 @@ up 9 years, 28 weeks, 1 day, 2 hours, 50 minutes
== AUTHORS
mailto:dottedmag@dottedmag.net[Mikhail Gusarov] +
mailto:dottedmag@dottedmag.net[Mikhail Gusarov],
mailto:kzak@redhat.com[Karel Zak]
== SEE ALSO

26
sys-utils/wdctl.8.adoc
View File

@ -25,44 +25,44 @@ Note that the number of supported watchdog features is hardware specific.
== OPTIONS
*-f*, *--flags* _list_::
Print only the specified flags.
Print only the specified flags.
*-F*, *--noflags*::
Do not print information about flags.
Do not print information about flags.
*-I*, *--noident*::
Do not print watchdog identity information.
Do not print watchdog identity information.
*-n*, *--noheadings*::
Do not print a header line for flags table.
Do not print a header line for flags table.
*-o*, *--output* _list_::
Define the output columns to use in table of watchdog flags. If no output arrangement is specified, then a default set is used. Use *--help* to get list of all supported columns.
Define the output columns to use in table of watchdog flags. If no output arrangement is specified, then a default set is used. Use *--help* to get list of all supported columns.
*-O*, *--oneline*::
Print all wanted information on one line in key="value" output format.
Print all wanted information on one line in key="value" output format.
*-r*, *--raw*::
Use the raw output format.
Use the raw output format.
*-s*, *-settimeout* _seconds_::
Set the watchdog timeout in seconds.
Set the watchdog timeout in seconds.
*-T*, *--notimeouts*::
Do not print watchdog timeouts.
Do not print watchdog timeouts.
*-x*, *--flags-only*::
Same as *-I -T*.
Same as *-I -T*.
*-V*, *--version*::
Display version information and exit.
Display version information and exit.
*-h*, *--help*::
Display help text and exit.
Display help text and exit.
== AUTHORS
mailto:kzak@redhat.com[Karel Zak] +
mailto:kzak@redhat.com[Karel Zak],
mailto:lennart@poettering.net[Lennart Poettering]
include::../man-common/bugreports.adoc[]

30
sys-utils/zramctl.8.adoc
View File

@ -39,39 +39,39 @@ Note that _zramdev_ node specified on command line has to already exist. The com
== OPTIONS
*-a*, **--algorithm lzo**|**lz4**|**lz4hc**|**deflate**|*842*::
Set the compression algorithm to be used for compressing data in the zram device.
Set the compression algorithm to be used for compressing data in the zram device.
*-f*, *--find*::
Find the first unused zram device. If a *--size* argument is present, then initialize the device.
Find the first unused zram device. If a *--size* argument is present, then initialize the device.
*-n*, *--noheadings*::
Do not print a header line in status output.
Do not print a header line in status output.
*-o*, *--output* _list_::
Define the status output columns to be used. If no output arrangement is specified, then a default set is used. Use *--help* to get a list of all supported columns.
Define the status output columns to be used. If no output arrangement is specified, then a default set is used. Use *--help* to get a list of all supported columns.
*--output-all*::
Output all available columns.
Output all available columns.
*--raw*::
Use the raw format for status output.
Use the raw format for status output.
*-r*, *--reset*::
Reset the options of the specified zram device(s). Zram device settings can be changed only after a reset.
Reset the options of the specified zram device(s). Zram device settings can be changed only after a reset.
*-s*, *--size* _size_::
Create a zram device of the specified _size_. Zram devices are aligned to memory pages; when the requested _size_ 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 _size_ parameter is bytes. +
{nbsp} +
The _size_ 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.
Create a zram device of the specified _size_. Zram devices are aligned to memory pages; when the requested _size_ 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 _size_ parameter is bytes.
+
The _size_ 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.
*-t*, *--streams* _number_::
Set the maximum number of compression streams that can be used for the device. The default is one stream.
Set the maximum number of compression streams that can be used for the device. The default is one stream.
*-V*, *--version*::
Display version information and exit.
Display version information and exit.
*-h*, *--help*::
Display help text and exit.
Display help text and exit.
== EXIT STATUS
@ -80,7 +80,7 @@ Note that _zramdev_ node specified on command line has to already exist. The com
== FILES
_/dev/zram[0..N]_::
zram block devices
zram block devices
== EXAMPLE
@ -98,7 +98,7 @@ The following commands set up a zram device with a size of one gigabyte and use
== AUTHORS
mailto:nefelim4ag@gmail.com[Timofey Titovets] +
mailto:nefelim4ag@gmail.com[Timofey Titovets],
mailto:kzak@redhat.com[Karel Zak]
== SEE ALSO