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: src/sbin/savecore/savecore.8,v 1.8.2.6 2002/06/20 23:09:09 charnier Exp $
  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 Fl N Ar system
  47 .Ar directory
  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 and enters a reboot message and information about the core dump into
  55 the system log.
  56 .Pp
  57 The options are as follows:
  58 .Bl -tag -width indent
  59 .It Fl c
  60 Clear the dump, so that future invocations of
  61 .Nm
  62 will ignore it.
  63 .It Fl f
  64 Force a dump to be taken even if the dump doesn't appear correct or there
  65 is insufficient disk space.
  66 .It Fl k
  67 Do not clear the dump after saving it.
  68 .It Fl N
  69 Use
  70 .Ar system
  71 as the kernel instead of the running kernel (as determined from
  72 .Xr getbootfile 3 ) .
  73 .It Fl v
  74 Print out some additional debugging information.
  75 .It Fl z
  76 Compress the core dump and kernel (see
  77 .Xr gzip 1 ) .
  78 .El
  79 .Pp
  80 The
  81 .Nm
  82 utility
  83 checks the core dump in various ways to make sure that it is current and
  84 that it corresponds to the currently running system.
  85 If it passes these checks, it saves the core image in
  86 .Ar directory Ns Pa /vmcore.#
  87 and the system in
  88 .Ar directory Ns Pa /kernel.#
  89 The ``#'' is the number from the first line of the file
  90 .Ar directory Ns Pa /bounds ,
  91 and it is incremented and stored back into the file each time
  92 .Nm
  93 successfully runs.
  94 .Pp
  95 The
  96 .Nm
  97 utility
  98 also checks the available disk space before attempting to make the copies.
  99 If there is insufficient disk space in the filesystem containing
 100 .Ar directory ,
 101 or if the file
 102 .Ar directory Ns Pa /minfree
 103 exists and the number of free kilobytes (for non-superusers) in the
 104 filesystem after the copies were made would be less than the number
 105 in the first line of this file, the copies are not attempted.
 106 .Pp
 107 If
 108 .Nm
 109 successfully copies the kernel and the core dump, the core dump is cleared
 110 so that future invocations of
 111 .Nm
 112 will ignore it.
 113 .Pp
 114 The
 115 .Nm
 116 utility
 117 is meant to be called near the end of the initialization file
 118 .Pa /etc/rc
 119 (see
 120 .Xr rc 8 ) .
 121 .Sh BUGS
 122 The minfree code does not consider the effect of compression.
 123 .Sh SEE ALSO
 124 .Xr gzip 1 ,
 125 .Xr getbootfile 3 ,
 126 .Xr dumpon 8 ,
 127 .Xr syslogd 8
 128 .Sh HISTORY
 129 The
 130 .Nm
 131 utility appeared in
 132 .Bx 4.1 .