usr.bin/basename/basename.1

   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.3 2004/07/16 00:45:33 hmp Exp $
  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
  47 .Ar string
  48 .Op Ar suffix
  49 .Nm dirname
  50 .Ar string
  51 .Sh DESCRIPTION
  52 The
  53 .Nm
  54 utility deletes any prefix ending with the last slash
  55 .Ql \&/
  56 character present in
  57 .Ar string
  58 (after first stripping trailing slashes),
  59 and a
  60 .Ar suffix ,
  61 if given.
  62 The
  63 .Ar suffix
  64 is not stripped if it is identical to the remaining characters in
  65 .Ar string .
  66 The resulting filename is written to the standard output.
  67 A non-existent suffix is ignored.
  68 .Pp
  69 The
  70 .Nm dirname
  71 utility deletes the filename portion, beginning
  72 with the last slash
  73 .Ql \&/
  74 character to the end of
  75 .Ar string
  76 (after first stripping trailing slashes),
  77 and writes the result to the standard output.
  78 .Sh EXAMPLES
  79 The following line sets the shell variable
  80 .Ev FOO
  81 to
  82 .Pa /usr/bin .
  83 .Pp
  84 .Dl FOO=`dirname /usr/bin/trail`
  85 .Sh DIAGNOSTICS
  86 .Ex -std basename dirname
  87 .Sh SEE ALSO
  88 .Xr csh 1 ,
  89 .Xr sh 1
  90 .Sh STANDARDS
  91 The
  92 .Nm
  93 and
  94 .Nm dirname
  95 utilities are expected to be
  96 .St -p1003.2
  97 compatible.