Mercurial > projects > pk-update-icon

annotate pk-update-icon.1 @ 16:7af115023d5a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
add CLI, make delay and interval configurable
author Guido Berhoerster <guido@berhoerster.name>
date Thu, 20 Oct 2011 12:06:42 +0200
parents fe1a21ab4f69
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
10
fe1a21ab4f69 add a man page
Guido Berhoerster <guido@berhoerster.name>
parents:
diff changeset
1 .\" Copyright (C) 2011 Guido Berhoerster <gber@opensuse.org>
fe1a21ab4f69 add a man page
Guido Berhoerster <guido@berhoerster.name>
parents:
diff changeset
2 .\"
fe1a21ab4f69 add a man page
Guido Berhoerster <guido@berhoerster.name>
parents:
diff changeset
3 .\" Licensed under the GNU General Public License Version 2
fe1a21ab4f69 add a man page
Guido Berhoerster <guido@berhoerster.name>
parents:
diff changeset
4 .\"
fe1a21ab4f69 add a man page
Guido Berhoerster <guido@berhoerster.name>
parents:
diff changeset
5 .\" This program is free software; you can redistribute it and/or modify
fe1a21ab4f69 add a man page
Guido Berhoerster <guido@berhoerster.name>
parents:
diff changeset
6 .\" it under the terms of the GNU General Public License as published by
fe1a21ab4f69 add a man page
Guido Berhoerster <guido@berhoerster.name>
parents:
diff changeset
7 .\" the Free Software Foundation; either version 2 of the License, or
fe1a21ab4f69 add a man page
Guido Berhoerster <guido@berhoerster.name>
parents:
diff changeset
8 .\" (at your option) any later version.
fe1a21ab4f69 add a man page
Guido Berhoerster <guido@berhoerster.name>
parents:
diff changeset
9 .\"
fe1a21ab4f69 add a man page
Guido Berhoerster <guido@berhoerster.name>
parents:
diff changeset
10 .\" This program is distributed in the hope that it will be useful,
fe1a21ab4f69 add a man page
Guido Berhoerster <guido@berhoerster.name>
parents:
diff changeset
11 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
fe1a21ab4f69 add a man page
Guido Berhoerster <guido@berhoerster.name>
parents:
diff changeset
12 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
fe1a21ab4f69 add a man page
Guido Berhoerster <guido@berhoerster.name>
parents:
diff changeset
13 .\" GNU General Public License for more details.
fe1a21ab4f69 add a man page
Guido Berhoerster <guido@berhoerster.name>
parents:
diff changeset
14 .\"
fe1a21ab4f69 add a man page
Guido Berhoerster <guido@berhoerster.name>
parents:
diff changeset
15 .\" You should have received a copy of the GNU General Public License
fe1a21ab4f69 add a man page
Guido Berhoerster <guido@berhoerster.name>
parents:
diff changeset
16 .\" along with this program; if not, write to the Free Software
fe1a21ab4f69 add a man page
Guido Berhoerster <guido@berhoerster.name>
parents:
diff changeset
17 .\" Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
fe1a21ab4f69 add a man page
Guido Berhoerster <guido@berhoerster.name>
parents:
diff changeset
18 .\"
16
7af115023d5a add CLI, make delay and interval configurable
Guido Berhoerster <guido@berhoerster.name>
parents: 10
diff changeset
19 .TH PK\-UPDATE\-ICON 1 "20 Oct 2011"
10
fe1a21ab4f69 add a man page
Guido Berhoerster <guido@berhoerster.name>
parents:
diff changeset
20 .SH NAME
16
7af115023d5a add CLI, make delay and interval configurable
Guido Berhoerster <guido@berhoerster.name>
parents: 10
diff changeset
21 pk\-update\-icon \- display notifications about software updates
10
fe1a21ab4f69 add a man page
Guido Berhoerster <guido@berhoerster.name>
parents:
diff changeset
22 .SH SYNOPSIS
16
7af115023d5a add CLI, make delay and interval configurable
Guido Berhoerster <guido@berhoerster.name>
parents: 10
diff changeset
23 \fBpk\-update\-icon\fR
7af115023d5a add CLI, make delay and interval configurable
Guido Berhoerster <guido@berhoerster.name>
parents: 10
diff changeset
24 [\fB\-hv?\fR]
7af115023d5a add CLI, make delay and interval configurable
Guido Berhoerster <guido@berhoerster.name>
parents: 10
diff changeset
25 [\fB\-d\fR \fIdelay\fR | \fB\-\-delay\fR=\fIdelay\fR]
7af115023d5a add CLI, make delay and interval configurable
Guido Berhoerster <guido@berhoerster.name>
parents: 10
diff changeset
26 [\fB\-i\fR \fIinterval\fR | \fB\-\-interval\fR=\fIinterval\fR]
10
fe1a21ab4f69 add a man page
Guido Berhoerster <guido@berhoerster.name>
parents:
diff changeset
27 .SH DESCRIPTION
fe1a21ab4f69 add a man page
Guido Berhoerster <guido@berhoerster.name>
parents:
diff changeset
28 \fBpk\-update\-icon\fR displays notifications and an icon in the tray area of
fe1a21ab4f69 add a man page
Guido Berhoerster <guido@berhoerster.name>
parents:
diff changeset
29 the panel when package updates are available.
16
7af115023d5a add CLI, make delay and interval configurable
Guido Berhoerster <guido@berhoerster.name>
parents: 10
diff changeset
30 .SH OPTIONS
7af115023d5a add CLI, make delay and interval configurable
Guido Berhoerster <guido@berhoerster.name>
parents: 10
diff changeset
31 The following options are supported:
7af115023d5a add CLI, make delay and interval configurable
Guido Berhoerster <guido@berhoerster.name>
parents: 10
diff changeset
32 .TP
7af115023d5a add CLI, make delay and interval configurable
Guido Berhoerster <guido@berhoerster.name>
parents: 10
diff changeset
33 .BR \-d ", " \-\-delay =\fIdelay\fR
7af115023d5a add CLI, make delay and interval configurable
Guido Berhoerster <guido@berhoerster.name>
parents: 10
diff changeset
34 Set the delay in seconds before the first check for updates.
7af115023d5a add CLI, make delay and interval configurable
Guido Berhoerster <guido@berhoerster.name>
parents: 10
diff changeset
35 .TP
7af115023d5a add CLI, make delay and interval configurable
Guido Berhoerster <guido@berhoerster.name>
parents: 10
diff changeset
36 .BR \-h ", " \-? ", " \-\-help
7af115023d5a add CLI, make delay and interval configurable
Guido Berhoerster <guido@berhoerster.name>
parents: 10
diff changeset
37 Print a summary of all command line options and exit.
7af115023d5a add CLI, make delay and interval configurable
Guido Berhoerster <guido@berhoerster.name>
parents: 10
diff changeset
38 .TP
7af115023d5a add CLI, make delay and interval configurable
Guido Berhoerster <guido@berhoerster.name>
parents: 10
diff changeset
39 .BR \-i ", " \-\-interval =\fIinterval\fR
7af115023d5a add CLI, make delay and interval configurable
Guido Berhoerster <guido@berhoerster.name>
parents: 10
diff changeset
40 Set the interval in seconds between checks for updates.
7af115023d5a add CLI, make delay and interval configurable
Guido Berhoerster <guido@berhoerster.name>
parents: 10
diff changeset
41 .TP
7af115023d5a add CLI, make delay and interval configurable
Guido Berhoerster <guido@berhoerster.name>
parents: 10
diff changeset
42 .BR \-v ", " \-\-version
7af115023d5a add CLI, make delay and interval configurable
Guido Berhoerster <guido@berhoerster.name>
parents: 10
diff changeset
43 Print the version number and exit.
7af115023d5a add CLI, make delay and interval configurable
Guido Berhoerster <guido@berhoerster.name>
parents: 10
diff changeset
44 .SH EXIT STATUS
7af115023d5a add CLI, make delay and interval configurable
Guido Berhoerster <guido@berhoerster.name>
parents: 10
diff changeset
45 .TP
7af115023d5a add CLI, make delay and interval configurable
Guido Berhoerster <guido@berhoerster.name>
parents: 10
diff changeset
46 .B 0
7af115023d5a add CLI, make delay and interval configurable
Guido Berhoerster <guido@berhoerster.name>
parents: 10
diff changeset
47 The program has exited normally.
7af115023d5a add CLI, make delay and interval configurable
Guido Berhoerster <guido@berhoerster.name>
parents: 10
diff changeset
48 .TP
7af115023d5a add CLI, make delay and interval configurable
Guido Berhoerster <guido@berhoerster.name>
parents: 10
diff changeset
49 .B >0
7af115023d5a add CLI, make delay and interval configurable
Guido Berhoerster <guido@berhoerster.name>
parents: 10
diff changeset
50 An Error has occurred.