xref: /dragonfly/usr.bin/checkpt/checkpt.1 (revision 9bb2a92d)
1.\"
2.\" Copyright (c) 2003 Matthew Dillon, 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.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $DragonFly: src/usr.bin/checkpt/checkpt.1,v 1.1 2003/10/20 04:46:14 dillon Exp $
26.\"
27.Dd October 19, 2003
28.Dt CHECKPT 1
29.Os
30.Sh NAME
31.Nm checkpt
32.Nd resume checkpointed program
33.Sh SYNOPSIS
34.Nm
35.Op Fl r Ar file.ckpt
36.Ar
37.Sh DESCRIPTION
38The
39.Nm
40utility will resume the checkpointed program from the specified checkpoint
41file.  Programs can be checkpointed using ^E.
42.Pp
43The checkpt.ko module must be loaded for checkpointing to work.  By default,
44only members of the wheel group can checkpoint a program.  The group can be
45changed with the sysctl kern.ckptgroup.  The checkpoint file template can be
46changed with the sysctl kern.ckptfile.
47.Pp
48The checkpointing utility is currently very primitive.  Only programs
49operating on normal files can be properly restored.  Programs which operate
50on devices, sockets, or pipes (including piped commands) cannot be restored.
51File descriptors 0, 1, and 2, are not saved and the restored program will
52inherit the descriptors from
53.Nm
54.Sh SEE ALSO
55.Xr stty 1
56.Sh HISTORY
57The
58.Nm
59command first appeared in DragonFly .
60