sbin/savecore/savecore.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 .\" 4. 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: @(#)savecore.8    8.1 (Berkeley) 6/5/93
  29 .\" $FreeBSD: src/sbin/savecore/savecore.8 2005/02/24 02:45:10 obrien Exp $
  30 .\" $DragonFly: src/sbin/savecore/savecore.8,v 1.7 2006/10/20 18:30:12 corecode Exp $
  31 .\"
  32 .Dd December 15, 2009
  33 .Dt SAVECORE 8
  34 .Os
  35 .Sh NAME
  36 .Nm savecore
  37 .Nd "save a core dump of the operating system"
  38 .Sh SYNOPSIS
  39 .Nm
  40 .Fl c
  41 .Nm
  42 .Fl C
  43 .Op Fl v
  44 .Op Ar directory device
  45 .Nm
  46 .Op Fl fkvz
  47 .Op Ar directory Op Ar device ...
  48 .Sh DESCRIPTION
  49 The
  50 .Nm
  51 utility
  52 copies the currently running kernel and its associated core dump into
  53 .Fa directory ,
  54 or the current working directory if no
  55 .Ar directory
  56 argument is given,
  57 and enters a reboot message and information about the core dump into
  58 the system log.
  59 .Pp
  60 The options are as follows:
  61 .Bl -tag -width indent
  62 .It Fl C
  63 Check to see if a dump exists,
  64 and display a brief message to indicate the status.
  65 An exit status of 0 indicates that a dump is there,
  66 1 indicates that none exists.
  67 This option is compatible only with the
  68 .Op Fl v
  69 option.
  70 .It Fl c
  71 Clear the dump, so that future invocations of
  72 .Nm
  73 will ignore it.
  74 .It Fl f
  75 Force a dump to be taken even if either the dump was cleared or if the
  76 dump header information is inconsistent.
  77 .It Fl k
  78 Do not clear the dump after saving it.
  79 .It Fl v
  80 Print out some additional debugging information.
  81 .It Fl z
  82 Compress the core dump and kernel (see
  83 .Xr gzip 1 ) .
  84 .El
  85 .Pp
  86 The
  87 .Nm
  88 utility
  89 looks for dumps on each device specified by the
  90 .Ar device
  91 argument(s), or on each device in
  92 .Pa /etc/fstab
  93 marked as
  94 .Dq dump
  95 or
  96 .Dq swap .
  97 The
  98 .Nm
  99 utility
 100 checks the core dump in various ways to make sure that it is complete.
 101 If it passes these checks, it saves the core image in
 102 .Ar directory Ns Pa /vmcore.#
 103 and the system in
 104 .Ar directory Ns Pa /kernel.#
 105 and information about the core in
 106 .Ar directory Ns Pa /info.#
 107 The ``#'' is the number from the first line of the file
 108 .Ar directory Ns Pa /bounds ,
 109 and it is incremented and stored back into the file each time
 110 .Nm
 111 successfully runs.
 112 .Pp
 113 The
 114 .Nm
 115 utility
 116 also checks the available disk space before attempting to make the copies.
 117 If there is insufficient disk space in the filesystem containing
 118 .Ar directory ,
 119 or if the file
 120 .Ar directory Ns Pa /minfree
 121 exists and the number of free kilobytes (for non-superusers) in the
 122 filesystem after the copies were made would be less than the number
 123 in the first line of this file, the copies are not attempted.
 124 .Pp
 125 If
 126 .Nm
 127 successfully copies the kernel and the core dump, the core dump is cleared
 128 so that future invocations of
 129 .Nm
 130 will ignore it.
 131 .Pp
 132 The
 133 .Nm
 134 utility
 135 is meant to be called near the end of the initialization file
 136 .Pa /etc/rc
 137 (see
 138 .Xr rc 8 ) .
 139 .Sh SEE ALSO
 140 .Xr gzip 1 ,
 141 .Xr getbootfile 3 ,
 142 .Xr dumpon 8 ,
 143 .Xr loader 8 ,
 144 .Xr syslogd 8
 145 .Sh HISTORY
 146 The
 147 .Nm
 148 utility appeared in
 149 .Bx 4.1 .
 150 .Sh BUGS
 151 The minfree code does not consider the effect of compression or sparse files.