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