Difference between revisions of "CLI"

From CRIU
Jump to: navigation, search
(Command line syntax)
Line 1: Line 1:
== Command line syntax ==
+
== Synopsis ==
 +
<pre>
 +
'crtools' [-c] [-s] [-f <file>] [-d] [-n] [-o <path>] [-D <path>] [-v [num]] [--help] <command> (-p|-t) <pid>
 +
</pre>
  
Syntax is pretty trivial one but partially context dependent.
+
== Description ==
 +
'crtools' is command line utility to steer checkpoint and restore procedure.
  
<code>
+
== Options ==
  crtools [-c] [-D dir] (show|dump|restore) [-p|-t] $pid
+
<pre>
</code>
+
<command>::
 +
    One of the follwong commands
 +
        * 'dump'
 +
                to initiate checkpoint procedure
 +
        * 'restore'
 +
                to restore previously checkpointed processes
 +
        * 'show'
 +
                to decode binary dump files and show their contents in human
 +
                readable format
 +
        * 'check'
 +
                to test whether the kernel support is up-to-date
  
* '''c''' - to continue execution of a task once checkpoint is complete in case of '''checkpointing''' stage, and show contents of memory pages in case of '''show''' stage
+
-c::
* '''D dir''' - write/read dump images to/from the specified directory
+
    In case of 'show' command the dumped pages content will be shown in hex format.
 +
    In case of 'dump' command processes being checkpointed wont be killed once
 +
    checkpoint complete but rather continue execution.
 +
 
 +
-D <path>::
 +
    Use path 'path' as a base directory where to look for dump files set. This
 +
    commands allpies to any <command>.
 +
 
 +
-s::
 +
    Leave tasks in stopped state after checkpoint instead of killing them.
 +
 
 +
-f <file>::
 +
    This option is valid for 'show' command only and allows to see content of
 +
    the <file> specified.
 +
 
 +
-p <pid>::
 +
    Checkpoint only one process specified by 'pid' instead of the whole process
 +
    tree.
 +
 
 +
-t <pid>::
 +
    Checkpoint the whole process tree starting from 'pid'.
 +
 
 +
-d::
 +
    Detach 'crtools' itself once restore is complete.
 +
 
 +
-n <ns>::
 +
    Checkpoint namespaces. Namespaces must be separated by comma.
 +
    Currently supported namespaces: uts, ipc.
 +
 
 +
-o <file>::
 +
    Write logging messages to 'file'.
 +
 
 +
-v <num>::
 +
    Set logging level to 'num'. Valid options are: 0 - (silent, error messages
 +
    only), 1 - informative (default), 2 - debug messages.
 +
</pre>

Revision as of 05:36, 20 July 2012

Synopsis

'crtools' [-c] [-s] [-f <file>] [-d] [-n] [-o <path>] [-D <path>] [-v [num]] [--help] <command> (-p|-t) <pid>

Description

'crtools' is command line utility to steer checkpoint and restore procedure.

Options

<command>::
    One of the follwong commands
        * 'dump'
                to initiate checkpoint procedure
        * 'restore'
                to restore previously checkpointed processes
        * 'show'
                to decode binary dump files and show their contents in human
                readable format
        * 'check'
                to test whether the kernel support is up-to-date

-c::
    In case of 'show' command the dumped pages content will be shown in hex format.
    In case of 'dump' command processes being checkpointed wont be killed once
    checkpoint complete but rather continue execution.

-D <path>::
    Use path 'path' as a base directory where to look for dump files set. This
    commands allpies to any <command>.

-s::
    Leave tasks in stopped state after checkpoint instead of killing them.

-f <file>::
    This option is valid for 'show' command only and allows to see content of
    the <file> specified.

-p <pid>::
    Checkpoint only one process specified by 'pid' instead of the whole process
    tree.

-t <pid>::
    Checkpoint the whole process tree starting from 'pid'.

-d::
    Detach 'crtools' itself once restore is complete.

-n <ns>::
    Checkpoint namespaces. Namespaces must be separated by comma.
    Currently supported namespaces: uts, ipc.

-o <file>::
    Write logging messages to 'file'.

-v <num>::
    Set logging level to 'num'. Valid options are: 0 - (silent, error messages
    only), 1 - informative (default), 2 - debug messages.