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 12, 2017
  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 L | Fl P | 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 L | Fl P | 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 and is a directory, then remove it
  82 so that the link may occur.
  83 The
  84 .Fl F
  85 option should be used with either
  86 .Fl f
  87 or
  88 .Fl i
  89 options.
  90 If neither
  91 .Fl f
  92 nor
  93 .Fl i
  94 is specified,
  95 .Fl f
  96 is implied.
  97 The
  98 .Fl F
  99 option is a no-op unless
 100 .Fl s
 101 is specified.
 102 .It Fl L
 103 When creating a hard link to a symbolic link,
 104 create a hard link to the target of the symbolic link.
 105 This is the default.
 106 This option cancels the
 107 .Fl P
 108 option.
 109 .It Fl P
 110 When creating a hard link to a symbolic link,
 111 create a hard link to the symbolic link itself.
 112 This option cancels the
 113 .Fl L
 114 option.
 115 .It Fl f
 116 If the target file already exists,
 117 then unlink it so that the link may occur.
 118 (The
 119 .Fl f
 120 option overrides any previous
 121 .Fl i
 122 and
 123 .Fl w
 124 options.)
 125 .It Fl h
 126 If the
 127 .Ar target_file
 128 or
 129 .Ar target_dir
 130 is a symbolic link, do not follow it.
 131 This is most useful with the
 132 .Fl f
 133 option, to replace a symlink which may point to a directory.
 134 .It Fl i
 135 Cause
 136 .Nm
 137 to write a prompt to standard error if the target file exists.
 138 If the response from the standard input begins with the character
 139 .Sq Li y
 140 or
 141 .Sq Li Y ,
 142 then unlink the target file so that the link may occur.
 143 Otherwise, do not attempt the link.
 144 (The
 145 .Fl i
 146 option overrides any previous
 147 .Fl f
 148 options.)
 149 .It Fl n
 150 Same as
 151 .Fl h ,
 152 for compatibility with other
 153 .Nm
 154 implementations.
 155 .It Fl s
 156 Create a symbolic link.
 157 .It Fl v
 158 Cause
 159 .Nm
 160 to be verbose, showing files as they are processed.
 161 .It Fl w
 162 Warn if the source of a symbolic link does not currently exist.
 163 .El
 164 .Pp
 165 By default,
 166 .Nm
 167 makes
 168 .Em hard
 169 links.
 170 A hard link to a file is indistinguishable from the original directory entry;
 171 any changes to a file are effectively independent of the name used to reference
 172 the file.
 173 Directories may not be hardlinked, and hard links may not span file systems.
 174 .Pp
 175 A symbolic link contains the name of the file to
 176 which it is linked.
 177 The referenced file is used when an
 178 .Xr open 2
 179 operation is performed on the link.
 180 A
 181 .Xr stat 2
 182 on a symbolic link will return the linked-to file; an
 183 .Xr lstat 2
 184 must be done to obtain information about the link.
 185 The
 186 .Xr readlink 2
 187 call may be used to read the contents of a symbolic link.
 188 Symbolic links may span file systems and may refer to directories.
 189 .Pp
 190 Given one or two arguments,
 191 .Nm
 192 creates a link to an existing file
 193 .Ar source_file .
 194 If
 195 .Ar target_file
 196 is given, the link has that name;
 197 .Ar target_file
 198 may also be a directory in which to place the link;
 199 otherwise it is placed in the current directory.
 200 If only the directory is specified, the link will be made
 201 to the last component of
 202 .Ar source_file .
 203 .Pp
 204 Given more than two arguments,
 205 .Nm
 206 makes links in
 207 .Ar target_dir
 208 to all the named source files.
 209 The links made will have the same name as the files being linked to.
 210 .Pp
 211 When the utility is called as
 212 .Nm link ,
 213 exactly two arguments must be supplied,
 214 neither of which may specify a directory.
 215 No options may be supplied in this simple mode of operation,
 216 which performs a
 217 .Xr link 2
 218 operation using the two passed arguments.
 219 .Sh EXAMPLES
 220 Create a symbolic link named
 221 .Pa /home/src
 222 and point it to
 223 .Pa /usr/src :
 224 .Pp
 225 .Dl # ln -s /usr/src /home/src
 226 .Pp
 227 Hard link
 228 .Pa /usr/local/bin/fooprog
 229 to file
 230 .Pa /usr/local/bin/fooprog-1.0 :
 231 .Pp
 232 .Dl # ln /usr/local/bin/fooprog-1.0 /usr/local/bin/fooprog
 233 .Pp
 234 As an exercise, try the following commands:
 235 .Bd -literal -offset indent
 236 # ls -i /bin/[
 237 11553 /bin/[
 238 # ls -i /bin/test
 239 11553 /bin/test
 240 .Ed
 241 .Pp
 242 Note that both files have the same inode; that is,
 243 .Pa /bin/[
 244 is essentially an alias for the
 245 .Xr test 1
 246 command.
 247 This hard link exists so
 248 .Xr test 1
 249 may be invoked from shell scripts, for example, using the
 250 .Li "if [ ]"
 251 construct.
 252 .Pp
 253 In the next example, the second call to
 254 .Nm
 255 removes the original
 256 .Pa foo
 257 and creates a replacement pointing to
 258 .Pa baz :
 259 .Bd -literal -offset indent
 260 # mkdir bar baz
 261 # ln -s bar foo
 262 # ln -shf baz foo
 263 .Ed
 264 .Pp
 265 Without the
 266 .Fl h
 267 option, this would instead leave
 268 .Pa foo
 269 pointing to
 270 .Pa bar
 271 and inside
 272 .Pa foo
 273 create a new symlink
 274 .Pa baz
 275 pointing to itself.
 276 This results from directory-walking.
 277 .Pp
 278 An easy rule to remember is that the argument order for
 279 .Nm
 280 is the same as for
 281 .Xr cp 1 :
 282 The first argument needs to exist, the second one is created.
 283 .Sh COMPATIBILITY
 284 The
 285 .Fl h ,
 286 .Fl i ,
 287 .Fl n ,
 288 .Fl v
 289 and
 290 .Fl w
 291 options are non-standard and their use in scripts is not recommended.
 292 They are provided solely for compatibility with other
 293 .Nm
 294 implementations.
 295 .Pp
 296 The
 297 .Fl F
 298 option is a
 299 .Fx
 300 extension and should not be used in portable scripts.
 301 .Sh SEE ALSO
 302 .Xr link 2 ,
 303 .Xr lstat 2 ,
 304 .Xr readlink 2 ,
 305 .Xr stat 2 ,
 306 .Xr symlink 2 ,
 307 .Xr symlink 7
 308 .Sh STANDARDS
 309 The
 310 .Nm
 311 utility conforms to
 312 .St -p1003.2-92 .
 313 .Pp
 314 The simplified
 315 .Nm link
 316 command conforms to
 317 .St -susv2 .
 318 .Sh HISTORY
 319 An
 320 .Nm
 321 command appeared in
 322 .At v1 .