Print this page
12144 Convert Intro(7) to mandoc
12145 Convert cpr(7) to mandoc
12146 Convert ibmf(7) to mandoc
12147 Convert FSS(7) to mandoc
Reviewed by: Peter Tribble <peter.tribble@gmail.com>
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/man/man7/cpr.7
+++ new/usr/src/man/man7/cpr.7
1 -'\" te
2 1 .\" Copyright (c) 2001, Sun Microsystems, Inc.
3 2 .\" All Rights Reserved
4 -.\" 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.
5 -.\" 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.
6 -.\" 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]
7 -.TH CPR 7 "May 13, 2017"
8 -.SH NAME
9 -cpr \- Suspend and resume module
10 -.SH SYNOPSIS
11 -.LP
12 -.nf
13 -\fB/platform/'uname -m'/kernel/misc/cpr\fR
14 -.fi
15 -
16 -.SH DESCRIPTION
17 -.LP
18 -The \fBcpr\fR module is a loadable module used to suspend and resume the entire
19 -system. You may wish to suspend a system to save power or to power off
20 -temporarily for transport. The \fBcpr\fR module should not be used in place of
3 +.\"
4 +.\" Copyright 2020 Joyent, Inc.
5 +.\"
6 +.\" The contents of this file are subject to the terms of the
7 +.\" Common Development and Distribution License (the "License").
8 +.\" You may not use this file except in compliance with the License.
9 +.\"
10 +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
11 +.\" or http://www.opensolaris.org/os/licensing.
12 +.\" See the License for the specific language governing permissions
13 +.\" and limitations under the License.
14 +.\"
15 +.\" When distributing Covered Code, include this CDDL HEADER in each
16 +.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
17 +.\" If applicable, add the following below this CDDL HEADER, with the
18 +.\" fields enclosed by brackets "[]" replaced with your own identifying
19 +.\" information: Portions Copyright [yyyy] [name of copyright owner]
20 +.\"
21 +.Dd January 12, 2020
22 +.Dt CPR 7
23 +.Os
24 +.Sh NAME
25 +.Nm cpr
26 +.Nd Suspend and resume module
27 +.Sh SYNOPSIS
28 +.Pa /platform/i86pc/kernel/misc/amd64/cpr
29 +.Pa /platform/sun4u/kernel/misc/sparcv9/cpr
30 +.Sh DESCRIPTION
31 +The
32 +.Nm
33 +module is a loadable module used to suspend and resume the entire system.
34 +You may wish to suspend a system to save power or to power off
35 +temporarily for transport.
36 +The
37 +.Nm
38 +module should not be used in place of
21 39 a normal shutdown when performing any hardware reconfiguration or replacement.
22 40 In order for the resume operation to succeed, it is important that the hardware
23 -configuration remain the same. When the system is suspended, the entire system
41 +configuration remain the same.
42 +When the system is suspended, the entire system
24 43 state is preserved in non-volatile storage until a resume operation is
25 44 conducted.
26 -.sp
27 -.LP
28 -\fBpmconfig\fR(1M) and \fBpower.conf\fR(4) are used to configure the
29 -suspend-resume feature.
30 -.sp
31 -.LP
45 +.Pp
46 +.Xr pmconfig 1M
47 +and
48 +.Xr power.conf 4
49 +are used to configure the suspend-resume feature.
50 +.Pp
32 51 The speed of suspend and resume operations can range from 15 seconds to
33 52 several minutes, depending on the system speed, memory size, and load.
34 -.sp
35 -.LP
36 -During resume operation, the \fBSIGTHAW\fR signal is sent to all processes to
53 +.Pp
54 +During resume operation, the
55 +.Dv SIGTHAW
56 +signal is sent to all processes to
37 57 allow them to do any special processing in response to suspend-resume
38 -operation. Normally applications are not required to do any special processing
58 +operation.
59 +Normally applications are not required to do any special processing
39 60 because of suspend-resume, but some specialized processes can use
40 -\fBSIGTHAW\fR to restore the state prior to suspend. For example, \fBX\fR can
41 -refresh the screen in response to \fBSIGTHAW\fR.
42 -.sp
43 -.LP
44 -In some cases the \fBcpr\fR module may be unable to perform the suspend
45 -operation. If a system contains additional devices outside the standard shipped
61 +.Dv SIGTHAW
62 +to restore the state prior to suspend.
63 +For example,
64 +.Sy X
65 +can refresh the screen in response to
66 +.Dv SIGTHAW .
67 +.Pp
68 +In some cases the
69 +.Nm
70 +module may be unable to perform the suspend operation.
71 +If a system contains additional devices outside the standard shipped
46 72 configuration, it is possible that device drivers for these additional devices
47 -might not support suspend-resume operations. In this case, the suspend fails
48 -and an error message is displayed. These devices must be removed or their
49 -device drivers unloaded for the suspend operation to succeed. Contact the
73 +might not support suspend-resume operations.
74 +In this case, the suspend fails and an error message is displayed.
75 +These devices must be removed or their
76 +device drivers unloaded for the suspend operation to succeed.
77 +Contact the
50 78 device manufacturer to obtain a new version of device driver that supports
51 79 suspend-resume.
52 -.sp
53 -.LP
80 +.Pp
54 81 A suspend may also fail when devices or processes are performing critical or
55 -time-sensitive operations (such as realtime operations). The system will remain
56 -in its current running state. Messages reporting the failure will be displayed
57 -on the console and status returned to the caller. Once the system is
82 +time-sensitive operations (such as realtime operations).
83 +The system will remain in its current running state.
84 +Messages reporting the failure will be displayed
85 +on the console and status returned to the caller.
86 +Once the system is
58 87 successfully suspended the resume operation will succeed, barring external
59 88 influences such as a hardware reconfiguration.
60 -.sp
61 -.LP
89 +.Pp
62 90 Some network-based applications may fail across a suspend and resume cycle.
63 91 This largely depends on the underlying network protocol and the applications
64 -involved. In general, applications that retry and automatically reestablish
92 +involved.
93 +In general, applications that retry and automatically reestablish
65 94 connections will continue to operate transparently on a resume operation;
66 95 those applications that do not will likely fail.
67 -.SH ATTRIBUTES
68 -.LP
69 -See \fBattributes\fR(5) for descriptions of the following attributes:
70 -.sp
71 -
72 -.sp
73 -.TS
74 -box;
75 -c | c
76 -l | l .
77 -ATTRIBUTE TYPE ATTRIBUTE VALUE
78 -_
79 -Interface stability Unstable
80 -.TE
81 -
82 -.SH SEE ALSO
83 -.LP
84 -\fBpmconfig\fR(1M),
85 -\fBuadmin\fR(1M), \fBuadmin\fR(2), \fBpower.conf\fR(4), \fBattributes\fR(5)
86 -.sp
87 -.LP
88 -\fIWriting Device Drivers\fR
89 -.SH NOTES
90 -.LP
96 +.Sh INTERFACE STABILITY
97 +Unstable
98 +.Sh SEE ALSO
99 +.Xr pmconfig 1M ,
100 +.Xr uadmin 1M ,
101 +.Xr uadmin 2 ,
102 +.Xr power.conf 4 ,
103 +.Xr attributes 5
104 +.Pp
105 +.%T Writing Device Drivers
106 +.Sh NOTES
91 107 Certain device operations such as tape and floppy disk activities are not
92 -resumable due to the nature of removable media. These activities are detected
108 +resumable due to the nature of removable media.
109 +These activities are detected
93 110 at suspend time, and must be stopped before the suspend operation will
94 111 complete successfully.
95 -.sp
96 -.LP
112 +.Pp
97 113 Suspend-resume is currently supported only on a limited set of hardware
98 114 platforms.
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX