aboutsummaryrefslogtreecommitdiffstats
path: root/man/man7/man-pages.7
AgeCommit message (Collapse)AuthorFilesLines
2025-09-25man/: ffix (escape dashes)Alejandro Colomar1-1/+1
Most of these have been reported by 'make lint-man-dash'. A couple of them were found manually. Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-09-21man-pages.7: STYLE GUIDE: Mention UNIX for BeginnersAlejandro Colomar1-0/+6
Reported-by: Peter Xu <peterx@redhat.com> [gbr: style fixes] Cc: "G. Branden Robinson" <g.branden.robinson@gmail.com> Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
2025-09-21man/: Use semantic newlinesAlejandro Colomar1-3/+6
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/man7/man-pages.7: Document formatting of foward declarations of function ↵Alejandro Colomar1-0/+13
parameters Reported-by: Helge Kreutzmann <debian@helgefjell.de> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-08-23man/man7/man-pages.7: ffixAlejandro Colomar1-1/+3
Prevent splitting 'uname -m', and use italics instead of quotes. Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-08-22man/: ffixAlejandro Colomar1-6/+2
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-22man/man7/man-pages.7: ffixAlejandro Colomar1-1/+1
This table format specification was bogus. It specified 4 columns, but we were only using 3. Due to the commit in which that was introduced, I suspect it was just a typo that went unnoticed. Fixes: 0ab815e900ce (2021-01-06; "man-pages.7: ffix: don't fill text in tables") Reported-by: Ingo Schwarze <schwarze@openbsd.org> Suggested-by: Ingo Schwarze <schwarze@openbsd.org> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-05-17*: grfixAlejandro Colomar1-1/+1
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 Colomar1-1/+1
- 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 Colomar1-3/+1
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 Colomar1-3/+0
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 Colomar1-13/+24
While doing this global change, fix other minor issues found nearby. Signed-off-by: Alejandro Colomar <alx@kernel.org>
2025-01-15man/man7/man-pages.7: Stop telling contributors to write titles in all capsJason Yundt1-2/+1
Recently, I submitted my first patch to the Linux man-pages project. In my patch, I had created a new manual page. On the manual page’s title line, I had written the title of my new page in all caps because man-pages(7) said that I should write it that way. It turns out that man-pages(7) was wrong and that the title on the title line should have matched the title in the manual page’s filename [1][2]. This commit corrects man-pages(7) so that it does not tell contributors to use all caps when writing titles on title lines. Link: [1] <https://lore.kernel.org/linux-man/rph24kz36vysoeix4qoxxxcwq3c3fskws2vmxkkgcb2lpits3f@ysm7ug66svzh/T/#mc84250a6634d7f776118879021331001cceccbe5> Link: [2] <https://lore.kernel.org/linux-man/mog6nnwzwl2dmlrec5b7l76wbxlsnklvdulok644x6o557trib@3zwtoz47r4x3/T/#mf71422d0e159210a7ca2798f2bba50a668e1410e> Message-ID: <20250114211427.160509-1-jason@jasonyundt.email> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-06-15man/: srcfix: Use \[rs] instead of \eAlejandro Colomar1-9/+9
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-06-13man-pages.7: Correct escaping of \~ adviceBrian Norris1-1/+2
\e[ti] renders as \[ti] -- using \[ti] in a man page will produce a literal tilde (~), not a nonbreaking space. The intention here is to recommend \~, which produces a nonbreaking space, so we need some more escaping. Apply bold formatting too, which I believe is in accordance with the advice in this section. Fixes: 36f73ba37945 ("man-pages.7: Recommend using \[..] instead of \(.. escapes") Signed-off-by: Brian Norris <briannorris@chromium.org> Message-ID: <20240613205329.3240669-1-briannorris@chromium.org> Cc: "G. Branden Robinson" <branden@debian.org> Signed-off-by: Alejandro Colomar <alx@kernel.org>
2024-05-02man/, share/mk/: Move man*/ to man/Alejandro Colomar1-0/+1227
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 Colomar1-1162/+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 Colomar1-0/+1162
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>