HELPPRINT(1X)

NAME

helpprint and helpprintrst - The HP Help Print Programs.

SYNOPSIS

helpprint [options] helpprintrst [options]

DESCRIPTION

Helpprint and helpprintrst are programs which prints Help topics. They are integral parts of the Hewlett-Packard Help System (HP Help). Access to helpprint is provided by the helpview client’s print command, an application’s help window, or through a command line shell. Helpprintrst is a special version of helpprint for multibyte locales. The same options apply to both programs unless stated otherwise.

The program helpprint will create full PCL output, text and graphics, using the internal fonts of the printer. The program helpprintrst will use the display specified to rasterize each page and then prints each page as a PCL raster graphic. The resolution of the rasterized pages will be 100 dpi.

The printer must have enough memory to store each printed page. This is particularly important for helpprintrst where each page is rendered as a raster. You may want to specify a smaller page size if your printer has limited memory. See "Printer Specific Resources" for details on setting page sizes.

OPTIONS

−display display
This option specifies the display to use, typically of the form hostname:display_number.screen_number. For example, -display oregon:0.1 specifies screen one of display zero of host oregon. If no screen_number is specified, the first screen (screen “0”) is used. See also X(1). Only helpprintrst uses this option.

−printer printer
This option specifies the name of the printer to use, of the form used by the system print spooler. For example, -printer laser2 specifies a printer called "laser2". The default is the default system printer. See also lp(1). Associated resource: printer.name.

−R This option specifies helpprint to recursively print the topic and all its subtopics. The option applies only when printing help volumes.

−outputFile filename
This option directs helpprint to write the output to the named file. Without this option, helpprint creates a temporary file in the system temporary directory and sends the file to the printer spooler.

−name name
This option specifies the application name under which resources are to be obtained. The default is the name used to run the program. Associated resource: application.name.

−class classname
This option specifies the application class under which resources are to be obtained. The default class name is "Helpprint" or "Helpprintrst". Associated resource: application.class.

−topicTitle title
This option specifies the title to print on the printout.

−helpType helptype
This options specifies the type of help information to be printed. It determines what additional options need to be supplied. Valid help types are listed below.

Name	helpType Value
Help topic	1
String	2
Man page	3
File	4
Dynamic string	5

−helpVolume volume file name
This option specifies the volume file for help topics.

−locationId id
This option specifies the location id for help topics.

−manPage man page name
This option specifies the man page for help type man page.

−stringData stringdata
This options specifies the string for help types string and dynamic string.

−helpFile helpfile
This options specifies the name of the file for help type file.

−xrm resourcestring
This option specifies a resource string to use. For example, helpprint ... -xrm "*size: a4" specifies that the printer is loaded with A4-size paper. You can specify multiple resources by adding one -xrm option after another. A use of helpprint would be:
helpprint -printer laser -xrm "locationId: Welcome" \
-xrm "helpVolume: GettingStarted.hv" -xrm "*size: a4"

RESOURCE OVERVIEW

Helpprint is largely configured from its resource database.

The application class is Helpprint or Helpprintrst unless specified otherwise with the -class option. The application name is the name used to run the program (usually "helpprint") unless specified otherwise with the -name option. In the following discussion of resource specifications, the class name (eg., "Helpprint") and the application name (eg., "helpprint") can be used interchangeably. However, if conflicting resources are specified, resources specified by resource name (eg., "helpprint") will take precedence over resource specified by resource class (eg., "Helpprint").

Helpprint uses the following types of resources:

Help Text Resources:

These resources specify the search path for finding help information.

Printer Specific Resources:

These resources describe the name and capabilities of the specific printer being used as well as the size of paper for which the Help information will be formatted.

Resources for System Utilities

These resources specify what system utilities will be used for formatting.

HELP TEXT RESOURCES

Help text resources specify the information that will be printed. The syntax for specifying the resources is:

Helpprint*resource_id

For example, helpprint*helpVolume is used to specify the name of the volume file.

The following help text resources can be specified:

Help Text Resource
Name	Class	Value Type	Default
locationId	LocationId	string	_HOMETOPIC
helpVolume	HelpVolume	string	NULL
manPage	ManPage	string	NULL
stringData	StringData	string	NULL
helpFile	HelpFile	string	NULL
topicTitle	TopicTitle	string	HP Help
helpType	HelpType	numeric string	1

The Help Text Resources are defined in the HP Help System Developer’s Guide.

PRINTER SPECIFIC RESOURCES

These resources specify the model, paper size, and page margins of the printer to be used. Resources can be specified for many printers. The current printer to use is specified by the -printer command line option or the .printer.name resource.

The syntax for specifying resources for the default printer is

*printer.resource_id

For example, *printer.model specifies what specific model of the printer the default printer is.

The syntax for specifying printer specific appearance and behavior resources is

*printer.printer_name.resource_id

For example, *printer.laser.model specifies specific model of the printer called "laser".

Printer Specific Appearance and Behavior Resources
Name	Class	Value Type	Default
model	Model	string	LJIII
size	Size	int	letter
width	Width	int
height	Height	int
leftMargin	LeftMargin	int
rightMargin	RightMargin	int
topMargin	TopMargin	int
bottomMargin	BottomMargin	int

model (class Model)
This resource identifies the specific model of the printer. Valid printer models are:

Name	Description
LJII	HP LaserJet II printer.
LJIII	HP LaserJet III printer (default).

size (class Size)
This resource specifies the size of the page for which to format the help data. It provides appropriate values for all of the dimension resources. Valid page sizes are:

Name	Description
executive	7.25 x 10.5 inches.
letter	8 1/2 x 11 inches (default).
legal	8 1/2 x 14 inches.
a4	210 x 297 mm.

width (class Width)
This resource is used to specify (in 100th of a millimeter) a non-standard page width. It overrides the width implied in the size resource.

height (class Height)
This resource is used to specify (in 100th of a millimeter) a non-standard page length. It overrides the height implied in the size resource.

leftMargin (class LeftMargin)
This resource is used to specify (in 100th of a millimeter) a non-standard left margin. It overrides the left margin implied in the size resource.

topMargin (class TopMargin)
This resource is used to specify (in 100th of a millimeter) a non-standard top margin. It overrides the top margin implied in the size resource.

rightMargin (class RightMargin)
This resource is used to specify (in 100th of a millimeter) a non-standard right margin. It overrides the right margin implied in the size resource.

bottomMargin (class BottomMargin)
This resource is used to specify (in 100th of a millimeter) a non-standard bottom margin. It overrides the bottom margin implied in the size resource.

RESOURCES FOR SYSTEM UTILITIES

Helpprint uses a number of system utilities. Several of these can be redefined through resources. If you specify such a resource, be sure that the new utility will accept the same command line arguments as the utility it replaces.

Resources for System Utilities
Name	Class	Value Type	Default
lpCommand	LpCommand	string	lp -oraw
manCommand	ManCommand	string	man
prCommand	PrCommand	string	pr

outputFile (class OutputFile)
Usually, helpprint will spool the output to a printer. This resource specifies the of a file to which it will write the output.

lpCommand (class LpCommand)
If this resource specifies the command helpprint invokes to send its output to the printer spooler. The default is "lp". If another program is specified here, it must support the options -s, -d, -t, and -oraw. The name of the temporary file containing the output is appended to the command.

manCommand (class ManCommand)
If this resource specifies the command helpprint invokes to format man pages.

prCommand (class PrCommand)
If this resource specifies the command helpprint invokes to format helpFiles and stringData. It must support -h, -f, and -l options.

RESOURCE DESCRIPTION FILES

Helpprint combines a number of default files into one resource database.

This database is built from the following sources. They are listed in order of precedence, low to high:

Environment variables DISPLAY, PRINTER
/usr/lib/X11/app-defaults/class_name
$HOME/.Xdefaults
XENVIRONMENT variable or $HOME/.Xdefaults-host
command line options

Printer specific resources and page size resources are usually stored in the file /usr/lib/X11/app-defaults/Helpprint. Help text resources are usually specified on the command line.

COPYRIGHT

ORIGIN

Hewlett-Packard Company UTD-CV.

Museum

Related Articles