Add module descriptions.

ChangeLog

@@ -1,3 +1,10 @@
+2003-01-11  Bruno Haible  <bruno@clisp.org>
+
+	* modules/*: Add a description.
+	* modules/strpbrk: Fix Makefile.am snippet.
+	* modules/strtoimax: Fix dependencies.
+	* modules/strtoumax: Likewise.
+
 2003-01-11  Bruno Haible  <bruno@clisp.org>
 
 	* gnulib-tool (func_create_testdir): Substitute lib_OBJECTS.

modules/acl

@@ -1,4 +1,5 @@
 Description:
+Access control lists of files.  (Unportable.)
 
 Files:
 lib/acl.h

modules/argmatch

@@ -1,4 +1,5 @@
 Description:
+Search for an exact or abbreviated match of a string in an array of strings.
 
 Files:
 lib/argmatch.h

modules/atexit

@@ -1,4 +1,5 @@
 Description:
+atexit() function: register a function to be called at program termination.
 
 Files:
 lib/atexit.c

modules/backupfile

@@ -1,4 +1,6 @@
 Description:
+Determination of the filename of a backup file, according to user environment
+variables.
 
 Files:
 lib/backupfile.h

modules/bcopy

@@ -1,4 +1,5 @@
 Description:
+Old BSD bcopy() function: copy memory area.
 
 Files:
 lib/bcopy.c

modules/bumpalloc

@@ -1,4 +1,5 @@
 Description:
+Increase table allocation by one element.
 
 Files:
 lib/bumpalloc.h

modules/c-stack

@@ -1,4 +1,5 @@
 Description:
+Stack overflow handling, causing program exit.
 
 Files:
 lib/c-stack.h

modules/canon-host

@@ -1,4 +1,6 @@
 Description:
+Canonicalize a host name: return a name other hosts can understand, i.e.
+usually the host name including FQDN.
 
 Files:
 lib/canon-host.c

modules/chown

@@ -1,4 +1,5 @@
 Description:
+chown() function: change ownership of a file.
 
 Files:
 lib/chown.c

modules/closeout

@@ -1,4 +1,5 @@
 Description:
+Close stdout, checking for errors.
 
 Files:
 lib/closeout.h

modules/diacrit

@@ -1,4 +1,5 @@
 Description:
+Decomposition of composed ISO-8859-1 characters.
 
 Files:
 lib/diacrit.h

modules/dirfd

@@ -1,4 +1,5 @@
 Description:
+Retrieving the file descriptor of an open directory stream.  (Unportable.)
 
 Files:
 lib/dirfd.h

modules/dirname

@@ -1,4 +1,5 @@
 Description:
+Extract specific portions of filenames.
 
 Files:
 lib/dirname.h

modules/dup2

@@ -1,4 +1,5 @@
 Description:
+dup2() function: duplicate an open file descriptor.
 
 Files:
 lib/dup2.c

modules/error

@@ -1,4 +1,5 @@
 Description:
+error() and error_at_line() functions: Error reporting.
 
 Files:
 lib/error.h

modules/euidaccess

@@ -1,4 +1,5 @@
 Description:
+euidaccess() function: check effective user's permissions for a file.
 
 Files:
 lib/euidaccess.c

modules/exclude

@@ -1,4 +1,5 @@
 Description:
+Manage list of filenames or wildcard patterns for --exclude option processing.
 
 Files:
 lib/exclude.h

modules/exitfail

@@ -1,4 +1,5 @@
 Description:
+Set exit status for fatal signal.
 
 Files:
 lib/exitfail.h

modules/fatal

@@ -1,4 +1,5 @@
 Description:
+Error reporting for fatal errors.
 
 Files:
 lib/fatal.h

modules/file-type

@@ -1,4 +1,5 @@
 Description:
+Return a string describing the type of a file.
 
 Files:
 lib/file-type.h

modules/fileblocks

@@ -1,4 +1,5 @@
 Description:
+Estimate number of blocks of a file, if 'struct stat' doesn't have st_blocks.
 
 Files:
 lib/fileblocks.c

modules/filemode

@@ -1,4 +1,6 @@
 Description:
+Return a string (?rwxrwxrwx format) describing the type and permissions of a
+file.
 
 Files:
 lib/filemode.h

modules/fnmatch

@@ -1,4 +1,5 @@
 Description:
+GNU fnmatch() implementation.
 
 Files:
 lib/fnmatch_.h

modules/fnmatch-gnu

@@ -1,4 +1,5 @@
 Description:
+fnmatch() function: wildcard matching, with GNU extensions.
 
 Files:
 

modules/fnmatch-posix

@@ -1,4 +1,5 @@
 Description:
+fnmatch() function: wildcard matching.
 
 Files:
 

modules/fpending

@@ -1,4 +1,5 @@
 Description:
+Determine the number of bytes waiting in the output buffer of a stream.
 
 Files:
 lib/__fpending.h

modules/fsusage

@@ -1,4 +1,5 @@
 Description:
+Return filesystem space usage info.
 
 Files:
 lib/fsusage.h

modules/ftruncate

@@ -1,4 +1,5 @@
 Description:
+ftruncate() function: truncate an open file to a specified length.
 
 Files:
 lib/ftruncate.c

modules/full-read

@@ -1,4 +1,5 @@
 Description:
+An interface to read() that reads all it is asked to read.
 
 Files:
 lib/full-read.h

modules/full-write

@@ -1,4 +1,5 @@
 Description:
+An interface to write() that writes all it is asked to write.
 
 Files:
 lib/full-write.h

modules/gcd

@@ -1,4 +1,5 @@
 Description:
+Greatest common divisor.
 
 Files:
 lib/gcd.h

modules/getdate

@@ -1,4 +1,5 @@
 Description:
+Convert a date/time string to linear time.
 
 Files:
 lib/getdate.h

modules/getgroups

@@ -1,4 +1,5 @@
 Description:
+getgroups() function: return the supplementary group IDs of the current process.
 
 Files:
 lib/getgroups.c

modules/gethostname

@@ -1,4 +1,5 @@
 Description:
+gethostname() function: Return machine's hostname.
 
 Files:
 lib/gethostname.c

modules/getline

@@ -1,4 +1,5 @@
 Description:
+Read a line from a stream.
 
 Files:
 lib/getline.h

modules/getloadavg

@@ -1,4 +1,5 @@
 Description:
+Return the current system load averages.
 
 Files:
 lib/getloadavg.c

modules/getopt

@@ -1,4 +1,5 @@
 Description:
+Process command line arguments.
 
 Files:
 lib/getopt.h

modules/getpagesize

@@ -1,4 +1,5 @@
 Description:
+getpagesize() function: Return memory page size.
 
 Files:
 lib/getpagesize.h

modules/getpass

@@ -1,4 +1,5 @@
 Description:
+getpass() function: read a password from /dev/tty.
 
 Files:
 lib/getpass.c

modules/gettext

@@ -1,4 +1,5 @@
 Description:
+Translate messages to user's native language.
 
 Files:
 lib/gettext.h

modules/gettime

@@ -1,4 +1,5 @@
 Description:
+Return current time, with nanosecond resolution.
 
 Files:
 lib/gettime.c

modules/gettimeofday

@@ -1,4 +1,5 @@
 Description:
+gettimeofday() function: return current time.
 
 Files:
 lib/gettimeofday.c

modules/getugroups

@@ -1,4 +1,5 @@
 Description:
+Return the group IDs of a user.
 
 Files:
 lib/getugroups.c

modules/getusershell

@@ -1,4 +1,5 @@
 Description:
+Return names of valid user shells.
 
 Files:
 lib/getusershell.c

modules/group-member

@@ -1,4 +1,5 @@
 Description:
+Determine whether the current process has the permissions of a given group ID.
 
 Files:
 lib/group-member.h

modules/hard-locale

@@ -1,4 +1,5 @@
 Description:
+Determine whether the current locale is different from the "C" locale.
 
 Files:
 lib/hard-locale.h

modules/hash

@@ -1,4 +1,5 @@
 Description:
+Parametrizable hash table.
 
 Files:
 lib/hash.h

modules/hash-pjw

@@ -1,4 +1,5 @@
 Description:
+Compute a hash value for a NUL-terminated string.
 
 Files:
 lib/hash-pjw.h

modules/human

@@ -1,4 +1,6 @@
 Description:
+Convert a number (usually a file size) to a human readable string, possibly
+with K/M/G suffix.
 
 Files:
 lib/human.h

modules/iconv

@@ -1,4 +1,5 @@
 Description:
+Character set conversion.
 
 Files:
 m4/iconv.m4

modules/idcache

@@ -1,4 +1,5 @@
 Description:
+Username <--> uid and groupname <--> gid conversions, with cache for speed.
 
 Files:
 lib/idcache.c

modules/isdir

@@ -1,4 +1,5 @@
 Description:
+Determine whether a directory exists.
 
 Files:
 lib/isdir.c

modules/lchown

@@ -1,4 +1,5 @@
 Description:
+lchown() function: change ownership of a file.
 
 Files:
 lib/lchown.h

modules/linebuffer

@@ -1,4 +1,5 @@
 Description:
+Read a line from a stream.
 
 Files:
 lib/linebuffer.h

modules/localcharset

@@ -1,4 +1,5 @@
 Description:
+Return current locale's character encoding.
 
 Files:
 lib/localcharset.h

modules/long-options

@@ -1,4 +1,5 @@
 Description:
+Handle --help and --version options.
 
 Files:
 lib/long-options.h

modules/lstat

@@ -1,4 +1,5 @@
 Description:
+stat() function: return information about a file or symbolic link.
 
 Files:
 lib/lstat.c

modules/makepath

@@ -1,4 +1,5 @@
 Description:
+Ensure that a directory path exists.
 
 Files:
 lib/makepath.h

modules/malloc

@@ -1,4 +1,5 @@
 Description:
+malloc() function that is glibc compatible.
 
 Files:
 lib/malloc.c

modules/mbswidth

@@ -1,4 +1,5 @@
 Description:
+Determine the number of screen columns needed for a string.
 
 Files:
 lib/mbswidth.h

modules/md5

@@ -1,4 +1,5 @@
 Description:
+Compute MD5 checksum.
 
 Files:
 lib/md5.h

modules/memcasecmp

@@ -1,4 +1,5 @@
 Description:
+Case-insensitive memory area comparison.
 
 Files:
 lib/memcasecmp.h

modules/memchr

@@ -1,4 +1,5 @@
 Description:
+memchr() function: scan memory for a byte.
 
 Files:
 lib/memchr.c

modules/memcmp

@@ -1,4 +1,5 @@
 Description:
+memcmp() function: compare memory areas.
 
 Files:
 lib/memcmp.c

modules/memcoll

@@ -1,4 +1,5 @@
 Description:
+Locale dependent memory area comparison.
 
 Files:
 lib/memcoll.h

modules/memcpy

@@ -1,4 +1,5 @@
 Description:
+memcpy() function: copy memory area.
 
 Files:
 lib/memcpy.c

modules/memmove

@@ -1,4 +1,5 @@
 Description:
+memmove() function: copy memory area.
 
 Files:
 lib/memmove.c

modules/memrchr

@@ -1,4 +1,5 @@
 Description:
+memrchr() function: scan memory for a byte, from the right end.
 
 Files:
 lib/memrchr.c

modules/memset

@@ -1,4 +1,5 @@
 Description:
+memset() function: fill memory with a constant byte.
 
 Files:
 lib/memset.c

modules/mkdir

@@ -1,4 +1,5 @@
 Description:
+mkdir() function: create a directory.
 
 Files:
 lib/mkdir.c

modules/mkstemp

@@ -1,4 +1,5 @@
 Description:
+mkstemp() function: create a private temporary file.
 
 Files:
 lib/mkstemp.c

modules/mktime

@@ -1,4 +1,5 @@
 Description:
+mktime() function: convert broken-down time to linear time.
 
 Files:
 lib/mktime.c

modules/modechange

@@ -1,4 +1,6 @@
 Description:
+Manipulation of mode changes specified by strings (e.g. as first argument of
+chmod utility).
 
 Files:
 lib/modechange.h

modules/mountlist

@@ -1,4 +1,5 @@
 Description:
+Return list of mounted filesystems.
 
 Files:
 lib/mountlist.h

modules/nanosleep

@@ -1,4 +1,5 @@
 Description:
+nanosleep() function: pause execution for a specified time.
 
 Files:
 lib/nanosleep.c

modules/obstack

@@ -1,4 +1,5 @@
 Description:
+Memory allocation, optimized for stack-like allocation patterns.
 
 Files:
 lib/obstack.h

modules/path-concat

@@ -1,4 +1,6 @@
 Description:
+Construct a full pathname by concatenating a directory name and a relative
+filename.
 
 Files:
 lib/path-concat.h

modules/pathmax

@@ -1,4 +1,5 @@
 Description:
+Return maximum size of reasonable pathnames.  (Unportable: Hurd has no limit.)
 
 Files:
 lib/pathmax.h

modules/physmem

@@ -1,4 +1,5 @@
 Description:
+Return amount of total/available physical memory.
 
 Files:
 lib/physmem.h

modules/posixtm

@@ -1,4 +1,5 @@
 Description:
+Convert a date/time string (POSIX syntax) to linear time or broken-down time.
 
 Files:
 lib/posixtm.h

modules/posixver

@@ -1,4 +1,6 @@
 Description:
+Determine desired POSIX specification version, according to user's environment
+variables.
 
 Files:
 lib/posixver.h

modules/putenv

@@ -1,4 +1,5 @@
 Description:
+putenv() function: change or add an environment variable.
 
 Files:
 lib/putenv.c

modules/quote

@@ -1,4 +1,5 @@
 Description:
+Quote arguments for use in error messages.
 
 Files:
 lib/quote.h

modules/quotearg

@@ -1,4 +1,5 @@
 Description:
+Quote arguments for use in error messages.
 
 Files:
 lib/quotearg.h

modules/readtokens

@@ -1,4 +1,5 @@
 Description:
+Read tokens from a stream.
 
 Files:
 lib/readtokens.h

modules/readutmp

@@ -1,4 +1,5 @@
 Description:
+Read entire utmp file into memory.
 
 Files:
 lib/readutmp.h

modules/realloc

@@ -1,4 +1,5 @@
 Description:
+realloc() function that is glibc compatible.
 
 Files:
 lib/realloc.c

modules/regex

@@ -1,4 +1,5 @@
 Description:
+Regular expression matching.
 
 Files:
 lib/regex.h

modules/rename

@@ -1,4 +1,5 @@
 Description:
+rename() function: change the name or location of a file.
 
 Files:
 lib/rename.c

modules/rmdir

@@ -1,4 +1,5 @@
 Description:
+rmdir() function: delete a directory.
 
 Files:
 lib/rmdir.c

modules/rpmatch

@@ -1,4 +1,5 @@
 Description:
+Locale dependent classification of a response as matching "yes" or "no".
 
 Files:
 lib/rpmatch.c

modules/safe-read

@@ -1,4 +1,5 @@
 Description:
+An interface to read() that retries after interrupts.
 
 Files:
 lib/safe-read.h

modules/safe-write

@@ -1,4 +1,5 @@
 Description:
+An interface to write() that retries after interrupts.
 
 Files:
 lib/safe-write.h

modules/same

@@ -1,4 +1,6 @@
 Description:
+Determine whether two pathnames refer to the same directory entry of the same
+directory.
 
 Files:
 lib/same.h

modules/save-cwd

@@ -1,4 +1,5 @@
 Description:
+Save and restore the current working directory.
 
 Files:
 lib/save-cwd.h

modules/savedir

@@ -1,4 +1,5 @@
 Description:
+Return the entries of a directory (just the names) as an argz string.
 
 Files:
 lib/savedir.h

modules/setenv

@@ -1,4 +1,6 @@
 Description:
+setenv() function: set an environment variable.
+unsetenv() function: remove an environment variable.
 
 Files:
 lib/setenv.h

modules/settime

@@ -1,4 +1,5 @@
 Description:
+Set the current time, with nanosecond resolution.
 
 Files:
 lib/settime.c

modules/sha

@@ -1,4 +1,5 @@
 Description:
+Compute SHA checksum.
 
 Files:
 lib/sha.h