xref: /freebsd/sbin/dumpon/dumpon.8 (revision dce6e6518b85561495cff38a3074a69d29d58a55)
1.\" Copyright (c) 1980, 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 acknowledgment:
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.\"     From: @(#)swapon.8	8.1 (Berkeley) 6/5/93
33.\" $FreeBSD$
34.\"
35.Dd May 12, 1995
36.Dt DUMPON 8
37.Os
38.Sh NAME
39.Nm dumpon
40.Nd "specify a device for crash dumps"
41.Sh SYNOPSIS
42.Nm
43.Op Fl v
44.Ar special_file
45.Nm
46.Op Fl v
47.Ar off
48.Sh DESCRIPTION
49The
50.Nm
51utility is used to specify a device where the kernel can save a crash dump in
52the case of a panic.
53.Pp
54Calls to
55.Nm
56normally occur from the system multi-user initialization file
57.Pa /etc/rc ,
58controlled by the
59.Dq dumpdev
60variable in the boot time configuration file
61.Pa /etc/rc.conf .
62.Pp
63For most systems the size of the specified dump device must be at least
64the size of physical memory.
65Even though an additional header is added to the dump,
66the BIOS for a platform typically holds back some memory, so it is not usually
67necessary to size the dump device larger than the actual amount of RAM
68available in the machine.
69.Pp
70The
71.Fl v
72flag causes
73.Nm
74to be verbose about its activity.
75.Sh IMPLEMENTATION NOTES
76Since a
77.Xr panic 9
78condition may occur in a situation
79where the kernel cannot trust its internal representation
80of the state of any given file system,
81one of the system swap devices,
82and
83.Em not
84a device containing a file system,
85should be used as the dump device.
86.Pp
87The
88.Nm
89utility operates by opening
90.Ar special_file
91and making a
92.Dv DIOCSKERNELDUMP
93.Xr ioctl 2
94request on it to save kernel crash dumps.
95If
96.Ar special_file
97is the text string:
98.Dq Li off ,
99.Nm
100performs a
101.Dv DIOCSKERNELDUMP
102.Xr ioctl 2
103on
104.Pa /dev/null
105and thus instructs the kernel not to save crash dumps.
106.Pp
107Since
108.Nm
109cannot be used during kernel initialization, the
110.Va dumpdev
111variable of
112.Xr loader 8
113must be used to enable dumps for system panics which occur
114during kernel initialization.
115.Sh SEE ALSO
116.Xr fstab 5 ,
117.Xr rc.conf 5 ,
118.Xr config 8 ,
119.Xr init 8 ,
120.Xr loader 8 ,
121.Xr rc 8 ,
122.Xr savecore 8 ,
123.Xr swapon 8 ,
124.Xr panic 9
125.Sh FILES
126.Bl -tag -width "/dev/{ad,da}?s?b" -compact
127.It Pa /dev/{ad,da}?s?b
128standard swap areas
129.It Pa /etc/rc.conf
130boot-time system configuration
131.El
132.Sh BUGS
133Because the file system layer is already dead by the time a crash dump
134is taken, it is not possible to send crash dumps directly to a file.
135.Sh HISTORY
136The
137.Nm
138utility appeared in
139.Fx 2.1 .
140