~ubuntu-branches/ubuntu/saucy/devscripts/saucy

25 by Colin Watson
* Resynchronise with Debian. Remaining changes:
1
.TH ANNOTATE-OUTPUT 1 "Debian Utilities" "DEBIAN" \" -*- nroff -*-
2
.SH NAME
3
annotate-output \- annotate program output with time and stream
4
.SH SYNOPSIS
10.2.10 by James Vega, James Vega, Patrick Schoenfeld, Ryan Niebur, Adam D. Barratt
The "Welcome to the New Year" release.
5
\fBannotate\-output\fR [\fIoptions\fR] \fIprogram\fR [\fIargs\fR ...]
25 by Colin Watson
* Resynchronise with Debian. Remaining changes:
6
.SH DESCRIPTION
7
\fBannotate\-output\fR will execute the specified program, while
8
prepending every line with the current time and O for stdout and E for
9
stderr.
10
10.2.10 by James Vega, James Vega, Patrick Schoenfeld, Ryan Niebur, Adam D. Barratt
The "Welcome to the New Year" release.
11
.SH OPTIONS
12
.TP
13
\fB+FORMAT\fR
14
Controls the timestamp format, as per \fBdate\fR(1).  Defaults to
15
"%H:%M:%S".
16
.TP
17
\fB\-h\fR, \fB\-\-help\fR
18
Display a help message and exit successfully.
19
25 by Colin Watson
* Resynchronise with Debian. Remaining changes:
20
.SH EXAMPLE
21
22
.nf
23
$ annotate-output make
24
21:41:21 I: Started make
52 by Colin Watson
* Resynchronise with Debian. Remaining changes:
25
21:41:21 O: gcc \-Wall program.c
25 by Colin Watson
* Resynchronise with Debian. Remaining changes:
26
21:43:18 E: program.c: Couldn't compile, and took me ages to find out
27
21:43:19 E: collect2: ld returned 1 exit status
28
21:43:19 E: make: *** [all] Error 1
29
21:43:19 I: Finished with exitcode 2
30
.fi
31
32
.SH BUGS
33
Since stdout and stderr are processed in parallel, it can happen that
34
some lines received on stdout will show up before later-printed stderr
35
lines (and vice-versa).
36
37
This is unfortunately very hard to fix with the current annotation
38
strategy.  A fix would involve switching to PTRACE'ing the process.
39
Giving nice a (much) higher priority over the executed program could
40
however cause this behaviour to show up less frequently.
41
42
The program does not work as well when the output is not linewise.  In
43
particular, when an interactive program asks for input, the question
44
might not be shown until after you have answered it.  This will give
45
the impression that the annotated program has hung, while it has not.
46
10.2.10 by James Vega, James Vega, Patrick Schoenfeld, Ryan Niebur, Adam D. Barratt
The "Welcome to the New Year" release.
47
.SH "SEE ALSO"
48
\fBdate\fR(1)
49
50
.SH SUPPORT
25 by Colin Watson
* Resynchronise with Debian. Remaining changes:
51
This program is community-supported (meaning: you'll need to fix it
52
yourself).  Patches are however appreciated, as is any feedback
53
(positive or negative).
54
55
.SH AUTHOR
56
\fBannotate-output\fR was written by Jeroen van Wolffelaar
10.9.22 by Benjamin Drung, Christoph Berg, James McCoy, Dmitry Smirnov, Paul Wise, Benjamin Drung, Cyril Brulebois, Tony Mancill, David Prévot, Josselin Mouette, Raphael Geissert, Regid Ichira, Colin Watson
[ Christoph Berg ]
57
<jeroen@wolffelaar.nl>. This manpage comes under the same copyright as
25 by Colin Watson
* Resynchronise with Debian. Remaining changes:
58
annotate-output itself, read /usr/bin/annotate-output (or wherever
59
you install it) for the details.