lib/libc/gen/basename.3

   1 .\"
   2 .\" Copyright (c) 1997 Todd C. Miller <Todd.Miller@courtesan.com>
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" 3. The name of the author may not be used to endorse or promote products
  14 .\"    derived from this software without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
  17 .\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  18 .\" AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
  19 .\" THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  20 .\" EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  21 .\" PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  22 .\" OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  23 .\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  24 .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  25 .\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26 .\"
  27 .\" $OpenBSD: basename.3,v 1.12 2000/04/18 03:01:25 aaron Exp $
  28 .\" $FreeBSD$
  29 .\"
  30 .Dd October 6, 2009
  31 .Dt BASENAME 3
  32 .Os
  33 .Sh NAME
  34 .Nm basename
  35 .Nd extract the base portion of a pathname
  36 .Sh SYNOPSIS
  37 .In libgen.h
  38 .Ft char *
  39 .Fn basename "const char *path"
  40 .Ft char *
  41 .Fn basename_r "const char *path" "char *bname"
  42 .Sh DESCRIPTION
  43 The
  44 .Fn basename
  45 function
  46 returns the last component from the pathname pointed to by
  47 .Fa path ,
  48 deleting any trailing
  49 .Sq \&/
  50 characters.
  51 If
  52 .Fa path
  53 consists entirely of
  54 .Sq \&/
  55 characters, a pointer to the string
  56 .Qq \&/
  57 is returned.
  58 If
  59 .Fa path
  60 is a null pointer or the empty string, a pointer to the string
  61 .Qq \&.
  62 is returned.
  63 .Pp
  64 The
  65 .Fn basename_r
  66 variation accepts a buffer of at least
  67 .Dv MAXPATHLEN
  68 bytes in which to store the resulting component.
  69 .Sh IMPLEMENTATION NOTES
  70 The
  71 .Fn basename
  72 function
  73 returns a pointer to internal storage space allocated on the first call
  74 that will be overwritten
  75 by subsequent calls.
  76 .Fn basename_r
  77 is therefore preferred for threaded applications.
  78 .Sh RETURN VALUES
  79 On successful completion,
  80 .Fn basename
  81 and
  82 .Fn basename_r
  83 return pointers to the last component of
  84 .Fa path .
  85 .Pp
  86 If they fail, a null pointer is returned and the global variable
  87 .Va errno
  88 is set to indicate the error.
  89 .Sh ERRORS
  90 The following error codes may be set in
  91 .Va errno :
  92 .Bl -tag -width Er
  93 .It Bq Er ENAMETOOLONG
  94 The path component to be returned was larger than
  95 .Dv MAXPATHLEN .
  96 .El
  97 .Sh SEE ALSO
  98 .Xr basename 1 ,
  99 .Xr dirname 1 ,
 100 .Xr dirname 3
 101 .Sh STANDARDS
 102 The
 103 .Fn basename
 104 function conforms to
 105 .St -xpg4.2 .
 106 .Sh HISTORY
 107 The
 108 .Fn basename
 109 function first appeared in
 110 .Ox 2.2
 111 and
 112 .Fx 4.2 .
 113 .Sh AUTHORS
 114 .An "Todd C. Miller" Aq Todd.Miller@courtesan.com