usr/src/man/man3c/basename.3c

   1 '\" te
   2 .\"  Copyright 1989 AT&T  Copyright (c) 2002, Sun Microsystems, Inc.  All Rights Reserved  Portions Copyright (c) 1992, X/Open Company Limited  All Rights Reserved
   3 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   4 .\" http://www.opengroup.org/bookstore/.
   5 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   6 .\"  This notice shall appear on any product containing this material.
   7 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   9 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  10 .TH BASENAME 3C "Jul 24, 2002"
  11 .SH NAME
  12 basename \- return the last element of a path name
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 #include <libgen.h>
  17
  18 \fBchar *\fR\fBbasename\fR(\fBchar *\fR\fIpath\fR);
  19 .fi
  20
  21 .SH DESCRIPTION
  22 .sp
  23 .LP
  24 The \fBbasename()\fR function takes the pathname pointed to by \fIpath\fR and
  25 returns a pointer to the final component of the pathname, deleting any
  26 trailing '/' characters.
  27 .sp
  28 .LP
  29 If the string consists entirely of the '/' character, \fBbasename()\fR returns
  30 a pointer to the string "/" .
  31 .sp
  32 .LP
  33 If \fIpath\fR is a null pointer or points to an empty string, \fBbasename()\fR
  34 returns a pointer to the string "." .
  35 .SH RETURN VALUES
  36 .sp
  37 .LP
  38 The \fBbasename()\fR function returns a pointer to the final component of
  39 \fIpath\fR.
  40 .SH USAGE
  41 .sp
  42 .LP
  43 The \fBbasename()\fR function may modify the string pointed to by \fIpath\fR,
  44 and may return a pointer to static storage that may then be overwritten by a
  45 subsequent call to \fBbasename()\fR.
  46 .sp
  47 .LP
  48 When compiling multithreaded applications, the \fB_REENTRANT\fR flag must be
  49 defined on the compile line.  This flag should only be used in multithreaded
  50 applications.
  51 .SH EXAMPLES
  52 .LP
  53 \fBExample 1 \fRExamples for \fBInput String\fR and \fBOutput String\fR
  54 .sp
  55
  56 .sp
  57 .TS
  58 box;
  59 c | c
  60 l | l .
  61 \fBInput String\fR      \fBOutput String\fR
  62 _
  63 "/usr/lib"      "lib"
  64 _
  65 "/usr/" "usr"
  66 _
  67 "/"     "/"
  68 .TE
  69
  70 .SH ATTRIBUTES
  71 .sp
  72 .LP
  73 See \fBattributes\fR(5) for descriptions of the following attributes:
  74 .sp
  75
  76 .sp
  77 .TS
  78 box;
  79 c | c
  80 l | l .
  81 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  82 _
  83 Interface Stability     Standard
  84 _
  85 MT-Level        MT-Safe
  86 .TE
  87
  88 .SH SEE ALSO
  89 .sp
  90 .LP
  91 \fBbasename\fR(1), \fBdirname\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)