Changeset 3439 for pykoticon/trunk/README
- Timestamp:
- 10/06/08 00:29:29 (15 years ago)
- Files:
-
- 1 modified
Legend:
- Unmodified
- Added
- Removed
-
pykoticon/trunk/README
r176 r3439 22 22 PyKotIcon is a cross-platform client-side helper for PyKota. 23 23 24 It is meant to be launched whenever the user logs in, and stay in 25 the taskbar (depending on the client operating system) until the 26 user closes his session. 27 24 It is meant to be launched whenever the user logs in, and stay in 25 the taskbar (depending on the client operating system) until the 26 user closes his session. 27 28 28 Installation : 29 29 30 30 * GNU/Linux and similar : 31 31 32 32 $ cd pykoticon 33 33 $ python setup.py install 34 34 35 35 Then modify your .xsession file, or the appropriate file depending 36 36 on your desktop environment, to ensure that the pykoticon command 37 37 is launched in the background each time your X Window session 38 38 starts. 39 39 40 40 You MUST pass the list of hostnames or IP addresses from which 41 41 PyKotIcon should accept incoming connexions on pykoticon's … … 44 44 hostnames or IP addresses of ALL print servers on pykoticon's 45 45 command line. 46 46 47 47 NB : `pykoticon --help` will give you hints about the expected 48 48 command line parameters. 49 50 * MS Windows : 51 52 Download pykoticon-x.yy.zip from 53 49 50 * MS Windows : 51 52 Download pykoticon-x.yy.zip from 53 54 54 http://www.pykota.com/software/pykoticon/download/tarballs/ 55 56 Unzip it into a directory of its own. I usually unzip it into 55 56 Unzip it into a directory of its own. I usually unzip it into 57 57 /var/lib/samba/netlogon/pykoticon/ 58 58 59 59 Modify the PYKOTICON.VBS file to include the list of authorized 60 60 print servers and change other parameters as needed, as explained 61 61 in the GNU/Linux section above. 62 62 63 63 Ensure that PYKOTICON.VBS is executed each time an user logs 64 64 in. The easiest way to do this is in STARTUP.CMD : 65 65 66 66 --- CUT --- 67 67 SET PATH=%PATH%;\\MYSERVER\NETLOGON\PYKOTICON\ 68 \\MYSERVER\NETLOGON\PYKOTICON\PYKOTICON.VBS 68 \\MYSERVER\NETLOGON\PYKOTICON\PYKOTICON.VBS 69 69 --- CUT --- 70 70 71 71 NB : if you launch PYKOTICON.EXE directly instead of from 72 PYKOTICON.VBS, a small but disturbing window may appear on 72 PYKOTICON.VBS, a small but disturbing window may appear on 73 73 the screen. 74 74 … … 84 84 independant of PyKota, and can be used from any application 85 85 which can do remote procedure calls over XML-RPC. 86 86 87 87 PyKotIcon exposes 4 of its methods over XML-RPC, here they are : 88 88 89 89 - nop : 90 90 91 91 This methods does exactly nothing :) 92 92 93 93 - Input : No argument. 94 94 95 95 - Output : returns the True boolean value. 96 97 - quitApplication : 98 96 97 - quitApplication : 98 99 99 This method causes the PyKotIcon application to exit. 100 100 101 101 - Input : No argument. 102 102 103 103 - Output : returns the True boolean value. 104 105 - showDialog : 106 104 105 - showDialog : 106 107 107 This methods displays an informational message, and returns 108 108 the choice the user made, if any. 109 110 - Input : 111 112 - message : a Binary XML-RPC object representing an UTF-8 encoded 113 character string which will be displayed to the end user. 114 This string can contain literal "\n" sequences which will 109 110 - Input : 111 112 - message : a Binary XML-RPC object representing an UTF-8 encoded 113 character string which will be displayed to the end user. 114 This string can contain literal "\n" sequences which will 115 115 be automatically expanded into line breaks by PyKotIcon. 116 117 - confirmation : a boolean value indicating if the user will 116 117 - confirmation : a boolean value indicating if the user will 118 118 be given the choice to valid or cancel (True), or only 119 119 to valid (False) the dialog box. 120 121 - Output : 122 120 121 - Output : 122 123 123 - the literal string "OK" if the user clicked on the OK button, 124 124 else the literal string "CANCEL". The latter is only possible 125 125 if the method was called with its second parameter set to 126 126 True. 127 128 - askDatas : 129 127 128 - askDatas : 129 130 130 This method can generate an input form and return what the user 131 131 entered in the different fields. 132 132 133 133 - Input : 134 135 - An array of labels, one label per input field in the 134 135 - An array of labels, one label per input field in the 136 136 form to be created. Each label in the list is passed as 137 137 a Binary XML-RPC object representing an UTF-8 encoded 138 138 character string. 139 139 140 140 - An array of variables names, one name per input field in 141 141 the form to be created. Each name in the list is passed 142 as an ASCII encoded character string. 142 as an ASCII encoded character string. 143 143 IMPORTANT : if one of these names is 'password' then this 144 particular field's input box will be visually protected 144 particular field's input box will be visually protected 145 145 with * in place of the characters typed during input. 146 147 - An associative array (e.g. Python mapping) of initial values. 146 147 - An associative array (e.g. Python mapping) of initial values. 148 148 Each key is a variable name which must be present in the list 149 149 above, and each value is a possibly empty initial content, 150 which will be passed as a Binary XML-RPC object representing 150 which will be passed as a Binary XML-RPC object representing 151 151 an UTF-8 encoded character string. 152 152 153 153 - Output : 154 154 155 155 - An associative array (e.g. Python mapping) containing the 156 156 variables names as keys and the variables' contents as 157 157 values in the following format : 158 158 159 159 - Each key is an ASCII encoded character string representing 160 the name of a variable to ask which was passed from the 160 the name of a variable to ask which was passed from the 161 161 caller. 162 163 - Each value is a Binary XML-RPC object representing an UTF-8 162 163 - Each value is a Binary XML-RPC object representing an UTF-8 164 164 encoded character string, itself being the result of user 165 165 input in the form's field for this particular variable. … … 173 173 In this case, all the other values are empty strings 174 174 anyway. 175 176 177 IMPORTANT : PyKotIcon doesn't currently support encrypted connexions, 175 176 177 IMPORTANT : PyKotIcon doesn't currently support encrypted connexions, 178 178 so if you're afraid of sensitive information flying in the clear 179 over the nework, you should probably install a transparent secure 179 over the nework, you should probably install a transparent secure 180 180 tunneling software like stunnel on both sides of each connection. 181 181 182 182 ==================================================================== 183 183 184 184 Please e-mail bugs to the PyKota mailing list at : pykota@librelogiciel.com 185 185 or to the main author at : alet@librelogiciel.com (Jerome Alet)