Add man pages for snf-image-creator & snf-mkimage

[snf-image-creator] / docs / man / snf-image-creator.rst

diff --git a/docs/man/snf-image-creator.rst b/docs/man/snf-image-creator.rst
new file mode 100644 (file)
index 0000000..ee87989
--- /dev/null
+++ b/docs/man/snf-image-creator.rst
@@ -0,0 +1,70 @@
+:orphan:
+
+snf-image-creator manual page
+=============================
+
+Synopsis
+--------
+
+**snf-image-creator** [OPTION] <INPUT MEDIA>
+
+Description
+-----------
+Create image out of an <INPUT MEDIA>. The <INPUT MEDIA> may be a block device,
+a regular file that represents a hard disk or \`/' to bundle the host system
+itself.
+
+Options
+-------
+
+-a ACCOUNT, --account=ACCOUNT
+       use this ACCOUNT when uploading/registering images to a Synnefo
+       deployment
+
+--disable-sysprep=SYSPREP
+       prevent SYSPREP operation from running on the input media
+
+--enable-sysprep=SYSPREP
+       run SYSPREP operation on the input media
+
+-f, --force
+       overwrite output files if they exist
+
+-h, --help
+       show this help message and exit
+
+-m KEY=VALUE, --metadata=KEY=VALUE
+       add custom KEY=VALUE metadata to the image
+
+--no-shrink
+       don't shrink any partition
+
+--no-sysprep
+       don't perform any system preparation operation
+
+-o FILE, --outfile=FILE
+       dump image to FILE
+
+--print-sysprep
+       print the enabled and disabled system preparation operations for this
+       input media
+
+-r IMAGENAME, --register=IMAGENAME
+       register the image with cyclades as IMAGENAME
+
+-s, --silent
+       output only errors
+
+-t TOKEN, --token=TOKEN
+       use this token when uploading/registering images to a Synnefo
+       deployment
+
+--tmpdir=DIR
+       create large temporary image files under DIR
+
+-u FILENAME, --upload=FILENAME
+       upload the image to pithos with name FILENAME
+
+--version
+       show program's version number and exit
+