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

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
line wrap: on
line diff
--- a/pk-update-icon.1	Thu Oct 20 09:06:52 2011 +0200
+++ b/pk-update-icon.1	Thu Oct 20 12:06:42 2011 +0200
@@ -16,11 +16,35 @@
 .\" along with this program; if not, write to the Free Software
 .\" Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 .\"
-.TH PK\-UPDATE\-ICON 1 "9 Oct 2011"
+.TH PK\-UPDATE\-ICON 1 "20 Oct 2011"
 .SH NAME
-pk\-update\-icon \- display notifications about package updates
+pk\-update\-icon \- display notifications about software updates
 .SH SYNOPSIS
-.B pk\-update\-icon
+\fBpk\-update\-icon\fR
+[\fB\-hv?\fR]
+[\fB\-d\fR \fIdelay\fR | \fB\-\-delay\fR=\fIdelay\fR]
+[\fB\-i\fR \fIinterval\fR | \fB\-\-interval\fR=\fIinterval\fR]
 .SH DESCRIPTION
 \fBpk\-update\-icon\fR displays notifications and an icon in the tray area of
 the panel when package updates are available.
+.SH OPTIONS
+The following options are supported:
+.TP
+.BR \-d ", " \-\-delay =\fIdelay\fR
+Set the delay in seconds before the first check for updates.
+.TP
+.BR \-h ", " \-? ", " \-\-help
+Print a summary of all command line options and exit.
+.TP
+.BR \-i ", " \-\-interval =\fIinterval\fR
+Set the interval in seconds between checks for updates.
+.TP
+.BR \-v ", " \-\-version
+Print the version number and exit.
+.SH EXIT STATUS
+.TP
+.B 0
+The program has exited normally.
+.TP
+.B >0
+An Error has occurred.