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