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