Date: Sun, 21 Aug 2005 08:13:04 -0700 From: "Gary W. Swearingen" <garys@opusnet.com> To: FreeBSD-gnats-submit@FreeBSD.org Subject: docs/85186: ktrace(1) manpage doesn't warn about need for KTRACE Message-ID: <3rbr3rnx1b.r3r@mail.opusnet.com> Resent-Message-ID: <200508211520.j7LFK6ra072794@freefall.freebsd.org>
next in thread | raw e-mail | index | archive | help
>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:
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?3rbr3rnx1b.r3r>