[Qemu-devel] [PATCH 4/4] curl: Add usage documentation

[Matthew Booth]

Signed-off-by: Matthew Booth <address@hidden>
---
 qemu-options.hx | 68 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 68 insertions(+)

diff --git a/qemu-options.hx b/qemu-options.hx
index 781af14..7587bce 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -2191,6 +2191,74 @@ qemu-system-x86_64 --drive 
file=gluster://192.0.2.1/testvol/a.img
 @end example
 
 See also @url{http://www.gluster.org}.
+
address@hidden HTTP/HTTPS/FTP/FTPS/TFTP
+QEMU supports read-only access to files accessed over http(s), ftp(s) and tftp.
+
+Syntax using a single filename:
address@hidden
+<protocol>://[<username>[:<password>]@@]<host>/<path>
address@hidden example
+
+where:
address@hidden @option
address@hidden protocol
+'http', 'https', 'ftp', 'ftps', or 'tftp'.
+
address@hidden username
+Optional username for authentication to the remote server.
+
address@hidden password
+Optional password for authentication to the remote server.
+
address@hidden host
+Address of the remote server.
+
address@hidden path
+Path on the remote server, including any query string.
address@hidden table
+
+The following options are also supported:
address@hidden @option
address@hidden url
+The full URL when passing options to the driver explicitly.
+
address@hidden readahead
+The amount of data to read ahead with each range request to the remote server.
+This value may optionally have the suffix 'T', 'G', 'M', 'K', 'k' or 'b'. If it
+does not have a suffix, it will be assumed to be in bytes. The value must be a
+multiple of 512 bytes. It defaults to 256k.
+
address@hidden sslverify
+Whether to verify the remote server's certificate when connecting over SSL. It
+can have the value 'on' or 'off'. It defaults to 'on'.
address@hidden table
+
+Note that when passing options to qemu explicitly, @option{driver} is the value
+of <protocol>.
+
+Example: boot from a remote Fedora 20 live ISO image
address@hidden
+qemu-system-x86_64 --drive 
media=cdrom,file=http://dl.fedoraproject.org/pub/fedora/linux/releases/20/Live/x86_64/Fedora-Live-Desktop-x86_64-20-1.iso,readonly
+
+qemu-system-x86_64 --drive 
media=cdrom,file.driver=http,file.url=http://dl.fedoraproject.org/pub/fedora/linux/releases/20/Live/x86_64/Fedora-Live-Desktop-x86_64-20-1.iso,readonly
address@hidden example
+
+Example: boot from a remote Fedora 20 cloud image using a local overlay for
+writes, copy-on-read, and a readahead of 64k
address@hidden
+qemu-img create -f qcow2 -o backing_file='json:@{"file.driver":"http",, 
"file.url":"https://dl.fedoraproject.org/pub/fedora/linux/releases/20/Images/x86_64/Fedora-x86_64-20-20131211.1-sda.qcow2";,,
 "file.readahead":"64k"@}' /tmp/Fedora-x86_64-20-20131211.1-sda.qcow2
+
+qemu-system-x86_64 -drive 
file=/tmp/Fedora-x86_64-20-20131211.1-sda.qcow2,copy-on-read=on
address@hidden example
+
+Example: boot from an image stored on a VMware vSphere server with a 
self-signed
+certificate using a local overlay for writes and a readahead of 64k
address@hidden
+qemu-img create -f qcow2 -o backing_file='json:@{"file.driver":"https",, 
"file.url":"https://user:password@@vsphere.example.com/folder/test/test-flat.vmdk?dcPath=Datacenter&dsName=datastore1";,,
 "file.sslverify":"off",, "file.readahead":"64k"@}' /tmp/test.qcow2
+
+qemu-system-x86_64 -drive file=/tmp/test.qcow2
address@hidden example
 ETEXI
 
 STEXI
-- 
1.9.0