Release 1.6.0.
[xtoys] / xcatch.1
... / ...
CommitLineData
1.\" -*-nroff-*-
2.TH xcatch 1 "15 December 1998" "Straylight/Edgeware" "xtoys"
3.SH NAME
4xcatch \- catch input and trap it in a window
5.SH SYNOPSIS
6.B xcatch
7.RI [ gtk-options ...]
8.RB [ \-F
9.IR font ]
10.RB [ \-f
11.IR file ]
12.RI [ command
13.RI [ args ]...]
14.SH DESCRIPTION
15The
16.B xcatch
17program watches an input file descriptor (usually a pipe) and displays
18data from it in a GTK window. The window is displayed only when data is
19first read from the descriptor; if no data ever arrives, the window is
20not created. If a file is specified using the
21.B \-f
22option, it is read; otherwise, if a
23.I command
24is specified, it is executed with standard output and standard error
25redirected to
26.BR xcatch ;
27otherwise,
28.B xcatch
29reads from its own standard input.
30.PP
31It is better to write
32.IP
33.B xcatch
34.I command args
35.PP
36than
37.IP
38.I command args
39.B | xcatch
40.PP
41The former allows
42.B xcatch
43to collect the exit status of the
44.I command
45and (a) report it in its window, and (b) provide it (or a version of it)
46as its own exit status for the caller to check. It also enables
47.B xcatch
48to put the command line in its title bar.
49.SS Options
50.TP
51.BI "\-F, \-\-font " font
52Display output text in
53.I font
54rather than GTK's default.
55.TP
56.BI "\-f, \-\-file " file
57Read data from
58.I file
59instead of standard output.
60.SH BUGS
61None currently known.
62.SH SEE ALSO
63.BR gtk-options (7).
64.SH AUTHOR
65Mark Wooding (mdw@distorted.org.uk).