Difference between revisions of "CLI"

From CRIU
Jump to navigation Jump to search
(added 'in development' disclaimer)
(add deprecated stuff)
 
(39 intermediate revisions by 4 users not shown)
Line 1: Line 1:
Since the tools and overall concept are still under heavy development, there are some known limitations applied, in particular only pure x86-64 environment is supported, no IA32 emulation allowed.
+
This is a collection of articles describing specific CRIU command line options.
  
== Synopsis ==
+
== Actions ==
<pre>
+
{{Special:PrefixIndex/CLI/cmd/|stripprefix=1}}
'crtools' [-c] [-s] [-f <file>] [-d] [-n] [-o <path>] [-D <path>] [-v [num]] [--help] <command> (-p|-t) <pid>
 
</pre>
 
 
 
== Description ==
 
'crtools' is command line utility to steer checkpoint and restore procedure.
 
  
 
== Options ==
 
== Options ==
<pre>
+
{{Special:PrefixIndex/CLI/opt/|stripprefix=1}}
<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>::
+
== Deprecated stuff ==
    Checkpoint only one process specified by 'pid' instead of the whole process
 
    tree.
 
  
-t <pid>::
+
=== Actions ===
    Checkpoint the whole process tree starting from 'pid'.
+
{{Special:PrefixIndex/CLI/deprecated/cmd/|stripprefix=1}}
  
-d::
+
=== Options ===
    Detach 'crtools' itself once restore is complete.
+
{{Special:PrefixIndex/CLI/deprecated/opt/|stripprefix=1}}
  
-n <ns>::
+
== See also ==
    Checkpoint namespaces. Namespaces must be separated by comma.
 
    Currently supported namespaces: uts, ipc.
 
  
-o <file>::
+
* [[Advanced usage]] article for more options
    Write logging messages to 'file'.
+
* [[RPC]] -- an API to C/R functionality
 +
* [[API compliance]]
 +
* [[:Category:HOWTO]]
  
-v <num>::
+
[[Category: API]]
    Set logging level to 'num'. Valid options are: 0 - (silent, error messages
 
    only), 1 - informative (default), 2 - debug messages.
 
</pre>
 

Latest revision as of 19:32, 20 September 2016