Add man pages for snf-image-creator & snf-mkimage
[snf-image-creator] / docs / man / snf-image-creator.rst
1 :orphan:
2
3 snf-image-creator manual page
4 =============================
5
6 Synopsis
7 --------
8
9 **snf-image-creator** [OPTION] <INPUT MEDIA>
10
11 Description
12 -----------
13 Create image out of an <INPUT MEDIA>. The <INPUT MEDIA> may be a block device,
14 a regular file that represents a hard disk or \`/' to bundle the host system
15 itself.
16
17 Options
18 -------
19
20 -a ACCOUNT, --account=ACCOUNT
21         use this ACCOUNT when uploading/registering images to a Synnefo
22         deployment
23
24 --disable-sysprep=SYSPREP
25         prevent SYSPREP operation from running on the input media
26
27 --enable-sysprep=SYSPREP
28         run SYSPREP operation on the input media
29
30 -f, --force
31         overwrite output files if they exist
32
33 -h, --help
34         show this help message and exit
35
36 -m KEY=VALUE, --metadata=KEY=VALUE
37         add custom KEY=VALUE metadata to the image
38
39 --no-shrink
40         don't shrink any partition
41
42 --no-sysprep
43         don't perform any system preparation operation
44
45 -o FILE, --outfile=FILE
46         dump image to FILE
47
48 --print-sysprep
49         print the enabled and disabled system preparation operations for this
50         input media
51
52 -r IMAGENAME, --register=IMAGENAME
53         register the image with cyclades as IMAGENAME
54
55 -s, --silent
56         output only errors
57
58 -t TOKEN, --token=TOKEN
59         use this token when uploading/registering images to a Synnefo
60         deployment
61
62 --tmpdir=DIR
63         create large temporary image files under DIR
64
65 -u FILENAME, --upload=FILENAME
66         upload the image to pithos with name FILENAME
67
68 --version
69         show program's version number and exit
70