alexk / rpms / rpm

Forked from rpms/rpm 2 years ago
Clone
5523e9
From 4a2c311bfe21eda9472f52795db1c9f883e6c194 Mon Sep 17 00:00:00 2001
5523e9
From: Florian Festi <ffesti@redhat.com>
5523e9
Date: Mon, 4 Jul 2016 17:45:33 +0200
5523e9
Subject: [PATCH] Add man page for systemd-inhibit plugin
5523e9
5523e9
---
5523e9
 doc/Makefile.am                  |  1 +
5523e9
 doc/rpm-plugin-systemd-inhibit.8 | 36 ++++++++++++++++++++++++++++++++++++
5523e9
 2 files changed, 37 insertions(+)
5523e9
 create mode 100644 doc/rpm-plugin-systemd-inhibit.8
5523e9
5523e9
diff --git a/doc/Makefile.am b/doc/Makefile.am
5523e9
index f7940b9..d2f520d 100644
5523e9
--- a/doc/Makefile.am
5523e9
+++ b/doc/Makefile.am
5523e9
@@ -9,6 +9,7 @@ EXTRA_DIST += $(man_man1_DATA)
5523e9
 man_man8dir = $(mandir)/man8
5523e9
 man_man8_DATA = rpm.8 rpmbuild.8 rpmdeps.8 rpmgraph.8 rpm2cpio.8
5523e9
 man_man8_DATA += rpmdb.8 rpmkeys.8 rpmsign.8 rpmspec.8
5523e9
+man_man8_DATA += rpm-plugin-systemd-inhibit.8
5523e9
 EXTRA_DIST += $(man_man8_DATA)
5523e9
 
5523e9
 man_fr_man8dir = $(mandir)/fr/man8
5523e9
diff --git a/doc/rpm-plugin-systemd-inhibit.8 b/doc/rpm-plugin-systemd-inhibit.8
5523e9
new file mode 100644
5523e9
index 0000000..b49e8ef
5523e9
--- /dev/null
5523e9
+++ b/doc/rpm-plugin-systemd-inhibit.8
5523e9
@@ -0,0 +1,36 @@
5523e9
+.TH "RPM-SYSTEMD-INHIBIT" "8" "14 Apr 2016" "Red Hat, Inc."
5523e9
+.SH NAME
5523e9
+rpm-plugin-systemd-inhibit \- Plugin for the RPM Package Manager
5523e9
+
5523e9
+.SH Description
5523e9
+
5523e9
+This plugin for RPM prevents the system to enter shutdown, sleep or idle
5523e9
+mode while there is a rpm transaction running to prevent system corruption
5523e9
+that can occur if the transaction is interrupted by a reboot.
5523e9
+
5523e9
+This is achieved by using the inhibit DBUS interface of systemd. The call is
5523e9
+roughly equivalent to executing
5523e9
+
5523e9
+\fBsystemd-inhibit --mode=block --what=idle:sleep:shutdown --who=RPM --why="Transaction running"\fR 
5523e9
+
5523e9
+See \fBsystemd-inhibit(1)\fR for the details of this mechanism. 
5523e9
+
5523e9
+It is strongly advised to have the plugin installed on all systemd
5523e9
+based systems.
5523e9
+
5523e9
+.SH Prerequisites
5523e9
+
5523e9
+For the plugin to work systemd has to be used as init system and
5523e9
+though the DBUS system bus must be available. If the plugin cannot access the
5523e9
+interface it gives a warning but does not stop the transaction.
5523e9
+
5523e9
+.SH Configuration
5523e9
+
5523e9
+The plugin currently does not have any configuration option other than
5523e9
+turning it on and off. It can be disabled by commenting out the
5523e9
+\fI%__transaction_systemd_inhibit\fR macro in main macros file
5523e9
+(typically located at \fI/usr/lib/rpm/macros\fR) or otherwise change
5523e9
+the value of the macro.
5523e9
+
5523e9
+Another option is to remove the plugin from the system if it is
5523e9
+packaged in its own sub package.
5523e9
-- 
5523e9
2.5.5
5523e9