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
  13   kill link ln logname ls md5sum mkdir mkfifo mknod 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 Pre-C99 build failure
  68 -----------------------
  69
  70 There is a new, implicit build requirement:
  71 To build the coreutils from source, you should have a C99-conforming
  72 compiler, due to the use of declarations after non-declaration statements
  73 in several files in src/.  There is code in configure to find and, if
  74 possible, enable an appropriate compiler.  However, if configure doesn't
  75 find a C99 compiler, it continues nonetheless, and your build will fail.
  76 If that happens, simply apply the included patch using the following
  77 command, and then run make again:
  78
  79   cd src && patch < c99-to-c89.diff
  80
  81
  82 ***********************
  83 HPUX 11.x build failure
  84 -----------------------
  85
  86 A known problem exists when compiling on HPUX on both hppa and ia64
  87 in 64-bit mode (i.e. +DD64) on HP-UX 11.0, 11.11, and 11.23.  This
  88 is not due to a bug in the package but instead due to a bug in the
  89 system header file which breaks things in 64-bit mode.  The default
  90 compilation mode is 32-bit and the software compiles fine using the
  91 default mode.  To build this software in 64-bit mode you will need
  92 to fix the system /usr/include/inttypes.h header file.  After
  93 correcting that file the software also compiles fine in 64-bit mode.
  94 Here is one possible patch to correct the problem:
  95
  96 --- /usr/include/inttypes.h.orig        Thu May 30 01:00:00 1996
  97 +++ /usr/include/inttypes.h     Sun Mar 23 00:20:36 2003
  98 @@ -489 +489 @@
  99 -#ifndef __STDC_32_MODE__
 100 +#ifndef __LP64__
 101
 102
 103 ************************
 104 OSF/1 4.0d build failure
 105 ------------------------
 106
 107 If you use /usr/bin/make on an OSF/1 4.0d system, it will fail due
 108 to the presence of the "[" target.  That version of make appears to
 109 treat "[" as some syntax relating to locks.  To work around that,
 110 the best solution is to use GNU make.  Otherwise, simply remove
 111 all mention of "[$(EXEEXT)" from src/Makefile.
 112
 113
 114
 115 **********************
 116 Running tests as root:
 117 ----------------------
 118
 119 If you run the tests as root, note that a few of them create files
 120 and/or run programs as a non-root user, `nobody' by default.
 121 If you want to use some other non-root username, specify it via
 122 the NON_ROOT_USERNAME environment variable.  Depending on the
 123 permissions with which the working directories have been created,
 124 using `nobody' may fail, because that user won't have the required
 125 read and write access to the build and test directories.
 126 I find that it is best to unpack and build as a non-privileged
 127 user, and then to run the following command as that user in order
 128 to run the privilege-requiring tests:
 129
 130   sudo env NON_ROOT_USERNAME=$USER make -k check
 131
 132 If you can run the tests as root, please do so and report any
 133 problems.  We get much less test coverage in that mode, and it's
 134 arguably more important that these tools work well when run by
 135 root than when run by less privileged users.
 136
 137
 138 ***************
 139 Reporting bugs:
 140 ---------------
 141
 142 IMPORTANT: if you take the time to report a test failure,
 143 please be sure to include the output of running `make check'
 144 in verbose mode for each failing test.  For example,
 145 if the test that fails is tests/mv/hard-link-1, then you
 146 would run this command:
 147
 148   env VERBOSE=yes make check -C tests/mv TESTS=hard-link-1 >> log 2>&1
 149
 150 For some tests, you can get even more detail by including
 151 DEBUG=yes in the environment:
 152
 153   env DEBUG=yes VERBOSE=yes make check -C tests/mv TESTS=hard-link-1 >> log 2>&1
 154
 155 and then include the contents of the file `log' in your bug report.
 156
 157 ***************************************
 158
 159 There are many tests, but nowhere near as many as we need.
 160 Additions and corrections are very welcome.
 161
 162 If you see a problem that you've already reported, feel free to re-report
 163 it -- it won't bother me to get a reminder.  Besides, the more messages I
 164 get regarding a particular problem the sooner it'll be fixed -- usually.
 165 If you sent a complete patch and, after a couple weeks you haven't
 166 received any acknowledgement, please ping us.  A complete patch includes
 167 a well-written ChangeLog entry, unified (diff -u format) diffs relative
 168 to the most recent test release (or, better, relative to the latest
 169 sources in the CVS repository), an explanation for why the patch is
 170 necessary or useful, and if at all possible, enough information to
 171 reproduce whatever problem prompted it.  Plus, you'll earn lots of
 172 karma if you include a test case to exercise any bug(s) you fix.
 173 Instructions for checking out the latest source via CVS are here:
 174
 175   http://savannah.gnu.org/cvs/?group=coreutils
 176
 177
 178 If your patch adds a new feature, please try to get some sort of consensus
 179 that it is a worthwhile change.  One way to do that is to send mail to
 180 bug-coreutils@gnu.org including as much description and justification
 181 as you can.  Based on the feedback that generates, you may be able to
 182 convince us that it's worth adding.
 183
 184
 185 WARNING:  Now that we use the ./bootstrap script, you should not run
 186 autoreconf manually.  Doing that will overwrite essential source files
 187 with older versions, which may make the package unbuildable or introduce
 188 subtle bugs.
 189
 190
 191 WARNING:  If you modify files like configure.in, m4/*.m4, aclocal.m4,
 192 or any Makefile.am, then don't be surprised if what gets regenerated no
 193 longer works.  To make things work, you'll have to be using appropriate
 194 versions of automake and autoconf.  As for what versions are `appropriate',
 195 use the versions of
 196
 197   * autoconf specified via AC_PREREQ in m4/jm-macros.m4
 198   * automake specified via AM_INIT_AUTOMAKE in configure.ac
 199
 200 Usually it's fine to use versions that are newer than those specified.
 201
 202 All of these programs except `test' recognize the `--version' option.
 203 When reporting bugs, please include in the subject line both the package
 204 name/version and the name of the program for which you found a problem.
 205
 206 For general documentation on the coding and usage standards
 207 this distribution follows, see the GNU Coding Standards,
 208 http://www.gnu.org/prep/standards_toc.html.
 209
 210 Mail suggestions and bug reports for these programs to
 211 the address on the last line of --help output.
 212
 213
 214 ========================================================================
 215
 216 Copyright (C) 1998, 2002, 2003, 2004, 2005, 2006 Free Software
 217 Foundation, Inc.
 218
 219 Permission is granted to copy, distribute and/or modify this document
 220 under the terms of the GNU Free Documentation License, Version 1.2 or
 221 any later version published by the Free Software Foundation; with no
 222 Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
 223 Texts.  A copy of the license is included in the ``GNU Free
 224 Documentation License'' file as part of this distribution.