1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
|
<HTML>
<!-- SECTION: Getting Started -->
<HEAD>
<TITLE>Translating and Customizing CUPS</TITLE>
<LINK REL="STYLESHEET" TYPE="text/css" HREF="../cups-printable.css">
</HEAD>
<BODY>
<H1 CLASS="title">Translating and Customizing CUPS</H1>
<P>Thanks to its extensive use of templates, images, and message catalogs, CUPS can be easily translated (or customized!) to suit your needs. This help file will guide you through the CUPS localization files so you can get the most out of it.</P>
<H2 CLASS="title" ID="INTRO">Getting Started</H2>
<P>Start by downloading the CUPS source code from <A HREF="https://www.cups.org/" TARGET="_blank">www.cups.org</A>. After you extract the files from the source archive (or clone the Git repository), you will want to copy the following files and directories:</P>
<UL>
<LI><VAR>desktop/cups.desktop</VAR> - the GNOME/KDE desktop file pointing to the CUPS web interface</LI>
<LI><VAR>doc/index.html.in</VAR> - the web interface home page</LI>
<LI><VAR>locale/cups.pot</VAR> - the message catalog</LI>
<LI><VAR>templates/*.tmpl</VAR> and <VAR>templates/header.tmpl.in</VAR> - the web interface template files</LI>
</UL>
<P>With the exception of the message catalogs and desktop file, localization files are placed in subdirectories under the <VAR>doc</VAR> and <VAR>templates</VAR> using the locale name. Locale names are either <VAR>ll</VAR> or <VAR>ll_CC</VAR>, where "ll" is the 2-letter language code and "CC" is the 2-letter country code. <em>CUPS does not currently use or support the newer <VAR>ll-region</VAR> syntax for locale names.</em></P>
<P>All non-image files must be encoded using the UTF-8 character set.</P>
<H2 CLASS="title" ID="SUBMIT">Submitting a Translation for CUPS</H2>
<P>To submit a translation for inclusion in CUPS, translate the desktop file, all of the template files, the <VAR>index.html.in</VAR> file, and the message catalog. Place these files in the correct subdirectories in the CUPS source code archive and run the following command to create an archive with your files:</P>
<PRE CLASS="command">
tar cvf <I>ll_CC</I>.tar.gz desktop/cups.desktop doc/<I>ll_CC</I> locale/cups_<I>ll_CC</I>.po templates/<I>ll_CC</I>
</PRE>
<P>Replace "ll_CC" with the locale name for your translation. Once you have created the archive, go to the <A HREF="https://github.com/apple/cups" TARGET="_blank">CUPS project page</A> and submit a bug report, attaching the translation to the report.</P>
<P>Alternately, you can clone the CUPS project on Github, make your changes, and submit a pull request from the same link.</P>
<H2 CLASS="title" ID="DESKTOP">The Desktop File</H2>
<P>The <VAR>desktop/cups.desktop</VAR> file provides a link to the CUPS web interface from desktop environments such as GNOME and KDE. To translate this file, add two lines to the bottom with the <tt>Name</tt> and <tt>Comment</tt> keys:</P>
<PRE CLASS="command">
Name[<I>ll_CC</I>]=<I>Translation of "Manage Printing"</I>
Comment[<I>ll_CC</I>]=<I>Translation of "CUPS Web Interface"</I>
</PRE>
<H2 CLASS="title" ID="HOMEPAGE">The Home Page</H2>
<P>The <VAR>index.html.in</VAR> file is a complete HTML file that is displayed when the user visits "http://localhost:631/". Edit the existing <VAR>doc/index.html.in</VAR> and save it in the <VAR>doc/ll_CC</VAR> subdirectory so that the configure script can generate it. After configuring, run "make install" in the <VAR>doc</VAR> subdirectory to test the new home page.</P>
<H2 CLASS="title" ID="CATALOGS">Message Catalogs</H2>
<P>CUPS message catalogs are GNU gettext ".po" text files that provide a list of localized message strings for the CUPS software. Message catalogs are named <VAR>cups_ll.po</VAR> or <VAR>cups_ll_CC.po</VAR>, where "ll" is the standard 2-letter abbreviation for the language and "CC" is the standard 2-letter abbreviation for the country.</P>
<P>When translating a new message catalog, copy the <VAR>cups.pot</VAR> message catalog file in the <VAR>locale</VAR> subdirectory of the CUPS source code. For example, to start translating the message catalog to Canadian French, you would type the following commands:</P>
<PRE CLASS="command">
cd locale
cp cups.pot cups_fr_CA.po
</PRE>
<P>Alternatively, you can copy the existing <VAR>cups_fr.po</VAR> message catalog and then make any necessary changes.</P>
<P>Once you have make your copy of the file, edit it using your favorite text editor or translation program to translate the text to the desired language.</P>
<P>Then validate your translation using the <VAR>locale/checkpo</VAR> utility:</P>
<PRE CLASS="command">
cd locale
./checkpo cups_ll_CC.po
</PRE>
<P>After fixing any errors in your translation, add your locale to the <CODE>LANGUAGES</CODE> variable in the <VAR>Makedefs</VAR> file and run the "make install" command in the <VAR>locale</VAR> subdirectory to test the translation. <em>This variable is automatically updated when you run the configure script.</em></P>
<H2 CLASS="title" ID="TEMPLATES">Template Files</H2>
<P>The CUPS scheduler provides a web interface that can be used to do many common printing and administration tasks. The built-in web server supports localization of web pages through the use of subdirectories for each locale, e.g. "fr" for French, "de" for German, "fr_ca" for French in Canada, and so forth.</P>
<P>Template files are HTML files with special formatting characters in them that allow substitution of variables and arrays. The CUPS CGI programs (<CODE>admin.cgi</CODE>, <CODE>classes.cgi</CODE>, <CODE>help.cgi</CODE>, <CODE>jobs.cgi</CODE>, and <CODE>printers.cgi</CODE>) use these template file to provide dynamic content for the web interface. Template files are installed in the <VAR>/usr/share/cups/templates</VAR> directory by default. <A HREF="table1">Table 1</a> lists the various template files and their purpose.</P>
<P>Translated versions of the template files should be saved in
the <VAR>templates/ll_CC</VAR> subdirectory. For example,
Canadian French template files should be saved in the
<VAR>templates/fr_CA</VAR> subdirectory. After you have
translated all of the templates, add the locale to the
<CODE>LANGUAGES</CODE> variable in the
<VAR>Makedefs</VAR> file and run "make install" in the
<VAR>templates</VAR> subdirectory to test the translation.</P>
<DIV CLASS="table"><TABLE ID="table1" SUMMARY="Web Interface Template Files">
<CAPTION>Table 1: Web Interface Template Files</CAPTION>
<THEAD>
<TR>
<TH>Filename</TH>
<TH>Purpose</TH>
</TR>
</THEAD>
<TBODY>
<TR>
<TD>add-class.tmpl</TD>
<TD>This is the initial form that is shown to add a new printer class.</TD>
</TR>
<TR>
<TD>add-printer.tmpl</TD>
<TD>This is the initial form that is shown to add a new printer.</TD>
</TR>
<TR>
<TD>admin.tmpl</TD>
<TD>This is the main administration page.</TD>
</TR>
<TR>
<TD>choose-device.tmpl</TD>
<TD>This is the form that shows the list of available devices.</TD>
</TR>
<TR>
<TD>choose-make.tmpl</TD>
<TD>This is the form that shows the list of available manufacturers.</TD>
</TR>
<TR>
<TD>choose-model.tmpl</TD>
<TD>This is the form that shows the list of available printer models/drivers.</TD>
</TR>
<TR>
<TD>choose-serial.tmpl</TD>
<TD>This is the form that allows the user to choose a serial port and any options.</TD>
</TR>
<TR>
<TD>choose-uri.tmpl</TD>
<TD>This is the form that allows the user to enter a device URI for network printers.</TD>
</TR>
<TR>
<TD>class.tmpl</TD>
<TD>This template shows information about a single class.</TD>
</TR>
<TR>
<TD>class-added.tmpl</TD>
<TD>This template shows the "class added" message.</TD>
</TR>
<TR>
<TD>class-confirm.tmpl</TD>
<TD>This is the template used to confirm the deletion of a class.</TD>
</TR>
<TR>
<TD>class-deleted.tmpl</TD>
<TD>This template shows the "class deleted" message.</TD>
</TR>
<TR>
<TD>class-jobs-header.tmpl</TD>
<TD>This template shows the "jobs" header for jobs in a class.</TD>
</TR>
<TR>
<TD>class-modified.tmpl</TD>
<TD>This template shows the "class modified" message.</TD>
</TR>
<TR>
<TD>classes.tmpl</TD>
<TD>This template shows one or more printer classes.</TD>
</TR>
<TR>
<TD>classes-header.tmpl</TD>
<TD>This template shows the "showing N of M classes" header in the class list.</TD>
</TR>
<TR>
<TD>command.tmpl</TD>
<TD>This template shows the status of a command job.</TD>
</TR>
<TR>
<TD>edit-config.tmpl</TD>
<TD>This is the cupsd.conf editor page.</TD>
</TR>
<TR>
<TD>error.tmpl</TD>
<TD>This template displays a generic error message.</TD>
</TR>
<TR>
<TD>error-op.tmpl</TD>
<TD>This is the "unknown operation" error page.</TD>
</TR>
<TR>
<TD>header.tmpl(.in)</TD>
<TD>This template is used as the standard header on all dynamic content. Edit the <VAR>header.tmpl.in</VAR> file and let the configure script generate the <VAR>header.tmpl</VAR> file.</TD>
</TR>
<TR>
<TD>help-header.tmpl</TD>
<TD>This is the top part of the help page.</TD>
</TR>
<TR>
<TD>help-printable.tmpl</TD>
<TD>This is the standard page header for the printable version of help files.</TD>
</TR>
<TR>
<TD>help-trailer.tmpl</TD>
<TD>This is the bottom part of the help page.</TD>
</TR>
<TR>
<TD>job-cancel.tmpl</TD>
<TD>This template shows "job canceled".</TD>
</TR>
<TR>
<TD>job-hold.tmpl</TD>
<TD>This template shows "job held".</TD>
</TR>
<TR>
<TD>job-move.tmpl</TD>
<TD>This template shows the move-job form.</TD>
</TR>
<TR>
<TD>job-moved.tmpl</TD>
<TD>This template shows "job moved".</TD>
</TR>
<TR>
<TD>job-release.tmpl</TD>
<TD>This template shows "job released".</TD>
</TR>
<TR>
<TD>job-restart.tmpl</TD>
<TD>This template shows "job reprinted".</TD>
</TR>
<TR>
<TD>jobs.tmpl</TD>
<TD>This template is used to list the print jobs on a server, class, or printer.</TD>
</TR>
<TR>
<TD>jobs-header.tmpl</TD>
<TD>This template shows the "showing N or M jobs" header in the jobs list.</TD>
</TR>
<TR>
<TD>list-available-printers.tmpl</TD>
<TD>This template shows a list of new printers that have been found.</TD>
</TR>
<TR>
<TD>modify-class.tmpl</TD>
<TD>This template is used as the first form when modifying a class.</TD>
</TR>
<TR>
<TD>modify-printer.tmpl</TD>
<TD>This template is used as the first form when modifying a printer.</TD>
</TR>
<TR>
<TD>norestart.tmpl</TD>
<TD>This template shows "server not restarted because no changes were made to the configuration".</TD>
</TR>
<TR>
<TD>option-boolean.tmpl</TD>
<TD>This template is used to select a boolean PPD option.</TD>
</TR>
<TR>
<TD>option-conflict.tmpl</TD>
<TD>This template shows the conflicting options.</TD>
</TR>
<TR>
<TD>option-header.tmpl</TD>
<TD>This template is used to start a PPD option group.</TD>
</TR>
<TR>
<TD>option-pickmany.tmpl</TD>
<TD>This template is used to select a multi-valued PPD option.</TD>
</TR>
<TR>
<TD>option-pickone.tmpl</TD>
<TD>This template is used to select a single-valued PPD option.</TD>
</TR>
<TR>
<TD>option-trailer.tmpl</TD>
<TD>This template is used to end a PPD option group.</TD>
</TR>
<TR>
<TD>pager.tmpl</TD>
<TD>This template shows the previous/next pager bar.</TD>
</TR>
<TR>
<TD>printer.tmpl</TD>
<TD>This template shows information about a single printer.</TD>
</TR>
<TR>
<TD>printer-accept.tmpl</TD>
<TD>This template shows "printer now accepting jobs".</TD>
</TR>
<TR>
<TD>printer-added.tmpl</TD>
<TD>This template shows "printer added".</TD>
</TR>
<TR>
<TD>printer-cancel-jobs.tmpl</TD>
<TD>This template shows "All jobs on printer have been canceled."</TD>
</TR>
<TR>
<TD>printer-configured.tmpl</TD>
<TD>This template shows "printer configured".</TD>
</TR>
<TR>
<TD>printer-confirm.tmpl</TD>
<TD>This template asks the user to confirm the deletion of a printer.</TD>
</TR>
<TR>
<TD>printer-default.tmpl</TD>
<TD>This template shows "default printer set".</TD>
</TR>
<TR>
<TD>printer-deleted.tmpl</TD>
<TD>This template shows "printer deleted".</TD>
</TR>
<TR>
<TD>printer-jobs-header.tmpl</TD>
<TD>This templates shows the "jobs" header for jobs on a printer.</TD>
</TR>
<TR>
<TD>printer-modified.tmpl</TD>
<TD>This template shows "printer modified".</TD>
</TR>
<TR>
<TD>printer-reject.tmpl</TD>
<TD>This template shows "printer now rejecting jobs".</TD>
</TR>
<TR>
<TD>printer-start.tmpl</TD>
<TD>This template shows "printer started".</TD>
</TR>
<TR>
<TD>printer-stop.tmpl</TD>
<TD>This template shows "printer stopped".</TD>
</TR>
<TR>
<TD>printers.tmpl</TD>
<TD>This template is used to list information on one or more printers.</TD>
</TR>
<TR>
<TD>printers-header.tmpl</TD>
<TD>This template shows the "showing printer N of M" header in the printers list.</TD>
</TR>
<TR>
<TD>restart.tmpl</TD>
<TD>This template shows "server restarting".</TD>
</TR>
<TR>
<TD>search.tmpl</TD>
<TD>This template shows the search form.</TD>
</TR>
<TR>
<TD>set-printer-options-header.tmpl</TD>
<TD>This template shows the first part of the set printer options form.</TD>
</TR>
<TR>
<TD>set-printer-options-trailer.tmpl</TD>
<TD>This template shows the last part of the set printer options form.</TD>
</TR>
<TR>
<TD>test-page.tmpl</TD>
<TD>This template shows "test page printed".</TD>
</TR>
<TR>
<TD>trailer.tmpl</TD>
<TD>This template is used as the standard trailer on all dynamic content.</TD>
</TR>
<TR>
<TD>users.tmpl</TD>
<TD>This template shows the set allowed users form.</TD>
</TR>
</TBODY>
</TABLE></DIV>
<H4 ID="VARIABLE">Inserting Attributes and Values</H4>
<P>Template files consist of HTML with variable substitutions for named inside curly braces "{name}". Variable names are generally the IPP attribute names with the hyphen ("-") replaced by the underscore ("_") character. For example, the <TT>job-printer-uri</TT> attribute is renamed to <TT>job_printer_uri</TT>.</P>
<P>Curley braces ("{" and "}") to indicate substitutions, and the backslash ("\") character for quoting. To insert any of these special characters as-is you need to use the HTML <CODE>&name;</CODE> mechanism or prefix each special character with the backslash ("\".)</P>
<P>You substitute the value of a variable using <CODE>{NAME}</CODE> in your template file. If the variable is undefined then the <CODE>{NAME}</CODE> string is output as-is.</P>
<P>To substitute an empty string if the variable is undefined, use <CODE>{?NAME}</CODE> instead.</P>
<H4>Array Substitutions</H4>
<P>The number of array elements can be inserted using <CODE>{#NAME}</CODE>. If the array is undefined then 0 is output. The current array element (starting at 1) is inserted with <CODE>{#}</CODE>.</P>
<P>Arrays are handled using <CODE>{[NAME]</CODE> at the beginning of a section and <CODE>}</CODE> at the end. The information between the closing bracket ("]") and closing brace ("}") is repeated for as many elements as are in the named array. For example, the following template will display a list of each job in the <CODE>job_id</CODE> array:</P>
<PRE CLASS="command">
<TABLE>
<TR>
<TH>Job ID</TH>
<TH>Destination</TH>
<TH>Title</TH>
</TR>
{[job_id]
<TR>
<TD>{?job_id}</TD>
<TD>{?job_printer_name}</TD>
<TD>{?job_name}</TD>
</TR>
}
</TABLE>
</PRE>
<P>Arrays can be nested, however all elements within the curly braces ("{" and "}") are indexed using the innermost array.</P>
<H4>Conditional Tests</H4>
<P>Templates can also test variables against specific values and conditionally include text in the template. The format is:</P>
<PRE CLASS="command">
{<I>variable</I>?<I>true</I>:<I>false</I>}
{<I>variable</I>=<I>value</I>?<I>true</I>:<I>false</I>}
{<I>variable</I>!<I>value</I>?<I>true</I>:<I>false</I>}
{<I>variable</I><<I>value</I>?<I>true</I>:<I>false</I>}
{<I>variable</I>><I>value</I>?<I>true</I>:<I>false</I>}
</PRE>
<P>where <VAR>true</VAR> is the text that is included if the condition is true and <VAR>false</VAR> is the text that is included if the condition is false. A value of <CODE>#</CODE> is replaced with the current element number (starting at 1.) The character after the variable name specifies the condition to test. <A HREF="#table2">Table 2</A> shows the available test conditions.</P>
<DIV CLASS="table"><TABLE ID="table2" SUMMARY="Template Substitution Conditions">
<CAPTION>Table 2: Template Substitution Conditions</CAPTION>
<TR>
<TH>Char</TH>
<TH>Condition</TH>
</TR>
<TR>
<TD>?</TD>
<TD>True if <VAR>variable</VAR> exists.</TD>
</TR>
<TR>
<TD>=</TD>
<TD>True if <VAR>variable</VAR> is equal to <VAR>value</VAR>.</TD>
</TR>
<TR>
<TD>!</TD>
<TD>True if <VAR>variable</VAR> is not equal to <VAR>value</VAR>.</TD>
</TR>
<TR>
<TD><</TD>
<TD>True if <VAR>variable</VAR> is less than <VAR>value</VAR>.</TD>
</TR>
<TR>
<TD>></TD>
<TD>True if <VAR>variable</VAR> is greater than <VAR>value</VAR>.</TD>
</TR>
</TABLE></DIV>
<H4 ID="LOCTMPL">What to Localize in a Template File</H4>
<P>Because HTML contains both markup (that generally is not localized) and text (which <em>is</em> localized), you should carefully avoid changing the markup unless it contains human-readable text. The following HTML examples show how to correctly localize template files:</P>
<P CLASS="command">
<!-- English table heading --><br>
<table class="list" summary="Printer List"><br>
<br>
<!-- Correctly localized to French; the class attribute is unchanged but summary is localized --><br>
<table class="list" summary="Liste des imprimantes"><br>
<br>
<br>
<!-- English hyperlink --><br>
<li><a {SECTION=help?class="active" :}href="/help/">Help</a></li><br>
<br>
<!-- Correctly localized to Danish; the href attribute is unchanged while the link text is localized --><br>
<li><a {SECTION=help?class="active" :}href="/help/">Hjælp</a></li><br>
</P>
<H3 ID="CGI">CGI Programs</H3>
<P>CUPS uses five CGI programs to manage the dynamic web interfaces:</P>
<UL>
<LI><CODE>admin.cgi</CODE></LI>
<LI><CODE>classes.cgi</CODE></LI>
<LI><CODE>help.cgi</CODE></LI>
<LI><CODE>jobs.cgi</CODE></LI>
<LI><CODE>printers.cgi</CODE></LI>
</UL>
<P>Each CGI program accepts standard form variables such as <CODE>OP</CODE> for the operation to perform, <CODE>PRINTER_NAME</CODE> for the printer or class name to operate on, <CODE>QUERY</CODE> for any search words,<CODE>FIRST</CODE> for the first class, job, or printer to display, and <CODE>ORDER</CODE> to control the order that classes, jobs, or printers are displayed.</P>
<P>In addition, the <CODE>classes.cgi</CODE>, <CODE>jobs.cgi</CODE>, and <CODE>printers.cgi</CODE> programs support a <CODE>WHICH_JOBS</CODE> variable to control which jobs are displayed. <A HREF="#table3">Table 3</A> lists the supported values.</P>
<DIV CLASS="table"><TABLE ID="table3" SUMMARY="WHICH_JOBS Values">
<CAPTION>Table 3: WHICH_JOBS Values</CAPTION>
<THEAD>
<TR>
<TH>WHICH_JOBS Value</TH>
<TH>Description</TH>
</TR>
</THEAD>
<TR>
<TD>all</TD>
<TD>Show all jobs</TD>
</TR>
<TR>
<TD>completed</TD>
<TD>Show completed jobs</TD>
</TR>
<TR>
<TD>not-completed</TD>
<TD>Show active jobs</TD>
</TR>
</TABLE></DIV>
<H4 ID="admin.cgi">admin.cgi</H4>
<P>The <CODE>admin.cgi</CODE> program handles all of the printer and class administration functions and is run for all direct accesses to the <VAR>/admin</VAR> resource. For most operations it uses the <CODE>PRINTER_NAME</CODE> and <CODE>OP</CODE> form variables to specify the action requested. <A HREF="#table4">Table 4</A> shows the supported <CODE>OP</CODE> values.</P>
<DIV CLASS="table"><TABLE ID="table4" SUMMARY="admin.cgi OP Values">
<CAPTION>Table 4: admin.cgi OP Values</CAPTION>
<THEAD>
<TR>
<TH>OP Value</TH>
<TH>Description</TH>
</TR>
</THEAD>
<TBODY>
<TR>
<TD>add-class</TD>
<TD>Adds a new printer class.</TD>
</TR>
<TR>
<TD>add-printer</TD>
<TD>Adds a new printer.</TD>
</TR>
<TR>
<TD>config-server</TD>
<TD>Configures the server.</TD>
</TR>
<TR>
<TD>delete-class</TD>
<TD>Deletes a printer class. The form variable <CODE>CONFIRM</CODE>
may be set to any value to bypass the confirmation page.</TD>
</TR>
<TR>
<TD>delete-printer</TD>
<TD>Deletes a printer. The form variable <CODE>CONFIRM</CODE>
may be set to any value to bypass the confirmation page.</TD>
</TR>
<TR>
<TD>find-new-printers</TD>
<TD>Find new printers that have not yet been added.</TD>
</TR>
<TR>
<TD>modify-class</TD>
<TD>Modifies a printer class.</TD>
</TR>
<TR>
<TD>modify-printer</TD>
<TD>Modifies a printer.</TD>
</TR>
<TR>
<TD>redirect</TD>
<TD>Redirects the web browser to the location referenced by
the URL form variable.</TD>
</TR>
<TR>
<TD>set-allowed-users</TD>
<TD>Sets the allowed users for a destination.</TD>
</TR>
<TR>
<TD>set-as-default</TD>
<TD>Sets the default destination.</TD>
</TR>
<TR>
<TD>set-printer-options</TD>
<TD>Sets the default options for a printer.</TD>
</TR>
<TR>
<TD>set-sharing</TD>
<TD>Sets the printer-is-shared attribute for a destination.</TD>
</TR>
</TBODY>
</TABLE></DIV>
<H4 ID="classes.cgi">classes.cgi</H4>
<P>The <CODE>classes.cgi</CODE> program is responsible for listing class information, including jobs destined for that class. It is for all direct accesses to the <VAR>/classes</VAR> resource and supports the optional form variables <CODE>OP</CODE> and <CODE>WHICH_JOBS</CODE>. If no form variables are supplied then the CGI lists all or a specific class and the active jobs on each class. <A HREF="#table5">Table 5</A> shows the supported <CODE>OP</CODE> values.</P>
<DIV CLASS="table"><TABLE ID="table5" SUMMARY="classes.cgi OP Values">
<CAPTION>Table 5: classes.cgi OP Values</CAPTION>
<THEAD>
<TR>
<TH>OP Value</TH>
<TH>Description</TH>
</TR>
</THEAD>
<TBODY>
<TR>
<TD>accept-jobs</TD>
<TD>Start accepting jobs for a class.</TD>
</TR>
<TR>
<TD>cancel-jobs</TD>
<TD>Cancel all jobs for a class.</TD>
</TR>
<TR>
<TD>move-jobs</TD>
<TD>Move all jobs to a different destination.</TD>
</TR>
<TR>
<TD>print-test-page</TD>
<TD>Print a PostScript test page.</TD>
</TR>
<TR>
<TD>reject-jobs</TD>
<TD>Stop accepting jobs for a class.</TD>
</TR>
<TR>
<TD>start-class</TD>
<TD>Start processing jobs for a class.</TD>
</TR>
<TR>
<TD>stop-class</TD>
<TD>Stop processing jobs for a class.</TD>
</TR>
</TBODY>
</TABLE></DIV>
<H4 ID="help.cgi">help.cgi</H4>
<P>The <CODE>help.cgi</CODE> program handles all of the on-line help functions and is run for all direct accesses to the <VAR>/help</VAR> resource.</P>
<H4 ID="jobs.cgi">jobs.cgi</H4>
<P>The <CODE>jobs.cgi</CODE> program handles all of the job functions and is run for all direct accesses to the <VAR>/jobs</VAR> resource. For most operations it uses the <CODE>JOB_ID</CODE>, <CODE>OP</CODE>, and <CODE>WHICH_JOBS</CODE> form variables to specify the action requested. <A HREF="#table6">Table 6</A> shows the supported <CODE>OP</CODE> values.</P>
<DIV CLASS="table"><TABLE ID="table6" SUMMARY="jobs.cgi OP Values">
<CAPTION>Table 6: jobs.cgi OP Values</CAPTION>
<THEAD>
<TR>
<TH>OP Value</TH>
<TH>Description</TH>
</TR>
</THEAD>
<TBODY>
<TR>
<TD>cancel-job</TD>
<TD>Cancels a job.</TD>
</TR>
<TR>
<TD>hold-job</TD>
<TD>Holds a job indefinitely.</TD>
</TR>
<TR>
<TD>move-job</TD>
<TD>Moves a job to another destination.</TD>
</TR>
<TR>
<TD>release-job</TD>
<TD>Releases a job for printing.</TD>
</TR>
<TR>
<TD>restart-job</TD>
<TD>Restarts/reprints a stopped, canceled, completed, or aborted
print job.</TD>
</TR>
</TBODY>
</TABLE></DIV>
<H4 ID="printers.cgi">printers.cgi</H4>
<P>The <CODE>printers.cgi</CODE> program is responsible for listing printer information, including jobs destined for that printer. It is for all direct accesses to the <VAR>/printers</VAR> resource and supports the optional form variables <CODE>OP</CODE> and <CODE>WHICH_JOBS</CODE>. If no form variables are supplied then the CGI lists all printers or a specific printer and the active jobs on that printer. <A HREF="#table7">Table 7</A> shows the supported <CODE>OP</CODE> values.</P>
<DIV CLASS="table"><TABLE ID="table7" SUMMARY="printers.cgi OP Values">
<CAPTION>Table 7: printers.cgi OP Values</CAPTION>
<THEAD>
<TR>
<TH>OP Value</TH>
<TH>Description</TH>
</TR>
</THEAD>
<TBODY>
<TR>
<TD>accept-jobs</TD>
<TD>Start accepting jobs for a printer.</TD>
</TR>
<TR>
<TD>cancel-jobs</TD>
<TD>Cancel all jobs for a printer.</TD>
</TR>
<TR>
<TD>clean-print-heads</TD>
<TD>Clean the print heads.</TD>
</TR>
<TR>
<TD>move-jobs</TD>
<TD>Move all jobs to a different destination.</TD>
</TR>
<TR>
<TD>print-self-test-page</TD>
<TD>Print a printer self-test page.</TD>
</TR>
<TR>
<TD>print-test-page</TD>
<TD>Print a PostScript test page.</TD>
</TR>
<TR>
<TD>reject-jobs</TD>
<TD>Stop accepting jobs for a printer.</TD>
</TR>
<TR>
<TD>start-printer</TD>
<TD>Start processing jobs for a printer.</TD>
</TR>
<TR>
<TD>stop-printer</TD>
<TD>Stop processing jobs for a printer.</TD>
</TR>
</TBODY>
</TABLE></DIV>
</BODY>
</HTML>
|
