citrun

commit 69aac62c0f6a21f0d839994a7058015ba8b0f4c2
parent ddaed162df00f2cff5af8d64aad98ff7776c5842
Author: Kyle Milz <kyle@0x30.net>
Date:   Tue, 26 Jul 2016 21:18:28 -0600

man: sync

Diffstat:
M
man/citrun-gl.1
 | 
26
++++++++++++++------------
A
man/citrun-term.1
 | 
33
+++++++++++++++++++++++++++++++++

2 files changed, 47 insertions(+), 12 deletions(-)
diff --git a/man/citrun-gl.1 b/man/citrun-gl.1
@@ -18,24 +18,26 @@
 .Os
 .Sh NAME
 .Nm citrun-gl
-.Nd interact with instrumented binaries
-.Sh SYNOPSIS
-.Nm
+.Nd OpenGL viewer
 .Sh DESCRIPTION
-Displays executing source code from any instrumented binaries running on the
-system.
+Multiplexes execution data from any running instrumented programs into an
+OpenGL window.
+.Pp
+Started instrumented programs will try connecting to
+.Nm
+when it is running. When that succeeds execution data will appear in the viewer
+window.
 .Pp
-Instrumented binaries built with
-.Xr citrun-wrap 1
-automatically attempt connections to the
 .Nm
-socket.
+uses process group information from connected programs to aggregate similar
+processes together.
 .Sh FILES
 .Bl -tag -width Ds
-.It Pa /tmp/citrun-gl.socket
-Default listening socket.
+.It Pa /tmp/citrun.socket
+Listen socket.
 .El
 .Sh EXIT STATUS
 .Ex -std
 .Sh SEE ALSO
-.Xr citrun-wrap 1
+.Xr citrun-wrap 1 ,
+.Xr citrun-term 1
diff --git a/man/citrun-term.1 b/man/citrun-term.1
@@ -0,0 +1,33 @@
+.\"
+.\" Copyright (c) 2016 Kyle Milz <kyle@0x30.net>
+.\"
+.\" Permission to use, copy, modify, and distribute this software for any
+.\" purpose with or without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+.\"
+.Dd $Mdocdate: July 19 2016 $
+.Dt CITRUN-TERM 1
+.Os
+.Sh NAME
+.Nm citrun-term
+.Nd terminal viewer
+.Sh DESCRIPTION
+Listens for a connection from a single running instrumented program. Displays
+execution data in a terminal window.
+.Sh FILES
+.Bl -tag -width Ds
+.It Pa /tmp/citrun.socket
+Listen socket.
+.El
+.Sh EXIT STATUS
+.Ex -std
+.Sh SEE ALSO
+.Xr citrun-gl 1