Show
Ignore:
Timestamp:
01/24/09 22:38:46 (15 years ago)
Author:
jerome
Message:

Updated manual pages.

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • pykota/trunk/man/pykosd.1

    r3279 r3485  
    11.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.36. 
    2 .TH PYKOSD "1" "January 2008" "C@LL - Conseil Internet & Logiciels Libres" "User Commands" 
     2.TH PYKOSD "1" "January 2009" "C@LL - Conseil Internet & Logiciels Libres" "User Commands" 
    33.SH NAME 
    4 pykosd \- manual page for pykosd 1.27alpha3_BROKEN_unofficial 
     4pykosd \- manual page for pykosd (PyKota) 1.27alpha7_unofficial 
     5.SH SYNOPSIS 
     6.B pykosd 
     7[\fIoptions\fR] 
    58.SH DESCRIPTION 
    6 pykosd v1.27alpha3_BROKEN_unofficial (c) 2003, 2004, 2005, 2006, 2007, 2008 Jerome Alet \- alet@librelogiciel.com 
    7 .PP 
    8 An OSD quota monitor for PyKota. 
    9 .PP 
    10 command line usage : 
    11 .IP 
    12 pykosd [options] 
    13 .PP 
    14 options : 
     9An On Screen Display (OSD) monitor for PyKota's end users. 
     10.SH OPTIONS 
    1511.TP 
    16 \fB\-v\fR | \fB\-\-version\fR 
    17 Prints pykosd's version number then exits. 
     12\fB\-h\fR, \fB\-\-help\fR 
     13show this help message and exit. 
    1814.TP 
    19 \fB\-h\fR | \fB\-\-help\fR 
    20 Prints this message then exits. 
     15\fB\-v\fR, \fB\-\-version\fR 
     16show the version number and exit. 
    2117.TP 
    22 \fB\-c\fR | \fB\-\-color\fR #rrggbb Sets the color to use for display as an hexadecimal 
    23 triplet, for example #FF0000 is 100% red. 
    24 Defaults to 100% green (#00FF00). 
     18\fB\-A\fR ARGUMENTSFILE, \fB\-\-arguments\fR=\fIARGUMENTSFILE\fR 
     19loads additional options and arguments from a file, 
     20one per line. 
    2521.TP 
    26 \fB\-d\fR | \fB\-\-duration\fR d 
    27 Sets the duration of the display in seconds. 
    28 Defaults to 3 seconds. 
     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). 
    2926.TP 
    30 \fB\-f\fR | \fB\-\-font\fR f 
    31 Sets the font to use for display. 
    32 Defaults to the Python OSD library's default. 
     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. 
    3330.TP 
    34 \fB\-l\fR | \fB\-\-loop\fR n 
    35 Sets the number of times the info will be displayed. 
     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. 
    3636Defaults to 0, which means loop forever. 
    3737.TP 
    38 \fB\-s\fR | \fB\-\-sleep\fR s 
    39 Sets the sleeping duration between two displays 
    40 in seconds. Defaults to 180 seconds (3 minutes). 
    41 .PP 
    42 examples : 
     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:" 
    4342.IP 
    44 \f(CW$ pykosd -s 60 \-\-loop 5\fR 
     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:" 
    4547.IP 
    46 Will launch pykosd. Display will be refreshed every 60 seconds, 
    47 and will last for 3 seconds (the default) each time. After five 
    48 iterations, the program will exit. 
    49 .PP 
    50 (c) 2003, 2004, 2005, 2006, 2007, 2008 Jerome Alet <alet@librelogiciel.com> 
    51 This program is free software: you can redistribute it and/or modify 
    52 it under the terms of the GNU General Public License as published by 
    53 the Free Software Foundation, either version 3 of the License, or 
    54 (at your option) any later version. 
    55 .PP 
    56 This program is distributed in the hope that it will be useful, 
    57 but WITHOUT ANY WARRANTY; without even the implied warranty of 
    58 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the 
    59 GNU General Public License for more details. 
    60 .PP 
    61 You should have received a copy of the GNU General Public License 
    62 along with this program.  If not, see <http://www.gnu.org/licenses/>. 
    63 .PP 
    64 Please report bugs to : Jerome Alet \- alet@librelogiciel.com 
     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/>.