xref: /openbmc/obmc-ikvm/README.md (revision abd331b7)
1# OpenBMC IpKVM Server
2
3The obmc-ikvm application is a VNC server that provides access to the host
4graphics output. The application interfaces with the video device on the BMC
5that captures the host graphics, and then serves that video data on the RFB
6(remote framebuffer, also known as VNC) protocol. The application also
7interfaces with the BMC USB gadget device to pass HID events from the BMC to the
8host, allowing the user to interact with the host system.
9
10## Usage
11
12Once the host is running and an appropriate HID gadget device is instantiated on
13the BMC, the application can be started with the following command:
14`obmc-ikvm -v <video device path> -i <HID gadget device path>`
15
16For example:
17
18`obmc-ikvm -v /dev/video0 -i /dev/hidg0`
19