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