JeroenED
/
retroarch-standalone-service
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

add man page

This commit is contained in:
graysky 2021-03-13 07:31:37 -05:00
parent 13e6b6f3c9
commit c71835e5fe
2 changed files with 60 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Makefile
View File

@ -5,6 +5,7 @@ INITDIR = $(PREFIX)/lib/systemd/system
USERDIR = $(PREFIX)/lib/sysusers.d
TMPFDIR = $(PREFIX)/lib/tmpfiles.d
UDEVDIR = $(PREFIX)/lib/udev/rules.d
MANDIR = $(PREFIX)/share/man/man1
RM = rm
INSTALL = install -p
@ -30,6 +31,10 @@ install-init:
$(INSTALL_DATA) init/tmpfiles.conf "$(DESTDIR)$(TMPFDIR)/kodi-standalone.conf"
$(INSTALL_DATA) init/sysusers.conf "$(DESTDIR)$(USERDIR)/kodi-standalone.conf"
install-man:
$(INSTALL_DIR) "$(DESTDIR)$(MANDIR)"
$(INSTALL_DATA) doc/kodi.service.1 "$(DESTDIR)$(MANDIR)/kodi.service.1"
uninstall:
$(RM) "$(DESTDIR)$(INITDIR)/kodi-gbm.service"
$(RM) "$(DESTDIR)$(INITDIR)/kodi-wayland.service"
@ -37,7 +42,8 @@ uninstall:
$(RM) "$(DESTDIR)$(TMPFDIR)/kodi-standalone.conf"
$(RM) "$(DESTDIR)$(USERDIR)/kodi-standalone.conf"
$(RM) "$(DESTDIR)$(UDEVDIR)/99-kodi.rules"
$(RM) "$(DESTDIR)$(MANDIR)/kodi.service.1"
install: install-common install-init
install: install-common install-init install-man
.PHONY: install-common install-init uninstall

53
doc/kodi.service.1 Normal file
View File

@ -0,0 +1,53 @@
.\" Text automatically generated by txt2man
.TH kodi.service 1 "13 March 2021" "" ""
.SH NAME
\fBkodi-xxx.service \fP- Systemd service units to run Kodi in standalone mode without the need for a DE.
\fB
.SH DESCRIPTION
Systemd service units to run kodi in standalone mode using X11, GBM, or Wayland.
.PP
Provided services are:
.IP \(bu 3
/usr/lib/systemd/system/kodi-x11.service
.IP \(bu 3
/usr/lib/systemd/system/kodi-gbm.service
.IP \(bu 3
/usr/lib/systemd/system/kodi-wayland.service
.SH NOTES ON SYSTEM SHUTDOWN/REBOOT
Be aware that these services run Kodi in systemd's user.slice not in the system.slice. In order to have Kodi gracefully exit, the system should be called to shutdown or to reboot using the respective Kodi actions not by a call to systemctl.
.PP
This is NOT recommended:
.PP
.nf
.fam C
# systemctl reboot
.fam T
.fi
If you do reboot or shutdown via a call to systemctl, this will result in systemd killing the cg too quickly and data loss to your Kodi profile will occur. When Kodi exits cleanly, it will save GUI settings, media settings, Kodi uptime etc. In principal this is no different than data loss occurring from a user doing work when a sysadmin issues a reboot command without prior warning. While it is possible to run Kodi in systemd's system.slice instead, doing so makes it difficult to use USB mounts within Kodi and to use pulseaudio for Kodi sessions.
.SH RECOMMENDED METHODS TO SHUTDOWN/REBOOT
Here are several options:
.IP \(bu 3
Select the corresponding option under Power menu in the Kodi GUI.
.IP \(bu 3
Use the official Android/iOS remote app.
.IP \(bu 3
If a CLI option is preferred, use kodi-send (depending on the Distro, this may or may not be including in the standard kodi package) to issue a \fBShutDown\fP() or Reboot like so:
.PP
.nf
.fam C
$ kodi-send -a "Reboot"
$ kodi-send -a "ShutDown()"
.fam T
.fi
.SH PASSING ENVIRONMENT VARIABLES TO THE SERVICE
Should the need arise, one can pass environment variables to the service by creating /etc/conf.d/kodi-standalone and populating it with the needed variables.
.SH CONTRIBUTE
Users wishing to contribute to this code, should fork and send a pull request. Source is freely available on the project page linked below.
.SH BUGS
Discover a bug? Please open an issue on the project page linked below.
.SH ONLINE
Project page: https://github.com/graysky2/kodi-standalone-service
.SH AUTHOR
graysky (graysky AT archlinux DOT us)