~ubuntu-branches/ubuntu/quantal/lxc/quantal-201206191543

« back to all changes in this revision

Viewing changes to doc/lxc-checkpoint.1

  • Committer: Stéphane Graber
  • Date: 2011-08-11 18:43:51 UTC
  • mto: (3.1.15 sid)
  • mto: This revision was merged to the branch mainline in revision 30.
  • Revision ID: stgraber@ubuntu.com-20110811184351-xa4c5v0ct5ud45d0
Tags: upstream-0.7.5
Import upstream version 0.7.5

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.\" This manpage has been automatically generated by docbook2man 
2
 
.\" from a DocBook document.  This tool can be found at:
3
 
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
4
 
.\" Please send any bug reports, improvements, comments, patches, 
5
 
.\" etc. to Steve Cheng <steve@ggi-project.org>.
6
 
.TH "LXC-CHECKPOINT" "1" "20 May 2011" "IBM" ""
7
 
 
8
 
.SH NAME
9
 
lxc-checkpoint \- checkpoint a running container (not implemented yet)
10
 
.SH SYNOPSIS
11
 
 
12
 
\fBlxc-checkpoint
13
 
--statefile=\fIFILE\fB
14
 
--statefd=\fIFD\fB
15
 
--name=\fINAME\fB \fR [ \fB-k|-p\fR ]
16
 
 
17
 
.SH "DESCRIPTION"
18
 
.PP
19
 
\fBlxc-checkpoint\fR is a command
20
 
to checkpoint the specified container
21
 
\fINAME\fR and dumps its state into the file
22
 
\fIFILE\fR\&. If the
23
 
option \fB--kill\fR is specified, the application
24
 
running in the container will terminate after the checkpoint
25
 
just before resuming its execution. If the
26
 
option \fB--pause\fR is specified, the application
27
 
will be stopped after the checkpoint just before resuming
28
 
execution. The command \fBlxc-unfreeze\fR will
29
 
resume its execution.
30
 
.SH "CHECKPOINT OPTIONS"
31
 
.TP
32
 
\fB-S, --statefile=\fIFILE\fB\fR
33
 
write the state of the container in this
34
 
\fIFILE\fR\&.
35
 
This option is exclusive with \fB--statefd\fR below.
36
 
.TP
37
 
\fB-d, --statefd=\fIFD\fB\fR
38
 
write the state of the container in this
39
 
\fIFD\fR file descriptor.
40
 
This option is exclusive with above \fB--statefile\fR\&.
41
 
.TP
42
 
\fB-k,--kill\fR
43
 
Kill container processes after checkpoint. the processes are sent
44
 
a SIGKILL signal.
45
 
 
46
 
This option is mutually exclusive with the following
47
 
\fB--pause\fR option.
48
 
.TP
49
 
\fB-p,--pause\fR
50
 
Pause container processes after checkpoint. The container
51
 
will be stopped until you resume it. This option is
52
 
mutually exclusive with previously mentionned
53
 
\fB--kill\fR option.
54
 
.SH "COMMON OPTIONS"
55
 
.PP
56
 
These options are common to most of lxc commands.
57
 
.TP
58
 
\fB-?, -h, --help\fR
59
 
Print a longer usage message than normal.
60
 
.TP
61
 
\fB--usage\fR
62
 
Give the usage message
63
 
.TP
64
 
\fB-q, --quiet\fR
65
 
mute on
66
 
.TP
67
 
\fB-o, --logfile=\fIFILE\fB\fR
68
 
Output to an alternate log
69
 
\fIFILE\fR\&. The default is no log.
70
 
.TP
71
 
\fB-l, --logpriority=\fILEVEL\fB\fR
72
 
Set log priority to
73
 
\fILEVEL\fR\&. The default log
74
 
priority is ERROR\&. Possible values are :
75
 
FATAL, CRIT,
76
 
WARN, ERROR,
77
 
NOTICE, INFO,
78
 
DEBUG\&.
79
 
 
80
 
Note that this option is setting the priority of the events
81
 
log in the alternate log file. It do not have effect on the
82
 
ERROR events log on stderr.
83
 
.TP
84
 
\fB-n, --name=\fINAME\fB\fR
85
 
Use container identifier \fINAME\fR\&.
86
 
The container identifier format is an alphanumeric string.
87
 
.SH "EXAMPLES"
88
 
.PP
89
 
To start a new container 123 computing decimals of pi
90
 
 
91
 
.nf
92
 
      lxc-execute -n 123 -- pi1 -d 500000
93
 
      lxc-execute --name=123 -- pi1 -d 500000
94
 
    
95
 
.fi
96
 
.PP
97
 
to checkpoint the same container in \fBdump-death\fR
98
 
mode
99
 
 
100
 
.nf
101
 
      lxc-checkpoint -n 123 -S /share/123/chkpt1 -k
102
 
      lxc-checkpoint --name=123 -S /share/123/chkpt1 -k
103
 
    
104
 
.fi
105
 
.PP
106
 
to checkpoint the same container and \fBpause\fR it
107
 
 
108
 
.nf
109
 
      lxc-checkpoint -n 123 -S /share/123/chkpt1 -p
110
 
      lxc-checkpoint --name=123 -S /share/123/chkpt1 -p
111
 
    
112
 
.fi
113
 
.SH "NOTES"
114
 
.PP
115
 
Actually, this command does not operate. Its description
116
 
helps to define a CLI api for future Checkpoint / Restart
117
 
solution
118
 
.SH "SEE ALSO"
119
 
.PP
120
 
\fBlxc\fR(1),
121
 
\fBlxc-create\fR(1),
122
 
\fBlxc-destroy\fR(1),
123
 
\fBlxc-start\fR(1),
124
 
\fBlxc-stop\fR(1),
125
 
\fBlxc-execute\fR(1),
126
 
\fBlxc-kill\fR(1),
127
 
\fBlxc-console\fR(1),
128
 
\fBlxc-monitor\fR(1),
129
 
\fBlxc-wait\fR(1),
130
 
\fBlxc-cgroup\fR(1),
131
 
\fBlxc-ls\fR(1),
132
 
\fBlxc-ps\fR(1),
133
 
\fBlxc-info\fR(1),
134
 
\fBlxc-freeze\fR(1),
135
 
\fBlxc-unfreeze\fR(1),
136
 
\fBlxc.conf\fR(5)
137
 
.SH "AUTHOR"
138
 
.PP
139
 
Daniel Lezcano <daniel.lezcano@free.fr>