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 February 16, 2015
  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 chflagsat 2 ,
 150 .Xr fchmodat 2 ,
 151 .Xr fchownat 2 ,
 152 .Xr fstatat 2
 153 and
 154 .Xr utimensat 2 .
 155 .Pp
 156 The owner and group of an existing symbolic link can be changed by
 157 means of the
 158 .Xr lchown 2
 159 system call.
 160 The flags, access permissions, owner/group and modification time of
 161 an existing symbolic link can be changed by means of the
 162 .Xr lchflags 2 ,
 163 .Xr lchmod 2 ,
 164 .Xr lchown 2 ,
 165 and
 166 .Xr lutimes 2
 167 system calls, respectively.
 168 Of these, only the flags and ownership are used by the system;
 169 the access permissions are ignored.
 170 .Pp
 171 The
 172 .Bx 4.4
 173 system differs from historical
 174 .Bx 4
 175 systems in that the system call
 176 .Xr chown 2
 177 has been changed to follow symbolic links.
 178 The
 179 .Xr lchown 2
 180 system call was added later when the limitations of the new
 181 .Xr chown 2
 182 became apparent.
 183 .Ss Commands not traversing a file tree.
 184 The second area is symbolic links, specified as command line file
 185 name arguments, to commands which are not traversing a file tree.
 186 .Pp
 187 Except as noted below, commands follow symbolic links named as command
 188 line arguments.
 189 For example, if there were a symbolic link
 190 .Dq Li slink
 191 which pointed to a file named
 192 .Dq Li afile ,
 193 the command
 194 .Dq Li cat slink
 195 would display the contents of the file
 196 .Dq Li afile .
 197 .Pp
 198 It is important to realize that this rule includes commands which may
 199 optionally traverse file trees, e.g.\& the command
 200 .Dq Li "chown file"
 201 is included in this rule, while the command
 202 .Dq Li "chown -R file"
 203 is not.
 204 (The latter is described in the third area, below.)
 205 .Pp
 206 If it is explicitly intended that the command operate on the symbolic
 207 link instead of following the symbolic link, e.g., it is desired that
 208 .Dq Li "chown slink"
 209 change the ownership of the file that
 210 .Dq Li slink
 211 is, whether it is a symbolic link or not, the
 212 .Fl h
 213 option should be used.
 214 In the above example,
 215 .Dq Li "chown root slink"
 216 would change the ownership of the file referenced by
 217 .Dq Li slink ,
 218 while
 219 .Dq Li "chown -h root slink"
 220 would change the ownership of
 221 .Dq Li slink
 222 itself.
 223 .Pp
 224 There are five exceptions to this rule.
 225 The
 226 .Xr mv 1
 227 and
 228 .Xr rm 1
 229 commands do not follow symbolic links named as arguments,
 230 but respectively attempt to rename and delete them.
 231 (Note, if the symbolic link references a file via a relative path,
 232 moving it to another directory may very well cause it to stop working,
 233 since the path may no longer be correct.)
 234 .Pp
 235 The
 236 .Xr ls 1
 237 command is also an exception to this rule.
 238 For compatibility with historic systems (when
 239 .Nm ls
 240 is not doing a tree walk, i.e., the
 241 .Fl R
 242 option is not specified),
 243 the
 244 .Nm ls
 245 command follows symbolic links named as arguments if the
 246 .Fl H
 247 or
 248 .Fl L
 249 option is specified,
 250 or if the
 251 .Fl F ,
 252 .Fl d
 253 or
 254 .Fl l
 255 options are not specified.
 256 (The
 257 .Nm ls
 258 command is the only command where the
 259 .Fl H
 260 and
 261 .Fl L
 262 options affect its behavior even though it is not doing a walk of
 263 a file tree.)
 264 .Pp
 265 The
 266 .Xr file 1
 267 and
 268 .Xr stat 1
 269 commands are also exceptions to this rule.
 270 These
 271 commands do not follow symbolic links named as argument by default,
 272 but do follow symbolic links named as argument if the
 273 .Fl L
 274 option is specified.
 275 .Pp
 276 The
 277 .Bx 4.4
 278 system differs from historical
 279 .Bx 4
 280 systems in that the
 281 .Nm chown
 282 and
 283 .Nm chgrp
 284 commands follow symbolic links specified on the command line.
 285 .Ss Commands traversing a file tree.
 286 The following commands either optionally or always traverse file trees:
 287 .Xr chflags 1 ,
 288 .Xr chgrp 1 ,
 289 .Xr chmod 1 ,
 290 .Xr cp 1 ,
 291 .Xr du 1 ,
 292 .Xr find 1 ,
 293 .Xr ls 1 ,
 294 .Xr pax 1 ,
 295 .Xr rm 1 ,
 296 .Xr tar 1
 297 and
 298 .Xr chown 8 .
 299 .Pp
 300 It is important to realize that the following rules apply equally to
 301 symbolic links encountered during the file tree traversal and symbolic
 302 links listed as command line arguments.
 303 .Pp
 304 The first rule applies to symbolic links that reference files that are
 305 not of type directory.
 306 Operations that apply to symbolic links are performed on the links
 307 themselves, but otherwise the links are ignored.
 308 .Pp
 309 The command
 310 .Dq Li "rm -r slink directory"
 311 will remove
 312 .Dq Li slink ,
 313 as well as any symbolic links encountered in the tree traversal of
 314 .Dq Li directory ,
 315 because symbolic links may be removed.
 316 In no case will
 317 .Nm rm
 318 affect the file which
 319 .Dq Li slink
 320 references in any way.
 321 .Pp
 322 The second rule applies to symbolic links that reference files of type
 323 directory.
 324 Symbolic links which reference files of type directory are never
 325 .Dq followed
 326 by default.
 327 This is often referred to as a
 328 .Dq physical
 329 walk, as opposed to a
 330 .Dq logical
 331 walk (where symbolic links referencing directories are followed).
 332 .Pp
 333 As consistently as possible, you can make commands doing a file tree
 334 walk follow any symbolic links named on the command line, regardless
 335 of the type of file they reference, by specifying the
 336 .Fl H
 337 (for
 338 .Dq half\-logical )
 339 flag.
 340 This flag is intended to make the command line name space look
 341 like the logical name space.
 342 (Note, for commands that do not always do file tree traversals, the
 343 .Fl H
 344 flag will be ignored if the
 345 .Fl R
 346 flag is not also specified.)
 347 .Pp
 348 For example, the command
 349 .Dq Li "chown -HR user slink"
 350 will traverse the file hierarchy rooted in the file pointed to by
 351 .Dq Li slink .
 352 Note, the
 353 .Fl H
 354 is not the same as the previously discussed
 355 .Fl h
 356 flag.
 357 The
 358 .Fl H
 359 flag causes symbolic links specified on the command line to be
 360 dereferenced both for the purposes of the action to be performed
 361 and the tree walk, and it is as if the user had specified the
 362 name of the file to which the symbolic link pointed.
 363 .Pp
 364 As consistently as possible, you can make commands doing a file tree
 365 walk follow any symbolic links named on the command line, as well as
 366 any symbolic links encountered during the traversal, regardless of
 367 the type of file they reference, by specifying the
 368 .Fl L
 369 (for
 370 .Dq logical )
 371 flag.
 372 This flag is intended to make the entire name space look like
 373 the logical name space.
 374 (Note, for commands that do not always do file tree traversals, the
 375 .Fl L
 376 flag will be ignored if the
 377 .Fl R
 378 flag is not also specified.)
 379 .Pp
 380 For example, the command
 381 .Dq Li "chown -LR user slink"
 382 will change the owner of the file referenced by
 383 .Dq Li slink .
 384 If
 385 .Dq Li slink
 386 references a directory,
 387 .Nm chown
 388 will traverse the file hierarchy rooted in the directory that it
 389 references.
 390 In addition, if any symbolic links are encountered in any file tree that
 391 .Nm chown
 392 traverses, they will be treated in the same fashion as
 393 .Dq Li slink .
 394 .Pp
 395 As consistently as possible, you can specify the default behavior by
 396 specifying the
 397 .Fl P
 398 (for
 399 .Dq physical )
 400 flag.
 401 This flag is intended to make the entire name space look like the
 402 physical name space.
 403 .Pp
 404 For commands that do not by default do file tree traversals, the
 405 .Fl H ,
 406 .Fl L
 407 and
 408 .Fl P
 409 flags are ignored if the
 410 .Fl R
 411 flag is not also specified.
 412 In addition, you may specify the
 413 .Fl H ,
 414 .Fl L
 415 and
 416 .Fl P
 417 options more than once; the last one specified determines the
 418 command's behavior.
 419 This is intended to permit you to alias commands to behave one way
 420 or the other, and then override that behavior on the command line.
 421 .Pp
 422 The
 423 .Xr ls 1
 424 and
 425 .Xr rm 1
 426 commands have exceptions to these rules.
 427 The
 428 .Nm rm
 429 command operates on the symbolic link, and not the file it references,
 430 and therefore never follows a symbolic link.
 431 The
 432 .Nm rm
 433 command does not support the
 434 .Fl H ,
 435 .Fl L
 436 or
 437 .Fl P
 438 options.
 439 .Pp
 440 To maintain compatibility with historic systems,
 441 the
 442 .Nm ls
 443 command acts a little differently.
 444 If you do not specify the
 445 .Fl F ,
 446 .Fl d
 447 or
 448 .Fl l
 449 options,
 450 .Nm ls
 451 will follow symbolic links specified on the command line.
 452 If the
 453 .Fl L
 454 flag is specified,
 455 .Nm ls
 456 follows all symbolic links,
 457 regardless of their type,
 458 whether specified on the command line or encountered in the tree walk.
 459 .Sh SEE ALSO
 460 .Xr chflags 1 ,
 461 .Xr chgrp 1 ,
 462 .Xr chmod 1 ,
 463 .Xr cp 1 ,
 464 .Xr du 1 ,
 465 .Xr find 1 ,
 466 .Xr ln 1 ,
 467 .Xr ls 1 ,
 468 .Xr mv 1 ,
 469 .Xr pax 1 ,
 470 .Xr rm 1 ,
 471 .Xr tar 1 ,
 472 .Xr lchflags 2 ,
 473 .Xr lchmod 2 ,
 474 .Xr lchown 2 ,
 475 .Xr lstat 2 ,
 476 .Xr lutimes 2 ,
 477 .Xr readlink 2 ,
 478 .Xr rename 2 ,
 479 .Xr symlink 2 ,
 480 .Xr unlink 2 ,
 481 .Xr fts 3 ,
 482 .Xr remove 3 ,
 483 .Xr chown 8