Revision 9228aff8 docs/usage.rst

b/docs/usage.rst
17 17

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

  
20
   $ snf-image-creator --help
21
   Usage: snf-image-creator [options] <input_media>
22
   
23
   Options:
24
     --version             show program's version number and exit
25
     -h, --help            show this help message and exit
26
     -o FILE, --outfile=FILE
27
                           dump image to FILE
28
     -f, --force           overwrite output files if they exist
29
     -s, --silent          output only errors
30
     -u FILENAME, --upload=FILENAME
31
                           upload the image to the storage service with name FILENAME
32
     -r IMAGENAME, --register=IMAGENAME
33
                           register the image with the compute service as IMAGENAME
34
     -m KEY=VALUE, --metadata=KEY=VALUE
35
                           add custom KEY=VALUE metadata to the image
36
     -t TOKEN, --token=TOKEN
37
                           use this authentication token when
38
                           uploading/registering images
39
     -a URL, --authentication-url=URL
40
                           use this authentication URL when uploading/registering
41
                           images
42
     -c CLOUD, --cloud=CLOUD
43
                           use this saved cloud account to authenticate against a
44
                           cloud when uploading/registering images
45
     --print-sysprep       print the enabled and disabled system preparation
46
                           operations for this input media
47
     --enable-sysprep=SYSPREP
48
                           run SYSPREP operation on the input media
49
     --disable-sysprep=SYSPREP
50
                           prevent SYSPREP operation from running on the input
51
                           media
52
     --no-sysprep          don't perform any system preparation operation
53
     --no-shrink           don't shrink any partition
54
     --public              register image with the compute service as public
55
     --tmpdir=DIR          create large temporary image files under DIR
20
  $ snf-image-creator --help
21
  Usage: snf-image-creator [options] <input_media>
22

  
23
  Options:
24
    --version             show program's version number and exit
25
    -h, --help            show this help message and exit
26
    -o FILE, --outfile=FILE
27
                          dump image to FILE
28
    -f, --force           overwrite output files if they exist
29
    -s, --silent          output only errors
30
    -u FILENAME, --upload=FILENAME
31
                          upload the image to the cloud with name FILENAME
32
    -r IMAGENAME, --register=IMAGENAME
33
                          register the image with a cloud as IMAGENAME
34
    -m KEY=VALUE, --metadata=KEY=VALUE
35
                          add custom KEY=VALUE metadata to the image
36
    -t TOKEN, --token=TOKEN
37
                          use this authentication token when
38
                          uploading/registering images
39
    -a URL, --authentication-url=URL
40
                          use this authentication URL when uploading/registering
41
                          images
42
    -c CLOUD, --cloud=CLOUD
43
                          use this saved cloud account to authenticate against a
44
                          cloud when uploading/registering images
45
    --print-syspreps      print the enabled and disabled system preparation
46
                          operations for this input media
47
    --enable-sysprep=SYSPREP
48
                          run SYSPREP operation on the input media
49
    --disable-sysprep=SYSPREP
50
                          prevent SYSPREP operation from running on the input
51
                          media
52
    --print-sysprep-params
53
                          print the needed sysprep parameters for this input
54
                          media
55
    --sysprep-param=SYSPREP_PARAMS
56
                          Add KEY=VALUE system preparation parameter
57
    --no-sysprep          don't perform any system preparation operation
58
    --no-shrink           don't shrink any partition
59
    --public              register image with the cloud as public
60
    --tmpdir=DIR          create large temporary image files under DIR
56 61

  
57 62
Most input options are self-describing. If you want to save a local copy of
58 63
the image you create, provide a filename using the *-o* option. To upload the
......
298 303
Supported operating systems
299 304
---------------------------
300 305

  
301
*snf-image-creator* can only fully function on input media hosting *Linux*
302
systems. The program will detect the needed metadata and you may use it to
303
upload and register other *Unix* or *Windows* images, but you cannot use it to
304
shrink them or perform system preparation operations.
306
*snf-image-creator* can only fully function on input media hosting *Linux*,
307
*FreeBSD* (tested on version 9.1) and *Windows* (Server 2008 R2 and Server
308
2012) systems. The program will detect the needed metadata and you may use it
309
to upload and register other *Unix* images, but you cannot use it to shrink
310
them or perform system preparation operations.
305 311

  
306 312
Logical Volumes
307 313
---------------
......
330 336
kvm using the *if=virtio* option (see the kvm command in the
331 337
`Creating a new image`_ section).
332 338

  
339
For Windows and FreeBSD systems, the needed drivers need to be manually
340
downloaded and installed on the media before the image creation process takes
341
place. For *FreeBSD* the virtio drivers can be found
342
`here <http://people.freebsd.org/~kuriyama/virtio/>`_. For Windows the drivers
343
are hosted by the
344
`Fedora Project <http://alt.fedoraproject.org/pub/alt/virtio-win/latest/images/>`_.
345

  
333 346
Some caveats on image creation
334 347
==============================
335 348

  

Also available in: Unified diff