Skip site navigation (1)Skip section navigation (2)

FreeBSD Man Pages

Man Page or Keyword Search:
Man Architecture
Apropos Keyword Search (all sections) Output format
home | help
SYMLINK(2)		  FreeBSD System Calls Manual		    SYMLINK(2)

NAME
     symlink --	make symbolic link to a	file

LIBRARY
     Standard C	Library	(libc, -lc)

SYNOPSIS
     #include <unistd.h>

     int
     symlink(const char	*name1,	const char *name2);

DESCRIPTION
     A symbolic	link name2 is created to name1 (name2 is the name of the file
     created, name1 is the string used in creating the symbolic	link).	Either
     name may be an arbitrary path name; the files need	not be on the same
     file system.

RETURN VALUES
     The symlink() function returns the	value 0	if successful; otherwise the
     value -1 is returned and the global variable errno	is set to indicate the
     error.

ERRORS
     The symbolic link succeeds	unless:

     [ENOTDIR]		A component of the name2 path prefix is	not a direc-
			tory.

     [ENAMETOOLONG]	A component of the name2 pathname exceeded 255 charac-
			ters, or the entire length of either path name
			exceeded 1023 characters.

     [ENOENT]		A component of the name2 path prefix does not exist.

     [EACCES]		A component of the name2 path prefix denies search
			permission, or write permission	is denied on the par-
			ent directory of the file to be	created.

     [ELOOP]		Too many symbolic links	were encountered in translat-
			ing the	name2 path name.

     [EEXIST]		The path name pointed at by the	name2 argument already
			exists.

     [EPERM]		The parent directory of	the file named by name2	has
			its immutable flag set,	see the	chflags(2) manual page
			for more information.

     [EIO]		An I/O error occurred while making the directory entry
			for name2, or allocating the inode for name2, or writ-
			ing out	the link contents of name2.

     [EROFS]		The file name2 would reside on a read-only file	sys-
			tem.

     [ENOSPC]		The directory in which the entry for the new symbolic
			link is	being placed cannot be extended	because	there
			is no space left on the	file system containing the
			directory.

     [ENOSPC]		The new	symbolic link cannot be	created	because	there
			is no space left on the	file system that will contain
			the symbolic link.

     [ENOSPC]		There are no free inodes on the	file system on which
			the symbolic link is being created.

     [EDQUOT]		The directory in which the entry for the new symbolic
			link is	being placed cannot be extended	because	the
			user's quota of	disk blocks on the file	system con-
			taining	the directory has been exhausted.

     [EDQUOT]		The new	symbolic link cannot be	created	because	the
			user's quota of	disk blocks on the file	system that
			will contain the symbolic link has been	exhausted.

     [EDQUOT]		The user's quota of inodes on the file system on which
			the symbolic link is being created has been exhausted.

     [EIO]		An I/O error occurred while making the directory entry
			or allocating the inode.

     [EFAULT]		The name1 or name2 argument points outside the
			process's allocated address space.

SEE ALSO
     ln(1), chflags(2),	link(2), lstat(2), readlink(2),	unlink(2), symlink(7)

HISTORY
     The symlink() system call appeared	in 4.2BSD.

FreeBSD	10.1		       December	9, 2006			  FreeBSD 10.1

NAME | LIBRARY | SYNOPSIS | DESCRIPTION | RETURN VALUES | ERRORS | SEE ALSO | HISTORY

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=symlink&sektion=2&manpath=FreeBSD+7.2-RELEASE>

home | help