bin/ln/ln.1

   1 .\"-
   2 .\" Copyright (c) 1980, 1990, 1993
   3 .\"     The Regents of the University of California.  All rights reserved.
   4 .\"
   5 .\" This code is derived from software contributed to Berkeley by
   6 .\" the Institute of Electrical and Electronics Engineers, Inc.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)ln.1        8.2 (Berkeley) 12/30/93
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd June 6, 2008
  36 .Dt LN 1
  37 .Os
  38 .Sh NAME
  39 .Nm ln ,
  40 .Nm link
  41 .Nd link files
  42 .Sh SYNOPSIS
  43 .Nm
  44 .Op Fl s Op Fl F
  45 .Op Fl f | iw
  46 .Op Fl hnv
  47 .Ar source_file
  48 .Op Ar target_file
  49 .Nm
  50 .Op Fl s Op Fl F
  51 .Op Fl f | iw
  52 .Op Fl hnv
  53 .Ar source_file ...
  54 .Ar target_dir
  55 .Nm link
  56 .Ar source_file Ar target_file
  57 .Sh DESCRIPTION
  58 The
  59 .Nm
  60 utility creates a new directory entry (linked file) for the file name
  61 specified by
  62 .Ar target_file .
  63 The
  64 .Ar target_file
  65 will be created with the same file modes as the
  66 .Ar source_file .
  67 It is useful for maintaining multiple copies of a file in many places
  68 at once without using up storage for the
  69 .Dq copies ;
  70 instead, a link
  71 .Dq points
  72 to the original copy.
  73 There are two types of links; hard links and symbolic links.
  74 How a link
  75 .Dq points
  76 to a file is one of the differences between a hard and symbolic link.
  77 .Pp
  78 The options are as follows:
  79 .Bl -tag -width flag
  80 .It Fl f
  81 If the target file already exists,
  82 then unlink it so that the link may occur.
  83 (The
  84 .Fl f
  85 option overrides any previous
  86 .Fl i
  87 and
  88 .Fl w
  89 options.)
  90 .It Fl F
  91 If the target file already exists and is a directory, then remove it
  92 so that the link may occur.
  93 The
  94 .Fl F
  95 option should be used with either
  96 .Fl f
  97 or
  98 .Fl i
  99 options.
 100 If none is specified,
 101 .Fl f
 102 is implied.
 103 The
 104 .Fl F
 105 option is a no-op unless
 106 .Fl s
 107 option is specified.
 108 .It Fl h
 109 If the
 110 .Ar target_file
 111 or
 112 .Ar target_dir
 113 is a symbolic link, do not follow it.
 114 This is most useful with the
 115 .Fl f
 116 option, to replace a symlink which may point to a directory.
 117 .It Fl i
 118 Cause
 119 .Nm
 120 to write a prompt to standard error if the target file exists.
 121 If the response from the standard input begins with the character
 122 .Sq Li y
 123 or
 124 .Sq Li Y ,
 125 then unlink the target file so that the link may occur.
 126 Otherwise, do not attempt the link.
 127 (The
 128 .Fl i
 129 option overrides any previous
 130 .Fl f
 131 options.)
 132 .It Fl n
 133 Same as
 134 .Fl h ,
 135 for compatibility with other
 136 .Nm
 137 implementations.
 138 .It Fl s
 139 Create a symbolic link.
 140 .It Fl v
 141 Cause
 142 .Nm
 143 to be verbose, showing files as they are processed.
 144 .It Fl w
 145 Warn if the source of a symbolic link does not currently exist.
 146 .El
 147 .Pp
 148 By default,
 149 .Nm
 150 makes
 151 .Em hard
 152 links.
 153 A hard link to a file is indistinguishable from the original directory entry;
 154 any changes to a file are effectively independent of the name used to reference
 155 the file.
 156 Directories may not be hardlinked, and hard links may not span file systems.
 157 .Pp
 158 A symbolic link contains the name of the file to
 159 which it is linked.
 160 The referenced file is used when an
 161 .Xr open 2
 162 operation is performed on the link.
 163 A
 164 .Xr stat 2
 165 on a symbolic link will return the linked-to file; an
 166 .Xr lstat 2
 167 must be done to obtain information about the link.
 168 The
 169 .Xr readlink 2
 170 call may be used to read the contents of a symbolic link.
 171 Symbolic links may span file systems and may refer to directories.
 172 .Pp
 173 Given one or two arguments,
 174 .Nm
 175 creates a link to an existing file
 176 .Ar source_file .
 177 If
 178 .Ar target_file
 179 is given, the link has that name;
 180 .Ar target_file
 181 may also be a directory in which to place the link;
 182 otherwise it is placed in the current directory.
 183 If only the directory is specified, the link will be made
 184 to the last component of
 185 .Ar source_file .
 186 .Pp
 187 Given more than two arguments,
 188 .Nm
 189 makes links in
 190 .Ar target_dir
 191 to all the named source files.
 192 The links made will have the same name as the files being linked to.
 193 .Pp
 194 When the utility is called as
 195 .Nm link ,
 196 exactly two arguments must be supplied,
 197 neither of which may specify a directory.
 198 No options may be supplied in this simple mode of operation,
 199 which performs a
 200 .Xr link 2
 201 operation using the two passed arguments.
 202 .Sh COMPATIBILITY
 203 The
 204 .Fl h ,
 205 .Fl i ,
 206 .Fl n ,
 207 .Fl v
 208 and
 209 .Fl w
 210 options are non-standard and their use in scripts is not recommended.
 211 They are provided solely for compatibility with other
 212 .Nm
 213 implementations.
 214 .Pp
 215 The
 216 .Fl F
 217 option is
 218 .Fx
 219 extention and should not be used in portable scripts.
 220 .Sh SEE ALSO
 221 .Xr link 2 ,
 222 .Xr lstat 2 ,
 223 .Xr readlink 2 ,
 224 .Xr stat 2 ,
 225 .Xr symlink 2 ,
 226 .Xr symlink 7
 227 .Sh STANDARDS
 228 The
 229 .Nm
 230 utility conforms to
 231 .St -p1003.2-92 .
 232 .Pp
 233 The simplified
 234 .Nm link
 235 command conforms to
 236 .St -susv2 .
 237 .Sh HISTORY
 238 An
 239 .Nm
 240 command appeared in
 241 .At v1 .