README

   1 These are the GNU core utilities.  This package is the union of
   2 the GNU fileutils, sh-utils, and textutils packages.
   3
   4 Most of these programs have significant advantages over their Unix
   5 counterparts, such as greater speed, additional options, and fewer
   6 arbitrary limits.
   7
   8 The programs that can be built with this package are:
   9
  10   [ arch base64 basename cat chcon chgrp chmod chown chroot cksum comm cp
  11   csplit cut date dd df dir dircolors dirname du echo env expand expr
  12   factor false fmt fold groups head hostid hostname id install join kill
  13   link ln logname ls md5sum mkdir mkfifo mknod mktemp mv nice nl nohup
  14   od paste pathchk pinky pr printenv printf ptx pwd readlink rm rmdir
  15   runcon seq sha1sum sha224sum sha256sum sha384sum sha512sum shred shuf
  16   sleep sort split stat stty su sum sync tac tail tee test touch tr true
  17   tsort tty uname unexpand uniq unlink uptime users vdir wc who whoami yes
  18
  19 See the file NEWS for a list of major changes in the current release.
  20
  21 If you obtained this file as part of a "cvs checkout" or "git clone",
  22 then see the README-hacking file.  If this file came to you as part of a
  23 tar archive, then see the file INSTALL for compilation and installation
  24 instructions.
  25
  26 These programs are intended to conform to POSIX (with BSD and other
  27 extensions), like the rest of the GNU system.  By default they conform
  28 to older POSIX (1003.2-1992), and therefore support obsolete usages
  29 like "head -10" and "chown owner.group file".  This default is
  30 overridden at build-time by the value of <unistd.h>'s _POSIX2_VERSION
  31 macro, and this in turn can be overridden at runtime as described in
  32 the documentation under "Standards conformance".
  33
  34 The ls, dir, and vdir commands are all separate executables instead of
  35 one program that checks argv[0] because people often rename these
  36 programs to things like gls, gnuls, l, etc.  Renaming a program
  37 file shouldn't affect how it operates, so that people can get the
  38 behavior they want with whatever name they want.
  39
  40 Special thanks to Paul Eggert, Brian Matthews, Bruce Evans, Karl Berry,
  41 Kaveh Ghazi, and François Pinard for help with debugging and porting
  42 these programs.  Many thanks to all of the people who have taken the
  43 time to submit problem reports and fixes.  All contributed changes are
  44 attributed in the ChangeLog files.
  45
  46 And thanks to the following people who have provided accounts for
  47 portability testing on many different types of systems: Bob Proulx,
  48 Christian Robert, François Pinard, Greg McGary, Harlan Stenn,
  49 Joel N. Weber, Mark D. Roth, Matt Schalit, Nelson H. F. Beebe,
  50 Réjean Payette, Sam Tardieu.
  51
  52 Thanks to Michael Stone for inflicting test releases of this package
  53 on Debian's unstable distribution, and to all the kind folks who used
  54 that distribution and found and reported bugs.
  55
  56 Note that each man page is now automatically generated from a template
  57 and from the corresponding --help usage message.  Patches to the template
  58 files (man/*.x) are welcome.  However, the authoritative documentation
  59 is in texinfo form in the doc directory.
  60
  61 If you run the tests on a SunOS4.1.4 system, expect the ctime-part of
  62 the ls `time-1' test to fail.  I believe that is due to a bug in the
  63 way Sun implemented link(2) and chmod(2).
  64
  65
  66 *****************************************
  67 Test failure with NLS and gettext <= 0.17
  68 -----------------------------------------
  69
  70 Due to a conflict between libintl.h and gnulib's new xprintf module,
  71 when you configure with NLS support, and with a gettext installation
  72 older than 0.17.1 (not yet released, at the time of this writing),
  73 then some tests fail, at least on NetBSD 1.6.  To work around it in
  74 the mean time, you can configure with --disable-nls.  For details,
  75 see <http://thread.gmane.org/gmane.comp.lib.gnulib.bugs/12015/>.
  76
  77
  78 ***********************
  79 Pre-C99 build failure
  80 -----------------------
  81
  82 There is a new, implicit build requirement:
  83 To build the coreutils from source, you should have a C99-conforming
  84 compiler, due to the use of declarations after non-declaration statements
  85 in several files in src/.  There is code in configure to find and, if
  86 possible, enable an appropriate compiler.  However, if configure doesn't
  87 find a C99 compiler, it continues nonetheless, and your build will fail.
  88 If that happens, simply apply the included patch using the following
  89 command, and then run make again:
  90
  91   cd src && patch < c99-to-c89.diff
  92
  93
  94 ***********************
  95 HPUX 11.x build failure
  96 -----------------------
  97
  98 A known problem exists when compiling on HPUX on both hppa and ia64
  99 in 64-bit mode (i.e. +DD64) on HP-UX 11.0, 11.11, and 11.23.  This
 100 is not due to a bug in the package but instead due to a bug in the
 101 system header file which breaks things in 64-bit mode.  The default
 102 compilation mode is 32-bit and the software compiles fine using the
 103 default mode.  To build this software in 64-bit mode you will need
 104 to fix the system /usr/include/inttypes.h header file.  After
 105 correcting that file the software also compiles fine in 64-bit mode.
 106 Here is one possible patch to correct the problem:
 107
 108 --- /usr/include/inttypes.h.orig        Thu May 30 01:00:00 1996
 109 +++ /usr/include/inttypes.h     Sun Mar 23 00:20:36 2003
 110 @@ -489 +489 @@
 111 -#ifndef __STDC_32_MODE__
 112 +#ifndef __LP64__
 113
 114
 115 ************************
 116 OSF/1 4.0d build failure
 117 ------------------------
 118
 119 If you use /usr/bin/make on an OSF/1 4.0d system, it will fail due
 120 to the presence of the "[" target.  That version of make appears to
 121 treat "[" as some syntax relating to locks.  To work around that,
 122 the best solution is to use GNU make.  Otherwise, simply remove
 123 all mention of "[$(EXEEXT)" from src/Makefile.
 124
 125
 126
 127 **********************
 128 Running tests as root:
 129 ----------------------
 130
 131 If you run the tests as root, note that a few of them create files
 132 and/or run programs as a non-root user, `nobody' by default.
 133 If you want to use some other non-root username, specify it via
 134 the NON_ROOT_USERNAME environment variable.  Depending on the
 135 permissions with which the working directories have been created,
 136 using `nobody' may fail, because that user won't have the required
 137 read and write access to the build and test directories.
 138 I find that it is best to unpack and build as a non-privileged
 139 user, and then to run the following command as that user in order
 140 to run the privilege-requiring tests:
 141
 142   sudo env NON_ROOT_USERNAME=$USER make -k check
 143
 144 If you can run the tests as root, please do so and report any
 145 problems.  We get much less test coverage in that mode, and it's
 146 arguably more important that these tools work well when run by
 147 root than when run by less privileged users.
 148
 149
 150 ***************
 151 Reporting bugs:
 152 ---------------
 153
 154 IMPORTANT: if you take the time to report a test failure,
 155 please be sure to include the output of running `make check'
 156 in verbose mode for each failing test.  For example,
 157 if the test that fails is tests/mv/hard-link-1, then you
 158 would run this command:
 159
 160   env VERBOSE=yes make check -C tests/mv TESTS=hard-link-1 >> log 2>&1
 161
 162 For some tests, you can get even more detail by including
 163 DEBUG=yes in the environment:
 164
 165   env DEBUG=yes VERBOSE=yes make check -C tests/mv TESTS=hard-link-1 >> log 2>&1
 166
 167 and then include the contents of the file `log' in your bug report.
 168
 169 ***************************************
 170
 171 There are many tests, but nowhere near as many as we need.
 172 Additions and corrections are very welcome.
 173
 174 If you see a problem that you've already reported, feel free to re-report
 175 it -- it won't bother me to get a reminder.  Besides, the more messages I
 176 get regarding a particular problem the sooner it'll be fixed -- usually.
 177 If you sent a complete patch and, after a couple weeks you haven't
 178 received any acknowledgement, please ping us.  A complete patch includes
 179 a well-written ChangeLog entry, unified (diff -u format) diffs relative
 180 to the most recent test release (or, better, relative to the latest
 181 sources in the CVS repository), an explanation for why the patch is
 182 necessary or useful, and if at all possible, enough information to
 183 reproduce whatever problem prompted it.  Plus, you'll earn lots of
 184 karma if you include a test case to exercise any bug(s) you fix.
 185 Instructions for checking out the latest source via CVS are here:
 186
 187   http://savannah.gnu.org/cvs/?group=coreutils
 188
 189
 190 If your patch adds a new feature, please try to get some sort of consensus
 191 that it is a worthwhile change.  One way to do that is to send mail to
 192 bug-coreutils@gnu.org including as much description and justification
 193 as you can.  Based on the feedback that generates, you may be able to
 194 convince us that it's worth adding.
 195
 196
 197 WARNING:  Now that we use the ./bootstrap script, you should not run
 198 autoreconf manually.  Doing that will overwrite essential source files
 199 with older versions, which may make the package unbuildable or introduce
 200 subtle bugs.
 201
 202
 203 WARNING:  If you modify files like configure.in, m4/*.m4, aclocal.m4,
 204 or any Makefile.am, then don't be surprised if what gets regenerated no
 205 longer works.  To make things work, you'll have to be using appropriate
 206 versions of automake and autoconf.  As for what versions are `appropriate',
 207 use the versions of
 208
 209   * autoconf specified via AC_PREREQ in m4/jm-macros.m4
 210   * automake specified via AM_INIT_AUTOMAKE in configure.ac
 211
 212 Usually it's fine to use versions that are newer than those specified.
 213
 214 All of these programs except `test' recognize the `--version' option.
 215 When reporting bugs, please include in the subject line both the package
 216 name/version and the name of the program for which you found a problem.
 217
 218 For general documentation on the coding and usage standards
 219 this distribution follows, see the GNU Coding Standards,
 220 http://www.gnu.org/prep/standards_toc.html.
 221
 222 Mail suggestions and bug reports for these programs to
 223 the address on the last line of --help output.
 224
 225
 226 ========================================================================
 227
 228 Copyright (C) 1998, 2002, 2003, 2004, 2005, 2006 Free Software
 229 Foundation, Inc.
 230
 231 Permission is granted to copy, distribute and/or modify this document
 232 under the terms of the GNU Free Documentation License, Version 1.2 or
 233 any later version published by the Free Software Foundation; with no
 234 Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
 235 Texts.  A copy of the license is included in the ``GNU Free
 236 Documentation License'' file as part of this distribution.