~sircmpwn/ctools

c4758148e06b60c4dc97fb4482eef14da41b5f10 — Drew DeVault 1 year, 2 months ago 19b01a8
link, unlink: add man pages
3 files changed, 64 insertions(+), 0 deletions(-)

A doc/link.1.scd
M doc/meson.build
A doc/unlink.1.scd
A doc/link.1.scd => doc/link.1.scd +30 -0
@@ 0,0 1,30 @@
link(1) "ctools"

# NAME

link - create a hard link

# SYNOPSIS

*link* _file1_ _file2_

# DESCRIPTION

*link* creates a hard link from _file1_ to _file2_. A hard link creates a new
directory entry which refers to the same underlying file.

# UNSPECIFIED BEHAVIOR

The POSIX standard does not unambiguously specify the behavior of this command
under certain conditions. Under such conditions, the ctools implementation of
*link* behaves as follows:

- If _file1_ is a symbolic link, *link* will exit with an error without
  creating a link.

# DISCLAIMER

This command is part of ctools and is compatible with POSIX-1.2017, and may
optionally support XSI extensions. This man page is not intended to be a
complete reference, and where it disagrees with the specification, the
specification takes precedence.

M doc/meson.build => doc/meson.build +2 -0
@@ 11,8 11,10 @@ man_files = [
	'cksum.1',
	'cmp.1',
	'comm.1',
	'link.1',
	'false.1',
	'true.1',
	'unlink.1',
]

foreach page : man_files

A doc/unlink.1.scd => doc/unlink.1.scd +32 -0
@@ 0,0 1,32 @@
unlink(1) "ctools"

# NAME

unlink - unlink a file

# SYNOPSIS

*unlink* _file1_

# DESCRIPTION

*unlink* will unlink a file. This removes the directory entry and decrements
the reference count on the inode, reclaiming the disk space if the reference
count is zero (the reference count will be nonzero if a hard link has been made
with *link*(1) or by some other means).

# UNSPECIFIED BEHAVIOR

The POSIX standard does not unambiguously specify the behavior of this command
under certain conditions. Under such conditions, the ctools implementation of
*unlink* behaves as follows:

- If _file1_ is a symbolic link, *unlink* will exit with an error without
  unlinking the file.

# DISCLAIMER

This command is part of ctools and is compatible with POSIX-1.2017, and may
optionally support XSI extensions. This man page is not intended to be a
complete reference, and where it disagrees with the specification, the
specification takes precedence.