commit 7faf732d0b88472bdfcefcc9dd8e0257eb33f7d4
Author: FRIGN <[email protected]>
Date: Sun Feb 1 00:43:43 2015 +0100
Edit readlink.1 and document missing flags
diff --git a/README b/README
index c53e24f..246869f 100644
--- a/README
+++ b/README
@@ -53,7 +53,7 @@ The following tools are implemented ('*' == finished, '#' ==
UTF-8 support,
=* printenv non-posix none
printf stolen stolen
=* pwd yes none
-= readlink non-posix none
+= readlink non-posix -e, -m
=* renice yes none
=* rm yes (-i)
=* rmdir yes none
diff --git a/readlink.1 b/readlink.1
index a6a979d..8b4a9d2 100644
--- a/readlink.1
+++ b/readlink.1
@@ -1,31 +1,33 @@
-.Dd January 30, 2015
+.Dd January 31, 2015
.Dt READLINK 1
.Os sbase
.Sh NAME
.Nm readlink
-.Nd print value of a symbolic link or canonical file name
+.Nd print symbolic link target or canonical file name
.Sh SYNOPSIS
.Nm
.Op Fl fn
-.Ar file
+.Ar name
.Sh DESCRIPTION
-The
+If
+.Ar name
+is a symbolic link,
.Nm
-utility when invoked with the pathname of a symbolic link as
-its argument dereferences the symbolic link and prints the name of the target
-on standard output. If the
+writes its target to stdout.
+If
.Fl f
-option is not specified and
+is not set and
+.Ar name
+is not a symbolic link,
.Nm
-is
-invoked with an argument other than the pathname of a symbolic link, it
exits with a nonzero exit code without printing anything.
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl f
-Canonicalize by following every symlink in every component of the
-given path recursively. The argument does not need to be a symbolic
-link.
+Canonicalize
+.Ar name ,
+which does not need to be a symlink,
+by recursively following every symlink in its components.
.It Fl n
Do not output the trailing newline.
.El
diff --git a/readlink.c b/readlink.c
index b70dcbe..9c1479a 100644
--- a/readlink.c
+++ b/readlink.c
@@ -11,7 +11,7 @@
static void
usage(void)
{
- eprintf("usage: %s [-efmn] file\n", argv0);
+ eprintf("usage: %s [-efmn] name\n", argv0);
}
int
