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