Mercurial > projects > pk-update-icon

comparison pk-update-icon.1.xml @ 37:7e44a0a8dc2c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Convert the manpage to DocBook V5.0
author Guido Berhoerster <gber@opensuse.org>
date Fri, 07 Feb 2014 18:10:41 +0100
parents
children aa5d3752091d
comparison
equal deleted inserted replaced
36:82a31628a26d 37:7e44a0a8dc2c
1 <?xml version="1.0"?>
2 <!--
3
4 Copyright (C) 2014 Guido Berhoerster <gber@opensuse.org>
5
6 Licensed under the GNU General Public License Version 2
7
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
12
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
17
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21
22 -->
23 <refentry xmlns="http://docbook.org/ns/docbook" xml:lang="en">
24 <info>
25 <author>
26 <personname>
27 <firstname>Guido</firstname>
28 <surname>Berhoerster</surname>
29 </personname>
30 <email>gber@opensuse.org</email>
31 <personblurb/>
32 </author>
33 <date>7 February, 2014</date>
34 </info>
35 <refmeta>
36 <refentrytitle>pk-update-icon</refentrytitle>
37 <manvolnum>1</manvolnum>
38 <refmiscinfo class="source"/>
39 <refmiscinfo class="version"/>
40 <refmiscinfo class="manual">User Commands</refmiscinfo>
41 </refmeta>
42 <refnamediv>
43 <refname>pk-update-icon</refname>
44 <refpurpose>display notifications about software updates</refpurpose>
45 </refnamediv>
46 <refsynopsisdiv>
47 <cmdsynopsis>
48 <command>pk-update-icon</command>
49 <group>
50 <arg choice="plain">
51 <option>-h</option>
52 </arg>
53 <arg choice="plain">
54 <option>-?</option>
55 </arg>
56 <arg choice="plain">
57 <option>--help</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 <group>
69 <arg choice="plain">
70 <option>-d</option>
71 <replaceable>delay</replaceable>
72 </arg>
73 <arg choice="plain">
74 <option>--delay</option>
75 <replaceable>delay</replaceable>
76 </arg>
77 </group>
78 <group >
79 <arg choice="plain">
80 <option>-i</option>
81 <replaceable>interval</replaceable>
82 </arg>
83 <arg choice="plain">
84 <option>--interval</option>
85 <replaceable>interval</replaceable>
86 </arg>
87 </group>
88 </cmdsynopsis>
89 </refsynopsisdiv>
90 <refsect1>
91 <title>Description</title>
92 <para><command>pk-update-icon</command> displays notifications and an
93 icon in the tray area of the panel when package updates are
94 available.</para>
95 </refsect1>
96 <refsect1>
97 <title>Options</title>
98 <para>The following options are supported:</para>
99 <variablelist>
100 <varlistentry>
101 <term>
102 <option>-d</option>
103 <replaceable>delay</replaceable>
104 </term>
105 <term>
106 <option>--delay</option>
107 <replaceable>delay</replaceable>
108 </term>
109 <listitem>
110 <para>Set the delay in seconds before the first check for
111 updates.</para>
112 </listitem>
113 </varlistentry>
114 <varlistentry>
115 <term>
116 <option>-h</option>
117 </term>
118 <term>
119 <option>-?</option>
120 </term>
121 <term>
122 <option>--help</option>
123 </term>
124 <listitem>
125 <para>Print a summary of all command line options and exit.</para>
126 </listitem>
127 </varlistentry>
128 <varlistentry>
129 <term>
130 <option>-i</option>
131 <replaceable>interval</replaceable>
132 </term>
133 <term>
134 <option>--interval</option>
135 <replaceable>interval</replaceable>
136 </term>
137 <listitem>
138 <para>Set the interval in seconds between checks for updates.</para>
139 </listitem>
140 </varlistentry>
141 <varlistentry>
142 <term>
143 <option>-v</option>
144 </term>
145 <term>
146 <option>--version</option>
147 </term>
148 <listitem>
149 <para>Print the version number and exit.</para>
150 </listitem>
151 </varlistentry>
152 </variablelist>
153 </refsect1>
154 <refsect1>
155 <title>Exit Status</title>
156 <para>The following exit values are returned:</para>
157 <variablelist>
158 <varlistentry>
159 <term>0</term>
160 <listitem>
161 <para>Command successfully executed.</para>
162 </listitem>
163 </varlistentry>
164 <varlistentry>
165 <term>&gt; 0</term>
166 <listitem>
167 <para>An error has occured.</para>
168 </listitem>
169 </varlistentry>
170 </variablelist>
171 </refsect1>
172 </refentry>