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.7 2004/07/02 23:52:10 ru Exp $
  29 .\"
  30 .Dd August 17, 1997
  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 .Fo basename
  40 .Fa "char *path"
  41 .Fc
  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 .Sh RETURN VALUES
  64 On successful completion,
  65 .Fn basename
  66 returns a pointer to the last component of
  67 .Fa path .
  68 .Pp
  69 If
  70 .Fn basename
  71 fails, a null pointer is returned and the global variable
  72 .Va errno
  73 is set to indicate the error.
  74 .Sh ERRORS
  75 The following error codes may be set in
  76 .Va errno :
  77 .Bl -tag -width Er
  78 .It Bq Er ENAMETOOLONG
  79 The path component to be returned was larger than
  80 .Dv MAXPATHLEN .
  81 .El
  82 .Sh WARNINGS
  83 The
  84 .Fn basename
  85 function
  86 returns a pointer to internal static storage space
  87 that will be overwritten by subsequent calls.
  88 The function may modify the string pointed to by
  89 .Fa path .
  90 .Sh LEGACY SYNOPSIS
  91 .Fd #include <libgen.h>
  92 .Pp
  93 .Ft char *
  94 .br
  95 .Fo basename
  96 .Fa "const char *path"
  97 .Fc ;
  98 .Pp
  99 In legacy mode,
 100 .Fa path
 101 will not be changed.
 102 .Sh SEE ALSO
 103 .Xr basename 1 ,
 104 .Xr dirname 1 ,
 105 .Xr dirname 3 ,
 106 .Xr compat 5
 107 .Sh STANDARDS
 108 The
 109 .Fn basename
 110 function conforms to
 111 .St -xpg4.2 .
 112 .Sh HISTORY
 113 The
 114 .Fn basename
 115 function first appeared in
 116 .Ox 2.2
 117 and
 118 .Fx 4.2 .
 119 .Sh AUTHORS
 120 .An "Todd C. Miller" Aq Todd.Miller@courtesan.com