sbin/dumpon/dumpon.8

   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
  49 .Nm Dumpon
  50 is used to specify a device where the kernel can save a crash dump in
  51 the case of a panic.
  52 .Pp
  53 Calls to
  54 .Nm
  55 normally occur from the system multi-user initialization file
  56 .Pa /etc/rc ,
  57 controlled by the
  58 .Dq dumpdev
  59 variable in the boot time configuration file
  60 .Pa /etc/rc.conf .
  61 .Pp
  62 The size of the specified dump device must be at least 64 KB greater
  63 than the size of physical memory.
  64 .Pp
  65 The
  66 .Fl v
  67 flag causes
  68 .Nm
  69 to be verbose about its activity.
  70 .Sh NOTES
  71 Since a
  72 .Xr panic 9
  73 condition may occur in a situation
  74 where the kernel cannot trust its internal representation
  75 of the state of any given filesystem,
  76 one of the system swap devices,
  77 and
  78 .Em not
  79 a device containing a filesystem,
  80 should be used as the dump device.
  81 .Pp
  82 The
  83 .Nm
  84 program operates by setting the
  85 .Xr sysctl 3
  86 MIB variable
  87 .Dq kern.dumpdev
  88 to the device number of the designated
  89 .Ar special_file
  90 or to
  91 .Dv NODEV
  92 (meaning that no dumps are to be taken) if
  93 .Ar special_file
  94 is the text string:
  95 .Dq Li off .
  96 .Pp
  97 Since
  98 .Nm
  99 cannot be used during kernel initialization, the
 100 .Va dumpdev
 101 variable of
 102 .Xr loader 8
 103 must be used to enable dumps for system panics which occur
 104 during kernel initialization.
 105 .Sh SEE ALSO
 106 .Xr sysctl 3 ,
 107 .Xr fstab 5 ,
 108 .Xr rc.conf 5 ,
 109 .Xr config 8 ,
 110 .Xr init 8 ,
 111 .Xr loader 8 ,
 112 .Xr rc 8 ,
 113 .Xr savecore 8 ,
 114 .Xr swapon 8 ,
 115 .Xr panic 9
 116 .Sh FILES
 117 .Bl -tag -width "/dev/{ad,da}?s?b" -compact
 118 .It Pa /dev/{ad,da}?s?b
 119 standard swap areas
 120 .It Pa /etc/rc.conf
 121 boot-time system configuration
 122 .El
 123 .Sh BUGS
 124 Because the filesystem layer is already dead by the time a crash dump
 125 is taken, it is not possible to send crash dumps directly to a file.
 126 .Sh HISTORY
 127 The
 128 .Nm
 129 command appeared in
 130 .Fx 2.1 .