blob: 884cda1abda6075683a680ee1b7ed58687865d54 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
|
<!--
SPDX license identifier: CC-BY-SA-4.0
Copyright (C) 2015, GENIVI
This work is licensed under a Creative Commons Attribution-ShareAlike
4.0 International License.
-->
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
]>
<refentry id="legacy-app-handler">
<refmeta>
<refentrytitle>legacy-app-handler</refentrytitle>
</refmeta>
<refnamediv>
<refname>legacy-app-handler</refname>
<refpurpose>
Helper binary for registering legacy apps with the GENIVI Node State Manager
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>legacy-app-handler</command>
<arg choice="plain"><option>--unit</option> <replaceable>UNIT</replaceable></arg>
<arg choice="plain"><option>--shutdown-mode</option> <replaceable>MODE</replaceable></arg>
<arg><option>[--timeout</option> <replaceable>TIMEOUT]</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
<command>legacy-app-handler</command> is a helper binary which registers the legacy
app <arg>unit</arg> with the Node Startup Controller, which in turn registers a
shutdown client with the Node State Manager. This means that during the Node State
Manager's shutdown cycle, it will shut down the legacy app as well.
</para>
<refsect2>
<title>Arguments</title>
<variablelist>
<varlistentry>
<term><option>-u</option>, <option>--unit</option></term>
<listitem><para>
The unit file for the legacy application, e.g. cups.service.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-m</option>, <option>--shutdown-mode</option></term>
<listitem><para>
The <link linkend="NSMShutdownType">NSMShutdownType</link> of the shutdown
mode to register the app with.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-t</option>, <option>--timeout</option></term>
<listitem><para>
The amount of time in milliseconds the Node State Manager will wait until it
considers shutdown to have failed. By default its value is 1000 milliseconds.
</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<note><para>The Node State Manager does not guarantee that it will shut down
units registered with the "fast" shutdown mode in the event of a "normal"
shutdown. For units which must shut down in both shutdown cases, use the bitwise
combination of the shutdown modes, (e.g. for a normal and fast shutdown client
shutdown-mode=3).
</para></note>
</refentry>
|
