summaryrefslogtreecommitdiffstats
path: root/man5 (follow)
Commit message (Collapse)AuthorAgeLines
* man/, share/mk/: Move man*/ to man/Alejandro Colomar2024-05-02-18440/+1
| | | | | | | | | | | | | | | | | | | | This is a scripted change: $ mkdir man/; $ mv man* man/; $ ln -st . man/man*; $ find share/mk/ -type f \ | xargs grep -l '^MANDIR *:=' \ | xargs sed -i '/^MANDIR *:=/s,$,/man,'; $ find share/mk/dist/ -type f \ | xargs grep -l man \ | xargs sed -i 's,man%,man/%,g'; Link: <https://lore.kernel.org/linux-man/YxcV4h+Xn7cd6+q2@pevik/T/> Cc: Petr Vorel <pvorel@suse.cz> Cc: Jakub Wilk <jwilk@jwilk.net> Cc: Stefan Puiu <stefan.puiu@gmail.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* proc.5: Refer to split-out manual pages for detailed descriptionSalvatore Bonaccorso2024-04-14-1/+3
| | | | | | | | | | | | Back in August 2023 various parts of proc(5) were split out into separate manpages. The final cleanup in 92cdcec79df0 ("proc.5: Clean up after making sashimi of this page") missed to as well refer to the split out manpages and retained the wording that details are found further below in the manpages for the various files. Fixes: 92cdcec79df0 ("proc.5: Clean up after making sashimi of this page") Signed-off-by: Salvatore Bonaccorso <carnil@debian.org> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* proc_pid_io.5: Move note to CAVEATSAlejandro Colomar2024-03-18-6/+5
| | | | | Cc: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* proc_pid_io.5: Dewafflifyнаб2024-03-17-37/+31
| | | | | | | | | | | | | | | | | | | | | | | | | | | This page copies verbatim the contents of Documentation/filesystems/proc.rst, added wholesale in commit f9c99463b0cd05603d125c915e2886d55a686b82 ("[PATCH] Documentation for io-accounting / reporting via procfs") in 2007. As such, it mirrors the sensibilities of the time ‒ writing "successful read returns" as "data pulled from storage. actually just the data the process gave to read(). this also means from non-regular files! whether the data was pulled from storage doesn't matter actually (obligatory cache mention)" for the modern reader this is just a lot of waffling (note also that processes give no data to read()!) ‒ and sensibilities of the sheepish implementer in kernel documentation ‒ "an attempt" for a well-defined kernel behaviour, mentioning the "current implementation", consistent mentions of specific kernel-internal caching mechanisms, "the big inaccuracy here". Re-write to be more useful and less misleading as documentation; the syscall enumeration is accurate for kernel v6.8, but the sysc? stats are also bumped by kernel_{read,write}(), which is sometimes used by too many syscalls in too many scenarios to usefully enumerate. Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* proc_pid_io.5: Stats include childrenнаб2024-03-17-9/+18
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This file is like getrusage(2) RUSAGE_SELF + RUSAGE_CHILDREN, the current wording implies it's like just RUSAGE_SELF. Compare: #include <fcntl.h> #include <signal.h> #include <string.h> #include <sys/wait.h> #include <unistd.h> void copy() { char buf[1024]; int fd = open("/proc/self/io", 0); write(1, buf, read(fd, buf, sizeof(buf))); close(fd); } int main() { copy(); copy(); if (!fork()) { zero:; int fd = open("/dev/zero", 0); char buf[64 * 1024] = {}; write(1, buf, 10000); for (int i = 0; i < 1000; ++i) read(fd, buf, sizeof(buf)); _exit(0); } sleep(1); copy(); wait(NULL); copy(); signal(SIGCHLD, SIG_IGN); if (!fork()) goto zero; sleep(1); copy(); wait(NULL); copy(); } yielding rchar: 3980 wchar: 0 syscr: 9 syscw: 0 read_bytes: 2968 write_bytes: 0 cancelled_write_bytes: 0 rchar: 4076 wchar: 96 syscr: 10 syscw: 1 read_bytes: 2968 write_bytes: 96 cancelled_write_bytes: 0 rchar: 4175 wchar: 195 syscr: 11 syscw: 2 read_bytes: 2968 write_bytes: 195 cancelled_write_bytes: 0 rchar: 65540276 wchar: 10296 syscr: 1012 syscw: 4 read_bytes: 2968 write_bytes: 10296 cancelled_write_bytes: 0 rchar: 65540387 wchar: 10407 syscr: 1013 syscw: 5 read_bytes: 2968 write_bytes: 10407 cancelled_write_bytes: 0 rchar: 65540498 wchar: 10518 syscr: 1014 syscw: 6 read_bytes: 2968 write_bytes: 10518 cancelled_write_bytes: 0 Just s/process/& and its waited-for children/ but re-broken per review. Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* tzfile.5: ffixAlejandro Colomar2024-03-17-2/+2
| | | | | | Cc: "G. Branden Robinson" <branden@debian.org> Cc: Paul Eggert <eggert@cs.ucla.edu> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* tzfile.5: Avoid crashing man2html(1)Alejandro Colomar2024-03-17-14/+14
| | | | | | | | Link: <https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1067022> Cc: Paul Eggert <eggert@cs.ucla.edu> Cc: "G. Branden Robinson" <branden@debian.org> Cc: Robert Luberda <robert@debian.org> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* tzfile.5, tzselect.8, zdump.8, zic.8: Refresh pagesAlejandro Colomar2024-03-16-66/+78
| | | | | | Refreshed from tzdb-2024a. Signed-off-by: Alejandro Colomar <alx@kernel.org>
* getrusage.2, proc_pid_io.5: Crosslinkнаб2024-03-14-0/+1
| | | | | | | These serve the same purpose from different perspectives. Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* proc_pid_io.5: Mention atomicity in atomicity noteнаб2024-03-14-5/+4
| | | | | | | | | And drop "current implementation" (wording still literal from Documentation/filesystems/proc.rst). Of course this describes the current implementation. Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* proc_pid_io.5: wfixнаб2024-03-14-4/+4
| | | | | Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* man*/: ffixAlejandro Colomar2024-02-25-3/+3
| | | | | | | | | | | | | | | | Found with: $ grep -rn '^\.[BI] .* [.,:;)]*$' man* man2/prctl.2:382:.B FR=1 . man2/openat2.2:377:.B EAGAIN . man2/openat2.2:424:.I how.resolve . man5/elf.5:788:.B PF_R . man5/networks.5:18:.I name number aliases ... man5/protocols.5:31:.I protocol number aliases ... man7/cgroups.7:980:.I """max""" . Cc: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* man*/: Say ISO 3166Alejandro Colomar2024-01-28-3/+3
| | | | | | | Link: <https://www.iso.org/iso-3166-country-codes.html> Reported-by: Helge Kreutzmann <debian@helgefjell.de> Cc: Mario Blaettermann <mario.blaettermann@gmail.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* locale.5: Say ISO 4217Alejandro Colomar2024-01-28-1/+1
| | | | | | | Link: <https://www.iso.org/standard/64758.html> Reported-by: Helge Kreutzmann <debian@helgefjell.de> Cc: Mario Blaettermann <mario.blaettermann@gmail.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* man*/: Say ISO 639Alejandro Colomar2024-01-28-3/+3
| | | | | | | Link: <https://www.iso.org/standard/74575.html> Reported-by: Helge Kreutzmann <debian@helgefjell.de> Cc: Mario Blaettermann <mario.blaettermann@gmail.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* filesystems.5: Say ISO/IEC 9660Alejandro Colomar2024-01-28-2/+2
| | | | | | | Link: <https://www.iso.org/standard/81979.html> Reported-by: Helge Kreutzmann <debian@helgefjell.de> Cc: Mario Blaettermann <mario.blaettermann@gmail.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* man*/: Say ISO/IEC 6429Alejandro Colomar2024-01-28-9/+9
| | | | | | | Link: <https://www.iso.org/standard/12782.html> Reported-by: Helge Kreutzmann <debian@helgefjell.de> Cc: Mario Blaettermann <mario.blaettermann@gmail.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* man*/: Say ISO/IEC 8859Alejandro Colomar2024-01-28-1/+1
| | | | | | | Link: <https://www.iso.org/standard/28245.html> Reported-by: Helge Kreutzmann <debian@helgefjell.de> Cc: Mario Blaettermann <mario.blaettermann@gmail.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* locale.5: tfixG. Branden Robinson2024-01-15-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | ...that proved surprisingly tough to troubleshoot. I got the following output from my working copy. grotty:...:(man5/locale.5):32291: error: output above first line discarded grotty:...:(man5/locale.5):32291: error: output above first line discarded grotty:...:(man5/locale.5):32291: error: output above first line discarded grotty:...:(man5/locale.5):32291: error: output above first line discarded grotty:...:(man5/locale.5):32291: error: output above first line discarded grotty:...:(man5/locale.5):32291: error: output above first line discarded grotty:...:(man5/locale.5):32291: error: output above first line discarded grotty:...:(man5/locale.5):32291: error: output above first line discarded grotty:...:(man5/locale.5):32291: error: output above first line discarded grotty:...:(man5/locale.5):32292: error: output above first line discarded grotty:...:(man5/locale.5):32294: error: output above first line discarded grotty:...:(man5/locale.5):32294: error: output above first line discarded grotty:...:(man5/locale.5):32294: error: output above first line discarded grotty:...:(man5/locale.5):32294: error: output above first line discarded grotty:...:(man5/locale.5):32294: error: output above first line discarded `\r` is a perfectly legal *roff escape sequence, but one generally never sees it in man pages. In that case, the input line in question was at the top of the "page" in continuous rendering mode, and so the attempt at a reverse vertical motion did indeed put the drawing position above the top of the page. grepping reveals no other occurrences of '\r' in the man-pages corpus. Signed-off-by: "G. Branden Robinson" <g.branden.robinson@gmail.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* proc_sys_user.5: tfixJakub Wilk2023-11-24-1/+1
| | | | | Signed-off-by: Jakub Wilk <jwilk@jwilk.net> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* proc_pid_oom_score_adj.5: tfixJakub Wilk2023-11-24-1/+1
| | | | | Signed-off-by: Jakub Wilk <jwilk@jwilk.net> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* proc_pid_mountinfo.5: spfixJakub Wilk2023-11-24-1/+1
| | | | | Signed-off-by: Jakub Wilk <jwilk@jwilk.net> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* proc_crypto.5: spfixJakub Wilk2023-11-24-1/+1
| | | | | | | | "Cypher" is a valid but less common spelling of "cipher". The latter is used everywhere else, so let's use it here too. Signed-off-by: Jakub Wilk <jwilk@jwilk.net> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* man*/: srcfixG. Branden Robinson2023-11-19-2/+6
| | | | | | | | | | | | | | | | | Clean up in preparation for "MR sed". Format only one man page cross reference per input line. Begin parentheticals on their own input lines. Also, groff 1.23.0's (and Plan 9 from User Space's) `MR` is not a font style alternation macro; there is no "reversed" form as with `BR` and `RB`. So when a man page cross reference must be immediately preceded by punctuation, put that punctuation on the previous text line and use the `\c` escape sequence to connect them. Signed-off-by: "G. Branden Robinson" <g.branden.robinson@gmail.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* man*/: srcfix (Use .P instead of .PP or .LP)Alejandro Colomar2023-10-31-387/+387
| | | | | | | | | | | | | | We're trying to "standardize" on a paragraphing macro from the three equivalent ones (P, PP, LP). We (somewhat arbitrarily) agreed on P. Scripted change: $ find man* -type f | xargs sed -i '/\.PP/s/PP/P/' $ find man* -type f | xargs sed -i '/\.LP/s/LP/P/' Suggested-by: "G. Branden Robinson" <branden@debian.org> Cc: Ingo Schwarze <schwarze@openbsd.org> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* man*/: ffix (Use '.TQ' where appropriate)Alejandro Colomar2023-10-23-16/+51
| | | | | | | | | | | | When there are multiple tags for a paragraph, using a single TP and separating the tags with commas makes the man(7) source more complex. It also has a disadvantage: when searching through a manual page, heuristics such as " --option" don't work so well. By using GNU's TQ, we simplify the source of the pages, and improve the ability to search them. Signed-off-by: Alejandro Colomar <alx@kernel.org>
* proc_sys.5, proc_sys_vm.5: Split /proc/sys/vm/ from proc_sys(5)Alejandro Colomar2023-09-30-406/+420
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* proc_sys.5, proc_sys_user.5: Split /proc/sys/user/ from proc_sys(5)Alejandro Colomar2023-09-30-4/+18
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* proc_sys.5, proc_sys_sunrpc.5: Split /proc/sys/proc/ from proc_sys(5)Alejandro Colomar2023-09-30-5/+19
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* proc_sys.5, proc_sys_proc.5: Split /proc/sys/proc/ from proc_sys(5)Alejandro Colomar2023-09-30-3/+17
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* proc_sys.5, proc_sys_net.5: Split /proc/sys/net/ from proc_sys(5)Alejandro Colomar2023-09-30-20/+34
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* proc_sys.5, proc_sys_kernel.5: Split /proc/sys/kernel/ from proc_sys(5)Alejandro Colomar2023-09-30-677/+691
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* proc_sys.5, proc_sys_fs.5: Split /proc/sys/fs/ from proc_sys(5)Alejandro Colomar2023-09-30-457/+471
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* proc_sys.5, proc_sys_dev.5: Split /proc/sys/dev/ from proc_sys(5)Alejandro Colomar2023-09-30-6/+20
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* proc_sys.5, proc_sys_debug.5: Split /proc/sys/debug/ from proc_sys(5)Alejandro Colomar2023-09-30-3/+17
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* proc_sys.5, proc_sys_abi.5: Split /proc/sys/abi/ from proc_sys(5)Alejandro Colomar2023-09-30-10/+24
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* tmpfs.5: Extend with new noswap documentationLuis Chamberlain2023-09-27-0/+6
| | | | | | | | | | Linux commit 2c6efe9cf2d7 ("shmem: add support to ignore swap") merged as of v6.4 added support to disable swap for tmpfs mounts. This extends the man page to document that. Signed-off-by: Luis Chamberlain <mcgrof@kernel.org> Signed-off-by: Alejandro Colomar <alx@kernel.org>
* man5/: srcfix: '\" t commentAlejandro Colomar2023-09-07-5/+1
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* proc_self.5: Fix link pageAlejandro Colomar2023-09-03-1/+1
| | | | | Fixes: 68553d3f22ff ("proc.5, proc_pid.5, proc_self.5: Split /proc/PID/ (and /proc/self/) from proc(5)") Signed-off-by: Alejandro Colomar <alx@kernel.org>
* proc.5: Clean up after making sashimi of this pageAlejandro Colomar2023-08-15-30/+3
| | | | | | | | | | | | | | - Remove outdated comments (they're on git, so it's not worth moving them to the appropriate pages). - Relicense with GPL-3.0-or-later, and add myself to copyleft. - Remove now-empty "Files and directories" subsection. - Remove now-irrelevant note about the page being a monster, which it is not anymore. Signed-off-by: Alejandro Colomar <alx@kernel.org>
* proc.5, proc_zoneinfo.5: Split /proc/zoneinfo from proc(5)Alejandro Colomar2023-08-15-5/+17
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* proc.5, proc_vmstat.5: Split /proc/vmstat from proc(5)Alejandro Colomar2023-08-15-690/+702
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* proc.5, proc_version.5: Split /proc/version from proc(5)Alejandro Colomar2023-08-15-15/+27
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* proc.5, proc_uptime.5: Split /proc/uptime from proc(5)Alejandro Colomar2023-08-15-5/+17
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* proc.5, proc_tty.5: Split /proc/tty from proc(5)Alejandro Colomar2023-08-15-4/+16
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* proc.5, proc_timer_stats.5: Split /proc/timer_stats from proc(5)Alejandro Colomar2023-08-15-105/+117
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* proc.5, proc_timer_list.5: Split /proc/timer_list from proc(5)Alejandro Colomar2023-08-15-6/+18
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* proc.5, proc_sysvipc.5: Split /proc/sysvipc/ from proc(5)Alejandro Colomar2023-08-15-15/+25
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* proc.5, proc_sysrq-trigger.5: Split /proc/sysrq-trigger from proc(5)Alejandro Colomar2023-08-15-13/+25
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
* proc.5, proc_sys.5: Split /proc/sys/ from proc(5)Alejandro Colomar2023-08-15-1610/+1623
| | | | Signed-off-by: Alejandro Colomar <alx@kernel.org>
generated by cgit v1.2.3 (git 2.39.1) at 2024-06-15 05:59:08 +0000