unlink - Man Page

call the unlink() function

Prolog

This manual page is part of the POSIX Programmer's Manual. The Linux implementation of this interface may differ (consult the corresponding Linux manual page for details of Linux behavior), or the interface may not be implemented on Linux.

Synopsis

unlink file

Description

The unlink utility shall perform the function call:

unlink(file);

A user may need appropriate privileges to invoke the unlink utility.

Options

None.

Operands

The following operands shall be supported:

file

The pathname of an existing file.

Stdin

Not used.

Input Files

Not used.

Environment Variables

The following environment variables shall affect the execution of unlink:

LANG

Provide a default value for the internationalization variables that are unset or null. (See the Base Definitions volume of POSIX.1-2017, Section 8.2, Internationalization Variables for the precedence of internationalization variables used to determine the values of locale categories.)

LC_ALL

If set to a non-empty string value, override the values of all the other internationalization variables.

LC_CTYPE

Determine the locale for the interpretation of sequences of bytes of text data as characters (for example, single-byte as opposed to multi-byte characters in arguments).

LC_MESSAGES

Determine the locale that should be used to affect the format and contents of diagnostic messages written to standard error.

NLSPATH

Determine the location of message catalogs for the processing of LC_MESSAGES.

Asynchronous Events

Default.

Stdout

None.

Stderr

The standard error shall be used only for diagnostic messages.

Output Files

None.

Extended Description

None.

Exit Status

The following exit values shall be returned:

0

Successful completion.

>0

An error occurred.

Consequences of Errors

Default.

The following sections are informative.

Application Usage

None.

Examples

None.

Rationale

None.

Future Directions

None.

See Also

link, rm

The Base Definitions volume of POSIX.1-2017, Chapter 8, Environment Variables

The System Interfaces volume of POSIX.1-2017, unlink()

Referenced By

link(1p).

2017 IEEE/The Open Group POSIX Programmer's Manual