summaryrefslogtreecommitdiff
path: root/man
AgeCommit message (Collapse)Author
2012-01-27maint: use single copyright year rangeJim Meyering
Run "make update-copyright".
2012-01-22maint: quote 'like this' or "like this", not `like this'Paul Eggert
* doc/coreutils.texi (Formatting the file names): coreutils now quotes 'like this'. * man/help2man: * src/timeout.c (usage): Quote 'like this' in diagnostics. * HACKING, Makefile.am, NEWS, README, README-hacking, TODO, cfg.mk: * doc/Makefile.am, doc/coreutils.texi, m4/jm-macros.m4: * man/Makefile.am, man/help2man, src/Makefile.am, src/copy.h: * src/extract-magic, src/ls.c, src/pinky.c, src/pr.c, src/sort.c: * src/split.c, src/timeout.c, src/who.c, tests/dd/skip-seek-past-file: * tests/pr/pr-tests: Quote 'like this' in commentary. * cfg.mk (old_NEWS_hash): Update due to changed old NEWS.
2012-01-05tests: avoid a false positive due to overflow on Linux/HPPAPádraig Brady
* tests/misc/timeout-parameters: Verify that the timer doesn't fire immediately in the problematic range, and avoid overflow checks in that case. * man/timeout.x: Mention the possible bug. Reported by Bruno Haible
2012-01-03realpath: a new program to print the resolved pathPádraig Brady
This program is compatible with other realpath(1) implementations, and also incorporates relpath like support, through the --relative options. The relpath support was suggested by Peng Yu, who also provided an initial implemenation of that functionality. * AUTHORS: Add my name. * NEWS: Mention the new command. * README: Likewise. * doc/coreutils.texi (realpath invocation): Add realpath info. * man/Makefile.am (realpath.1): Add dependency. * man/realpath.x: New template. * man/.gitignore: Ignore generated man page. * po/POTFILES.in: Add src/realpath.c. * src/.gitignore: Exclude realpath. * src/Makefile.am (EXTRA_PROGRAMS): Add realpath. * src/realpath.c: New file. * scripts/git-hooks/commit-msg: Add realpath to the list of prefixes. * tests/Makefile.am (TESTS): Add misc/realpath. * tests/misc/realpath: New file.
2012-01-01maint: update all copyright year number rangesJim Meyering
Run "make update-copyright".
2011-10-20build: include man-pages for non-default progsMike Frysinger
At the moment, things like man/arch.1 are not included in the tarball. This makes perl a requirement if you want to build/install the arch helper. * man/Makefile.am (EXTRA_DIST): Add $(NO_INSTALL_PROGS_DEFAULT:%=%.1).
2011-07-08doc: don't terminate SEE ALSO sections with a periodBenoît Knecht
man-pages(7) explicitly says about SEE ALSO sections: "Do not terminate this with a period." This is also in line with all the other man pages in coreutils. * man/cat.x: Remove period at the end of the SEE ALSO section. * man/tac.x: Likewise.
2011-01-01maint: update all copyright year number rangesJim Meyering
Run "make update-copyright".
2010-12-28coreutils: keep lines within 80-column limitsPaul Eggert
* cfg.mk (LINE_LEN_MAX, FILTER_LONG_LINES): New macros. (sc_long_lines): New rule. * HACKING: Use shorter URLs to the same material. * doc/Makefile.am, doc/coreutils.texi, m4/boottime.m4: * man/help2man, man/stdbuf.x, src/Makefile.am, src/cat.c, src/copy.c: * src/cp.c, src/dd.c, src/df.c, src/du.c, src/groups.c, src/install.c: * src/ls.c, src/md5sum.c, src/mv.c, src/od.c, src/pinky.c, src/ptx.c: * src/readlink.c, src/remove.c, src/rmdir.c, src/setuidgid.c: * src/sort.c, src/tail.c, src/touch.c, tests/Coreutils.pm: * tests/cp/existing-perm-race, tests/cp/perm, tests/cp/preserve-gid: * tests/du/2g, tests/du/long-from-unreadable, tests/init.sh: * tests/install/basic-1, tests/ls/nameless-uid: * tests/ls/readdir-mountpoint-inode, tests/misc/chroot-credentials: * tests/misc/cut, tests/misc/date, tests/misc/join, tests/misc/md5sum: * tests/misc/sha1sum, tests/misc/sha224sum, tests/misc/sort: * tests/misc/sort-continue, tests/misc/sort-files0-from: * tests/misc/sort-rand, tests/misc/stdbuf, tests/misc/tr: * tests/misc/uniq, tests/mv/atomic, tests/mv/part-fail: * tests/mv/part-symlink, tests/mv/sticky-to-xpart, tests/pr/pr-tests: * tests/rm/fail-2eperm, tests/rm/interactive-always: Reformat to fit within 80 columns. * doc/Makefile.am (BAD_POSIX_PERL): New macro. * doc/coreutils.texi: Reword slightly, to make menus and index lines shorter. * src/md5sum.c: Redo --help output so that it fits within 79 columns, since that's a bit more portable and all the other --help strings fit in 79 columns.
2010-10-20doc: add a cross reference from cat's man page to "tac"Rodrigo Campos
* man/cat.x: See also "tac".
2010-08-15doc: improve the info on md5sum security weaknessesBruno Haible
* doc/coreutils.texi (md5sum invocation): Mention currently known security problems. Don't recommend SHA-1 as alternative. * man/md5sum.x (BUGS): Warn about the vulnerabilities and reference the SHA-2 based alternatives. Reported by Simon Josefsson
2010-02-16maint: fix the man page correlation testsPádraig Brady
These checks were not being run as distcheck-hook targets are only supported in the top-level Makefile. Instead these tests are now run during a syntax-check. * cfg.mk (sc_man_file_correlation): A new syntax check to call the 2 existing tests to check the correlation between the programs and man/*.[1x]. * man/Makefile.am (sc_man_file_correlation): Call the 2 existing man page correlation tests. (check-x-vs-1): Remove the "GEN" annotation as it's a bit verbose. (check-programs-vs-x): Likewise. * src/Makefile.am (all_programs.list): Exclude libstdbuf.so from the list of programs. This issue was not noticed as the checks were not actually being run.
2010-02-15doc: fix inconsistent capitalization in --help outputPádraig Brady
* src/base64.c (usage): Don't capitalize the first character in an --option description. * src/stdbuf.c (usage): Likewise. * src/truncate.c (usage): Likewise. * cfg.mk (sc_option_desc_uppercase): A new syntax check to stop this happening in future. * man/Makefile.am (sc_option_desc_uppercase): Ensure all man pages are generated, then search for erroneous uppercase chars. * src/Makefile.am (all_programs): Ensure all commands are built so that all man pages can be generated.
2010-02-15dirname: improve man page descriptionEric Blake
* doc/coreutils.texi (dirname invocation): Properly cover behavior on directory. * man/dirname.x: Likewise. * THANKS: Update. Reported by Emmanuel Lacour.
2010-02-07doc: add a cross reference from tac's man page to "rev"James R. Van Zandt
* man/tac.x: See also "rev".
2010-01-01maint: update all FSF copyright year lists to include 2010Jim Meyering
Use this command: git ls-files | grep -v COPYING \ | xargs env UPDATE_COPYRIGHT_USE_INTERVALS=1 \ build-aux/update-copyright
2009-11-06nproc: A new program to count the available processorsGiuseppe Scrivano
* AUTHORS: Add my name. * NEWS: Mention it. * README: Likewise. * bootstrap.conf (gnulib_modules): Add nproc. * doc/coreutils.texi (nproc invocation): Add nproc info. * man/Makefile.am (nproc.1): Add dependency. * man/nproc.x: New template. * man/.gitignore: Ignore generated man page. * po/POTFILES.in: Add src/nproc.c. * src/.gitignore: Exclude nproc. * src/Makefile.am (EXTRA_PROGRAMS): Add nproc. * src/nproc.c: New file. * tests/Makefile.am (TESTS): Add misc/nproc-{avail,positive}. * tests/misc/nproc-avail: New file. * tests/misc/nproc-positive: New file.
2009-09-21doc: mention the texinfo documentation in --helpPádraig Brady
* src/system.h: Rename emit_bug_reporting_address() to emit_ancillary_info() and update it to not print the translation project address in en_* locales, and _do_ print it in the 'C' (and other) locales so that it's included in the default man page. Also mention how to invoke the texinfo documentation for each command. Also move the "hard-locale.h" include to the 8 files that now use it. * man/help2man: Strip the newly added texinfo reference from the --help output as a more verbose version is already added by help2man. Suggestion from C de-Avillez
2009-07-26build: use a fixed-name temporary in man/Makefile.amJim Meyering
* man/Makefile.am (check-x-vs-1): Using a fixed-name temporary file is better than one ending in -$$, because many -$$-suffixed files may accumulate over time.
2009-07-24readlink: improve one-line summary: prints canonical file names, tooJim Meyering
* src/readlink.c (usage): Adjust one-line summary. * man/readlink.x: Likewise. Suggested by Kamil Dudka.
2009-06-23maint: update all Copyright year lists to include 2009Jim Meyering
2009-06-17stdbuf: A new program to run a command with modified stdio bufferingPádraig Brady
* AUTHORS: Register as the author. * NEWS: Mention this change. * README: Add stdbuf command to list. * configure.ac: Only enable on ELF systems with GCC. * cfg.mk (sc_system_h_headers): Use VC_LIST_EXCEPT rather than VC_LIST, so we can add an exception, if needed. * .x-sc_system_h_headers: New file. Exempt libstdbuf.c. * Makefile.am (syntax_check_exceptions): Add .x-sc_system_h_headers. * doc/coreutils.texi (stdbuf invocation): Add stdbuf info. * man/.gitignore: Ignore generated manpage. * src/.gitignore: Ignore stdbuf and libstdbuf.so binaries. * man/Makefile.am (stdbuf.1): Add dependency. * man/stdbuf.x: New file with example usage. * po/POTFILES.in: Reference new command and shared library sources. * src/Makefile.am (build_if_possible__progs): Add stdbuf and libstdbuf, (pkglib_PROGRAMS): Reference optional shared lib, (libstdbuf_so_LDADD): Ensure we don't link with non PIC libcoreutils.a. (libstdbuf_so_LDFLAGS): Add -shared GCC option, (libstdbuf_so_CFLAGS): Add -fPIC GCC option. (check-README): Exclude libstbuf. (check-AUTHORS): ditto. (sc_tight_scope): Exclude functions starting with __. * src/libstdbuf.c: The LD_PRELOAD shared library to control buffering. * src/stdbuf.c: New file to setup env variables before execing command. * tests/Makefile.am: Reference new test file. * tests/misc/help-version: Set expected exit codes. * tests/misc/invalid-opt: ditto. * tests/misc/stdbuf: Add 9 tests.
2009-06-02build: make generated man/*.1 files read-onlyJim Meyering
This should help people notice that they are generated. Note: each file already has a comment to that effect from help2man. * man/Makefile.am (.x.1): Make generated files read-only. Also, don't redirect directly to the target, $@.
2009-06-02build (man/): use automake's new $(AM_V_GEN) variableJim Meyering
* man/Makefile.am (.x.1, check-x-vs-1, check-programs-vs-x): Mark with $(AM_V_GEN), so that automake-1.11 prints "GEN $@" by default (stick with "GEN" in spite of the latter two rules not officially generating anything -- they're just tests).
2009-05-18doc: clarify the operation of the comm -123 parametersPádraig Brady
* src/comm.c (usage): give more information on the -123 parameters, with examples to show that they can be combined. Addresses <http://savannah.gnu.org/bugs/?24974>. * doc/coreutils.texi (comm invocation): Mention that the column separators are suppressed along with the column. Suggestion from Dan Jacobson. * man/comm.x: Reference other commands that match adjacent lines. * man/join.x: ditto. * man/uniq.x: ditto.
2009-03-18maint: normalize leading-TAB indentation in MakefilesJim Meyering
* maint.mk (sc_makefile_TAB_only_indentation): New rule. Replace each TAB+8-space sequence with two TABs. * man/Makefile.am: Likewise. * build-aux/check.mk: Likewise. I used this command (run it more than once, if needed): t=$'\t'; git grep -l -E "$t {8}"|grep -E 'Makefile|\.mk$' \ | xargs perl -pi -e 's/\t {8}/\t\t/'
2009-02-22truncate: fix typo in man pageTobias Stoeckmann
* man/truncate.x: Fix spelling. * THANKS: Update.
2009-02-15doc: id: make --help and .man more descriptiveJim Meyering
* src/id.c (usage): Improve description, based on a suggestion from Brian M. Carlson in http://bugs.debian.org/514675 * man/id.x: Use a better one-liner, based on the one at top of id.c.
2009-02-02doc: preserve --help line breaks in 'REPORTING BUGS' man page sectionJim Meyering
* man/help2man: Insert .br between adjacent lines.
2009-01-27doc: ensure that emit_bug_reporting_address changes propagate to *.1Jim Meyering
* man/Makefile.am ($(MAN)): Depend on system.h.
2009-01-27doc: restore "REPORTING BUGS" section to generated man pagesJim Meyering
* man/help2man ($PAT_BUGS): Update regexp to match the newer "Report PROG bugs ..." --help output, as well as "Report bugs...". Reported by Eric Blake.
2008-12-17doc: Remove curly quotes from shell examples in man pagesPádraig Brady
Use \(aq rather than a literal ' as groff will convert apostrophe to a right quote (\u2029) in utf8 locales for example. Stepan Kasal details the issue and fix here: http://lists.gnu.org/archive/html/bug-coreutils/2008-12/msg00124.html
2008-09-14various VPATH-related fixesRalf Wildenhues
* maint.mk (VC_LIST): Prepend '$(srcdir)/'. (patch-check): Fix to make it work with a VPATH build. * src/Makefile.am (sc_tight_scope): Likewise. * man/Makefile.am (.x.1): Do not make outputs unwritable.
2008-06-06Add new program: truncatePádraig Brady
* AUTHORS: Register as the author * NEWS: Mention this change * README: Add truncate command to list * src/truncate.c: New command * src/Makefile.am: Add truncate command to list to build * src/.gitignore: Add truncate binary to list to ignore * doc/coreutils.texi (truncate invocation): Add truncate info * man/Makefile.am: Add truncate man page to list to build * man/truncate.x: Add truncate man page template * po/POTFILES.in: Add truncate to list to translate * tests/Makefile.am: Add truncate tests * tests/misc/help-version: Add support for new truncate command * tests/misc/truncate-dangling-symlink: check dangling link ok * tests/misc/truncate-dir-fail: ensure dirs fail * tests/misc/truncate-fail-diag: validate messages for missing paths * tests/misc/truncate-fifo: ensure fifos ignored * tests/misc/truncate-no-create-missing: ensure -c option honoured * tests/misc/truncate-overflow: check signed integer overflows * tests/misc/truncate-owned-by-other: root permissions check * tests/misc/truncate-parameters: check invalid parameter combinations * tests/misc/truncate-relative: check invalid relative sizes
2008-06-02new program: timeoutPádraig Brady
* AUTHORS: Register as the author. * NEWS: Mention this change. * README: Add timeout command to list. * src/timeout.c: New file. * src/kill.c (operand2sig): Move function to its own file, now that timeout.c will also use it. * src/operand2sig.c (operand2sig): New file, extracted from kill.c. * src/operand2sig.h (operand2sig): Declare. * src/Makefile.am (EXTRA_PROGRAMS): Add timeout. * src/.gitignore: Add timeout binary to list to ignore. * doc/coreutils.texi (timeout invocation): Add timeout info. (Signal specifications): New section, also referenced by kill. * man/Makefile.am (timeout.1): Add dependency. * man/timeout.x: New file. * po/POTFILES.in: Add timeout.c and operand2sig.c to list to translate. * tests/Makefile.am (TESTS): Add the two new tests. * tests/misc/help-version: Add support for new timeout command. * tests/misc/invalid-opt: Add support for new timeout command. * tests/misc/timeout: New file: check basic timeout operation. * tests/misc/timeout-parameters: New file: check invalid parameter combinations.
2008-05-06fix typo in comments: s/ouput/output/Jim Meyering
adjust spelling in that same comment: s/localisation/localization/
2008-05-06help2man: fix perl 5.10 problem properlyJim Meyering
* man/help2man: Do pull LC_ALL via "use POSIX". Instead, limit the importing of gettext-related symbols to just those two we'll use: gettext and textdomain.
2008-05-05help2man: avoid failure with Debian unstable's Perl 5.10.0Jim Meyering
Avoid failure that produced this diagnostic: Constant subroutine main::LC_ALL redefined at /.../Exporter.pm * man/help2man: Don't include LC_ALL in the "use POSIX" list, since Locale::gettext->import will get it.
2008-04-01printf doc: xref print(3) and libc's "Output Conversion Syntax" nodeJim Meyering
* coreutils.texi (printf invocation): Add xref. Use "The GNU C Library Reference Manual" as the name of the 'libc' document consistently. * man/printf.x: Add See also: printf(3). Suggested by A. Costa in http://bugs.debian.org/465522
2008-03-20Remove today's automake kludge, altogether. Fix properly.Jim Meyering
* man/Makefile.am: Use dist_man1_MANS instead of dist_man_MANS. Suggestion from Ralf Wildenhues.
2008-03-20Kludge to make automake generate install-man rulesJim Meyering
* man/Makefile.am (dist_man_MANS): Add a literal, rm.1. Without this, "make install" would not install man pages. However, with this kludge, the rm.1 man page is installed even when you configure with --enable-no-install-program=rm.
2008-03-20Revert recent man/Makefile.am change.Jim Meyering
Revert 4b544e447eb78fd1f031a026a499f6aed177808a. * man/Makefile.am: That change was only a band-aid. It solved the stated problem, but not a deeper one: that "make install" would no longer man pages. Reported by Dmitry V. Levin. The latter problem arose in 167b8025aca487de001da2448c1aebc2747bc1d3 with the removal of the sole literal from the definition of dist_man_MANS. When automake perceives dist_man_MANS as empty, it no longer emits the install-man* rules.
2008-03-19"make" would not always update man/*.1 files (but "make dist" would)Jim Meyering
* man/Makefile.am (BUILT_SOURCES): Define, so that "make" always updates man/*.1 files. Reported by Bob Proulx.
2008-02-13Replace groups.sh with groups.c.James Youngman
* src/groups.c (main): New file, replacing groups.sh. * src/group-list.c, src/group-list.h: New files, factored out of id.c, implementing the functionality that "id" and "groups" have in common. * src/id.c (print_full_info): Avoid a segfault when trying to print an error message if getgroups fails. (print_group_list): Move to group-list.c. (print_group): Likewise. * man/Makefile.am: When building groups.1, obtain the help text from src/groups.c, not src/groups.sh. (noinst_HEADERS): Add group-list.h. (group): Remove rule. (dist_man_MANS): Remove groups.1. * doc/coreutils.texi (groups: Print group names a user is in): Explain why "groups" and "groups $(id -un)" give different results in existing login sessions after you change the group database. (id: Print user identity): Likewise for "id". * po/POTFILES.in: Add src/group-list.c and src/groups.c. * NEWS: mention this. * AUTHORS: Update.
2008-01-31Improve wording of date and time man page.Bob Proulx
* man/date.x: Improve compact description of the --date=STRING. * man/touch.x: Likewise. Suggested by A. Costa.
2008-01-29Improve the man pages of --date=STRING for 'date' and 'touch'.Bob Proulx
* man/date.x: Add a compact description of the --date=STRING. * man/touch.x: Likewise. Reported by A. Costa in http://bugs.debian.org/363011
2008-01-29Avoid "make distcheck" failure: newly-created man/*.1 files not removedJim Meyering
* Makefile.am (EXTRA_DIST): Add .version. (.version): New rule. (dist-hook): Don't create $(distdir)/.version here, now that it's being distributed. * man/Makefile.am (common_dep): Use ../.version, not ../VERSION. (../VERSION): Remove rule. * GNUmakefile (dummy): Create .version, not VERSION. Add an extra "...:= $(shell..." statement to ensure that .version exists even when the preceding code is not run. * .gitignore: Remove both .version and VERSION. Signed-off-by: Jim Meyering <meyering@redhat.com>
2008-01-26Emit "info coreutils 'PROG invocation'" into the man page,Jim Meyering
rather than just "info PROG". The latter would often fail or simply display the man page. * man/help2man: Change the template. Prompted by http://bugs.debian.org/399684
2008-01-26Ensure that each version string change propagates to man pages.Jim Meyering
* man/Makefile.am (common_dep): Don't depend on configure.ac for version changes. Instead, depend on ../VERSION. (../VERSION): New rule. * Makefile.am (DISTCLEANFILES): Define. * GNUmakefile: Update ./VERSION. * .gitignore: List VERSION. Reported by Sven Joachim.
2007-12-20Avoid spurious "make check" failures due to omitted programs.Jim Meyering
* man/Makefile.am (distcheck-hook): Make check rules dependents of this target, not of check-local, so that people aren't distracted by failures due to programs omitted via --enable-no-install-program=...