Source-Changes-HG archive

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]

[src/trunk]: src/external/cddl/dtracetoolkit/dist/Man/man1m Try to improve ma...



details:   https://anonhg.NetBSD.org/src/rev/bc35169a523e
branches:  trunk
changeset: 935133:bc35169a523e
user:      uwe <uwe%NetBSD.org@localhost>
date:      Thu Jun 25 14:59:51 2020 +0000

description:
Try to improve markup.

diffstat:

 external/cddl/dtracetoolkit/dist/Man/man1m/opensnoop.1m |  67 ++++++++--------
 1 files changed, 32 insertions(+), 35 deletions(-)

diffs (114 lines):

diff -r b0d530e56648 -r bc35169a523e external/cddl/dtracetoolkit/dist/Man/man1m/opensnoop.1m
--- a/external/cddl/dtracetoolkit/dist/Man/man1m/opensnoop.1m   Thu Jun 25 14:52:26 2020 +0000
+++ b/external/cddl/dtracetoolkit/dist/Man/man1m/opensnoop.1m   Thu Jun 25 14:59:51 2020 +0000
@@ -1,4 +1,4 @@
-.\" $NetBSD: opensnoop.1m,v 1.3 2020/06/25 09:39:19 sevan Exp $
+.\" $NetBSD: opensnoop.1m,v 1.4 2020/06/25 14:59:51 uwe Exp $
 .Dd June 25, 2020
 .Dt OPENSNOOP 1
 .Os
@@ -16,12 +16,12 @@
 tracks file opens.
 As a process issues a file open, details such as UID, PID and pathname are
 printed out.
-The returned file descriptor is printed, a value of -1 indicates an error.
+The returned file descriptor is printed, a value of \-1 indicates an error.
 This can be useful for troubleshooting to determine if appliacions are
 attempting to open files that do not exist.
 Since this uses DTrace, only the root user or users with the
 dtrace_kernel privilege can run this command.
-.Bl -tag -width Ds
+.Bl -tag -width Fl
 .It Fl a
 print all data
 .It Fl A
@@ -47,51 +47,49 @@
 .It Fl p Ar PID
 process ID to snoop
 .El
-.Bl -column fieldtitle description
+.Bl -column "STRTIME"
 .It Sy Fields Ta Sy Description
-.It ZONE Ta Zone name
-.It UID        Ta User ID
-.It PID Ta Process ID
-.It PPID Ta Parent Process ID
-.It FD Ta File Descriptor (-1 is error)
-.It ERR Ta errno value ( see
-.Pa /usr/include/sys/errno.h
-)
-.It CWD Ta current working directory of process
-.It PATH Ta pathname for file open
-.It COMM Ta command name for the process
-.It ARGS Ta argument listing for the process
-.It TIME Ta timestamp for the open event, us
-.It STRTIME Ta timestamp for the open event, string
+.It ZONE      Ta Zone name
+.It UID       Ta User ID
+.It PID       Ta Process ID
+.It PPID      Ta Parent Process ID
+.It FD        Ta File Descriptor
+.Pq \-1 is error
+.It ERR       Ta Va errno
+value
+.Pq see Pa /usr/include/sys/errno.h
+.It CWD       Ta current working directory of process
+.It PATH      Ta pathname for file open
+.It COMM      Ta command name for the process
+.It ARGS      Ta argument listing for the process
+.It TIME      Ta timestamp for the open event, us
+.It STRTIME   Ta timestamp for the open event, string
 .El
 .Sh EXAMPLES
 Default output, print file opens by process as they occur,
-.Bd -literal -offset indent
-.Ic opensnoop
-.Ed
+.Pp
+.Dl Ic opensnoop
 .Pp
 Print human readable timestamps,
-.Bd -literal -offset indent
-.Ic opensnoop -v
-.Ed
+.Pp
+.Dl Ic opensnoop -v
 .Pp
 See error codes,
-.Bd -literal -offset indent
-.Ic opensnoop -e
-.Ed
+.Pp
+.Dl Ic opensnoop -e
 .Pp
 Snoop this file only,
-.Bd -literal -offset indent
-.Ic opensnoop -f /etc/passwd
-.Ed
+.Pp
+.Dl Ic opensnoop -f /etc/passwd
 .Sh STABILITY
-stable - needs the syscall provider.
+stable \(em needs the syscall provider.
 .Sh DOCUMENTATION
 See the DTraceToolkit for further documentation under the Docs directory.
 The DTraceToolkit docs may include full worked examples with verbose
 descriptions explaining the output.
 .Sh EXIT
-opensnoop will run forever until Ctrl\-C is hit.
+.Nm
+will run forever until Ctrl\-C is hit.
 .Sh SEE ALSO
 .Xr dtrace 1
 .Sh AUTHORS
@@ -100,8 +98,7 @@
 .Sh BUGS
 Occasionally the pathname for the file open cannot be read and the following
 error will be seen,
-.Bd -literal -offset indent
-dtrace: error on enabled probe ID 6 (...): invalid address
-.Ed
+.Pp
+.Dl dtrace: error on enabled probe ID 6 (...): invalid address
 .Pp
 this is normal behaviour.



Home | Main Index | Thread Index | Old Index