diff --git a/documentation/content/en/articles/kde-plasma-desktop/_index.adoc b/documentation/content/en/articles/kde-plasma-desktop/_index.adoc new file mode 100644 --- /dev/null +++ b/documentation/content/en/articles/kde-plasma-desktop/_index.adoc @@ -0,0 +1,237 @@ +--- +title: KDE Plasma Install Guide +description: This article explains how to install and configure KDE Plasma in FreeBSD +tags: ["KDE", "Plasma", "FreeBSD", "Desktop", "Guide"] +--- + +[[kde-plasma]] += KDE Plasma Install Guide +:doctype: article +:toc: macro +:toclevels: 1 +:icons: font +:sectnums: +:sectnumlevels: 6 +:source-highlighter: rouge +:experimental: +:images-path: articles/kde-plasma-desktop/ + +ifdef::env-beastie[] +ifdef::backend-html5[] +include::shared/authors.adoc[] +include::shared/mirrors.adoc[] +include::shared/releases.adoc[] +include::shared/attributes/attributes-{{% lang %}}.adoc[] +include::shared/{{% lang %}}/teams.adoc[] +include::shared/{{% lang %}}/mailing-lists.adoc[] +include::shared/{{% lang %}}/urls.adoc[] +:imagesdir: ../../../images/{images-path} +endif::[] +ifdef::backend-pdf,backend-epub3[] +include::../../../../shared/asciidoctor.adoc[] +endif::[] +endif::[] + +ifndef::env-beastie[] +include::../../../../../shared/asciidoctor.adoc[] +endif::[] + +''' + +toc::[] + +[[introduction]] +== Introduction + +FreeBSD, renowned for its stability, security, and performance, is a favorite among professionals and enthusiasts in the UNIX(R) world. +However, to many users, the lack of a pre-installed desktop environment may seem daunting. +KDE Plasma, a versatile and visually stunning desktop environment, offers a user-friendly interface and a plethora of features that can transform FreeBSD into a modern, fully functional desktop operating system. + +This guide aims to walk you through the process of installing and configuring KDE Plasma on FreeBSD, ensuring that even users new to the system can achieve a smooth setup. +From installing the necessary dependencies to fine-tuning your desktop environment, this article will provide all the essential steps and tips to make the experience as seamless as possible. + +[[prerequisites]] +== Prerequisites + +Before diving into the installation of KDE Plasma on FreeBSD, it's essential to ensure that your system is properly prepared. +This section outlines the key requirements and initial setup steps to get started. + +[[hardware-requirements]] +=== Hardware Requirements + +KDE Plasma is a feature-rich desktop environment that performs best on systems meeting the following minimum requirements: + +* Processor: x86_64, x86 or aarch64 +* RAM: 2 GB (4 GB or more recommended for optimal performance) +* Disk Space: At least 20 GB of free space +* Graphics Support: A GPU with support for OpenGL is recommended for graphical effects + +[[freebsd-installation]] +=== FreeBSD Installation + +To proceed with this guide, you must have a base FreeBSD system installed and configured. +If you're new to FreeBSD or need guidance on setting up the operating system, refer to the Install chapter in the FreeBSD Handbook. +The handbook provides detailed instructions for downloading, installing, and configuring a base FreeBSD system, which serves as the foundation for adding KDE Plasma. + +[[installing-kde-plasma]] +== Installing KDE Plasma + +With the prerequisites in place, you are ready to install KDE Plasma on your FreeBSD system. +This section will guide you through the necessary steps to install the required packages and configure the display manager. + +[[update-system]] +=== Update the System + +Before proceeding, ensure the base system is up-to-date executing the following command: + +[source,shell] +.... +# freebsd-update && fetch install +.... + +Also update the Ports tree executing the following command: + +[source,shell] +.... +# pkg update && pkg upgrade +.... + +[[install-kde-plasma-packages]] +=== Install KDE Plasma Packages + +FreeBSD provides two options for installing KDE Plasma, depending on your needs + +[[full-kde-plasma-installation]] +==== Full KDE Plasma Installation + +This option installs the complete KDE Plasma Desktop along with a suite of KDE applications (e.g., Dolphin file manager, Konsole terminal emulator, and others). +To install the full KDE environment, execute the following command: + +[source,shell] +.... +# pkg install kde5 sddm xorg drm-kmod xf86-input-evdev +.... + +[[minimal-kde-plasma-installation]] +==== Minimal KDE Plasma Installation + +To install lighter setup with just the core Plasma Desktop and no additional KDE applications, install the minimal environment instead: + +[source,shell] +.... +# pkg install plasma5-plasma sddm konsole xorg-minimal drm-kmod xf86-input-evdev +.... + +[TIP] +==== +In case of using an NVIDIA(R) graphics card install the package:x11/nvidia-driver[] instead package:graphics/drm-kmod[]. +==== + +[[config-services]] +=== Configure Required Services and User Settings + +To ensure that KDE Plasma and its dependencies function correctly, you need to enable two essential services D-Bus and SDDM, and configure the user account for proper graphical support. + +[[dbus]] +==== D-BUS +D-Bus is an inter-process communication (IPC) system that allows applications and system components to interact seamlessly. +It is essential for the proper functioning of KDE Plasma and many of its features. + +Enable the D-Bus service executing the following command: + +[source,shell] +.... +# sysrc dbus_enable="YES" +.... + +To improve system performance and prevent potential issues related to inter-process communication, increase the size of the message buffers for local stream communication. +These commands adjust the receive and send buffer sizes, optimizing communication between processes. +For a persistent configuration, add these lines to the [.filename]#/etc/sysctl.conf# file: + +[.programlisting] +.... +net.local.stream.recvspace=65536 +net.local.stream.sendspace=65536 +.... + +[[sddm]] +==== SDDM +The Simple Desktop Display Manager (SDDM) is a graphical login manager that launches KDE Plasma sessions. +Enabling it ensures KDE Plasma will start after boot. + +Enable the SDDM service executing the following command: + +[source,shell] +.... +# sysrc sddm_enable="YES" +.... + +[[graphics]] +==== Graphics +To ensure proper graphical support for Xorg and KDE Plasma, the current user must be a member of the video group. +This step is necessary for enabling hardware-accelerated rendering and other graphics-related functionality. + +Add your user to the video group with the following command (replacing username with your actual username): + +[source,shell] +.... +# pw groupmod video -m username +.... + +// TODO: Add info about loading the correct module (Intel, AMD, NVIDIA...) + +[[launching-kde-plasma]] +== Launching KDE Plasma + +*After rebooting your system*, the SDDM display manager should appear, presenting you with a graphical login screen. +Select your user, enter your password, and choose Plasma from the session menu (if not already selected). + +// TODO: Add image + +[[troubleshooting-tips]] +=== Troubleshooting Tips + +If the SDDM display manager does not start or you encounter a black screen. + +* Verify that the dbus and sddm services are running: ++ +[source,shell] +.... +# service dbus status +# service sddm status +.... ++ +* Check your graphics driver installation and ensure that your user is part of the `video` group +* Inspect the logs in [.filename]#/var/log# (e.g., `Xorg.0.log` and `sddm.log`) for error messages. + +[[customizing-plasma]] +== Customizing KDE Plasma + +KDE Plasma is well-known for its flexibility and customization options, allowing you to tailor the desktop to your preferences. + +[[change-appearance]] +=== Change the Appearance + +// TODO + +[[widgets-panels]] +=== Add Widgets and Panels + +// TODO + +[[performance]] +=== Optimize Performance + +// TODO + +[[conclusion]] +== Conclusion + +Congratulations! You have successfully installed and configured KDE Plasma on FreeBSD. +This powerful desktop environment, combined with the robust FreeBSD operating system, offers a highly customizable and performant platform for everyday use. + +With KDE Plasma installed, you can now explore its extensive features, from productivity applications to advanced customization options +Whether you are a developer, a power user, or someone new to FreeBSD, KDE Plasma provides a polished and versatile desktop experience. + +For further learning and advanced configurations, consult the KDE User Documentation and the FreeBSD Handbook. +Enjoy your journey with KDE Plasma on FreeBSD!