Annotation of src/lib/libc/gen/basename.3, Revision 1.3
1.3 ! garbled 1: .\" $NetBSD: basename.3,v 1.2 1998/02/05 18:45:54 perry Exp $
1.1 kleink 2: .\"
3: .\" Copyright (c) 1997 The NetBSD Foundation, Inc.
4: .\" All rights reserved.
5: .\"
6: .\" This code is derived from software contributed to The NetBSD Foundation
7: .\" by Klaus Klein.
8: .\"
9: .\" Redistribution and use in source and binary forms, with or without
10: .\" modification, are permitted provided that the following conditions
11: .\" are met:
12: .\" 1. Redistributions of source code must retain the above copyright
13: .\" notice, this list of conditions and the following disclaimer.
14: .\" 2. Redistributions in binary form must reproduce the above copyright
15: .\" notice, this list of conditions and the following disclaimer in the
16: .\" documentation and/or other materials provided with the distribution.
17: .\" 3. All advertising materials mentioning features or use of this software
18: .\" must display the following acknowledgement:
19: .\" This product includes software developed by the NetBSD
20: .\" Foundation, Inc. and its contributors.
21: .\" 4. Neither the name of The NetBSD Foundation nor the names of its
22: .\" contributors may be used to endorse or promote products derived
23: .\" from this software without specific prior written permission.
24: .\"
25: .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
26: .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
27: .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28: .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
29: .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30: .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31: .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32: .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33: .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34: .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35: .\" POSSIBILITY OF SUCH DAMAGE.
36: .\"
37: .Dd Oct 31, 1997
38: .Dt BASENAME 3
1.3 ! garbled 39: .Os
1.1 kleink 40: .Sh NAME
41: .Nm basename
42: .Nd return the last component of a pathname
1.2 perry 43: .Sh LIBRARY
44: .Lb libc
1.1 kleink 45: .Sh SYNOPSIS
46: .Fd #include <libgen.h>
47: .Ft char *
48: .Fn basename "char *path"
49: .Sh DESCRIPTION
50: The
51: .Fn basename
52: function takes the pathname pointed to by
53: .Ar path
54: and returns a pointer to the final component of the pathname,
55: deleting and trailing '/' characters.
56: .Pp
57: If
58: .Ar path
59: consists entirely of '/' characters,
60: .Fn basename
61: returns a pointer to the string "/".
62: .Pp
63: If
64: .Ar path
65: is a null pointer or points to an empty string,
66: .Fn basename
67: returns a pointer to the string ".".
68: .Pp
69: .Sh RETURN VALUES
70: The
71: .Fn basename
72: function returns a pointer to the final component of
73: .Ar path .
74: .Sh SEE ALSO
75: .Xr dirname 3
76: .Sh STANDARDS
77: .Bl -bullet -compact
78: .It
79: .St -xpg4.2
80: .El
81: .Sh BUGS
82: The
83: .Fn basename
84: function may modify the string pointed to by
85: .Ar path .
CVSweb <webmaster@jp.NetBSD.org>