**************************************************************************
* Turboprint for Linux - a printer driver system for Linux
* (c) ZEDOnet GmbH 2000-2017 all rights reserved
*
* ZEDOnet
* Sedanstraße 8
* D-87600 Kaufbeuren
* Germany
* WEB: http://www.turboprint.de
* EMAIL: mail turboprint.de
**************************************************************************

tpsetup - a printer setup tool for turboprint
=============================================

IMPORTANT: tpsetup must be started from a root login

The menu structure of tpsetup:

                      main menu
                          |
               printer administration


Command line parameters
=======================

If called without parameters, tpsetup will be in interactive mode (see
below).

tpsetup --install <name of keyfile>

Install a keyfile

tpsetup --uninstall

Delete all installed printer configurations


The main menu
=============

A list of the printers that were set up by turboprint is shown.

The term "printer" in this document means actually a
"printer configuration" (or in LINUX terms a "printer queue"):
several printer configurations for the same physical printer can exist
(e.g. one for draft and one for photo quality printing).

If no printers have been set up yet, the list is empty.

Nr.      - a reference number for the printer
Def.     - "lp" is shown here, if the printer is the default printer
Short    - short name for the printer configuration
Configuration - long name for -"-
Connection - how the printer is connected, e.g. local printer / remote ...
           smb (remote windows printer) / ncp (remote netware printer)
Output   - the name of the device or a remote printer name
Spooldir - the spool directory for this printer (within /var/spool/lpd/ )

The following options are available in the administration menu:

<number> - Administration (rename / set device / delete)
--------------------------------------------------------
Administrate a certain printer. Please use the number
shown at the beginning of a list entry.

D - Default printer
-------------------
Choose which printer should be the default printer "lp" (If
you don't specify a specific printer when printing via lpr,
the default printer is used).

A - Add printer
---------------
Add a new printer. There are two ways to add a printer

  C - Clone a printer

  This will create a duplicate of an existing printer
  that was set up in tpsetup.

  A - Add other printer

  A list with all available printers is shown. Please enter
  the number of the printer you want to add. A new printer
  entry will be created with default settings.

After the printer has been added, the printer administration for
the new printer will be called, so that the names and the
output device can be chosen.

Q - Return to main menu
-----------------------
Return to the main menu.


The printer administration menu
===============================

This menu offers options to specify the printer port or a
remote printer, to rename and delete a printer:

S - Short Name
--------------
Change the short name of the printer. The short name is used
when printing via "lpr". E.g. if the short name is "tp0", enter

lpr -Ptp0 printjob.ps

L - Long Name
-------------
Change the long name of the printer. The long name is usually
the printer manufacturer and model, e.g. "Epson_StylusColor900",
plus some additional information (to discern several printer
queues for the same physical printer),
e.g. "Epson_StylusColor900_draft".

C - Connection
--------------
The printer connection can be chosen here:

Local printer  - the printer is directly connected to a port
                (parallel, serial, USB)
File           - the output is sent to a file
Remote Printer - a printer server with LPD protocol
Remote Windows - the printer is connected to a Windows computer
Remote Netware - the printer is connected to a Netware server
Socket         - a printer server with Socket / HP Jetdirect protocol
Remote IPP     - a printer server with IPP protocol / Linux server with CUPS
Other(CUPS URI)- specify a CUPS URI directly

Depending on the selected "connection", different options are available:

"Connection" = "Local Printer":

  N - Device Name
  ---------------
  The local device that the printer is connected to,
  e.g. /dev/lp0 for the first parallel port.

"Connection" = "File":

  N - Filename
  ------------
  If the output should be stored in a file. Please enter
  the full path name. The lp daemon must have write access,
  so the /tmp directory is a possible choice.

"Connection" = "Remote Printer"

  E - Server Name
  ---------------
  The name of a Linux or Unix printer server.

  N - Printer Name
  ----------------
  The name of the printer on the server.

"Connection" = "Window"

  E - Server Name
  ---------------
  The name of a Windows printer server (or a Linux
  server with Samba).

  N - Printer Name
  ----------------
  The name of the printer.

  U - User Name (optional)
  ------------------------
  The user name, if necessary.

  P - Password (optional)
  -----------------------
  The password, if necessary.

  Important: The password is stored as plain ascii text in
  this version, it is not encrypted! Don't use the same
  password for login and printer access!

  W - Workgroup (optional)
  ------------------------
  The workgroup, if the printer server is not in the same
  workgroup.

  I - IP Address (optional)
  -------------------------
  The IP address, if necessary.

"Connection" = "Remote Netware"

  E - Server Name
  ---------------
  The name of a Netware printer server (or a Linux
  server with Samba).

  N - Printer Name
  ----------------
  The name of the printer.

  U - User Name (optional)
  ------------------------
  The user name, if necessary.

  P - Password (optional)
  -----------------------
  The password, if necessary.

  Important: The password is stored as plain ascii text in
  this version, it is not encrypted! Don't use the same
  password for login and printer access!

"Connection" = "Socket"

  E - Server Name
  ---------------
  Name or IP address of server

  O - Port
  --------
  A port number - 9100 for first printer on server, 9101 for second...

"Connection" = "Remote IPP"

  E - Server Name
  ---------------
  Name or IP address of server

  N - Printer Name
  ----------------
  Name of print queue on server
  On servers with CUPS: "printers/<name of print queue>"

"Connection" = "other (CUPS URI)"

  V - URI Address
  ---------------
  Specify a CUPS URI directly, e.g.

  parallel:/dev/lp0
  socket://192.168.17.36:9100

  See CUPS documentation for details.

  D - Select one of local CUPS devices
  ------------------------------------
  Displays a list of printers that have been recognized by CUPS.

X - Spool Status
----------------
Display / change the status "accepting" or "rejecting" new print jobs.

Y - Print Status
----------------
Display / change the print status "started" or "paused".

Z - Delete all print jobs
-------------------------
Empties the print queue and make it "accepting" and "started".

R - Remove printer
------------------
Remove the printer. (It is actually removed when tpsetup
is left with "S - Save".)

Q - return to main menu
-----------------------
Return to main menu.