1.\" $NetBSD: basename.3,v 1.9 2002/10/17 08:41:48 wiz Exp $ 2.\" 3.\" Copyright (c) 1997, 2002 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 and Jason R. Thorpe. 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 October 16, 2002 38.Dt BASENAME 3 39.Os 40.Sh NAME 41.Nm basename 42.Nd return the last component of a pathname 43.Sh LIBRARY 44.Lb libc 45.Sh SYNOPSIS 46.Fd #include \*[Lt]libgen.h\*[Gt] 47.Ft char * 48.Fn basename "char *path" 49.Sh DESCRIPTION 50The 51.Fn basename 52function takes the pathname pointed to by 53.Ar path 54and returns a pointer to the final component of the pathname, 55deleting any trailing 56.Sq / 57characters. 58.Pp 59If 60.Ar path 61consists entirely of 62.Sq / 63characters, 64.Fn basename 65returns a pointer to the string 66.Dq / . 67.Pp 68If 69.Ar path 70is a null pointer or points to an empty string, 71.Fn basename 72returns a pointer to the string 73.Dq \&. . 74.Sh RETURN VALUES 75The 76.Fn basename 77function returns a pointer to the final component of 78.Ar path . 79.Sh SEE ALSO 80.Xr dirname 3 81.Sh STANDARDS 82.Bl -bullet -compact 83.It 84.St -xpg4.2 85.It 86.St -p1003.1-2001 87.El 88.Sh BUGS 89If the length of the result is longer than 90.Dv PATH_MAX 91bytes 92.Pq including the terminating nul , 93the result will be truncated. 94.Pp 95The 96.Fn basename 97function returns a pointer to static storage that may be overwritten 98by subsequent calls to 99.Fn basename . 100This is not strictly a bug; it is explicitly allowed by 101.St -p1003.1-2001 . 102