LinuxCommandLibrary

VBoxClient

Enables VirtualBox guest additions features

SYNOPSIS

VBoxClient [OPTIONS] [COMMANDS]
Examples:
  VBoxClient --clipboard --draganddrop
  VBoxClient --seamless

PARAMETERS

--clipboard
    Enables and manages the shared clipboard functionality between the host and guest operating systems, allowing text and other data to be copied and pasted across the virtual machine boundary.

--draganddrop
    Activates the drag and drop feature, enabling users to move files and folders directly between the host desktop and the guest desktop environment.

--seamless
    Enables seamless window mode, which allows individual windows from the guest operating system to appear on the host desktop as if they were native host applications, providing a more integrated experience.

--display-auto-resize
    Monitors the guest display resolution and automatically resizes it to match the VirtualBox viewer window size, providing a fluid and adaptable display experience.

--checkhostsystem
    Queries the host system for capabilities related to certain guest integration features and reports them to the guest.

--vmsvga
    Activates specific enhancements for the VMSVGA 3D graphics controller, improving graphics performance and features within the guest operating system.

--vbgcc
    Enables guest control functionality, which allows the host to execute commands and manage processes within the guest operating system.

-v, --version
    Prints the version information of the VBoxClient utility and then exits.

-d <display_string>, --display <display_string>
    Specifies the X display to connect to, which is typically used in X11 environments for graphical features managed by VBoxClient.

-n, --nodisplay
    Prevents VBoxClient from attempting to connect to an X display, useful for non-graphical or headless environments where display features are not required.

-q, --quiet
    Suppresses most output messages from VBoxClient, making it run more silently without verbose feedback.

DESCRIPTION

VBoxClient is a crucial component of VirtualBox Guest Additions, installed within a guest operating system. It facilitates seamless integration between the guest and host machines, enhancing the user experience by providing essential features such as shared clipboard, drag and drop support, automatic display resizing, and seamless window mode. This utility typically runs in the background, often started automatically as part of the Guest Additions services upon the guest's desktop environment startup. Without VBoxClient and its associated processes, many of the convenient integration features that improve the usability of VirtualBox virtual machines would not function, limiting interaction between the host and guest.

CAVEATS

VBoxClient relies entirely on the presence and proper installation of VirtualBox Guest Additions within the guest operating system. If Guest Additions are not installed, are outdated, or are corrupted, VBoxClient functionalities will be unavailable or unstable. Some features might also require specific VirtualBox machine settings (e.g., shared clipboard enabled for bidirectional) or a compatible host environment. Ensure that the VBoxService daemon is running in the guest for optimal operation, as VBoxClient often interacts with it.

AUTOMATIC STARTUP

VBoxClient processes (such as for clipboard, drag and drop, and seamless mode) are typically initiated automatically upon the guest user's login to their desktop environment. This automatic startup is managed either by the VBoxService daemon or through desktop environment autostart entries that are configured during the VirtualBox Guest Additions installation. This ensures that the various integration features are immediately available without requiring manual user intervention after the guest OS boots, contributing to a seamless user experience.

HISTORY

VBoxClient has been an integral part of VirtualBox Guest Additions since the early versions of VirtualBox, which first saw a public release in 2007. It has continuously evolved alongside VirtualBox itself, receiving updates and new features to improve guest-host integration as the virtualization platform developed its capabilities and extended support to a wider array of operating systems and hardware configurations. Its development is closely tied to Oracle's ongoing maintenance and enhancement of the VirtualBox virtualization platform.

SEE ALSO

VBoxService(8), VBoxManage(1), VBoxGuestAdditions.run

Copied to clipboard