qemu-img: Document backing options
The create and convert subcommands have shorthands to set the backing_file and, in the case of create, the backing_fmt options for the new image. However, they have not been documented so far, which is remedied by this patch. Reported-by: Eric Blake <eblake@redhat.com> Signed-off-by: Max Reitz <mreitz@redhat.com> Reviewed-by: Eric Blake <eblake@redhat.com> Signed-off-by: Kevin Wolf <kwolf@redhat.com>
This commit is contained in:
		
							parent
							
								
									48758a8473
								
							
						
					
					
						commit
						2b4c0a20fb
					
				| @ -22,9 +22,9 @@ STEXI | ||||
| ETEXI | ||||
| 
 | ||||
| DEF("create", img_create, | ||||
|     "create [-q] [--object objectdef] [-f fmt] [-o options] filename [size]") | ||||
|     "create [-q] [--object objectdef] [-f fmt] [-b backing_file] [-F backing_fmt] [-o options] filename [size]") | ||||
| STEXI | ||||
| @item create [--object @var{objectdef}] [-q] [-f @var{fmt}] [-o @var{options}] @var{filename} [@var{size}] | ||||
| @item create [--object @var{objectdef}] [-q] [-f @var{fmt}] [-b @var{backing_file}] [-F @var{backing_fmt}] [-o @var{options}] @var{filename} [@var{size}] | ||||
| ETEXI | ||||
| 
 | ||||
| DEF("commit", img_commit, | ||||
| @ -40,9 +40,9 @@ STEXI | ||||
| ETEXI | ||||
| 
 | ||||
| DEF("convert", img_convert, | ||||
|     "convert [--object objectdef] [--image-opts] [-c] [-p] [-q] [-n] [-f fmt] [-t cache] [-T src_cache] [-O output_fmt] [-o options] [-s snapshot_id_or_name] [-l snapshot_param] [-S sparse_size] [-m num_coroutines] [-W] filename [filename2 [...]] output_filename") | ||||
|     "convert [--object objectdef] [--image-opts] [-c] [-p] [-q] [-n] [-f fmt] [-t cache] [-T src_cache] [-O output_fmt] [-B backing_file] [-o options] [-s snapshot_id_or_name] [-l snapshot_param] [-S sparse_size] [-m num_coroutines] [-W] filename [filename2 [...]] output_filename") | ||||
| STEXI | ||||
| @item convert [--object @var{objectdef}] [--image-opts] [-c] [-p] [-q] [-n] [-f @var{fmt}] [-t @var{cache}] [-T @var{src_cache}] [-O @var{output_fmt}] [-o @var{options}] [-s @var{snapshot_id_or_name}] [-l @var{snapshot_param}] [-S @var{sparse_size}] [-m @var{num_coroutines}] [-W] @var{filename} [@var{filename2} [...]] @var{output_filename} | ||||
| @item convert [--object @var{objectdef}] [--image-opts] [-c] [-p] [-q] [-n] [-f @var{fmt}] [-t @var{cache}] [-T @var{src_cache}] [-O @var{output_fmt}] [-B @var{backing_file}] [-o @var{options}] [-s @var{snapshot_id_or_name}] [-l @var{snapshot_param}] [-S @var{sparse_size}] [-m @var{num_coroutines}] [-W] @var{filename} [@var{filename2} [...]] @var{output_filename} | ||||
| ETEXI | ||||
| 
 | ||||
| DEF("dd", img_dd, | ||||
|  | ||||
| @ -224,7 +224,7 @@ If @code{-r} is specified, exit codes representing the image state refer to the | ||||
| state after (the attempt at) repairing it. That is, a successful @code{-r all} | ||||
| will yield the exit code 0, independently of the image state before. | ||||
| 
 | ||||
| @item create [-f @var{fmt}] [-o @var{options}] @var{filename} [@var{size}] | ||||
| @item create [-f @var{fmt}] [-b @var{backing_file}] [-F @var{backing_fmt}] [-o @var{options}] @var{filename} [@var{size}] | ||||
| 
 | ||||
| Create the new disk image @var{filename} of size @var{size} and format | ||||
| @var{fmt}. Depending on the file format, you can add one or more @var{options} | ||||
| @ -302,7 +302,7 @@ Error on reading data | ||||
| 
 | ||||
| @end table | ||||
| 
 | ||||
| @item convert [-c] [-p] [-n] [-f @var{fmt}] [-t @var{cache}] [-T @var{src_cache}] [-O @var{output_fmt}] [-o @var{options}] [-s @var{snapshot_id_or_name}] [-l @var{snapshot_param}] [-m @var{num_coroutines}] [-W] [-S @var{sparse_size}] @var{filename} [@var{filename2} [...]] @var{output_filename} | ||||
| @item convert [-c] [-p] [-n] [-f @var{fmt}] [-t @var{cache}] [-T @var{src_cache}] [-O @var{output_fmt}] [-B @var{backing_file}] [-o @var{options}] [-s @var{snapshot_id_or_name}] [-l @var{snapshot_param}] [-m @var{num_coroutines}] [-W] [-S @var{sparse_size}] @var{filename} [@var{filename2} [...]] @var{output_filename} | ||||
| 
 | ||||
| Convert the disk image @var{filename} or a snapshot @var{snapshot_param}(@var{snapshot_id_or_name} is deprecated) | ||||
| to disk image @var{output_filename} using format @var{output_fmt}. It can be optionally compressed (@code{-c} | ||||
|  | ||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user
	 Max Reitz
						Max Reitz