xref: /freebsd/usr.bin/basename/basename.1 (revision 23f282aa31e9b6fceacd449020e936e98d6f2298)
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. 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	8.2 (Berkeley) 4/18/94
36.\" $FreeBSD$
37.\"
38.Dd April 18, 1994
39.Dt BASENAME 1
40.Os
41.Sh NAME
42.Nm basename , dirname
43.Nd return filename or directory portion of pathname
44.Sh SYNOPSIS
45.Nm basename
46.Ar string
47.Op Ar suffix
48.Nm dirname
49.Ar string
50.Sh DESCRIPTION
51.Nm Basename
52deletes any prefix ending with the last slash
53.Ql \&/
54character present in
55.Ar string
56(after first stripping trailing slashes),
57and a
58.Ar suffix ,
59if given.
60The
61.Ar suffix
62is not stripped if it is identical to the remaining characters in
63.Ar string .
64The resulting filename is written to the standard output.
65A non-existent suffix is ignored.
66.Pp
67.Nm Dirname
68deletes the filename portion, beginning
69with the last slash
70.Ql \&/
71character to the end of
72.Ar string
73(after first stripping trailing slashes),
74and writes the result to the standard output.
75.Sh EXAMPLES
76The following line sets the shell variable
77.Ev FOO
78to
79.Pa /usr/bin .
80.Pp
81.Dl FOO=`dirname /usr/bin/trail`
82.Sh  DIAGNOSTICS
83Both the
84.Nm
85and
86.Nm dirname
87utilities exit 0 on success, and >0 if an error occurs.
88.Sh SEE ALSO
89.Xr csh 1 ,
90.Xr sh 1
91.Sh STANDARDS
92The
93.Nm
94and
95.Nm dirname
96functions are expected to be POSIX 1003.2 compatible.
97