util/lndir.man

   1 .\" $TOG: lndir.man /main/11 1998/02/06 11:23:56 kaleb $
   2 .\"
   3 .\" Copyright (c) 1993, 1994, 1998 The Open Group
   4 .\"
   5 .\" All Rights Reserved.
   6 .\"
   7 .\" The above copyright notice and this permission notice shall be
   8 .\" included in all copies or substantial portions of the Software.
   9 .\"
  10 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  11 .\" EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  12 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  13 .\" IN NO EVENT SHALL THE OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR
  14 .\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  15 .\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  16 .\" OTHER DEALINGS IN THE SOFTWARE.
  17 .\"
  18 .\" Except as contained in this notice, the name of The Open Group shall
  19 .\" not be used in advertising or otherwise to promote the sale, use or
  20 .\" other dealings in this Software without prior written authorization
  21 .\" from The Open Group.
  22 .\"
  23 .TH LNDIR 1 "Release 6.4" "X Version 11"
  24 .SH NAME
  25 lndir \- create a shadow directory of symbolic links to another directory tree
  26 .SH SYNOPSIS
  27 .B lndir
  28 [
  29 .B \-silent
  30 ] [
  31 .B \-ignorelinks
  32 ]
  33 .I \|fromdir\|
  34 [
  35 .I todir
  36 ]
  37 .SH DESCRIPTION
  38 The
  39 .I lndir
  40 program makes a shadow copy
  41 .I todir
  42 of a directory tree
  43 .I fromdir,
  44 except that the shadow is not
  45 populated with real files but instead with symbolic links pointing at
  46 the real files in the
  47 .I fromdir
  48 directory tree.  This is usually useful for maintaining source code for
  49 different machine architectures.  You create a shadow directory
  50 containing links to the real source, which you will have usually
  51 mounted from a remote machine.  You can build in the shadow tree, and
  52 the object files will be in the shadow directory, while the
  53 source files in the shadow directory are just symlinks to the real
  54 files.
  55 .PP
  56 This scheme has the advantage that if you update the source, you need not
  57 propagate the change to the other architectures by hand, since all
  58 source in all shadow directories are symlinks to the real thing: just cd
  59 to the shadow directory and recompile away.
  60 .PP
  61 The
  62 .I todir
  63 argument is optional and defaults to the current directory.  The
  64 .I fromdir
  65 argument may be relative (e.g., ../src) and is relative to
  66 .I todir
  67 (not the current directory).
  68 .PP
  69 .\" CVS.adm is used by the Concurrent Versions System.
  70 Note that RCS, SCCS, CVS and CVS.adm directories are not shadowed.
  71 .PP
  72 If you add files, simply run
  73 .I lndir
  74 again.  New files will be silently added.  Old files will be
  75 checked that they have the correct link.
  76 .PP
  77 Deleting files is a more painful problem; the symlinks will
  78 just point into never never land.
  79 .PP
  80 If a file in \fIfromdir\fP is a symbolic link, \fIlndir\fP will make
  81 the same link in \fItodir\fP rather than making a link back to the
  82 (symbolic link) entry in \fIfromdir.\fP  The \fB\-ignorelinks\fP flag
  83 changes this behavior.
  84 .SH OPTIONS
  85 .IP \-silent
  86 Normally \fIlndir\fP outputs the name of each subdirectory as it
  87 descends into it.  The \fB\-silent\fP option suppresses these status
  88 messages.
  89 .IP \-ignorelinks
  90 Causes the program to not treat symbolic links in \fIfromdir\fP
  91 specially.  The link created in \fItodir\fP will point back to the
  92 corresponding (symbolic link) file in \fIfromdir\fP.
  93 If the link is to a directory, this is almost certainly the wrong thing.
  94 .IP
  95 This option exists mostly to emulate the behavior the C version of
  96 \fIlndir\fP had in X11R6.  Its use is not recommended.
  97 .SH DIAGNOSTICS
  98 The program displays the name of each subdirectory it enters, followed
  99 by a colon.  The \fB\-silent\fP option suppresses these messages.
 100 .PP
 101 A warning message is displayed if the symbolic link cannot be created.
 102 The usual problem is that a regular file of the same name already
 103 exists.
 104 .PP
 105 If the link already exists but doesn't point to the correct file, the
 106 program prints the link name and the location where it does point.
 107 .SH BUGS
 108 The
 109 .I patch
 110 program gets upset if it cannot change the files.  You should never run
 111 .I patch
 112 from a shadow directory anyway.
 113 .PP
 114 You need to use something like
 115 .nf
 116         find todir \|\-type l \|\-print \||\| xargs rm
 117 .fi
 118 to clear out all files before you can relink (if fromdir moved, for instance).
 119 Something like
 120 .nf
 121          find . \|\\! \|\-type d \|\-print
 122 .fi
 123 will find all files that are not directories.