root / pykota / trunk / man / pykosd.1 @ 3485

Revision 3485, 2.2 kB (checked in by jerome, 15 years ago)

Updated manual pages.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
RevLine 
[2808]1.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.36.
[3485]2.TH PYKOSD "1" "January 2009" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
[1605]3.SH NAME
[3485]4pykosd \- manual page for pykosd (PyKota) 1.27alpha7_unofficial
5.SH SYNOPSIS
6.B pykosd
7[\fIoptions\fR]
[1605]8.SH DESCRIPTION
[3485]9An On Screen Display (OSD) monitor for PyKota's end users.
10.SH OPTIONS
[1605]11.TP
[3485]12\fB\-h\fR, \fB\-\-help\fR
13show this help message and exit.
[1605]14.TP
[3485]15\fB\-v\fR, \fB\-\-version\fR
16show the version number and exit.
[1605]17.TP
[3485]18\fB\-A\fR ARGUMENTSFILE, \fB\-\-arguments\fR=\fIARGUMENTSFILE\fR
19loads additional options and arguments from a file,
20one per line.
[1629]21.TP
[3485]22\fB\-c\fR COLOR, \fB\-\-color\fR=\fICOLOR\fR, \fB\-\-colour\fR=\fICOLOR\fR
23Set the color that will be used for display, as an
24hexadecimal triplet. For example #FF0000 is 100% red.
25The default is 100% green (#00FF00).
[1605]26.TP
[3485]27\fB\-d\fR DURATION, \fB\-\-duration\fR=\fIDURATION\fR
28Set the time in seconds during which the message will
29be displayed. Defaults to 3 seconds.
[1629]30.TP
[3485]31\fB\-f\fR FONT, \fB\-\-font\fR=\fIFONT\fR
32Set the font to use. Defaults to \-*\-helveticamedium\-r\-normal\-*\-*\-360\-*\-*\-p\-*\-*\-*.
33.TP
34\fB\-l\fR LOOP, \fB\-\-loop\fR=\fILOOP\fR
35Set the number of times the info will be displayed.
[1605]36Defaults to 0, which means loop forever.
37.TP
[3485]38\fB\-s\fR SLEEP, \fB\-\-sleep\fR=\fISLEEP\fR
39Set the sleeping time in seconds between two
40refreshes. Defaults to 180 seconds.
41.SS "examples:"
[1605]42.IP
[3485]43pykosd \fB\-s\fR 60 \fB\-\-loop\fR 5
44This would tell pykosd to display the current user's status for 3 seconds
45(the default) every 60 seconds, and exit after 5 iterations.
46.SS "licensing terms:"
[1605]47.IP
[3485]48(c) 2003\-2009 Jerome Alet \- alet@librelogiciel.com
49This program is free software: you can redistribute it and/or modify it
50under the terms of the GNU General Public License as published by the Free
51Software Foundation, either version 3 of the License, or (at your option)
52any later version.
53.IP
54This program is distributed in the hope that it will be useful, but
55WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
56or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
57for more details.
58.IP
59You should have received a copy of the GNU General Public License along
60with this program.  If not, see <http://www.gnu.org/licenses/>.
Note: See TracBrowser for help on using the browser.