From 0513f0d83571ff2b3ad18d6413e3d7ff2c806cbe Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ole-Andr=C3=A9=20Rodlie?= Date: Thu, 8 Feb 2024 09:33:26 +0100 Subject: [PATCH] Update docs --- docs/README.md | 81 ++++++++++++--------------------- share/powerkit.1 | 115 ++++++++++++++++------------------------------- 2 files changed, 67 insertions(+), 129 deletions(-) diff --git a/docs/README.md b/docs/README.md index 4af155f..834c28f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,6 @@ # NAME -*powerkit* - desktop independent Linux power manager +*powerkit* - Desktop independent Linux power manager # SYNOPSIS @@ -8,16 +8,20 @@ powerkit *`[--config]`* # DESCRIPTION -powerkit is an desktop independent Linux power manager for alternative X11 desktop environments and window managers. +Desktop independent Linux power manager for alternative X11 desktop environments and window managers. - * Implements *``org.freedesktop.ScreenSaver``* service and screen saver + * Implements *``org.freedesktop.ScreenSaver``* service * Implements *``org.freedesktop.PowerManagement.Inhibit``* service - * Automatically suspend on idle - * Automatically suspend or shutdown on critical battery - * Inhibit lid action if external monitor connected + * Automatic actions on lid, idle and low battery + * Sleep + * Hibernate + * HybridSleep + * Suspend then Hibernate + * Shutdown + * Screen saver support + * Screen lid support * Screen locking support * Screen backlight support - * RTC wake support * Notification support (can use *``org.freedesktop.Notifications``* if available) # USAGE @@ -31,7 +35,7 @@ powerkit should be started during the X11 user session. Consult the documentatio ## CONFIGURATION -The most common options are available directly from the system tray icon, for more advanced options open *``Settings``* from the system tray menu or run *``powerkit --config``*. You should also be able to lauch the powerkit settings from your desktop application menu (if available). +Settings are available directly from the system tray icon or run *``powerkit --config``*. You should also be able to lauch the powerkit settings from your desktop application menu (if available). ## SCREEN SAVER @@ -98,46 +102,24 @@ First make sure you have the required dependencies installed, then review the mo * *``CMAKE_INSTALL_PREFIX=``* - Install target. *``/usr``* recommended. * *``CMAKE_BUILD_TYPE=``* - Build type. *``Release``* recommended - * *``SERVICE_USER=``* - powerkitd owner, needs write access to /sys. Usually the *``root``* user. - * *``SERVICE_GROUP=``* - Group that can access the powerkitd service, this should be any desktop user. Consult your system documentation for the preferred user group. Now configure powerkit with CMake and build (*example for packaging purposes*). ``` -cmake -DCMAKE_INSTALL_PREFIX=/usr -DSERVICE_GROUP=plugdev -DCMAKE_BUILD_TYPE=Release .. -make -make DESTDIR= install +cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Release .. +make -j4 ``` + +``` +make DESTDIR= install ``` -pkg -|-- etc -| |-- dbus-1 -| | `-- system.d -| | `-- org.freedesktop.PowerKit.conf -| `-- xdg -| `-- autostart -| `-- powerkit.desktop -`-- usr - |-- bin - | `-- powerkit - |-- libexec - | `-- powerkitd - `-- share - |-- applications - | `-- powerkit.desktop - |-- dbus-1 - | `-- system-services - | `-- org.freedesktop.PowerKit.service - |-- doc - | `-- powerkit-VERSION - | |-- LICENSE - | `-- README.md - `-- man - |-- man1 - | `-- powerkit.1 - `-- man8 - `-- powerkitd.8 +or +``` +cpack -G DEB +``` +``` +cpack -G RPM ``` # CHANGELOG @@ -145,20 +127,13 @@ pkg ## 2.0.0 (TBA) * Recommended locker is ``xsecurelock`` - * Improved support for logind + * Added support for "modern" logind * Removed support for ConsoleKit * Removed support for XScreenSaver - * Added screen saver in powerkit - * Easier to use (minimal setup) + * Added basic screen saver + * Easier to use (minimal/no setup) * New UI - * RTC wake alarm support (not used for anything yet) - * Hibernate computer while suspended for X amount of time - * CPU frequency scaling and thermal support (not used for anything yet) - * Intel PState - * powerkitd - * Service for unprivileged users (needed for CPU/RTC/brightness) - -May change at any time during development. + * Major code changes # OPTIONS @@ -172,7 +147,7 @@ May change at any time during development. # SEE ALSO -**``xsecurelock``**(1), **``UPower``**(7), **``powerkitd``**(8) +**``xsecurelock``**(1), **``UPower``**(7) # BUGS diff --git a/share/powerkit.1 b/share/powerkit.1 index 82dc813..9fac518 100644 --- a/share/powerkit.1 +++ b/share/powerkit.1 @@ -2,31 +2,40 @@ .\" .TH "POWERKIT" "1" "February 2024" "Version 2.0.0" "PowerKit Documentation" .SH NAME -\f[I]powerkit\f[R] - desktop independent Linux power manager +\f[I]powerkit\f[R] - Desktop independent Linux power manager .SH SYNOPSIS powerkit \f[I]\f[CI][--config]\f[I]\f[R] .SH DESCRIPTION -powerkit is an desktop independent Linux power manager for alternative -X11 desktop environments and window managers. +Desktop independent Linux power manager for alternative X11 desktop +environments and window managers. .IP \[bu] 2 -Implements \f[I]\f[CI]org.freedesktop.ScreenSaver\f[I]\f[R] service and -screen saver +Implements \f[I]\f[CI]org.freedesktop.ScreenSaver\f[I]\f[R] service .IP \[bu] 2 Implements \f[I]\f[CI]org.freedesktop.PowerManagement.Inhibit\f[I]\f[R] service .IP \[bu] 2 -Automatically suspend on idle +Automatic actions on lid, idle and low battery +.RS 2 +.IP \[bu] 2 +Sleep +.IP \[bu] 2 +Hibernate +.IP \[bu] 2 +HybridSleep .IP \[bu] 2 -Automatically suspend or shutdown on critical battery +Suspend then Hibernate .IP \[bu] 2 -Inhibit lid action if external monitor connected +Shutdown +.RE +.IP \[bu] 2 +Screen saver support +.IP \[bu] 2 +Screen lid support .IP \[bu] 2 Screen locking support .IP \[bu] 2 Screen backlight support .IP \[bu] 2 -RTC wake support -.IP \[bu] 2 Notification support (can use \f[I]\f[CI]org.freedesktop.Notifications\f[I]\f[R] if available) .SH USAGE @@ -43,9 +52,8 @@ In \f[I]Openbox\f[R] add \f[I]\f[CI]powerkit &\f[I]\f[R] to the \f[B]Do use powerkit if your desktop environment or window manager already has a power manager or screen saver service running.\f[R] .SS CONFIGURATION -The most common options are available directly from the system tray -icon, for more advanced options open \f[I]\f[CI]Settings\f[I]\f[R] from -the system tray menu or run \f[I]\f[CI]powerkit --config\f[I]\f[R]. +Settings are available directly from the system tray icon or run +\f[I]\f[CI]powerkit --config\f[I]\f[R]. You should also be able to lauch the powerkit settings from your desktop application menu (if available). .SS SCREEN SAVER @@ -131,90 +139,46 @@ review the most common build options: .IP \[bu] 2 \f[I]\f[CI]CMAKE_BUILD_TYPE=\f[I]\f[R] - Build type. \f[I]\f[CI]Release\f[I]\f[R] recommended -.IP \[bu] 2 -\f[I]\f[CI]SERVICE_USER=\f[I]\f[R] - powerkitd owner, needs write -access to /sys. -Usually the \f[I]\f[CI]root\f[I]\f[R] user. -.IP \[bu] 2 -\f[I]\f[CI]SERVICE_GROUP=\f[I]\f[R] - Group that can access the -powerkitd service, this should be any desktop user. -Consult your system documentation for the preferred user group. .PP Now configure powerkit with CMake and build (\f[I]example for packaging purposes\f[R]). .IP .EX -cmake -DCMAKE_INSTALL_PREFIX=/usr -DSERVICE_GROUP=plugdev -DCMAKE_BUILD_TYPE=Release .. -make -make DESTDIR= install +cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Release .. +make -j4 .EE .IP .EX -pkg -|-- etc -| |-- dbus-1 -| | \[ga]-- system.d -| | \[ga]-- org.freedesktop.PowerKit.conf -| \[ga]-- xdg -| \[ga]-- autostart -| \[ga]-- powerkit.desktop -\[ga]-- usr - |-- bin - | \[ga]-- powerkit - |-- libexec - | \[ga]-- powerkitd - \[ga]-- share - |-- applications - | \[ga]-- powerkit.desktop - |-- dbus-1 - | \[ga]-- system-services - | \[ga]-- org.freedesktop.PowerKit.service - |-- doc - | \[ga]-- powerkit-VERSION - | |-- LICENSE - | \[ga]-- README.md - \[ga]-- man - |-- man1 - | \[ga]-- powerkit.1 - \[ga]-- man8 - \[ga]-- powerkitd.8 +make DESTDIR= install +.EE +.PP +or +.IP +.EX +cpack -G DEB +.EE +.IP +.EX +cpack -G RPM .EE .SH CHANGELOG .SS 2.0.0 (TBA) .IP \[bu] 2 Recommended locker is \f[CR]xsecurelock\f[R] .IP \[bu] 2 -Improved support for logind +Added support for \[lq]modern\[rq] logind .IP \[bu] 2 Removed support for ConsoleKit .IP \[bu] 2 Removed support for XScreenSaver .IP \[bu] 2 -Added screen saver in powerkit +Added basic screen saver .IP \[bu] 2 -Easier to use (minimal setup) +Easier to use (minimal/no setup) .IP \[bu] 2 New UI .IP \[bu] 2 -RTC wake alarm support (not used for anything yet) -.RS 2 -.IP \[bu] 2 -Hibernate computer while suspended for X amount of time -.RE -.IP \[bu] 2 -CPU frequency scaling and thermal support (not used for anything yet) -.RS 2 -.IP \[bu] 2 -Intel PState -.RE -.IP \[bu] 2 -powerkitd -.RS 2 -.IP \[bu] 2 -Service for unprivileged users (needed for CPU/RTC/brightness) -.RE -.PP -May change at any time during development. +Major code changes .SH OPTIONS .TP \f[I]\f[CI]--config\f[I]\f[R] @@ -224,8 +188,7 @@ Launch configuration. \f[I]\f[CI]\[ti]/.config/powerkit/powerkit.conf\f[I]\f[R] Per user configuration file. .SH SEE ALSO -\f[B]\f[CB]xsecurelock\f[B]\f[R](1), \f[B]\f[CB]UPower\f[B]\f[R](7), -\f[B]\f[CB]powerkitd\f[B]\f[R](8) +\f[B]\f[CB]xsecurelock\f[B]\f[R](1), \f[B]\f[CB]UPower\f[B]\f[R](7) .SH BUGS See \f[B]https://github.com/rodlie/powerkit/issues\f[R]. .SH COPYRIGHT