Commit Graph

21163 Commits

Author SHA1 Message Date
Bjarni Ingi Gislason f764b4557d man8/*: ffix: change '-' to '\-' for options
Change '-' to '\-' for the prefix of names to indicate an option.

Signed-off-by: Bjarni Ingi Gislason <bjarniig@rhi.hi.is>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-07-02 12:21:22 +02:00
Bjarni Ingi Gislason fb6d2c09ae man7/*: ffix: change '-' to '\-' for options and to '\(en' for a range
Change '-' to '\-' for the prefix of names to indicate an option.

  Change '-' to '\(en' for a range.

Signed-off-by: Bjarni Ingi Gislason <bjarniig@rhi.hi.is>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-07-02 12:21:02 +02:00
Bjarni Ingi Gislason 1c8ae9fefb man5/*: ffix: change '-' to '\-' for options
Change '-' to '\-' for the prefix of names to indicate an option.

Signed-off-by: Bjarni Ingi Gislason <bjarniig@rhi.hi.is>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-07-02 12:20:31 +02:00
Bjarni Ingi Gislason 47cf5cbc98 man4/*: ffix: change '-' to '\-' for options
Change '-' to '\-' for the prefix of names to indicate an option.

Signed-off-by: Bjarni Ingi Gislason <bjarniig@rhi.hi.is>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-07-02 12:20:25 +02:00
Bjarni Ingi Gislason 2c1acf16da man2/*: ffix: change '-' to '\-' for options
Change '-' to '\-' for the prefix of names to indicate an option.

Signed-off-by: Bjarni Ingi Gislason <bjarniig@rhi.hi.is>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-07-02 12:20:04 +02:00
Bjarni Ingi Gislason 8ef1d3d11d man1/*: ffix: change '-' to '\-' for options
Change '-' to '\-' for the prefix of names to indicate an option.

Signed-off-by: Bjarni Ingi Gislason <bjarniig@rhi.hi.is>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-07-02 12:18:03 +02:00
Michael Kerrisk 99192e5fbf ftw.3: srcfix
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-07-02 10:36:55 +02:00
Sven Hoexter 069cbb6044 cgroups.7, cpuset.7: Update kernel cgroup documentation references
cgroups-v1/v2 documentation got moved to the "admin-guide" subfolder
and converted from .txt files to .rst

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-06-30 09:37:38 +02:00
Thomas Bartelsmeier 215c784ff4 hosts.5: Clarify capability for IPv6 outside of examples
Resolves https://bugzilla.kernel.org/show_bug.cgi?id=208279

Signed-off-by: Thomas Bartelsmeier <t.bartelsmeier@gmail.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-06-30 09:33:46 +02:00
Michael Kerrisk c5c0846dbe strfromd.3: wfix (null character --> null byte)
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-06-29 22:30:07 +02:00
Michael Kerrisk feb9ef3848 iopl.2: Minor tweaks to Thomas Piekarski's patch
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-06-29 13:50:23 +02:00
Thomas Piekarski 6caf6c4380 iopl.2: Updating description of permissions and disabling interrupts
Update description of permissions for port-mapped I/O set
per-thread and not per-process. Mention that iopl() can not
disable interrupts since Linux 5.5 anymore and is in general
deprecated and only provided for legacy X servers.

See https://bugzilla.kernel.org/show_bug.cgi?id=205317

Reported-by: victorm007@yahoo.com
Signed-off-by: Thomas Piekarski <t.piekarski@deloquencia.de>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-06-29 13:50:23 +02:00
Michael Kerrisk ada17e7d82 prctl.2: srcfix: add various people to copyright
Based on git history.

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-06-29 13:50:16 +02:00
Michael Kerrisk 236a9f706a prctl.2: Minor fixes to Dave Martin's patch
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-06-26 13:34:48 +02:00
Dave Martin 9b276f9ea8 prctl.2: Add tagged address ABI control prctls (arm64)
Add documentation for the the PR_SET_TAGGED_ADDR_CTRL and
PR_GET_TAGGED_ADDR_CTRL prctls added in Linux 5.4 for arm64.

Signed-off-by: Dave Martin <Dave.Martin@arm.com>
Reviewed-by: Catalin Marinas <catalin.marinas@arm.com>
Cc: Vincenzo Frascino <vincenzo.frascino@arm.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-06-26 13:22:26 +02:00
Michael Kerrisk 7fe3c5a9cf prctl.2: Minor tweaks to Dave Martin's patch
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-06-26 13:13:19 +02:00
Dave Martin 034f403aa7 prctl.2: Add SVE prctls (arm64)
Add documentation for the the PR_SVE_SET_VL and PR_SVE_GET_VL
prctls added in Linux 4.15 for arm64.

Signed-off-by: Dave Martin <Dave.Martin@arm.com>
Cc: Catalin Marinas <catalin.marinas@arm.com>
Cc: Will Deacon <will@kernel.org>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-06-26 13:06:38 +02:00
Michael Kerrisk 27e0d164d9 locale.5: srcfix
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-06-26 11:34:20 +02:00
Michael Kerrisk 927a5da23a locale.5: tfix
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-06-26 11:33:41 +02:00
Michael Kerrisk d44890b7a3 cciss.4: tfix
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-06-26 11:29:02 +02:00
Michael Kerrisk 0b06563436 clone.2: tfix
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-06-26 11:17:44 +02:00
Michael Kerrisk f3061d3662 semctl.2: tfix
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-06-26 11:15:53 +02:00
Michael Kerrisk f902db6b7d sync.2: Minor fixes
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-06-26 11:11:20 +02:00
Michael Kerrisk 4e375ad273 sync.2: Minor tweaks to Jeff Layton's patch
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-06-26 11:11:01 +02:00
Jeff Layton 7b9af2eb80 sync.2: syncfs() now returns errors if writeback fails
A patch has been merged for v5.8 that changes how syncfs() reports
errors. Change the sync() manpage accordingly.

Signed-off-by: Jeff Layton <jlayton@kernel.org>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-06-26 11:01:54 +02:00
Philip Adams aeaf667ec3 tcp.7: tfix
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-06-26 10:49:16 +02:00
Michael Kerrisk fb033b1e18 gethostid.3: wfix: s/is intended/was intended/
The host ID might once have been intended to be globally unique,
but that turned out not to feasible.

Reported-by: Rich Felker <dalias@libc.org>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-06-25 21:35:44 +02:00
Arkadiusz Drabczyk af04113d0c ld.so.8: Explain than empty entry in LD_LIBRARY_PATH means cwd
If this was ever going to change the test case is very simple:

$ cd /tmp
$ touch libc.so.6
$ LD_LIBRARY_PATH=: sh
sh: error while loading shared libraries: libc.so.6: file too short

Signed-off-by: Arkadiusz Drabczyk <arkadiusz@drabczyk.org>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-06-25 09:13:46 +02:00
Michael Kerrisk 09caeefd5c ip.7: Remove mention of ipfw(4) which was in long obsolete ipchains project
Reported-by: Stephen Hemminger <stephen@networkplumber.org>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-06-25 09:00:59 +02:00
Michael Kerrisk ba6431be3a mmap.2: tfix
Reported-by: Bruno Haible <bruno@clisp.org>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-06-25 08:10:21 +02:00
Dan Kenigsberg 0c576731a8 capabilities.7: Clarify that CAP_SYS_NICE relates to *lowering* the nice value
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-06-24 13:43:06 +02:00
Michael Kerrisk 7122afd6bf standards.7: Add an entry for POSIX.1-1988
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-06-24 13:22:12 +02:00
Michael Kerrisk f5f55ae2d3 standards.7: Correct various details in the explanation of XPG/POSIX/SUS
As reported by mail from Geoff Clare, there are some details that
need correcting:

Subject: standards(7) (was: man-pages-5.07 released)
Date: Wed, 10 Jun 2020 10:53:14 +0100
From: Geoff Clare <gwc@opengroup.org>

...

The first isn't really a problem, just an oddity. You list
POSIX.1b as "formerly known as POSIX.4", but you don't do the
equivalent for POSIX.1c ("formerly known as POSIX.4a").

There are several problems with the XPG3 entry:

    "first significant release" - although I suppose XPG3 could
    be considered more significant than XPG2 because it was the
    first one to incorporate POSIX.1, I don't think it's fair to
    imply that XPG2 was not significant.  (E.g. XPG2 was
    significant in that it was the first release to include
    I18N, and the first that had a conformance test suite.)

    "produced by the X/Open Company, a multivendor consortium" -
    this conflates two different things called X/Open. X/Open
    Company Limited is the UK company that did the editing work,
    organised meetings, etc. X/Open Group is the consortium
    whose members developed the technical content.

    "This multivolume guide was based on the POSIX standards" -
    at the time there was only one POSIX standard, namely
    POSIX.1-1988.  The first release to incorporate POSIX.2 was
    XPG4 (which you may consider worth noting in the XPG4
    entry).

To fix these problems I would suggest changing the entry to:

XPG3  Released in 1989, this was the first release of the X/Open
      Portability Guide to be based on a POSIX standard
      (POSIX.1-1988).  This multivolume guide was developed by the
      X/Open Group, a multivendor consortium.

Under SUSv2 I would suggest changing:

    Sometimes also referred to as XPG5.

to:

    Sometimes also referred to (incorrectly) as XPG5.

Under POSIX.1-2001, SUSv3: "XSI conformance constitutes the Single
UNIX Specification version 3 (SUSv3)" is problematic.  I think I
touched on this in the previous discussion. I would suggest
deleting that sentence and instead inserting, before "Two
Technical Corrigenda ...", the following:

    The Single UNIX Specification version 3 (SUSv3) comprises the
    Base Specifications containing XBD, XSH, XCU and XRAT as
    above, plus X/Open Curses Issue 4 version 2 as an extra volume
    that is not in POSIX.1-2001.

Something similar is needed in the POSIX.1-2008, SUSv4 entry where
it talks about "the same four parts". The extra volume this time
is X/Open Curses Issue 7.
]]

Cowritten-by: Geoff Clare <gwc@opengroup.org>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-06-24 13:22:12 +02:00
Michael Kerrisk baa9880610 capabilities.7: srcfix
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-06-24 12:02:18 +02:00
Michael Kerrisk 9f6f7345e4 capabilities.7: tfix
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-06-24 12:01:06 +02:00
Michael Kerrisk a3cb5856c8 capabilities.7: Clarify wording around increasing process nice value
The fact that a more negative nice value means higher
priority is a continuing source of confusion.

Reported-by: Dan Kenigsberg <danken@redhat.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-06-24 11:59:49 +02:00
Michael Kerrisk c8863be925 zic.8: ffix
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-06-23 23:21:05 +02:00
Michael Kerrisk 24e14ed0b3 zic.8: Sync to 2020a tzdb release
From https://www.iana.org/time-zones, version 2020a.

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-06-23 23:21:05 +02:00
Michael Kerrisk f4077c2c2c sysctl.2: glibc removed support for sysctl() starting in version 2.32
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-06-23 21:26:51 +02:00
Michael Kerrisk 575bac0fdd connect.2, pidfd_send_signal.2, ptrace.2, socket.7: ffix
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-06-21 09:26:30 +02:00
Bjarni Ingi Gislason 7f740303b2 man3/*: srcfix: fix warnings from "mandoc -Tlint"
Remove superfluous paragraph macros.

Remove request ".br" if it precedes a line, that begins with a
space, as such lines automatically cause a break.

There is no change in the output from "nroff" and "groff".

###

Examples of warnings from "mandoc -Tlint":

mandoc: bindresvport.3:41:2: WARNING: skipping paragraph macro: PP after SH

mandoc: crypt.3:228:2: WARNING: skipping paragraph macro: PP empty

mandoc: dlinfo.3:151:2: WARNING: skipping paragraph macro: IP empty

mandoc: exec.3:86:2: WARNING: skipping paragraph macro: PP after SS

mandoc: getsubopt.3:45:2: WARNING: skipping paragraph macro: br before text line with leading blank

Signed-off-by: Bjarni Ingi Gislason <bjarniig@rhi.hi.is>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-06-21 09:22:01 +02:00
Bjarni Ingi Gislason fec6cf90e9 man2/*: srcfix: fix warnings from "mandoc -Tlint"
Remove superfluous paragraph macros.

  Remove ".br" if it is before a line that starts with a space
character, as such lines automatically cause a break.

###

  The output is unchanged, except two empty lines are added at the
bottom (before the footer line) in the output of "nroff" for the files
"alloc_hugepages.2" and "userfaultfd.2".

###

  Examples of warnings from "mandoc -Tlint":

mandoc: access.2:283:2: WARNING: skipping paragraph macro: PP after SH

mandoc: adjtimex.2:185:2: WARNING: skipping paragraph macro: PP empty

mandoc: futex.2:728:2: WARNING: skipping paragraph macro: IP empty

mandoc: getsid.2:48:2: WARNING: skipping paragraph macro: br before text line with leading blank

mandoc: init_module.2:290:2: WARNING: skipping paragraph macro: PP after SS

mandoc: ioctl_fideduperange.2:27:2: WARNING: skipping paragraph macro: br after SH

Signed-off-by: Bjarni Ingi Gislason <bjarniig@rhi.hi.is>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-06-21 09:08:00 +02:00
Bjarni Ingi Gislason c3f602233d man7/*: srcfix: trim trailing space
Trim tailing space in "strings".

  There is no change in the output from "nroff" and "groff".

###

Output is from: test-groff -b -mandoc -T utf8 -rF0 -t -w w -z

  [ "test-groff" is a developmental version of "groff" ]

troff: <attributes.7>:510: warning: trailing space
troff: <attributes.7>:512: warning: trailing space
troff: <attributes.7>:513: warning: trailing space
troff: <attributes.7>:516: warning: trailing space
troff: <attributes.7>:649: warning: trailing space
troff: <attributes.7>:681: warning: trailing space
troff: <attributes.7>:720: warning: trailing space
####

troff: <environ.7>:181: warning: trailing space
troff: <environ.7>:182: warning: trailing space
####

troff: <ip.7>:820: warning: trailing space
####

troff: <signal.7>:316: warning: trailing space
Signed-off-by: Bjarni Ingi Gislason <bjarniig@rhi.hi.is>

####

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-06-21 09:03:31 +02:00
Bjarni Ingi Gislason 81533e83e2 proc.5: srcfix: trim trailing space
Output is from: test-groff -b -mandoc -T utf8 -rF0 -t -w w -z

  [ "test-groff" is a developmental version of "groff" ]

Input file is ./proc.5

troff: <proc.5>:4410: warning: trailing space
troff: <proc.5>:5206: warning: trailing space
troff: <proc.5>:5488: warning: trailing space

###

  There is no change in the output from "nroff" and "groff".

Signed-off-by: Bjarni Ingi Gislason <bjarniig@rhi.hi.is>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-06-21 09:02:41 +02:00
Bjarni Ingi Gislason ee6a7196a6 man4/*: srcfix: remove trailing space in "strings"
Trim trailing space.

There is no change in the output from "nroff" and "groff".

Signed-off-by: Bjarni Ingi Gislason <bjarniig@rhi.hi.is>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-06-21 08:48:42 +02:00
Michael Kerrisk 247c654385 fstatvfs.2, getcontext.2, getcwd.2, gethostid.2, killpg.2, mq_notify.2, mq_open.2, mq_timedreceive.2, mq_timedsend.2, mq_unlink.2, setcontext.2, sethostid.2, statvfs.2: Remove historical .so links
These links were mostly created when pages were moved between
sections, in almost every case several years ago. The idea
was to allow people time to get used to the new section numbers
while still having commands of the form "man <sec> <page>"
work as before. Let's assume that people have now had time to
get used to the new section numbers, and remove these links.

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-06-20 09:24:32 +02:00
Michael Kerrisk 12e3a797b3 getdtablesize.2, sigqueue.2, clock_getres.3, clock_gettime.3, clock_settime.3, attr.5, numa_maps.5: Remove old links
These are all links that were created several years ago, mainly
when pages were migrated to different sections, in order to
allow the 'man' commands using the old section numbers to work.
However, the plan was always to eventually remove them, after
allowing people who cared to get used to the new section numbers.
Now, after 5+ years in each case, it's time to remove
these links.

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-06-19 20:50:47 +02:00
Michael Kerrisk 04ce17bdba symlink.7: Minor fixes to Aleksa Sarai's patch
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-06-19 14:59:45 +02:00
Aleksa Sarai 41e240557f symlink.7: Document magic links more completely
Traditionally, magic links have not been a well-understood topic
in Linux. This helps clarify some of the terminology used in
openat2.2.

Signed-off-by: Aleksa Sarai <cyphar@cyphar.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-06-19 14:59:45 +02:00
Oleksandr Kravchuk 32b46e5005 keyctl.2: Declare auth_key
The variable is used in the code example, but not declared,
leading to a compilation error.

Signed-off-by: Oleksandr Kravchuk <open.source@oleksandr-kravchuk.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-06-19 14:58:54 +02:00