33. CUPS

Data and functions related only to CUPS

33.1. Summary of Module Globals

List of Global Functions

List of Global Variables

33.2. Global Functions

33.2.1. ClientRead

Read settings of CUPS client-only

Return value

  • string - default queue name (empty if server-default is used, nil on fail) TODO error handling

33.2.2. DetectCupsUsbDevicesInfo

Detect information about USB devices using the CUPS USB backend Also store this information to Printerlib module

Return value

  • list<list<string> > - a list of detected devices

33.2.3. GetAvailableQueues

List all available queues (local and remote)

Return value

  • list<string> - a list of strings all available queues

33.2.4. GetCupsUsbDevices

Get all CUPS-like USB device names

Return value

  • list<string> - a list of CUPS USB device names

33.2.5. GetProblematicCupsUsbDevices

Get problematic CUPS USB devices names

Return value

  • list<string> - a list of strings with problematic device names

33.2.6. GetSupportedUriTypes

Get URI Types supported by CUPS

Return value

  • list<string> - a list of supported URI types

33.2.7. GetSystemForbiddenNames

Get the list of queue names that are forbidden by the spooler

Return value

  • list<string> - a list of forbidden queue names

33.2.8. InstallationType

If only client is installed or remote server to use is set, returns 1, if this is real server installation, returns 0 Also sets server_hostname and cups_installation

Return value

  • symbol - `client or `server

33.2.9. ListenCupsServers

Get hosts available on local network via listening to IPP broadcasts

Return value

  • list - Sorted list of hosts

33.2.10. LoadServerHostName

Read client.conf host name to server_hostname

Return value

  • void

33.2.11. ProposeClientOnly

Propose Client only with a CUPS server listen_remote_ipp must have neen started befor this function is called

Return value

  • void

33.2.12. ProposeServerSettings

Propose the CUPS server settings

Return value

  • void

33.2.13. ReadCupsSettings

Reads CUPS server settings from /etc/cups/cupsd.conf file

Return value

  • boolean - true on success

33.2.14. SaveCupsClient

Save CUPS client-only configuration

Function parameters

  • string default_queue

Return value

  • boolean - true on success

33.2.15. SaveServerHostName

Save client.conf host name host name

Return value

  • boolean - true on success

33.2.16. StartDaemon

start CUPS server and don't wait until initialization finishes

Return value

  • void

33.2.17. StopListenCupsServers

Immediatelly stop listenning to IPP broadcasts via the script

Return value

  • void

33.2.18. WaitForCupsListeiningFinish

Wait until listening to CUPS IPP broadcasts finishes

Return value

  • void

33.2.19. WriteCupsSettings

Writes CUPS server settings to /etc/cups/cupsd.conf file

Return value

  • boolean - true on success

33.2.20. WriteQueue

Write configuration to CUPS

Function parameters

  • map entry

Return value

  • boolean - true if successfull

33.2.21. getBannerList

Get list of possible banners for CUPS server

Return value

  • list<string> - a list banners names

33.3. Global Variables

33.3.1. cups_installation

Type of cups installation. nil: unknown `server: server `client: client

33.3.2. cups_server_permissions

Settings of CUPS server

33.3.3. cups_server_settings

Settings of CUPS server

33.3.4. cups_servers

List of detected CUPS servers

33.3.5. server_default

When configuring client, using server's default queue?

33.3.6. server_hostname

If this is only cups client station, server host name is here.

33.3.7. usb_dev_names

Use CUPS-like USB devices names `always, `never, `serial

33.4. Module Requirements

33.4.1. Module Imports

  • Arch
  • Label
  • Package
  • Printerlib
  • Report
  • Service
  • SuSEFirewall

33.4.2. Module Includes