xref: /dragonfly/lib/libc/gen/basename.3 (revision 9348a738)
1.\"
2.\" Copyright (c) 1997 Todd C. Miller <Todd.Miller@courtesan.com>
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\" 3. The name of the author may not be used to endorse or promote products
14.\"    derived from this software without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
17.\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
18.\" AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
19.\" THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20.\" EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21.\" PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
22.\" OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
23.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
24.\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
25.\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26.\"
27.\" $OpenBSD: basename.3,v 1.12 2000/04/18 03:01:25 aaron Exp $
28.\" $FreeBSD: src/lib/libc/gen/basename.3,v 1.1.2.5 2003/03/15 15:11:05 trhodes Exp $
29.\" $DragonFly: src/lib/libc/gen/basename.3,v 1.3 2007/08/18 20:48:47 swildner Exp $
30.\"
31.Dd August 17, 1997
32.Dt BASENAME 3
33.Os
34.Sh NAME
35.Nm basename
36.Nd extract the base portion of a pathname
37.Sh LIBRARY
38.Lb libc
39.Sh SYNOPSIS
40.In libgen.h
41.Ft char *
42.Fn basename "const char *path"
43.Sh DESCRIPTION
44The
45.Fn basename
46function
47returns the last component from the pathname pointed to by
48.Fa path ,
49deleting any trailing
50.Sq \&/
51characters.
52If
53.Fa path
54consists entirely of
55.Sq \&/
56characters, a pointer to the string
57.Qq \&/
58is returned.
59If
60.Fa path
61is a null pointer or the empty string, a pointer to the string
62.Qq \&.
63is returned.
64.Sh RETURN VALUES
65On successful completion,
66.Fn basename
67returns a pointer to the last component of
68.Fa path .
69.Pp
70If
71.Fn basename
72fails, a null pointer is returned and the global variable
73.Va errno
74is set to indicate the error.
75.Sh ERRORS
76The following error codes may be set in
77.Va errno :
78.Bl -tag -width Er
79.It Bq Er ENAMETOOLONG
80The path component to be returned was larger than
81.Dv MAXPATHLEN .
82.El
83.Sh WARNINGS
84The
85.Fn basename
86function
87returns a pointer to internal static storage space that will be overwritten
88by subsequent calls.
89.Sh SEE ALSO
90.Xr basename 1 ,
91.Xr dirname 1 ,
92.Xr dirname 3
93.Sh STANDARDS
94The
95.Fn basename
96function conforms to
97.St -xpg4.2 .
98.Sh HISTORY
99The
100.Fn basename
101function first appeared in
102.Ox 2.2
103and
104.Fx 4.2 .
105.Sh AUTHORS
106.An Todd C. Miller Aq Mt Todd.Miller@courtesan.com
107