xref: /freebsd/lib/libc/gen/basename.3 (revision 2be1a816b9ff69588e55be0a84cbe2a31efc0f2f)
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$
29.\"
30.Dd October 12, 2006
31.Dt BASENAME 3
32.Os
33.Sh NAME
34.Nm basename
35.Nd extract the base portion of a pathname
36.Sh SYNOPSIS
37.In libgen.h
38.Ft char *
39.Fn basename "const char *path"
40.Sh DESCRIPTION
41The
42.Fn basename
43function
44returns the last component from the pathname pointed to by
45.Fa path ,
46deleting any trailing
47.Sq \&/
48characters.
49If
50.Fa path
51consists entirely of
52.Sq \&/
53characters, a pointer to the string
54.Qq \&/
55is returned.
56If
57.Fa path
58is a null pointer or the empty string, a pointer to the string
59.Qq \&.
60is returned.
61.Sh IMPLEMENTATION NOTES
62The
63.Fn basename
64function
65returns a pointer to internal storage space allocated on the first call
66that will be overwritten
67by subsequent calls.
68.Sh RETURN VALUES
69On successful completion,
70.Fn basename
71returns a pointer to the last component of
72.Fa path .
73.Pp
74If
75.Fn basename
76fails, a null pointer is returned and the global variable
77.Va errno
78is set to indicate the error.
79.Sh ERRORS
80The following error codes may be set in
81.Va errno :
82.Bl -tag -width Er
83.It Bq Er ENAMETOOLONG
84The path component to be returned was larger than
85.Dv MAXPATHLEN .
86.El
87.Sh SEE ALSO
88.Xr basename 1 ,
89.Xr dirname 1 ,
90.Xr dirname 3
91.Sh STANDARDS
92The
93.Fn basename
94function conforms to
95.St -xpg4.2 .
96.Sh HISTORY
97The
98.Fn basename
99function first appeared in
100.Ox 2.2
101and
102.Fx 4.2 .
103.Sh AUTHORS
104.An "Todd C. Miller" Aq Todd.Miller@courtesan.com
105