bin/ln/symlink.7

   1 .\"-
   2 .\" Copyright (c) 1992, 1993, 1994
   3 .\"     The Regents of the University of California.  All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" 4. Neither the name of the University nor the names of its contributors
  14 .\"    may be used to endorse or promote products derived from this software
  15 .\"    without specific prior written permission.
  16 .\"
  17 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  18 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  21 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27 .\" SUCH DAMAGE.
  28 .\"
  29 .\"     @(#)symlink.7   8.3 (Berkeley) 3/31/94
  30 .\" $FreeBSD$
  31 .\"
  32 .Dd December 29, 2014
  33 .Dt SYMLINK 7
  34 .Os
  35 .Sh NAME
  36 .Nm symlink
  37 .Nd symbolic link handling
  38 .Sh SYMBOLIC LINK HANDLING
  39 Symbolic links are files that act as pointers to other files.
  40 To understand their behavior, you must first understand how hard links
  41 work.
  42 A hard link to a file is indistinguishable from the original file because
  43 it is a reference to the object underlying the original file name.
  44 Changes to a file are independent of the name used to reference the
  45 file.
  46 Hard links may not refer to directories and may not reference files
  47 on different file systems.
  48 A symbolic link contains the name of the file to which it is linked,
  49 i.e., it is a pointer to another name, and not to an underlying object.
  50 For this reason, symbolic links may reference directories and may span
  51 file systems.
  52 .Pp
  53 Because a symbolic link and its referenced object coexist in the file system
  54 name space, confusion can arise in distinguishing between the link itself
  55 and the referenced object.
  56 Historically, commands and system calls have adopted their own link
  57 following conventions in a somewhat ad-hoc fashion.
  58 Rules for more a uniform approach, as they are implemented in this system,
  59 are outlined here.
  60 It is important that local applications conform to these rules, too,
  61 so that the user interface can be as consistent as possible.
  62 .Pp
  63 Symbolic links are handled either by operating on the link itself,
  64 or by operating on the object referenced by the link.
  65 In the latter case,
  66 an application or system call is said to
  67 .Dq follow
  68 the link.
  69 Symbolic links may reference other symbolic links,
  70 in which case the links are dereferenced until an object that is
  71 not a symbolic link is found,
  72 a symbolic link which references a file which does not exist is found,
  73 or a loop is detected.
  74 (Loop detection is done by placing an upper limit on the number of
  75 links that may be followed, and an error results if this limit is
  76 exceeded.)
  77 .Pp
  78 There are three separate areas that need to be discussed.
  79 They are as follows:
  80 .Pp
  81 .Bl -enum -compact -offset indent
  82 .It
  83 Symbolic links used as file name arguments for system calls.
  84 .It
  85 Symbolic links specified as command line arguments to utilities that
  86 are not traversing a file tree.
  87 .It
  88 Symbolic links encountered by utilities that are traversing a file tree
  89 (either specified on the command line or encountered as part of the
  90 file hierarchy walk).
  91 .El
  92 .Ss System calls.
  93 The first area is symbolic links used as file name arguments for
  94 system calls.
  95 .Pp
  96 Except as noted below, all system calls follow symbolic links.
  97 For example, if there were a symbolic link
  98 .Dq Li slink
  99 which pointed to a file named
 100 .Dq Li afile ,
 101 the system call
 102 .Dq Li open("slink" ...\&)
 103 would return a file descriptor to the file
 104 .Dq afile .
 105 .Pp
 106 There are thirteen system calls that do not follow links, and which operate
 107 on the symbolic link itself.
 108 They are:
 109 .Xr lchflags 2 ,
 110 .Xr lchmod 2 ,
 111 .Xr lchown 2 ,
 112 .Xr lpathconf 2 ,
 113 .Xr lstat 2 ,
 114 .Xr lutimes 2 ,
 115 .Xr readlink 2 ,
 116 .Xr readlinkat 2 ,
 117 .Xr rename 2 ,
 118 .Xr renameat 2 ,
 119 .Xr rmdir 2 ,
 120 .Xr unlink 2 ,
 121 and
 122 .Xr unlinkat 2 .
 123 Because
 124 .Xr remove 3
 125 is an alias for
 126 .Xr unlink 2 ,
 127 it also does not follow symbolic links.
 128 When
 129 .Xr rmdir 2
 130 or
 131 .Xr unlinkat 2
 132 with the
 133 .Dv AT_REMOVEDIR
 134 flag
 135 is applied to a symbolic link, it fails with the error
 136 .Er ENOTDIR .
 137 .Pp
 138 The
 139 .Xr linkat 2
 140 system call does not follow symbolic links
 141 unless given the
 142 .Dv AT_SYMLINK_FOLLOW
 143 flag.
 144 .Pp
 145 The following system calls follow symbolic links
 146 unless given the
 147 .Dv AT_SYMLINK_NOFOLLOW
 148 flag:
 149 .Xr fchmodat 2 ,
 150 .Xr fchownat 2
 151 and
 152 .Xr fstatat 2 .
 153 .Pp
 154 The owner and group of an existing symbolic link can be changed by
 155 means of the
 156 .Xr lchown 2
 157 system call.
 158 The flags, access permissions, owner/group and modification time of
 159 an existing symbolic link can be changed by means of the
 160 .Xr lchflags 2 ,
 161 .Xr lchmod 2 ,
 162 .Xr lchown 2 ,
 163 and
 164 .Xr lutimes 2
 165 system calls, respectively.
 166 Of these, only the flags and ownership are used by the system;
 167 the access permissions are ignored.
 168 .Pp
 169 The
 170 .Bx 4.4
 171 system differs from historical
 172 .Bx 4
 173 systems in that the system call
 174 .Xr chown 2
 175 has been changed to follow symbolic links.
 176 The
 177 .Xr lchown 2
 178 system call was added later when the limitations of the new
 179 .Xr chown 2
 180 became apparent.
 181 .Ss Commands not traversing a file tree.
 182 The second area is symbolic links, specified as command line file
 183 name arguments, to commands which are not traversing a file tree.
 184 .Pp
 185 Except as noted below, commands follow symbolic links named as command
 186 line arguments.
 187 For example, if there were a symbolic link
 188 .Dq Li slink
 189 which pointed to a file named
 190 .Dq Li afile ,
 191 the command
 192 .Dq Li cat slink
 193 would display the contents of the file
 194 .Dq Li afile .
 195 .Pp
 196 It is important to realize that this rule includes commands which may
 197 optionally traverse file trees, e.g.\& the command
 198 .Dq Li "chown file"
 199 is included in this rule, while the command
 200 .Dq Li "chown -R file"
 201 is not.
 202 (The latter is described in the third area, below.)
 203 .Pp
 204 If it is explicitly intended that the command operate on the symbolic
 205 link instead of following the symbolic link, e.g., it is desired that
 206 .Dq Li "chown slink"
 207 change the ownership of the file that
 208 .Dq Li slink
 209 is, whether it is a symbolic link or not, the
 210 .Fl h
 211 option should be used.
 212 In the above example,
 213 .Dq Li "chown root slink"
 214 would change the ownership of the file referenced by
 215 .Dq Li slink ,
 216 while
 217 .Dq Li "chown -h root slink"
 218 would change the ownership of
 219 .Dq Li slink
 220 itself.
 221 .Pp
 222 There are five exceptions to this rule.
 223 The
 224 .Xr mv 1
 225 and
 226 .Xr rm 1
 227 commands do not follow symbolic links named as arguments,
 228 but respectively attempt to rename and delete them.
 229 (Note, if the symbolic link references a file via a relative path,
 230 moving it to another directory may very well cause it to stop working,
 231 since the path may no longer be correct.)
 232 .Pp
 233 The
 234 .Xr ls 1
 235 command is also an exception to this rule.
 236 For compatibility with historic systems (when
 237 .Nm ls
 238 is not doing a tree walk, i.e., the
 239 .Fl R
 240 option is not specified),
 241 the
 242 .Nm ls
 243 command follows symbolic links named as arguments if the
 244 .Fl H
 245 or
 246 .Fl L
 247 option is specified,
 248 or if the
 249 .Fl F ,
 250 .Fl d
 251 or
 252 .Fl l
 253 options are not specified.
 254 (The
 255 .Nm ls
 256 command is the only command where the
 257 .Fl H
 258 and
 259 .Fl L
 260 options affect its behavior even though it is not doing a walk of
 261 a file tree.)
 262 .Pp
 263 The
 264 .Xr file 1
 265 and
 266 .Xr stat 1
 267 commands are also exceptions to this rule.
 268 These
 269 commands do not follow symbolic links named as argument by default,
 270 but do follow symbolic links named as argument if the
 271 .Fl L
 272 option is specified.
 273 .Pp
 274 The
 275 .Bx 4.4
 276 system differs from historical
 277 .Bx 4
 278 systems in that the
 279 .Nm chown
 280 and
 281 .Nm chgrp
 282 commands follow symbolic links specified on the command line.
 283 .Ss Commands traversing a file tree.
 284 The following commands either optionally or always traverse file trees:
 285 .Xr chflags 1 ,
 286 .Xr chgrp 1 ,
 287 .Xr chmod 1 ,
 288 .Xr cp 1 ,
 289 .Xr du 1 ,
 290 .Xr find 1 ,
 291 .Xr ls 1 ,
 292 .Xr pax 1 ,
 293 .Xr rm 1 ,
 294 .Xr tar 1
 295 and
 296 .Xr chown 8 .
 297 .Pp
 298 It is important to realize that the following rules apply equally to
 299 symbolic links encountered during the file tree traversal and symbolic
 300 links listed as command line arguments.
 301 .Pp
 302 The first rule applies to symbolic links that reference files that are
 303 not of type directory.
 304 Operations that apply to symbolic links are performed on the links
 305 themselves, but otherwise the links are ignored.
 306 .Pp
 307 The command
 308 .Dq Li "rm -r slink directory"
 309 will remove
 310 .Dq Li slink ,
 311 as well as any symbolic links encountered in the tree traversal of
 312 .Dq Li directory ,
 313 because symbolic links may be removed.
 314 In no case will
 315 .Nm rm
 316 affect the file which
 317 .Dq Li slink
 318 references in any way.
 319 .Pp
 320 The second rule applies to symbolic links that reference files of type
 321 directory.
 322 Symbolic links which reference files of type directory are never
 323 .Dq followed
 324 by default.
 325 This is often referred to as a
 326 .Dq physical
 327 walk, as opposed to a
 328 .Dq logical
 329 walk (where symbolic links referencing directories are followed).
 330 .Pp
 331 As consistently as possible, you can make commands doing a file tree
 332 walk follow any symbolic links named on the command line, regardless
 333 of the type of file they reference, by specifying the
 334 .Fl H
 335 (for
 336 .Dq half\-logical )
 337 flag.
 338 This flag is intended to make the command line name space look
 339 like the logical name space.
 340 (Note, for commands that do not always do file tree traversals, the
 341 .Fl H
 342 flag will be ignored if the
 343 .Fl R
 344 flag is not also specified.)
 345 .Pp
 346 For example, the command
 347 .Dq Li "chown -HR user slink"
 348 will traverse the file hierarchy rooted in the file pointed to by
 349 .Dq Li slink .
 350 Note, the
 351 .Fl H
 352 is not the same as the previously discussed
 353 .Fl h
 354 flag.
 355 The
 356 .Fl H
 357 flag causes symbolic links specified on the command line to be
 358 dereferenced both for the purposes of the action to be performed
 359 and the tree walk, and it is as if the user had specified the
 360 name of the file to which the symbolic link pointed.
 361 .Pp
 362 As consistently as possible, you can make commands doing a file tree
 363 walk follow any symbolic links named on the command line, as well as
 364 any symbolic links encountered during the traversal, regardless of
 365 the type of file they reference, by specifying the
 366 .Fl L
 367 (for
 368 .Dq logical )
 369 flag.
 370 This flag is intended to make the entire name space look like
 371 the logical name space.
 372 (Note, for commands that do not always do file tree traversals, the
 373 .Fl L
 374 flag will be ignored if the
 375 .Fl R
 376 flag is not also specified.)
 377 .Pp
 378 For example, the command
 379 .Dq Li "chown -LR user slink"
 380 will change the owner of the file referenced by
 381 .Dq Li slink .
 382 If
 383 .Dq Li slink
 384 references a directory,
 385 .Nm chown
 386 will traverse the file hierarchy rooted in the directory that it
 387 references.
 388 In addition, if any symbolic links are encountered in any file tree that
 389 .Nm chown
 390 traverses, they will be treated in the same fashion as
 391 .Dq Li slink .
 392 .Pp
 393 As consistently as possible, you can specify the default behavior by
 394 specifying the
 395 .Fl P
 396 (for
 397 .Dq physical )
 398 flag.
 399 This flag is intended to make the entire name space look like the
 400 physical name space.
 401 .Pp
 402 For commands that do not by default do file tree traversals, the
 403 .Fl H ,
 404 .Fl L
 405 and
 406 .Fl P
 407 flags are ignored if the
 408 .Fl R
 409 flag is not also specified.
 410 In addition, you may specify the
 411 .Fl H ,
 412 .Fl L
 413 and
 414 .Fl P
 415 options more than once; the last one specified determines the
 416 command's behavior.
 417 This is intended to permit you to alias commands to behave one way
 418 or the other, and then override that behavior on the command line.
 419 .Pp
 420 The
 421 .Xr ls 1
 422 and
 423 .Xr rm 1
 424 commands have exceptions to these rules.
 425 The
 426 .Nm rm
 427 command operates on the symbolic link, and not the file it references,
 428 and therefore never follows a symbolic link.
 429 The
 430 .Nm rm
 431 command does not support the
 432 .Fl H ,
 433 .Fl L
 434 or
 435 .Fl P
 436 options.
 437 .Pp
 438 To maintain compatibility with historic systems,
 439 the
 440 .Nm ls
 441 command acts a little differently.
 442 If you do not specify the
 443 .Fl F ,
 444 .Fl d
 445 or
 446 .Fl l
 447 options,
 448 .Nm ls
 449 will follow symbolic links specified on the command line.
 450 If the
 451 .Fl L
 452 flag is specified,
 453 .Nm ls
 454 follows all symbolic links,
 455 regardless of their type,
 456 whether specified on the command line or encountered in the tree walk.
 457 .Sh SEE ALSO
 458 .Xr chflags 1 ,
 459 .Xr chgrp 1 ,
 460 .Xr chmod 1 ,
 461 .Xr cp 1 ,
 462 .Xr du 1 ,
 463 .Xr find 1 ,
 464 .Xr ln 1 ,
 465 .Xr ls 1 ,
 466 .Xr mv 1 ,
 467 .Xr pax 1 ,
 468 .Xr rm 1 ,
 469 .Xr tar 1 ,
 470 .Xr lchflags 2 ,
 471 .Xr lchmod 2 ,
 472 .Xr lchown 2 ,
 473 .Xr lstat 2 ,
 474 .Xr lutimes 2 ,
 475 .Xr readlink 2 ,
 476 .Xr rename 2 ,
 477 .Xr symlink 2 ,
 478 .Xr unlink 2 ,
 479 .Xr fts 3 ,
 480 .Xr remove 3 ,
 481 .Xr chown 8