xref: /openbsd-src/lib/libc/gen/basename.3 (revision b2ea75c1b17e1a9a339660e7ed45cd24946b230e)
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.14 2001/08/06 10:42:25 mpech Exp $
28.\"
29.Dd August 17, 1997
30.Dt BASENAME 3
31.Os
32.Sh NAME
33.Nm basename
34.Nd extract the base portion of a pathname
35.Sh SYNOPSIS
36.Fd #include <libgen.h>
37.Ft char *
38.Fn basename "const char *path"
39.Sh DESCRIPTION
40The
41.Fn basename
42function returns the last component from the pathname pointed to by
43.Ar path ,
44deleting any trailing
45.Sq \&/
46characters.
47If
48.Ar path
49consists entirely of
50.Sq \&/
51characters, a pointer to the string
52.Qq \&/
53is returned.
54If
55.Ar path
56is a null pointer or the empty string, a pointer to the string
57.Qq \&.
58is returned.
59.Sh RETURN VALUES
60On successful completion,
61.Fn basename
62returns a pointer to the last component of
63.Ar path .
64.Pp
65If
66.Fn basename
67fails, a null pointer is returned and the global variable
68.Va errno
69is set to indicate the error.
70.Sh ERRORS
71The following error codes may be set in
72.Va errno :
73.Bl -tag -width Er
74.It Bq Er ENAMETOOLONG
75The path component to be returned was larger than
76.Dv MAXPATHLEN .
77.El
78.Sh WARNINGS
79.Fn basename
80returns a pointer to internal static storage space that will be overwritten
81by subsequent calls.
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 .
96.Sh AUTHORS
97Todd C. Miller <Todd.Miller@courtesan.com>
98