symlink(2) CLIX symlink(2)
NAME
symlink - Makes a symbolic link to a file
LIBRARY
Berkeley Software Distribution Library (libbsd.a)
SYNOPSIS
int symlink(
char *name1 ,
char *name2 );
PARAMETERS
name1 Specifies the pathname of a file that will be the destination of
the symbolic link.
name2 Specifies the pathname of the symbolic link file to be created.
DESCRIPTION
The name1 and name2 parameters point to pathnames naming files.
A symbolic link name2 is created to name1. (The name2 parameter is the
name of the file created; name1 is the string used in creating the
symbolic link.) Either name may be an arbitrary pathname; the files need
not be on the same file system.
EXAMPLES
To create a symbolic link newfile to refer to a given file:
if (symlink("/usr2/guest/existing_file", "newfile") != 0)
perror("symlink failed");
RETURN VALUES
Upon successful completion, a value of 0 is returned. Otherwise, a value
of -1 is returned and errno is set to indicate the error.
ERRORS
The symlink() function fails if one or more of the following is true:
[NOTDIR] A component of the name2 prefix is not a directory.
[NOENT] The named file does not exist or too many symbolic links were
in the path of name2.
2/94 - Intergraph Corporation 1
symlink(2) CLIX symlink(2)
[ACCES] Search permission is denied for a component of the name2
prefix.
[FAULT] Either name1 or name2 points to an invalid address.
[INTR] A signal was caught during the symlink() functions.
[NOLINK] The name2 parameter points to a remote machine and the link
to that machine is no longer active.
[MULTIHOP] Components of name2 require hopping to multiple remote
machines.
RELATED INFORMATION
Commands: ln(1)
Functions: link(2), unlink(2)
2 Intergraph Corporation - 2/94