BSD 4_4 release

[unix-history] / usr / src / bin / ln / ln.1

diff --git a/usr/src/bin/ln/ln.1 b/usr/src/bin/ln/ln.1
index 78b1969..03da2c2 100644 (file)
--- a/usr/src/bin/ln/ln.1
+++ b/usr/src/bin/ln/ln.1
@@ -1,80 +1,131 @@
-.\" Copyright (c) 1980 Regents of the University of California.
-.\" All rights reserved.  The Berkeley software License Agreement
-.\" specifies the terms and conditions for redistribution.
+.\" Copyright (c) 1980, 1990, 1993
+.\"    The Regents of the University of California.  All rights reserved.

 .\"
 .\"

-.\"    @(#)ln.1        6.2 (Berkeley) %G%
+.\" This code is derived from software contributed to Berkeley by
+.\" the Institute of Electrical and Electronics Engineers, Inc.

 .\"
 .\"

-.TH LN 1 ""
-.UC 4
-.SH NAME
-ln \- make links
-.SH SYNOPSIS
-.B ln
-[
-.B \-s
-]
-sourcename [ targetname ]
-.br
-.B ln
-[
-.B \-s
-]
-sourcename1 sourcename2 [ sourcename3 ... ] targetdirectory
-.SH DESCRIPTION
-A link is a directory entry referring
-to a file; the same file (together with
-its size, all its protection
-information, etc.)
-may have several links to it.
-There are two kinds of links: hard links and symbolic links.
-.PP
-By default
-.I ln
-makes hard links.
-A hard link to a file is indistinguishable from the
-original directory entry; any changes to a
-file are effective independent of the name used
-to reference the file.
-Hard links may not span file systems and may not refer to directories.
-.PP
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\"    @(#)ln.1        8.1 (Berkeley) 5/31/93
+.\"
+.Dd May 31, 1993
+.Dt LN 1
+.Os BSD 4
+.Sh NAME
+.Nm ln
+.Nd make links
+.Sh SYNOPSIS
+.Nm ln
+.Op Fl fs
+.Ar source_file
+.Op target_file
+.Nm ln
+.Op Fl fs
+.Ar source_file ...
+.Op target_dir
+.Sh DESCRIPTION

 The
 The

-.B \-s
-option causes
-.I ln
-to create symbolic links.
+.Nm ln
+utility creates a new directory entry (linked file) which has the
+same modes as the orginal file.
+It is useful for maintaining multiple copies of a file in many places
+at once without using up storage for the
+.Dq copies ;
+instead, a link
+.Dq points
+to the original copy.
+There are two types of links; hard links and symbolic links.
+How a link
+.Dq points
+to a file is one of the differences between a hard or symbolic link.
+.Pp
+The options are as follows:
+.Bl -tag -width flag
+.It Fl f
+Unlink any already existing file, permitting the link to occur.
+.It Fl s
+Create a symbolic link.
+.El
+.Pp
+By default
+.Nm ln
+makes
+.Em hard
+links.
+A hard link to a file is indistinguishable from the original directory entry;
+any changes to a file are effective independent of the name used to reference
+the file.
+Hard links may not normally refer to directories and may not span file systems.
+.Pp

 A symbolic link contains the name of the file to
 which it is linked.  The referenced file is used when an
 A symbolic link contains the name of the file to
 which it is linked.  The referenced file is used when an

-.IR open (2)
+.Xr open  2

 operation is performed on the link.
 A
 operation is performed on the link.
 A

-.IR stat (2)
+.Xr stat  2

 on a symbolic link will return the linked-to file; an
 on a symbolic link will return the linked-to file; an

-.IR lstat (2)
+.Xr lstat  2

 must be done to obtain information about the link.
 The
 must be done to obtain information about the link.
 The

-.IR readlink (2)
+.Xr readlink  2

 call may be used to read the contents of a symbolic link.
 Symbolic links may span file systems and may refer to directories.
 call may be used to read the contents of a symbolic link.
 Symbolic links may span file systems and may refer to directories.

-.PP
+.Pp

 Given one or two arguments,
 Given one or two arguments,

-.I ln
+.Nm ln

 creates a link to an existing file
 creates a link to an existing file

-.IR sourcename .
+.Ar source_file  .

 If
 If

-.I targetname
+.Ar target_file

 is given, the link has that name;
 is given, the link has that name;

-.I targetname
+.Ar target_file

 may also be a directory in which to place the link;
 otherwise it is placed in the current directory.
 If only the directory is specified, the link will be made
 to the last component of
 may also be a directory in which to place the link;
 otherwise it is placed in the current directory.
 If only the directory is specified, the link will be made
 to the last component of

-.IR sourcename .
-.PP
+.Ar source_file  .
+.Pp

 Given more than two arguments,
 Given more than two arguments,

-.I ln
-makes links in 
-.I targetdirectory
+.Nm ln
+makes links in
+.Ar target_dir

 to all the named source files.
 The links made will have the same name as the files being linked to.
 to all the named source files.
 The links made will have the same name as the files being linked to.

-.SH "SEE ALSO"
-rm(1), cp(1), mv(1), link(2), readlink(2), stat(2), symlink(2)
+.Sh SEE ALSO
+.Xr link 2 ,
+.Xr lstat 2 ,
+.Xr readlink 2 ,
+.Xr stat 2 ,
+.Xr symlink 2 ,
+.Xr symlink 7
+.Sh HISTORY
+A
+.Nm ln
+command appeared in
+.At v6 .