diff --git a/docs/conf.py b/docs/conf.py index c39fb2e8a64d0e5005b9baf2cd57ae778439b87b..e2c2dfeb1afbd0f16a6e9794d77113866e9c05bd 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -41,7 +41,7 @@ master_doc = 'index' # General information about the project. project = u'snf-image-creator' -copyright = u'2012, GRNET' +copyright = u'2012, 2013 GRNET S.A. All rights reserved' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -213,8 +213,12 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ('index', 'snf-image-creator', u'snf-image-creator Documentation', - [u'GRNET'], 1) + ('man/snf-image-creator', 'snf-image-creator', + 'Command line image creator for Synnefo', + 'GRNET Development Team <synnefo-devel@googlegroups.com>', 1), + ('man/snf-mkimage', 'snf-mkimage', + 'Dialog-based image creator for Synnefo', + 'GRNET Development Team <synnefo-devel@googlegroups.com>', 1) ] # If true, show URL addresses after external links. diff --git a/docs/man/snf-image-creator.rst b/docs/man/snf-image-creator.rst new file mode 100644 index 0000000000000000000000000000000000000000..ee87989c2bf6967a05fa2b4e2b9e853d591ab8d1 --- /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 + diff --git a/docs/man/snf-mkimage.rst b/docs/man/snf-mkimage.rst new file mode 100644 index 0000000000000000000000000000000000000000..87bbf107d9221de15fdedd1e05004ef316cdae9a --- /dev/null +++ b/docs/man/snf-mkimage.rst @@ -0,0 +1,27 @@ +:orphan: + +snf-mkimage manual page +======================= + +Synopsis +-------- + +**snf-mkimage** [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. If the <INPUT MEDIA> argument is missing, the user will be asked during +the program initializaton to specify one. + +Options +------- +--version + show program's version number and exit +-h, --help + show this help message and exit +-l FILE, --logfile=FILE + log all messages to FILE +--tmpdir=DIR + create large temporary image files under DIR