From adriel@fluffy.adriel.net  Tue Feb 27 11:42:30 2001
Return-Path: <adriel@fluffy.adriel.net>
Received: from fluffy.adriel.net (fluffy.adriel.net [216.141.4.150])
	by hub.freebsd.org (Postfix) with ESMTP id A395937B71B
	for <FreeBSD-gnats-submit@freebsd.org>; Tue, 27 Feb 2001 11:42:29 -0800 (PST)
	(envelope-from adriel@fluffy.adriel.net)
Received: (from root@localhost)
	by fluffy.adriel.net (8.11.1/8.9.3) id f1RJgSM80606;
	Tue, 27 Feb 2001 13:42:28 -0600 (CST)
	(envelope-from adriel)
Message-Id: <200102271942.f1RJgSM80606@fluffy.adriel.net>
Date: Tue, 27 Feb 2001 13:42:28 -0600 (CST)
From: adriel@adriel.net
To: FreeBSD-gnats-submit@freebsd.org
Subject: man page missing important information.
X-Send-Pr-Version: 3.2

>Number:         25420
>Category:       docs
>Synopsis:       man page missing important information.
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    dd
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          change-request
>Submitter-Id:   current-users
>Arrival-Date:   Tue Feb 27 11:50:01 PST 2001
>Closed-Date:    Sat Nov 24 09:03:01 PST 2001
>Last-Modified:  Sat Nov 24 09:03:28 PST 2001
>Originator:     adriel@adriel.net
>Release:        FreeBSD 4.2-STABLE i386
>Organization:
>Environment:
>Description:

	the man snp and man watch pages neglect to mention you have to add device snp to your kernel makefile and rebuild a custom kernel, and no referenced are made from the man watch page to any document that mentions device snp.

>How-To-Repeat:
>Fix:
>Release-Note:
>Audit-Trail:

From: Ben Smithurst <ben@FreeBSD.org>
To: freebsd-gnats-submit@FreeBSD.org, adriel@adriel.net
Cc:  
Subject: Re: docs/25420: man page missing important information.
Date: Thu, 29 Mar 2001 02:12:38 +0100

 Would it be enough just to change the first sentence to say:
 
         Watch allows the superuser to examine all data coming through a
         specified tty, using the snp(4) device.
 
 That at least gets the reference to snp(4) where you're more likely to see
 it.
 
 Or would you rather it also said something like
 
         Note that the snp(4) device is not in the default kernel so you
         must build a custom kernel in order to use watch(8).
 
 ?
 
 -- 
 Ben Smithurst / ben@FreeBSD.org / PGP: 0x99392F7D
Responsible-Changed-From-To: freebsd-doc->dd 
Responsible-Changed-By: ru 
Responsible-Changed-When: Tue Aug 21 05:46:01 PDT 2001 
Responsible-Changed-Why:  
Dima has been working recently on snp(4). 
It might worth adding the config(8) directive to the SYNOPSIS. 

http://www.FreeBSD.org/cgi/query-pr.cgi?pr=25420 
State-Changed-From-To: open->closed 
State-Changed-By: dd 
State-Changed-When: Sat Nov 24 09:03:01 PST 2001 
State-Changed-Why:  
I've updated the snp(4) and watch(8) manual pages to talk about this 
stuff.  It will be MFC'd with the rest of the snp(4) updates (probably 
some time before 4.5). 

http://www.FreeBSD.org/cgi/query-pr.cgi?pr=25420 
>Unformatted:
 
