[CRIU] [crtools-bot] docs: Initial commit

[Cyrill Gorcunov]

The commit is pushed to "master" and will appear on git://github.com/cyrillos/crtools.git
------>
commit 17a4a6cd09afff9da27c2ff6e59aa9f2008082bd
Author: Cyrill Gorcunov <gorcunov at openvz.org>
Date:   Sat Jan 28 18:45:28 2012 +0400

    docs: Initial commit
    
    Signed-off-by: Cyrill Gorcunov <gorcunov at openvz.org>
---
 Documentation/.gitattributes |    1 +
 Documentation/.gitignore     |    3 ++
 Documentation/Makefile       |   26 ++++++++++++++++++++
 Documentation/asciidoc.conf  |    1 +
 Documentation/crtools.txt    |   54 ++++++++++++++++++++++++++++++++++++++++++
 Makefile                     |    5 ++++
 6 files changed, 90 insertions(+), 0 deletions(-)

diff --git a/Documentation/.gitattributes b/Documentation/.gitattributes
new file mode 100644
index 0000000..ddb0301
--- /dev/null
+++ b/Documentation/.gitattributes
@@ -0,0 +1 @@
+*.txt whitespace
diff --git a/Documentation/.gitignore b/Documentation/.gitignore
new file mode 100644
index 0000000..2d97881
--- /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 0000000..d8002e3
--- /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 0000000..8b13789
--- /dev/null
+++ b/Documentation/asciidoc.conf
@@ -0,0 +1 @@
+
diff --git a/Documentation/crtools.txt b/Documentation/crtools.txt
new file mode 100644
index 0000000..649f349
--- /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 <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.
diff --git a/Makefile b/Makefile
index 736ce10..4f1e500 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'