Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

symlink(2) [ultrix man page]

symlink(2)							System Calls Manual							symlink(2)

Name
       symlink - make symbolic link to a file

Syntax
       symlink(name1, name2)
       char *name1, *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 can be an arbitrary path name.  The files need not be on the same file system.

Return Values
       Upon successful completion, a zero (0) value is returned.  If an error occurs, the error code is  stored  in  errno,  and  a  -1  value	is
       returned.

Diagnostics
       The symbolic link is made, unless one or more of the following are true:

       [ENOTDIR]      A component of the name2 prefix is not a directory.

       [EEXIST]       The name2 already exists.

       [EACCES]       A component of the name2 path prefix denies search permission.

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

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

       [ELOOP]	      Too many symbolic links were encountered in translating the pathname.

       [ENAMETOOLONG] A  component of either pathname exceeded MAXNAMELEN characters, or the entire length of either pathname exceeded MAXPATHNAME
		      characters.

       [ENOENT]       The named file does not exist.

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

       [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 containing 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 user's symbolic link is being created has been exhausted.

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

       [ETIMEDOUT]    A  connect  request  or remote file operation failed, because the connected party did not properly respond after a period of
		      time that is dependent on the communications protocol.

See Also
       ln(1), link(2), readlink(2), stat(2), unlink(2)

																	symlink(2)

Check Out this Related Man Page

symlink(2)							   System Calls 							symlink(2)

NAME
symlink - make a symbolic link to a file SYNOPSIS
#include <unistd.h> int symlink(const char *name1, const char *name2); DESCRIPTION
The symlink() function creates a symbolic link name2 to the file name1. Either name may be an arbitrary pathname, the files need not be on the same file system, and name1 may be nonexistent. The file to which the symbolic link points is used when an open(2) operation is performed on the link. A stat() operation performed on a symbolic link returns the linked-to file, while an lstat() operation returns information about the link itself. See stat(2). Unexpected results may occur when a symbolic link is made to a directory. To avoid confusion in applications, the readlink(2) call can be used to read the contents of a symbolic link. RETURN VALUES
Upon successful completion, 0 is returned. Otherwise, -1 is returned, errno is set to indicate the error, and the symbolic link is not made. ERRORS
The symlink() function will fail if: EACCES Search permission is denied for a component of the path prefix of name2. EDQUOT The directory where the entry for the new symbolic link is being placed cannot be extended because the user's quota of disk blocks on that file system has been exhausted; the new symbolic link cannot be created because the user's quota of disk blocks on that file system has been exhausted; or the user's quota of inodes on the file system where the file is being created has been exhausted. EEXIST The file referred to by name2 already exists. EFAULT The name1 or name2 argument points to an illegal address. EILSEQ 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. EIO An I/O error occurs while reading from or writing to the file system. ELOOP Too many symbolic links are encountered in translating name2. ENAMETOOLONG The length of the name2 argument exceeds PATH_MAX, or the length of a name2 component exceeds NAME_MAX while _POSIX_NO_TRUNC is in effect. ENOENT A component of the path prefix of name2 does not exist. ENOSPC The directory in which the entry for the new symbolic link is being placed cannot be extended because no space is left on the file system containing the directory; the new symbolic link cannot be created because no space is left on the file sys- tem which will contain the link; or there are no free inodes on the file system on which the file is being created. ENOSYS The file system does not support symbolic links. ENOTDIR A component of the path prefix of name2 is not a directory. EROFS The file name2 would reside on a read-only file system. ATTRIBUTES
See attributes(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |Interface Stability |Standard | +-----------------------------+-----------------------------+ SEE ALSO
cp(1), link(2), open(2), readlink(2), stat(2), unlink(2), attributes(5) SunOS 5.11 18 May 2007 symlink(2)
Man Page