{"id":98,"date":"2007-09-28T17:51:43","date_gmt":"2007-09-29T01:51:43","guid":{"rendered":"http:\/\/www.outflux.net\/blog\/archives\/2007\/09\/28\/cups-banner-template-variables\/"},"modified":"2007-09-28T17:51:43","modified_gmt":"2007-09-29T01:51:43","slug":"cups-banner-template-variables","status":"publish","type":"post","link":"https:\/\/outflux.net\/blog\/archives\/2007\/09\/28\/cups-banner-template-variables\/","title":{"rendered":"CUPS banner template variables"},"content":{"rendered":"

A while back, I wanted to design some banner pages for a shared network printer that would show the name of the host that sent the request (none of the standard CUPS banners report this). It was easy enough to define a custom banner page:<\/p>\n

\n
\r\n<Printer lj4200>\r\n...\r\nJobSheets shared-banner none\r\n...\r\n<\/Printer>\r\n<\/pre>\n<\/blockquote>\n
Then, I could drop a modified banner into \/usr\/share\/cups\/banners<\/code> with the filename “shared-banner”.  The banner is just a regular PostScript file, so I could muck around with it.  While looking at the “standard” banner, I saw some PS variables being used that had been defined by CUPS:<\/p>\n
\n
\r\n...\r\n  (Job ID: ) RIGHT\r\n  2 copy                % Copy X & Y\r\n  moveto\r\n  ({printer-name<\/strong>}-{job-id<\/strong>}) show\r\n...\r\n<\/pre>\n<\/blockquote>\n
I couldn’t find documentation on the available variables, but managed to track down some of the list at cupsGetJobs2 in cups\/utils.c<\/a>:<\/p>\n
\njob-id
\njob-priority
\njob-k-octets
\njob-state
\ntime-at-completed
\ntime-at-creation
\ntime-at-processing
\njob-printer-uri
\ndocument-format
\njob-name
\njob-originating-user-name\n<\/p><\/blockquote>\n
None of these had the sending host listed, so I continued searching.  Additional ones are defined in scheduler\/ipp.c<\/a>, including:<\/p>\n
\nprinter-name
\njob-id
\njob-billing
\njob-hold-until
\njob-sheets
\njob-media-sheets-completed
\njob-originating-host-name\n<\/p><\/blockquote>\n
“job-originating-host-name” did the trick for my banner:<\/p>\n
\n
\r\n...\r\n  (Host: ) RIGHT\r\n  moveto\r\n  ({job-originating-host-name}) show\r\n...\r\n<\/pre>\n<\/blockquote>\n
I’ve seen some other partial<\/a> lists<\/a>, but I haven’t found an official complete list.  It’d be handy to see this documented better, since some variables aren’t valid until after the job is processed (job-sheets), so it’s only valid in the trailing banner, not the leading banner.<\/p>\n
© 2007, Kees Cook<\/a>. This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 License<\/a>.
\"CC<\/a> <\/p>\n","protected":false},"excerpt":{"rendered":"
A while back, I wanted to design some banner pages for a shared network printer that would show the name of the host that sent the request (none of the standard CUPS banners report this). It was easy enough to define a custom banner page: <Printer lj4200> … JobSheets shared-banner none … <\/Printer> Then, I […]<\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[7,14],"tags":[],"_links":{"self":[{"href":"https:\/\/outflux.net\/blog\/wp-json\/wp\/v2\/posts\/98"}],"collection":[{"href":"https:\/\/outflux.net\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/outflux.net\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/outflux.net\/blog\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/outflux.net\/blog\/wp-json\/wp\/v2\/comments?post=98"}],"version-history":[{"count":0,"href":"https:\/\/outflux.net\/blog\/wp-json\/wp\/v2\/posts\/98\/revisions"}],"wp:attachment":[{"href":"https:\/\/outflux.net\/blog\/wp-json\/wp\/v2\/media?parent=98"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/outflux.net\/blog\/wp-json\/wp\/v2\/categories?post=98"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/outflux.net\/blog\/wp-json\/wp\/v2\/tags?post=98"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}