summaryrefslogtreecommitdiffstats
path: root/man
AgeCommit message (Collapse)AuthorLines
2026-01-26maint: avoid syntax-check failureCollin Funk-0/+5
* man/date.x: Add a copyright header to fix sc_copyright_check. Reported by Bruno Haible.
2026-01-26doc: fit in 80 columnsPaul Eggert-1/+2
2026-01-25doc: fix date(1) synopses etcPaul Eggert-0/+6
Font problem reported by Michael Aramini via Alejandro Colomar <https://bugs.gnu.org/80258>. This patch also fixes some longstanding confusion with date synopses. * src/date.c (usage): Do not imply that only -u can be used with MMDDhhmm..., and do not put misleading brackets around the latter.
2026-01-22doc: dir,vdir: add dircolors(1) reference to man pagesEgmont Koblinger-0/+4
* man/dir.x: Add dircolors(1) to "SEE ALSO" section. * man/vdir.x: Likewise.
2026-01-22doc: help2man: handle leading '+' in optionsPádraig Brady-3/+3
* man/help2man: Fix indentation of options with leading '+'.
2026-01-22doc: use TERM=dumb rather than HELP_NO_MARKUP to disable markupPádraig Brady-2/+2
This is a more standard mechanism to disable markup. * src/system.h (oputs_): Logic change to honor TERM=dumb, rather than HELP_NO_MARKUP=something. * doc/coreutils.texi: Adjust the description for --help. * man/local.mk: Ensure TERM is set to something, so that man pages have links included. * man/viewman: Just honor users $TERM. * tests/misc/getopt_vs_usage.sh: Remove env var complication, as TERM is unset automatically. * tests/misc/usage_vs_refs.sh: Likewise. * NEWS: Adjust the change in behavior note.
2026-01-21doc: viewman: a new helper to quickly view formatted man pagesPádraig Brady-0/+33
Use like: man/viewman ls * man/viewman: Generate man page on the fly, and view.
2026-01-21doc: help2man: account for undisplayed markup in indenting calculationsPádraig Brady-4/+15
* man/help2man: This is significant with the indented line following the dd bs=BYTES "option" at least.
2026-01-21doc: help2man: convert all hyperlinks, not just ones in --optionsPádraig Brady-4/+5
* man/help2man: Make the (--?) part of the match optional. Note we still extract the dashes, to support the existing option matching logic in help2man.
2026-01-21doc: help2man: support alternate format OSC hyperlinksPádraig Brady-2/+7
* man/help2man: The BEL terminator format was already supported. Add support for ESC + backslash terminator. Also split out and document the regular expression.
2026-01-21doc: help2man: convert OSC hyperlinksPádraig Brady-3/+24
* man/help2man: Convert OSC hyperlinks to roff \X escapes, which will be converted back to OSC hyperlinks when the man page is displayed on the terminal. Note formatting is removed from hyperlinked text by default, thus relying on how the terminal highlights hyperlinks, but --bold-refs is honored in this case, in which hyperlinked text will be marked up as bold, which matches the default markup used for non hyperlinked options.
2026-01-21doc: help2man: recognise option description with smaller indentPádraig Brady-1/+1
* man/help2man: Allow for a smaller indented option description. This smaller indentation is present in timeout --help output, so now the line spacing in timeout.1 is more consistent. Also having the description on a separate line with a smaller indentation, is a more general way to present option descriptions (and what the man page formatting uses already). We'll be changing many utilities, especially with longer multi-line descriptions to this new format.
2026-01-21doc: help2man: strip ANSI codesPádraig Brady-0/+7
* man/help2man: With these ANSI codes, output is corrupted, so it's best to strip these, which allows --help to outputting formatting and hyperlinks by default.
2026-01-18doc: add more redirections from legacy *sum to cksumPádraig Brady-7/+5
* doc/coreutils.texi (md5sum invocation, sha1sum invocation, b2sum invocation, sha2 utilities): Mention these are legacy interfaces, and reference 'cksum invocation'. * src/cksum.c (usage): Likewise. * man/md5sum.x: Redirect to cksum, rather than individual utils. * man/sha1sum.x: Likewise.
2026-01-16maint: spelling fixesPaul Eggert-3/+3
2026-01-01maint: run 'make update-copyright'Collin Funk-10/+10
2025-11-28doc: touch: man: state in summary that files are createdPádraig Brady-1/+1
* man/touch.x: Creating files is core functionality of touch(1), so state this in the summary, so that apropos can be used to search for file creation functionality.
2025-11-19build: support --enable-single-binary=hardlinksPádraig Brady-0/+4
* Makefile.am: Use ln rather than $(LN_S) for hardlinks. * configure.ac: Accept --enable-single-binary=hardlinks. * man/local.mk: In hardlink mode, explicitly add the hardlink creation rule to mandeps. Given the automake generated dependency chain, this ensures that the hardlinks are created _after_ the multicall binary, with `make all` or `make check` etc. * src/local.mk: Define the new src/coreutils_hardlinks rule, and only depend on src/coreutils_{symlinks,shebangs} if in those modes, so that hardlinks are created _after_ the multicall binary, and other link types before. * NEWS: Mention the new feature. Addresses https://github.com/coreutils/coreutils/issues/129
2025-10-02doc: man: consistently format -X[OPTIONAL] formPádraig Brady-1/+3
This is significant for the date, od, and pr commands which have options of the form -X[OPTIONAL], which change like: diff -r man.orig/date.1 man/date.1 < \fB\-I[FMT]\fR, \fB\-\-iso\-8601\fR[=\fI\,FMT\/\fR] > \fB\-I\fR[\fI\,FMT\/\fR], \fB\-\-iso\-8601\fR[=\fI\,FMT\/\fR] diff -r man.orig/od.1 man/od.1 < \fB\-w[BYTES]\fR, \fB\-\-width\fR[=\fI\,BYTES\/\fR] > \fB\-w\fR[\fI\,BYTES\/\fR], \fB\-\-width\fR[=\fI\,BYTES\/\fR] * man/help2man (convert_options): Support options of the form -X[PARAM], so that we now consistently format them (in italics).
2025-10-02doc: man: consistently italicize --option parametersPádraig Brady-1/+6
This changes a few pages, but the changes in tail.1 concisely illustrate the resulting man page changes: $ diff -r man.orig/tail.1 man/tail.1 < \fB\-c\fR, \fB\-\-bytes\fR=\fI\,[\/\fR+]NUM > \fB\-c\fR, \fB\-\-bytes\fR=\fI\,[+]NUM\/\fR < \fB\-f\fR, \fB\-\-follow[=\fR{name|descriptor}] > \fB\-f\fR, \fB\-\-follow\fR[=\fI\,{name|descriptor}\/\fR] < \fB\-n\fR, \fB\-\-lines\fR=\fI\,[\/\fR+]NUM > \fB\-n\fR, \fB\-\-lines\fR=\fI\,[+]NUM\/\fR * man/help2man: Relax the option match so more --option variations are supported, and passed through to convert_option(). Specifically more variations after '=' are now supported. Also split and document the regular expression. Reported at https://github.com/coreutils/coreutils/issues/84
2025-05-15maint: --help now outputs bug reporting addressPaul Eggert-1/+1
This changes the tail of "cat --help" output from: GNU coreutils online help: <https://www.gnu.org/software/coreutils/> Full documentation <https://www.gnu.org/software/coreutils/cat> or available locally via: info '(coreutils) cat invocation' to: Report bugs to: bug-coreutils@gnu.org GNU coreutils home page: <https://www.gnu.org/software/coreutils/> General help using GNU software: <https://www.gnu.org/gethelp/> Full documentation <https://www.gnu.org/software/coreutils/cat> or available locally via: info '(coreutils) cat invocation' * src/system.h (emit_bug_reporting_address): Don’t #define. (emit_ancillary_info): Call emit_bug_reporting_address instead of doing it by hand, which omitted the bug reporting address.
2025-02-05doc: remove extraneous new lines in some man pagesPádraig Brady-1/+1
* local.mk: Add the --loose-indent option, which results in help2man avoiding extraneous new lines in expr.1, id.1, numfmt.1, shred.1, tail.1, and timeout.1. Fixes https://bugs.gnu.org/74107
2025-02-05doc: sync help2man to latest versionPádraig Brady-16/+44
* man/help2man: sync changes to commit 8fe02612 The main change here is to Use \f(CR for monospace text when using groff in troff mode. Previously \f(CW was used, but that's not portable.
2025-01-01maint: update all copyright year number rangesPádraig Brady-10/+10
Update to latest gnulib with new copyright year. Run "make update-copyright" and then... * gnulib: Update included in this commit as copyright years are the only change from the previous gnulib commit. * tests/init.sh: Sync with gnulib to pick up copyright year. * bootstrap: Likewise. * tests/sample-test: Adjust to use the single most recent year.
2024-12-11maint: sync help2man to latest versionPaul Eggert-15/+15
* man/help2man: sync changes from version 1.48.5 through 1.49.3. This doesn't materially change the generated man pages.
2024-09-23doc: env: simplify extra info in the man pagePádraig Brady-18/+3
* man/env.x: Avoid confusion in the [OPTIONS] section by renaming to [SCRIPT OPTION HANDLING], and removing info regarding default signal handling, which is best restricted to the full info manual. Addresses https://bugs.gnu.org/72914
2024-07-22build: support creating reproducible tarball contentsPádraig Brady-1/+2
We already support reproducible builds since commit v8.24-99-gc1b3d6587, and this adjusts that change to also support reproducible tarball contents with subsequent runs of `make dist`. * Makefile.am: Don't create a varying .timestamp file, instead ... * man/local.mk: Rely on the timestamp of the .tarball-version file. Fixes https://bugs.gnu.org/72232
2024-03-19chmod: add support for -h, -H,-L,-P, --dereference optionsPádraig Brady-4/+6
There have been various requests to add -h to avoid following symlinks for security reasons. This wasn't provided previously as chmod(1) already ignored symlinks unless specified on the command line. Note chmod defaults to -H mode rather than the chown default of -P, as usually chown can work directly on symlinks and so defaults to not traversing those specified on the command line. Note FreeBSD chmod does default to -P mode, but we retain the -H mode default also for compatibility with existing chmod behavior. Adding -HLP will allow chmod to disable traversing CLI symlinks to dirs. Adding -h will allow to disable following CLI symlinks to files/dirs, also operating on all symlinks on systems that support that. Adding --dereference will be significant with -H (the default). I.e. symlinks to dirs not recursed, but symlinks are dereferenced. Adding these options will also be consistent with chown(1), chgrp(1), and chmod(1) on other systems. Note since chmod(1) currently ignores symlinks by default, and -h is primarily a mechanism to avoid following symlinks, rather than for operating on the symlink itself, we make -h try to chmod a symlink, but ignore ENOTSUP. In that way we're consistent with chown(1) where it also ignores ENOTSUP for symlinks, and we don't fail when trying to be extra secure with command line params. * doc/coreutils.texi (chmod invocation): Reference the -H,-L,-P descriptions, and adjust the corresponding macros to say the default is -H or -P as appropriate. Add --dereference and -h,--no-dereference descriptions. * man/chmod.x: Adjust discussion of symlink handling. * src/chmod.c (main): Accept new options and set fts flags appropriately. (process_file): Process / dereference symlinks as necessary. * src/system.h (emit_symlink_recurse_options): A new function refactored from chown.c and chmod.c usage(). * tests/chmod/symlinks.sh: New test for the new options. * tests/local.mk: Reference the new test. * NEWS: Mention the new feature.
2024-02-25doc: de-“note” the documentationPaul Eggert-3/+2
* doc/coreutils.texi, man/readlink.x, man/runcon.x: * src/comm.c (usage): * src/digest.c (usage): * src/echo.c (usage): * src/join.c (usage): * src/ln.c (usage): * src/rm.c (usage): * src/stat.c (usage): * src/system.h (USAGE_BUILTIN_WARNING): * src/test.c (usage): * src/touch.c (usage): * src/uniq.c (usage): Rewrite to avoid most uses of “Note that” and similar wording. These circumlocutions are rarely needed, and avoiding them improves readability and lessens preaching.
2024-01-01maint: update all copyright year number rangesPádraig Brady-10/+10
Update to latest gnulib with new copyright year. Run "make update-copyright" and then... * gnulib: Update included in this commit as copyright years are the only change from the previous gnulib commit. * tests/init.sh: Sync with gnulib to pick up copyright year. * bootstrap: Manually update copyright year, until we fully sync with gnulib at a later stage. * tests/sample-test: Adjust to use the single most recent year.
2023-08-28maint: spelling fixes, including author namesPaul Eggert-2/+2
Most of this just affects commentary and documentations. The only significant behavior change is translating author names via proper_name_lite rather than proper_name_utf8, or not translating them at all. proper_name_lite is good enough for coreutils and avoids the bloat that had coreutils not using Gnulib proper_name. * bootstrap.conf (gnulib_modules): Use propername-lite instead of propername. (XGETTEXT_OPTIONS): Look for proper_name_lite instead of for proper_name_utf8. * cfg.mk (local-checks-to-skip): Remove sc_proper_name_utf8_requires_ICONV, since we no longer use proper_name_utf8. (old_NEWS_hash): Update. (sc_check-I18N-AUTHORS): Remove; no longer needed.
2023-08-15doc: reference install(1) and cp(1) from each otherBernhard Voelker-0/+4
* man/cp.x (SEE ALSO): Add install(1). * man/install.x (SEE ALSO): Add cp(1). Discussed at https://lists.gnu.org/r/coreutils/2023-08/msg00026.html
2023-01-01maint: update all copyright year number rangesPádraig Brady-10/+10
Update to latest gnulib with new copyright year. Run "make update-copyright" and then... * tests/init.sh: Sync with gnulib to pick up copyright year. * bootstrap: Manually update copyright year, until we fully sync with gnulib at a later stage. * tests/sample-test: Adjust to use the single most recent year.
2022-10-26doc: basenc: reference from base{32,64} docsPádraig Brady-0/+4
* doc/coreutils.texi (base32 invocation): Reference basenc to improve discoverability. (base64 invocation): Likewise. * man/base32.x: Likewise. * man/base64.x: Likewise.
2022-07-30doc: reference fmt(1) from fold(1)Pádraig Brady-0/+2
* man/fold.x: fold and fmt have overlapping functionality, so reference fmt(1) from the lower level fold(1) utility.
2022-03-12doc: test: clarify that -rwx don't just check perm bitsPádraig Brady-0/+7
* src/test.c (usage): State that -rwx is determined by user access, rather than permission bits. * doc/coreutils.texi (Access permission tests): Likewise. * man/test.x [SEE ALSO]: access(2). Fixes https://bugs.gnu.org/54338
2022-02-15doc: env: fix man page reference of exec(2) to exec(3p)Pádraig Brady-1/+1
* man/env.x: Change exec() reference from section 2 to 3p.
2022-02-15doc: use bold style for man page referencesPádraig Brady-2/+14
It's more common to use bold style than not, for references to other man pages. Ideally each man page renderer would highlight references, but currently some rely on styles in the page itself. * man/help2man: Implement a --bold-refs option that will mark up references like "name(1)" with bold style around the "name" component. * man/local.mk: Pass --bold-refs to our help2man unless disabled. * configure.ac: Add a --disable-bold-man-page-references option. Addresses https://bugs.gnu.org/53977
2022-02-14tr: mention multibyte problem in man pagePaul Eggert-0/+9
* man/tr.x: Document tr problem.
2022-02-12doc: ls: reference dircolors(1) from --helpPádraig Brady-0/+2
* src/ls.c (usage): s/dircolors/dircolors(1)/. * man/ls.x [SEE ALSO]: Reference dircolors(1). Addresses https://bugs.gnu.org/53946
2022-01-02maint: update all copyright year number rangesPádraig Brady-9/+9
Run "make update-copyright" and then... * gnulib: Update to latest with copyright year adjusted. * tests/init.sh: Sync with gnulib to pick up copyright year. * bootstrap: Likewise. * tests/sample-test: Adjust to use the single most recent year.
2021-10-22doc: say that printf(1) is preferred over echo(1)Pádraig Brady-0/+2
* src/echo.c (usage): Say printf(1) is preferred due to being more standard and robust. * man/echo.x [SEE ALSO]: Reference printf(1). * doc/coreutils.texi (echo invocation): Mention in the summary that echo is not robust when outputting any string, and that printf is preferred. Also expand on the examples showing how to output a single '-n' string. Addresses https://bugs.gnu.org/51311
2021-09-16maint: sync help2man to latest versionPádraig Brady-6/+7
* man/help2man: sync to changes from version 1.48.5. Note this doesn't materially change the generated man pages.
2021-09-15cksum: add --algorithm option to select digest modePádraig Brady-1/+15
* src/digest.c: Organize HASH_ALGO_CKSUM to be table driven, and amalgamate all digest algorithms. (main): Parse all options if HASH_ALGO_CKSUM, and disallow --tag, --zero, and --check with the traditional bsd, sysv, and crc checksums for now. * src/local.mk: Reorganize to include all digest modules in cksum. * tests/misc/cksum-a.sh: Add a new test. * tests/misc/b2sum.sh: Update to default to checking with cksum, as b2sum's implementation diverges a bit from the others. * tests/local.mk: Reference the new test. * doc/coreutils.texi (cksum invocation): Adjust the summary to identify the new mode, and document the new --algorithm option. * man/cksum.x: Adjust description to be more general. * man/*sum.x: Add [See Also] section referencing cksum(1). * NEWS: Mention the new feature.
2021-09-15doc: fix ambiguities in logname(1) and whoami(1)Pádraig Brady-1/+3
* doc/coreutils.texi (whoami invocation): Clarify it prints names, not numeric IDs. * man/whoami.x: Likewise. * man/logname.x: Reference getlogin(3). * src/logname.c: Clarify that it prints the login name, rather than the name of the effective user ID. Fixes https://bugs.gnu.org/48894
2021-07-28doc: modernize usage of “disk” and “core”Paul Eggert-5/+5
In documentation and comments, don’t assume that secondary storage devices are disk devices. Similarly, don’t assume that main memory uses magnetic cores, which became obsolete in the 1970s. * src/du.c (usage): * src/ls.c (usage): * src/shred.c (usage): Reword to avoid “disk” in usage messages.
2021-01-03doc: make formatting of SEE ALSO in cat.1 and tac.1 consistentBernhard Voelker-2/+2
None of the coreutils man pages - but the two above - are using bold setting for the references to other man pages in the SEE ALSO section. * man/cat.x (SEE ALSO): Remove '\fB...\fP' setting. * man/tac.x: Likewise, and add a reference to cat(1).
2021-01-01maint: update all copyright year number rangesPádraig Brady-9/+9
Run "make update-copyright" and then... * gnulib: Update to latest with copyright year adjusted. * tests/init.sh: Sync with gnulib to pick up copyright year. * bootstrap: Likewise. * tests/sample-test: Adjust to use the single most recent year.
2020-10-25maint: sync help2man to latest versionPádraig Brady-11/+14
* man/help2man: sync to changes from version 1.47.16. Note this doesn't materially change the generated man pages. Addresses https://bugs.gnu.org/44105
2020-06-23chmod: man page fixesPaul Eggert-4/+6
* man/chmod.x: Mention -6000 too. Use .BR to fix trailing period.
generated by cgit v1.2.3 (git 2.46.0) at 2026-03-17 06:30:43 +0000