logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

This manual page is part of the POSIX Programmer's Manual. The Linux implementation of this interface

Description

       The  basename()  function  shall  take  the pathname pointed to by path and return a pointer to the final
       component of the pathname, deleting any trailing '/' characters.

       If the string pointed to by path consists entirely of  the  '/'  character,  basename()  shall  return  a
       pointer  to  the  string  "/".   If  the string pointed to by path is exactly "//", it is implementation-
       defined whether '/' or "//" is returned.

       If path is a null pointer or points to an empty string, basename() shall return a pointer to  the  string
       ".".

       The  basename()  function  may modify the string pointed to by path, and may return a pointer to internal
       storage. The returned pointer might be invalidated or the storage might be overwritten  by  a  subsequent
       call to basename().  The returned pointer might also be invalidated if the calling thread is terminated.

       The basename() function need not be thread-safe.

Errors

       No errors are defined.

       Thefollowingsectionsareinformative.

Examples

Usingbasename()
       The following program fragment returns a pointer to the value lib, which is the base name of /usr/lib.

           #include <libgen.h>
           ...
           char name[] = "/usr/lib";
           char *base;

           base = basename(name);
           ...

   SampleInputandOutputStringsforthebasename()anddirname()FunctionsandthebasenameanddirnameUtilities
       .TS
               ┌───────────────┬───────────┬────────────┬──────────────┬─────────────────┬───────────┐
               │   basename()  │           │            │   basenameOutputOutput   │
               │ anddirname()StringStringanddirnameWrittenbyWrittenby │
               │ FunctionspathReturnedbyReturnedbyUtilitiesbasenamedirname   │
               │    Argumentbasename()dirname()stringOperandUtilityUtility   │
               ├───────────────┼───────────┼────────────┼──────────────┼─────────────────┼───────────┤
               │ "usr"         │"usr"      │"."         │usr           │usr              │.          │
               ├───────────────┼───────────┼────────────┼──────────────┼─────────────────┼───────────┤
               │ "usr/"        │"usr"      │"."         │usr/          │usr              │.          │
               ├───────────────┼───────────┼────────────┼──────────────┼─────────────────┼───────────┤
               │ ""            │"."        │"."         │""            │. or empty string│.          │
               ├───────────────┼───────────┼────────────┼──────────────┼─────────────────┼───────────┤
               │ "/"           │"/"        │"/"         │/             │/                │/          │
               ├───────────────┼───────────┼────────────┼──────────────┼─────────────────┼───────────┤
               │ "//"          │"/" or "//"│"/" or "//" │//            │/ or //          │/ or //    │
               ├───────────────┼───────────┼────────────┼──────────────┼─────────────────┼───────────┤
               │ "///"         │"/"        │"/"         │///           │/                │/          │
               ├───────────────┼───────────┼────────────┼──────────────┼─────────────────┼───────────┤
               │ "/usr/"       │"usr"      │"/"         │/usr/         │usr              │/          │
               ├───────────────┼───────────┼────────────┼──────────────┼─────────────────┼───────────┤
               │ "/usr/lib"    │"lib"      │"/usr"      │/usr/lib      │lib              │/usr       │
               ├───────────────┼───────────┼────────────┼──────────────┼─────────────────┼───────────┤
               │ "//usr//lib//"│"lib"      │"//usr"     │//usr//lib//  │lib              │//usr      │
               ├───────────────┼───────────┼────────────┼──────────────┼─────────────────┼───────────┤
               │ "/home//dwc// │"test"     │"/home//dwc"│/home//dwc//  │test             │/home//dwc │
               │ test"         │           │            │test          │                 │           │
               └───────────────┴───────────┴────────────┴──────────────┴─────────────────┴───────────┘
       .SH "APPLICATION USAGE" None.

Future Directions

       None.

Name

       basename — return the last component of a pathname

Prolog

       This  manual  page  is part of the POSIX Programmer's Manual.  The Linux implementation of this interface
       may differ (consult the corresponding Linux manual page for details of Linux behavior), or the  interface
       may not be implemented on Linux.

Rationale

       None.

Return Value

       The basename() function shall return a pointer to the final component of path.

See Also

dirname()

       The Base Definitions volume of POSIX.1‐2017, <libgen.h>

       The Shell and Utilities volume of POSIX.1‐2017, basename

Synopsis

       #include <libgen.h>

       char *basename(char *path);

See Also