BSD 4_3_Net_2 release
[unix-history] / usr / src / usr.bin / basename / basename.1
index cfc0afe..2568d44 100644 (file)
@@ -1,32 +1,97 @@
-.\"    @(#)basename.1  5.1 (Berkeley) %G%
+.\" Copyright (c) 1990 The Regents of the University of California.
+.\" All rights reserved.
 .\"
 .\"
-.TH BASENAME 1 "1 April 1981"
-.AT 3
-.SH NAME
-basename \- strip filename affixes
-.SH SYNOPSIS
-.B basename
-string [ suffix ]
-.SH DESCRIPTION
-.I Basename
-deletes any prefix ending in `/' and the
-.I suffix,
-if present in
-.I string,
-from
-.I string,
-and prints the result on the standard output.
-It is normally used inside substitution marks \`\ \`
-in shell procedures.
-.PP
-This shell procedure invoked with the argument
-.I /usr/src/bin/cat.c
-compiles the named file and moves the output to
-.I cat
-in the current directory:
-.IP "" 15n
-cc $1
-.br
-mv a.out \`basename $1 .c\`
-.SH "SEE ALSO"
-sh(1)
+.\" This code is derived from software contributed to Berkeley by
+.\" the Institute of Electrical and Electronics Engineers, Inc.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\"     @(#)basename.1 6.7 (Berkeley) 6/27/91
+.\"
+.Dd June 27, 1991
+.Dt BASENAME 1
+.Os
+.Sh NAME
+.Nm basename , dirname
+.Nd return filename or directory portion of pathname
+.Sh SYNOPSIS
+.Nm basename
+.Ar string
+.Op Ar suffix
+.Nm dirname
+.Ar string
+.Sh DESCRIPTION
+.Nm Basename
+deletes any prefix ending with the last slash
+.Ql \&/
+character present in
+.Ar string ,
+and a
+.Ar suffix ,
+if given.
+The resulting filename is written to the standard output.
+If
+.Ar string
+ends in the slash character,
+.Ql / ,
+or is the same as the
+.Ar suffix
+argument,
+a newline is output.
+A non-existant suffix is ignored.
+.Pp
+.Nm Dirname
+deletes the filename portion, beginning
+with the last slash
+.Ql \&/
+character to the end of
+.Ar string , 
+and writes the result to the standard output.
+.Sh EXAMPLES 
+The following line sets the shell variable
+.Ev FOO
+to
+.Pa /usr/bin .
+.Pp
+.Dl FOO=`dirname /usr/bin/trail`
+.Pp
+Both the
+.Nm basename
+and
+.Nm dirname
+exit 0 on success, and >0 if an error occurs.
+.Sh SEE ALSO
+.Xr csh 1
+.Xr sh 1
+.Sh STANDARDS
+The
+.Nm basename
+and
+.Nm dirname
+functions are expected to be POSIX 1003.2 compatible.