User_Manual_-_QVM_Documentation.txt

------------------------------------------------------------------------------
==================> 01010001 01010110 01001101 10101001 <=====================
------------------------------------------------------------------------------
        __  __   __   _,      __  _,        
       / _ \\ \ / / \/ | ___ |  \/ | __ _  _ ___  __ _  __ _  __   _ _     
      ( (_) |\ \ / |\/ ||___|| |\/ || _` || `/\ || _` || _` || -_)| `_|    
       \__\_\ \_/|_| |_|     |_| |_|\__,_||_| |_|\__,_|\__, |\___||_|  ©    
                                                       |____/              
------------------------------------------------------------------------------
================> QEMU Virtual Machine Manager v1.0.3 © 2024 <================
---------------------------------- Help/Info ---------------------------------

QEMU Virtual Machine Manager (Type2 Hypervisor) ©2025 written by P.H.

QVM-MANAGER(1)                 User Commands                   QVM-MANAGER(1)

NAME
        QVM - QVM-Manager - QEMU Virtual Machine Manager

SYNOPSIS
        qvm-manager
        qvm-manager [OPTION]
        qvm-manager [OPTION] [VALUE] 
        qvm-manager [OPTION] [VALUE] [OPTION] [VALUE]

DESCRIPTION
        qvm-manager is a command line interface (CLI) tool for managing QEMU
        virtual machines. It is an extremely simple and lightweight but powerful
        QEMU hypervisor designed to get the best performance from your host
        machine. QVM works in conjunction with Kernel-based Virtual Machine (KVM)
        to provide hardware-assisted virtualization, enhancing performance by
        allowing virtual machines to run at near-native speeds. QVM also provides
        users with a user-friendly graphical user interface (GUI) for a smoother
        virtualization experience.

OPTIONS
        --delete-iso <iso_image_name|all>
                Delete a specified ISO image or all ISO images.

        --delete-snap <vm_name> --tag <snapshot_name>
                Delete a specified snapshot.

        --delete-vm <vm_name>
                Delete a specified VM.

        --gui  
                Launch the QVM graphical user interface.

        --help, -h
                Display this help message.

        --import-iso
                Import manually downloaded ISO images.

        --list-iso
                List all local ISO images.

        --list-vm
                List all existing VMs.

        --pull-iso <list>
                Launches GUI window for downloading a specified ISO image. 
                Using the 'list' arguement outputs the list of official ISO 
                images that QVM recommendeds for downloads.

        --revert <vm_name> --tag <snapshot_name>
                Use a snapshot to revert a VM back to a previous state.

        --show-snap <vm_name>
                List all snapshots for a specified VM.

        --show-vm <vm_name>
                Show a VM's Specs.

        --snap <vm_name> --tag <snapshot_name>
                Save a snapshot of an existing VM.

        --start <vm_name>
                Start an existing VM.

        --version, -v [VALUE]
                Display version information of QVM installation.
                    -ac: Version data for QVM & its components.

EXAMPLES
        qvm-manager --pull-iso list
                List all the official ISO images that are available.

        qvm-manager --pull-iso
                Download one of the available ISO images.
        
        qvm-manager
                Starts QVM in its default CLI mode. Access the main 
                menu, explore all features and create or restart a VM.

        qvm-manager --list-vm
                List all existing virtual machines.

        qvm-manager --start myvm
                Start the virtual machine named "myvm".

        qvm-manager --snap myvm --tag backup1
                Create a snapshot of "myvm" with the tag "backup1".

        qvm-manager --show-snap myvm
                List all snapshots of the "myvm" virtual machine.

GUI TIPS & HINTS
        - VM templating can only be implemented via the GUI.
        - VMs can only be renamed via the GUI.
        - Most GUI messages are automatically sent to the CLI, providing a useful
          log of the current session's activities.
        - It is generally much easier to manage VMs via the GUI. However, using
          the CLI can be a more efficient way completing certain tasks.

AUTHOR
        Written by P.H.

COPYRIGHT
        Copyright © 2024 QVM-Manager. License GPLv3+: GNU GPL version 3 or later
        <https://gnu.org/licenses/gpl.html>.
        This is free software: you are free to change and redistribute it.
        There is NO WARRANTY, to the extent permitted by law.

QVM-Manager v1.0.3               January 2025                  QVM-MANAGER(1)