vps/vps.1

   1 .TH VPS 1
   2 .SH NAME
   3 vps \- interactive process tree viewer
   4 .SH SYNOPSIS
   5 .B vps
   6 [\fIOPTION\fR]
   7 .SH DESCRIPTION
   8 .PP
   9 \fBvps\fR is a perl script which provides a terminal\-based interactive view of
  10 all process, in a tree\-structured format. That is, the processes are listed
  11 in parent\-child order, with children indented below their parents. \fBvps\fR
  12 also provides for signalling selected process, and for displaying process
  13 environment variables, and open files.
  14 .PP
  15 The basic display is separated into a top area, where the process tree is
  16 displayed. and a bottom three lines, where additional details on the currently
  17 selected process is displayed.
  18 .PP
  19 The top area includes the tree structure, the process id, and the short name of
  20 the process without arguments. A full command and arguments (subject to fit
  21 within the window) can be displayed below by selecting a process. To the right
  22 of tree structure the following columns are displayed: the process owner (bold
  23 if changed), the start time, the memory usage, and the state.
  24 .PP
  25 The bottom area of the selected process shows on the first line the current
  26 processes' command and arguments. The next line shows the process I.D., the
  27 termainal, the user and group, the memory and resident memory. The third line
  28 shows the process start time, the elapsed time (not currently working under
  29 OS X), and the system time and percentage used.
  30 .PP
  31 The top region is scrollable if the entire process tree does not fit. The
  32 separator between the top and bottom sections works as a scrollbar, displaying
  33 what portion of the scrollable area is currently being viewed.
  34 .SH OPTIONS
  35 .TP
  36 \fB\-h\fR
  37 Display help and exit
  38 .TP
  39 \fB\-n\fR
  40 Non\-interactive mode
  41 .SH USAGE
  42 .PP
  43 \fBvps\fR uses vi\-style commands, with some emacs\-style additions.
  44 .PP
  45 Many operations involve switching the top display to view some other
  46 information (environment variables, open files, help, or a list of signals).
  47 The top view is still controlled with the same characters. To return to the
  48 main view, press "q". In the Signal view, once you have selected the desired
  49 signal, press "S" to send that signal to the current process.
  50 .PP
  51 Cursor Motion Commands:
  52 .TP
  53 \fBj\fR, \fB^N\fR
  54 Move cursor down one line
  55 .TP
  56 \fBk\fR, \fB^P\fR
  57 Move cursor up one line
  58 .TP
  59 \fB^F\fR
  60 Move cursor down one screen
  61 .TP
  62 \fB^B\fR
  63 Move cursor up one screen
  64 .TP
  65 \fB^E\fR
  66 Scroll screen upwards
  67 .br
  68 (cursor remains on same line if possible)
  69 .TP
  70 \fB^Y\fR
  71 Scroll screen downwards
  72 .br
  73 (cursor remains on same line if possible)
  74 .TP
  75 \fB^L\fR
  76 Redraw screen
  77 .PP
  78 Other Commands:
  79 .TP
  80 \fBspace\fR
  81 Rebuild list of processes and redisplay
  82 .TP
  83 \fB.\fR
  84 Update data displayed for current process
  85 .TP
  86 \fBe\fR
  87 Show environment variables for current process
  88 .TP
  89 \fBo\fR
  90 Show open files for current process
  91 .br
  92 (not on OS X)
  93 .TP
  94 \fBS\fR
  95 Send a signal to current process
  96 .TP
  97 \fBq\fR
  98 quit
  99 .TP
 100 \fBnumber\fR
 101 Enter a process ID, and press return to set current process
 102 .br
 103 (if it exists)
 104 .TP
 105 \fB/\fR
 106 Enter a string to search forwards for, and press return
 107 .br
 108 (searches program, arguments, user, and group)
 109 .TP
 110 \fB?\fR
 111 Same as "/" but searches backwards
 112 .TP
 113 \fBn\fR
 114 Repeat last search
 115 .TP
 116 \fB\-\fR
 117 Use narrower indent in tree\-structured display
 118 .TP
 119 \fB=\fR
 120 Use wider indent in tree\-structured display
 121 .TP
 122 \fBh\fR
 123 Help
 124 .SH COMPATIBILITY
 125 .PP
 126 \fBvps\fR is almost exclusively used by the author on xterms. It is written to be
 127 terminal independent, but does have xterm\-specific enhancements. Other
 128 terminals (or their termcap descriptions) may not provide adequate support to
 129 function properly.
 130 .PP
 131 Code modifications are possible, but the code is very crufty, having been
 132 drafted together from different pieces of old projects. Some of the terminal
 133 display functions seem to have support for HP, Dec, and other operating
 134 systems, but this is largely cruft, not actual support.
 135 .SH AUTHOR
 136 .TP
 137 .B vps
 138 written by Thomas A. Fine
 139 .TP
 140 .B vps(1)
 141 written by Tim Yang, based on the online vps readme
 142 .SH COPYRIGHT
 143 .PP
 144 Copyright \(co 2007 Thomas A. Fine
 145 .PP
 146 Freely redistributable in whole or in part, provided the author's credit is
 147 preserved.
 148 .PP
 149 http://hea\-www.harvard.edu/~fine/Tech/vps.html