Aren
/
NetBSD
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
NetBSD/lib/libc/gen/dirname.3

105 lines
3.3 KiB
Groff
Raw Normal View History

Use .Dq and .Sq.
2002-10-17 12:41:38 +04:00
.\" $NetBSD: dirname.3,v 1.9 2002/10/17 08:41:38 wiz Exp $
Add basename() and dirname(), from XPG4.2.
1997-11-02 19:48:25 +03:00
.\"
Change basename(3) and dirname(3) to return a pointer to static storage, rather than modifying their input arguments. While not reentrant, this is explcitly allowed by IEEE Std 1003.1-2001 (which allows either behavior, stating that it is implementation-dependent). The new semantics are considered less hostile/more useful by most programs which use basename(3) and/or dirname(3) (several programs in the NetBSD tree reimplement basename()/dirname() themselves to avoid modification of the input argument). This new implementation truncates results to PATH_MAX. The Std does not address this in the static storage case. However since PATH_MAX is the maximum pathname length in the Std, this should not be a problem in practice. Nontheless, it is noted in the BUGS section. See the basename(3)/dirname(3) regression tests in src/regress/lib/libc. Inspired by discussion with Niels Provos, related to PR 18647.
2002-10-17 06:06:04 +04:00
.\" Copyright (c) 1997, 2002 The NetBSD Foundation, Inc.
Add basename() and dirname(), from XPG4.2.
1997-11-02 19:48:25 +03:00
.\" All rights reserved.
.\"
.\" This code is derived from software contributed to The NetBSD Foundation
Change basename(3) and dirname(3) to return a pointer to static storage, rather than modifying their input arguments. While not reentrant, this is explcitly allowed by IEEE Std 1003.1-2001 (which allows either behavior, stating that it is implementation-dependent). The new semantics are considered less hostile/more useful by most programs which use basename(3) and/or dirname(3) (several programs in the NetBSD tree reimplement basename()/dirname() themselves to avoid modification of the input argument). This new implementation truncates results to PATH_MAX. The Std does not address this in the static storage case. However since PATH_MAX is the maximum pathname length in the Std, this should not be a problem in practice. Nontheless, it is noted in the BUGS section. See the basename(3)/dirname(3) regression tests in src/regress/lib/libc. Inspired by discussion with Niels Provos, related to PR 18647.
2002-10-17 06:06:04 +04:00
.\" by Klaus Klein and Jason R. Thorpe.
Add basename() and dirname(), from XPG4.2.
1997-11-02 19:48:25 +03:00
.\"
.\" 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. All advertising materials mentioning features or use of this software
.\" must display the following acknowledgement:
.\" This product includes software developed by the NetBSD
.\" Foundation, Inc. and its contributors.
.\" 4. Neither the name of The NetBSD Foundation nor the names of its
.\" contributors may be used to endorse or promote products derived
.\" from this software without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
.\" ``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 FOUNDATION OR CONTRIBUTORS
.\" 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.
.\"
Change basename(3) and dirname(3) to return a pointer to static storage, rather than modifying their input arguments. While not reentrant, this is explcitly allowed by IEEE Std 1003.1-2001 (which allows either behavior, stating that it is implementation-dependent). The new semantics are considered less hostile/more useful by most programs which use basename(3) and/or dirname(3) (several programs in the NetBSD tree reimplement basename()/dirname() themselves to avoid modification of the input argument). This new implementation truncates results to PATH_MAX. The Std does not address this in the static storage case. However since PATH_MAX is the maximum pathname length in the Std, this should not be a problem in practice. Nontheless, it is noted in the BUGS section. See the basename(3)/dirname(3) regression tests in src/regress/lib/libc. Inspired by discussion with Niels Provos, related to PR 18647.
2002-10-17 06:06:04 +04:00
.Dd October 16, 2002
Add basename() and dirname(), from XPG4.2.
1997-11-02 19:48:25 +03:00
.Dt DIRNAME 3
Last of the .Os cleanups. .Os is defined in the tmac.doc-common file, so we shouldn't override it with versions in the manpages. Wheee!
1999-03-22 22:44:33 +03:00
.Os
Add basename() and dirname(), from XPG4.2.
1997-11-02 19:48:25 +03:00
.Sh NAME
.Nm dirname
.Nd report the parent directory name of a file pathname
add LIBRARY section to man page
1998-02-05 21:45:17 +03:00
.Sh LIBRARY
.Lb libc
Add basename() and dirname(), from XPG4.2.
1997-11-02 19:48:25 +03:00
.Sh SYNOPSIS
Generate <>& symbolically.
2002-02-07 10:00:09 +03:00
.Fd #include \*[Lt]libgen.h\*[Gt]
Add basename() and dirname(), from XPG4.2.
1997-11-02 19:48:25 +03:00
.Ft char *
.Fn dirname "char *path"
.Sh DESCRIPTION
The
.Fn dirname
function takes a pointer to a character string that contains a pathname,
.Ar path ,
and returns a pointer to a string that is a pathname of the parent directory of
.Ar path .
Use .Dq and .Sq.
2002-10-17 12:41:38 +04:00
Trailing
.Sq /
characters in
Add basename() and dirname(), from XPG4.2.
1997-11-02 19:48:25 +03:00
.Ar path
are not counted as part of the path.
.Pp
If
.Ar path
Use .Dq and .Sq.
2002-10-17 12:41:38 +04:00
does not contain a
.Sq / ,
then
Add basename() and dirname(), from XPG4.2.
1997-11-02 19:48:25 +03:00
.Fn dirname
Use .Dq and .Sq.
2002-10-17 12:41:38 +04:00
returns a pointer to the string
.Dq \&. .
Add basename() and dirname(), from XPG4.2.
1997-11-02 19:48:25 +03:00
.Pp
If
.Ar path
is a null pointer or points to an empty string,
.Fn dirname
Use .Dq and .Sq.
2002-10-17 12:41:38 +04:00
returns a pointer to the string
.Dq \&. .
Add basename() and dirname(), from XPG4.2.
1997-11-02 19:48:25 +03:00
.Sh RETURN VALUES
The
.Fn dirname
function returns a pointer to a string that is the parent directory of
.Ar path .
.Sh SEE ALSO
.Xr basename 3
.Sh STANDARDS
.Bl -bullet -compact
Boring whitespace fixes.
2001-09-16 06:30:23 +04:00
.It
Add basename() and dirname(), from XPG4.2.
1997-11-02 19:48:25 +03:00
.St -xpg4.2
Change basename(3) and dirname(3) to return a pointer to static storage, rather than modifying their input arguments. While not reentrant, this is explcitly allowed by IEEE Std 1003.1-2001 (which allows either behavior, stating that it is implementation-dependent). The new semantics are considered less hostile/more useful by most programs which use basename(3) and/or dirname(3) (several programs in the NetBSD tree reimplement basename()/dirname() themselves to avoid modification of the input argument). This new implementation truncates results to PATH_MAX. The Std does not address this in the static storage case. However since PATH_MAX is the maximum pathname length in the Std, this should not be a problem in practice. Nontheless, it is noted in the BUGS section. See the basename(3)/dirname(3) regression tests in src/regress/lib/libc. Inspired by discussion with Niels Provos, related to PR 18647.
2002-10-17 06:06:04 +04:00
.It
.St -p1003.1-2001
Boring whitespace fixes.
2001-09-16 06:30:23 +04:00
.El
Add basename() and dirname(), from XPG4.2.
1997-11-02 19:48:25 +03:00
.Sh BUGS
Change basename(3) and dirname(3) to return a pointer to static storage, rather than modifying their input arguments. While not reentrant, this is explcitly allowed by IEEE Std 1003.1-2001 (which allows either behavior, stating that it is implementation-dependent). The new semantics are considered less hostile/more useful by most programs which use basename(3) and/or dirname(3) (several programs in the NetBSD tree reimplement basename()/dirname() themselves to avoid modification of the input argument). This new implementation truncates results to PATH_MAX. The Std does not address this in the static storage case. However since PATH_MAX is the maximum pathname length in the Std, this should not be a problem in practice. Nontheless, it is noted in the BUGS section. See the basename(3)/dirname(3) regression tests in src/regress/lib/libc. Inspired by discussion with Niels Provos, related to PR 18647.
2002-10-17 06:06:04 +04:00
If the length of the result is longer than
.Dv PATH_MAX
bytes
.Pq including the terminating nul ,
the result will be truncated.
.Pp
Add basename() and dirname(), from XPG4.2.
1997-11-02 19:48:25 +03:00
The
.Fn dirname
Change basename(3) and dirname(3) to return a pointer to static storage, rather than modifying their input arguments. While not reentrant, this is explcitly allowed by IEEE Std 1003.1-2001 (which allows either behavior, stating that it is implementation-dependent). The new semantics are considered less hostile/more useful by most programs which use basename(3) and/or dirname(3) (several programs in the NetBSD tree reimplement basename()/dirname() themselves to avoid modification of the input argument). This new implementation truncates results to PATH_MAX. The Std does not address this in the static storage case. However since PATH_MAX is the maximum pathname length in the Std, this should not be a problem in practice. Nontheless, it is noted in the BUGS section. See the basename(3)/dirname(3) regression tests in src/regress/lib/libc. Inspired by discussion with Niels Provos, related to PR 18647.
2002-10-17 06:06:04 +04:00
function returns a pointer to static storage that may be overwritten
by subsequent calls to
.Fn dirname .
This is not strictly a bug; it is explicitly allowed by
.St -p1003.1-2001 .