Libc-763.11.tar.gz

[apple/libc.git] / gen / dirname.3

diff --git a/gen/dirname.3 b/gen/dirname.3
index 2caa87271ccfd248460c8e0934b2b07ff2e94ca9..330b426402d01dec533ca088deb85456b6d502d2 100644 (file)
--- a/gen/dirname.3
+++ b/gen/dirname.3
@@ -1,33 +1,22 @@
+.\" $OpenBSD: dirname.3,v 1.17 2007/05/31 19:19:28 jmc Exp $

 .\"
 .\" Copyright (c) 1997 Todd C. Miller <Todd.Miller@courtesan.com>
 .\"
 .\" Copyright (c) 1997 Todd C. Miller <Todd.Miller@courtesan.com>

-.\" All rights reserved.

 .\"
 .\"

-.\" Redistribution and use in source and binary forms, with or without
-.\" modification, are permitted provided that the following conditions
-.\" are met:
-.\" 1. Redistributions of source code must retain the above copyright
-.\"    notice, this list of conditions and the following disclaimer.
-.\" 2. Redistributions in binary form must reproduce the above copyright
-.\"    notice, this list of conditions and the following disclaimer in the
-.\"    documentation and/or other materials provided with the distribution.
-.\" 3. The name of the author may not be used to endorse or promote products
-.\"    derived from this software without specific prior written permission.
+.\" Permission to use, copy, modify, and distribute this software for any
+.\" purpose with or without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.

 .\"
 .\"

-.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
-.\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
-.\" AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
-.\" THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
-.\" EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
-.\" PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
-.\" OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
-.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
-.\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
-.\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

 .\"
 .\"

-.\" $OpenBSD: dirname.3,v 1.9 2000/04/18 03:01:25 aaron Exp $
-.\" $FreeBSD: src/lib/libc/gen/dirname.3,v 1.8 2004/07/02 23:52:10 ru Exp $
+.\" $FreeBSD: src/lib/libc/gen/dirname.3,v 1.10 2008/11/03 05:19:45 delphij Exp $

 .\"
 .\"

-.Dd August 17, 1997
+.Dd October 12, 2006

 .Dt DIRNAME 3
 .Os
 .Sh NAME
 .Dt DIRNAME 3
 .Os
 .Sh NAME


@@ -42,8 +31,7 @@
 .Sh DESCRIPTION
 The
 .Fn dirname
 .Sh DESCRIPTION
 The
 .Fn dirname

-function
-is the converse of
+function is the converse of

 .Xr basename 3 ;
 it returns a pointer to the parent directory of the pathname pointed to by
 .Fa path .
 .Xr basename 3 ;
 it returns a pointer to the parent directory of the pathname pointed to by
 .Fa path .


@@ -60,31 +48,13 @@ characters,
 returns a pointer to the string
 .Qq \&. ,
 signifying the current directory.
 returns a pointer to the string
 .Qq \&. ,
 signifying the current directory.

-.Sh RETURN VALUES
-On successful completion,
-.Fn dirname
-returns a pointer to the parent directory of
-.Fa path .
-.Pp
-If
-.Fn dirname
-fails, a null pointer is returned and the global variable
-.Va errno
-is set to indicate the error.
-.Sh ERRORS
-The following error codes may be set in
-.Va errno :
-.Bl -tag -width Er
-.It Bq Er ENAMETOOLONG
-The path component to be returned was larger than
-.Dv MAXPATHLEN .
-.El
-.Sh WARNINGS
+.Sh IMPLEMENTATION NOTES

 The
 .Fn dirname
 function
 The
 .Fn dirname
 function

-returns a pointer to internal static storage space that will be overwritten
-by subsequent calls (each function has its own separate storage).
+returns a pointer to internal storage space allocated on the first call
+that will be overwritten
+by subsequent calls.

 .Pp
 Other vendor implementations of
 .Fn dirname
 .Pp
 Other vendor implementations of
 .Fn dirname


@@ -104,6 +74,25 @@ this should be taken into account when writing code which calls this function.
 In legacy mode,
 .Fa path
 will not be changed.
 In legacy mode,
 .Fa path
 will not be changed.

+.Sh RETURN VALUES
+On successful completion,
+.Fn dirname
+returns a pointer to the parent directory of
+.Fa path .
+.Pp
+If
+.Fn dirname
+fails, a null pointer is returned and the global variable
+.Va errno
+is set to indicate the error.
+.Sh ERRORS
+The following error codes may be set in
+.Va errno :
+.Bl -tag -width Er
+.It Bq Er ENAMETOOLONG
+The path component to be returned was larger than
+.Dv MAXPATHLEN .
+.El

 .Sh SEE ALSO
 .Xr basename 1 ,
 .Xr dirname 1 ,
 .Sh SEE ALSO
 .Xr basename 1 ,
 .Xr dirname 1 ,


@@ -122,4 +111,4 @@ function first appeared in
 and
 .Fx 4.2 .
 .Sh AUTHORS
 and
 .Fx 4.2 .
 .Sh AUTHORS

-.An "Todd C. Miller" Aq Todd.Miller@courtesan.com
+.An "Todd C. Miller"