net: add -netdev options to man page

Document the -netdev syntax which supercedes the older -net syntax.
This patch is a first step to making -netdev prominent in the QEMU
manual.

Reported-by: Anatoly Techtonik <techtonik@gmail.com>
Signed-off-by: Stefan Hajnoczi <stefanha@linux.vnet.ibm.com>
This commit is contained in:
Stefan Hajnoczi 2012-08-14 14:14:27 +01:00 committed by Stefan Hajnoczi
parent 06b5f36d05
commit 08d12022c7

View File

@ -1357,6 +1357,7 @@ Valid values for @var{type} are
Not all devices are supported on all targets. Use -net nic,model=? Not all devices are supported on all targets. Use -net nic,model=?
for a list of available devices for your target. for a list of available devices for your target.
@item -netdev user,id=@var{id}[,@var{option}][,@var{option}][,...]
@item -net user[,@var{option}][,@var{option}][,...] @item -net user[,@var{option}][,@var{option}][,...]
Use the user mode network stack which requires no administrator Use the user mode network stack which requires no administrator
privilege to run. Valid options are: privilege to run. Valid options are:
@ -1365,6 +1366,7 @@ privilege to run. Valid options are:
@item vlan=@var{n} @item vlan=@var{n}
Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default). Connect user mode stack to VLAN @var{n} (@var{n} = 0 is the default).
@item id=@var{id}
@item name=@var{name} @item name=@var{name}
Assign symbolic name for use in monitor commands. Assign symbolic name for use in monitor commands.
@ -1490,6 +1492,7 @@ processed and applied to -net user. Mixing them with the new configuration
syntax gives undefined results. Their use for new applications is discouraged syntax gives undefined results. Their use for new applications is discouraged
as they will be removed from future versions. as they will be removed from future versions.
@item -netdev tap,id=@var{id}[,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,helper=@var{helper}]
@item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,helper=@var{helper}] @item -net tap[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,ifname=@var{name}][,script=@var{file}][,downscript=@var{dfile}][,helper=@var{helper}]
Connect the host TAP network interface @var{name} to VLAN @var{n}. Connect the host TAP network interface @var{name} to VLAN @var{n}.
@ -1529,6 +1532,7 @@ qemu-system-i386 linux.img \
-net nic -net tap,"helper=/usr/local/libexec/qemu-bridge-helper" -net nic -net tap,"helper=/usr/local/libexec/qemu-bridge-helper"
@end example @end example
@item -netdev bridge,id=@var{id}[,br=@var{bridge}][,helper=@var{helper}]
@item -net bridge[,vlan=@var{n}][,name=@var{name}][,br=@var{bridge}][,helper=@var{helper}] @item -net bridge[,vlan=@var{n}][,name=@var{name}][,br=@var{bridge}][,helper=@var{helper}]
Connect a host TAP network interface to a host bridge device. Connect a host TAP network interface to a host bridge device.
@ -1551,6 +1555,7 @@ qemu-system-i386 linux.img -net bridge -net nic,model=virtio
qemu-system-i386 linux.img -net bridge,br=qemubr0 -net nic,model=virtio qemu-system-i386 linux.img -net bridge,br=qemubr0 -net nic,model=virtio
@end example @end example
@item -netdev socket,id=@var{id}[,fd=@var{h}][,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}] @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}] [,listen=[@var{host}]:@var{port}][,connect=@var{host}:@var{port}]
Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual Connect the VLAN @var{n} to a remote VLAN in another QEMU virtual
@ -1573,6 +1578,7 @@ qemu-system-i386 linux.img \
-net socket,connect=127.0.0.1:1234 -net socket,connect=127.0.0.1:1234
@end example @end example
@item -netdev socket,id=@var{id}[,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]]
@item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]] @item -net socket[,vlan=@var{n}][,name=@var{name}][,fd=@var{h}][,mcast=@var{maddr}:@var{port}[,localaddr=@var{addr}]]
Create a VLAN @var{n} shared with another QEMU virtual Create a VLAN @var{n} shared with another QEMU virtual
@ -1624,6 +1630,7 @@ qemu-system-i386 linux.img \
-net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4 -net socket,mcast=239.192.168.1:1102,localaddr=1.2.3.4
@end example @end example
@item -netdev vde,id=@var{id}[,sock=@var{socketpath}][,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
@item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}] @item -net vde[,vlan=@var{n}][,name=@var{name}][,sock=@var{socketpath}] [,port=@var{n}][,group=@var{groupname}][,mode=@var{octalmode}]
Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and Connect VLAN @var{n} to PORT @var{n} of a vde switch running on host and
listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname} listening for incoming connections on @var{socketpath}. Use GROUP @var{groupname}