Update version.py and ChangeLog for 0.6.1
[snf-image-creator] / docs / man / snf-mkimage.rst
1 :orphan:
2
3 snf-mkimage manual page
4 =======================
5
6 Synopsis
7 --------
8
9 **snf-mkimage** [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 -a URL, --authentication-url=URL
20         use this authentication URL when uploading/registering images
21
22 --allow-unsupported
23         Proceed with the image creation even if the media is not supported
24
25 -c CLOUD, --cloud=CLOUD
26         use this saved cloud account to authenticate against a cloud when
27         uploading/registering images
28
29 --disable-sysprep=SYSPREP
30         prevent SYSPREP operation from running on the input media
31
32 --enable-sysprep=SYSPREP
33         run SYSPREP operation on the input media
34
35 -f, --force
36         overwrite output files if they exist
37
38 -h, --help
39         show this help message and exit
40
41 -m KEY=VALUE, --metadata=KEY=VALUE
42         add custom KEY=VALUE metadata to the image
43
44 --no-shrink
45         don't shrink any partition
46
47 --no-sysprep
48         don't perform any system preparation operation
49
50 -o FILE, --outfile=FILE
51         dump image to FILE
52
53 --public
54         register image with the storage service as public
55
56 --print-syspreps
57         print the enabled and disabled system preparation operations for this
58         input media
59
60 --print-sysprep-params
61         print the needed sysprep parameters for this input media
62
63 -r IMAGENAME, --register=IMAGENAME
64         register the image with the compute service with name IMAGENAME
65
66 -s, --silent
67         output only errors
68
69 --sysprep-param=SYSPREP_PARAMS
70         add KEY=VALUE system preparation parameter
71
72 -t TOKEN, --token=TOKEN
73         use this token when uploading/registering images
74
75 --tmpdir=DIR
76         create large temporary image files under DIR
77
78 -u FILENAME, --upload=FILENAME
79         save the image to the storage service with remote name FILENAME
80
81 --version
82         show program's version number and exit
83