plasma/print-manager/README.md

0001 # Print Manager
0002
0003 Print Manager is a small, relatively self-contained set of components integrated with Plasma System Settings for managing CUPS printer configurations.
0004
0005
0006 ## Components
0007
0008 * Set of legacy stand-alone apps:
0009   * kde-add-printer (for adding printers and printer groups)
0010   * configure-printer (for configuring current printers and printer groups)
0011   * kde-print-queue (for managing printer job queues)
0012
0013 * System tray plasmoid that provides quick access to printers and print job status
0014
0015 * KDed module for new device notification
0016
0017 * KCM module
0018
0019 * KCups Library that provides an interface to the CUPS api as well as a few models that are used by the legacy apps, the KCM and the plasmoid
0020
0021
0022 ## External Dependencies
0023
0024 The legacy apps, the KDed module and the KCM make use of the interfaces provided by the [OpenPrinting system-config-printer project.](https://github.com/OpenPrinting/system-config-printer)  These interfaces provide the following features used by print-manager:
0025
0026 * New device notifications
0027 * Device discovery and grouping
0028 * Recommended driver discovery
0029
0030 While not required it is recommended that this component is installed for print-manager to provide the best results.
0031
0032
0033 ## General
0034
0035 For Plasma6, the KCM will provide the primary means to add/configure printers and printer groups.  In addition, some of the basic CUPS print server options can be configured.  There are some limitations to KCM add-printer features that mirror the legacy apps:
0036
0037 * No support for Windows printers using samba
0038 * No support for auto print queue identification for older connection schemes (LPD/SOCKET)
0039
0040 While the add-printer app is available, the KCM is the primary means to add printers and printer groups and provides no direct access to the add-printer app.
0041
0042 The KCM is also missing the following features that are present in the configure-printer app:
0043
0044 * Media settings (paper size, mode, type, quality, etc)
0045 * Banners, Policies and Allowed Users
0046
0047 These features are available via the configure-printer app, accessed from the KCM and the plasmoid as a configure option.  In a future release, these features will be integrated with the KCM.
0048
0049 The kde-print-queue legacy app is provided as the primary means to manage established print job queues.  It remains directly accessible from both the KCM and the plasmoid.
0050
0051
0052 ## Building
0053
0054 The easiest way to make changes and test print-manager during development is to [build it with kdesrc-build](https://community.kde.org/Get_Involved/development/Build_software_with_kdesrc-build).
0055
0056 When building print-manager manually, keep in mind that the Qt5 and Qt6 versions will be built by default. To control which versions are built, use the `BUILD_QT5` and `BUILD_QT6` CMake variables.
0057
0058
0059 ## Contributing
0060
0061 Like other projects in the KDE ecosystem, contributions are welcome from all. This repository is managed in [KDE Invent](https://invent.kde.org/plasma/print-manager), our GitLab instance.
0062
0063 * Want to contribute code? See the [GitLab wiki page](https://community.kde.org/Infrastructure/GitLab) for a tutorial on how to send a merge request.
0064 * Reporting a bug? Please submit it on the [KDE Bugtracking System](https://bugs.kde.org/enter_bug.cgi?format=guided&product=print-manager). Please do not use the Issues
0065 tab to report bugs.
0066 * Is there a part of print-manager that's not translated? See the [Getting Involved in Translation wiki page](https://community.kde.org/Get_Involved/translation) to see how
0067 you can help translate!
0068
0069 If you get stuck or need help with anything at all, head over to the [KDE New Contributors room](https://go.kde.org/matrix/#/#kde-welcome:kde.org) on Matrix. For questions about print-manager, please ask in the [KDE Development room](https://go.kde.org/matrix/#/#kde-devel:kde.org). See [Matrix](https://community.kde.org/Matrix) for more details.