revpath.man

   1 .\" $XFree86: xc/config/util/revpath.man,v 1.1 1999/01/03 03:58:14 dawes Exp $
   2 .TH REVPATH 1 __vendorversion__
   3 .SH NAME
   4 revpath \- generate a relative path that can be used to undo a change-directory
   5 .SH SYNOPSIS
   6 .B revpath
   7 .I path
   8 .SH DESCRIPTION
   9 The
  10 .I revpath
  11 program prints out a relative path that is the ``reverse'' or ``inverse'' of
  12 .IR path .
  13 Start with two directories
  14 .I top
  15 and
  16 .IR bottom ,
  17 with the latter below the former, and
  18 .I path
  19 is the location of
  20 .I bottom
  21 relative to
  22 .IR top .
  23 The output of
  24 .I revpath
  25 is the location of
  26 .I top
  27 relative to
  28 .IR bottom .
  29 The resulting path contains a trailing `/' character when the result is
  30 non-trivial.
  31 If
  32 .I path
  33 is equivalent to `.', the resulting output is empty.
  34 If
  35 .I path
  36 is invalid in some way (e.g., doesn't represent the path to a subdirectory)
  37 the output is also empty and no error messages are ever generated.
  38 .SH DIAGNOSTICS
  39 There are no diagnostics.  Error conditions are silently ignored, and the
  40 exit status is always 0.
  41 .SH BUGS
  42 It isn't possible to reverse arbitrary relative paths.
  43 If any path element between the two end points of
  44 .I path
  45 is a symbolic link, the results will probably be incorrect.