summaryrefslogtreecommitdiff
path: root/man/man1/pmtime.1
diff options
context:
space:
mode:
Diffstat (limited to 'man/man1/pmtime.1')
-rw-r--r--man/man1/pmtime.166
1 files changed, 66 insertions, 0 deletions
diff --git a/man/man1/pmtime.1 b/man/man1/pmtime.1
new file mode 100644
index 0000000..6a2af1f
--- /dev/null
+++ b/man/man1/pmtime.1
@@ -0,0 +1,66 @@
+.TH PMTIME 1 "" "Performance Co-Pilot"
+.SH NAME
+\f3pmtime\f1 \- time control server for Performance Co-Pilot
+.SH SYNOPSIS
+\f3pmtime\f1
+[\f3\-p\f1 \f2port\f1]
+.SH DESCRIPTION
+.B pmtime
+is a graphical user interface for performance monitoring applications
+using the PCP infrastructure and requiring interactive time control.
+.PP
+.B pmtime
+is not normally invoked directly by users.
+Rather, it is more typical for it to be started by client applications
+(e.g.
+.BR pmchart (1)
+and
+.BR pmval (1)).
+.PP
+There are two modes of interacting with a
+.B pmtime
+process - live host mode, and historical archive mode.
+In archive mode the window presents time controls suitable for
+manipulating the archive position, allowing full VCR control to
+move forwards and backwards in time at configurable rates and
+intervals.
+In live mode the
+.B pmtime
+window contains the simpler time controls suitable for
+live monitoring.
+.PP
+The arguments to
+.B pmtime
+are as follows:
+.TP 5
+.B \-p
+.I port
+is the port number which
+.B pmtime
+will use for communication with its clients (monitoring applications).
+.PP
+Note that the
+.B pmtime
+window is only made visible when explicitly requested.
+Multiple client applications can be connected to a single
+.B pmtime
+server \- when the final client application exits,
+.B pmtime
+will also exit.
+.SH ENVIRONMENT
+When a port number is not explicitly requested on the command line
+via the
+.B \-p
+option, the environment variable
+.I PMTIME_PORT
+can be set to specify the port number from which available-port
+probing will commence when
+.B pmtime
+is searching for a port number to use.
+.PP
+The default starting port number is 43334.
+.SH SEE ALSO
+.BR PCPIntro (1),
+.BR pmchart (1),
+and
+.BR pmval (1).