freebsd-nq/sbin/savecore/savecore.8

.\" Copyright (c) 1980, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     From: @(#)savecore.8	8.1 (Berkeley) 6/5/93
.\" $FreeBSD$
.\"
.Dd September 23, 1994
.Dt SAVECORE 8
.Os
.Sh NAME
.Nm savecore
.Nd "save a core dump of the operating system"
.Sh SYNOPSIS
.Nm
.Fl c
.Nm
.Op Fl fkvz
.Op Ar directory Op Ar device ...
.Sh DESCRIPTION
The
.Nm
utility
copies a core dump into
.Ar directory ,
or the current working directory if no
.Ar directory
argument is given,
and enters a reboot message and information about the core dump into
the system log.
.Pp
The options are as follows:
.Bl -tag -width indent
.It Fl c
Clear the dump, so that future invocations of
.Nm
will ignore it.
.It Fl f
Force a dump to be taken even if the dump was cleared.
.It Fl k
Do not clear the dump after saving it.
.It Fl v
Print out some additional debugging information.
.It Fl z
Compress the core dump and kernel (see
.Xr gzip 1 ) .
.El
.Pp
The
.Nm
utility
looks for dumps on each device specified by the
.Ar device
argument(s), or on each device in
.Pa /etc/fstab
marked as
.Dq dump
or
.Dq swap .
The
.Nm
utility
checks the core dump in various ways to make sure that it is complete.
If it passes these checks, it saves the core image in
.Ar directory Ns Pa /vmcore.#
and information about the core in
.Ar directory Ns Pa /info.#
The ``#'' is the number from the first line of the file
.Ar directory Ns Pa /bounds ,
and it is incremented and stored back into the file each time
.Nm
successfully runs.
.Pp
The
.Nm
utility
also checks the available disk space before attempting to make the copies.
If there is insufficient disk space in the filesystem containing
.Ar directory ,
or if the file
.Ar directory Ns Pa /minfree
exists and the number of free kilobytes (for non-superusers) in the
filesystem after the copies were made would be less than the number
in the first line of this file, the copies are not attempted.
.Pp
If
.Nm
successfully copies the kernel and the core dump, the core dump is cleared
so that future invocations of
.Nm
will ignore it.
.Pp
The
.Nm
utility
is meant to be called near the end of the initialization file
.Pa /etc/rc
(see
.Xr rc 8 ) .
.Sh BUGS
The minfree code does not consider the effect of compression or sparse files.
.Sh SEE ALSO
.Xr gzip 1 ,
.Xr getbootfile 3 ,
.Xr dumpon 8 ,
.Xr syslogd 8
.Sh HISTORY
The
.Nm
command appeared in
.Bx 4.1 .
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.\" Copyright (c) 1980, 1991, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\" 3. All advertising materials mentioning features or use of this software`
			`.\" must display the following acknowledgement:`
			`.\" This product includes software developed by the University of`
			`.\" California, Berkeley and its contributors.`
			`.\" 4. Neither the name of the University nor the names of its contributors`
			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
Get rid of _PATH_UNIX completely; use getbootfile(3) instead. DANGER WILL ROBINSON! _PATH_UNIX is currently defined as the literal string "don't use this". I am of two minds about this myself, but wanted to get something into the tree as quickly as possible. 1994-09-24 00:08:43 +00:00			`.\" From: @(#)savecore.8 8.1 (Berkeley) 6/5/93`
$Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.\"`
Get rid of _PATH_UNIX completely; use getbootfile(3) instead. DANGER WILL ROBINSON! _PATH_UNIX is currently defined as the literal string "don't use this". I am of two minds about this myself, but wanted to get something into the tree as quickly as possible. 1994-09-24 00:08:43 +00:00			`.Dd September 23, 1994`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.Dt SAVECORE 8`
mdoc(7) police: removed HISTORY info from the .Os call. 2001-07-10 11:04:34 +00:00			`.Os`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.Sh NAME`
			`.Nm savecore`
			`.Nd "save a core dump of the operating system"`
			`.Sh SYNOPSIS`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 16:52:27 +00:00			`.Nm`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.Fl c`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 16:52:27 +00:00			`.Nm`
Document the new -k option in usage message and man page. 2001-02-16 16:28:36 +00:00			`.Op Fl fkvz`
- revert back to vmcore.# - reimplement -z - use syslog() - improve consistancy of messages - allow -f to recover cleared dumps - return bufsize to 1024 * 1024 - return the ability to write sparse files - update man page - fix minfree to require 2k for info file instead of the kernel size - include Berkeley copyright too due to amount of old code copied Submitted by: Chad David <davidc@acns.ab.ca> 2002-05-05 01:04:00 +00:00			`.Op Ar directory Op Ar device ...`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.Sh DESCRIPTION`
mdoc(7) police: nits. 2002-05-29 16:53:27 +00:00			`The`
			`.Nm`
			`utility`
- revert back to vmcore.# - reimplement -z - use syslog() - improve consistancy of messages - allow -f to recover cleared dumps - return bufsize to 1024 * 1024 - return the ability to write sparse files - update man page - fix minfree to require 2k for info file instead of the kernel size - include Berkeley copyright too due to amount of old code copied Submitted by: Chad David <davidc@acns.ab.ca> 2002-05-05 01:04:00 +00:00			`copies a core dump into`
mdoc(7) police: nits. 2002-05-29 16:53:27 +00:00			`.Ar directory ,`
- revert back to vmcore.# - reimplement -z - use syslog() - improve consistancy of messages - allow -f to recover cleared dumps - return bufsize to 1024 * 1024 - return the ability to write sparse files - update man page - fix minfree to require 2k for info file instead of the kernel size - include Berkeley copyright too due to amount of old code copied Submitted by: Chad David <davidc@acns.ab.ca> 2002-05-05 01:04:00 +00:00			`or the current working directory if no`
mdoc(7) police: nits. 2002-05-29 16:53:27 +00:00			`.Ar directory`
- revert back to vmcore.# - reimplement -z - use syslog() - improve consistancy of messages - allow -f to recover cleared dumps - return bufsize to 1024 * 1024 - return the ability to write sparse files - update man page - fix minfree to require 2k for info file instead of the kernel size - include Berkeley copyright too due to amount of old code copied Submitted by: Chad David <davidc@acns.ab.ca> 2002-05-05 01:04:00 +00:00			`argument is given,`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`and enters a reboot message and information about the core dump into`
			`the system log.`
			`.Pp`
			`The options are as follows:`
Correct use of .Nm, add rcsid, remove unused #include. 1998-07-28 06:38:57 +00:00			`.Bl -tag -width indent`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.It Fl c`
Correct use of .Nm, add rcsid, remove unused #include. 1998-07-28 06:38:57 +00:00			`Clear the dump, so that future invocations of`
			`.Nm`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`will ignore it.`
			`.It Fl f`
- revert back to vmcore.# - reimplement -z - use syslog() - improve consistancy of messages - allow -f to recover cleared dumps - return bufsize to 1024 * 1024 - return the ability to write sparse files - update man page - fix minfree to require 2k for info file instead of the kernel size - include Berkeley copyright too due to amount of old code copied Submitted by: Chad David <davidc@acns.ab.ca> 2002-05-05 01:04:00 +00:00			`Force a dump to be taken even if the dump was cleared.`
Document the new -k option in usage message and man page. 2001-02-16 16:28:36 +00:00			`.It Fl k`
			`Do not clear the dump after saving it.`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.It Fl v`
Correct use of .Nm, add rcsid, remove unused #include. 1998-07-28 06:38:57 +00:00			`Print out some additional debugging information.`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.It Fl z`
Correct use of .Nm, add rcsid, remove unused #include. 1998-07-28 06:38:57 +00:00			`Compress the core dump and kernel (see`
* Switch from doing compress(1)ed crashdumps with the -z flag to using gzip(1). gdb doesn't understand these, but then again it didn't understand compressed crashdumps either. * Change a stray lseek() into a Lseek() * Remove the extraneous prototype for log() which has apparently never existed in FreeBSD's sources Obtained from: NetBSD (partially) MFC after: 2 weeks 2001-09-06 09:30:09 +00:00			`.Xr gzip 1 ) .`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.El`
			`.Pp`
mdoc(7) police: nits. 2002-05-29 16:53:27 +00:00			`The`
			`.Nm`
			`utility`
- revert back to vmcore.# - reimplement -z - use syslog() - improve consistancy of messages - allow -f to recover cleared dumps - return bufsize to 1024 * 1024 - return the ability to write sparse files - update man page - fix minfree to require 2k for info file instead of the kernel size - include Berkeley copyright too due to amount of old code copied Submitted by: Chad David <davidc@acns.ab.ca> 2002-05-05 01:04:00 +00:00			`looks for dumps on each device specified by the`
			`.Ar device`
			`argument(s), or on each device in`
			`.Pa /etc/fstab`
mdoc(7) police: nits. 2002-05-29 16:53:27 +00:00			`marked as`
			`.Dq dump`
			`or`
			`.Dq swap .`
			`The`
			`.Nm`
			`utility`
- revert back to vmcore.# - reimplement -z - use syslog() - improve consistancy of messages - allow -f to recover cleared dumps - return bufsize to 1024 * 1024 - return the ability to write sparse files - update man page - fix minfree to require 2k for info file instead of the kernel size - include Berkeley copyright too due to amount of old code copied Submitted by: Chad David <davidc@acns.ab.ca> 2002-05-05 01:04:00 +00:00			`checks the core dump in various ways to make sure that it is complete.`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`If it passes these checks, it saves the core image in`
			`.Ar directory Ns Pa /vmcore.#`
- revert back to vmcore.# - reimplement -z - use syslog() - improve consistancy of messages - allow -f to recover cleared dumps - return bufsize to 1024 * 1024 - return the ability to write sparse files - update man page - fix minfree to require 2k for info file instead of the kernel size - include Berkeley copyright too due to amount of old code copied Submitted by: Chad David <davidc@acns.ab.ca> 2002-05-05 01:04:00 +00:00			`and information about the core in`
			`.Ar directory Ns Pa /info.#`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			The ``#'' is the number from the first line of the file
			`.Ar directory Ns Pa /bounds ,`
			`and it is incremented and stored back into the file each time`
Correct use of .Nm, add rcsid, remove unused #include. 1998-07-28 06:38:57 +00:00			`.Nm`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`successfully runs.`
			`.Pp`
mdoc(7) police: nits. 2002-05-29 16:53:27 +00:00			`The`
			`.Nm`
			`utility`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`also checks the available disk space before attempting to make the copies.`
			`If there is insufficient disk space in the filesystem containing`
			`.Ar directory ,`
			`or if the file`
			`.Ar directory Ns Pa /minfree`
			`exists and the number of free kilobytes (for non-superusers) in the`
			`filesystem after the copies were made would be less than the number`
			`in the first line of this file, the copies are not attempted.`
			`.Pp`
			`If`
Correct use of .Nm, add rcsid, remove unused #include. 1998-07-28 06:38:57 +00:00			`.Nm`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`successfully copies the kernel and the core dump, the core dump is cleared`
			`so that future invocations of`
Correct use of .Nm, add rcsid, remove unused #include. 1998-07-28 06:38:57 +00:00			`.Nm`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`will ignore it.`
			`.Pp`
mdoc(7) police: nits. 2002-05-29 16:53:27 +00:00			`The`
			`.Nm`
			`utility`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`is meant to be called near the end of the initialization file`
			`.Pa /etc/rc`
			`(see`
			`.Xr rc 8 ) .`
			`.Sh BUGS`
- revert back to vmcore.# - reimplement -z - use syslog() - improve consistancy of messages - allow -f to recover cleared dumps - return bufsize to 1024 * 1024 - return the ability to write sparse files - update man page - fix minfree to require 2k for info file instead of the kernel size - include Berkeley copyright too due to amount of old code copied Submitted by: Chad David <davidc@acns.ab.ca> 2002-05-05 01:04:00 +00:00			`The minfree code does not consider the effect of compression or sparse files.`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.Sh SEE ALSO`
* Switch from doing compress(1)ed crashdumps with the -z flag to using gzip(1). gdb doesn't understand these, but then again it didn't understand compressed crashdumps either. * Change a stray lseek() into a Lseek() * Remove the extraneous prototype for log() which has apparently never existed in FreeBSD's sources Obtained from: NetBSD (partially) MFC after: 2 weeks 2001-09-06 09:30:09 +00:00			`.Xr gzip 1 ,`
mdoc(7) police: restore the correct sorting of SEE ALSO. 2001-09-11 09:58:34 +00:00			`.Xr getbootfile 3 ,`
Add a Xref to dumpon. 2001-10-28 16:41:56 +00:00			`.Xr dumpon 8 ,`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.Xr syslogd 8`
			`.Sh HISTORY`
			`The`
			`.Nm`
			`command appeared in`
			`.Bx 4.1 .`