bin/ln/ln.1

   1 .\" Copyright (c) 1980, 1990, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" This code is derived from software contributed to Berkeley by
   5 .\" the Institute of Electrical and Electronics Engineers, Inc.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\" 3. All advertising materials mentioning features or use of this software
  16 .\"    must display the following acknowledgement:
  17 .\"     This product includes software developed by the University of
  18 .\"     California, Berkeley and its contributors.
  19 .\" 4. Neither the name of the University nor the names of its contributors
  20 .\"    may be used to endorse or promote products derived from this software
  21 .\"    without specific prior written permission.
  22 .\"
  23 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33 .\" SUCH DAMAGE.
  34 .\"
  35 .\"     @(#)ln.1        8.2 (Berkeley) 12/30/93
  36 .\" $FreeBSD$
  37 .\"
  38 .Dd December 30, 1993
  39 .Dt LN 1
  40 .Os BSD 4
  41 .Sh NAME
  42 .Nm ln ,
  43 .Nm link
  44 .Nd make links
  45 .Sh SYNOPSIS
  46 .Nm ln
  47 .Op Fl fsv
  48 .Ar source_file
  49 .Op target_file
  50 .Nm ln
  51 .Op Fl fsv
  52 .Ar source_file ...
  53 .Op target_dir
  54 .Nm link
  55 .Ar source_file Ar target_file
  56 .Sh DESCRIPTION
  57 The
  58 .Nm
  59 utility creates a new directory entry (linked file) which has the
  60 same modes as the original file.
  61 It is useful for maintaining multiple copies of a file in many places
  62 at once without using up storage for the
  63 .Dq copies ;
  64 instead, a link
  65 .Dq points
  66 to the original copy.
  67 There are two types of links; hard links and symbolic links.
  68 How a link
  69 .Dq points
  70 to a file is one of the differences between a hard and symbolic link.
  71 .Pp
  72 The options are as follows:
  73 .Bl -tag -width flag
  74 .It Fl f
  75 Unlink any already existing file, permitting the link to occur.
  76 .It Fl s
  77 Create a symbolic link.
  78 .It Fl v
  79 Cause
  80 .Nm
  81 to be verbose, showing files as they are processed.
  82 .El
  83 .Pp
  84 By default,
  85 .Nm
  86 makes
  87 .Em hard
  88 links.
  89 A hard link to a file is indistinguishable from the original directory entry;
  90 any changes to a file are effectively independent of the name used to reference
  91 the file.
  92 Hard links may not normally refer to directories and may not span file systems.
  93 .Pp
  94 A symbolic link contains the name of the file to
  95 which it is linked.  The referenced file is used when an
  96 .Xr open  2
  97 operation is performed on the link.
  98 A
  99 .Xr stat  2
 100 on a symbolic link will return the linked-to file; an
 101 .Xr lstat  2
 102 must be done to obtain information about the link.
 103 The
 104 .Xr readlink  2
 105 call may be used to read the contents of a symbolic link.
 106 Symbolic links may span file systems and may refer to directories.
 107 .Pp
 108 Given one or two arguments,
 109 .Nm
 110 creates a link to an existing file
 111 .Ar source_file  .
 112 If
 113 .Ar target_file
 114 is given, the link has that name;
 115 .Ar target_file
 116 may also be a directory in which to place the link;
 117 otherwise it is placed in the current directory.
 118 If only the directory is specified, the link will be made
 119 to the last component of
 120 .Ar source_file  .
 121 .Pp
 122 Given more than two arguments,
 123 .Nm
 124 makes links in
 125 .Ar target_dir
 126 to all the named source files.
 127 The links made will have the same name as the files being linked to.
 128 .Pp
 129 When the utility is called as
 130 .Nm link ,
 131 exactly two arguments must be supplied,
 132 neither of which may specify a directory.
 133 No options may be supplied in this simple mode of operation,
 134 which performs a
 135 .Xr link 2
 136 operation using the two passed arguments.
 137 .Sh SEE ALSO
 138 .Xr link 2 ,
 139 .Xr lstat 2 ,
 140 .Xr readlink 2 ,
 141 .Xr stat 2 ,
 142 .Xr symlink 2 ,
 143 .Xr symlink 7
 144 .Sh COMPATIBILITY
 145 The
 146 .Fl v
 147 option is non-standard and its use in scripts is not recommended.
 148 .Sh HISTORY
 149 An
 150 .Nm
 151 command appeared in
 152 .At v1 .
 153 The simplified
 154 .Nm link
 155 command conforms to
 156 .St -susv2 .