1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
|
'\" te
.\" Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
.\" Copyright 1989 AT&T
.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
.TH LINK 2 "May 18, 2007"
.SH NAME
link \- link to a file
.SH SYNOPSIS
.LP
.nf
#include <unistd.h>
\fBint\fR \fBlink\fR(\fBconst char *\fR\fIexisting\fR, \fBconst char *\fR\fInew\fR);
.fi
.SH DESCRIPTION
.sp
.LP
The \fBlink()\fR function creates a new link (directory entry) for the existing
file and increments its link count by one. The \fIexisting\fR argument points
to a path name naming an existing file. The \fInew\fR argument points to a
pathname naming the new directory entry to be created.
.sp
.LP
To create hard links, both files must be on the same file system. Both the old
and the new link share equal access and rights to the underlying object.
Privileged processes can make multiple links to a directory. Unless the caller
is privileged, the file named by \fIexisting\fR must not be a directory.
.sp
.LP
Upon successful completion, \fBlink()\fR marks for update the \fBst_ctime\fR
field of the file. Also, the \fBst_ctime\fR and \fBst_mtime\fR fields of the
directory that contains the new entry are marked for update.
.SH RETURN VALUES
.sp
.LP
Upon successful completion, \fB0\fR is returned. Otherwise, \fB\(mi1\fR is
returned, no link is created, and \fBerrno\fR is set to indicate the error.
.SH ERRORS
.sp
.LP
The \fBlink()\fR function will fail if:
.sp
.ne 2
.na
\fB\fBEACCES\fR\fR
.ad
.RS 16n
A component of either path prefix denies search permission, or the requested
link requires writing in a directory with a mode that denies write permission.
.RE
.sp
.ne 2
.na
\fB\fBEDQUOT\fR\fR
.ad
.RS 16n
The directory where the entry for the new link is being placed cannot be
extended because the user's quota of disk blocks on that file system has been
exhausted.
.RE
.sp
.ne 2
.na
\fB\fBEEXIST\fR\fR
.ad
.RS 16n
The link named by \fInew\fR exists.
.RE
.sp
.ne 2
.na
\fB\fBEFAULT\fR\fR
.ad
.RS 16n
The \fIexisting\fR or \fInew\fR argument points to an illegal address.
.RE
.sp
.ne 2
.na
\fB\fBEILSEQ\fR\fR
.ad
.RS 16n
The path argument includes non-UTF8 characters and the file system accepts only
file names where all characters are part of the UTF-8 character codeset.
.RE
.sp
.ne 2
.na
\fB\fBEINTR\fR\fR
.ad
.RS 16n
A signal was caught during the execution of the \fBlink()\fR function.
.RE
.sp
.ne 2
.na
\fB\fBELOOP\fR\fR
.ad
.RS 16n
Too many symbolic links were encountered in translating \fIpath\fR.
.RE
.sp
.ne 2
.na
\fB\fBEMLINK\fR\fR
.ad
.RS 16n
The maximum number of links to a file would be exceeded.
.RE
.sp
.ne 2
.na
\fB\fBENAMETOOLONG\fR\fR
.ad
.RS 16n
The length of the \fIexisting\fR or \fInew\fR argument exceeds \fBPATH_MAX\fR,
or the length of a \fIexisting\fR or \fInew\fR component exceeds \fBNAME_MAX\fR
while \fB_POSIX_NO_TRUNC\fR is in effect.
.RE
.sp
.ne 2
.na
\fB\fBENOENT\fR\fR
.ad
.RS 16n
The \fIexisting\fR or \fInew\fR argument is a null pathname; a component of
either path prefix does not exist; or the file named by \fIexisting\fR does not
exist.
.RE
.sp
.ne 2
.na
\fB\fBENOLINK\fR\fR
.ad
.RS 16n
The \fIexisting\fR or \fInew\fR argument points to a remote machine and the
link to that machine is no longer active.
.RE
.sp
.ne 2
.na
\fB\fBENOSPC\fR\fR
.ad
.RS 16n
The directory that would contain the link cannot be extended.
.RE
.sp
.ne 2
.na
\fB\fBENOTDIR\fR\fR
.ad
.RS 16n
A component of either path prefix is not a directory.
.RE
.sp
.ne 2
.na
\fB\fBEPERM\fR\fR
.ad
.RS 16n
The file named by \fIexisting\fR is a directory and the
{\fBPRIV_SYS_LINKDIR\fR} privilege is not asserted in the effective set of the
calling process.
.sp
The effective user ID does not match the owner of the file and the
{\fBPRIV_FILE_LINK_ANY\fR} privilege is not asserted in the effective set of
the calling process.
.RE
.sp
.ne 2
.na
\fB\fBEROFS\fR\fR
.ad
.RS 16n
The requested link requires writing in a directory on a read-only file system.
.RE
.sp
.ne 2
.na
\fB\fBEXDEV\fR\fR
.ad
.RS 16n
The link named by \fInew\fR and the file named by \fIexisting\fR are on
different logical devices (file systems).
.RE
.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp
.sp
.TS
box;
c | c
l | l .
ATTRIBUTE TYPE ATTRIBUTE VALUE
_
Interface Stability Standard
_
MT-Level Async-Signal-Safe
.TE
.SH SEE ALSO
.sp
.LP
\fBsymlink\fR(2), \fBunlink\fR(2), \fBattributes\fR(5), \fBprivileges\fR(5),
\fBstandards\fR(5)
|
