documentation/3034: inconsistency in fsdb(8) and fsdb usage

From: Dan Weeks <danimal(at)danimal.org>
Date: Sun Dec 15 2002 - 10:53:37 EST

>Number: 3034
>Category: documentation
>Synopsis: the internal fsdb clri command is mis-documented in fsdb(8)
>Confidential: no
danimal.org
>Environment:

	System      : OpenBSD 3.2
	Architecture: OpenBSD.i386
	Machine     : i386

>Description:

	The 'clri' command in fsdb says it takes at least one argument:

	fsdb (inum: 2)> help
        Commands are:
        command    min argc max argc   what
        help           1     1   Print out help
        [snip]
        clri           2     2   Clear inode INUM

	The fsdb(8) man page says:

	clri    Clear the current inode.

	where it should say that one argument of an inode is needed.

>How-To-Repeat:

	man 8 fsdb

>Fix:

	simple patch attatched:

--- sbin/fsdb/fsdb.8.orig	Sun Dec 15 10:38:22 2002
+++ sbin/fsdb/fsdb.8	Sun Dec 15 10:30:11 2002

@@ -90,8 +90,9 @@ as the new current inode.  .It Cm back
 Revert to the previously current inode.  .Pp
-.It Cm clri
-Clear the current inode.

+.It Cm clri Ar i-number
+Clear the inode
+.Ar i-number .

 .Pp
 .It Cm lookup Ar name , Cm cd Ar name
 Find

>Release-Note:
Received on Sun Dec 15 15:46:18 2002