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.17 2006/03/16 17:21:52 jkoshy Exp $
  37 .\" $DragonFly: src/usr.bin/basename/basename.1,v 1.7 2007/08/28 15:36:44 pavalos 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
  51 .Op Fl a
  52 .Op Fl s Ar suffix
  53 .Ar string
  54 .Op Ar ...
  55 .Nm dirname
  56 .Ar string
  57 .Sh DESCRIPTION
  58 The
  59 .Nm
  60 utility deletes any prefix ending with the last slash
  61 .Ql \&/
  62 character present in
  63 .Ar string
  64 (after first stripping trailing slashes),
  65 and a
  66 .Ar suffix ,
  67 if given.
  68 The
  69 .Ar suffix
  70 is not stripped if it is identical to the remaining characters in
  71 .Ar string .
  72 The resulting filename is written to the standard output.
  73 A non-existent suffix is ignored.
  74 If
  75 .Fl a
  76 is specified, then every argument is treated as a
  77 .Ar string
  78 as if
  79 .Nm
  80 were invoked with just one argument.
  81 If
  82 .Fl s
  83 is specified, then the
  84 .Ar suffix
  85 is taken as its argument, and all other arguments are treated as a
  86 .Ar string .
  87 .Pp
  88 The
  89 .Nm dirname
  90 utility deletes the filename portion, beginning
  91 with the last slash
  92 .Ql \&/
  93 character to the end of
  94 .Ar string
  95 (after first stripping trailing slashes),
  96 and writes the result to the standard output.
  97 .Sh EXIT STATUS
  98 .Ex -std basename dirname
  99 .Sh EXAMPLES
 100 The following line sets the shell variable
 101 .Ev FOO
 102 to
 103 .Pa /usr/bin .
 104 .Pp
 105 .Dl FOO=`dirname /usr/bin/trail`
 106 .Sh SEE ALSO
 107 .Xr csh 1 ,
 108 .Xr sh 1 ,
 109 .Xr basename 3 ,
 110 .Xr dirname 3
 111 .Sh STANDARDS
 112 The
 113 .Nm
 114 and
 115 .Nm dirname
 116 utilities are expected to be
 117 .St -p1003.2
 118 compatible.
 119 The
 120 .Nm
 121 utility does not conform to
 122 .St -p1003.1-2004 .
 123 The
 124 .Nm dirname
 125 utility conforms to
 126 .St -p1003.1-2004 .