2
0
mirror of https://github.com/checkpoint-restore/criu synced 2025-08-22 09:58:09 +00:00

docs: Initial commit

Signed-off-by: Cyrill Gorcunov <gorcunov@openvz.org>
This commit is contained in:
Cyrill Gorcunov 2012-01-28 18:45:28 +04:00
parent 4804db00aa
commit 17a4a6cd09
6 changed files with 90 additions and 0 deletions

1
Documentation/.gitattributes vendored Normal file
View File

@ -0,0 +1 @@
*.txt whitespace

3
Documentation/.gitignore vendored Normal file
View File

@ -0,0 +1,3 @@
*.xml
*.html
*.[1-8]

26
Documentation/Makefile Normal file
View File

@ -0,0 +1,26 @@
ifeq ($(strip $(V)),)
E = @echo
Q = @
else
E = @\#
Q =
endif
export E Q
ASCIIDOC := asciidoc
A2X := a2x
XMLTO := xmlto
MAN := crtools.txt
all: man
man: $(MAN)
$(E) " GEN " $@
$(Q) $(ASCIIDOC) -b docbook -d manpage -o crtools.xml crtools.txt
$(Q) $(XMLTO) man --skip-validation crtools.xml 2>/dev/null
clean:
$(E) " CLEAN "
$(Q) rm -f ./*.xml
$(Q) rm -f ./*.1

View File

@ -0,0 +1 @@

54
Documentation/crtools.txt Normal file
View File

@ -0,0 +1,54 @@
crtools(1)
==========
:doctype: manpage
:man source: CRtools
:man version: 0.0.1
:man manual: CRtools Manual
NAME
----
crtools - checkpoint/restore in userspace
SYNOPSIS
--------
'crtools' [-c] [-f <file>] [-D <path>] [--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 or 'show' -- to
decode binary dump files and show their contents in human readable format.
-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>.
-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'.
AUTHOR
------
OpenVZ team.
COPYING
-------
Copyright \(C) 2011-2012, Parallels Inc.

View File

@ -171,11 +171,16 @@ cscope:
$(Q) $(CSCOPE) -bkqu
.PHONY: cscope
docs:
$(Q) $(MAKE) -s -C Documentation all
.PHONY: docs
help:
$(E) ' Targets:'
$(E) ' all - Build all [*] targets'
$(E) ' * crtools - Build crtools'
$(E) ' zdtm - Build zdtm test-suite'
$(E) ' docs - Build documentation'
$(E) ' clean - Clean everything'
$(E) ' tags - Generate tags file (ctags)'
$(E) ' cscope - Generate cscope database'