xref: /freebsd/usr.bin/basename/basename.1 (revision 05248206f720394d95c2a7475429311df670a2e9)
1.\" Copyright (c) 1990, 1993, 1994
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" This code is derived from software contributed to Berkeley by
5.\" the Institute of Electrical and Electronics Engineers, Inc.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\" 3. Neither the name of the University nor the names of its contributors
16.\"    may be used to endorse or promote products derived from this software
17.\"    without specific prior written permission.
18.\"
19.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29.\" SUCH DAMAGE.
30.\"
31.\"     @(#)basename.1	8.2 (Berkeley) 4/18/94
32.\"
33.Dd June 21, 2021
34.Dt BASENAME 1
35.Os
36.Sh NAME
37.Nm basename , dirname
38.Nd return filename or directory portion of pathname
39.Sh SYNOPSIS
40.Nm
41.Ar string
42.Op Ar suffix
43.Nm
44.Op Fl a
45.Op Fl s Ar suffix
46.Ar string
47.Op Ar ...
48.Nm dirname
49.Ar string
50.Op Ar ...
51.Sh DESCRIPTION
52The
53.Nm
54utility deletes any prefix ending with the last slash
55.Ql \&/
56character present in
57.Ar string
58(after first stripping trailing slashes),
59and a
60.Ar suffix ,
61if given.
62The
63.Ar suffix
64is not stripped if it is identical to the remaining characters in
65.Ar string .
66The resulting filename is written to the standard output.
67A non-existent suffix is ignored.
68If
69.Fl a
70is specified, then every argument is treated as a
71.Ar string
72as if
73.Nm
74were invoked with just one argument.
75If
76.Fl s
77is specified, then the
78.Ar suffix
79is taken as its argument, and all other arguments are treated as a
80.Ar string .
81.Pp
82The
83.Nm dirname
84utility deletes the filename portion, beginning
85with the last slash
86.Ql \&/
87character to the end of
88.Ar string
89(after first stripping trailing slashes),
90and writes the result to the standard output.
91.Sh EXIT STATUS
92.Ex -std basename dirname
93.Sh EXAMPLES
94The following line sets the shell variable
95.Ev FOO
96to
97.Pa /usr/bin .
98.Pp
99.Dl FOO=`dirname /usr/bin/trail`
100.Sh SEE ALSO
101.Xr csh 1 ,
102.Xr sh 1 ,
103.Xr basename 3 ,
104.Xr dirname 3
105.Sh STANDARDS
106The
107.Nm
108and
109.Nm dirname
110utilities are expected to be
111.St -p1003.2
112compatible.
113.Sh HISTORY
114The
115.Nm
116utility first appeared in
117.At v7 .
118The
119.Nm dirname
120utility first appeared in
121.At III .
122