a bunch of stuff, i don't know
[puffcrash.git] / puffcrash.1
1 .\" Copyright (c) 2017 Ian Sutton <ian@ce.gl>$
2 .\"
3 .\" Permission to use, copy, modify, and distribute this software for any
4 .\" purpose with or without fee is hereby granted, provided that the above
5 .\" copyright notice and this permission notice appear in all copies.
6 .\"
7 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
8 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
9 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
10 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
11 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
12 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
13 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
14 .\"
15 .Dd $Mdocdate: June 10 2017 $
16 .Dt PUFFCRASH 1
17 .Os
18 .Sh NAME
19 .Nm puffcrash
20 .Nd OpenBSD kernel debugging assitant
21 .Sh SYNOPSIS
22 .Nm
23 .Op Fl c Ar config
24 .Op Ar serial\ console\ log
25 .Sh DESCRIPTION
26 .Nm
27 reads serial terminal output from OpenBSD machines, listening for
28 kernel panics.
29 When detected (and following 'trace' command is issued to
30 .Xr ddb 4 ,
31 puffcrash tries to ascertain the source lines implicated in the crash via
32 .Xr objdump 1
33 and source tags (usually generated by `make tags`), displaying them if succesful.
34 .Pp
35 .Nm
36 reads from standard input if logfile argument is omitted.
37 .Sh SEE ALSO
38 .Xr ddb 4
39 .Sh HISTORY
40 .Nm
41 does not appear in
42 .Ox 6.1
43 currently.
44 .Sh AUTHORS
45 .An -nosplit
46 .Nm
47 was written by
48 .An Ian Sutton Aq Mt ian@ce.gl .