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. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     From: @(#)swapon.8      8.1 (Berkeley) 6/5/93
  29 .\" $FreeBSD: src/sbin/dumpon/dumpon.8,v 1.11.2.12 2003/01/26 03:12:04 keramida Exp $
  30 .\"
  31 .Dd September 29, 2016
  32 .Dt DUMPON 8
  33 .Os
  34 .Sh NAME
  35 .Nm dumpon
  36 .Nd "specify a device for crash dumps"
  37 .Sh SYNOPSIS
  38 .Nm
  39 .Op Fl v
  40 .Ar special_file
  41 .Nm
  42 .Op Fl v
  43 .Cm off
  44 .Sh DESCRIPTION
  45 The
  46 .Nm
  47 utility is used to specify a device where the kernel can save a crash dump in
  48 the case of a panic.
  49 .Pp
  50 Calls to
  51 .Nm
  52 normally occur from the system multi-user initialization file
  53 .Pa /etc/rc ,
  54 controlled by the
  55 .Dq dumpdev
  56 variable in the boot time configuration file
  57 .Pa /etc/rc.conf .
  58 .Pp
  59 For most systems the size of the specified dump device must be at least
  60 the size of physical memory.
  61 Even though an additional header is added to the dump,
  62 the BIOS for a platform typically holds back some memory, so it is not usually
  63 necessary to size the dump device larger than the actual amount of RAM
  64 available in the machine.
  65 .Pp
  66 The
  67 .Fl v
  68 flag causes
  69 .Nm
  70 to be verbose about its activity.
  71 .Sh NOTES
  72 Since a
  73 .Xr panic 9
  74 condition may occur in a situation
  75 where the kernel cannot trust its internal representation
  76 of the state of any given file system,
  77 one of the system swap devices,
  78 and
  79 .Em not
  80 a device containing a file system,
  81 should be used as the dump device.
  82 .Pp
  83 The
  84 .Nm
  85 utility operates by setting the
  86 .Xr sysctl 3
  87 MIB variable
  88 .Va kern.dumpdev
  89 to the device number of the designated
  90 .Ar special_file
  91 or to
  92 .Dv NODEV
  93 (meaning that no dumps are to be taken) if
  94 .Ar special_file
  95 is the text string:
  96 .Dq Li off .
  97 .Pp
  98 Since
  99 .Nm
 100 cannot be used during kernel initialization, the
 101 .Va dumpdev
 102 variable of
 103 .Xr loader 8
 104 must be used to enable dumps for system panics which occur
 105 during kernel initialization.
 106 .Sh FILES
 107 .Bl -tag -width "/dev/{ad,da}?s?b" -compact
 108 .It Pa /dev/{ad,da}?s?b
 109 standard swap areas
 110 .It Pa /etc/rc.conf
 111 boot-time system configuration
 112 .El
 113 .Sh SEE ALSO
 114 .Xr sysctl 3 ,
 115 .Xr fstab 5 ,
 116 .Xr rc.conf 5 ,
 117 .Xr config 8 ,
 118 .Xr init 8 ,
 119 .Xr loader 8 ,
 120 .Xr rc 8 ,
 121 .Xr savecore 8 ,
 122 .Xr swapon 8 ,
 123 .Xr panic 9
 124 .Sh HISTORY
 125 The
 126 .Nm
 127 utility appeared in
 128 .Fx 2.0.5 .
 129 .Sh BUGS
 130 Because the file system layer is already dead by the time a crash dump
 131 is taken, it is not possible to send crash dumps directly to a file.