Date: Tue, 6 Mar 2018 21:15:00 +0000 (UTC) From: Mark Johnston <markj@FreeBSD.org> To: src-committers@freebsd.org, svn-src-user@freebsd.org Subject: svn commit: r330549 - user/markj/netdump/share/man/man4 Message-ID: <201803062115.w26LF0vt028373@repo.freebsd.org>
next in thread | raw e-mail | index | archive | help
Author: markj Date: Tue Mar 6 21:15:00 2018 New Revision: 330549 URL: https://svnweb.freebsd.org/changeset/base/330549 Log: Add a rudimentary netdump.4. Added: user/markj/netdump/share/man/man4/netdump.4 Modified: user/markj/netdump/share/man/man4/Makefile Modified: user/markj/netdump/share/man/man4/Makefile ============================================================================== --- user/markj/netdump/share/man/man4/Makefile Tue Mar 6 21:14:24 2018 (r330548) +++ user/markj/netdump/share/man/man4/Makefile Tue Mar 6 21:15:00 2018 (r330549) @@ -323,6 +323,7 @@ MAN= aac.4 \ ncv.4 \ ${_ndis.4} \ net80211.4 \ + netdump.4 \ netfpga10g_nf10bmac.4 \ netgraph.4 \ netintro.4 \ Added: user/markj/netdump/share/man/man4/netdump.4 ============================================================================== --- /dev/null 00:00:00 1970 (empty, because file is newly added) +++ user/markj/netdump/share/man/man4/netdump.4 Tue Mar 6 21:15:00 2018 (r330549) @@ -0,0 +1,72 @@ +.\"- +.\" Copyright (c) 2018 Mark Johnston <markj@FreeBSD.org> +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd March 6, 2018 +.Dt netdump 4 +.Os +.Sh NAME +.Nm netdump +.Nd protocol for transmitting kernel dumps to a remote server +.Sh SYNOPSIS +To compile netdump client support into the kernel, place the following line in +your kernel configuration file: +.Bd -ragged -offset indent +.Cd "options NETDUMP" +.Ed +.Pp +Debug output can be enabled by adding the following line: +.Bd -ragged -offset indent +.Cd "options NETDUMP_DEBUG" +.Ed +.Sh DESCRIPTION +netdump is a UDP-based protocol for transmitting kernel dumps to a remote host. +A netdump client is a panicking kernel, and a netdump server is a host +running the +.Nm +daemon, available in ports as +.Pa ports/ftp/netdumpd . +.Nm +clients are configured using the +.Xr dumpon 8 +utility. +.Pp +The following network drivers support netdump: +.Xr alc 4 , +.Xr bge 4 , +.Xr em 4 , +.Xr igb 4 , +.Xr ix 4 , +.Xr re 4 , +.Xr vtnet 4 . +.Sh SEE ALSO +.Xr dumpon 8 +.Sh HISTORY +.Nm +client support first appeared in +.Fx 12.0 . +.Sh BUGS +Only IPv4 is supported.
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201803062115.w26LF0vt028373>