diff --git a/Documentation/.gitattributes b/Documentation/.gitattributes new file mode 100644 index 000000000..ddb030137 --- /dev/null +++ b/Documentation/.gitattributes @@ -0,0 +1 @@ +*.txt whitespace diff --git a/Documentation/.gitignore b/Documentation/.gitignore new file mode 100644 index 000000000..2d97881c2 --- /dev/null +++ b/Documentation/.gitignore @@ -0,0 +1,3 @@ +*.xml +*.html +*.[1-8] diff --git a/Documentation/Makefile b/Documentation/Makefile new file mode 100644 index 000000000..d8002e347 --- /dev/null +++ b/Documentation/Makefile @@ -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 diff --git a/Documentation/asciidoc.conf b/Documentation/asciidoc.conf new file mode 100644 index 000000000..8b1378917 --- /dev/null +++ b/Documentation/asciidoc.conf @@ -0,0 +1 @@ + diff --git a/Documentation/crtools.txt b/Documentation/crtools.txt new file mode 100644 index 000000000..649f3490b --- /dev/null +++ b/Documentation/crtools.txt @@ -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 ] [-D ] [--help] (-p|-t) + +DESCRIPTION +----------- +'crtools' is command line utility to steer checkpoint and restore procedure. + +OPTIONS +------- +:: + 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 :: + Use path 'path' as a base directory where to look for dump files set. This + commands allpies to any . + +-f :: + This option is valid for 'show' command only and allows to see content of + the specified. + +-p :: + Checkpoint only one process specified by 'pid' instead of the whole process + tree. + +-t :: + Checkpoint the whole process tree starting from 'pid'. + + +AUTHOR +------ +OpenVZ team. + +COPYING +------- +Copyright \(C) 2011-2012, Parallels Inc. diff --git a/Makefile b/Makefile index 736ce10ed..4f1e50062 100644 --- a/Makefile +++ b/Makefile @@ -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'