From acc80a2c3238681d57254677da0bf2ff11677d36 Mon Sep 17 00:00:00 2001 From: Volker Ruppert Date: Thu, 10 Apr 2014 18:11:30 +0000 Subject: [PATCH] Improved Slirp documentation (to be continued) --- bochs/.bochsrc | 3 +- bochs/doc/docbook/user/user.dbk | 57 +++++++++++++++++++++++++++++++-- bochs/doc/man/bochsrc.5 | 5 +-- 3 files changed, 59 insertions(+), 6 deletions(-) diff --git a/bochs/.bochsrc b/bochs/.bochsrc index e1a4e0cf2..30082ddcf 100644 --- a/bochs/.bochsrc +++ b/bochs/.bochsrc @@ -959,7 +959,8 @@ speaker: enabled=1, mode=sound # This is mainly useful for the tun/tap devices that only exist during # Bochs execution. The network interface name is supplied to the script # as first parameter. The 'slirp' module uses this parameter to specify -# a config file for setting up an alternative configuration. +# a config file for setting up an alternative IP configuration or additional +# features. # # BOOTROM: The bootrom value is optional, and is the name of the ROM image # to load. Note that this feature is only implemented for the PCI version of diff --git a/bochs/doc/docbook/user/user.dbk b/bochs/doc/docbook/user/user.dbk index 96dffeb1b..e6c31999b 100644 --- a/bochs/doc/docbook/user/user.dbk +++ b/bochs/doc/docbook/user/user.dbk @@ -4530,9 +4530,10 @@ version where this module was added. slirp Built-in Slirp support with DHCP / TFTP servers. Adds user mode - networking to Bochs. The 'script' parameter can be used to set up an - alternative configuration. The TFTP server uses the 'ethdev' value for - the root directory and doesn't overwrite files. + networking to Bochs - see Using the 'slirp' + networking module. The 'script' parameter can be used to set up + an alternative IP configuration or additional features. The TFTP server + uses the 'ethdev' value for the root directory and doesn't overwrite files. Yes, for TFTP Yes, for Slirp config @@ -6965,6 +6966,56 @@ Some of the other options in this group is probably also needed, +
Using the 'slirp' networking module + +Slirp is a software program that emulates a PPP, SLIP, or CSLIP connection to +the Internet via a shell account. The original version has been written by +Danny Gasparovski in 1995. It has been integrated in QEMU to provide user mode +networking. Now a port of the QEMU Slirp implementation is available in Bochs. + + +Features and limitations: + +Access to the internet and host network services without root/Administrator +privileges or additional libraries. +Builtin DHCP and TFTP servers +Optional SMB support on Linux +ICMP traffic (ping) from guest to the host's network or the internet +not supported +guest not yet accessible from the host or external network + + + +If no config file is specified with "script" parameter in the network device setup, +Bochs uses this "classic" Slirp configuration: +Default Slirp setup + + + + DHCP, TFTP servers and gateway + 10.0.2.2 + + + DNS server + 10.0.2.3 + + + SMB server (optional) + 10.0.2.4 + + + Guest address (from DHCP) + 10.0.2.15 + + + +
+ + +&FIXME; TODO: config file options (slirp.conf) + +
+
Using Bochs internal debugger diff --git a/bochs/doc/man/bochsrc.5 b/bochs/doc/man/bochsrc.5 index 369fd7f14..d35242310 100644 --- a/bochs/doc/man/bochsrc.5 +++ b/bochs/doc/man/bochsrc.5 @@ -1,5 +1,5 @@ .\"Document Author: Timothy R. Butler - tbutler@uninetsolutions.com" -.TH bochsrc 5 "02 Apr 2014" "bochsrc" "The Bochs Project" +.TH bochsrc 5 "10 Apr 2014" "bochsrc" "The Bochs Project" .\"SKIP_SECTION" .SH NAME bochsrc \- Configuration file for Bochs. @@ -1084,7 +1084,8 @@ this script to configure this network interface, or enable masquerading. This is mainly useful for the tun/tap devices that only exist during Bochs execution. The network interface name is supplied to the script as first parameter. The 'slirp' module uses this parameter to specify -a config file for setting up an alternative configuration. +a config file for setting up an alternative IP configuration or additional +features. BOOTROM: The bootrom value is optional, and is the name of the ROM image