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   basename cat chgrp chmod chown chroot cksum comm cp csplit cut date dd
  11   df dir dircolors dirname du echo env expand expr factor false fmt fold
  12   ginstall groups head hostid hostname id join kill link ln logname ls
  13   md5sum mkdir mkfifo mknod mv nice nl nohup od paste pathchk pinky pr
  14   printenv printf ptx pwd readlink rm rmdir seq sha1sum shred sleep sort
  15   split stat stty su sum sync tac tail tee test touch tr true tsort tty
  16   uname unexpand uniq unlink uptime users vdir wc who whoami yes
  17
  18 See the file NEWS for a list of major changes in the current release.
  19
  20 See the file INSTALL for compilation and installation instructions.
  21
  22 These programs are intended to be POSIX.2 compliant (with BSD and other
  23 extensions), like the rest of the GNU system.
  24
  25 The ls, dir, and vdir commands are all separate executables instead of
  26 one program that checks argv[0] because people often rename these
  27 programs to things like gls, gnuls, l, etc.  Renaming a program
  28 file shouldn't affect how it operates, so that people can get the
  29 behavior they want with whatever name they want.
  30
  31 Special thanks to Paul Eggert, Brian Matthews, Bruce Evans, Karl Berry,
  32 Kaveh Ghazi, and François Pinard for help with debugging and porting
  33 these programs.  Many thanks to all of the people who have taken the
  34 time to submit problem reports and fixes.  All contributed changes are
  35 attributed in the ChangeLog file.
  36
  37 And thanks to the following people who have provided accounts for
  38 portability testing on many different types of systems: Bob Proulx,
  39 Christian Robert, François Pinard, Greg McGary, Harlan Stenn,
  40 Joel N. Weber, Mark D. Roth, Matt Schalit, Nelson H. F. Beebe,
  41 Réjean Payette, Sam Tardieu.
  42
  43 Thanks to Michael Stone for inflicting test releases of the fileutils
  44 on Debian's unstable distribution, and to all the kind folks who used
  45 that distribution and found and reported bugs.
  46
  47 Note that each man page is now automatically generated from a template
  48 and from the corresponding --help usage message.  Patches to the template
  49 files (man/*.x) are welcome.  However, the authoritative documentation
  50 is in texinfo form in the doc directory.
  51
  52 If you run the tests on a SunOS4.1.4 system, expect the ctime-part of
  53 the ls `time-1' test to fail.  I believe that is due to a bug in the
  54 way Sun implemented link(2) and chmod(2).
  55
  56 There are pretty many tests, but nowhere near as many as we need.
  57 Additions and corrections are very welcome.
  58
  59 If you see a problem that you've already reported, feel free to re-report
  60 it -- it won't bother me to get a reminder.  Besides, the more messages I
  61 get regarding a particular problem the sooner it'll be fixed -- usually.
  62 If you sent a complete patch and, after a couple weeks you haven't
  63 received any acknowledgement please ping us.  A complete patch includes
  64 a well-written ChangeLog entry, unified (diff -u format) diffs relative
  65 to the most recent test release, an explanation for why the patch is
  66 necessary or useful, and if at all possible, enough information to
  67 reproduce whatever problem prompted it.
  68
  69 If your patch adds a new feature, please try to get some sort of consensus
  70 that it is a worthwhile change.  One way to do that is to send mail to
  71 bug-coreutils@gnu.org including as much description and justification
  72 as you can.  Based on the feedback that generates, you may be able to
  73 convince us that it's worth adding.
  74
  75
  76 WARNING:  If you modify files like configure.in, m4/*.m4, aclocal.m4,
  77 or any Makefile.am, then don't be surprised if what gets regenerated no
  78 longer works.  To make things work, you'll have to be using appropriate
  79 versions of automake and autoconf.  As for what versions are `appropriate',
  80 use the versions of
  81
  82   * autoconf specified via AC_PREREQ in m4/jm-macros.m4
  83   * automake specified via AM_INIT_AUTOMAKE in configure.ac
  84
  85 Usually it's fine to use versions that are newer than those specified.
  86
  87 These programs all recognize the `--version' option.  When reporting
  88 bugs, please include in the subject line both the package name/version
  89 and the name of the program for which you found a problem.
  90
  91 For general documentation on the coding and usage standards
  92 this distribution follows, see the GNU Coding Standards,
  93 http://www.gnu.org/prep/standards_toc.html.
  94
  95 Mail suggestions and bug reports for these programs to
  96 the address on the last line of --help output.