Added man page for peekfd.

Added README comment for peekfd.
Fixed spelling issue.

1 files changed, 51 insertions, 0 deletions

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)