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 1, 2015
  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 .Op Fl v
  41 .Op Ar device ...
  42 .Nm
  43 .Fl C
  44 .Op Fl v
  45 .Op Ar device ...
  46 .Nm
  47 .Op Fl -libxo
  48 .Op Fl fkvz
  49 .Op Fl m Ar maxdumps
  50 .Op Ar directory Op Ar device ...
  51 .Sh DESCRIPTION
  52 The
  53 .Nm
  54 utility
  55 copies a core dump into
  56 .Ar directory ,
  57 or the current working directory if no
  58 .Ar directory
  59 argument is given,
  60 and enters a reboot message and information about the core dump into
  61 the system log.
  62 .Pp
  63 The options are as follows:
  64 .Bl -tag -width ".Fl m Ar maxdumps"
  65 .It Fl -libxo
  66 Generate output via
  67 .Xr libxo 3
  68 in a selection of different human and machine readable formats.
  69 See
  70 .Xr xo_parse_args 3
  71 for details on command line arguments.
  72 .It Fl C
  73 Check to see if a dump exists,
  74 and display a brief message to indicate the status.
  75 An exit status of 0 indicates that a dump is there,
  76 1 indicates that none exists.
  77 This option is compatible only with the
  78 .Op Fl v
  79 option.
  80 .It Fl c
  81 Clear the dump, so that future invocations of
  82 .Nm
  83 will ignore it.
  84 .It Fl f
  85 Force a dump to be taken even if either the dump was cleared or if the
  86 dump header information is inconsistent.
  87 .It Fl k
  88 Do not clear the dump after saving it.
  89 .It Fl m Ar maxdumps
  90 Maximum number of dumps to store.
  91 Once the number of stored dumps is equal to
  92 .Ar maxdumps
  93 the counter will restart from
  94 .Dv 0 .
  95 .It Fl v
  96 Print out some additional debugging information.
  97 Specify twice for more information.
  98 .It Fl z
  99 Compress the core dump and kernel (see
 100 .Xr gzip 1 ) .
 101 .El
 102 .Pp
 103 The
 104 .Nm
 105 utility
 106 looks for dumps on each device specified by the
 107 .Ar device
 108 argument(s), or on each device in
 109 .Pa /etc/fstab
 110 marked as
 111 .Dq dump
 112 or
 113 .Dq swap .
 114 The
 115 .Nm
 116 utility
 117 checks the core dump in various ways to make sure that it is complete.
 118 If it passes these checks, it saves the core image in
 119 .Ar directory Ns Pa /vmcore.#
 120 and information about the core in
 121 .Ar directory Ns Pa /info.# .
 122 For kernel textdumps generated with the
 123 .Xr textdump 4
 124 facility, output will be stored in the
 125 .Xr tar 5
 126 format and named
 127 .Ar directory Ns Pa /textdump.tar.# .
 128 The
 129 .Dq #
 130 is the number from the first line of the file
 131 .Ar directory Ns Pa /bounds ,
 132 and it is incremented and stored back into the file each time
 133 .Nm
 134 successfully runs.
 135 .Pp
 136 The
 137 .Nm
 138 utility
 139 also checks the available disk space before attempting to make the copies.
 140 If there is insufficient disk space in the file system containing
 141 .Ar directory ,
 142 or if the file
 143 .Ar directory Ns Pa /minfree
 144 exists and the number of free kilobytes (for non-superusers) in the
 145 file system after the copies were made would be less than the number
 146 in the first line of this file, the copies are not attempted.
 147 .Pp
 148 If
 149 .Nm
 150 successfully copies the kernel and the core dump, the core dump is cleared
 151 so that future invocations of
 152 .Nm
 153 will ignore it.
 154 .Pp
 155 The
 156 .Nm
 157 utility
 158 is meant to be called near the end of the initialization file
 159 .Pa /etc/rc
 160 (see
 161 .Xr rc 8 ) .
 162 .Sh SEE ALSO
 163 .Xr gzip 1 ,
 164 .Xr getbootfile 3 ,
 165 .Xr libxo 3 ,
 166 .Xr xo_parse_args 3 ,
 167 .Xr textdump 4 ,
 168 .Xr tar 5 ,
 169 .Xr dumpon 8 ,
 170 .Xr syslogd 8
 171 .Sh HISTORY
 172 The
 173 .Nm
 174 utility appeared in
 175 .Bx 4.1 .
 176 .Pp
 177 Support for kernel textdumps appeared in
 178 .Fx 7.1 .
 179 .Sh BUGS
 180 The minfree code does not consider the effect of compression or sparse files.