xref: /386bsd/usr/src/usr.bin/basename/basename.1 (revision a2142627)
1.\" Copyright (c) 1990 The Regents of the University of California.
2.\" 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. All advertising materials mentioning features or use of this software
16.\"    must display the following acknowledgement:
17.\"	This product includes software developed by the University of
18.\"	California, Berkeley and its contributors.
19.\" 4. Neither the name of the University nor the names of its contributors
20.\"    may be used to endorse or promote products derived from this software
21.\"    without specific prior written permission.
22.\"
23.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33.\" SUCH DAMAGE.
34.\"
35.\"     @(#)basename.1	6.7 (Berkeley) 6/27/91
36.\"
37.Dd June 27, 1991
38.Dt BASENAME 1
39.Os
40.Sh NAME
41.Nm basename , dirname
42.Nd return filename or directory portion of pathname
43.Sh SYNOPSIS
44.Nm basename
45.Ar string
46.Op Ar suffix
47.Nm dirname
48.Ar string
49.Sh DESCRIPTION
50.Nm Basename
51deletes any prefix ending with the last slash
52.Ql \&/
53character present in
54.Ar string ,
55and a
56.Ar suffix ,
57if given.
58The resulting filename is written to the standard output.
59If
60.Ar string
61ends in the slash character,
62.Ql / ,
63or is the same as the
64.Ar suffix
65argument,
66a newline is output.
67A non-existant suffix is ignored.
68.Pp
69.Nm Dirname
70deletes the filename portion, beginning
71with the last slash
72.Ql \&/
73character to the end of
74.Ar string ,
75and writes the result to the standard output.
76.Sh EXAMPLES
77The following line sets the shell variable
78.Ev FOO
79to
80.Pa /usr/bin .
81.Pp
82.Dl FOO=`dirname /usr/bin/trail`
83.Pp
84Both the
85.Nm basename
86and
87.Nm dirname
88exit 0 on success, and >0 if an error occurs.
89.Sh SEE ALSO
90.Xr csh 1
91.Xr sh 1
92.Sh STANDARDS
93The
94.Nm basename
95and
96.Nm dirname
97functions are expected to be POSIX 1003.2 compatible.
98