share/man/man1/basename.1

   1 .\" Copyright 2014 Garrett D'Amore <garrett@damore.org>
   2 .\" Copyright 1989 AT&T  Copyright (c) 2001, Sun Microsystems, Inc.  All Rights Reserved  Portions Copyright (c) 1992, X/Open Company Limited  All Rights Reserved
   3 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   4 .\" http://www.opengroup.org/bookstore/.
   5 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   6 .\"  This notice shall appear on any product containing this material.
   7 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   9 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  10 .Dd Aug 21, 2014
  11 .Dt BASENAME 1
  12 .Os
  13 .Sh NAME
  14 .Nm basename ,
  15 .Nm dirname
  16 .Nd deliver portions of path names
  17 .Sh SYNOPSIS
  18 .Nm basename
  19 .Ar string
  20 .Op Ar suffix
  21 .Nm dirname
  22 .Ar string
  23 .Sh DESCRIPTION
  24 The
  25 .Nm basename
  26 utility deletes any prefix ending in
  27 .Li /
  28 and the
  29 .Ar suffix
  30 .Pq if present in Ar string
  31 from
  32 .Ar string ,
  33 and prints the
  34 result on the standard output. It is normally used inside substitution marks
  35 (\fB`\|`\fR) within shell procedures.
  36 .Lp
  37 The
  38 .Ar suffix
  39 is a string with no special significance attached to  any of
  40 the characters it contains.
  41 .Lp
  42 The
  43 .Nm dirname
  44 utility delivers all but the last level of the path name in
  45 .Ar string .
  46 .Sh ENVIRONMENT
  47 See
  48 .Xr environ 5
  49 for descriptions of the following environment variables
  50 that affect  the execution of
  51 .Nm basename
  52 and
  53 .Nm dirname :
  54 .Ev LANG ,
  55 .Ev LC_ALL ,
  56 .Ev LC_CTYPE ,
  57 .Ev LC_MESSAGES ,
  58 and
  59 .Ev NLSPATH .
  60 .Sh EXIT STATUS
  61 .Ex -std
  62 .Sh EXAMPLES
  63 .Ss Example 1 Setting environment variables
  64 The following example, invoked with the argument
  65 .Pa /home/sms/personal/mail
  66 sets the environment variable
  67 .Ev NAME
  68 to the file named
  69 .Pa mail
  70 and the
  71 environment variable
  72 .Ev MYMAILPATH
  73 to the string
  74 .Pa /home/sms/personal :
  75 .Bd -literal
  76 example% NAME=`basename \|$HOME/personal/mail`
  77 example% MYMAILPATH=`dirname \|$HOME/personal/mail`
  78 .Ed
  79 .Ss Example 2 Compiling a file and moving the output
  80 This shell procedure, invoked with the argument
  81 .Pa /usr/src/bin/cat.c ,
  82 compiles the named file and moves the output to
  83 .Pa cat
  84 in the current directory:
  85 .Bd -literal
  86 example% cc $1
  87 example% mv a.out `basename $1 .c`
  88 .Ed
  89 .Sh INTERFACE STABILITY
  90 .Sy Standard .
  91 .Sh SEE ALSO
  92 .Xr expr 1 ,
  93 .Xr basename 3C ,
  94 .Xr environ 5 ,
  95 .Xr standards 5
  96 .Sh STANDARDS
  97 These utilities conform to the following standards.  See
  98 .Xr standards 5 .
  99 .Lp
 100 .Bl -bullet -compact
 101 .It
 102 .St -xpg4
 103 .It
 104 .St -xpg4.2
 105 .It
 106 .St -susv2
 107 .It
 108 .St -susv2
 109 .It
 110 .St -p1003.1-2008
 111 .El