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$
  30 .\"
  31 .Dd December 24, 2008
  32 .Dt SAVECORE 8
  33 .Os
  34 .Sh NAME
  35 .Nm savecore
  36 .Nd "save a core dump of the operating system"
  37 .Sh SYNOPSIS
  38 .Nm
  39 .Fl c
  40 .Nm
  41 .Fl C
  42 .Op Fl v
  43 .Op Ar directory device
  44 .Nm
  45 .Op Fl fkvz
  46 .Op Ar directory Op Ar device ...
  47 .Sh DESCRIPTION
  48 The
  49 .Nm
  50 utility
  51 copies a core dump into
  52 .Ar directory ,
  53 or the current working directory if no
  54 .Ar directory
  55 argument is given,
  56 and enters a reboot message and information about the core dump into
  57 the system log.
  58 .Pp
  59 The options are as follows:
  60 .Bl -tag -width indent
  61 .It Fl C
  62 Check to see if a dump exists,
  63 and display a brief message to indicate the status.
  64 An exit status of 0 indicates that a dump is there,
  65 1 indicates that none exists.
  66 This option is compatible only with the
  67 .Op Fl v
  68 option.
  69 .It Fl c
  70 Clear the dump, so that future invocations of
  71 .Nm
  72 will ignore it.
  73 .It Fl f
  74 Force a dump to be taken even if either the dump was cleared or if the
  75 dump header information is inconsistent.
  76 .It Fl k
  77 Do not clear the dump after saving it.
  78 .It Fl v
  79 Print out some additional debugging information.
  80 Specify twice for more 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 information about the core in
 104 .Ar directory Ns Pa /info.#
 105 For kernel textdumps generated with the
 106 .Xr textdump 4
 107 facility, output will be stored in the
 108 .Xr tar 5
 109 format and named
 110 .Ar director Ns Pa /textdump.tar.#
 111 The ``#'' is the number from the first line of the file
 112 .Ar directory Ns Pa /bounds ,
 113 and it is incremented and stored back into the file each time
 114 .Nm
 115 successfully runs.
 116 .Pp
 117 The
 118 .Nm
 119 utility
 120 also checks the available disk space before attempting to make the copies.
 121 If there is insufficient disk space in the file system containing
 122 .Ar directory ,
 123 or if the file
 124 .Ar directory Ns Pa /minfree
 125 exists and the number of free kilobytes (for non-superusers) in the
 126 file system after the copies were made would be less than the number
 127 in the first line of this file, the copies are not attempted.
 128 .Pp
 129 If
 130 .Nm
 131 successfully copies the kernel and the core dump, the core dump is cleared
 132 so that future invocations of
 133 .Nm
 134 will ignore it.
 135 .Pp
 136 The
 137 .Nm
 138 utility
 139 is meant to be called near the end of the initialization file
 140 .Pa /etc/rc
 141 (see
 142 .Xr rc 8 ) .
 143 .Sh SEE ALSO
 144 .Xr gzip 1 ,
 145 .Xr getbootfile 3 ,
 146 .Xr textdump 4 ,
 147 .Xr tar 5 ,
 148 .Xr dumpon 8 ,
 149 .Xr syslogd 8
 150 .Sh HISTORY
 151 The
 152 .Nm
 153 utility appeared in
 154 .Bx 4.1 .
 155 .Pp
 156 Support for kernel textdumps appeared in
 157 .Fx 7.1 .
 158 .Sh BUGS
 159 The minfree code does not consider the effect of compression or sparse files.