[unix-history] / usr.bin / basename / basename.1

.\" Copyright (c) 1990 The Regents of the University of California.
.\" All rights reserved.
.\"
.\" 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.
.\"
.\"     from: @(#)basename.1	6.7 (Berkeley) 6/27/91
.\"	$Id: basename.1,v 1.3 1994/04/24 01:22:43 jkh Exp $
.\"
.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.
A non-existent 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
utilities
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
utilities conform to
.St -p1003.2-92 .
Commit	Line	Data
15637ed4 RG	1	.\" Copyright (c) 1990 The Regents of the University of California.
	2	.\" 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	.\"
1b860961	35	.\" from: @(#)basename.1 6.7 (Berkeley) 6/27/91
c2714ef5	36	.\" $Id: basename.1,v 1.3 1994/04/24 01:22:43 jkh Exp $
15637ed4 RG	37	.\"
	38	.Dd June 27, 1991
	39	.Dt BASENAME 1
	40	.Os
	41	.Sh NAME
	42	.Nm basename , dirname
	43	.Nd return filename or directory portion of pathname
	44	.Sh SYNOPSIS
	45	.Nm basename
	46	.Ar string
	47	.Op Ar suffix
	48	.Nm dirname
	49	.Ar string
	50	.Sh DESCRIPTION
	51	.Nm Basename
	52	deletes any prefix ending with the last slash
	53	.Ql \&/
	54	character present in
	55	.Ar string ,
	56	and a
	57	.Ar suffix ,
	58	if given.
	59	The resulting filename is written to the standard output.
c2714ef5	60	A non-existent suffix is ignored.
15637ed4 RG	61	.Pp
	62	.Nm Dirname
	63	deletes the filename portion, beginning
	64	with the last slash
	65	.Ql \&/
	66	character to the end of
	67	.Ar string ,
	68	and writes the result to the standard output.
	69	.Sh EXAMPLES
	70	The following line sets the shell variable
	71	.Ev FOO
	72	to
	73	.Pa /usr/bin .
	74	.Pp
	75	.Dl FOO=`dirname /usr/bin/trail`
	76	.Pp
	77	Both the
	78	.Nm basename
	79	and
	80	.Nm dirname
1b860961	81	utilities
15637ed4 RG	82	exit 0 on success, and >0 if an error occurs.
15637ed4 RG	83	.Sh SEE ALSO
1b860961	84	.Xr csh 1 ,
15637ed4 RG	85	.Xr sh 1
	86	.Sh STANDARDS
	87	The
	88	.Nm basename
	89	and
	90	.Nm dirname
1b860961 C	91	utilities conform to
1b860961 C	92	.St -p1003.2-92 .