Skip to content
This repository was archived by the owner on Apr 16, 2023. It is now read-only.

Renamed vconfig tool in vconf because of name collision with the standard vconfig Linux VLAN tool #29

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
File renamed without changes.
8 changes: 4 additions & 4 deletions man/man1/vclean.1
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ is not used any more and the corresponding configuration settings must be remove
(see \fBvstart\fR(1) for a description of ``\fBtap\fR'' collision domains).
.IP \(en 2
A network interface has been attached ``on the fly'' to a running virtual machine
by using \fBvconfig\fR (see \fBvconfig\fR(1)). After halting (or crashing) the
by using \fBvconf\fR (see \fBvconf\fR(1)). After halting (or crashing) the
machine, the corresponding virtual hub is still running and must be terminated.

.PP
Expand Down Expand Up @@ -79,8 +79,8 @@ should result in getting rid of all Netkit processes, even the hanging ones
.B
--remove-tunnels
When using an interface attached to a ``\fBtap\fR'' collision domain for the
first time, \fIvstart\fR (or \fIvconfig\fR, depending on the command you have
been using to configure the interface \(en see \fBvstart\fR(1), \fBvconfig\fR(1))
first time, \fIvstart\fR (or \fIvconf\fR, depending on the command you have
been using to configure the interface \(en see \fBvstart\fR(1), \fBvconf\fR(1))
takes care of automatically configuring the necessary host-side settings and, if
found, also the iptables firewall. For details about the configuration parameters
being altered, see \fBvstart\fR(1).
Expand Down Expand Up @@ -209,7 +209,7 @@ of cleaning up temporary files created after running a Netkit lab).

.SH "SEE ALSO"
\fIlclean\fR(1),
\fIvconfig\fR(1),
\fIvconf\fR(1),
\fIvcrash\fR(1),
\fIvhalt\fR(1),
\fIvlist\fR(1),
Expand Down
34 changes: 17 additions & 17 deletions man/man1/vconfig.1
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
.TH VCONFIG 1 "November 2009" "" Netkit
.SH NAME
vconfig \- attach network interfaces to running netkit virtual machines
vconf \- attach network interfaces to running netkit virtual machines
.SH SYNOPSIS
\fBvconfig\fR [options] \fIMACHINE\-ID\fR
\fBvconf\fR [options] \fIMACHINE\-ID\fR


\" ########################################

.SH DESCRIPTION

The \fIvconfig\fR command can be used to attach network interfaces to running
The \fIvconf\fR command can be used to attach network interfaces to running
virtual machines ``on the fly''. The affected machine is identified by a \fBMACHINE\-ID\fR,
which is either the PID or the name of a running virtual machine.

Expand All @@ -30,7 +30,7 @@ Attaching an already existing interface to a virtual machine causes an error.

.PP

The following options are also supported by \fIvconfig\fR.
The following options are also supported by \fIvconf\fR.

.TP
.B
Expand Down Expand Up @@ -68,16 +68,16 @@ This option suppresses any kind of output, except errors and warnings.
.TP
.B
--user=\fIUSERNAME\fR
This option tells \fIvconfig\fR to only work on virtual machines owned by \fIUSERNAME\fR.
By default, \fIvconfig\fR only allows to attach interfaces to virtual machines
started by the current user (i.e., the one who launched \fIvconfig\fR). By using
This option tells \fIvconf\fR to only work on virtual machines owned by \fIUSERNAME\fR.
By default, \fIvconf\fR only allows to attach interfaces to virtual machines
started by the current user (i.e., the one who launched \fIvconf\fR). By using
this option it is possible to attach interfaces to someone else's virtual machines
(this requires administrative privileges). The special user name `\fB\-\fR' is
reserved and allows to consider all virtual machines, regardless of their owner.

Consider that different users may be running virtual machines having the same
name. Hence, using the `\fB\-\-user\fR=\fB-\fR' option when \fIMACHINE\-ID\fR
is a virtual machine name may arise ambiguities. In such a case, \fIvconfig\fR
is a virtual machine name may arise ambiguities. In such a case, \fIvconf\fR
only works on the virtual machine reported by issuing the command
.nh
`vlist -u - \fIMACHINE\-ID\fR'.
Expand All @@ -104,14 +104,14 @@ by using this command are not shown by the \fIvlist\fR command, even
when requesting complete details about the virtual machine.
.br
As a side effect of this, virtual hubs (collision domains) started by
\fIvconfig\fR are not automatically stopped when all the connected machines are
\fIvconf\fR are not automatically stopped when all the connected machines are
shut down. In order to do this, you should use the \fBvclean\fR command with the
option \fB\-H\fR (see \fBvclean\fR(1)).

An important difference with respect to attaching interfaces with \fIvstart\fR (see
\fBvstart\fR(1)) is that, when using ``\fBtap\fR'' collision domains, the
configuration of the virtual machine is not automatically updated. In particular,
assume that interface eth0 has been set up using \fIvconfig\fR with the following option:
assume that interface eth0 has been set up using \fIvconf\fR with the following option:

.nf
\-\-eth0=tap,\fITAP\-ADDRESS\fR,\fIGUEST\-ADDRESS\fR
Expand All @@ -128,11 +128,11 @@ by using the following command:
ifconfig eth0 \fIGUEST\-ADDRESS\fR up
.fi

Notice that \fIvconfig\fR does not consider the \fIGUEST\-ADDRESS\fR parameter,
Notice that \fIvconf\fR does not consider the \fIGUEST\-ADDRESS\fR parameter,
even if the command syntax requires it. Hence, you are free to use any IP
address in configuring interface eth0 (provided that it is on the same (sub)network
as \fITAP\-ADDRESS\fR). Nevertheless, it is a good rule to be coherent with the
\fIGUEST\-ADDRESS\fR provided on the \fIvconfig\fR command line.
\fIGUEST\-ADDRESS\fR provided on the \fIvconf\fR command line.

.IP 2) 3
A default route must be configured to point to the host side of the ``\fBtap\fR''
Expand Down Expand Up @@ -161,7 +161,7 @@ domain.
All Netkit commands require that the \fBNETKIT_HOME\fR variable contains the
name of the directory Netkit is installed in.

Apart from this, \fIvconfig\fR supports no other environment variables.
Apart from this, \fIvconf\fR supports no other environment variables.


\" ########################################
Expand All @@ -171,15 +171,15 @@ Apart from this, \fIvconfig\fR supports no other environment variables.
.TP
.B
.nf
vconfig --eth0=A pc1
vconf --eth0=A pc1
.fi
Equip virtual machine \fBpc1\fR with a new interface (\fBeth0\fR) which is attached
to the virtual collision domain \fBA\fR.

.TP
.B
.nf
vconfig --eth1=tap,10.0.0.1,10.0.0.2 -u foo pc2
vconf --eth1=tap,10.0.0.1,10.0.0.2 -u foo pc2
.fi
Configure a new interface (\fBeth1\fR) on virtual machine \fBpc2\fR owned
by user \fBfoo\fR. The host side of the interface will be automatically configured
Expand All @@ -191,7 +191,7 @@ ifconfig eth1 10.0.0.2 up
route add default gw 10.0.0.1 dev eth1
.fi

Running this example requires administrative privileges. The \fIvconfig\fR
Running this example requires administrative privileges. The \fIvconf\fR
command will take care of asking you for the root password if needed. For more
information about how Netkit gains root privileges, see \fBUSE_SUDO\fR and
\fBSETTING UP NETKIT FOR USE WITH SUDO\fR in the man page of
Expand All @@ -212,7 +212,7 @@ information about how Netkit gains root privileges, see \fBUSE_SUDO\fR and
\" ########################################

.SH AUTHOR
\fIvconfig\fR script: Massimo Rimondini
\fIvconf\fR script: Massimo Rimondini
.br
This man page: Massimo Rimondini

Expand Down
2 changes: 1 addition & 1 deletion man/man1/vcrash.1
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ A synonym for \fB\-\-user\fR=\fB-\fR.

.SH "SEE ALSO"
\fIvclean\fR(1),
\fIvconfig\fR(1),
\fIvconf\fR(1),
\fIvhalt\fR(1),
\fIvlist\fR(1),
\fIvstart\fR(1),
Expand Down
2 changes: 1 addition & 1 deletion man/man1/vhalt.1
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ Apart from this, \fIvhalt\fR supports no other environment variables.

.SH "SEE ALSO"
\fIvclean\fR(1),
\fIvconfig\fR(1),
\fIvconf\fR(1),
\fIvcrash\fR(1),
\fIvlist\fR(1),
\fIvstart\fR(1),
Expand Down
2 changes: 1 addition & 1 deletion man/man1/vlist.1
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,7 @@ which you can get by typing `vlist pc1'.

.SH "SEE ALSO"
\fIvclean\fR(1),
\fIvconfig\fR(1),
\fIvconf\fR(1),
\fIvcrash\fR(1),
\fIvhalt\fR(1),
\fIvstart\fR(1).
Expand Down
2 changes: 1 addition & 1 deletion man/man1/vstart.1
Original file line number Diff line number Diff line change
Expand Up @@ -640,7 +640,7 @@ shown inside different tabs of the terminal emulator konsole.
\fIlstart\fR(1),
\fInetkit.conf\fR(5),
\fIvclean\fR(1),
\fIvconfig\fR(1),
\fIvconf\fR(1),
\fIvcrash\fR(1),
\fIvhalt\fR(1),
\fIvlist\fR(1),
Expand Down
4 changes: 2 additions & 2 deletions man/man7/netkit.7
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ See also the README in the Netkit kernel package for information about building
a customized kernel for the virtual machines.

Netkit provides you with two alternative interfaces to start and configure virtual
machines. A set of `v'\-prefixed commands (\fIvclean\fR, \fIvconfig\fR,
machines. A set of `v'\-prefixed commands (\fIvclean\fR, \fIvconf\fR,
\fIvcrash\fR, \fIvhalt\fR, \fIvlist\fR, \fIvstart\fR), which allow to start and
manage single virtual machines while providing finegrained control on their
configuration, and a set of `l'\-prefixed commands (\fIlclean\fR, \fIlcrash\fR,
Expand Down Expand Up @@ -78,7 +78,7 @@ file and a description of its format.
\fIlstart\fR(1),
\fIltest\fR(1),
\fIvclean\fR(1),
\fIvconfig\fR(1),
\fIvconf\fR(1),
\fIvcrash\fR(1),
\fIvhalt\fR(1),
\fIvlist\fR(1),
Expand Down