aboutsummaryrefslogtreecommitdiffstats
path: root/man/man4
AgeCommit message (Collapse)AuthorFilesLines
2025-10-10man/man4/console_codes.4: ffixG. Branden Robinson1-6/+0
Stop meddling with adjustment. A lengthy comment in groff's man(7) package explains why attempts to meddle with text alignment and adjustment with the `ad` and `na` requests--outside of tbl(1) text blocks--exhibits contempt for reader preferences and often comes to grief anyway. .\" Resetting the adjustment mode is a complicated dance. .\" 1. Man pages sometimes disable adjustment--when they do, they .\" often forget to put it back the way it was. .\" 2. When they do remember to put it back, they often fail to do .\" so correctly because of the `ad` request's quirky semantics .\" starting from Seventh Edition Unix troff/nroff. Briefly, the .\" `ad` request without arguments turns adjustment back on after .\" an `na` even if the previous adjustment mode was `l` (align to .\" the left with NO adjustment). .\" 3. The default adjustment mode historically has not been .\" predictable; it can depend on nroff vs. troff mode and on the .\" vendor of the *roff system in use. .\" 4. It's possible (and portable) to obtain the previous adjustment .\" mode via the `.j` register so that it can be saved prior to .\" meddling and restored later, but in practice man page authors .\" neglect to do so. .\" 5. groff man(7)'s `AD` string isn't supported everywhere. .\" 6. We want user preferences, if expressed, to override the page .\" author's. .\" 7. Even if we didn't want (6), one page author's can override .\" another's when formatting multiple man(7) documents in .\" sequence[.] Signed-off-by: "G. Branden Robinson" <g.branden.robinson@gmail.com> Message-ID: <20251009215811.3a6ughmxcskgae3s@illithid> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-10-10man/man4/console_codes.4: ffixG. Branden Robinson1-1/+1
Add missing `x` column modifier to the descriptive column of the "VT100 console sequences not implemented on the Linux console" table, making it format like all the other tables in this man page. Signed-off-by: "G. Branden Robinson" <g.branden.robinson@gmail.com> Message-ID: <20251009215801.yt57b4zbpsvctl5h@illithid> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-10-10man/man4/console_codes.4: wfixG. Branden Robinson1-1/+1
Spell out column heading as "parmeter"; "param" is a false economy given that one of the entries in the same column is "100..107" (only one en shorter). Signed-off-by: "G. Branden Robinson" <g.branden.robinson@gmail.com> Message-ID: <20251009215752.upezzr4gubzveiwe@illithid> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-10-10man/man4/console_codes.4: ffixG. Branden Robinson1-3/+7
Use a more idiomatic means (than numeral-width horizontal motion escape sequences `\0`) of setting table entries that are indented with respect to other entries in the same column. Use table region continuation (`.T&`) and the `A` column classifier. See tbl(1). Signed-off-by: "G. Branden Robinson" <g.branden.robinson@gmail.com> Message-ID: <20251009215742.w44sai53jje46m6h@illithid> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-10-10man/man4/console_codes.4: ffixG. Branden Robinson1-4/+10
Put lengthy table entries into tbl(1) text blocks, so that they don't cause output lines to overset. Signed-off-by: "G. Branden Robinson" <g.branden.robinson@gmail.com> Message-ID: <20251009215733.k3dgj5mafiysxa7z@illithid> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-10-10man/man4/console_codes.4: ffixG. Branden Robinson1-0/+9
Consistently put inter-paragraph space before tables. Signed-off-by: "G. Branden Robinson" <g.branden.robinson@gmail.com> Message-ID: <20251009215724.7gms7w7zosrlg44n@illithid> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-10-10man/man4/console_codes.4: Document the names of the "ESC s" and "ESC u" ↵G. Branden Robinson1-2/+2
extension controls. Link: <https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h3-Functions-using-CSI-_-ordered-by-the-final-character_s_> Signed-off-by: "G. Branden Robinson" <g.branden.robinson@gmail.com> Message-ID: <20251009215712.zhmxvmbtx72tk4yg@illithid> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-10-05man/: ffixAlejandro Colomar1-3/+3
Remove spaces before a tab (except in a few cases). Reported-by: "G. Branden Robinson" <branden@debian.org> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-10-05man/man4/console_codes.4: ffixAlejandro Colomar1-1/+3
Also remove it from "share/mk/build/catman/troff.xfail", as it doesn't fail anymore. Suggested-by: "G. Branden Robinson" <branden@debian.org> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-09-21man/: Use semantic newlinesAlejandro Colomar10-80/+127
And fix related issues while at it. Silence false positives with \&. Reported-by: `make lint-man-semnl` Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-09-06man/: ffixAlejandro Colomar1-5/+9
Reported-by: Helge Kreutzmann <debian@helgefjell.de> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-08-24man/man4/console_codes.4: tfixAlejandro Colomar1-1/+1
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-08-22man/: ffixAlejandro Colomar1-1/+1
On Fri, Aug 22, 2025 at 05:09:42PM +0200, Ingo Schwarze wrote: > > .TS > > l l l > > --- > > That's terrible style. > > Using "-" in the tbl(7) layout only makes sense when the same layout > line also contains at least one cell that receives data. > > A horizontal line that extends across the table as a whole > should *not* get its own layout line but can be specified purely > in the data section of the table. That's not only more robust, > but also results in source code that is easier to read and maintain. > > The above is not just convention, but also makes sense logically > and is related to the root cause of your earlier blank line woes. > A table line that receives no data should not be specified in the > layout because every layout line requires at least one data line, > so a layout line receiving no data is an oxymoron, and that logical > contradiction is precisely what causes the issue of needing a > blank line in the first place. > > Note that in a layout line that only contains "-" for *some* cells, > while at leat one cell receives data, the problem does not occur > because the coressponding data line(s) do contain actual data > for at least one cell, so they are not blank. Reported-by: Ingo Schwarze <schwarze@openbsd.org> Suggested-by: Ingo Schwarze <schwarze@openbsd.org> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-08-20man/: EXAMPLES: Use err(3) and errc(3bsd) instead of similar macrosAlejandro Colomar1-8/+6
These functions are quite portable. And if one doesn't have them for some reason (but libbsd has been ported to many systems), one can write them easily as macros, anyway. Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-05-17*: grfixAlejandro Colomar31-31/+31
Scripted change: $ grep -rl 'The authors of the Linux man-pages' \ | xargs sed -i '/Copyright, The authors of the Linux man-pages project/s/The/the/'; Reported-by: Josh Triplett <josh@joshtriplett.org> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-05-10*, AUTHORS: Consistently refer to authorsAlejandro Colomar31-31/+31
- Rename the file CREDITS => AUTHORS - Say 'authors' in the copyright notice. Scripted change: $ grep -rn 'The contributors to the Linux man-pages' -l \ | xargs sed -i '/Copyright, The contributors to the Linux man-pages project/s/contributors to/authors of/' Suggested-by: Dave Martin <Dave.Martin@arm.com> Acked-by: "G. Branden Robinson" <branden@debian.org> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-05-06*, CREDITS: Unify copyright noticesAlejandro Colomar31-51/+31
Link: <https://lore.kernel.org/linux-man/jpin2dbnp5vpitnh7l4qmvkamzq3h3xljzsznrudgioox3nn72@57uybxbe3h4p/T/#u> Link: <https://www.linuxfoundation.org/blog/blog/copyright-notices-in-open-source-software-projects> Cc: "G. Branden Robinson" <branden@debian.org> Cc: Carlos O'Donell <carlos@redhat.com> Cc: Eugene Syromyatnikov <evgsyr@gmail.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-05-06man/, CREDITS: Move in-source contribution records to CREDITSAlejandro Colomar25-75/+5
This information is better placed in the git logs, not in the source code itself. For people interested in the old history of pages, before we used git, they will probably look at old versions of these pages, like for example man-pages-1.70, or the 'prehistory' branch, and there they'll find these notes. Keep the names and emails of contributors in a new CREDITS file. Link: <https://lore.kernel.org/linux-man/jpin2dbnp5vpitnh7l4qmvkamzq3h3xljzsznrudgioox3nn72@57uybxbe3h4p/T/#u> Link: <https://www.linuxfoundation.org/blog/blog/copyright-notices-in-open-source-software-projects> Cc: "G. Branden Robinson" <branden@debian.org> Cc: Carlos O'Donell <carlos@redhat.com> Cc: Eugene Syromyatnikov <evgsyr@gmail.com> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-03-30man/: srcfix (\fX => \f[X])Alejandro Colomar13-218/+364
While doing this global change, fix other minor issues found nearby. Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-11-17man/: Terminology consistency reforms (n, size, length)Alejandro Colomar1-3/+3
Use 'length' for the lenght of a string. Use 'n' for the number of elements. Use 'size' for the number of bytes. (And in wide-character string functions, 'size' also refers to the number of wide characters.) The change is quite large, and I might have made some mistakes. But overall, this should improve consistency in use of these terms. Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-09-01console_codes.4, inode.7: srcfixG. Branden Robinson1-2/+5
Prepare for `MR` macro migration. Rewrite man page cross references inside tbl(1) text blocks to use man(7) macros instead of troff(1) font selection escape sequences. $ cat fix-man-page-refs-in-tbl-tables-1.sed # Rewrite man page cross references inside tbl(1) text blocks to use # man(7) macros instead of troff(1) font selection escape sequences. /^\.\\"/b # Case: (handled in commit 9d21f97766, 2024-07-27) # T{ # See \fBchown\fP(2) for # T} /T{$/,/^T}/s/ \\fB\([^\\]*\)\\fP\(([0-9][a-z]*)\) /\ .BR \1 \2\ / # Case: # T{ # the map that is loaded by the utility \fBmapscrn\fP(8). # T} /T{$/,/^T}/s/ \\fB\([^\\]*\)\\fP\(([0-9][a-z]*)\)\([^0-9a-z]\+\)$/\ .BR \1 \2\3/ # Case: # T{ # by \fBxterm\fP(1)'s \fBhpLowerleftBugCompat\fP resource). # T} /T{$/,/^T}/s/ \\fB\([^\\]*\)\\fP\(([0-9][a-z]*)\)\([^ ]\+\) \(.*\)/\ .BR \1 \2\3\ \4/ Signed-off-by: "G. Branden Robinson" <g.branden.robinson@gmail.com> Message-ID: <20240901032603.khxdcqiqc2pxooky@illithid> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-09-01lirc.4: srcfixG. Branden Robinson1-1/+3
Prepare for `MR` macro migration. Migrate man page cross references in "SEE ALSO" section from using font selection escape sequences to font alternation macros to set man page cross references. This is an oddball case where `\-` appears in the man page title and, for no obvious reason, a nonbreaking space escape sequence was applied between list items. (I can _guess_ why: someone was trying to defeat line adjustment, and didn't notice that they were trying to do so right before a paragraph break, so adjustment wouldn't have happened anyway.) Signed-off-by: "G. Branden Robinson" <g.branden.robinson@gmail.com> Message-ID: <20240901032556.mmrwd27rpr3zzb5s@illithid> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-06-28man/: ffix (Use TQ where appropriate)Alejandro Colomar2-4/+12
Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-06-15man/: srcfix: Use \[rs] instead of \eAlejandro Colomar7-14/+14
Scripted change: $ find man -type f \ | xargs grep -l '\\e' \ | xargs sed -i 's/\\e/\\[rs]/g'; Link: <https://lore.kernel.org/linux-man/20240611122453.qn6jyl4go4bvwkqm@illithid/> Suggested-by: "G. Branden Robinson" <branden@debian.org> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-05-02man/, share/mk/: Move man*/ to man/Alejandro Colomar40-0/+7742
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>
2022-09-09Revert "src.mk, All pages: Move man* to man/"Alejandro Colomar40-7497/+0
This reverts commit 70ac1c4785fc1e158ab2349a962dba2526bf4fbc. Link: <https://lore.kernel.org/linux-man/YxcV4h+Xn7cd6+q2@pevik/T/> Reported-by: Petr Vorel <pvorel@suse.cz> Reported-by: Jakub Wilk <jwilk@jwilk.net> Cc: Stefan Puiu <stefan.puiu@gmail.com> Signed-off-by: Alex Colomar <alx.manpages@gmail.com>
2022-09-05src.mk, All pages: Move man* to man/Alejandro Colomar40-0/+7497
The root of the repository is becoming a bit overpopulated and unorganized, due to the recent addition of more mandirs, and more informative and configuration files too. Let's create a specific mandir <man/> that contains the mandirs <man[1-8]*>. Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
generated by cgit 1.2.3-korg (git 2.43.0) at 2025-12-01 07:40:20 +0000