xref: /openbsd/usr.bin/basename/basename.1 (revision 78b63d65)
1.\"	$OpenBSD: basename.1,v 1.11 2000/03/04 21:12:01 aaron Exp $
2.\"	$NetBSD: basename.1,v 1.9 1995/03/25 18:17:45 glass Exp $
3.\"
4.\" Copyright (c) 1990, 1993, 1994
5.\"	The Regents of the University of California.  All rights reserved.
6.\"
7.\" This code is derived from software contributed to Berkeley by
8.\" the Institute of Electrical and Electronics Engineers, Inc.
9.\"
10.\" Redistribution and use in source and binary forms, with or without
11.\" modification, are permitted provided that the following conditions
12.\" are met:
13.\" 1. Redistributions of source code must retain the above copyright
14.\"    notice, this list of conditions and the following disclaimer.
15.\" 2. Redistributions in binary form must reproduce the above copyright
16.\"    notice, this list of conditions and the following disclaimer in the
17.\"    documentation and/or other materials provided with the distribution.
18.\" 3. All advertising materials mentioning features or use of this software
19.\"    must display the following acknowledgement:
20.\"	This product includes software developed by the University of
21.\"	California, Berkeley and its contributors.
22.\" 4. Neither the name of the University nor the names of its contributors
23.\"    may be used to endorse or promote products derived from this software
24.\"    without specific prior written permission.
25.\"
26.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36.\" SUCH DAMAGE.
37.\"
38.\"     @(#)basename.1	8.2 (Berkeley) 4/18/94
39.\"
40.Dd April 18, 1994
41.Dt BASENAME 1
42.Os
43.Sh NAME
44.Nm basename
45.Nd return filename portion of pathname
46.Sh SYNOPSIS
47.Nm basename
48.Ar string
49.Op Ar suffix
50.Sh DESCRIPTION
51.Nm
52deletes any prefix ending with the last slash
53.Pq Sq \&/
54character present in
55.Ar string ,
56and a
57.Ar suffix ,
58if given.
59The resulting filename is written to the standard output.
60A non-existent suffix is ignored.
61.Pp
62The
63.Nm
64utility
65exits 0 on success or >0 if an error occurred.
66.Sh EXAMPLES
67The following line sets the shell variable
68.Ev FOO
69to
70.Pa tail :
71.Pp
72.Dl FOO=`basename /usr/bin/tail`
73.Sh SEE ALSO
74.Xr csh 1 ,
75.Xr dirname 1 ,
76.Xr sh 1 ,
77.Xr basename 3
78.Sh STANDARDS
79The
80.Nm
81utility conforms to
82.St -p1003.2-92 .
83