lib/libcr/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 .\"
  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 .Fn basename "const char *path"
  40 .Sh DESCRIPTION
  41 The
  42 .Fn basename
  43 function
  44 returns the last component from the pathname pointed to by
  45 .Fa path ,
  46 deleting any trailing
  47 .Sq \&/
  48 characters.
  49 If
  50 .Fa path
  51 consists entirely of
  52 .Sq \&/
  53 characters, a pointer to the string
  54 .Qq \&/
  55 is returned.
  56 If
  57 .Fa path
  58 is a null pointer or the empty string, a pointer to the string
  59 .Qq \&.
  60 is returned.
  61 .Sh RETURN VALUES
  62 On successful completion,
  63 .Fn basename
  64 returns a pointer to the last component of
  65 .Fa path .
  66 .Pp
  67 If
  68 .Fn basename
  69 fails, a null pointer is returned and the global variable
  70 .Va errno
  71 is set to indicate the error.
  72 .Sh ERRORS
  73 The following error codes may be set in
  74 .Va errno :
  75 .Bl -tag -width Er
  76 .It Bq Er ENAMETOOLONG
  77 The path component to be returned was larger than
  78 .Dv MAXPATHLEN .
  79 .El
  80 .Sh WARNINGS
  81 The
  82 .Fn basename
  83 function
  84 returns a pointer to internal static storage space that will be overwritten
  85 by subsequent calls.
  86 .Sh SEE ALSO
  87 .Xr basename 1 ,
  88 .Xr dirname 1 ,
  89 .Xr dirname 3
  90 .Sh STANDARDS
  91 The
  92 .Fn basename
  93 function conforms to
  94 .St -xpg4.2 .
  95 .Sh HISTORY
  96 The
  97 .Fn basename
  98 function first appeared in
  99 .Ox 2.2
 100 and
 101 .Fx 4.2 .
 102 .Sh AUTHORS
 103 Todd C. Miller <Todd.Miller@courtesan.com>