Subject: misc/37243: Description of option "-h" in ln.1 looks malformatted
To: None <misc-bug-people@netbsd.org, gnats-admin@netbsd.org,>
From: None <jn_netbsd@iinet.net.au>
List: netbsd-bugs
Date: 10/28/2007 22:05:01
>Number:         37243
>Category:       misc
>Synopsis:       Description of option "-h" in ln.1 looks malformatted
>Confidential:   no
>Severity:       non-critical
>Priority:       medium
>Responsible:    misc-bug-people
>State:          open
>Class:          doc-bug
>Submitter-Id:   net
>Arrival-Date:   Sun Oct 28 22:05:01 +0000 2007
>Originator:     Joerg Niendorf
>Release:        ln.1 rev 1.21
>Organization:
none
>Environment:
N/A

>Description:
The description of the "-h" option in ln.1 doesn't look right. It reads:

If the target_file or target_dir is a symbolic link, do not follow
it.  This is most useful with the -i Cause ln to write a prompt to
standard error if the target file exists.  If the response from the
standard input begins with the character `y' or `Y', then unlink
the target file so that the link may occur.  Otherwise, do not
attempt the link.  (The -i option override any previous -f
options.)  -f option, to replace a symlink which may point to a
directory.

I believe that paragraph got corrupted with the introduction of the "-i"
option. I think it was meant to be:

-h  If the target_file or target_dir is a symbolic link, do not follow
    it.  This is most useful with the -f option, to replace a symlink
    which may point to a directory.

-i  Cause ln to write a prompt to standard error if the target file
    exists.  If the response from the standard input begins with the
    character `y' or `Y', then unlink the target file so that the link
    may occur.  Otherwise, do not attempt the link.  (The -i option
    overrides any previous -f options.)


The attached diff should fix it.

>How-To-Repeat:

N/A

>Fix:
Index: ln.1
===================================================================
RCS file: /cvsroot/src/bin/ln/ln.1,v
retrieving revision 1.21
diff -b -u -r1.21 ln.1
--- ln.1	7 Oct 2006 10:05:25 -0000	1.21
+++ ln.1	28 Oct 2007 14:40:37 -0000
@@ -73,7 +73,9 @@
 .Ar target_dir
 is a symbolic link, do not follow it.
 This is most useful with the
-.Fl i
+.Fl f
+option, to replace a symlink which may point to a directory.
+.It Fl i
 Cause
 .Nm
 to write a prompt to standard error if the target file exists.
@@ -85,11 +87,9 @@
 Otherwise, do not attempt the link.
 (The
 .Fl i
-option override any previous
+option overrides any previous
 .Fl f
 options.)
-.Fl f
-option, to replace a symlink which may point to a directory.
 .It Fl n
 Same as
 .Fl h ,