projects/package-update-indicator

view package-update-indicator.1.xml @ 52:707e9e3deeac

Do not hardcode pkg-config

Using a macro allows passing a different executable in case of
cross-compilation.
author Helmut Grohne <helmut@subdivi.de>
date Sat Dec 12 01:08:21 2020 -0500 (11 months ago)
parents 2f04ec9e0506
children
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>19 June, 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 <para>Protocol-specific proxies specified through the corresponding
77 environment variables will be used by PackagKit when refreshing metadata if
78 the user is allowed to use the polkit action
79 <literal>org.freedesktop.packagekit.system-network-proxy-configure</literal>
80 without authentication.</para>
81 </refsect1>
82 <refsect1>
83 <title>Options</title>
84 <para>The following options are supported:</para>
85 <variablelist>
86 <varlistentry>
87 <term>
88 <option>-q</option>
89 </term>
90 <term>
91 <option>--quit</option>
92 </term>
93 <listitem>
94 <para>Quit the running instance of
95 <command>package-update-indicator</command>.</para>
96 </listitem>
97 </varlistentry>
98 <varlistentry>
99 <term>
100 <option>-V</option>
101 </term>
102 <term>
103 <option>--version</option>
104 </term>
105 <listitem>
106 <para>Print the version number and exit.</para>
107 </listitem>
108 </varlistentry>
109 </variablelist>
110 </refsect1>
111 <refsect1>
112 <title>Environment Variables</title>
113 <variablelist>
114 <varlistentry>
115 <term>http_proxy</term>
116 <listitem>
117 <para>Network proxy using the HTTP protcol.</para>
118 </listitem>
119 </varlistentry>
120 <varlistentry>
121 <term>https_proxy</term>
122 <listitem>
123 <para>Network proxy using the HTTPS protcol.</para>
124 </listitem>
125 </varlistentry>
126 <varlistentry>
127 <term>ftp_proxy</term>
128 <listitem>
129 <para>Network proxy using the FTP protcol.</para>
130 </listitem>
131 </varlistentry>
132 <varlistentry>
133 <term>socks_proxy</term>
134 <listitem>
135 <para>Network proxy using the SOCKS protcol.</para>
136 </listitem>
137 </varlistentry>
138 <varlistentry>
139 <term>no_proxy</term>
140 <listitem>
141 <para>Comma-separated list of host for which no proxy should be
142 used.</para>
143 </listitem>
144 </varlistentry>
145 </variablelist>
146 </refsect1>
147 <refsect1>
148 <title>Exit Status</title>
149 <para>The following exit values are returned:</para>
150 <variablelist>
151 <varlistentry>
152 <term>0</term>
153 <listitem>
154 <para>Command successfully executed.</para>
155 </listitem>
156 </varlistentry>
157 <varlistentry>
158 <term>1</term>
159 <listitem>
160 <para>An unspecified error has occured.</para>
161 </listitem>
162 </varlistentry>
163 <varlistentry>
164 <term>2</term>
165 <listitem>
166 <para>Invalid command line options were specified.</para>
167 </listitem>
168 </varlistentry>
169 </variablelist>
170 </refsect1>
171 <refsect1>
172 <title>See Also</title>
173 <para><citerefentry>
174 <refentrytitle>package-update-indicator-prefs</refentrytitle>
175 <manvolnum>1</manvolnum></citerefentry>,
176 <citerefentry><refentrytitle>polkit</refentrytitle>
177 <manvolnum>8</manvolnum></citerefentry></para>
178 </refsect1>
179 </refentry>