From owner-freebsd-doc@FreeBSD.ORG Sun Aug 21 15:20:13 2005 Return-Path: X-Original-To: freebsd-doc@hub.freebsd.org Delivered-To: freebsd-doc@hub.freebsd.org Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id 5909916A420 for ; Sun, 21 Aug 2005 15:20:13 +0000 (GMT) (envelope-from gnats@FreeBSD.org) Received: from freefall.freebsd.org (freefall.freebsd.org [216.136.204.21]) by mx1.FreeBSD.org (Postfix) with ESMTP id BF51F43D6D for ; Sun, 21 Aug 2005 15:20:06 +0000 (GMT) (envelope-from gnats@FreeBSD.org) Received: from freefall.freebsd.org (gnats@localhost [127.0.0.1]) by freefall.freebsd.org (8.13.3/8.13.3) with ESMTP id j7LFK6KN072795 for ; Sun, 21 Aug 2005 15:20:06 GMT (envelope-from gnats@freefall.freebsd.org) Received: (from gnats@localhost) by freefall.freebsd.org (8.13.3/8.13.1/Submit) id j7LFK6ra072794; Sun, 21 Aug 2005 15:20:06 GMT (envelope-from gnats) Resent-Date: Sun, 21 Aug 2005 15:20:06 GMT Resent-Message-Id: <200508211520.j7LFK6ra072794@freefall.freebsd.org> Resent-From: FreeBSD-gnats-submit@FreeBSD.org (GNATS Filer) Resent-To: freebsd-doc@FreeBSD.org Resent-Reply-To: FreeBSD-gnats-submit@FreeBSD.org, garys@opusnet.com Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id A374816A41F for ; Sun, 21 Aug 2005 15:11:51 +0000 (GMT) (envelope-from garys@opusnet.com) Received: from opusnet.com (mail.opusnet.com [209.210.200.6]) by mx1.FreeBSD.org (Postfix) with ESMTP id 5328C43D46 for ; Sun, 21 Aug 2005 15:11:51 +0000 (GMT) (envelope-from garys@opusnet.com) Received: from localhost.localhost [70.98.246.232] by opusnet.com with ESMTP (SMTPD32-8.05) id A9B3FC700CA; Sun, 21 Aug 2005 08:11:47 -0700 Received: from localhost.localhost (localhost.localhost [127.0.0.1]) by localhost.localhost (8.13.3/8.13.3) with ESMTP id j7LFD9V7032197 for ; Sun, 21 Aug 2005 08:13:09 -0700 (PDT) (envelope-from garys@opusnet.com) Received: (from jojo@localhost) by localhost.localhost (8.13.3/8.13.3/Submit) id j7LFD4vR032196; Sun, 21 Aug 2005 08:13:04 -0700 (PDT) (envelope-from garys@opusnet.com) Message-Id: <3rbr3rnx1b.r3r@mail.opusnet.com> Date: Sun, 21 Aug 2005 08:13:04 -0700 From: "Gary W. Swearingen" To: FreeBSD-gnats-submit@FreeBSD.org Cc: Subject: docs/85186: ktrace(1) manpage doesn't warn about need for KTRACE X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.5 Precedence: list Reply-To: garys@opusnet.com List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sun, 21 Aug 2005 15:20:14 -0000 >Number: 85186 >Category: docs >Synopsis: ktrace(1) manpage doesn't warn about need for KTRACE >Confidential: no >Severity: non-critical >Priority: low >Responsible: freebsd-doc >State: open >Quarter: >Keywords: >Date-Required: >Class: doc-bug >Submitter-Id: current-users >Arrival-Date: Sun Aug 21 15:20:06 GMT 2005 >Closed-Date: >Last-Modified: >Originator: Gary W. Swearingen >Release: FreeBSD 5.4-RELEASE i386 >Organization: none >Environment: n/a >Description: 1) ktrace(1) manpage doesn't warn about need for KTRACE I'm basing that on KTRACE's comment in the Handbook: "ktrace(1) support" 2) It omits needed hyphens. 3) It uses redundant "as follows". >How-To-Repeat: >Fix: --- ktrace..orig.1 Sat Aug 20 14:42:44 2005 +++ ktrace.1 Sat Aug 20 14:49:53 2005 @@ -64,7 +64,7 @@ A traced process can generate enormous amounts of log data quickly; It is strongly suggested that users memorize how to disable tracing before attempting to trace a process. -The following command is sufficient to disable tracing on all user owned +The following command is sufficient to disable tracing on all user-owned processes, and, if executed by root, all processes: .Pp .Dl \&$ ktrace -C @@ -73,12 +73,16 @@ .Xr kdump 1 to decode it. .Pp -The options are as follows: +The utility should be used only with a kernel that has been built with the +.Dq KTRACE +option in the kernel configuration file. +.Pp +The options are: .Bl -tag -width indent .It Fl a Append to the trace file instead of recreating it. .It Fl C -Disable tracing on all user owned processes, and, if executed by root, all +Disable tracing on all user-owned processes, and, if executed by root, all processes in the system. .It Fl c Clear the trace points associated with the specified file or processes. @@ -160,7 +164,7 @@ # disable all tracing to the file "tracedata" .Dl $ ktrace -c -f tracedata .Pp -# disable tracing of all processes owned by the user +# disable tracing of all user-owned processes .Dl $ ktrace -C .Sh SEE ALSO .Xr kdump 1 >Release-Note: >Audit-Trail: >Unformatted: