README

   1 v86d -- A x86 Emulation Daemon
   2 ------------------------------
   3
   4 1. Purpose
   5 ----------
   6 v86d provides a backend for kernel drivers that need to execute
   7 x86 BIOS code.  The code is executed in a controlled environment
   8 and the results are passed back to the kernel via the netlink
   9 interface.
  10
  11 2. Suported architectures
  12 -------------------------
  13 This version of v86d supports the following architectures:
  14 x86, x86-64 (amd64).
  15
  16 3. Configuration
  17 ----------------
  18
  19 3.1. The C library
  20 ------------------
  21 v86d can be compiled against two different C libraries: glibc
  22 and klibc, glibc being the default.
  23
  24 Compiling against glibc will result in a dynamically linked
  25 executable that is not suitable for inclusion in initrds.
  26
  27 Compiling against klibc will result in a relatively small,
  28 statically linked binary, which can be included in an initrd.
  29
  30 To compile v86d against klibc, run ./configure --with-klibc
  31 after making sure that a recent (1.4 or newer) version of
  32 klibc is installed on your system.
  33
  34 3.2. The emulator backend
  35 -------------------------
  36 On x86, the code executed by v86d can be run either in a fully
  37 software-emulated environment (x86emu) or a virtualized
  38 environment (vm86) supported by the CPU.  On other arches
  39 or 64-bit systems, the code is always run by x86emu.
  40
  41 To choose the x86emu backend on a x86 system, run ./configure
  42 --with-x86emu.
  43
  44 4. Installation & Usage
  45 -----------------------
  46 To configure, build and install v86d with the default settings,
  47 run:
  48
  49  # ./configure --default
  50  # make
  51  # make install
  52
  53 If the kernel that you're currently running doesn't provide
  54 uvesafb, you can use the KDIR variable to point make to a
  55 different kernel tree (e.g. `make KDIR=/usr/src/linux`).
  56
  57 v86d isn't meant to be used in an interactive way. It should
  58 be started and called by the kernel. If you want to see it in
  59 action, build and load the uvesafb kernel module.
  60
  61 If you want to include v86d into an initramfs image,
  62 misc/initramfs provides a minimal config file parsable by
  63 gen_init_cpio.
  64
  65 5. Licensing
  66 ------------
  67 v86d is licensed under GPL v2.
  68
  69 --
  70  Michal Januszewski <spock@gentoo.org>
  71