Changeset 3413 for pykota/trunk/docs/introduction.sgml
- Timestamp:
- 09/27/08 22:02:37 (16 years ago)
- Files:
-
- 1 modified
-
pykota/trunk/docs/introduction.sgml (modified) (22 diffs)
Legend:
- Unmodified
- Added
- Removed
-
pykota/trunk/docs/introduction.sgml
r3345 r3413 3 3 <chapter> 4 4 <title id="introduction">Introduction to PyKota</title> 5 5 6 6 <para>Last modified on $Date$</para> 7 7 8 8 <para> 9 9 This chapter will briefly introduce you to PyKota, and will familiarize 10 10 you with this software and its components. 11 11 </para> 12 13 12 13 14 14 <sect1> 15 15 <title>What is <application>PyKota</application> ?</title> 16 16 17 17 <para> 18 18 <application>PyKota</application> is a print quota and print accounting software solution 19 19 for GNU/Linux and compatible print servers. 20 20 </para> 21 21 22 22 <para> 23 23 PyKota currently supports the 24 24 <ulink url="http://www.cups.org"><application>CUPS</application></ulink> 25 25 <footnote><para>Common UNIX Printing System</para></footnote> 26 printing subsystem, although older releases also supported 26 printing subsystem, although older releases also supported 27 27 <ulink url="http://lprng.sourceforge.net"><application>LPRng</application></ulink>. 28 28 </para> 29 29 30 30 <para> 31 31 PyKota is distributed under the terms of the GNU General Public License of the … … 34 34 the terms of this license. 35 35 </para> 36 36 37 37 <para> 38 38 We believe that despite being a bit rough around the edges sometimes, <application>PyKota</application> … … 41 41 for the next release. 42 42 </para> 43 43 44 44 <para> 45 45 <application>PyKota</application> is however a somewhat complex piece of software, and installing … … 47 47 next chapter. 48 48 </para> 49 49 50 50 <para> 51 51 <application>PyKota</application> is made of the following components : … … 73 73 so please give particular attention to this file's permissions. 74 74 </para> 75 </listitem> 76 <listitem> 77 <para> 78 <filename>pykota.conf</filename> : this is the main configuration file for 75 </listitem> 76 <listitem> 77 <para> 78 <filename>pykota.conf</filename> : this is the main configuration file for 79 79 <application>PyKota</application>. It contains database settings which 80 80 allow the <application>PyKota</application> software to access to the print 81 81 quota database in readonly mode, as well as global and print queue specific 82 configuration directives. With a properly configured <application>PyKota</application>, 82 configuration directives. With a properly configured <application>PyKota</application>, 83 83 letting normal users read this file is safe 84 84 excepted where you want to forbid users to read other users' print quota … … 87 87 use any of the <application>PyKota</application> command line tools. 88 88 </para> 89 </listitem> 89 </listitem> 90 90 </itemizedlist> 91 91 </para> 92 </listitem> 92 </listitem> 93 93 <listitem> 94 94 <para> … … 100 100 for other database backends might be added in a future release. 101 101 </para> 102 </listitem> 102 </listitem> 103 103 <listitem> 104 104 <para> … … 108 108 of circumstances like the user being over quota, and interact with the end user through the use of external 109 109 commands or shell scripts. This software is written in such a manner than system 110 administrators can plug their own scripts at the most strategic points of the 110 administrators can plug their own scripts at the most strategic points of the 111 111 printing process, through specific directives that you put in <application>PyKota</application>'s 112 112 configuration files. 113 113 </para> 114 </listitem> 114 </listitem> 115 115 <listitem> 116 116 <para> … … 126 126 interactive way, but currently only under Debian and Ubuntu. 127 127 </para> 128 </listitem> 128 </listitem> 129 129 <listitem> 130 130 <para> … … 133 133 into a turn-key solution, hence the name. 134 134 </para> 135 </listitem> 135 </listitem> 136 136 <listitem> 137 137 <para> 138 138 <command>pkprinters</command> : to manage printers and printers groups. 139 139 </para> 140 </listitem> 140 </listitem> 141 141 <listitem> 142 142 <para> 143 143 <command>pkusers</command> : to manage users and users groups. 144 144 </para> 145 </listitem> 145 </listitem> 146 146 <listitem> 147 147 <para> 148 148 <command>edpykota</command> : to manage users' and users groups' print quota entries. 149 149 </para> 150 </listitem> 150 </listitem> 151 151 <listitem> 152 152 <para> 153 153 <command>pkbcodes</command> : to manage billing codes. 154 154 </para> 155 </listitem> 155 </listitem> 156 156 <listitem> 157 157 <para> 158 158 <command>repykota</command> : to do some basic print quota reporting. 159 159 </para> 160 </listitem> 160 </listitem> 161 161 <listitem> 162 162 <para> … … 166 166 numerous output formats are supported, like <acronym>csv</acronym> and <acronym>XML</acronym> 167 167 </para> 168 </listitem> 168 </listitem> 169 169 <listitem> 170 170 <para> … … 173 173 instead from <filename>pykota.conf</filename>'s <literal>policy</literal> directive. 174 174 </para> 175 </listitem> 175 </listitem> 176 176 <listitem> 177 177 <para> … … 180 180 application which works under the X Window system. 181 181 </para> 182 </listitem> 182 </listitem> 183 183 <listitem> 184 184 <para> … … 187 187 a less costly printer. 188 188 </para> 189 </listitem> 189 </listitem> 190 190 <listitem> 191 191 <para> … … 193 193 This command is 194 194 not meant to be used from the command line, but 195 instead from <filename>pykota.conf</filename>'s <literal>startingbanner</literal> 195 instead from <filename>pykota.conf</filename>'s <literal>startingbanner</literal> 196 196 and <literal>endingbanner</literal> directives. If you prefer you can use 197 197 your own generator of dynamic banner pages or even static banner pages. 198 198 </para> 199 </listitem> 199 </listitem> 200 200 <listitem> 201 201 <para> … … 204 204 this command is meant to be used as a periodic reminder. 205 205 </para> 206 </listitem> 206 </listitem> 207 207 <listitem> 208 208 <para> … … 210 210 tools allow you to interact with end users at printing time. 211 211 </para> 212 </listitem> 212 </listitem> 213 213 <listitem> 214 214 <para> … … 216 216 for your users from their printing history. 217 217 </para> 218 </listitem> 219 <listitem> 220 <para> 221 <command>pkrefund</command> : a tool with which you can refund print jobs 218 </listitem> 219 <listitem> 220 <para> 221 <command>pkrefund</command> : a tool with which you can refund print jobs 222 222 when there was an accounting problem. It can generate printable receipts 223 223 in the PDF format. 224 224 </para> 225 </listitem> 225 </listitem> 226 226 </itemizedlist> 227 227 </para> 228 </listitem> 228 </listitem> 229 229 <listitem> 230 230 <para> … … 236 236 <listitem> 237 237 <para> 238 <command>printquota.cgi</command> : to do basic print quota reports like repykota, 238 <command>printquota.cgi</command> : to do basic print quota reports like repykota, 239 239 and also to examine the printing history, which is not possible with repykota for now. 240 240 </para> 241 </listitem> 241 </listitem> 242 242 <listitem> 243 243 <para> … … 245 245 command line tool, but works from within a web browser. 246 246 </para> 247 </listitem> 247 </listitem> 248 248 <listitem> 249 249 <para> … … 251 251 command line tool, but works from within a web browser. 252 252 </para> 253 </listitem> 253 </listitem> 254 254 </itemizedlist> 255 255 </para> 256 </listitem> 256 </listitem> 257 257 <listitem> 258 258 <para> … … 261 261 you may find interesting things... 262 262 </para> 263 </listitem> 263 </listitem> 264 264 </itemizedlist> 265 265 </para> 266 267 </sect1> 268 266 267 </sect1> 268 269 269 </chapter> 270 270
