logo

oasis-root

Compiled tree of Oasis Linux based on own branch at <https://hacktivis.me/git/oasis/> git clone https://anongit.hacktivis.me/git/oasis-root.git

basename.3p (4096B)

    

  1. '\" et
  2. .TH BASENAME "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
  3. .\"
  4. .SH PROLOG
  5. This manual page is part of the POSIX Programmer's Manual.
  6. The Linux implementation of this interface may differ (consult
  7. the corresponding Linux manual page for details of Linux behavior),
  8. or the interface may not be implemented on Linux.
  9. .\"
  10. .SH NAME
  11. basename
  12. \(em return the last component of a pathname
  13. .SH SYNOPSIS
  14. .LP
  15. .nf
  16. #include <libgen.h>
  17. .P
  18. char *basename(char *\fIpath\fP);
  19. .fi
  20. .SH DESCRIPTION
  21. The
  22. \fIbasename\fR()
  23. function shall take the pathname pointed to by
  24. .IR path
  25. and return a pointer to the final component of the pathname, deleting
  26. any trailing
  27. .BR '/' 
  28. characters.
  29. .P
  30. If the string pointed to by
  31. .IR path
  32. consists entirely of the
  33. .BR '/' 
  34. character,
  35. \fIbasename\fR()
  36. shall return a pointer to the string
  37. .BR \(dq/\(dq .
  38. If the string pointed to by
  39. .IR path
  40. is exactly
  41. .BR \(dq//\(dq ,
  42. it is implementation-defined whether
  43. .BR '/' 
  44. or
  45. .BR \(dq//\(dq 
  46. is returned.
  47. .P
  48. If
  49. .IR path
  50. is a null pointer or points to an empty string,
  51. \fIbasename\fR()
  52. shall return a pointer to the string
  53. .BR \(dq.\(dq .
  54. .P
  55. The
  56. \fIbasename\fR()
  57. function may modify the string pointed to by
  58. .IR path ,
  59. and may return a pointer to internal storage. The returned pointer
  60. might be invalidated or the storage might be overwritten by a
  61. subsequent call to
  62. \fIbasename\fR().
  63. The returned pointer might also be invalidated if the calling
  64. thread is terminated.
  65. .P
  66. The
  67. \fIbasename\fR()
  68. function need not be thread-safe.
  69. .SH "RETURN VALUE"
  70. The
  71. \fIbasename\fR()
  72. function shall return a pointer to the final component of
  73. .IR path .
  74. .SH ERRORS
  75. No errors are defined.
  76. .LP
  77. .IR "The following sections are informative."
  78. .SH EXAMPLES
  79. .SS "Using basename(\|)"
  80. .P
  81. The following program fragment returns a pointer to the value
  82. .IR lib ,
  83. which is the base name of
  84. .BR /usr/lib .
  85. .sp
  86. .RS 4
  87. .nf
  89. #include <libgen.h>
  90. \&...
  91. char name[] = "/usr/lib";
  92. char *base;
  93. .P
  94. base = basename(name);
  95. \&...
  96. .fi
  97. .P
  98. .RE
  99. .SS "Sample Input and Output Strings for the basename(\|) and dirname(\|) Functions and the basename and dirname Utilities"
  100. .S -1
  101. .TS
  102. center box tab(!);
  103. cB | cB | cB | cB | cB | cB
  104. cB | cB | cB | cB | cB | cB
  105. cB | cB | cB | cB | cB | cB
  106. cB | cB | cB | cB | cB | cB
  107. lf51 | lf51 | lf51 | lf51 | lf51 | lf5.
  108. basename(\|)!!!basename!Output!Output
  109. and dirname(\|)!String!String!and dirname!Written by!Written by
  110. Functions path!Returned by!Returned by!Utilities!basename!dirname
  111. Argument!basename(\|)!dirname(\|)!string Operand!Utility!Utility
  112. _
  113. "usr"!"usr"!"."!usr!usr!.
  114. _
  115. "usr/"!"usr"!"."!usr/!usr!.
  116. _
  117. ""!"."!"."!""!. \fRor empty string\fR!.
  118. _
  119. "/"!"/"!"/"!/!/!/
  120. _
  121. "//"!"/" \fRor\fR "//"!"/" \fRor\fR "//"!//!/ \fRor\fR //!/ \fRor\fR //
  122. _
  123. "///"!"/"!"/"!///!/!/
  124. _
  125. "/usr/"!"usr"!"/"!/usr/!usr!/
  126. _
  127. "/usr/lib"!"lib"!"/usr"!/usr/lib!lib!/usr
  128. _
  129. "//usr//lib//"!"lib"!"//usr"!//usr//lib//!lib!//usr
  130. _
  131. "/home//dwc//!"test"!"/home//dwc"!/home//dwc//!test!/home//dwc
  132. test"!!!test
  133. .TE
  134. .S +1
  135. .SH "APPLICATION USAGE"
  136. None.
  137. .SH RATIONALE
  138. None.
  139. .SH "FUTURE DIRECTIONS"
  140. None.
  141. .SH "SEE ALSO"
  142. .IR "\fIdirname\fR\^(\|)"
  143. .P
  144. The Base Definitions volume of POSIX.1\(hy2017,
  145. .IR "\fB<libgen.h>\fP"
  146. .P
  147. The Shell and Utilities volume of POSIX.1\(hy2017,
  148. .IR "\fIbasename\fR\^"
  149. .\"
  150. .SH COPYRIGHT
  151. Portions of this text are reprinted and reproduced in electronic form
  152. from IEEE Std 1003.1-2017, Standard for Information Technology
  153. -- Portable Operating System Interface (POSIX), The Open Group Base
  154. Specifications Issue 7, 2018 Edition,
  155. Copyright (C) 2018 by the Institute of
  156. Electrical and Electronics Engineers, Inc and The Open Group.
  157. In the event of any discrepancy between this version and the original IEEE and
  158. The Open Group Standard, the original IEEE and The Open Group Standard
  159. is the referee document. The original Standard can be obtained online at
  160. http://www.opengroup.org/unix/online.html .
  161. .PP
  162. Any typographical or formatting errors that appear
  163. in this page are most likely
  164. to have been introduced during the conversion of the source files to
  165. man page format. To report such errors, see
  166. https://www.kernel.org/doc/man-pages/reporting_bugs.html .