[apple/network_cmds.git] / kdumpd.tproj / kdumpd.8

.\" Copyright (c) 1983, 1991, 1993
.\"	The Regents of the University of California.  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.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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.
.\"
.\"	@(#)tftpd.8	8.1 (Berkeley) 6/4/93
.\" $FreeBSD: src/libexec/tftpd/tftpd.8,v 1.15 2001/07/15 07:53:42 dd Exp $
.\"
.Dd June 10, 2020
.Dt KDUMPD 8
.Os
.Sh NAME
.Nm kdumpd
.Nd Mac OS X remote kernel core dump server
.Sh SYNOPSIS
.Nm /usr/libexec/kdumpd
.Op Ar directory
.Sh DESCRIPTION
.Nm Kdumpd
is a server which receives
kernel states in the form of
a core dump from a remote 
Mac OS X machine.
The
.Tn kdumpd
server operates
on UDP port 1069, although this
may be configurable in the future.
The server should be started by
.Xr launchctl 1 .
.Pp
The server should have the user ID
with the lowest possible privilege,
usually the user "nobody". 
.Pp
By default the server stores kernel cores
in the directory
.Pa /var/tmp/PanicDumps .
The directory needs to already exist for kdumpd
to save core dumps.
.Pp
The server returns an EEXIST error
to the remote kernel if it receives a
request for an existing file - i.e.
only new files can be created. The server
also disallows path specifications in the
incoming file name. 
.Sh HISTORY
The
.Nm
command is based on Berkeley
.Xr tftpd 8 ,
by way of FreeBSD, with several modifications.
.Sh SEE ALSO
.Xr launchd 8 ,
.Xr launchctl 1 ,
.Xr launchd.plist 5
Commit	Line	Data
ac2f15b3 A	1	.\" Copyright (c) 1983, 1991, 1993
	2	.\" The Regents of the University of California. All rights reserved.
	3	.\"
	4	.\" Redistribution and use in source and binary forms, with or without
	5	.\" modification, are permitted provided that the following conditions
	6	.\" are met:
	7	.\" 1. Redistributions of source code must retain the above copyright
	8	.\" notice, this list of conditions and the following disclaimer.
	9	.\" 2. Redistributions in binary form must reproduce the above copyright
	10	.\" notice, this list of conditions and the following disclaimer in the
	11	.\" documentation and/or other materials provided with the distribution.
	12	.\" 3. All advertising materials mentioning features or use of this software
	13	.\" must display the following acknowledgement:
	14	.\" This product includes software developed by the University of
	15	.\" California, Berkeley and its contributors.
	16	.\" 4. Neither the name of the University nor the names of its contributors
	17	.\" may be used to endorse or promote products derived from this software
	18	.\" without specific prior written permission.
	19	.\"
	20	.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	21	.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	22	.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	23	.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	24	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	25	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	26	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	27	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	28	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	29	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	30	.\" SUCH DAMAGE.
	31	.\"
	32	.\" @(#)tftpd.8 8.1 (Berkeley) 6/4/93
	33	.\" $FreeBSD: src/libexec/tftpd/tftpd.8,v 1.15 2001/07/15 07:53:42 dd Exp $
	34	.\"
a3cc5c72	35	.Dd June 10, 2020
ac2f15b3 A	36	.Dt KDUMPD 8
	37	.Os
	38	.Sh NAME
	39	.Nm kdumpd
	40	.Nd Mac OS X remote kernel core dump server
	41	.Sh SYNOPSIS
	42	.Nm /usr/libexec/kdumpd
	43	.Op Ar directory
	44	.Sh DESCRIPTION
	45	.Nm Kdumpd
	46	is a server which receives
	47	kernel states in the form of
	48	a core dump from a remote
	49	Mac OS X machine.
	50	The
	51	.Tn kdumpd
	52	server operates
	53	on UDP port 1069, although this
	54	may be configurable in the future.
	55	The server should be started by
a3cc5c72	56	.Xr launchctl 1 .
ac2f15b3 A	57	.Pp
	58	The server should have the user ID
	59	with the lowest possible privilege,
	60	usually the user "nobody".
a3cc5c72 A	61	.Pp
	62	By default the server stores kernel cores
	63	in the directory
	64	.Pa /var/tmp/PanicDumps .
	65	The directory needs to already exist for kdumpd
	66	to save core dumps.
	67	.Pp
ac2f15b3 A	68	The server returns an EEXIST error
	69	to the remote kernel if it receives a
	70	request for an existing file - i.e.
	71	only new files can be created. The server
	72	also disallows path specifications in the
	73	incoming file name.
	74	.Sh HISTORY
	75	The
	76	.Nm
	77	command is based on Berkeley
a3cc5c72	78	.Xr tftpd 8 ,
ac2f15b3	79	by way of FreeBSD, with several modifications.
a3cc5c72 A	80	.Sh SEE ALSO
	81	.Xr launchd 8 ,
	82	.Xr launchctl 1 ,
	83	.Xr launchd.plist 5