Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

rmdir(2) [osf1 man page]

rmdir(2)							System Calls Manual							  rmdir(2)

NAME
rmdir - Removes a directory file SYNOPSIS
#include <unistd.h> int rmdir ( const char *path ); STANDARDS
Interfaces documented on this reference page conform to industry standards as follows: rmdir(): XSH5.0 Refer to the standards(5) reference page for more information about industry standards and associated tags. PARAMETERS
Specifies the directory pathname. The final component of the path parameter cannot be a symbolic link. DESCRIPTION
The rmdir() function removes the directory specified by the path parameter. The directory is removed only if it is an empty directory. For the rmdir() function to execute successfully, the calling process must have write access to the parent directory of the path parameter with respect to all of the system's access control policies. If the directory's link count becomes 0 (zero) and no process has the directory open, the space occupied by the directory is freed and the directory is no longer accessible. If one or more processes have the directory open when the last link is removed, the . (dot) and .. (dot-dot) entries, if present, are removed before the rmdir() function returns, and no new entries may be created in the directory. How- ever, the directory is not removed until all references to the directory have been closed. Upon successful completion, the rmdir() function marks the st_ctime and st_mtime fields of the parent directory for update. RETURN VALUES
Upon successful completion, the rmdir() function returns a value of 0 (zero). If the rmdir() function fails, a value of -1 is returned and errno is set to indicate the error. ERRORS
If the rmdir() function fails, the directory is not deleted and errno may be set to one of the following values: Search permission is denied on a component of the path parameter, or write permission is denied on the parent directory of the directory to be removed. The process does not have write access to the parent directory with respect to one of the system's access control policies. The directory is in use as either the mount point for a file system or the current directory of the process that issued the rmdir() function. The directory named by the path parameter is not empty. The path parameter is an invalid address. While reading from or writing to the file system, an I/O error occurred. Too many links were encountered in translating path. The length of the path parameter exceeds PATH_MAX, or a pathname component is longer than NAME_MAX. The directory named by the path parameter does not exist or is an empty string. A component of the path parameter is not a directory. The S_ISVTX flag is set on the parent directory of the directory to be removed, and the caller is not the file owner. The directory named by the path parameter resides on a read-only file system. [Tru64 UNIX] For NFS file access, if the rmdir() function fails, errno may also be set to one of the following values: The file position pointer associated with the filedes parameter was negative. Indicates either that the system file table is full, or that there are too many files currently open in the system. Indicates a stale NFS file handle. An opened file was deleted by the server or another client; a client cannot open a file because the server has unmounted or unexported the remote directory; or the directory that contains an opened file was either unmounted or unexported by the server. RELATED INFORMATION
Functions: chmod(2), mkdir(2), mknod(2), rename(2), umask(2), unlink(2), mkfifo(3), remove(3) Standards: standards(5) delim off rmdir(2)

Check Out this Related Man Page

mkdir(2)							System Calls Manual							  mkdir(2)

NAME
mkdir - Creates a directory SYNOPSIS
#include <sys/stat.h> #include <sys/types.h> int mkdir ( const char *path, mode_t mode ); STANDARDS
Interfaces documented on this reference page conform to industry standards as follows: mkdir(): XSH5.0 Refer to the standards(5) reference page for more information about industry standards and associated tags. PARAMETERS
Specifies the name of the new directory. [Tru64 UNIX] If NFS is installed on your system, this path can cross into another node. In this case, the new directory is created at that node. If the final component of the path parameter refers to a symbolic link, the link is traversed and pathname resolution continues. Specifies the mask for the read, write, and execute (RWX) flags for owner, group, and others. DESCRIPTION
The mkdir() function creates a new directory with the following attributes: The owner ID is set to the process's effective user ID. The group ID is set to the group ID of its parent directory. [Tru64 UNIX] However, if the sys_v_mode tunable is set, then the group ID of the file is set to the effective group ID of the process. With exception, if the S_ISGID bit of the parent directory is set, the group ID of the file is set to the group ID of the parent directory and its S_ISGID bit is set. If the group ID of the new file does not match the effective group of the process or one of the supplementary group IDs of the process, the S_ISGID bit of the new file is cleared. Permission and attribute bits are set according to the value of the mode parameter modified by the process's file creation mask (see the umask() function). This parameter is constructed by logically ORing values described in the sys/mode.h header file. The new directory is empty, except for . (dot) and .. (dot-dot). To execute the mkdir() function, a process must have search permission to get to the parent directory of the path parameter and write per- mission in the parent directory of the path parameter with respect to all of the system's configured access control policies. Upon successful completion, the mkdir() function marks the st_atime, st_ctime, and st_mtime fields of the directory for update, and marks the st_ctime and st_mtime fields of the new directory's parent directory for update. RETURN VALUES
Upon successful completion, the mkdir() function returns a value of 0 (zero). If the mkdir() function fails, a value of -1 is returned, and errno is set to indicate the error. ERRORS
If the mkdir() function fails, the directory is not created and errno may be set to one of the following values: Creating the requested directory requires writing in a directory with a mode that denies write permission, or search permission is denied on the parent directory of the directory to be created. The process does not have write access to the parent directory with respect to one of the system's access policies. The directory in which the entry for the new link is being placed cannot be extended because the user's quota of disk blocks or i-nodes on the file system containing the directory is exhausted. The named file already exists. The path parameter is an invalid address. The owner or group ID is not a value that is supported by this implementation. A physical I/O error has occurred. Too many links were encountered in translating path. The link count of the parent directory would exceed LINK_MAX. The length of the path parame- ter exceeds PATH_MAX or a pathname component is longer than NAME_MAX. A component of the path parameter does not exist or points to an empty string. Unable to allocate a directory buffer. The file system does not contain enough space to hold the contents of the new direc- tory or to extend the parent directory of the new directory. A component of the path prefix is not a directory. The named file resides on a read-only file system. [Tru64 UNIX] For NFS file access, if the mkdir() function fails, errno may also be set to one of the following values: Indicates either that the system file table is full, or that there are too many files currently open in the system. Indicates a stale NFS file handle. A client cannot make a directory because the server has unmounted or unexported the remote directory. RELATED INFORMATION
Commands: chmod(1), mkdir(1), mknod(8) Functions: chmod(2), mknod(2), rmdir(2), umask(2) Standards: standards(5) delim off mkdir(2)
Man Page