Annotation of src/usr.bin/basename/basename.1, Revision 1.11
1.11 ! aaron 1: .\" $OpenBSD: basename.1,v 1.10 1999/11/20 07:45:56 dugsong Exp $
1.1 deraadt 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
1.4 deraadt 44: .Nm basename
45: .Nd return filename portion of pathname
1.1 deraadt 46: .Sh SYNOPSIS
47: .Nm basename
48: .Ar string
49: .Op Ar suffix
50: .Sh DESCRIPTION
1.7 aaron 51: .Nm
1.1 deraadt 52: deletes any prefix ending with the last slash
1.5 aaron 53: .Pq Sq \&/
1.1 deraadt 54: character present in
55: .Ar string ,
56: and a
57: .Ar suffix ,
58: if given.
59: The resulting filename is written to the standard output.
60: A non-existent suffix is ignored.
1.11 ! aaron 61: .Pp
! 62: The
! 63: .Nm
! 64: utility
! 65: exits 0 on success or >0 if an error occurred.
1.6 aaron 66: .Sh EXAMPLES
1.1 deraadt 67: The following line sets the shell variable
68: .Ev FOO
69: to
1.10 dugsong 70: .Pa tail :
1.1 deraadt 71: .Pp
1.10 dugsong 72: .Dl FOO=`basename /usr/bin/tail`
1.1 deraadt 73: .Sh SEE ALSO
1.5 aaron 74: .Xr csh 1 ,
1.4 deraadt 75: .Xr dirname 1 ,
1.8 aaron 76: .Xr sh 1 ,
77: .Xr basename 3
1.1 deraadt 78: .Sh STANDARDS
79: The
1.7 aaron 80: .Nm
81: utility conforms to
1.1 deraadt 82: .St -p1003.2-92 .