472351e13d
.In header.h instead of .Fd #include \*[Lt]header.h\*[Gt] Much easier to read and write, and supported by groff for ages. Okayed by ross.
102 lines
3.1 KiB
Groff
102 lines
3.1 KiB
Groff
.\" $NetBSD: basename.3,v 1.10 2003/04/16 13:34:35 wiz Exp $
|
|
.\"
|
|
.\" Copyright (c) 1997, 2002 The NetBSD Foundation, Inc.
|
|
.\" All rights reserved.
|
|
.\"
|
|
.\" This code is derived from software contributed to The NetBSD Foundation
|
|
.\" by Klaus Klein and Jason R. Thorpe.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\" 3. All advertising materials mentioning features or use of this software
|
|
.\" must display the following acknowledgement:
|
|
.\" This product includes software developed by the NetBSD
|
|
.\" Foundation, Inc. and its contributors.
|
|
.\" 4. Neither the name of The NetBSD Foundation nor the names of its
|
|
.\" contributors may be used to endorse or promote products derived
|
|
.\" from this software without specific prior written permission.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
|
|
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
|
|
.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
|
|
.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
.\" POSSIBILITY OF SUCH DAMAGE.
|
|
.\"
|
|
.Dd October 16, 2002
|
|
.Dt BASENAME 3
|
|
.Os
|
|
.Sh NAME
|
|
.Nm basename
|
|
.Nd return the last component of a pathname
|
|
.Sh LIBRARY
|
|
.Lb libc
|
|
.Sh SYNOPSIS
|
|
.In libgen.h
|
|
.Ft char *
|
|
.Fn basename "char *path"
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Fn basename
|
|
function takes the pathname pointed to by
|
|
.Ar path
|
|
and returns a pointer to the final component of the pathname,
|
|
deleting any trailing
|
|
.Sq /
|
|
characters.
|
|
.Pp
|
|
If
|
|
.Ar path
|
|
consists entirely of
|
|
.Sq /
|
|
characters,
|
|
.Fn basename
|
|
returns a pointer to the string
|
|
.Dq / .
|
|
.Pp
|
|
If
|
|
.Ar path
|
|
is a null pointer or points to an empty string,
|
|
.Fn basename
|
|
returns a pointer to the string
|
|
.Dq \&. .
|
|
.Sh RETURN VALUES
|
|
The
|
|
.Fn basename
|
|
function returns a pointer to the final component of
|
|
.Ar path .
|
|
.Sh SEE ALSO
|
|
.Xr dirname 3
|
|
.Sh STANDARDS
|
|
.Bl -bullet -compact
|
|
.It
|
|
.St -xpg4.2
|
|
.It
|
|
.St -p1003.1-2001
|
|
.El
|
|
.Sh BUGS
|
|
If the length of the result is longer than
|
|
.Dv PATH_MAX
|
|
bytes
|
|
.Pq including the terminating nul ,
|
|
the result will be truncated.
|
|
.Pp
|
|
The
|
|
.Fn basename
|
|
function returns a pointer to static storage that may be overwritten
|
|
by subsequent calls to
|
|
.Fn basename .
|
|
This is not strictly a bug; it is explicitly allowed by
|
|
.St -p1003.1-2001 .
|