projects/package-update-indicator

view package-update-indicator.1.xml @ 0:6884bb8130ca

Initial revision
author Guido Berhoerster <guido+pui@berhoerster.name>
date Sun May 20 11:32:57 2018 +0200 (2018-05-20)
parents
children 2f04ec9e0506
line source
1 <?xml version="1.0"?>
2 <!--
4 Copyright (C) 2018 Guido Berhoerster <guido+pui@berhoerster.name>
6 Permission is hereby granted, free of charge, to any person obtaining
7 a copy of this software and associated documentation files (the
8 "Software"), to deal in the Software without restriction, including
9 without limitation the rights to use, copy, modify, merge, publish,
10 distribute, sublicense, and/or sell copies of the Software, and to
11 permit persons to whom the Software is furnished to do so, subject to
12 the following conditions:
14 The above copyright notice and this permission notice shall be included
15 in all copies or substantial portions of the Software.
17 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
18 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
19 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
20 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
21 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
22 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
23 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
25 -->
26 <refentry xmlns="http://docbook.org/ns/docbook" xml:lang="en">
27 <info>
28 <author>
29 <personname>
30 <firstname>Guido</firstname>
31 <surname>Berhoerster</surname>
32 </personname>
33 <email>guido+pui@berhoerster.name</email>
34 <personblurb/>
35 </author>
36 <date>25 May, 2018</date>
37 </info>
38 <refmeta>
39 <refentrytitle>package-update-indicator</refentrytitle>
40 <manvolnum>1</manvolnum>
41 <refmiscinfo class="source"/>
42 <refmiscinfo class="version"/>
43 <refmiscinfo class="manual">User Commands</refmiscinfo>
44 </refmeta>
45 <refnamediv>
46 <refname>package-update-indicator</refname>
47 <refpurpose>notify about available software updates</refpurpose>
48 </refnamediv>
49 <refsynopsisdiv>
50 <cmdsynopsis>
51 <command>package-update-indicator</command>
52 <group>
53 <arg choice="plain">
54 <option>-q</option>
55 </arg>
56 <arg choice="plain">
57 <option>--quit</option>
58 </arg>
59 </group>
60 <group>
61 <arg choice="plain">
62 <option>-V</option>
63 </arg>
64 <arg choice="plain">
65 <option>--version</option>
66 </arg>
67 </group>
68 </cmdsynopsis>
69 </refsynopsisdiv>
70 <refsect1>
71 <title>Description</title>
72 <para>The <command>package-update-indicator</command> utility regularly
73 checks for software updates and notifies the user about available updates
74 using desktop notifications and either a status notifier icon or a system
75 tray icon.</para>
76 </refsect1>
77 <refsect1>
78 <title>Options</title>
79 <para>The following options are supported:</para>
80 <variablelist>
81 <varlistentry>
82 <term>
83 <option>-q</option>
84 </term>
85 <term>
86 <option>--quit</option>
87 </term>
88 <listitem>
89 <para>Quit the running instance of
90 <command>package-update-indicator</command>.</para>
91 </listitem>
92 </varlistentry>
93 <varlistentry>
94 <term>
95 <option>-V</option>
96 </term>
97 <term>
98 <option>--version</option>
99 </term>
100 <listitem>
101 <para>Print the version number and exit.</para>
102 </listitem>
103 </varlistentry>
104 </variablelist>
105 </refsect1>
106 <refsect1>
107 <title>Exit Status</title>
108 <para>The following exit values are returned:</para>
109 <variablelist>
110 <varlistentry>
111 <term>0</term>
112 <listitem>
113 <para>Command successfully executed.</para>
114 </listitem>
115 </varlistentry>
116 <varlistentry>
117 <term>1</term>
118 <listitem>
119 <para>An unspecified error has occured.</para>
120 </listitem>
121 </varlistentry>
122 <varlistentry>
123 <term>2</term>
124 <listitem>
125 <para>Invalid command line options were specified.</para>
126 </listitem>
127 </varlistentry>
128 </variablelist>
129 </refsect1>
130 </refentry>