3371 dumpadm -z is not documented in manpage

3380 zfs man page: documentation for zfs allow is confusing
Reviewed by: Richard Lowe <[email protected]>
Reviewed by: Robert Mustacchi <[email protected]>
Approved by: Gordon Ross <[email protected]>

usr/src/man/man1m/dumpadm.1m

@@ -1,17 +1,18 @@
 '\" te
 .\"  Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved
+.\" Copyright 2013 Nexenta Systems, Inc.  All Rights Reserved.
 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
-.TH DUMPADM 1M "Apr 10, 2008"
+.TH DUMPADM 1M "Jan 30, 2013"
 .SH NAME
 dumpadm \- configure operating system crash dump
 .SH SYNOPSIS
 .LP
 .nf
 \fB/usr/sbin/dumpadm\fR [\fB-nuy\fR] [\fB-c\fR \fIcontent-type\fR] [\fB-d\fR \fIdump-device\fR]
      [\fB-m\fR \fImin\fRk | \fImin\fRm | \fImin\fR%] [\fB-s\fR \fIsavecore-dir\fR]
-     [\fB-r\fR \fIroot-dir\fR]
+     [\fB-r\fR \fIroot-dir\fR] [\fB-z\fR on | off]
 .fi
 
 .SH DESCRIPTION
@@ -35,12 +36,19 @@ your support engineer to aid in diagnosing the problem. As such, it is vital
 that the crash dump be retrieved and given to your support provider. Following
 an operating system crash, the \fBsavecore\fR(1M) utility is executed
 automatically during boot to retrieve the crash dump from the dump device, and
-write it to a pair of files in your file system named \fIunix.X\fR and
-\fIvmcore.X\fR, where X is an integer identifying the dump. Together, these
-data files form the \fIsaved crash dump\fR. The directory in which the crash
+write it to the file system. The directory in which the crash
 dump is saved on reboot can also be configured using \fBdumpadm\fR.
 .sp
 .LP
+When the operating system takes a crash dump the default behavior is to
+compress the crash dump. This behavior is controlled by the \fB-z\fR option.
+When compression is turned on, the \fBsavecore\fR(1M) utility writes one file
+to the file system named \fIvmdump.X\fR. If compression is disabled, it instead
+writes two files named \fIunix.X\fR and \fIvmcore.X\fR. In the uncompressed
+case, both data files form the \fIsaved crash dump\fR. In both cases X is an
+integer identifying the dump.
+.sp
+.LP
 For systems with a UFS root file system, the default dump device is  configured
 to be an appropriate swap partition. Swap partitions are disk partitions
 reserved as virtual memory backing store for the operating system. Thus, no
@@ -58,6 +66,7 @@ example# \fBdumpadm\fR
        Dump device: /dev/dsk/c0t0d0s1 (swap)
 Savecore directory: /var/crash/saturn
   Savecore enabled: yes
+   Save compressed: on
 .fi
 .in -2
 .sp
@@ -68,8 +77,8 @@ When no options are specified, \fBdumpadm\fR prints the current crash dump
 configuration. The example shows the set of default values: the dump content is
 set to kernel memory pages only, the dump device is a swap disk partition, the
 directory for \fBsavecore\fR files is set to
-\fB/var/crash/\fR\fBhostname\fR\fB,\fR and \fBsavecore\fR is set to run
-automatically on reboot.
+\fB/var/crash/\fR\fIhostname\fR\fB,\fR \fBsavecore\fR is set to run
+automatically on reboot, and compression is turned on.
 .sp
 .LP
 When one or more options are specified, \fBdumpadm\fR verifies that your
@@ -132,7 +141,7 @@ process, only kernel pages will be dumped.
 .sp .6
 .RS 4n
 Modify the dump configuration to use the specified dump device. The dump device
-may one of the following:
+may be one of the following:
 .sp
 .ne 2
 .na
@@ -288,6 +297,16 @@ Modify the dump configuration to automatically run \fBsavecore\fR on reboot.
 This is the default for this dump setting.
 .RE
 
+.sp
+.ne 2
+.na
+\fB\fB-z on | off\fR\fR
+.ad
+.sp .6
+.RS 4n
+Turns crash dump compression \fBon\fR or \fBoff\fR.
+.RE
+
 .SH EXAMPLES
 .LP
 \fBExample 1 \fRReconfiguring The Dump Device To A Dedicated Dump Device:
@@ -304,6 +323,7 @@ example# dumpadm -d /dev/dsk/c0t2d0s2
             Dump device: /dev/dsk/c0t2d0s2 (dedicated)
      Savecore directory: /var/crash/saturn
        Savecore enabled: yes
+        Save compressed: on
 .fi
 .in -2
 .sp

usr/src/man/man1m/savecore.1m

@@ -1,7 +1,8 @@
 '\" te
 .\" Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
 .\" Copyright (c) 1983 Regents of the University of California. All rights reserved. The Berkeley software License Agreement specifies the terms and conditions for redistribution.
-.TH SAVECORE 1M "Sep 25, 2004"
+.\" Copyright 2013 Nexenta Systems, Inc.  All Rights Reserved.
+.TH SAVECORE 1M "Jan 30, 2013"
 .SH NAME
 savecore \- save a crash dump of the operating system
 .SH SYNOPSIS
@@ -14,13 +15,16 @@ savecore \- save a crash dump of the operating system
 .sp
 .LP
 The \fBsavecore\fR utility saves a crash dump of the kernel (assuming that one
-was made) and writes a reboot message in the shutdown log. It is invoked by the
-\fBdumpadm\fR service each time the system boots.
+was made) and writes a reboot message in the shutdown log. By default, it is
+invoked by the \fBdumpadm\fR service each time the system boots.
 .sp
 .LP
-\fBsavecore\fR saves the crash dump data in the file
+Depending on the \fBdumpadm\fR(1M) configuration \fBsavecore\fR saves either
+the compressed or uncompressed crash dump. The compressed crash dump is saved in
+the file \fIdirectory\fR\fB/vmdump.\fR\fIn\fR.
+\fBsavecore\fR saves the uncompressed crash dump data in the file
 \fIdirectory\fR\fB/vmcore.\fR\fIn\fR and the kernel's namelist in
-\fIdirectory\fR\fB/unix.\fR\fIn.\fR The trailing \fB\&.\fR\fIn\fR in the
+\fIdirectory\fR\fB/unix.\fR\fIn.\fR The trailing \fIn\fR in the
 pathnames is replaced by a number which grows every time \fBsavecore\fR is run
 in that directory.
 .sp
@@ -108,6 +112,15 @@ specified, \fBsavecore\fR saves the crash dump files to the default
 .RE
 
 .SH FILES
+.sp
+.ne 2
+.na
+\fB\fIdirectory\fR\fB/vmdump.\fR\fIn\fR\fR
+.ad
+.RS 29n
+
+.RE
+
 .sp
 .ne 2
 .na
@@ -147,7 +160,7 @@ specified, \fBsavecore\fR saves the crash dump files to the default
 .sp
 .ne 2
 .na
-\fB\fB/var/crash/\&'uname \fR\fB-n\fR\fB\&'\fR\fR
+\fB\fB/var/crash/\&`uname \fR\fB-n\fR\fB\&`\fR\fR
 .ad
 .RS 29n
 default crash dump directory