34168b28e9
Now that the changes to the dirname(3) function had some time to settle, let's go ahead and use the same approach for replacing basename(3) by a simple implementation that modifies the input string, thereby making it thread-safe and guaranteed to succeed. Unlike dirname(3), this function already had a thread-safe variant basename_r(3). This function had its own set of problems, like having an upper bound on the pathname length. Keep this function around for compatibility, but remove most references from the man page. Make the man page more similar to that of dirname(3). As the basename_r(3) function is only provided by FreeBSD (and Bionic), depending on its use is even more implementation defined than assuming that basename(3) is thread-safe. Reviewed by: emaste Differential Revision: https://reviews.freebsd.org/D8382
89 lines
2.2 KiB
Groff
89 lines
2.2 KiB
Groff
.\" $OpenBSD: basename.3,v 1.20 2007/05/31 19:19:28 jmc Exp $
|
|
.\"
|
|
.\" Copyright (c) 1997 Todd C. Miller <Todd.Miller@courtesan.com>
|
|
.\"
|
|
.\" Permission to use, copy, modify, and distribute this software for any
|
|
.\" purpose with or without fee is hereby granted, provided that the above
|
|
.\" copyright notice and this permission notice appear in all copies.
|
|
.\"
|
|
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
.\"
|
|
.\" $FreeBSD$
|
|
.\"
|
|
.Dd October 29, 2016
|
|
.Dt BASENAME 3
|
|
.Os
|
|
.Sh NAME
|
|
.Nm basename
|
|
.Nd extract the base portion of a pathname
|
|
.Sh SYNOPSIS
|
|
.In libgen.h
|
|
.Ft char *
|
|
.Fn basename "char *path"
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Fn basename
|
|
function returns the last component from the pathname pointed to by
|
|
.Fa path ,
|
|
deleting any trailing
|
|
.Sq \&/
|
|
characters.
|
|
.Sh RETURN VALUES
|
|
If
|
|
.Fa path
|
|
consists entirely of
|
|
.Sq \&/
|
|
characters, a pointer to the string
|
|
.Qq \&/
|
|
is returned.
|
|
If
|
|
.Fa path
|
|
is a null pointer or the empty string, a pointer to the string
|
|
.Qq \&.
|
|
is returned.
|
|
Otherwise,
|
|
it returns a pointer to the last component of
|
|
.Fa path .
|
|
.Sh IMPLEMENTATION NOTES
|
|
This implementation of
|
|
.Fn basename
|
|
uses the buffer provided by the caller to store the resulting pathname
|
|
component.
|
|
Other vendor implementations may return a pointer to internal storage
|
|
space instead.
|
|
The advantage of the former approach is that it ensures thread-safety,
|
|
while also placing no upper limit on the supported length of the
|
|
pathname.
|
|
.Sh SEE ALSO
|
|
.Xr basename 1 ,
|
|
.Xr dirname 1 ,
|
|
.Xr dirname 3
|
|
.Sh STANDARDS
|
|
The
|
|
.Fn basename
|
|
function conforms to
|
|
.St -xpg4.2 .
|
|
.Sh HISTORY
|
|
The
|
|
.Fn basename
|
|
function first appeared in
|
|
.Ox 2.2
|
|
and
|
|
.Fx 4.2 .
|
|
.Pp
|
|
In
|
|
.Fx 12.0 ,
|
|
this function was reimplemented to store its result in the provided
|
|
input buffer.
|
|
There is no longer any need to use the
|
|
.Fn basename_r
|
|
function.
|
|
.Sh AUTHORS
|
|
.An Nuxi, the Netherlands
|