From: quantumg <quantumg>
Date: Thu, 15 Mar 2007 11:50:36 +0000 (+0000)
Subject: Added man page for peekfd.
X-Git-Tag: v22.11~70
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=e841174075b9cf8ab7e27d8dac0875b732c7bf68;p=psmisc

Added man page for peekfd.
Added README comment for peekfd.
Fixed spelling issue.
---

diff --git a/AUTHORS b/AUTHORS
index 83220ec..5114799 100644
--- a/AUTHORS
+++ b/AUTHORS
@@ -1,3 +1,3 @@
 Werner Almesberger <werner@almesberger.net>
 Craig Small <csmall@small.dropbear.id.au>
-peekfd writtten by Trent Waddington <trent.waddington@gmail.com>
+peekfd written by Trent Waddington <trent.waddington@gmail.com>
diff --git a/README b/README
index f6d4e8a..40bdbd6 100644
--- a/README
+++ b/README
@@ -9,6 +9,10 @@ This package contains four little utilities that use the proc FS:
   pidof	    like killall, buts lists PIDs instead of killing processes
   pstree    shows the currently running processes as a tree
 
+and
+
+  peekfd    shows the data travelling over a file descriptor
+
 They should work with most recent kernels. Man pages are included.
 
 - Werner Almesberger <Werner.Almesberger@epfl.ch>
diff --git a/doc/peekfd.1 b/doc/peekfd.1
new file mode 100644
index 0000000..f06e274
--- /dev/null
+++ b/doc/peekfd.1
@@ -0,0 +1,51 @@
+.\" Process this file with
+.\" groff -man -Tascii foo.1
+.\"
+.TH PEEKFD 1 "FEBRUARY 2007" Linux "User Manuals"
+.SH NAME
+peekfd \- peek at file descriptors of running processes
+.SH SYNOPSIS
+.B peekfd [-8] [-n] [-c] [-d] [-v] [-h]
+.I pid
+.I [fd]
+.I [fd]
+.B ...
+.SH DESCRIPTION
+.B peekfd
+attaches to a running process and intercepts all reads 
+and writes to file descriptors.  You can specify the 
+desired file descriptor numbers or dump all of them.
+.SH OPTIONS
+.IP -8
+Do no post-processing on the bytes being read or written.
+.IP -n
+Do not display headers indicating the source of the bytes dumped.
+.IP -c
+Also dump the requested file descriptor activity in any new child processes that are created.
+.IP -d
+Remove duplicate read/writes from the output.  If you're looking at a tty with echo, you might want this.
+.IP -v
+Display a version string.
+.IP -h
+Display a help message.
+.SH FILES
+.I /proc/*/fd
+.RS
+Not used but useful for the user to look at to get good file descriptor numbers.
+.SH ENVIRONMENT
+None.
+.SH DIAGNOSTICS
+The following diagnostics may be issued on stderr:
+
+.B 
+Error attaching to pid ...
+.RS
+An unknown error occured while attempted to attach to a process.. you may need to be root.
+.SH BUGS
+Probably lots.  Don't be surprised if the process you are monitoring dies.
+
+No long options are implemented.
+.SH AUTHOR
+Trent Waddington <trent.waddington@gmail.com>
+.SH "SEE ALSO"
+.BR ttysnoop (8)