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