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 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  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: @(#)savecore.8    8.1 (Berkeley) 6/5/93
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd September 23, 1994
  36 .Dt SAVECORE 8
  37 .Os
  38 .Sh NAME
  39 .Nm savecore
  40 .Nd "save a core dump of the operating system"
  41 .Sh SYNOPSIS
  42 .Nm
  43 .Fl c
  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 Clear the dump, so that future invocations of
  63 .Nm
  64 will ignore it.
  65 .It Fl f
  66 Force a dump to be taken even if the dump was cleared.
  67 .It Fl k
  68 Do not clear the dump after saving it.
  69 .It Fl v
  70 Print out some additional debugging information.
  71 .It Fl z
  72 Compress the core dump and kernel (see
  73 .Xr gzip 1 ) .
  74 .El
  75 .Pp
  76 The
  77 .Nm
  78 utility
  79 looks for dumps on each device specified by the
  80 .Ar device
  81 argument(s), or on each device in
  82 .Pa /etc/fstab
  83 marked as
  84 .Dq dump
  85 or
  86 .Dq swap .
  87 The
  88 .Nm
  89 utility
  90 checks the core dump in various ways to make sure that it is complete.
  91 If it passes these checks, it saves the core image in
  92 .Ar directory Ns Pa /vmcore.#
  93 and information about the core in
  94 .Ar directory Ns Pa /info.#
  95 The ``#'' is the number from the first line of the file
  96 .Ar directory Ns Pa /bounds ,
  97 and it is incremented and stored back into the file each time
  98 .Nm
  99 successfully runs.
 100 .Pp
 101 The
 102 .Nm
 103 utility
 104 also checks the available disk space before attempting to make the copies.
 105 If there is insufficient disk space in the filesystem containing
 106 .Ar directory ,
 107 or if the file
 108 .Ar directory Ns Pa /minfree
 109 exists and the number of free kilobytes (for non-superusers) in the
 110 filesystem after the copies were made would be less than the number
 111 in the first line of this file, the copies are not attempted.
 112 .Pp
 113 If
 114 .Nm
 115 successfully copies the kernel and the core dump, the core dump is cleared
 116 so that future invocations of
 117 .Nm
 118 will ignore it.
 119 .Pp
 120 The
 121 .Nm
 122 utility
 123 is meant to be called near the end of the initialization file
 124 .Pa /etc/rc
 125 (see
 126 .Xr rc 8 ) .
 127 .Sh BUGS
 128 The minfree code does not consider the effect of compression or sparse files.
 129 .Sh SEE ALSO
 130 .Xr gzip 1 ,
 131 .Xr getbootfile 3 ,
 132 .Xr dumpon 8 ,
 133 .Xr syslogd 8
 134 .Sh HISTORY
 135 The
 136 .Nm
 137 command appeared in
 138 .Bx 4.1 .