Annotation of src/usr.bin/basename/basename.1, Revision 1.13
1.13 ! jmc 1: .\" $OpenBSD: basename.1,v 1.12 2003/06/03 02:56:06 millert 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.
1.12 millert 18: .\" 3. Neither the name of the University nor the names of its contributors
1.1 deraadt 19: .\" may be used to endorse or promote products derived from this software
20: .\" without specific prior written permission.
21: .\"
22: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25: .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32: .\" SUCH DAMAGE.
33: .\"
34: .\" @(#)basename.1 8.2 (Berkeley) 4/18/94
35: .\"
36: .Dd April 18, 1994
37: .Dt BASENAME 1
38: .Os
39: .Sh NAME
1.4 deraadt 40: .Nm basename
41: .Nd return filename portion of pathname
1.1 deraadt 42: .Sh SYNOPSIS
43: .Nm basename
44: .Ar string
45: .Op Ar suffix
46: .Sh DESCRIPTION
1.7 aaron 47: .Nm
1.1 deraadt 48: deletes any prefix ending with the last slash
1.5 aaron 49: .Pq Sq \&/
1.1 deraadt 50: character present in
51: .Ar string ,
52: and a
53: .Ar suffix ,
54: if given.
55: The resulting filename is written to the standard output.
56: A non-existent suffix is ignored.
1.11 aaron 57: .Pp
58: The
59: .Nm
60: utility
61: exits 0 on success or >0 if an error occurred.
1.6 aaron 62: .Sh EXAMPLES
1.1 deraadt 63: The following line sets the shell variable
64: .Ev FOO
65: to
1.10 dugsong 66: .Pa tail :
1.1 deraadt 67: .Pp
1.10 dugsong 68: .Dl FOO=`basename /usr/bin/tail`
1.1 deraadt 69: .Sh SEE ALSO
1.5 aaron 70: .Xr csh 1 ,
1.4 deraadt 71: .Xr dirname 1 ,
1.8 aaron 72: .Xr sh 1 ,
73: .Xr basename 3
1.1 deraadt 74: .Sh STANDARDS
75: The
1.7 aaron 76: .Nm
1.13 ! jmc 77: utility is compliant with the
! 78: .St -p1003.1-2004
! 79: specification.