|
Packit |
7cfc04 |
'\" et
|
|
Packit |
7cfc04 |
.TH BASENAME "3P" 2013 "IEEE/The Open Group" "POSIX Programmer's Manual"
|
|
Packit |
7cfc04 |
.SH PROLOG
|
|
Packit |
7cfc04 |
This manual page is part of the POSIX Programmer's Manual.
|
|
Packit |
7cfc04 |
The Linux implementation of this interface may differ (consult
|
|
Packit |
7cfc04 |
the corresponding Linux manual page for details of Linux behavior),
|
|
Packit |
7cfc04 |
or the interface may not be implemented on Linux.
|
|
Packit |
7cfc04 |
|
|
Packit |
7cfc04 |
.SH NAME
|
|
Packit |
7cfc04 |
basename
|
|
Packit |
7cfc04 |
\(em return the last component of a pathname
|
|
Packit |
7cfc04 |
.SH SYNOPSIS
|
|
Packit |
7cfc04 |
.LP
|
|
Packit |
7cfc04 |
.nf
|
|
Packit |
7cfc04 |
#include <libgen.h>
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
char *basename(char *\fIpath\fP);
|
|
Packit |
7cfc04 |
.fi
|
|
Packit |
7cfc04 |
.SH DESCRIPTION
|
|
Packit |
7cfc04 |
The
|
|
Packit |
7cfc04 |
\fIbasename\fR()
|
|
Packit |
7cfc04 |
function shall take the pathname pointed to by
|
|
Packit |
7cfc04 |
.IR path
|
|
Packit |
7cfc04 |
and return a pointer to the final component of the pathname, deleting
|
|
Packit |
7cfc04 |
any trailing
|
|
Packit |
7cfc04 |
.BR '/'
|
|
Packit |
7cfc04 |
characters.
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
If the string pointed to by
|
|
Packit |
7cfc04 |
.IR path
|
|
Packit |
7cfc04 |
consists entirely of the
|
|
Packit |
7cfc04 |
.BR '/'
|
|
Packit |
7cfc04 |
character,
|
|
Packit |
7cfc04 |
\fIbasename\fR()
|
|
Packit |
7cfc04 |
shall return a pointer to the string
|
|
Packit |
7cfc04 |
.BR \(dq/\(dq .
|
|
Packit |
7cfc04 |
If the string pointed to by
|
|
Packit |
7cfc04 |
.IR path
|
|
Packit |
7cfc04 |
is exactly
|
|
Packit |
7cfc04 |
.BR \(dq//\(dq ,
|
|
Packit |
7cfc04 |
it is implementation-defined whether
|
|
Packit |
7cfc04 |
.BR '/'
|
|
Packit |
7cfc04 |
or
|
|
Packit |
7cfc04 |
.BR \(dq//\(dq
|
|
Packit |
7cfc04 |
is returned.
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
If
|
|
Packit |
7cfc04 |
.IR path
|
|
Packit |
7cfc04 |
is a null pointer or points to an empty string,
|
|
Packit |
7cfc04 |
\fIbasename\fR()
|
|
Packit |
7cfc04 |
shall return a pointer to the string
|
|
Packit |
7cfc04 |
.BR \(dq.\(dq .
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
The
|
|
Packit |
7cfc04 |
\fIbasename\fR()
|
|
Packit |
7cfc04 |
function may modify the string pointed to by
|
|
Packit |
7cfc04 |
.IR path ,
|
|
Packit |
7cfc04 |
and may return a pointer to internal storage. The returned pointer might
|
|
Packit |
7cfc04 |
be invalidated or the storage might be overwritten by a subsequent call to
|
|
Packit |
7cfc04 |
\fIbasename\fR().
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
The
|
|
Packit |
7cfc04 |
\fIbasename\fR()
|
|
Packit |
7cfc04 |
function need not be thread-safe.
|
|
Packit |
7cfc04 |
.SH "RETURN VALUE"
|
|
Packit |
7cfc04 |
The
|
|
Packit |
7cfc04 |
\fIbasename\fR()
|
|
Packit |
7cfc04 |
function shall return a pointer to the final component of
|
|
Packit |
7cfc04 |
.IR path .
|
|
Packit |
7cfc04 |
.SH ERRORS
|
|
Packit |
7cfc04 |
No errors are defined.
|
|
Packit |
7cfc04 |
.LP
|
|
Packit |
7cfc04 |
.IR "The following sections are informative."
|
|
Packit |
7cfc04 |
.SH EXAMPLES
|
|
Packit |
7cfc04 |
.SS "Using basename(\|)"
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
The following program fragment returns a pointer to the value
|
|
Packit |
7cfc04 |
.IR lib ,
|
|
Packit |
7cfc04 |
which is the base name of
|
|
Packit |
7cfc04 |
.BR /usr/lib .
|
|
Packit |
7cfc04 |
.sp
|
|
Packit |
7cfc04 |
.RS 4
|
|
Packit |
7cfc04 |
.nf
|
|
Packit |
7cfc04 |
\fB
|
|
Packit |
7cfc04 |
#include <libgen.h>
|
|
Packit |
7cfc04 |
\&...
|
|
Packit |
7cfc04 |
char *name = "/usr/lib";
|
|
Packit |
7cfc04 |
char *base;
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
base = basename(name);
|
|
Packit |
7cfc04 |
\&...
|
|
Packit |
7cfc04 |
.fi \fR
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
.RE
|
|
Packit |
7cfc04 |
.SS "Sample Input and Output Strings for basename(\|)"
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
In the following table, the input string is the value pointed to by
|
|
Packit |
7cfc04 |
.IR path ,
|
|
Packit |
7cfc04 |
and the output string is the return value of the
|
|
Packit |
7cfc04 |
\fIbasename\fR()
|
|
Packit |
7cfc04 |
function.
|
|
Packit |
7cfc04 |
.TS
|
|
Packit |
7cfc04 |
center box tab(!);
|
|
Packit |
7cfc04 |
cB | cB
|
|
Packit |
7cfc04 |
lf5 | lf5.
|
|
Packit |
7cfc04 |
Input String!Output String
|
|
Packit |
7cfc04 |
_
|
|
Packit |
7cfc04 |
"/usr/lib"!"lib"
|
|
Packit |
7cfc04 |
"/usr/"!"usr"
|
|
Packit |
7cfc04 |
"/"!"/"
|
|
Packit |
7cfc04 |
"///"!"/"
|
|
Packit |
7cfc04 |
"//usr//lib//"!"lib"
|
|
Packit |
7cfc04 |
.TE
|
|
Packit |
7cfc04 |
.SH "APPLICATION USAGE"
|
|
Packit |
7cfc04 |
None.
|
|
Packit |
7cfc04 |
.SH RATIONALE
|
|
Packit |
7cfc04 |
None.
|
|
Packit |
7cfc04 |
.SH "FUTURE DIRECTIONS"
|
|
Packit |
7cfc04 |
None.
|
|
Packit |
7cfc04 |
.SH "SEE ALSO"
|
|
Packit |
7cfc04 |
.IR "\fIdirname\fR\^(\|)"
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
The Base Definitions volume of POSIX.1\(hy2008,
|
|
Packit |
7cfc04 |
.IR "\fB<libgen.h>\fP"
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
The Shell and Utilities volume of POSIX.1\(hy2008,
|
|
Packit |
7cfc04 |
.IR "\fIbasename\fR\^"
|
|
Packit |
7cfc04 |
.SH COPYRIGHT
|
|
Packit |
7cfc04 |
Portions of this text are reprinted and reproduced in electronic form
|
|
Packit |
7cfc04 |
from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology
|
|
Packit |
7cfc04 |
-- Portable Operating System Interface (POSIX), The Open Group Base
|
|
Packit |
7cfc04 |
Specifications Issue 7, Copyright (C) 2013 by the Institute of
|
|
Packit |
7cfc04 |
Electrical and Electronics Engineers, Inc and The Open Group.
|
|
Packit |
7cfc04 |
(This is POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) In the
|
|
Packit |
7cfc04 |
event of any discrepancy between this version and the original IEEE and
|
|
Packit |
7cfc04 |
The Open Group Standard, the original IEEE and The Open Group Standard
|
|
Packit |
7cfc04 |
is the referee document. The original Standard can be obtained online at
|
|
Packit |
7cfc04 |
http://www.unix.org/online.html .
|
|
Packit |
7cfc04 |
|
|
Packit |
7cfc04 |
Any typographical or formatting errors that appear
|
|
Packit |
7cfc04 |
in this page are most likely
|
|
Packit |
7cfc04 |
to have been introduced during the conversion of the source files to
|
|
Packit |
7cfc04 |
man page format. To report such errors, see
|
|
Packit |
7cfc04 |
https://www.kernel.org/doc/man-pages/reporting_bugs.html .
|