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