xref: /openbsd/share/man/man1/portslogger.1 (revision 4cfece93)
1.\"	$OpenBSD: portslogger.1,v 1.1 2018/06/26 05:38:49 espie Exp $
2.\"
3.\" Copyright (c) 2010 Marc Espie <espie@openbsd.org>
4.\"
5.\" Permission to use, copy, modify, and distribute this software for any
6.\" purpose with or without fee is hereby granted, provided that the above
7.\" copyright notice and this permission notice appear in all copies.
8.\"
9.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16.\"
17.Dd $Mdocdate: June 26 2018 $
18.Dt PORTSLOGGER 1
19.Os
20.Sh NAME
21.Nm portslogger
22.Nd logs ports builds selectively
23.Sh SYNOPSIS
24.Nm portslogger
25.Op Fl s
26.Ar directory
27.Sh DESCRIPTION
28.Nm
29saves logs from ports build in separate files.
30.Pp
31.Nm
32handles directory change messages from the ports tree infrastructure and
33switches to a corresponding log file situated in
34.Ar directory
35accordingly, e.g., it will log the build from screen in
36.Pa directory/screen-4.0.3p1.log .
37.Nm
38will filter progress-bar noise from
39.Xr ftp 1 ,
40.Xr pkg_add 1 ,
41and
42.Xr pkg_create 1 .
43.Pp
44By default,
45.Nm
46acts as a filter and still passes its input to stdout, unless
47run with
48.Fl s .
49.Pp
50It is most often used as
51.Pp
52.Dl $ make package 2>&1 | portslogger logdir
53.Pp
54or in conjunction with
55.Xr tmux 1 ,
56such as
57.Pp
58.Dl $ tmux pipe-pane 'portslogger -s logdir'
59.Sh SEE ALSO
60.Xr dpb 1 ,
61.Xr tmux 1
62