Changeset View
Changeset View
Standalone View
Standalone View
sbin/savecore/savecore.8
Show All 22 Lines | |||||
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | ||||
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | .\" 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 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | ||||
.\" SUCH DAMAGE. | .\" SUCH DAMAGE. | ||||
.\" | .\" | ||||
.\" From: @(#)savecore.8 8.1 (Berkeley) 6/5/93 | .\" From: @(#)savecore.8 8.1 (Berkeley) 6/5/93 | ||||
.\" $FreeBSD$ | .\" $FreeBSD$ | ||||
.\" | .\" | ||||
.Dd November 17, 2020 | .Dd April 4, 2022 | ||||
.Dt SAVECORE 8 | .Dt SAVECORE 8 | ||||
.Os | .Os | ||||
.Sh NAME | .Sh NAME | ||||
.Nm savecore | .Nm savecore | ||||
.Nd "save a core dump of the operating system" | .Nd "save a core dump of the operating system" | ||||
.Sh SYNOPSIS | .Sh SYNOPSIS | ||||
.Nm | .Nm | ||||
.Fl c | .Fl c | ||||
.Op Fl v | .Op Fl v | ||||
.Op Ar device ... | .Op Ar device ... | ||||
.Nm | .Nm | ||||
.Fl C | .Fl C | ||||
.Op Fl v | .Op Fl v | ||||
.Op Ar device ... | .Op Ar device ... | ||||
.Nm | .Nm | ||||
.Fl L | |||||
.Op Fl fvZz | |||||
.Op Fl m Ar maxdumps | |||||
.Op Ar directory | |||||
.Nm | |||||
.Op Fl -libxo | .Op Fl -libxo | ||||
.Op Fl fkuvz | .Op Fl fkuvz | ||||
.Op Fl m Ar maxdumps | .Op Fl m Ar maxdumps | ||||
.Op Ar directory Op Ar device ... | .Op Ar directory Op Ar device ... | ||||
.Sh DESCRIPTION | .Sh DESCRIPTION | ||||
The | The | ||||
.Nm | .Nm | ||||
utility | utility | ||||
Show All 26 Lines | |||||
Clear the dump, so that future invocations of | Clear the dump, so that future invocations of | ||||
.Nm | .Nm | ||||
will ignore it. | will ignore it. | ||||
.It Fl f | .It Fl f | ||||
Force a dump to be taken even if either the dump was cleared or if the | Force a dump to be taken even if either the dump was cleared or if the | ||||
dump header information is inconsistent. | dump header information is inconsistent. | ||||
.It Fl k | .It Fl k | ||||
Do not clear the dump after saving it. | Do not clear the dump after saving it. | ||||
.It Fl L | |||||
Instruct | |||||
.Nm | |||||
to generate and save a kernel dump of the running system, rather than | |||||
copying one from a dump device. | |||||
.It Fl m Ar maxdumps | .It Fl m Ar maxdumps | ||||
Maximum number of dumps to store. | Maximum number of dumps to store. | ||||
Once the number of stored dumps is equal to | Once the number of stored dumps is equal to | ||||
.Ar maxdumps | .Ar maxdumps | ||||
the counter will restart from | the counter will restart from | ||||
.Dv 0 . | .Dv 0 . | ||||
.It Fl u | .It Fl u | ||||
Uncompress the dump in case it was compressed by the kernel. | Uncompress the dump in case it was compressed by the kernel. | ||||
.It Fl v | .It Fl v | ||||
Print out some additional debugging information. | Print out some additional debugging information. | ||||
Specify twice for more information. | Specify twice for more information. | ||||
.It Fl Z | |||||
Compress the dump (see | |||||
.Xr zstd 1 ) . | |||||
debdrup: Are you sure this is correct syntax according to `mandoc -Tlint`? | |||||
Done Inline ActionsYes! No complaints from mandoc or igor, but I had forgotten to check this :) It is copied from the paragraph below. mhorne: Yes! No complaints from mandoc or igor, but I had forgotten to check this :) It is copied from… | |||||
This option is only supported in conjunction with the | |||||
.Fl L | |||||
option. | |||||
Regular dumps can be configured for compression with zstd using | |||||
.Xr dumpon 8 . | |||||
.It Fl z | .It Fl z | ||||
Compress the dump (see | Compress the dump (see | ||||
.Xr gzip 1 ) . | .Xr gzip 1 ) . | ||||
The dump may already be compressed if the kernel was configured to | The dump may already be compressed if the kernel was configured to | ||||
do so by | do so by | ||||
.Xr dumpon 8 . | .Xr dumpon 8 . | ||||
In this case, the option has no effect. | In this case, the option has no effect. | ||||
.Pp | |||||
If used in conjunction with the | |||||
.Fl L | |||||
option, the requested live dump will be compressed with gzip. | |||||
.El | .El | ||||
.Pp | .Pp | ||||
The | The | ||||
.Nm | .Nm | ||||
utility | utility | ||||
looks for dumps on each device specified by the | looks for dumps on each device specified by the | ||||
.Ar device | .Ar device | ||||
argument(s), or on each device in | argument(s), or on each device in | ||||
▲ Show 20 Lines • Show All 51 Lines • ▼ Show 20 Lines | |||||
.Nm | .Nm | ||||
utility | utility | ||||
is meant to be called near the end of the initialization file | is meant to be called near the end of the initialization file | ||||
.Pa /etc/rc | .Pa /etc/rc | ||||
(see | (see | ||||
.Xr rc 8 ) . | .Xr rc 8 ) . | ||||
.Sh SEE ALSO | .Sh SEE ALSO | ||||
.Xr gzip 1 , | .Xr gzip 1 , | ||||
.Xr zstd 1 , | |||||
.Xr getbootfile 3 , | .Xr getbootfile 3 , | ||||
.Xr libxo 3 , | .Xr libxo 3 , | ||||
.Xr xo_parse_args 3 , | .Xr xo_parse_args 3 , | ||||
.Xr mem 4 , | |||||
.Xr textdump 4 , | .Xr textdump 4 , | ||||
.Xr tar 5 , | .Xr tar 5 , | ||||
.Xr crashinfo 8 , | .Xr crashinfo 8 , | ||||
.Xr decryptcore 8 , | .Xr decryptcore 8 , | ||||
.Xr dumpon 8 , | .Xr dumpon 8 , | ||||
.Xr syslogd 8 | .Xr syslogd 8 | ||||
.Sh HISTORY | .Sh HISTORY | ||||
The | The | ||||
.Nm | .Nm | ||||
utility appeared in | utility appeared in | ||||
.Bx 4.1 . | .Bx 4.1 . | ||||
.Pp | .Pp | ||||
Support for kernel textdumps appeared in | Support for kernel textdumps appeared in | ||||
.Fx 7.1 . | .Fx 7.1 . | ||||
.Sh BUGS | .Sh BUGS | ||||
The minfree code does not consider the effect of compression or sparse files. | The minfree code does not consider the effect of compression or sparse files. |
Are you sure this is correct syntax according to mandoc -Tlint?