aboutsummaryrefslogtreecommitdiffstats
path: root/man (follow)
AgeCommit message (Collapse)AuthorFilesLines
2025-10-02doc: man: consistently format -X[OPTIONAL] formPádraig Brady1-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 Brady1-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 Eggert1-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 Brady1-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 Brady1-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 Brady10-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 Eggert1-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 Brady1-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 Brady1-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 Brady1-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 Eggert2-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 Brady10-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 Eggert2-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 Voelker2-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 Brady10-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 Brady2-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 Brady1-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 Brady1-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 Brady1-1/+1
* man/env.x: Change exec() reference from section 2 to 3p.
2022-02-15doc: use bold style for man page referencesPádraig Brady2-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 Eggert1-0/+9
* man/tr.x: Document tr problem.
2022-02-12doc: ls: reference dircolors(1) from --helpPádraig Brady1-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 Brady9-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 Brady1-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 Brady1-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 Brady8-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 Brady2-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 Eggert1-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 Voelker2-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 Brady9-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 Brady1-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 Eggert1-4/+6
* man/chmod.x: Mention -6000 too. Use .BR to fix trailing period.
2020-06-21doc: fix punctuation in man pagesPádraig Brady1-1/+1
* man/chmod.x: Add missing punctuation. * src/expand-common.c: Likewise. * src/numfmt.c: Likewise. * src/rm.c: Likewise. Fixes https://bugs.gnu.org/41962
2020-01-01maint: update all copyright year number rangesPádraig Brady9-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.
2019-06-10stat: Use statx where available and support --cachedJeff Layton1-1/+1
* src/stat.c: Drop statbuf argument from out_epoch_sec(). Use statx() rather than [lf]stat() where available, so a separate call is not required to get birth time. Set STATX_* mask bits only for things we want to print, which can be more efficient on some file systems. Add a new --cache= command-line option that sets the appropriate hint flags in the statx call. These are primarily used with network file systems to indicate what level of cache coherency is desired. The new option is available unconditionally for better portability, and ignored where not implemented. * doc/coreutils.texi: Add documention for --cached. * man/stat.x (SEE ALSO): Mention statx(). * NEWS: Mention the new feature.
2019-03-04build: revert recent change with distributed man page handlingPádraig Brady1-9/+2
* man/local.mk: commit f114495e added an extra check to ensure a binary was working before using it to generate the man page. However this was not working for the false(1) command, and also one can generally specify that one should not be using generated commands on the current system by passing 'cross_compiling=yes' to the configure invocation.
2019-03-04env: new options --{default,ignore,block}-signal[=SIG]Assaf Gordon1-0/+28
New options to set signal handlers for the command being executed. --block-signal suggested by Paul Eggert in http://bugs.gnu.org/34488#71 --default-signal is useful to overcome the POSIX limitation that shell must not override inherited signal state, e.g. the second 'trap' here is a no-op: trap '' PIPE && sh -c 'trap - PIPE ; seq inf | head -n1' Instead use: trap '' PIPE && sh -c 'env --default-signal=PIPE seq inf | head -n1' Similarly, the following will prevent CTRL-C from terminating the program: env --ignore-signal=INT seq inf > /dev/null See https://bugs.gnu.org/34488#8 * NEWS: Mention new options. * doc/coreutils.texi (env invocation): Document new options. * man/env.x: Add example of --default-signal=SIG usage. (SEE ALSO): Mention sigprocmask. * src/env.c (signals): New global variable. (longopts): Add new options. (usage): Print new options. (parse_signal_params): Parse comma-separated list of signals, store in signals variable. (reset_signal_handlers): Set each signal to SIG_DFL/SIG_IGN. (parse_block_signal_params): Parse command-line options. (set_signal_proc_mask): Call sigprocmask to block/unblock signals. (main): Process new options. * src/local.mk (src_env_SOURCES): Add operand2sig.c. * tests/misc/env-signal-handler.sh: New test. * tests/local.mk (all_tests): Add new test.
2019-01-16build: use distributed man pages when running with --help failsBernhard Voelker1-2/+9
When building against an incompatible GLIBC version compared to that on the build host, then running the just-built binary might fail although it is the same platform - thus CROSS_COMPILING is false. As a result, generating the man pages fails. * man/local.mk (.x.1): Add a check to verify that running the utility with --help succeeds, otherwise falling back to using 'dummy-man'.
2019-01-01maint: update all copyright year number rangesAssaf Gordon9-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.
2018-12-27basenc: A new program complementary to base64/base32Assaf Gordon3-0/+40
Encodes/decodes data in various common formats: base64,base64url,base32,base32,base16,base2,z85. Discussed here: https://lists.gnu.org/r/coreutils/2018-11/msg00014.html https://lists.gnu.org/r/coreutils/2018-12/msg00019.html * AUTHORS: Add basenc. * README: Reference the new program. * NEWS: Mention the new program. * build-aux/gen-lists-of-programs.sh: Add basenc. * doc/coreutils.texi: (basenc invocation): Document the new command. * man/.gitignore: Ignore the generated man page. * man/basenc.x: A new template, with few examples. * man/local.mk: Reference the new man page. * scripts/git-hooks/commit-msg: Allow basenc as program prefix. * src/.gitignore: Ignore the new binary. * src/basenc.c: (usage): Mention new options. (main): Handle new options. (isbase*, base*_length, base*_encode, base*_decode_ctx): Implement new encoding/decoding formats. * src/local.mk: Add new program. * tests/local.mk: Add new test. * tests/misc/basenc.pl: New tests. * tests/misc/help-version.sh (basenc_setup): use '--version' for default invocation (basenc errors with no parameters).
2018-10-02doc: fix minor mistakes in "env.x"Bjarni Ingi Gislason1-2/+2
* man/env.x (OPTIONS): Fix a spelling mistake. Protect a period at the beginning of a line.
2018-06-20env: add -S/--split-string optionAssaf Gordon1-0/+35
Adopted from FreeBSD's env(1), useful for specifing multiple parameters on a shebang (#!) script line, e.g: #!/usr/bin/env -S perl -w -T Discussed in https://lists.gnu.org/r/coreutils/2018-04/msg00011.html * src/env.c (valid_escape_sequence,escape_char,scan_varname, extract_varname,validate_split_str,build_argv, parse_split_string): New functions. (main): Process new option and call parse_split_string. (usage): Mention new option. * tests/misc/env-S.pl: Test new option from the command line. * tests/misc/env-S-script.sh: Test new option from shebang scripts. * tests/local.mk (all_tests): Add new tests. * man/env.x (OPTIONS): Show a brief example of -S usage and point to the full documentation for more information. * doc/coreutils.texi (env invocation): Detail usage of -S/--split-string option. * NEWS: Mention new option.
2018-06-14doc: port test.1 to doclifterPaul Eggert1-5/+5
* man/test.x: Use \& instead of quoting (Bug#31803).
2018-06-13doc: port man pages to doclifterPaul Eggert1-0/+15
Problem reported by Eric S. Raymond (Bug#31803). * man/test.x: Add SYNOPSIS section, since help2man understandably gets confused by the square brackets. * src/ln.c (usage): Omit parenthetical "(Nth form)" in usage, as it confuses doclifter.
2018-05-25doc: formatting fixes in "du.x" and "rm.x"Bjarni Ingi Gislason2-8/+8
Avoid warnings from: groff -b -e -mandoc -T utf8 -rF0 -t -w w -z * man/du.x: Change ".BR" to ".B" if there is only one argument. Protect an end-of-sentence indicator (.?!) with '\&' if it does not mean an end of a sentence. Change '--' to '\-\-' if it indicates an option. * man/rm.x: Change '\=' to '='.
2018-01-01maint: update all copyright year number rangesPádraig Brady7-7/+7
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.
2017-12-09doc: clarify numeric setuid handling in chmod man pagePádraig Brady1-3/+8
* man/chmod.x: Update the information to state one can clear the setuid and setgid bits for directories numerically using an additional leading '0' or a leading '='. That has been supported since v8.15-64-g8931cdb. Fixes https://bugs.gnu.org/29390
2017-10-25doc: reference statfs(2) in the stat(1) man pageVincent Lefevre1-1/+1
* man/stat.x (SEE ALSO): Mention statfs(2) in addition to stat(2). Note statfs() is generally used rather than statvfs(), so we'll defer that reference to the SEE ALSO section of statfs(2). Fixes https://bugs.gnu.org/28989
2017-10-01build: reinstate distribution of man pagesPádraig Brady3-17/+24
man pages change little between systems, so falling back to distributed pages make sense when cross compiling or lacking perl. * man/local.mk: Add all man pages to EXTRA_DIST so that they're distributed in the generated tarball. Use the dummy-man page generator if cross compiling. Set TZ to avoid a distcheck failure where man pages used a diffent month than those rebuilt (with a .timestamp). * man/dummy-man: Only fall back to generating a stub if copying an existing man page fails. * man/help2man: Sync portable TZ=UTC0 specification from upstream help2man. * NEWS: Mention the build-related change. Fixes https://bugs.gnu.org/28574
2017-09-19all: prefer HTTPS in URLsPaul Eggert8-9/+9
generated by cgit v1.2.3 (git 2.39.1) at 2026-01-08 21:33:01 +0000