=================================================
XEROX SERVICES FOR UNIX SYSTEMS


Administrator Guide
=================================================

CONTENTS

ABOUT XEROX SERVICES FOR UNIX SYSTEMS (XSUS)
>>Introduction
>>Network and Hardware Requirements
>>Selecting a Printing Model

INSTALLING XSUS
>>Log In
>>Download the Installation Files
>>Perform the Common Install Procedure

XSUS FEATURES
>>Requirements
>>Key Features and Benefits

USING THE GRAPHICAL USER INTERFACE
>>Menu Bar
>>Printers List
>>Tool Buttons

ACCESSING XSUS

PRINTER MENU: QUEUE SETUP
>>Adding a New Printer Queue
>>Copying a Queue
>>Deleting a Queue
>>Modifying a Queue

PRINTER MENU: DISCOVERY (FIND AND QUERY PRINTERS)
>>Using Subnet Address
>>Using IP Address

TOOLS MENU
>>Test Print
>>Send File
>>Upgrade Printers
>>Preferred Browser
>>Reset Printer
>>SNMP Services
>>Internet Services

SNMP SERVICES
>>Status Tab
>>Properties Tab

INTERNET SERVICES

DISPLAY SETTINGS MENU

PRINTING
>>Xprint Commands
>>Using Command Line Options

TRANSLATION FILES FOR COMMAND LINE OPTIONS
>>Translation File Syntax
>>Translation Line Layout

QUEUE MANAGEMENT TOOLS
>>xpq
>>xprm
>>lp and lpr

APPENDIX A. COMMAND LINE QUEUE CREATION
>>xpqadmin
>>Examples
>>Procedure

============================================
ABOUT XEROX SERVICES FOR UNIX SYSTEMS (XSUS)

>>Introduction

This guide explains how to install Xerox Services for Unix Systems (XSUS) and configure a printer on various Unix and Linux systems.
With XSUS you can:

* Configure and check the status of network connected printers.
* Quickly set up a printer on your network as well as monitor the operation of the printer once it has been installed.
* Perform maintenance checks at any time. This minimizes down time by enabling you to check consumables status any time you wish and then schedule replacement during off-peak usage.

XSUS supports a variety of Unix and Linux platforms, and supports Xerox printers as well as non-Xerox printers.

>>Network and Hardware Requirements

The requirements for printer connection and setup include:

* A workstation with an appropriate Unix operating system software installed.
* A network interface on your printer and appropriate cabling for your network or a parallel printer to connect your workstation and printer.


>>Selecting a Printing Model

Before installing XSUS, decide which of the following printing models to use.

Workstation-to-Printer (Peer-to-Peer)
Print jobs are spooled locally and sent directly to the printer. XSUS must be installed on each workstation.

Workstation-to-Server (Client-Server)
Print jobs are spooled on the server. XSUS must be installed on each workstation and on the server.

Server Based Printing
Print jobs are spooled on the server. XSUS must be installed on the server. Workstations use native operating system tools (lp, lpr) for print job submission.
The advantage of server based printing is that workstation users can select printing features for each print job without having XSUS installed on their workstations.

NIS Server Based Printing
NIS uses a printer configuration map on the server. When new printer queues are added to a print server, only the configuration file in the master NIS server must be updated. NIS clients can then print to queues listed on the server map without setting up local queues.

Note: Consult your Unix operating system manual for more information on how to set up NIS-based printing.

===============
INSTALLING XSUS

>>Log In

Log in with ROOT or superuser privileges.

>>Download the Installation Files

File Names

You must download two .tgz files:

* The Printer Model Package file, which contains ppd files for all printer models. The file name is XeroxPrinterPkgXPXX_20xx_xx_xx.tgz.
* The printer driver file for your operating system. The available files are:
      XeroxAIXpowerpcxpxx_x.xx.xx.tgz
      XeroxHPUXXPXX_x.xx.xx.tgz
      XeroxLinuxi386XPXX_x.xx.xx.tgz
      XeroxSolarisXPXX_x.xx.xx.tgz

Locate the Files

1. Go to www.xerox.com and select Support & Drivers.
2. Select Multifunction > WorkCentre > 7755/7765/7775 Multifunction Printer > Drivers & Downloads.
3. In the Operating System list, select UNIX, Linux, or Sun Solaris.
4. In the Language list, select a language.
5. Click Go.

Download the Files

1. Set up a temporary directory.
2. Download the printer driver and Printer Model Package .tgz files to the temporary directory.
Note: Each expanded .tgz file requires as much as four times its original size in disk space.
3. Type "gzip -dfv {filename}" and press Return. The {filename} must include a .tgz extension.
4. Type "tar -xvf {filename}" and press Return. This step must be done for both the printer driver and the Printer Model Package .tgz files.
The files are expanded and two directories are created with names that match the printer driver and Printer Model Package .tgz file names.
 Perform the Common Install Procedure
1. Change your current directory to the install directory created by the expansion of the printer driver .tgz file.
2. Enter "./setup".
3. Change your current directory to the install directory created by the expansion of thePringer Model Package .tgz file.
4. Enter "./setup".

The installation creates a Xerox directory in /usr or /opt depending on your operating system.

Note: After installation, the .tgz files or the expanded files are not deleted.

=============
XSUS FEATURES

>>Requirements

Before using XSUS features, make sure:

* You understand the terminology of the printer.
* The network interface on your printer is connected to an active network with the appropriate cable.
* XSUS is loaded on a supported workstation and connected to the same active network as the printer.
* ROOT or superuser privileges are in place to set up or change the configuration of a printer.

>>Key Features and Benefits

* Instant Status: Select a printer from the Printers List to see current printer status.
* Remote Configuration: Configure and monitor tasks from your workstation.
* Diagnostics:Troubleshoot from your desk.
* Printer Upgrades: If your printer is equipped with Flash ROM, upgrade system or network software.
* Link to Internet Services: Many Xerox printers are equipped with embedded http servers. For these printers, XSUS provides links to Internet Services. Remote configuration for these printers is accomplished through Internet Services using your browser application.
* SNMP: For Xerox legacy printers and non-Xerox printers XSUS directly supports remote configuration.

==================================
USING THE GRAPHICAL USER INTERFACE

>>Menu Bar

Located across the top of the screen, these options contain the drop-down menus used in XSUS:
Printer, Tools, Display Settings, and Help.

>>Printers List

The Printers List displays descriptions of the printers supported by XSUS, including Hostname or System Name, IP Address, Hardware Address, and Device Type.

* Click on any printer in this list to select it for configuration or monitoring.
* Click Refresh to poll the network for supported printers and update the Printers List.

You can customize the display using the Display Settings menu. See "Display Settings Menu" for instructions.

>>Tool Buttons

Located below the Printers List, these buttons enable one-click access to:

* Online Help
* Refresh (the Discovered Printers list)
* Add Queue
* Internet Services
* SNMP Services

==============
ACCESSING XSUS

XSUS automatically detects if your system's X server can run in graphical mode and will start accordingly (using the display environment variable). If it cannot open in graphical mode, it opens in tty mode.

Note: You can also type "xpadmin –tty" to use non-graphical mode.

* From a terminal window prompt, type "xpadmin" and press Return.

=========================
PRINTER MENU: QUEUE SETUP

>>Adding a New Printer Queue

The Setup Wizard guides you through the installation of a new printer.
For information about printing models, see "Selecting a Printing Model."
For instructions to set up a printer queue using the command line option, see Appendix A. "Command Line Queue Creation."
Note: You must log in with ROOT or superuser privileges to complete these procedures.

Set Up a Workstation-to-Printer Queue

1. Type "xpadmin" to access XSUS.
2. Select a printer from the Printers List.
3. Do one of the following:
* Click the Add Queue button.
* On the menu bar, select Printer > Queue Setup > Add.
4. In Queue name, enter the name for your queue.
5. From Printer Type, choose the printer.
6. From Printing model, select workstation to printer.
7. From Printer connection, choose a connection method for your printer.
8. In Printer host name, enter the host name or TCP/IP address of your printer.
9. From Default printer, select Yes to make this printer the default printer (if desired).
Note: XSUS will recognize a default printer only if the printer is set up using XSUS.
10. From Features, enable or disable print features when submitting a print job to your printer.
11. From User interface, enable or disable the graphical mode when submitting a print job to your printer.
12. Click Configure Printer Features to change the default print options for your printer.
Note: Configured printer features (installable options, media type) apply to postscript print jobs only. PCL does not incorporate any configured features.
13. When finished, click Save Queue Settings.
14. Click OK to save your settings.
15. Run a test print from an application or select Tools > Test Print to verify printer operation.

Set Up a Workstation-to-Print Server Queue

1. Type "xpadmin" to access XSUS.
2. Select a printer from the Printers List.
3. Do one of the following:
* Click the Add Queue button.
* On the menu bar, select Printer > Queue Setup > Add.
4. In Queue name, enter the name for the queue created on the remote print server.
5. From Printer Type, choose your printer.
6. From Printing model, select workstation to print server.
7. From Printer connection, select a connection method for your printer.
8. In Print host name, enter the host name of the remote workstation to be used as a print server.
9. In Print server queue name, enter the queue name on the remote workstation used for your printer.
10. From Default printer, select Yes to make this printer the default printer (if desired).
11. From Features, enable or disable the setting of print features when submitting a print job to your printer.
12. From User interface, enable or disable the graphical mode when submitting a print job to your printer.
13. Click Configure Printer Features to change the default print options for your printer.
Note: Configured printer features (installable options, media type) apply to postscript print jobs only. PCL does not incorporate any configured features.
14. When finished, click Save Queue Settings.
15. Click OK to save your settings.
16. Run a test print from an application or select Tools > Test Print to verify printer operation.

Set Up Server Based Printing

Set up a queue on the server:
1. From Printing model, select "workstation to printer".
2. From User interface, enable the graphical mode.
3. On each workstation that will print to the printer, set up a queue to spool the print jobs on the server using your native operating system print administration tools.

Set Up NIS Server Based Printing

(as provided by your operating system)

Set up a queue on the server:
1. Follow the instructions for setting up a workstation to printer queue.
2. Define the queue in the NIS server's configuration map.
3. Execute xhost +servername to allow ServerName X permissions.

>>Copying a Queue

1. Select Printer > Queue Setup > Copy.
2. Select a queue to copy from the Print Queue list.
3. Click Copy.
4. Make the desired changes to the connectivity options.
5. Click OK to save your changes.

>>Deleting a Queue

1. Select Printer > Queue Setup > Delete.
2. Select the queue(s) to delete from the Print Queue List.
3. Click Delete to delete the queue and remain in the Delete Queue window.
4. Click OK to confirm the delete and exit the Delete Queue window.

>>Modifying a Queue

Note: You cannot modify the Queue name, Printer Type, Printing Model, or Connection Type.
1. Select Printer > Queue Setup > Modify.
2. Select a queue to modify from the Print Queue List.
3. Click Modify
4. Make the desired changes to the queue features.
5. Click OK to save your changes.

=================================================
PRINTER MENU: DISCOVERY (FIND AND QUERY PRINTERS)

This feature enables you to find printers from multiple subnets on your network, and also query specific printers.
Note: You cannot discover printers on the internet.

>>Using Subnet Address

Add/Set
1. Select Printer > Discovery.
2. Select the Subnet Address tab.
3. Enter the subnet address and subnet mask:
Subnet Address selects a range of subnets to search. A subnet address may be any valid node address within the subnet, for example 13.252.20.0.
Subnet Mask selects a range of TCP/IP addresses to search. This entry is automatically set to the default mask used by the workstation (255.255.255.0).
4. Click Add to add the subnet to the list.
5. When finished, click OK to exit.

Remove
1. Select the subnet address or mask to be deleted.
2. Click Remove.
Note: Local Network Interface Cards are displayed by default in the list and can only be enabled or disabled; not removed.

Enable/Disable
1. Select the subnet address or subnet mask.
2. Then click Enable/Disable.

Update Local Interfaces
Use to automatically refresh the list of local Network Interface cards.

>>Using IP Address

Use to select a list of specific TCP/IP addresses to search.

Add
* Select the IP Address tab, enter the desired IP address, and click Add.

Remove
* Select the IP Address tab, select the IP address to be deleted, and click Remove.

==========
TOOLS MENU

>>Test Print

Test Print sends a test file to a printer to verify printer operation.
1. Select Tools > Test Print.
2. Select the print queue.
3. Click Send File to send the file to print.

>>Send File

Select Send File to locate a file to print on a selected printer.
1. Select Tools > Send File.
2. Select a directory and file. To limit the available file entries, click Filter.
3. Select a file from the displayed directory window.
4. Click OK.

>>Upgrade Printers

Many of the printers that XSUS supports are equipped with Flash ROM on the Main Controller card and/or the network interface. You can update these printers using the Tools menu.
You should consult your printer documentation to determine if your printer is equipped with Flash ROM and on which card it is located. Also, some printer models supported by XSUS may require you to perform the upgrade while connected to the serial or parallel port of the printer.

Notes:
You must have a queue configured for any printer that you want to upgrade.
Do not issue any XSUS commands during the upgrade process.

Upgrade Procedure
This procedure requires special upgrade file(s) for each type of printer. The files are available from the Xerox website under the Support & Drivers tab (www.xerox.com).
1. Start XSUS from your workstation.
2. Select Tools > Upgrade. If the upgrade entry is not available, the selected printer requires a direct connection (serial or parallel port) for upgrading.
3. Enter the path where the upgrade file is located and click OK.
4. Select the queue for the printer that you want to upgrade and click Send File.
5. The file is copied to the printer. Once the upgrade has been completed, the printer resets and prints a confirmation page containing information about the new version of firmware.
6. Repeat this procedure if the Main Controller and the network interface are separate firmware files.

>>Preferred Browser

Use this option to choose the browser application to use for Internet Services. When selected, a dialog appears in which you enter the directory path of the browser.

>>Reset Printer

Use to reset the printer.

>>SNMP Services

Use the access the SNMP Services options. See "SNMP Services" for more information.

>>Internet Services

Opens a browser and displays the printer's Internet Services home page (if available). See "Internet Services" for more information.

=============
SNMP SERVICES

SNMP Services supports printers that do not contain an embedded http server for Internet Services. The tabs display printer status, configuration, and consumable information.
Note: The information displayed will vary for different printer models.

>>Status Tab

Select Status to view printer status and configuration information directly from the printer.

Control Panel
This tab shows a printer's control panel. The printer's ready status and control panel messages appear. You can also set the refresh interval, which defines how often to refresh the display with new information.

Input
This tab shows a printer's input tray information. The media type, the media size, the amount of media in each tray, and total tray capacity are displayed.

Consumables
This tab shows a printer's ink levels, marker levels, cartridges, oil, or developer waste information.

Output
This tab shows output destinations, individual output tray capacity, and total output tray capacity.

General
This tab shows a printer's supported languages, installed memory, and page count information.

Network
This tab shows a printer's network configuration, such as speed, packet, and interface data. Select:

* Interface to view network interface information.
* IP to view IP information.
* UDP to view this information.
* SNMP Inbound or SNMP Outbound to view this information.

>>Properties Tab

Select Properties to work with contact and print channel information.

Contact
This tab is used for viewing and configuring contact information such as system name, location, and person responsible for the printer.

Print Channel
This tab is used for configuring TCP/IP, enabling a printer's embedded http server, network, port, and Appletalk information.

=================
INTERNET SERVICES

Note: You should set a preferred browser before using this option.
For printers that contain an embedded http server, select a printer and then click Internet Services to open a printer's home page. Using Internet Services, an administrator can define the printer settings and network connections as well as monitor the printer status.
Internet Services enables remote printer configuration, monitoring, and managing on networks. Status checks on consumables such as toner and paper supply can be done immediately. Links to Xerox Support resources are also provided.

=====================
DISPLAY SETTINGS MENU

Use this menu to select the information to display in the Printers List, such as host or system name, IP address, hardware address, or the type of printer.
1. Select Display Settings.
2. Select Show System Name or Show hostname.
3. Select any of the following check boxes:
Show IP Address
Show Hardware Address
Show Device Type
4. Click OK.

========
PRINTING

In addition to the lp and lpr commands, you can use the Xerox Print Submission Tool, xprint.

Printing options are selected from the GUI, depending on how the queue was created:

* If the queue was created with the User Interface enabled, print features can be selected using the graphical mode.
* If the queue was created with the User Interface disabled, print jobs are printed in silent mode using the default print features.

>>Xprint Commands

The following formats are supported:

      xprint [options] [filename …]

The following options are supported:

-Pprinter_name = printer queue name
-cnumber = print number copies of filename.
-Fnumber = Use text font size number, number = (4, 5, 6, … , 16, 18, 20, … , 40)
-FC = Convert non printable character to octal notation
-dprinter_name = printer queue name
-n or -nomenu = Do not display menu or user interface.
-sProfileName = Load printer profile settings.
-oOptions = Print a list of all options available for a printer.
-oOption_name = Set the option_name printer feature.

For example, to print with predefined settings, enter -sProfileName -n, which loads the profile settings file and print input file names.

>>Using Command Line Options

You can send command line options to the print driver using either the xprint or lp command. With each call to xprint or lp, use the -o option plus the printer feature that you wish to set.

Features work from the command line only if the required installable option is selected during queue set up and has not been restricted by a selected feature, for example, duplex printing with paper size of envelope selected will not work because 2-sided printing for envelopes is not an allowable option.

For example, if you want to print on legal paper, enter the -oLegal option on the command line to print on legal paper:
      lp -dtest_queue -oLegal paper.ps

You can print a listing of all options available on your printer by entering:
      lp -dtest_queue -oOptions /etc/hosts

Note: Only the options sheet is printed; not /etc/hosts.

==========================================
TRANSLATION FILES FOR COMMAND LINE OPTIONS

You can create translation files for your printer. Creating translation files allows you to create a new command line option that can contain a list of features to use or simply rename an existing feature.

You can create two translation files. Both files must reside in the installation directory in a directory named trl. If this directory does not exist, it may be created by a superuser.

Example: /opt/Xerox/xpxx/trl

The first file is named common.trl. It is the first translation file that is referenced when the driver searches for an unknown feature name.

Example: /opt/Xerox/xpxx/ppd/xr_N40.ppd => /opt/Xerox/xpxx/trl/xr_N40.trl

The second translation file is named using the printer ppd name with the trl extension added to it.

>>Translation File Syntax

1. Each translation contains a required key name, an optional feature label separated with a slash ( / ), and a single feature or a list of features.
2. Each translation must be contained within a single line of text. A continuous text line may be wrapped to another line by using a backslash ( \ ) at the end of the wrapping line(s).
3. A pound sign ( # ) marks the beginning of a comment field. All text following the # is ignored.
4. Use either a colon ( : ) or an equal sign ( = ) to define the type of translation being defined. A colon implies that you are creating a macro (list of features). An equal sign implies that you are creating a definition (renaming an existing feature).

>>Translation Line Layout

a) name/
b) label :
c) feature_x

==========================================
Line Section      Entry       Definition
===========================================
a)          Name        A unique key word that is used to identify this translation, {a…z, A…Z, 0…9}. May be used as a command line -o option or in other translations.
b)          Label       A label text associated with this macro
c)          feature_x   The following items are allowed:
                        i. translation key word
                        ii. built-in feature (see -oOptions)
                        iii. ppd file feature ==> <UI Name>=<UI option name>

Examples:

name/label : feature_1 feature_2 … feature_n
name/label : feature_1 feature_2 \feature_3 feature_4 \feature_5 … feature_n
name/label = feature_1

=======================
QUEUE MANAGEMENT TOOLS

>>xpq

This utility is equivalent to the Unix lpq command. It allows you to view the current job list for your print queues. The utility executes and continues to run and update the screen until all jobs are gone from the queue. You can exit the utility by pressing the key combination [Control C].

Use the following command line to execute xpq:

      xpq [print_queue_name] [interval]

where:
[print_queue_name] is the queue name to monitor.
[interval] is the specified time between screen updates (in seconds). If no interval is specified, the utility will display the current queue status and exit.

>>xprm

xprm enables an administrator (with ROOT privileges) to delete any print jobs or any general user to delete their own print jobs.

This utility is equivalent to the Unix lprm command. It allows you to delete jobs currently in a job queue. Before using xprm, run the xpq utility for the desired queue and note the job number and job name of the print job you want to delete.

Use the following command to execute xprm:
      xprm [print_queue_name] [job_number.job_name]

where:
[print_queue_name] is the queue name containing the print job to delete.
[job_number.job_name] is the job number and job name of the print job to delete.

>>lp and lpr

Use the print submission tools lp and lpr to submit print jobs to the remote server. See "Selecting a Printing Model" for more information.

If the user interface for the queue you are printing to was enabled during setup, and the display access IDs were properly configured for the server, each print job submitted will enable the graphical mode on the workstation.

Note: If the display access is denied or the queue was configured without the user interface enabled, you will not be able to select any print features. The print job will print using only the predefined print features of the queue.

========================================
APPENDIX A. COMMAND LINE QUEUE CREATION

Use xpqadmin to create a queue from the command line or on a batch process.

This Appendix includes:
* A list of the command and supported options
* Command line examples
* Instructions for changing the default options

>>xpqadmin

The format is xpqadmin queue options
    queue - Queue name consisting of \"A…Z, a…z, -, _\" and no more than 14 characters.

The following options are supported:
      -ppd ppd_name - is the name of the ppd file to with this queue.
             The ppd file must exist in the ppd directory within the install area, and should be validated by Xerox.
      -pm model [wp | wps | psp]
        Printing model must be specified when generating a new queue.
        The printing model supports the following models:
          wp - workstation to printer.
          wps - workstation to print server.
          psp - print server to printer.
      -hn hostname - printer or remote print server hostname.
      -psqn name - remote print server's queue name.
      -dn devicename - path of the device to use to communicate to the locally attached printer.
      -fe - enables printer specific features to be added to print job.
      -ui - enables user interface when features are enabled.
      -bp - enables banner page printing from the driver.
      -d - establish queue as the default printer queue.
      -x - removes the print queue.
      -x all - removes all print queues.
      -xl q1 q2 … qn - removes print queues { q1 q2 … qn }.
      -LQ - print queue list.
      -QS - printout queue configuration, and create .settings file.
      -log name - basename for logfile.
      -af - add lpd filters, supported in Solaris only.
      -fs filename - path to a file that contains default printer feature selection entries. The default file name when created is .settings and is located in /opt/Xerox/xpxx/.

      -bps filename - path to a file that contains custom configured banner page information.
      -dbps filename - path to a file that contains custom configured banner page information to be used as the default banner page.
      -xdbps - remove the default banner page configuration.
      -cl clone_queue - create a clone of the printer queue clone_queue.
          To change the printer queue destination, you must supply the -pm option and either the -hn or -dn option.
          If you use the -pm wps option, you must also supply the -psqn option.
          Any other option added to the command line will be ignored.
      -mq - modify the named queue.
          To modify the named queue, you must supply at lease one of the following options:
            -bp, -fe, -fs filename, -ui, or -bps filename.
      -clean - clean the Xerox queue infrastructure.

>>Examples

To create a queue to a Phaser 5550 network printer with the user interface and printer specific features enabled:
xpqadmin test1 -ppd xr_p5550.ppd -pm wp -hn printer_hostname -ui –fe

To create a queue to a Phaser 5550 parallel connected with the user interface and printer specific features enabled:
xpqadmin test1 -ppd xr_p5550.ppd -pm wp -dn /dev/bpp0 -ui -fe

To create a queue called test1 that duplicates an existing queue:
xpqadmin test1 -cl clone_queue

To create a queue called test1 that duplicates an existing queue but connects to the same model of printer with a different IP address:
xpqadmin test1 -cl clone_queue -pm wps -psqn server_queue -hn printer_hostname

To change a queue called test1’s default print settings using the .settings file created from the procedures below and enable a banner page:
xpqadmin test1 -mq -fs .settings -fe –bp
xpqadmin Office4510 -pm wp -ppd xr_p4510.ppd -fe -hn 10.1.1.101 -fs /tmp/4510settings

>>Procedure

To set up a printer queue with custom default print settings requires creating a settings file using the driver GUI interface once.

1. Invoke the driver GUI for the target model - /opt/Xerox/xpxx/driver -GS xr_p4510.
2. Select the desired feature defaults (Duplex Unit, Long-Edge Binding).
3. Select the Paper/Output tab and click OK.
This creates a file called .settings in /opt/Xerox/xpxx.  The file can be renamed to something more descriptive as shown in the last example above.
4. Call xpqadmin with the "-fs /opt/Xerox/xpxx/.settings" parameter to create the queue with new defaults?:
xpqadmin {Queue_Name} -pm wp -ppd xr_p4510.ppd -fe -hn {Target_IP_Address} -fs /opt/Xerox/xpxx/.settings