root / pykota / trunk / man / pknotify.1 @ 2996

Revision 2910, 4.6 kB (checked in by jerome, 18 years ago)

Updated URLs in manual pages too.

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