Fix brought over from gettext.

[gnulib.git] / doc / functions.texi

diff --git a/doc/functions.texi b/doc/functions.texi
index 9d5e01b..ecb31a3 100644 (file)
--- a/doc/functions.texi
+++ b/doc/functions.texi
@@ -42,7 +42,7 @@ or @code{memmove} instead.
 
 @item btowc
 On Windows systems, @code{wchar_t} is a 16-bit type and therefore cannot
 
 @item btowc
 On Windows systems, @code{wchar_t} is a 16-bit type and therefore cannot

-accomodate all Unicode characters.
+accommodate all Unicode characters.

 
 @item bzero
 This function is marked as ``legacy'' in POSIX.  Better use @code{memset}
 
 @item bzero
 This function is marked as ``legacy'' in POSIX.  Better use @code{memset}


@@ -50,7 +50,7 @@ instead.
 
 @item chown
 When applied to a symbolic link, some implementations don't dereference
 
 @item chown
 When applied to a symbolic link, some implementations don't dereference

-the symlink, i.e. they behave like @code{lchown}.
+the symlink, i.e.@: they behave like @code{lchown}.

 
 @item cproj
 @itemx cprojf
 
 @item cproj
 @itemx cprojf


@@ -114,7 +114,7 @@ upon failure.
 @item fgetwc
 @itemx fgetws
 On Windows systems, @code{wchar_t} is a 16-bit type and therefore cannot
 @item fgetwc
 @itemx fgetws
 On Windows systems, @code{wchar_t} is a 16-bit type and therefore cannot

-accomodate all Unicode characters.
+accommodate all Unicode characters.

 
 @item fnmatch
 This function is broken in some version of Solaris or glibc.
 
 @item fnmatch
 This function is broken in some version of Solaris or glibc.


@@ -154,7 +154,7 @@ upon failure.
 @item fputwc
 @itemx fputws
 On Windows systems, @code{wchar_t} is a 16-bit type and therefore cannot
 @item fputwc
 @itemx fputws
 On Windows systems, @code{wchar_t} is a 16-bit type and therefore cannot

-accomodate all Unicode characters.
+accommodate all Unicode characters.

 
 @item fread
 On Windows systems (excluding Cygwin), this function does not set @code{errno}
 
 @item fread
 On Windows systems (excluding Cygwin), this function does not set @code{errno}


@@ -194,14 +194,14 @@ portability to Windows systems.
 
 @item fwide
 On Windows systems, @code{wchar_t} is a 16-bit type and therefore cannot
 
 @item fwide
 On Windows systems, @code{wchar_t} is a 16-bit type and therefore cannot

-accomodate all Unicode characters.
+accommodate all Unicode characters.

 
 @code{fwide} is not guaranteed to be able to change a file stream's mode
 to a different mode than the current one.
 
 @item fwprintf
 On Windows systems, @code{wchar_t} is a 16-bit type and therefore cannot
 
 @code{fwide} is not guaranteed to be able to change a file stream's mode
 to a different mode than the current one.
 
 @item fwprintf
 On Windows systems, @code{wchar_t} is a 16-bit type and therefore cannot

-accomodate all Unicode characters.
+accommodate all Unicode characters.

 
 @item fwrite
 On Windows systems (excluding Cygwin), this function does not set @code{errno}
 
 @item fwrite
 On Windows systems (excluding Cygwin), this function does not set @code{errno}


@@ -209,7 +209,7 @@ upon failure.
 
 @item fwscanf
 On Windows systems, @code{wchar_t} is a 16-bit type and therefore cannot
 
 @item fwscanf
 On Windows systems, @code{wchar_t} is a 16-bit type and therefore cannot

-accomodate all Unicode characters.
+accommodate all Unicode characters.

 
 @item gcvt
 This function is marked as ``legacy'' in POSIX.  Better use @code{sprintf}
 
 @item gcvt
 This function is marked as ``legacy'' in POSIX.  Better use @code{sprintf}


@@ -277,7 +277,7 @@ On some systems, @code{gettimeofday} clobbers the buffer in which
 @item getwc
 @itemx getwchar
 On Windows systems, @code{wchar_t} is a 16-bit type and therefore cannot
 @item getwc
 @itemx getwchar
 On Windows systems, @code{wchar_t} is a 16-bit type and therefore cannot

-accomodate all Unicode characters.
+accommodate all Unicode characters.

 
 @item getwd
 The size of the buffer required for this function is not a compile-time
 
 @item getwd
 The size of the buffer required for this function is not a compile-time


@@ -331,7 +331,7 @@ On Windows, @code{isatty} also returns true for character devices such as
 @itemx iswupper
 @itemx iswxdigit
 On Windows systems, @code{wchar_t} is a 16-bit type and therefore cannot
 @itemx iswupper
 @itemx iswxdigit
 On Windows systems, @code{wchar_t} is a 16-bit type and therefore cannot

-accomodate all Unicode characters.
+accommodate all Unicode characters.

 
 @item l64a
 This function was not correctly implemented in glibc versions before 2.2.5.
 
 @item l64a
 This function was not correctly implemented in glibc versions before 2.2.5.


@@ -371,7 +371,7 @@ is to use the @code{AC_SYS_LARGEFILE} macro.
 @itemx mbstowcs
 @itemx mbtowc
 On Windows systems, @code{wchar_t} is a 16-bit type and therefore cannot
 @itemx mbstowcs
 @itemx mbtowc
 On Windows systems, @code{wchar_t} is a 16-bit type and therefore cannot

-accomodate all Unicode characters.
+accommodate all Unicode characters.

 
 @item mkdir
 When the argument ends in a slash, the function call fails on some systems.
 
 @item mkdir
 When the argument ends in a slash, the function call fails on some systems.


@@ -381,6 +381,10 @@ and takes only one argument.  The fix is to define a macro like this:
 @smallexample
 #define mkdir ((int (*)()) _mkdir)
 @end smallexample
 @smallexample
 #define mkdir ((int (*)()) _mkdir)
 @end smallexample

+or
+@smallexample
+#define mkdir(path,mode) _mkdir (path)
+@end smallexample

 
 @item mkstemp
 On some systems (HP-UX 10.20, SunOS 4.1.4, Solaris 2.5.1), mkstemp has a silly
 
 @item mkstemp
 On some systems (HP-UX 10.20, SunOS 4.1.4, Solaris 2.5.1), mkstemp has a silly


@@ -467,17 +471,17 @@ upon failure.
 @item putwc
 @itemx putwchar
 On Windows systems, @code{wchar_t} is a 16-bit type and therefore cannot
 @item putwc
 @itemx putwchar
 On Windows systems, @code{wchar_t} is a 16-bit type and therefore cannot

-accomodate all Unicode characters.
+accommodate all Unicode characters.

 
 @item readlink
 When @code{readlink} is called on a directory: In the case of NFS mounted
 
 @item readlink
 When @code{readlink} is called on a directory: In the case of NFS mounted

-directories, Cygwin sets errno to @code{ENOENT} or @code{EIO} instead of
+directories, Cygwin sets @code{errno} to @code{ENOENT} or @code{EIO} instead of

 @code{EINVAL}.  To avoid this problem, check for a directory before calling
 @code{readlink}.
 
 When @code{readlink} is called on a file that is not a symbolic link:
 @code{EINVAL}.  To avoid this problem, check for a directory before calling
 @code{readlink}.
 
 When @code{readlink} is called on a file that is not a symbolic link:

-Irix may set errno to @code{ENXIO} instead of @code{EINVAL}.  Cygwin may set
-errno to @code{EACCES} instead of {EINVAL}.
+Irix may set @code{errno} to @code{ENXIO} instead of @code{EINVAL}.  Cygwin
+may set errno to @code{EACCES} instead of {EINVAL}.

 
 @item realpath
 This function does not allow to determine the required size of output buffer;
 
 @item realpath
 This function does not allow to determine the required size of output buffer;


@@ -525,7 +529,7 @@ called on descriptors created by the @code{socket} function, not on regular
 file descriptors.
 
 On Linux, when some file descriptor refers to a regular file, @code{select}
 file descriptors.
 
 On Linux, when some file descriptor refers to a regular file, @code{select}

-may fail, setting errno to @code{EBADF}.
+may fail, setting @code{errno} to @code{EBADF}.

 
 @item setcontext
 The effects of this call are system and compiler optimization dependent,
 
 @item setcontext
 The effects of this call are system and compiler optimization dependent,


@@ -533,7 +537,7 @@ since it restores the contents of register-allocated variables but not
 the contents of stack-allocated variables.
 
 @item setenv
 the contents of stack-allocated variables.
 
 @item setenv

-In some versions of glibc (e.g. 2.3.3), @code{setenv} doesn't fail if the
+In some versions of glibc (e.g.@: 2.3.3), @code{setenv} doesn't fail if the

 first argument contains a @samp{=} character.
 
 @item setjmp
 first argument contains a @samp{=} character.
 
 @item setjmp


@@ -557,8 +561,8 @@ upon failure.
 
 @item shmat
 Attempts to @code{shmat} into a previously malloc-ed region fail on SunOS 4,
 
 @item shmat
 Attempts to @code{shmat} into a previously malloc-ed region fail on SunOS 4,

-with errno set to @code{EINVAL}, even if there is an @code{munmap} call in
-between.
+with @code{errno} set to @code{EINVAL}, even if there is an @code{munmap} call
+in between.

 
 On Linux, the flag @code{SHM_REMAP} is needed in order to force @code{shmat}
 to replace existing memory mappings in the specify address range.  On other
 
 On Linux, the flag @code{SHM_REMAP} is needed in order to force @code{shmat}
 to replace existing memory mappings in the specify address range.  On other


@@ -588,7 +592,7 @@ flag @code{SA_NOCLDWAIT} in order to obtain this behaviour.
 
 @item signal
 On System V systems, when the signal is triggered, the kernel uninstalls the
 
 @item signal
 On System V systems, when the signal is triggered, the kernel uninstalls the

-handler (i.e. resets the signal's action to SIG_DFL) before invoking the
+handler (i.e.@: resets the signal's action to SIG_DFL) before invoking the

 handler.  This opens the door to race conditions: undesired things happen
 if the signal is triggered twice and the signal handler was not quick enough
 reinstalling itself as a handler.  On BSD systems and glibc systems, on the
 handler.  This opens the door to race conditions: undesired things happen
 if the signal is triggered twice and the signal handler was not quick enough
 reinstalling itself as a handler.  On BSD systems and glibc systems, on the


@@ -647,7 +651,7 @@ On platforms where @code{off_t} is a 32-bit type, @code{stat} may not correctly
 report the size of files or block devices larger than 2 GB.  The fix is to
 use the @code{AC_SYS_LARGEFILE} macro.
 
 report the size of files or block devices larger than 2 GB.  The fix is to
 use the @code{AC_SYS_LARGEFILE} macro.
 

-Cygwin's @code{stat} function sometimes sets errno to @code{EACCES} when
+Cygwin's @code{stat} function sometimes sets @code{errno} to @code{EACCES} when

 @code{ENOENT} would be more appropriate.
 
 @item strcasecmp
 @code{ENOENT} would be more appropriate.
 
 @item strcasecmp


@@ -671,7 +675,7 @@ multibyte locales.
 
 @item swprintf
 On Windows systems, @code{wchar_t} is a 16-bit type and therefore cannot
 
 @item swprintf
 On Windows systems, @code{wchar_t} is a 16-bit type and therefore cannot

-accomodate all Unicode characters.
+accommodate all Unicode characters.

 
 On Windows, this function does not take a buffer size as second argument.
 
 
 On Windows, this function does not take a buffer size as second argument.
 


@@ -682,7 +686,7 @@ the rules for quoting shell arguments containing spaces, quote or other special
 characters are different.
 
 @item tcdrain
 characters are different.
 
 @item tcdrain

-On some systems, @code{tcdrain} on a non-tty fails with errno set to
+On some systems, @code{tcdrain} on a non-tty fails with @code{errno} set to

 @code{EINVAL} or, on MacOS X, also @code{EOPNOTSUPP} or @code{ENODEV}, rather
 than @code{ENOTTY}.
 
 @code{EINVAL} or, on MacOS X, also @code{EOPNOTSUPP} or @code{ENODEV}, rather
 than @code{ENOTTY}.
 


@@ -706,7 +710,7 @@ security risks.)  Better use @code{mkstemp} instead.
 @itemx towlower
 @itemx towupper
 On Windows systems, @code{wchar_t} is a 16-bit type and therefore cannot
 @itemx towlower
 @itemx towupper
 On Windows systems, @code{wchar_t} is a 16-bit type and therefore cannot

-accomodate all Unicode characters.
+accommodate all Unicode characters.

 
 @item ungetc
 On Windows systems (excluding Cygwin), this function does not set @code{errno}
 
 @item ungetc
 On Windows systems (excluding Cygwin), this function does not set @code{errno}


@@ -714,10 +718,10 @@ upon failure.
 
 @item ungetwc
 On Windows systems, @code{wchar_t} is a 16-bit type and therefore cannot
 
 @item ungetwc
 On Windows systems, @code{wchar_t} is a 16-bit type and therefore cannot

-accomodate all Unicode characters.
+accommodate all Unicode characters.

 
 @item unlink
 
 @item unlink

-Removing an open file is unportable: On Unix this allows the programs that
+Removing an open file is non-portable: On Unix this allows the programs that

 have the file already open to continue working with it; the file's storage
 is only freed when the no process has the file open any more.  On Windows,
 the attempt to remove an open file fails.
 have the file already open to continue working with it; the file's storage
 is only freed when the no process has the file open any more.  On Windows,
 the attempt to remove an open file fails.


@@ -801,7 +805,7 @@ On Windows, these functions don't support the @code{hh}, @code{ll}, @code{j},
 
 @item vswprintf
 On Windows systems, @code{wchar_t} is a 16-bit type and therefore cannot
 
 @item vswprintf
 On Windows systems, @code{wchar_t} is a 16-bit type and therefore cannot

-accomodate all Unicode characters.
+accommodate all Unicode characters.

 
 On Windows, this function does not take a buffer size as second argument.
 
 
 On Windows, this function does not take a buffer size as second argument.
 


@@ -838,11 +842,11 @@ works correctly.
 @itemx wcstoull
 @itemx wcstoumax
 On Windows systems, @code{wchar_t} is a 16-bit type and therefore cannot
 @itemx wcstoull
 @itemx wcstoumax
 On Windows systems, @code{wchar_t} is a 16-bit type and therefore cannot

-accomodate all Unicode characters.
+accommodate all Unicode characters.

 
 @item wcswcs
 On Windows systems, @code{wchar_t} is a 16-bit type and therefore cannot
 
 @item wcswcs
 On Windows systems, @code{wchar_t} is a 16-bit type and therefore cannot

-accomodate all Unicode characters.
+accommodate all Unicode characters.

 
 This function is marked as ``legacy'' in POSIX.  Better use @code{wcsstr}
 instead.
 
 This function is marked as ``legacy'' in POSIX.  Better use @code{wcsstr}
 instead.


@@ -862,6 +866,6 @@ instead.
 @itemx wprintf
 @itemx wscanf
 On Windows systems, @code{wchar_t} is a 16-bit type and therefore cannot
 @itemx wprintf
 @itemx wscanf
 On Windows systems, @code{wchar_t} is a 16-bit type and therefore cannot

-accomodate all Unicode characters.
+accommodate all Unicode characters.

 
 @end table
 
 @end table