xref: /dragonfly/usr.bin/basename/basename.1 (revision f02303f9)
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: src/usr.bin/basename/basename.1,v 1.6.2.7 2002/07/15 04:11:27 keramida Exp $
37.\" $DragonFly: src/usr.bin/basename/basename.1,v 1.6 2005/08/05 22:35:11 swildner Exp $
38.\"
39.Dd April 18, 1994
40.Dt BASENAME 1
41.Os
42.Sh NAME
43.Nm basename ,
44.Nm dirname
45.Nd return filename or directory portion of pathname
46.Sh SYNOPSIS
47.Nm
48.Ar string
49.Op Ar suffix
50.Nm dirname
51.Ar string
52.Sh DESCRIPTION
53The
54.Nm
55utility deletes any prefix ending with the last slash
56.Ql \&/
57character present in
58.Ar string
59(after first stripping trailing slashes),
60and a
61.Ar suffix ,
62if given.
63The
64.Ar suffix
65is not stripped if it is identical to the remaining characters in
66.Ar string .
67The resulting filename is written to the standard output.
68A non-existent suffix is ignored.
69.Pp
70The
71.Nm dirname
72utility deletes the filename portion, beginning
73with the last slash
74.Ql \&/
75character to the end of
76.Ar string
77(after first stripping trailing slashes),
78and writes the result to the standard output.
79.Sh EXAMPLES
80The following line sets the shell variable
81.Ev FOO
82to
83.Pa /usr/bin .
84.Pp
85.Dl FOO=`dirname /usr/bin/trail`
86.Sh DIAGNOSTICS
87.Ex -std basename dirname
88.Sh SEE ALSO
89.Xr csh 1 ,
90.Xr sh 1
91.Sh STANDARDS
92The
93.Nm
94and
95.Nm dirname
96utilities are expected to be
97.St -p1003.2
98compatible.
99The
100.Nm
101utility does not conform to
102.St -p1003.1-2004 .
103The
104.Nm dirname
105utility conforms to
106.St -p1003.1-2004 .
107