Sync usage with man page.
[netbsd-mini2440.git] / usr.bin / basename / basename.1
blobee1e2d71704271bce607094e6d9aedcbae61a4a0
1 .\"     $NetBSD: basename.1,v 1.16 2003/08/07 11:13:10 agc 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. Neither the name of the University nor the names of its contributors
18 .\"    may be used to endorse or promote products derived from this software
19 .\"    without specific prior written permission.
20 .\"
21 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 .\" SUCH DAMAGE.
32 .\"
33 .\"     @(#)basename.1  8.2 (Berkeley) 4/18/94
34 .\"
35 .Dd April 18, 1994
36 .Dt BASENAME 1
37 .Os
38 .Sh NAME
39 .Nm basename ,
40 .Nm dirname
41 .Nd return filename or directory portion of pathname
42 .Sh SYNOPSIS
43 .Nm
44 .Ar string
45 .Op Ar suffix
46 .Nm dirname
47 .Ar string
48 .Sh DESCRIPTION
49 .Nm
50 deletes any prefix ending with the last slash
51 .Ql \&/
52 character present in
53 .Ar string ,
54 and a
55 .Ar suffix ,
56 if given.
57 The resulting filename is written to the standard output.
58 A non-existent suffix is ignored.
59 .Pp
60 .Nm dirname
61 deletes the filename portion, beginning
62 with the last slash
63 .Ql \&/
64 character to the end of
65 .Ar string ,
66 and writes the result to the standard output.
67 .Sh EXIT STATUS
68 Both the
69 .Nm
70 and
71 .Nm dirname
72 utilities
73 exit 0 on success, and \*[Gt]0 if an error occurs.
74 .Sh EXAMPLES
75 The following line sets the shell variable
76 .Ev FOO
78 .Pa /usr/bin .
79 .Pp
80 .Dl FOO=`dirname /usr/bin/trail`
81 .Sh SEE ALSO
82 .Xr csh 1 ,
83 .Xr sh 1 ,
84 .Xr basename 3 ,
85 .Xr dirname 3
86 .Sh STANDARDS
87 The
88 .Nm
89 and
90 .Nm dirname
91 utilities conform to
92 .St -p1003.2-92 .