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

Asciidoc: Fix markup

This commit is contained in:
Mario Blättermann 2021-04-04 15:33:56 +02:00
parent 69378d9bf4
commit 360946bb93
3 changed files with 11 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
misc-utils/findmnt.8.adoc
View File

@ -47,7 +47,7 @@ Do not canonicalize paths at all. This option affects the comparing of paths and
Canonicalize all printed paths.
*-D*, *--df*::
Imitate the output of df1. This option is equivalent to *-o SOURCE,FSTYPE,SIZE,USED,AVAIL,USE%,TARGET* but excludes all pseudo filesystems. Use *--all* to print all filesystems.
Imitate the output of *df*(1). This option is equivalent to *-o SOURCE,FSTYPE,SIZE,USED,AVAIL,USE%,TARGET* but excludes all pseudo filesystems. Use *--all* to print all filesystems.
*-d*, *--direction* _word_::
The search direction, either *forward* or *backward*.

14
misc-utils/logger.1.adoc
View File

@ -68,10 +68,10 @@ Ignore empty lines when processing files. An empty line is defined to be a line
Log the contents of the specified _file_. This option cannot be combined with a command-line message.
*-i*::
Log the PID of the logger process with each line.
Log the PID of the *logger* process with each line.
*--id*[**=**__id__]::
Log the PID of the logger process with each line. When the optional argument _id_ is specified, then it is used instead of the logger command's PID. The use of *--id=$$* (PPID) is recommended in scripts that send several messages.
Log the PID of the *logger* process with each line. When the optional argument _id_ is specified, then it is used instead of the *logger* command's PID. The use of *--id=$$* (PPID) is recommended in scripts that send several messages.
+
Note that the system logging infrastructure (for example *systemd* when listening on _/dev/log_) may follow local socket credentials to overwrite the PID specified in the message. *logger*(1) is able to set those socket credentials to the given _id_, but only if you have root permissions and a process with the specified PID exists, otherwise the socket credentials are not modified and the problem is silently ignored.
@ -140,7 +140,8 @@ Specifies a structured data element ID for an RFC 5424 message header. The optio
*logger* currently generates the *timeQuality* standardized element only. RFC 5424 also describes the elements *origin* (with parameters ip, enterpriseId, software and swVersion) and *meta* (with parameters sequenceId, sysUpTime and language). These element IDs may be specified without the **@**__digits__ suffix.
*--sd-param* _name_=_value_::
Specifies a structured data element parameter, a name and value pair. The option has to be used after *--sd-id* and may be specified more than once for the same element. Note that the quotation marks around _value_ are required and must be escaped on the command line. +
Specifies a structured data element parameter, a name and value pair. The option has to be used after *--sd-id* and may be specified more than once for the same element. Note that the quotation marks around _value_ are required and must be escaped on the command line.
+
....
logger --rfc5424 --sd-id zoo@123 \
--sd-param tiger="hungry" \
@ -149,18 +150,19 @@ Specifies a structured data element parameter, a name and value pair. The option
--sd-param onMeeting="yes"
"this is message"
....
produces: +
produces:
+
*<13>1 2015-10-01T14:07:59.168662+02:00 ws kzak - - [timeQuality tzKnown="1" isSynced="1" syncAccuracy="218616"][zoo@123 tiger="hungry" zebra="running"][manager@123 onMeeting="yes"] this is message*
*-S*, *--size* _size_::
Sets the maximum permitted message size to _size_. The default is 1KiB characters, which is the limit traditionally used and specified in RFC 3164. With RFC 5424, this limit has become flexible. A good assumption is that RFC 5424 receivers can at least process 4KiB messages.
+
Most receivers accept messages larger than 1KiB over any type of syslog protocol. As such, the *--size* option affects logger in all cases (not only when *--rfc5424* was used).
Most receivers accept messages larger than 1KiB over any type of syslog protocol. As such, the *--size* option affects *logger* in all cases (not only when *--rfc5424* was used).
+
Note: the message-size limit limits the overall message size, including the syslog header. Header sizes vary depending on the selected options and the hostname length. As a rule of thumb, headers are usually not longer than 50 to 80 characters. When selecting a maximum message size, it is important to ensure that the receiver supports the max size as well, otherwise messages may become truncated. Again, as a rule of thumb two to four KiB message size should generally be OK, whereas anything larger should be verified to work.
*--socket-errors*[**=**__mode__]::
Print errors about Unix socket connections. The _mode_ can be a value of *off*, *on*, or *auto*. When the mode is auto logger will detect if the init process is systemd, and if so assumption is made _/dev/log_ can be used early at boot. Other init systems lack of _/dev/log_ will not cause errors that is identical with messaging using *openlog*(3) system call. The *logger*(1) before version 2.26 used openlog, and hence was unable to detected loss of messages sent to Unix sockets.
Print errors about Unix socket connections. The _mode_ can be a value of *off*, *on*, or *auto*. When the mode is *auto*, then *logger* will detect if the init process is *systemd*(1), and if so assumption is made _/dev/log_ can be used early at boot. Other init systems lack of _/dev/log_ will not cause errors that is identical with messaging using *openlog*(3) system call. The *logger*(1) before version 2.26 used openlog, and hence was unable to detected loss of messages sent to Unix sockets.
+
The default mode is *auto*. When errors are not enabled lost messages are not communicated and will result to successful exit status of *logger*(1) invocation.

4
sys-utils/fstab.5.adoc
View File

@ -50,7 +50,7 @@ _/etc/fstab_
== DESCRIPTION
The file *fstab* contains descriptive information about the filesystems the system can mount. *fstab* is only read by programs, and not written; it is the duty of the system administrator to properly create and maintain this file. The order of records in *fstab* is important because fsck8, mount8, and umount8 sequentially iterate through *fstab* doing their thing.
The file *fstab* contains descriptive information about the filesystems the system can mount. *fstab* is only read by programs, and not written; it is the duty of the system administrator to properly create and maintain this file. The order of records in *fstab* is important because *fsck*(8), *mount*(8), and *umount*(8) sequentially iterate through *fstab* doing their thing.
Each filesystem is described on a separate line. Fields on each line are separated by tabs or spaces. Lines starting with '#' are comments. Blank lines are ignored.
@ -80,7 +80,7 @@ This field describes the mount point (target) for the filesystem. For swap parti
=== The third field (_fs_vfstype_).
This field describes the type of the filesystem. Linux supports many filesystem types: ext4, xfs, btrfs, f2fs, vfat, ntfs, hfsplus, tmpfs, sysfs, proc, iso9660, udf, squashfs, nfs, cifs, and many more. For more details, see mount8.
This field describes the type of the filesystem. Linux supports many filesystem types: ext4, xfs, btrfs, f2fs, vfat, ntfs, hfsplus, tmpfs, sysfs, proc, iso9660, udf, squashfs, nfs, cifs, and many more. For more details, see *mount*(8).
An entry _swap_ denotes a file or partition to be used for swapping, cf. *swapon*(8). An entry _none_ is useful for bind or move mounts.