man/man1/linkfarm.1

   1 .\"     $NetBSD: linkfarm.1,v 1.6 2009/02/08 23:11:56 wiz Exp $
   2 .\"
   3 .\" Copyright (c) 2003 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. All advertising materials mentioning features or use of this software
  15 .\"    must display the following acknowledgement:
  16 .\"        This product includes software developed by the NetBSD
  17 .\"        Foundation, Inc. and its contributors.
  18 .\" 4. Neither the name of The NetBSD Foundation nor the names of its
  19 .\"    contributors may be used to endorse or promote products derived
  20 .\"    from this software without specific prior written permission.
  21 .\"
  22 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  23 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  24 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  25 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  26 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  27 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  28 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  29 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  30 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  31 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  32 .\" POSSIBILITY OF SUCH DAMAGE.
  33 .\"
  34 .Dd September 2, 2003
  35 .Dt LINKFARM 1
  36 .Os
  37 .Sh NAME
  38 .Nm linkfarm
  39 .Nd manage symbolic links to package files
  40 .Sh SYNOPSIS
  41 .Nm
  42 .Op Fl cDnRVv
  43 .Op Fl d Ar stowdir
  44 .Op Fl s Ar subdir
  45 .Op Fl t Ar target
  46 .Ar package
  47 .Sh DESCRIPTION
  48 The
  49 .Nm
  50 command is used to manage a "linkfarm", a directory tree of symbolic links in
  51 .Ar target
  52 to the files in the
  53 .Ar package
  54 sub-directory of
  55 .Ar stowdir .
  56 The default action is to create a linkfarm to a package.
  57 .Pp
  58 The following command-line options are supported:
  59 .Bl -tag -width indent
  60 .It Fl c
  61 Check whether a package contains a linkfarm in
  62 .Ar target .
  63 If
  64 .Ar package
  65 has no symbolic links in
  66 .Ar target
  67 that correspond to its files, then return 0, otherwise return 1.
  68 .It Fl D
  69 Delete the linkfarm for
  70 .Ar package .
  71 .It Fl d Ar stowdir
  72 Set
  73 .Ar stowdir
  74 as the directory in which
  75 .Ar package
  76 can be found.
  77 The default
  78 .Ar stowdir
  79 is the
  80 .Pa packages
  81 sub-directory in the default
  82 .Ar target
  83 directory.
  84 .It Fl n
  85 Don't actually execute the commands for removing and creating the symbolic
  86 links and directories.
  87 .It Fl R
  88 Delete and re-create the linkfarm for
  89 .Ar package .
  90 .It Fl s Ar subdir
  91 The root of the package hierarchy for the linkfarm is the
  92 .Ar subdir
  93 sub-directory in the package.
  94 By default, assume the root of the package hierarchy is simply the
  95 .Ar package
  96 directory.
  97 .It Fl t Ar target
  98 Set
  99 .Ar target
 100 as the directory in which to create and delete the linkfarm for
 101 .Ar package .
 102 The default
 103 .Ar target
 104 directory is
 105 .Pa /usr/pkg
 106 but may be overridden by the
 107 .Ev LOCALBASE
 108 environment variable.
 109 .It Fl V
 110 Print version number and exit.
 111 .It Fl v
 112 Turn on verbose output.
 113 Specifying
 114 .Fl v
 115 multiple times increases the level of verbosity.
 116 .El
 117 .Sh ENVIRONMENT
 118 .Bl -tag -width indent
 119 .It Ev LOCALBASE
 120 The standard packages directory,
 121 .Pa /usr/pkg ,
 122 can be overridden by specifying an alternative directory in the
 123 .Ev LOCALBASE
 124 environment variable.
 125 This affects the default
 126 .Ar target
 127 and
 128 .Ar stowdir
 129 directories.
 130 .It Ev PLIST_IGNORE_FILES
 131 This can be used to specify files in
 132 .Ar package
 133 that should ignored when creating and deleting symbolic links in
 134 .Ar target .
 135 .Ev PLIST_IGNORE_FILES
 136 is a space-separated list of shell glob patterns that match files relative
 137 to the
 138 .Ar package
 139 directory, and it defaults to "info/dir *[~#] *.OLD *.orig *,v".
 140 .El
 141 .Sh SEE ALSO
 142 .Xr lndir 1 ,
 143 .Xr pkg_view 1
 144 .Sh AUTHORS
 145 The
 146 .Nm
 147 utility was written by
 148 .An Alistair G. Crooks Aq agc@NetBSD.org .