Revision ebe0f1e0 docs/usage.rst

b/docs/usage.rst
3 3

  
4 4
snf-image-creator comes in 2 variants:
5 5

  
6
 * snf-image-creator: A non-interactive command line program
7
 * snf-mkimage: A user-friendly dialog-based program
6
 * snf-mkimage: A non-interactive command line program
7
 * snf-image-creator: A user-friendly dialog-based program
8 8

  
9 9
Both expect the input media as first argument. The input media may be a local
10 10
file, a block device or *"/"* if you want to create an image out of the running
......
13 13
Non-interactive version
14 14
=======================
15 15

  
16
snf-image-creator receives the following options:
16
snf-mkimage receives the following options:
17 17

  
18 18
.. code-block:: console
19 19

  
20
  $ snf-image-creator --help
21
  Usage: snf-image-creator [options] <input_media>
20
  $ snf-mkimage --help
21
  Usage: snf-mkimage [options] <input_media>
22 22

  
23 23
  Options:
24 24
    --version             show program's version number and exit
......
70 70
VM's out of it. If you want the image to be visible by other user too, use the
71 71
*--public* option.
72 72

  
73
By default, before extracting the image, snf-image-creator will perform a
73
By default, before extracting the image, snf-mkimage will perform a
74 74
number of system preparation operations on the snapshot of the media and will
75 75
shrink the last partition found. Both actions can be disabled by specifying
76 76
*--no-sysprep* and *--no-shrink* respectively.
......
81 81
*-{enable,disable}-sysprep* options. The user may specify those options
82 82
multiple times.
83 83

  
84
Running *snf-image-creator* with *--print-sysprep* on a raw file that hosts a
84
Running *snf-mkimage* with *--print-sysprep* on a raw file that hosts a
85 85
debian system, we print the following output:
86 86

  
87 87
.. _sysprep:
88 88

  
89 89
.. code-block:: console
90 90

  
91
   $ snf-image-creator --print-sysprep ubuntu.raw
92
   snf-image-creator 0.3
91
   $ snf-mkimage --print-syspreps ubuntu.raw
92
   snf-image-creator 0.6
93 93
   =====================
94 94
   Examining source media `ubuntu_hd.raw' ... looks like an image file
95 95
   Snapshotting media source ... done
......
150 150

  
151 151
.. code-block:: console
152 152

  
153
   $ snf-image-creator --enable-sysprep cleanup-mail --enable-sysprep remove-user-accounts ...
153
   $ snf-mkimage --enable-sysprep cleanup-mail --enable-sysprep remove-user-accounts ...
154 154

  
155 155
Dialog-based version
156 156
====================
157 157

  
158
*snf-mkimage* receives the following options:
158
*snf-image-creator* receives the following options:
159 159

  
160 160
.. code-block:: console
161 161

  
162
 $ snf-mkimage --help
163
 Usage: snf-mkimage [options] [<input_media>]
162
 $ snf-image-creator --help
163
 Usage: snf-image-creator [options] [<input_media>]
164 164

  
165 165
 Options:
166 166
   --version             show program's version number and exit
......
179 179
`Host bundling operation`_).
180 180

  
181 181
After the input media is examined and the program is initialized, the user will
182
be given the choice to run *snf-mkimage* in *wizard* or *expert* mode.
182
be given the choice to run *snf-image-creator* in *wizard* or *expert* mode.
183 183

  
184 184
Wizard mode
185 185
-----------
186 186

  
187
When *snf-mkimage* runs in *wizard* mode, the user is just asked to provide the
187
When *snf-image-creator* runs in *wizard* mode, the user is just asked to provide the
188 188
following basic information:
189 189

  
190 190
 * Cloud: The cloud account to use to upload and register the resulting image
......
278 278

  
279 279
   $ sudo kvm -m 1G -boot c -drive file=ubuntu.raw,format=raw,cache=none,if=virtio
280 280

  
281
After you're done, you may use *snf-mkimage* as root to create and upload the
281
After you're done, you may use *snf-image-creator* as root to create and upload the
282 282
image:
283 283

  
284 284
.. code-block:: console
285 285

  
286 286
   $ sudo -s
287
   $ snf-mkimage ubuntu.raw
287
   $ snf-image-creator ubuntu.raw
288 288

  
289 289
In the first screen you will be asked to choose if you want to run the program
290 290
in *Wizard* or *Expert* mode. Choose *Wizard*.

Also available in: Unified diff