[2808] | 1 | .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.36. |
---|
[2851] | 2 | .TH PKNOTIFY "1" "avril 2006" "C@LL - Conseil Internet & Logiciels Libres" "User Commands" |
---|
[2778] | 3 | .SH NOM |
---|
[2872] | 4 | pknotify \- page de manuel de pknotify 1.24HotFix1_unofficial |
---|
[2778] | 5 | .SH DESCRIPTION |
---|
[2872] | 6 | pknotify v1.24HotFix1_unofficial (c) 2003, 2004, 2005, 2006 Jerome Alet \- alet@librelogiciel.com |
---|
[2778] | 7 | .PP |
---|
| 8 | Notifies or ask questions to end users who launched the PyKotIcon application. |
---|
| 9 | .PP |
---|
| 10 | command line usage : |
---|
| 11 | .TP |
---|
| 12 | pknotify |
---|
| 13 | [options] [arguments] |
---|
| 14 | .PP |
---|
| 15 | options : |
---|
| 16 | .TP |
---|
| 17 | \fB\-v\fR | \fB\-\-version\fR |
---|
[2822] | 18 | Prints pknotify's version number then exits. |
---|
[2778] | 19 | .TP |
---|
| 20 | \fB\-h\fR | \fB\-\-help\fR |
---|
| 21 | Prints this message then exits. |
---|
[2779] | 22 | .TP |
---|
| 23 | \fB\-d\fR | \fB\-\-destination\fR h[:p] |
---|
| 24 | Sets the destination hostname and optional |
---|
| 25 | port onto which contact the remote PyKotIcon |
---|
| 26 | application. This option is mandatory. |
---|
| 27 | When not specified, the port defaults to 7654. |
---|
| 28 | .TP |
---|
| 29 | \fB\-a\fR | \fB\-\-ask\fR |
---|
| 30 | Tells pknotify to ask something to the end |
---|
| 31 | user. Then pknotify will output the result. |
---|
| 32 | .TP |
---|
[2808] | 33 | \fB\-C\fR | \fB\-\-checkauth\fR |
---|
| 34 | When \fB\-\-ask\fR is used and both an 'username' and a |
---|
| 35 | \&'password' are asked to the end user, then |
---|
| 36 | pknotify will try to authenticate the user |
---|
| 37 | through PAM. If authentified, this program |
---|
| 38 | will print "AUTH=YES", else "AUTH=NO". |
---|
| 39 | If a field is missing, "AUTH=IMPOSSIBLE" will |
---|
| 40 | be printed. If the user is authenticated, then |
---|
| 41 | "USERNAME=xxxx" will be printed as well. |
---|
| 42 | .TP |
---|
[2779] | 43 | \fB\-c\fR | \fB\-\-confirm\fR |
---|
| 44 | Tells pknotify to ask for either a confirmation |
---|
| 45 | or abortion. |
---|
| 46 | .TP |
---|
[2808] | 47 | \fB\-D\fR | \fB\-\-denyafter\fR N |
---|
| 48 | With \fB\-\-checkauth\fR above, makes pknotify loop |
---|
| 49 | up to N times if the password is incorrect. |
---|
| 50 | After having reached the limit, "DENY" will |
---|
| 51 | be printed, which effectively rejects the job. |
---|
| 52 | The default value of N is 1, meaning the job |
---|
| 53 | is denied after the first unsuccessful try. |
---|
| 54 | .TP |
---|
[2779] | 55 | \fB\-n\fR | \fB\-\-notify\fR |
---|
| 56 | Tells pknotify to send an informational message |
---|
[2823] | 57 | to the end user. |
---|
[2779] | 58 | .TP |
---|
| 59 | \fB\-q\fR | \fB\-\-quit\fR |
---|
| 60 | Tells pknotify to send a message asking the |
---|
| 61 | PyKotIcon application to exit. This option can |
---|
| 62 | be combined with the other ones to make PyKotIcon |
---|
| 63 | exit after having sent the answer from the dialog. |
---|
[2808] | 64 | .TP |
---|
| 65 | \fB\-t\fR | \fB\-\-timeout\fR T |
---|
| 66 | Tells pknotify to ignore the end user's answer if |
---|
[2824] | 67 | it comes past T seconds after the dialog box being |
---|
[2808] | 68 | opened. The default value is 0 seconds, which |
---|
| 69 | tells pknotify to wait indefinitely. |
---|
| 70 | Use this option to avoid having an user who |
---|
| 71 | leaved his computer stall a whole print queue. |
---|
[2779] | 72 | .IP |
---|
| 73 | You MUST specify either \fB\-\-ask\fR, \fB\-\-confirm\fR, \fB\-\-notify\fR or \fB\-\-quit\fR. |
---|
| 74 | .IP |
---|
| 75 | arguments : |
---|
| 76 | .HP |
---|
[2825] | 77 | \fB\-a\fR | \fB\-\-ask\fR : Several arguments are accepted, of the form |
---|
[2779] | 78 | .IP |
---|
| 79 | "label:varname:defaultvalue". The result will |
---|
| 80 | be printed to stdout in the following format : |
---|
| 81 | VAR1NAME=VAR1VALUE |
---|
| 82 | VAR2NAME=VAR2VALUE |
---|
| 83 | \&... |
---|
| 84 | If the dialog was cancelled, nothing will be |
---|
| 85 | printed. If one of the varname is 'password' |
---|
| 86 | then this field is asked as a password (you won't |
---|
[2808] | 87 | see what you type in), and is NOT printed. Although |
---|
| 88 | it is not printed, it will be used to check if |
---|
| 89 | authentication is valid if you specify \fB\-\-checkauth\fR. |
---|
[2779] | 90 | .TP |
---|
| 91 | \fB\-c\fR | \fB\-\-confirm\fR : A single argument is expected, representing the |
---|
| 92 | message to display. If the dialog is confirmed |
---|
| 93 | then pknotify will print OK, else CANCEL. |
---|
| 94 | .TP |
---|
| 95 | \fB\-n\fR | \fB\-\-notify\fR : A single argument is expected, representing the |
---|
| 96 | message to display. In this case pknotify will |
---|
| 97 | always print OK. |
---|
[2778] | 98 | .PP |
---|
[2779] | 99 | examples : |
---|
| 100 | .IP |
---|
| 101 | pknotify \fB\-d\fR client:7654 \fB\-\-confirm\fR "This job costs : |
---|
| 102 | .PP |
---|
| 103 | 10 credits !" |
---|
| 104 | .IP |
---|
[2808] | 105 | Would display the cost of a print job and asks for confirmation. |
---|
| 106 | .IP |
---|
| 107 | pknotify \fB\-\-destination\fR $PYKOTAJOBORIGINATINGHOSTNAME:7654 \e |
---|
| 108 | .IP |
---|
| 109 | \fB\-\-checkauth\fR \fB\-\-ask\fR "Your name:username:" "Your password:password:" |
---|
| 110 | .IP |
---|
| 111 | Asks an username and password, and checks if they are valid. |
---|
| 112 | NB : The PYKOTAJOBORIGINATINGHOSTNAME environment variable is |
---|
| 113 | only set if you launch pknotify from cupspykota through a directive |
---|
| 114 | in ~pykota/pykota.conf |
---|
| 115 | .IP |
---|
| 116 | The TCP port you'll use must be reachable on the client from the |
---|
| 117 | print server. |
---|
[2779] | 118 | .PP |
---|
[2778] | 119 | This program is free software; you can redistribute it and/or modify |
---|
| 120 | it under the terms of the GNU General Public License as published by |
---|
| 121 | the Free Software Foundation; either version 2 of the License, or |
---|
| 122 | (at your option) any later version. |
---|
| 123 | .PP |
---|
| 124 | This program is distributed in the hope that it will be useful, |
---|
| 125 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
---|
| 126 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
---|
| 127 | GNU General Public License for more details. |
---|
| 128 | .PP |
---|
| 129 | You should have received a copy of the GNU General Public License |
---|
| 130 | along with this program; if not, write to the Free Software |
---|
| 131 | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110\-1301, USA. |
---|
| 132 | .PP |
---|
| 133 | Please report bugs to : Jerome Alet \- alet@librelogiciel.com |
---|