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 "February 10, 2006"
.\" 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 TAPDEVNR VLAN SYSTEM 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 first parameter
.B TAPDEVNR
is the number of the tap\-device. Use 0 for tap0, etc. See below how you
safely can define tap devices.
.PP
The second parameter 
.B VLAN
is the VLAN you want to add this adapter to. Usually,
using 0 will do.
.PP 
The third parameter
.B SYSTEM
is the system you want to emulate. Use "" if you want to use your current
architecture; in this case,
.B /usr/bin/qemm
will be called. If you want to simulate some other type of system, specify
it here; in that case, 
.B /usr/bin/qemm-system-SYSTEM
will be called.
.PP
All other options and parameters are fed to qemm.
.SH TAP DEVICE
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
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	frodo	290	.\" 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 "February 10, 2006"
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 TAPDEVNR VLAN SYSTEM 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 first parameter
43			.B 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 second parameter
48			.B VLAN
49			is the VLAN you want to add this adapter to. Usually,
50			using 0 will do.
51			.PP
52			The third parameter
53			.B SYSTEM
54			is the system you want to emulate. Use "" if you want to use your current
55			architecture; in this case,
56			.B /usr/bin/qemm
57			will be called. If you want to simulate some other type of system, specify
58			it here; in that case,
59			.B /usr/bin/qemm-system-SYSTEM
60			will be called.
61			.PP
62			All other options and parameters are fed to qemm.
63			.SH TAP DEVICE
64			You must create a tap device for use by qemu. The nicest way of doing this
65			is combining it with a bridge. This section describes how you can do this.
66			.PP
67			Edit
68			.BR /etc/network/interfaces .
69			Find the section where your current ethernet interface is described; we will
70			assume here it is
71			.IR eth0 .
72			Change its name to
73			.I br0
74			and add the following line to the stanza:
75			.PP
76			.I " " bridge_ports eth0 tap0
77			.PP
78			You can add more
79			.I tap
80			devices later if you want.
81			Now add a stanza for the new tap interface:
82			.PP
83			.I auto tap0
84			.br
85			.I iface tap0 inet manual
86			.br
87			.I " " tunctl_user qemu
88			.PP
89			Finally, restart your netwerk by issuing a command
90			.B /etc/init.d/networking restart
91
92
93			.SH SEE ALSO
94			.BR qemu (1)
95			.br
96			.SH AUTHOR
97			qemu-start was written by Frodo Looijaard <frodo@frodo.looijaard.name>.
98			.PP
99			This manual page was written by Frodo Looijaard <frodo@frodo.looijaard.name>
frodo@frodo.looijaard.name	ViewVC Help
Powered by ViewVC 1.1.26