Add options to allow the dump offset or system memory size (for the purposes
[dragonfly.git] / 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.4 2006/03/25 07:46:58 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 .Op Fl P Ar physmem
49 .Op Fl B Ar blkno
50 .Ar directory
51 .Sh DESCRIPTION
52 The
53 .Nm
54 utility
55 copies the currently running kernel and its associated core dump into
56 .Fa directory ,
57 and enters a reboot message and information about the core dump into
58 the system log.
59 .Pp
60 The options are as follows:
61 .Bl -tag -width indent
62 .It Fl c
63 Clear the dump, so that future invocations of
64 .Nm
65 will ignore it.
66 .It Fl f
67 Force a dump to be taken even if the dump doesn't appear correct or there
68 is insufficient disk space.
69 .It Fl k
70 Do not clear the dump after saving it.
71 .It Fl N
72 Use
73 .Ar system
74 as the kernel instead of the running kernel (as determined from
75 .Xr getbootfile 3 ) .
76 .It Fl P
77 Specify physical memory size used at dumptime (cf. the
78 .Va hw.physmem
79 kernel environment variable).
80 .It Fl B 
81 Specify offset of dump in blocks (as printed at dumptime).
82 .It Fl v
83 Print out some additional debugging information.
84 .It Fl z
85 Compress the core dump and kernel (see
86 .Xr gzip 1 ) .
87 .El
88 .Pp
89 The
90 .Nm
91 utility
92 checks the core dump in various ways to make sure that it is current and
93 that it corresponds to the currently running system.
94 If it passes these checks, it saves the core image in
95 .Ar directory Ns Pa /vmcore.#
96 and the system in
97 .Ar directory Ns Pa /kernel.#
98 The ``#'' is the number from the first line of the file
99 .Ar directory Ns Pa /bounds ,
100 and it is incremented and stored back into the file each time
101 .Nm
102 successfully runs.
103 .Pp
104 The
105 .Nm
106 utility
107 also checks the available disk space before attempting to make the copies.
108 If there is insufficient disk space in the filesystem containing
109 .Ar directory ,
110 or if the file
111 .Ar directory Ns Pa /minfree
112 exists and the number of free kilobytes (for non-superusers) in the
113 filesystem after the copies were made would be less than the number
114 in the first line of this file, the copies are not attempted.
115 .Pp
116 If
117 .Nm
118 successfully copies the kernel and the core dump, the core dump is cleared
119 so that future invocations of
120 .Nm
121 will ignore it.
122 .Pp
123 The
124 .Nm
125 utility
126 is meant to be called near the end of the initialization file
127 .Pa /etc/rc
128 (see
129 .Xr rc 8 ) .
130 .Sh SEE ALSO
131 .Xr gzip 1 ,
132 .Xr getbootfile 3 ,
133 .Xr dumpon 8 ,
134 .Xr syslogd 8 ,
135 .Xr loader 8
136 .Sh HISTORY
137 The
138 .Nm
139 utility appeared in
140 .Bx 4.1 .
141 .Sh BUGS
142 The minfree code does not consider the effect of compression.