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