qemu-start/trunk/qemu-start.1

.\"                                      Hey, EMACS: -*- nroff -*-
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH QEMU-START 1 "April 9, 2008"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
qemu\-start \- start qemu safely with tap devices
.SH SYNOPSIS
.B qemu\-start
.I [OPTIONS] -- QEMUOPTS...
.SH DESCRIPTION
This manual page documents the
.B qemu-start
command.
.PP
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
.\" \fI<whatever>\fP escape sequences to invode bold face and italics, 
.\" respectively.
\fBqemu-start\fP is a small program that helps you start qemu in a safe and
useful way. It presumes all qemu instances will run under the same
user-id 
.RI ( qemu ). 
A group
.I emulator
is created; only members of this group are allowed to start qemu. Qemu is
started with one ethernet interface, which is bound through a tap
device. Xauthority data is
automatically transferred if the DISPLAY variable is set.
.SH PARAMETERS
The parameter
.B --tapnr TAPDEVNR
is the number of the tap\-device. Use 0 for tap0, etc. See below how you
safely can define tap devices.
.PP
The parameter 
.B --vlan VLAN
is the VLAN you want to add this adapter to. Usually,
using 0 will do.
.PP
The parameter
.B --nic-model NICMODEL
is the model type of the emulated nic presented to the guest os.  Use
qemu -net nic,model=? for information on allowed values for this
parameter
.PP
The parameter
.B --macaddr MACADDRESS
sets the MAC address for the emulated nic presented to guest os.
.PP
The parameter
.B --system SYSTEM
is the system you want to emulate. Leave out if you want to use your current
architecture; in this case,
.B /usr/bin/qemu
will be called. If you want to simulate some other type of system, specify
it here; in that case, 
.B /usr/bin/qemu-system-SYSTEM
will be called.
.PP
The parameter
.B --window-left X
sets the left-most column of the window (in pixels) to X.
.PP
The parameter
.B --window-top Y
sets the top-most row of the window (in pixels) to Y.
.PP
All options and parameters after -- are fed to qemu.
.SH TAP DEVICE (DEBIAN SPECIFIC)
You must create a tap device for use by qemu. The nicest way of doing this
is combining it with a bridge. This section describes how you can do this.
.PP
Make sure you have the packages
.I bridge-utils
and 
.I uml-utilities
installed.
.PP
Edit
.BR /etc/network/interfaces .
Find the section where your current ethernet interface is described; we will
assume here it is
.IR eth0 . 
Change its name to
.I br0
and add the following line to the stanza:
.PP
.I "    " bridge_ports eth0 tap0
.PP
You can add more
.I tap
devices later if you want.
Now add a stanza for the new tap interface:
.PP
.I auto tap0
.br
.I iface tap0 inet manual
.br
.I "     " tunctl_user qemu
.PP
Finally, restart your netwerk by issuing a command
.B /etc/init.d/networking restart


.SH SEE ALSO
.BR qemu (1)
.br
.SH AUTHOR
qemu-start was written by Frodo Looijaard <frodo@frodo.looijaard.name>.
.PP
This manual page was written by Frodo Looijaard <frodo@frodo.looijaard.name>
1	.\" Hey, EMACS: -- nroff --
2	.\" First parameter, NAME, should be all caps
3	.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
4	.\" other parameters are allowed: see man(7), man(1)
5	.TH QEMU-START 1 "April 9, 2008"
6	.\" Please adjust this date whenever revising the manpage.
7	.\"
8	.\" Some roff macros, for reference:
9	.\" .nh disable hyphenation
10	.\" .hy enable hyphenation
11	.\" .ad l left justify
12	.\" .ad b justify to both left and right margins
13	.\" .nf disable filling
14	.\" .fi enable filling
15	.\" .br insert line break
16	.\" .sp <n> insert n+1 empty lines
17	.\" for manpage-specific macros, see man(7)
18	.SH NAME
19	qemu\-start \- start qemu safely with tap devices
20	.SH SYNOPSIS
21	.B qemu\-start
22	.I [OPTIONS] -- QEMUOPTS...
23	.SH DESCRIPTION
24	This manual page documents the
25	.B qemu-start
26	command.
27	.PP
28	.\" TeX users may be more comfortable with the \fB<whatever>\fP and
29	.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
30	.\" respectively.
31	\fBqemu-start\fP is a small program that helps you start qemu in a safe and
32	useful way. It presumes all qemu instances will run under the same
33	user-id
34	.RI ( qemu ).
35	A group
36	.I emulator
37	is created; only members of this group are allowed to start qemu. Qemu is
38	started with one ethernet interface, which is bound through a tap
39	device. Xauthority data is
40	automatically transferred if the DISPLAY variable is set.
41	.SH PARAMETERS
42	The parameter
43	.B --tapnr TAPDEVNR
44	is the number of the tap\-device. Use 0 for tap0, etc. See below how you
45	safely can define tap devices.
46	.PP
47	The parameter
48	.B --vlan VLAN
49	is the VLAN you want to add this adapter to. Usually,
50	using 0 will do.
51	.PP
52	The parameter
53	.B --nic-model NICMODEL
54	is the model type of the emulated nic presented to the guest os. Use
55	qemu -net nic,model=? for information on allowed values for this
56	parameter
57	.PP
58	The parameter
59	.B --macaddr MACADDRESS
60	sets the MAC address for the emulated nic presented to guest os.
61	.PP
62	The parameter
63	.B --system SYSTEM
64	is the system you want to emulate. Leave out if you want to use your current
65	architecture; in this case,
66	.B /usr/bin/qemu
67	will be called. If you want to simulate some other type of system, specify
68	it here; in that case,
69	.B /usr/bin/qemu-system-SYSTEM
70	will be called.
71	.PP
72	The parameter
73	.B --window-left X
74	sets the left-most column of the window (in pixels) to X.
75	.PP
76	The parameter
77	.B --window-top Y
78	sets the top-most row of the window (in pixels) to Y.
79	.PP
80	All options and parameters after -- are fed to qemu.
81	.SH TAP DEVICE (DEBIAN SPECIFIC)
82	You must create a tap device for use by qemu. The nicest way of doing this
83	is combining it with a bridge. This section describes how you can do this.
84	.PP
85	Make sure you have the packages
86	.I bridge-utils
87	and
88	.I uml-utilities
89	installed.
90	.PP
91	Edit
92	.BR /etc/network/interfaces .
93	Find the section where your current ethernet interface is described; we will
94	assume here it is
95	.IR eth0 .
96	Change its name to
97	.I br0
98	and add the following line to the stanza:
99	.PP
100	.I " " bridge_ports eth0 tap0
101	.PP
102	You can add more
103	.I tap
104	devices later if you want.
105	Now add a stanza for the new tap interface:
106	.PP
107	.I auto tap0
108	.br
109	.I iface tap0 inet manual
110	.br
111	.I " " tunctl_user qemu
112	.PP
113	Finally, restart your netwerk by issuing a command
114	.B /etc/init.d/networking restart
115
116
117	.SH SEE ALSO
118	.BR qemu (1)
119	.br
120	.SH AUTHOR
121	qemu-start was written by Frodo Looijaard <frodo@frodo.looijaard.name>.
122	.PP
123	This manual page was written by Frodo Looijaard <frodo@frodo.looijaard.name>
frodo@frodo.looijaard.name	ViewVC Help
Powered by ViewVC 1.1.26