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: src/lib/libc/gen/basename.3,v 1.1.2.5 2003/03/15 15:11:05 trhodes Exp $
  29 .\" $DragonFly: src/lib/libc/gen/basename.3,v 1.2 2003/06/17 04:26:42 dillon Exp $
  30 .\"
  31 .Dd August 17, 1997
  32 .Dt BASENAME 3
  33 .Os
  34 .Sh NAME
  35 .Nm basename
  36 .Nd extract the base portion of a pathname
  37 .Sh SYNOPSIS
  38 .In libgen.h
  39 .Ft char *
  40 .Fn basename "const char *path"
  41 .Sh DESCRIPTION
  42 The
  43 .Fn basename
  44 function
  45 returns the last component from the pathname pointed to by
  46 .Fa path ,
  47 deleting any trailing
  48 .Sq \&/
  49 characters.
  50 If
  51 .Fa path
  52 consists entirely of
  53 .Sq \&/
  54 characters, a pointer to the string
  55 .Qq \&/
  56 is returned.
  57 If
  58 .Fa path
  59 is a null pointer or the empty string, a pointer to the string
  60 .Qq \&.
  61 is returned.
  62 .Sh RETURN VALUES
  63 On successful completion,
  64 .Fn basename
  65 returns a pointer to the last component of
  66 .Fa path .
  67 .Pp
  68 If
  69 .Fn basename
  70 fails, a null pointer is returned and the global variable
  71 .Va errno
  72 is set to indicate the error.
  73 .Sh ERRORS
  74 The following error codes may be set in
  75 .Va errno :
  76 .Bl -tag -width Er
  77 .It Bq Er ENAMETOOLONG
  78 The path component to be returned was larger than
  79 .Dv MAXPATHLEN .
  80 .El
  81 .Sh WARNINGS
  82 The
  83 .Fn basename
  84 function
  85 returns a pointer to internal static storage space that will be overwritten
  86 by subsequent calls.
  87 .Sh SEE ALSO
  88 .Xr basename 1 ,
  89 .Xr dirname 1 ,
  90 .Xr dirname 3
  91 .Sh STANDARDS
  92 The
  93 .Fn basename
  94 function conforms to
  95 .St -xpg4.2 .
  96 .Sh HISTORY
  97 The
  98 .Fn basename
  99 function first appeared in
 100 .Ox 2.2
 101 and
 102 .Fx 4.2 .
 103 .Sh AUTHORS
 104 Todd C. Miller <Todd.Miller@courtesan.com>