usr.bin/relpath/relpath.1

   1 .\" Copyright (c) 2005 Max Okumoto
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $DragonFly: src/usr.bin/relpath/relpath.1,v 1.1 2005/01/19 21:58:04 okumoto Exp $
  26 .\"
  27 .Dd Jan 19, 2005
  28 .Dt RELPATH 1
  29 .Os
  30 .Sh NAME
  31 .Nm relpath
  32 .Nd returns a path which is relative to the specified base.
  33 .Sh SYNOPSIS
  34 .Nm
  35 base path
  36 .Sh DESCRIPTION
  37 The
  38 .Nm
  39 utility returns a path for 'path' which is relative to the specified
  40 'base'.  The path in 'path' and all the elements between it and
  41 'base' must exist on the same filesystem.
  42
  43 .Sh EXAMPLES
  44 % relpath /usr/home /usr/home/okumoto/test/main
  45 okumoto/test/main
  46
  47 .Sh NOTE/BUG
  48 If any element in 'path' has the same inode as 'base' then the path
  49 returned will be the same.