LinuxCommandLibrary

kpackagetool5

Install, uninstall, and manage KDE packages

TLDR

List all known package types that can be installed

$ kpackagetool5 --list-types
copy

Install the package from a directory
$ kpackagetool5 [[-t|--type]] [package_type] [[-i|--install]] [path/to/directory]
copy

Update installed package from a directory
$ kpackagetool5 [[-t|--type]] [package_type] [[-u|--upgrade]] [path/to/directory]
copy

List installed plasmoids (--global for all users)
$ kpackagetool5 [[-t|--type]] Plasma/Applet [[-l|--list]] [[-g|--global]]
copy

Remove a plasmoid by name
$ kpackagetool5 [[-t|--type]] Plasma/Applet [[-r|--remove]] "[name]"
copy

SYNOPSIS

kpackagetool5 [options] [package_file|package_directory]

PARAMETERS

--help
    Show help options

--help-all
    Show all help options

--help-kde
    Show KDE specific options

-v, --version
    Display version information

--author author
    Package author

--category category
    Package category

--description description
    Package description

--email email
    Package email

--icon icon
    Package icon

--license license
    Package license

--name name
    Package name

--packager packager
    Name of the packager

--screenshot screenshot
    Path to screenshot of package

--url url
    URL for more info on the package

--version version
    Package version

--install package_file|package_directory
    Install the specified package.

--uninstall package_name
    Uninstall the specified package.

--list
    List installed packages.

--pack directory
    Create a package from a directory.

--unpack package_file destination_directory
    Unpack a package to a destination directory.

--metadata package_file
    Display package metadata.

--type package_type
    Specify the package type (e.g., Plasmoid, Theme).

DESCRIPTION

kpackagetool5 is a command-line tool for managing KDE Plasma packages. These packages, identified with extensions like `.kpackage`, `.plasmoid`, `.theme`, etc., allow for easy distribution and installation of various Plasma components such as widgets (plasmoids), themes, global themes, KRunner plugins, and more.

It provides functionalities to install, uninstall, list, and query information about these packages. This tool is designed for both end-users and developers who need to manage their KDE Plasma packages from the command line, especially in automated scripts or environments where a GUI is not available. It integrates with KDE's settings and resources to ensure packages are properly integrated into the Plasma environment after installation.

CAVEATS

This tool requires KDE Plasma libraries to be installed. Package names used with the `--uninstall` option must match the exact name of the installed package, which can be obtained using the `--list` option. Using the incorrect package type with `--type` may cause unexpected behavior. The tool relies on proper configuration of KDE for resource management.

PACKAGE TYPES

Common package types include Plasmoid (widgets), Theme (Plasma themes), GlobalTheme (complete desktop themes), KRunner (KRunner plugins), and others. Use the `--type` flag to specify the package type during installation or creation.

METADATA

Package metadata provides information about the package, such as its name, version, author, description, and license. This information is used by KDE Plasma to manage and display the package in the system settings. Use the `--metadata` flag to view metadata of a specific package.

HISTORY

kpackagetool5 is part of the KDE Frameworks 5. It was developed to provide a command-line interface for managing KDE Plasma packages in a consistent manner across different distributions and environments. It builds upon previous iterations of package management tools within KDE, incorporating improved resource handling and integration with the Plasma desktop environment.

SEE ALSO

Copied to clipboard