Mercurial > projects > package-update-indicator

comparison package-update-indicator-prefs.1.xml @ 1:2f04ec9e0506

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add preferences application Split settings into separate file.
author Guido Berhoerster <guido+pui@berhoerster.name>
date Fri, 08 Jun 2018 08:38:42 +0200
parents
children 3d72ca76538d
comparison
equal deleted inserted replaced
0:6884bb8130ca 1:2f04ec9e0506
1 <?xml version="1.0"?>
2 <!--
3
4 Copyright (C) 2018 Guido Berhoerster <guido+pui@berhoerster.name>
5
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:
13
14 The above copyright notice and this permission notice shall be included
15 in all copies or substantial portions of the Software.
16
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.
24
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>5 June, 2018</date>
37 </info>
38 <refmeta>
39 <refentrytitle>package-update-indicator-prefs</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-prefs</refname>
47 <refpurpose>edit preferences for package-update-indicator</refpurpose>
48 </refnamediv>
49 <refsynopsisdiv>
50 <cmdsynopsis>
51 <command>package-update-indicator-prefs</command>
52 </cmdsynopsis>
53 </refsynopsisdiv>
54 <refsect1>
55 <title>Description</title>
56 <para>The <command>package-update-indicator-prefs</command> utility can be
57 used to edit the preferences for
58 <command>package-update-indicator</command>.</para>
59 </refsect1>
60 <refsect1>
61 <title>Preferences</title>
62 <variablelist>
63 <varlistentry>
64 <term>Cache refresh interval</term>
65 <listitem>
66 <para>The interval in which package metadata is refreshed.</para>
67 </listitem>
68 </varlistentry>
69 <varlistentry>
70 <term>Update installer command</term>
71 <listitem>
72 <para>The command for installing updates.</para>
73 </listitem>
74 </varlistentry>
75 </variablelist>
76 </refsect1>
77 <refsect1>
78 <title>Exit Status</title>
79 <para>The following exit values are returned:</para>
80 <variablelist>
81 <varlistentry>
82 <term>0</term>
83 <listitem>
84 <para>Command successfully executed.</para>
85 </listitem>
86 </varlistentry>
87 <varlistentry>
88 <term>1</term>
89 <listitem>
90 <para>An unspecified error has occured.</para>
91 </listitem>
92 </varlistentry>
93 <varlistentry>
94 <term>2</term>
95 <listitem>
96 <para>Invalid command line options were specified.</para>
97 </listitem>
98 </varlistentry>
99 </variablelist>
100 </refsect1>
101 <refsect1>
102 <title>See Also</title>
103 <para><citerefentry><refentrytitle>package-update-indicator</refentrytitle>
104 <manvolnum>1</manvolnum></citerefentry></para>
105 </refsect1>
106 </refentry>