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

Revision 3279, 5.2 kB (checked in by jerome, 17 years ago)

Finished changing copyright years, excepted for contributed stuff
and database schema migration scripts which would only be useful to
people with very very old releases of PyKota : these scripts won't change
for sure, and might disappear anyway...

Line 
1.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.36.
2.TH PKNOTIFY "1" "January 2008" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
3.SH NAME
4pknotify \- manual page for pknotify 1.27alpha3_BROKEN_unofficial
5.SH DESCRIPTION
6pknotify v1.27alpha3_BROKEN_unofficial (c) 2003, 2004, 2005, 2006, 2007, 2008 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\-\-noremote\fR action
56If it's impossible to connect to the remote
57PyKotIcon machine, do this action instead.
58Allowed actions are 'CONTINUE' and 'CANCEL',
59which will respectively allow the processing
60of the print job to continue, or the job to
61be cancelled. The default value is CANCEL.
62.TP
63\fB\-n\fR | \fB\-\-notify\fR
64Tells pknotify to send an informational message
65to the end user.
66.TP
67\fB\-q\fR | \fB\-\-quit\fR
68Tells pknotify to send a message asking the
69PyKotIcon application to exit. This option can
70be combined with the other ones to make PyKotIcon
71exit after having sent the answer from the dialog.
72.TP
73\fB\-t\fR | \fB\-\-timeout\fR T
74Tells pknotify to ignore the end user's answer if
75it comes past T seconds after the dialog box being
76opened. The default value is 0 seconds, which
77tells pknotify to wait indefinitely.
78Use this option to avoid having an user who
79leaved his computer stall a whole print queue.
80.IP
81You MUST specify either \fB\-\-ask\fR, \fB\-\-confirm\fR, \fB\-\-notify\fR or \fB\-\-quit\fR.
82.IP
83arguments :
84.HP
85\fB\-a\fR | \fB\-\-ask\fR : Several arguments are accepted, of the form
86.IP
87"label:varname:defaultvalue". The result will
88be printed to stdout in the following format :
89VAR1NAME=VAR1VALUE
90VAR2NAME=VAR2VALUE
91\&...
92If the dialog was cancelled, nothing will be
93printed. If one of the varname is 'password'
94then this field is asked as a password (you won't
95see what you type in), and is NOT printed. Although
96it is not printed, it will be used to check if
97authentication is valid if you specify \fB\-\-checkauth\fR.
98.TP
99\fB\-c\fR | \fB\-\-confirm\fR : A single argument is expected, representing the
100message to display. If the dialog is confirmed
101then pknotify will print OK, else CANCEL.
102.TP
103\fB\-n\fR | \fB\-\-notify\fR : A single argument is expected, representing the
104message to display. In this case pknotify will
105always print OK.
106.PP
107examples :
108.IP
109pknotify \fB\-d\fR client:7654 \fB\-\-noremote\fR CONTINUE \fB\-\-confirm\fR "This job costs 10 credits"
110.IP
111Would display the cost of the print job and asks for confirmation.
112If the end user doesn't have PyKotIcon running and accepting connections
113from the print server, PyKota will consider that the end user accepted
114to print this job.
115.IP
116pknotify \fB\-\-destination\fR $PYKOTAJOBORIGINATINGHOSTNAME:7654 \e
117.IP
118\fB\-\-checkauth\fR \fB\-\-ask\fR "Your name:username:" "Your password:password:"
119.IP
120Asks an username and password, and checks if they are valid.
121NB : The PYKOTAJOBORIGINATINGHOSTNAME environment variable is
122only set if you launch pknotify from cupspykota through a directive
123in ~pykota/pykota.conf
124.IP
125The TCP port you'll use must be reachable on the client from the
126print server.
127.PP
128(c) 2003, 2004, 2005, 2006, 2007, 2008 Jerome Alet <alet@librelogiciel.com>
129This program is free software: you can redistribute it and/or modify
130it under the terms of the GNU General Public License as published by
131the Free Software Foundation, either version 3 of the License, or
132(at your option) any later version.
133.PP
134This program is distributed in the hope that it will be useful,
135but WITHOUT ANY WARRANTY; without even the implied warranty of
136MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
137GNU General Public License for more details.
138.PP
139You should have received a copy of the GNU General Public License
140along with this program.  If not, see <http://www.gnu.org/licenses/>.
141.PP
142Please report bugs to : Jerome Alet \- alet@librelogiciel.com
Note: See TracBrowser for help on using the browser.