Adding upstream version 7.0.6-dfsg.upstream/7.0.6-dfsgupstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 201 insertions, 0 deletions

diff --git a/doc/manual/en_US/man_VBoxManage-hostonlyif.xml b/doc/manual/en_US/man_VBoxManage-hostonlyif.xml
new file mode 100644
index 00000000..4f0f1713
--- /dev/null
+++ b/doc/manual/en_US/man_VBoxManage-hostonlyif.xml
@@ -0,0 +1,201 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+    manpage, user manual, usage: VBoxManage hostonlyif
+-->
+<!--
+    Copyright (C) 2006-2022 Oracle and/or its affiliates.
+
+    This file is part of VirtualBox base platform packages, as
+    available from https://www.virtualbox.org.
+
+    This program is free software; you can redistribute it and/or
+    modify it under the terms of the GNU General Public License
+    as published by the Free Software Foundation, in version 3 of the
+    License.
+
+    This program is distributed in the hope that it will be useful, but
+    WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+    General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, see <https://www.gnu.org/licenses>.
+
+    SPDX-License-Identifier: GPL-3.0-only
+-->
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+  "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"[
+<!ENTITY % all.entities SYSTEM "all-entities.ent">
+%all.entities;
+]>
+<refentry id="vboxmanage-hostonlyif" lang="en">
+  <refentryinfo>
+    <pubdate>$Date: 2022-08-22 19:43:14 +0200 (Mon, 22 Aug 2022) $</pubdate>
+    <title>VBoxManage hostonlyif</title>
+  </refentryinfo>
+
+  <refmeta>
+    <refentrytitle>VBoxManage-hostonlyif</refentrytitle>
+    <manvolnum>1</manvolnum>
+  </refmeta>
+
+  <refnamediv>
+    <refname>VBoxManage-hostonlyif</refname>
+    <refpurpose>manage host-only network interfaces</refpurpose>
+    <refclass>&product-name;</refclass>
+  </refnamediv>
+
+  <refsynopsisdiv>
+<!-- The 'id' is mandatory and must start with 'synopsis-'. -->
+    <cmdsynopsis id="synopsis-vboxmanage-hostonlyif-ipconfig">
+      <command>VBoxManage hostonlyif ipconfig</command>
+      <arg choice="req"><replaceable>ifname</replaceable></arg>
+      <group>
+        <arg choice="plain">--dhcp</arg>
+        <arg choice="plain">--ip=<replaceable>IPv4-address</replaceable> <arg>--netmask=<replaceable>IPv4-netmask</replaceable></arg></arg>
+        <arg choice="plain">--ipv6=<replaceable>IPv6-address</replaceable> <arg>--netmasklengthv6=<replaceable>length</replaceable></arg></arg>
+      </group>
+    </cmdsynopsis>
+
+    <cmdsynopsis id="synopsis-vboxmanage-hostonlyif-create">
+      <command>VBoxManage hostonlyif create</command>
+    </cmdsynopsis>
+
+    <cmdsynopsis id="synopsis-vboxmanage-hostonlyif-remove">
+      <command>VBoxManage hostonlyif remove</command>
+      <arg choice="req"><replaceable>ifname</replaceable></arg>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>Description</title>
+    <para>
+      The <command>VBoxManage hostonlyif</command> command enables you
+      to change the IP configuration of a host-only network interface.
+      For a description of host-only networking, see
+      <xref linkend="network_hostonly" />. Each host-only network
+      interface is identified by a name and can either use the internal
+      DHCP server or a manual IP configuration, both IPv4 and IPv6.
+    </para>
+    <refsect2 id="vboxmanage-hostonlyif-ipconfig">
+      <title>Configure a Host-Only Interface</title>
+      <remark role="help-copy-synopsis"/>
+      <para>
+        The <command>VBoxManage hostonlyif ipconfig</command> command
+        configures a host-only interface.
+      </para>
+      <variablelist>
+        <varlistentry>
+          <term><replaceable>ifname</replaceable></term>
+          <listitem><para>
+              Specifies the name of the network interface. The name is
+              of the form
+              <literal>vboxnet</literal><replaceable>N</replaceable>
+              where <replaceable>N</replaceable> is the interface
+              instance.
+            </para></listitem>
+        </varlistentry>
+        <varlistentry>
+          <term><option>--dhcp</option></term>
+          <listitem><para>
+              Uses DHCP for the network interface.
+            </para><para>
+              You cannot use this option with the <option>--ip</option>,
+              <option>--ipv6</option>, <option>--netmask</option>, and
+              <option>--netmasklengthv6</option> options.
+            </para></listitem>
+        </varlistentry>
+        <varlistentry>
+          <term><option>--ip=<replaceable>IPv4-address</replaceable></option></term>
+          <listitem><para>
+              Specifies the IPv4 IP address for the network interface.
+            </para><para>
+              You cannot use this option with the
+              <option>--dhcp</option>, <option>--ipv6</option>, and
+              <option>--netmasklengthv6</option> options.
+            </para></listitem>
+        </varlistentry>
+        <varlistentry>
+          <term><option>--netmask=<replaceable>IPv4-netmask</replaceable></option></term>
+          <listitem><para>
+              Specifies the IPv4 netmask of the network interface. The
+              default value is <literal>255.255.255.0</literal>.
+            </para><para>
+              You can use this option only with the
+              <option>--ip</option> option.
+            </para></listitem>
+        </varlistentry>
+        <varlistentry>
+          <term><option>--ipv6=<replaceable>IPv6-address</replaceable></option></term>
+          <listitem><para>
+              Specifies the IPv6 IP address for the network interface.
+            </para><para>
+              You cannot use this option with the
+              <option>--dhcp</option>, <option>--ip</option>, and
+              <option>--netmask</option> options.
+            </para></listitem>
+        </varlistentry>
+        <varlistentry>
+          <term><option>--netmasklengthv6=<replaceable>length</replaceable></option></term>
+          <listitem><para>
+              Specifies the length of the IPv6 network interface. The
+              default value is <literal>64</literal>.
+            </para><para>
+              You can use this option only with the
+              <option>--ipv6</option> option.
+            </para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
+    <refsect2 id="vboxmanage-hostonlyif-create">
+      <title>Create a Network Interface on the Host System</title>
+      <remark role="help-copy-synopsis"/>
+      <para>
+        The <command>VBoxManage hostonlyif create</command> command
+        creates a new host-only network interface on the host operating
+        system (OS). The network interface name is of the form
+        <literal>vboxnet</literal><replaceable>N</replaceable> where
+        <replaceable>N</replaceable> is the interface instance. You must
+        run this command before you can attach virtual machines (VMs) to
+        the host-only network.
+      </para>
+    </refsect2>
+    <refsect2 id="vboxmanage-hostonlyif-remove">
+      <title>Remove a Network Interface From the Host System</title>
+      <remark role="help-copy-synopsis"/>
+      <para>
+        The <command>VBoxManage hostonlyif remove</command> command
+        removes the specified host-only network interface from the host
+        OS.
+      </para>
+      <variablelist>
+        <varlistentry>
+          <term><replaceable>ifname</replaceable></term>
+          <listitem><para>
+              Specifies the name of the network interface. The name is
+              of the form
+              <literal>vboxnet</literal><replaceable>N</replaceable>
+              where <replaceable>N</replaceable> is the interface
+              instance.
+            </para></listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
+  </refsect1>
+
+  <refsect1>
+    <title>Examples</title>
+    <remark role="help-scope" condition="GLOBAL" />
+    <para>
+      The following command creates a new host-only network interface.
+    </para>
+<screen>$ VBoxManage hostonlyif create
+0%...10%...20%...30%...40%...50%...60%...70%...80%...90%...100%
+Interface 'vboxnet2' was successfully created</screen>
+    <para>
+      The following command configures the IPv4 address for the
+      <literal>vboxnet2</literal> host-only network interface.
+    </para>
+<screen>$ VBoxManage hostonlyif ipconfig vboxnet2 --ip 10.0.2.18</screen>
+  </refsect1>
+</refentry>