1193 lines
59 KiB
Plaintext
1193 lines
59 KiB
Plaintext
<!-- $XConsortium: helpprin.sgm /main/15 1996/11/15 15:31:25 cdedoc $ -->
|
|
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
|
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
|
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
|
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
|
<!-- (c) Copyright 1995 Novell, Inc. -->
|
|
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
|
<!-- (c) Copyright 1995 Hitachi. -->
|
|
<refentry id="CDEMX.MAN21.rsml.1">
|
|
<refmeta><refentrytitle>dthelpprint</refentrytitle><manvolnum>user cmd</manvolnum>
|
|
</refmeta>
|
|
<refnamediv><refname><command>dthelpprint</command></refname><refpurpose>
|
|
print utility for DtHelpDialog and DtHelpQuickDialog widgets</refpurpose>
|
|
</refnamediv>
|
|
<refsynopsisdiv>
|
|
<cmdsynopsis>
|
|
<command>dthelpprint</command><arg choice="opt"><replaceable>options </replaceable></arg>
|
|
</cmdsynopsis>
|
|
<refsect2>
|
|
<title>Options</title>
|
|
<para>Options controlling what to print:</para>
|
|
<informaltable remap="center" orient="port">
|
|
<tgroup cols="3" colsep="0" rowsep="0">
|
|
<?PubTbl tgroup dispwid="6.10in">
|
|
<colspec align="left" colwidth="128*">
|
|
<colspec align="left" colwidth="106*">
|
|
<colspec align="left" colwidth="269*">
|
|
<tbody>
|
|
<row>
|
|
<entry align="left" valign="top"><literal>−helpType</literal></entry>
|
|
<entry align="left" valign="top"><symbol role="Variable">type</symbol></entry>
|
|
<entry align="left" valign="top">type of Help data</entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><literal>−helpType</literal></entry>
|
|
<entry align="left" valign="top"><symbol role="Variable">type</symbol></entry>
|
|
<entry align="left" valign="top">type of Help data. type = 0 (help volume),
|
|
1 (string), 2 (man page), 3 (help file)</entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><literal>−helpVolume</literal></entry>
|
|
<entry align="left" valign="top"><symbol role="Variable">volume</symbol></entry>
|
|
<entry align="left" valign="top">full path of Help volume file.</entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><literal>−locationId</literal></entry>
|
|
<entry align="left" valign="top"><symbol role="Variable">location</symbol></entry>
|
|
<entry align="left" valign="top">name of Help topic in the volume.</entry>
|
|
</row>
|
|
<row>
|
|
<entry align="left" valign="top"><literal>−allTopics</literal></entry>
|
|
<entry align="left" valign="top"></entry>
|
|
<entry align="left" valign="top">print all topics, toc, & index.</entry>
|
|
</row>
|
|
<row>
|
|
<entry align="left" valign="top"><literal>−subTopics</literal></entry>
|
|
<entry align="left" valign="top"></entry>
|
|
<entry align="left" valign="top">print topic locationId and all subtopics.</entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><literal>−oneTopic</literal></entry>
|
|
<entry align="left" valign="top"></entry>
|
|
<entry align="left" valign="top">print topic locationId.</entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><literal>−toc</literal></entry>
|
|
<entry align="left" valign="top"></entry>
|
|
<entry align="left" valign="top">print Help volume table of contents.</entry>
|
|
</row>
|
|
<row>
|
|
<entry align="left" valign="top"><literal>−index</literal></entry>
|
|
<entry align="left" valign="top"></entry>
|
|
<entry align="left" valign="top">print Help volume index.</entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><literal>−frontMatter</literal></entry>
|
|
<entry align="left" valign="top"></entry>
|
|
<entry align="left" valign="top">print Help volume front matter.</entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><literal>−manPage</literal></entry>
|
|
<entry align="left" valign="top"><symbol role="Variable">manpagename</symbol></entry>
|
|
<entry align="left" valign="top">name of man page.</entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><literal>−stringData</literal></entry>
|
|
<entry align="left" valign="top"><symbol role="Variable">string</symbol></entry>
|
|
<entry align="left" valign="top">Help text to print.</entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><literal>−helpFile</literal></entry>
|
|
<entry align="left" valign="top"><symbol role="Variable">filename</symbol></entry>
|
|
<entry align="left" valign="top">file containing Help text.</entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><literal>−topicTitle</literal></entry>
|
|
<entry align="left" valign="top"><symbol role="Variable">title</symbol></entry>
|
|
<entry align="left" valign="top">title string for Help text.</entry></row>
|
|
</tbody></tgroup><?Pub Caret></informaltable>
|
|
<para>Options controlling how to print:</para>
|
|
<informaltable remap="center" orient="port">
|
|
<tgroup cols="3" colsep="0" rowsep="0">
|
|
<?PubTbl tgroup dispwid="6.14in">
|
|
<colspec align="left" colwidth="125*">
|
|
<colspec align="left" colwidth="97*">
|
|
<colspec align="left" colwidth="284*">
|
|
<tbody>
|
|
<row>
|
|
<entry align="left" valign="top"><literal>−printer</literal></entry>
|
|
<entry align="left" valign="top"><symbol role="Variable">printername</symbol></entry>
|
|
<entry align="left" valign="top">printer to use</entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><literal>copies</literal></entry>
|
|
<entry align="left" valign="top"><symbol role="Variable">number</symbol></entry>
|
|
<entry align="left" valign="top">number of copies to print.</entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><literal>−outputFile</literal></entry>
|
|
<entry align="left" valign="top"><symbol role="Variable">filename</symbol></entry>
|
|
<entry align="left" valign="top">write output to this file.</entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><literal>−paperSize</literal></entry>
|
|
<entry align="left" valign="top"><symbol role="Variable">size</symbol></entry>
|
|
<entry align="left" valign="top">format content to this paper size.</entry>
|
|
</row>
|
|
<row>
|
|
<entry align="left" valign="top"><literal>−paperSize</literal></entry>
|
|
<entry align="left" valign="top"><symbol role="Variable">size</symbol></entry>
|
|
<entry align="left" valign="top">format content to this paper size. size =
|
|
{help_papersize_letter|help_papersize_legal| help_papersize_executive|help_papersize_a4|
|
|
help_papersize_b5}</entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><literal>−display</literal></entry>
|
|
<entry align="left" valign="top"><symbol role="Variable">displayname</symbol></entry>
|
|
<entry align="left" valign="top">display from which to get resources.</entry>
|
|
</row>
|
|
<row>
|
|
<entry align="left" valign="top"><literal>−name</literal></entry>
|
|
<entry align="left" valign="top"><symbol role="Variable">name</symbol></entry>
|
|
<entry align="left" valign="top">program name used when getting resources.</entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><literal>−class</literal></entry>
|
|
<entry align="left" valign="top"><symbol role="Variable">name</symbol></entry>
|
|
<entry align="left" valign="top">class name used when getting resources.</entry>
|
|
</row>
|
|
<row>
|
|
<entry align="left" valign="top"><literal>−xrm</literal></entry>
|
|
<entry align="left" valign="top"><symbol role="Variable">resourcestring</symbol></entry>
|
|
<entry align="left" valign="top">additional resources.</entry></row></tbody>
|
|
</tgroup></informaltable>
|
|
</refsect2>
|
|
</refsynopsisdiv>
|
|
<refsect1>
|
|
<title>DESCRIPTION</title>
|
|
<para>The <command>dthelpprint</command> utility is a private utility used
|
|
by &cdeman.DtHelpDialog; and &cdeman.DtHelpQuickDialog;
|
|
for printing Help information. It is not a public utility, and no effort to
|
|
maintain backwards compatibility will be made across versions. That said,
|
|
it is sometimes useful to use <command>dthelpprint</command> directly and
|
|
to configure its operation.</para>
|
|
<para>The <command>dthelpprint</command> utility processes help topics and
|
|
can send the output to a printer or to a specified output file.
|
|
The <command>dthelpprint</command> utility is an integral part of the CDE Help System.
|
|
Access to <command>dthelpprint</command> is provided by the &cdeman.dthelpview;
|
|
client's Print dialog, an application's Help window, or through
|
|
a utility line shell.</para>
|
|
<para>The <command>dthelpprint</command> utility can print plain text strings,
|
|
plain text files, Unix man pages, and CDE Help volumes. CDE Help volumes are
|
|
printed without any graphics, and there is no indication of missing graphics.
|
|
The standard <Filename MoreInfo="RefEntry">man</Filename>(1) and &cdeman.dthelpview;
|
|
search paths are used to find manual pages and CDE Help volumes; Help volumes
|
|
and files may be specified with an absolute pathname.</para>
|
|
</refsect1>
|
|
<refsect1>
|
|
<title>OPTIONS</title>
|
|
<para>The <command>dthelpprint</command> utility has two sets of utility line
|
|
options. The first set controls what should be printed. The second set controls
|
|
how it should be printed. All option names must be used exactly as given.
|
|
An alternative to specifying options on the utility line is to specify them
|
|
using resources in an app-defaults file. This is useful for changing the default
|
|
values from those given below. See the <literal>RESOURCE OVERVIEW</literal>
|
|
heading in this manual page for more information.</para>
|
|
<para>Options controlling what to print:</para>
|
|
<variablelist>
|
|
<varlistentry><term><literal>−helpType</literal> <symbol role="Variable">type</symbol></term>
|
|
<listitem>
|
|
<para>The type of Help data to print. This is a numeric value, as follows:
|
|
0=help volume, 1=string, 2=man page, 3=help file. The default value is 0,
|
|
a Help volume.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term><literal>−helpVolume</literal> <symbol role="Variable">volume</symbol></term>
|
|
<listitem>
|
|
<para>The name of the volume holding the topics to be printed.
|
|
If <symbol role="Variable">volume</symbol> is unqualified, the standard &cdeman.dthelpview;
|
|
search paths are used to locate the volume; these are also covered in the
|
|
<literal>ENVIRONMENT VARIABLES</literal> heading in this manual page. The volume may
|
|
also be specified relative to the current directory by beginning the volume
|
|
name with "./" or "../". This option is useful only in conjunction with a
|
|
<literal>−helpType</literal> of 0 (zero).</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term><literal>−locationId</literal> <symbol role="Variable">location</symbol></term>
|
|
<listitem>
|
|
<para>The starting topic for processing topics of a Help volume.
|
|
The <symbol role="Variable">location</symbol> must be a text string used by the
|
|
author to mark a location
|
|
in the volume. The default value is <literal>_hometopic</literal>, which is
|
|
the top topic of a CDE Help volume. This option is useful only in conjunction
|
|
with <literal>−helpVolume</literal>.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term><literal>−allTopics</literal></term>
|
|
<listitem>
|
|
<para>Instructs <command>dthelpprint</command> to print the entire help volume,
|
|
including front matter, table of contents, all topics, and an index. This
|
|
option is useful only in conjunction with <literal>−helpVolume</literal>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term><literal>−subTopics</literal></term>
|
|
<listitem>
|
|
<para>Instructs <command>dthelpprint</command> to print the topic specified
|
|
by <literal>−locationId</literal> and all the subtopics of that topic.
|
|
This option is useful only in conjunction with <literal>−helpVolume</literal>.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term><literal>−oneTopic</literal></term>
|
|
<listitem>
|
|
<para>Instructs <command>dthelpprint</command> to print the topic specified
|
|
by <literal>-locationId</literal>. This option is useful only in conjunction
|
|
with <literal>−helpVolume</literal>.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term><literal>−toc</literal></term>
|
|
<listitem>
|
|
<para>Instructs <command>dthelpprint</command> to print the Table of Contents
|
|
of the specified helpVolume. This option is useful only in conjunction with <literal>−helpVolume</literal>.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term><literal>−index</literal></term>
|
|
<listitem>
|
|
<para>Instructs <command>dthelpprint</command> to print the Index of the specified
|
|
helpVolume. This option is useful only in conjunction with <literal>−helpVolume</literal>.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term><literal>−frontMatter</literal></term>
|
|
<listitem>
|
|
<para>Instructs <command>dthelpprint</command> to print the front matter of
|
|
the specified helpVolume. Front matter includes the volume title, abstract,
|
|
and copyright information. This option is useful only in conjunction with <literal>−helpVolume</literal>.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term><literal>−stringData</literal> <symbol role="Variable">string</symbol></term>
|
|
<listitem>
|
|
<para>Specifies a string to print. This option is useful only in conjunction
|
|
with a <literal>−helpType</literal> of 1.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term><literal>−manPage</literal> <symbol role="Variable">manpagename</symbol></term>
|
|
<listitem>
|
|
<para>Specifies the name of the Unix man page to print. This option is useful
|
|
only in conjunction with a <literal>−helpType</literal> of 2.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term><literal>−helpFile</literal> <symbol role="Variable">filename</symbol></term>
|
|
<listitem>
|
|
<para>Specifies a file to print. This option is useful only in conjunction
|
|
with a <literal>−helpType</literal> of 3.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<para>Options controlling how to print:</para>
|
|
<variablelist>
|
|
<varlistentry><term><literal>−printer</literal> <symbol role="Variable">printername</symbol></term>
|
|
<listitem>
|
|
<para>Specifies which printer to use. If this isn't specified as a utility-line
|
|
option or resource, the default value is taken from the environment variable
|
|
<systemitem class="EnvironVar">LPDEST</systemitem>.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term><literal>−copies</literal> <symbol role="Variable">number</symbol></term>
|
|
<listitem>
|
|
<para>Specifies how many copies to produce. The default value is 1. This option
|
|
is only ignored when generating an output file.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term><literal>−outputFile</literal> <symbol role="Variable">filename</symbol></term>
|
|
<listitem>
|
|
<para>Specifies a file to hold the print-ready output. If this option is specified,
|
|
no output is sent to the printer.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term><literal>−paperSize</literal> <symbol role="Variable">size</symbol></term>
|
|
<listitem>
|
|
<para>Specifies a size of paper to which the output should be formatted. There
|
|
are five valid values for <symbol role="Variable">size</symbol>: <literal>help_papersize_letter</literal>, <literal>help_papersize_legal</literal>, <literal>help_papersize_executive</literal>, <literal>help_papersize_a4</literal>, <literal>help_papersize_b5</literal>. The default value is <literal>help_papersize_letter</literal>.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term><literal>−display</literal> <symbol role="Variable">displayname</symbol></term>
|
|
<listitem>
|
|
<para>Specifies the X display used to retrieve resource values. Typical format
|
|
for <emphasis>displayname</emphasis> is <literal>hostname:display_number.screen_number</literal>. If no screen number is specified, the first screen (0) is used.
|
|
See also <command>X</command>(1)</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term><literal>−name</literal> <symbol role="Variable">name</symbol></term>
|
|
<listitem>
|
|
<para>Specifies the application name under which resources are to be obtained.
|
|
The default is <command>dthelpprint</command>. The resource <literal>application.name</literal> way also be used to specify the name.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term><literal>−class</literal> <symbol role="Variable">classname</symbol></term>
|
|
<listitem>
|
|
<para>Specifies the application class name under which resources are to be
|
|
obtained. The default is <command>dthelpprint</command>. The resource
|
|
<systemitem class="resource">application.class</systemitem> may also be used to
|
|
specify the class name.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term><literal>−xrm</literal> <symbol role="Variable">resourcestring</symbol></term>
|
|
<listitem>
|
|
<para>Specifies an addition to the resource database used by this invocation
|
|
of the program.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
<refsect1>
|
|
<title>RESOURCE OVERVIEW</title>
|
|
<para>The <command>dthelpprint</command> utility uses resources in addition
|
|
to utility-line options to configure its operation. There are many more resources
|
|
available for this purpose than utility-line options. To set a resource on
|
|
the utility line, use the <literal>−xrm</literal> option.</para>
|
|
<para>The application class is <command>dthelpprint</command> unless specified
|
|
otherwise with the <systemitem class="resource">application.class</systemitem> or
|
|
<systemitem class="resource">Application.Class</systemitem> resource or the
|
|
<literal>−class</literal> option. The application
|
|
instance name is the name used to run the program (usually <command>dthelpprint</command>)
|
|
unless specified otherwise with the <systemitem class="resource">application.class</systemitem> or
|
|
<systemitem class="resource">Application.Class</systemitem> resource
|
|
or the <literal>−name</literal> option. In the following coverage of resource specifications,
|
|
the application's class name and instance name can be used interchangably;
|
|
however, if the same resource is specified more than once, the instance-specific
|
|
resource takes precedence over the class resource. In addition, when a value
|
|
can be specified using either a resource or utility-line option, the utility-line
|
|
option value takes precedence.</para>
|
|
<para>The <command>dthelpprint</command> utility has three types of resources.
|
|
</para>
|
|
<variablelist>
|
|
<varlistentry><term>Help Content</term>
|
|
<listitem>
|
|
<para>These resoures specify what to print. Typically, these values are specified
|
|
using utility-line options instead of resources.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term>Content Processing</term>
|
|
<listitem>
|
|
<para>These resources specify in more detail the configuration of how to print.
|
|
These resources include some values that can be specified with utility-line
|
|
options, but also many others.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term>Printer Configuration:</term>
|
|
<listitem>
|
|
<para>The <command>dthelpprint</command> utility allows printer-specific configurations
|
|
to be specified. The configuration used is controlled by the value of the
|
|
<systemitem class="resource">printer</systemitem> resource or
|
|
<literal>−printer</literal> option.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
<refsect1>
|
|
<title>HELP CONTENT RESOURCES</title>
|
|
<para>These resources specify what to print. The syntax for specifying the
|
|
resources is</para>
|
|
<ProgramListing><literal>Dthelpprint*</literal> <symbol role="Variable">resource</symbol><literal>:</literal>resource value</ProgramListing>
|
|
<para>For example, <literal>Dthelpprint*helpVolume:</literal> <Filename>aVolume.sdl</Filename> is used to specify the name of the Help volume.</para>
|
|
<refsect2>
|
|
<title>Basic Resource Set</title>
|
|
<informaltable remap="center" orient="port">
|
|
<tgroup cols="4" colsep="0" rowsep="0">
|
|
<?PubTbl tgroup dispwid="5.39in">
|
|
<colspec align="left" colwidth="108*">
|
|
<colspec align="left" colwidth="119*">
|
|
<colspec align="left" colwidth="102*">
|
|
<colspec align="left" colwidth="115*">
|
|
<tbody>
|
|
<row>
|
|
<entry align="left" valign="top"><literal>Name</literal></entry>
|
|
<entry align="left" valign="top"><literal>Class</literal></entry>
|
|
<entry align="left" valign="top"><literal>Type</literal></entry>
|
|
<entry align="left" valign="top"><literal>Default</literal></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">locationId</systemitem></entry>
|
|
<entry align="left" valign="top"><classname>LocationId</classname></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">string</structname></entry>
|
|
<entry align="left" valign="top"><Symbol>_HOMETOPIC</Symbol></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">helpVolume</systemitem></entry>
|
|
<entry align="left" valign="top"><classname>HelpVolume</classname></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">string</structname></entry>
|
|
<entry align="left" valign="top"><symbol role="Define">NULL</symbol></entry>
|
|
</row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">manPage</systemitem></entry>
|
|
<entry align="left" valign="top"><classname>ManPage</classname></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">string</structname></entry>
|
|
<entry align="left" valign="top"><symbol role="Define">NULL</symbol></entry>
|
|
</row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">stringData</systemitem></entry>
|
|
<entry align="left" valign="top"><classname>StringData</classname></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">string</structname></entry>
|
|
<entry align="left" valign="top"><symbol role="Define">NULL</symbol></entry>
|
|
</row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">helpFile</systemitem></entry>
|
|
<entry align="left" valign="top"><classname>HelpFile</classname></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">string</structname></entry>
|
|
<entry align="left" valign="top"><symbol role="Define">NULL</symbol></entry>
|
|
</row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">topicTitle</systemitem></entry>
|
|
<entry align="left" valign="top"><classname>TopicTitle</classname></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">string</structname></entry>
|
|
<entry align="left" valign="top"><symbol role="Define">NULL</symbol></entry>
|
|
</row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">helpType</systemitem></entry>
|
|
<entry align="left" valign="top"><classname>HelpType</classname></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">string</structname></entry>
|
|
<entry align="left" valign="top"><symbol role="Define">NULL</symbol></entry>
|
|
</row></tbody></tgroup></informaltable>
|
|
<para>These Help-content resources are defined in &cdeman.DtHelpDialog;.
|
|
The following content options are specific to <command>dthelpprint.</command>
|
|
Setting the resource to any value makes it <systemitem class="Constant">True</systemitem>.</para>
|
|
</refsect2>
|
|
<refsect2>
|
|
<title>Additional Resource Set</title>
|
|
<informaltable remap="center" orient="port">
|
|
<tgroup cols="4" colsep="0" rowsep="0">
|
|
<colspec align="left" colwidth="121*">
|
|
<colspec align="left" colwidth="120*">
|
|
<colspec align="left" colwidth="90*">
|
|
<colspec align="left" colwidth="125*">
|
|
<tbody>
|
|
<row>
|
|
<entry align="left" valign="top"><literal>Name</literal></entry>
|
|
<entry align="left" valign="top"><literal>Class</literal></entry>
|
|
<entry align="left" valign="top"><literal>Type</literal></entry>
|
|
<entry align="left" valign="top"><literal>Default</literal></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">allTopics</systemitem></entry>
|
|
<entry align="left" valign="top"><classname>AllTopics</classname></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">string</structname></entry>
|
|
<entry align="left" valign="top"><symbol role="Define">NULL</symbol></entry>
|
|
</row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">subTopics</systemitem></entry>
|
|
<entry align="left" valign="top"><classname>SubTopics</classname></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">string</structname></entry>
|
|
<entry align="left" valign="top"><symbol role="Define">NULL</symbol></entry>
|
|
</row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">oneTopic</systemitem></entry>
|
|
<entry align="left" valign="top"><classname>OneTopic</classname></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">string</structname></entry>
|
|
<entry align="left" valign="top"><symbol role="Define">NULL</symbol></entry>
|
|
</row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">toc</systemitem></entry>
|
|
<entry align="left" valign="top"><classname>Toc</classname></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">string</structname></entry>
|
|
<entry align="left" valign="top"><symbol role="Define">NULL</symbol></entry>
|
|
</row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">index</systemitem></entry>
|
|
<entry align="left" valign="top"><classname>Index</classname></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">string</structname></entry>
|
|
<entry align="left" valign="top"><symbol role="Define">NULL</symbol></entry>
|
|
</row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">frontMatter</systemitem></entry>
|
|
<entry align="left" valign="top"><classname>FrontMatter</classname></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">string</structname></entry>
|
|
<entry align="left" valign="top"><symbol role="Define">NULL</symbol></entry>
|
|
</row></tbody></tgroup></informaltable>
|
|
<para>These Help-content resources have the same meaning as the <command>dthelpprint</command> utility-line options of the same name.</para>
|
|
</refsect2>
|
|
</refsect1>
|
|
<refsect1>
|
|
<title>HELP PROCESSING RESOURCES</title>
|
|
<para>These resources specify how to print. The syntax for specifying the
|
|
resources is:</para>
|
|
<ProgramListing><literal>Dthelpprint*</literal> <symbol role="Variable">resource</symbol><literal>:</literal>resource value</ProgramListing>
|
|
<para>For example, <literal>Dthelpprint*printer:</literal> <literal>aPrinter</literal> is used to specify the name of the printer.</para>
|
|
<refsect2>
|
|
<title>Basic Resource Set</title>
|
|
<informaltable remap="center" orient="port">
|
|
<tgroup cols="4" colsep="0" rowsep="0">
|
|
<colspec align="left" colwidth="111*">
|
|
<colspec align="left" colwidth="121*">
|
|
<colspec align="left" colwidth="99*">
|
|
<colspec align="left" colwidth="125*">
|
|
<tbody>
|
|
<row>
|
|
<entry align="left" valign="top"><literal>Name</literal></entry>
|
|
<entry align="left" valign="top"><literal>Class</literal></entry>
|
|
<entry align="left" valign="top"><literal>Type</literal></entry>
|
|
<entry align="left" valign="top"><literal>Default</literal></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">printer</systemitem></entry>
|
|
<entry align="left" valign="top"><classname>Printer</classname></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">string</structname></entry>
|
|
<entry align="left" valign="top"><symbol role="Define">NULL</symbol></entry>
|
|
</row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">copies</systemitem></entry>
|
|
<entry align="left" valign="top"><classname>Copies</classname></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">string</structname></entry>
|
|
<entry align="left" valign="top"><symbol role="Define">NULL</symbol></entry>
|
|
</row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">outputFile</systemitem></entry>
|
|
<entry align="left" valign="top"><classname>OutputFile</classname></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">string</structname></entry>
|
|
<entry align="left" valign="top"><symbol role="Define">NULL</symbol></entry>
|
|
</row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">paperSize</systemitem></entry>
|
|
<entry align="left" valign="top"><classname>PaperSize</classname></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">string</structname></entry>
|
|
<entry align="left" valign="top"><symbol role="Define">NULL</symbol></entry>
|
|
</row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">display</systemitem></entry>
|
|
<entry align="left" valign="top"><symbol role="Message">Display</symbol></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">string</structname></entry>
|
|
<entry align="left" valign="top"><symbol role="Define">NULL</symbol></entry>
|
|
</row></tbody></tgroup></informaltable>
|
|
<para>These Help-processing resources have the same meaning as the <command>dthelpprint</command> utility-line options of the same name. It is used to
|
|
specify the name of the printer.</para>
|
|
</refsect2>
|
|
<refsect2>
|
|
<title>Additional Resource Set</title>
|
|
<informaltable remap="center" orient="port">
|
|
<tgroup cols="4" colsep="0" rowsep="0">
|
|
<?PubTbl tgroup dispwid="6.46in">
|
|
<colspec align="left" colwidth="175*">
|
|
<colspec align="left" colwidth="172*">
|
|
<colspec align="left" colwidth="83*">
|
|
<colspec align="left" colwidth="103*">
|
|
<tbody>
|
|
<row>
|
|
<entry align="left" valign="top"><literal>Name</literal></entry>
|
|
<entry align="left" valign="top"><literal>Class</literal></entry>
|
|
<entry align="left" valign="top"><literal>Type</literal></entry>
|
|
<entry align="left" valign="top"><literal>Default</literal></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">evenTocHeader</systemitem></entry>
|
|
<entry align="left" valign="top"><classname>EvenTocHeader</classname></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">string</structname></entry>
|
|
<entry align="left" valign="top"><literal>see below</literal></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">oddTocHeader</systemitem></entry>
|
|
<entry align="left" valign="top"><classname>OddTocHeader</classname></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">string</structname></entry>
|
|
<entry align="left" valign="top"><literal>see below</literal></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">evenTocFooter</systemitem></entry>
|
|
<entry align="left" valign="top"><classname>EvenTocFooter</classname></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">string</structname></entry>
|
|
<entry align="left" valign="top"><literal>see below</literal></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">oddTocFooter</systemitem></entry>
|
|
<entry align="left" valign="top"><classname>OddTocFooter</classname></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">string</structname></entry>
|
|
<entry align="left" valign="top"><literal>see below</literal></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">evenBodyHeader</systemitem></entry>
|
|
<entry align="left" valign="top"><classname>EvenBodyHeader</classname></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">string</structname></entry>
|
|
<entry align="left" valign="top"><literal>see below</literal></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">oddBodyHeader</systemitem></entry>
|
|
<entry align="left" valign="top"><classname>OddBodyHeader</classname></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">string</structname></entry>
|
|
<entry align="left" valign="top"><literal>see below</literal></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">evenBodyFooter</systemitem></entry>
|
|
<entry align="left" valign="top"><classname>EvenBodyFooter</classname></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">string</structname></entry>
|
|
<entry align="left" valign="top"><literal>see below</literal></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">oddBodyFooter</systemitem></entry>
|
|
<entry align="left" valign="top"><classname>OddBodyFooter</classname></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">string</structname></entry>
|
|
<entry align="left" valign="top"><literal>see below</literal></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">evenIndexHeader</systemitem></entry>
|
|
<entry align="left" valign="top"><classname>EvenIndexHeader</classname></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">string</structname></entry>
|
|
<entry align="left" valign="top"><literal>see below</literal></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">oddIndexHeader</systemitem></entry>
|
|
<entry align="left" valign="top"><classname>OddIndexHeader</classname></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">string</structname></entry>
|
|
<entry align="left" valign="top"><literal>see below</literal></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">evenIndexFooter</systemitem></entry>
|
|
<entry align="left" valign="top"><classname>EvenIndexFooter</classname></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">string</structname></entry>
|
|
<entry align="left" valign="top"><literal>see below</literal></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">oddIndexFooter</systemitem></entry>
|
|
<entry align="left" valign="top"><classname>OddIndexFooter</classname></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">string</structname></entry>
|
|
<entry align="left" valign="top"><literal>see below</literal></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">echoCommand</systemitem></entry>
|
|
<entry align="left" valign="top"><classname>EchoCommand</classname></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">string</structname></entry>
|
|
<entry align="left" valign="top"><literal>echo</literal></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">echoArgs</systemitem></entry>
|
|
<entry align="left" valign="top"><classname>EchoArgs</classname></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">string</structname></entry>
|
|
<entry align="left" valign="top"><literal>"%s"</literal></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">foldCommand</systemitem></entry>
|
|
<entry align="left" valign="top"><classname>FoldCommand</classname></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">string</structname></entry>
|
|
<entry align="left" valign="top"><literal>fold</literal></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">foldArgs</systemitem></entry>
|
|
<entry align="left" valign="top"><classname>FoldArgs</classname></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">string</structname></entry>
|
|
<entry align="left" valign="top"><literal>-w %d %s</literal></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">prCommand</systemitem></entry>
|
|
<entry align="left" valign="top"><classname>PrCommand</classname></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">string</structname></entry>
|
|
<entry align="left" valign="top"><literal>pr</literal></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">prArgs</systemitem></entry>
|
|
<entry align="left" valign="top"><classname>PrArgs</classname></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">string</structname></entry>
|
|
<entry align="left" valign="top"><literal>see below</literal></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">prOffsetArg</systemitem></entry>
|
|
<entry align="left" valign="top"><classname>PrOffsetArg</classname></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">string</structname></entry>
|
|
<entry align="left" valign="top"><literal>-o%d</literal></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">manCommand</systemitem></entry>
|
|
<entry align="left" valign="top"><classname>ManCommand</classname></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">string</structname></entry>
|
|
<entry align="left" valign="top"><literal>man</literal></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">manArgs</systemitem></entry>
|
|
<entry align="left" valign="top"><classname>ManArgs</classname></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">string</structname></entry>
|
|
<entry align="left" valign="top"><literal>%s</literal></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">redirectCmdAndArgs</systemitem></entry>
|
|
<entry align="left" valign="top"><classname>RedirectCmdAndArgs</classname></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">string</structname></entry>
|
|
<entry align="left" valign="top"><literal>> %s</literal></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">lpCommand</systemitem></entry>
|
|
<entry align="left" valign="top"><classname>LpCommand</classname></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">string</structname></entry>
|
|
<entry align="left" valign="top"><literal>lp</literal></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">shCommand</systemitem></entry>
|
|
<entry align="left" valign="top"><classname>ShCommand</classname></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">string</structname></entry>
|
|
<entry align="left" valign="top"><literal>see below</literal></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">iconvCmdAndArgs</systemitem></entry>
|
|
<entry align="left" valign="top"><classname>IconvCmdAndArgs</classname></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">string</structname></entry>
|
|
<entry align="left" valign="top"><literal>see below</literal></entry></row>
|
|
</tbody></tgroup></informaltable>
|
|
<informaltable remap="center" orient="port">
|
|
<tgroup cols="4" colsep="0" rowsep="0">
|
|
<?PubTbl tgroup dispwid="6.85in">
|
|
<colspec align="left" colwidth="142*">
|
|
<colspec align="left" colwidth="138*">
|
|
<colspec align="left" colwidth="147*">
|
|
<colspec align="left" colwidth="138*">
|
|
<tbody>
|
|
<row>
|
|
<entry align="left" valign="top"><literal>evenTocHeader</literal></entry>
|
|
<entry align="left" valign="top"><literal>oddTocHeader</literal></entry>
|
|
<entry align="left" valign="top"><literal>evenTocFooter</literal></entry>
|
|
<entry align="left" valign="top"><literal>oddTocFooter</literal></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><literal>evenBodyHeader</literal></entry>
|
|
<entry align="left" valign="top"><literal>oddBodyHeader</literal></entry>
|
|
<entry align="left" valign="top"><literal>evenBodyFooter</literal></entry>
|
|
<entry align="left" valign="top"><literal>oddBodyFooter</literal></entry>
|
|
</row>
|
|
<row>
|
|
<entry align="left" valign="top"><literal>evenIndexHeader</literal></entry>
|
|
<entry align="left" valign="top"><literal>oddIndexHeader</literal></entry>
|
|
<entry align="left" valign="top"><literal>evenIndexFooter</literal></entry>
|
|
<entry align="left" valign="top"><literal>oddIndexFooter</literal></entry>
|
|
</row></tbody></tgroup></informaltable>
|
|
<para>The values of these resources are used as the header and footer strings
|
|
only when printing Help volumes. Header and footer strings are specified separately
|
|
for odd and even pages to support double sided printing. The strings may contain
|
|
symbolic names for dynamic values.</para>
|
|
<para>Dynamic values are updated each time the string is to be used. Valid
|
|
dynamic values are as follows:</para>
|
|
<informaltable remap="center" orient="port">
|
|
<tgroup cols="2" colsep="0" rowsep="0">
|
|
<?PubTbl tgroup dispwid="5.90in">
|
|
<colspec align="left" colwidth="154*">
|
|
<colspec align="left" colwidth="332*">
|
|
<tbody>
|
|
<row>
|
|
<entry align="left" valign="top"><literal>Symbol</literal></entry>
|
|
<entry align="left" valign="top"><literal>Value</literal></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><Symbol>$LMARGIN</Symbol></entry>
|
|
<entry align="left" valign="top">left margin blanks.</entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><Symbol>$TODAY</Symbol></entry>
|
|
<entry align="left" valign="top">today's date.</entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><Symbol>$VOLDATE</Symbol></entry>
|
|
<entry align="left" valign="top">date on the help volume file.</entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><Symbol>$VOLUME</Symbol></entry>
|
|
<entry align="left" valign="top">volume name.</entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><Symbol>$VOLUMEFILL</Symbol></entry>
|
|
<entry align="left" valign="top">filler for fixed sized 50 column volume name.</entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><Symbol>$TOPIC</Symbol></entry>
|
|
<entry align="left" valign="top">section topic title.</entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><Symbol>$TOPICFILL</Symbol></entry>
|
|
<entry align="left" valign="top">filler for fixed sized 50 column section
|
|
topic title.</entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><Symbol>$PAGENUM</Symbol></entry>
|
|
<entry align="left" valign="top">page number.</entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><Symbol>$PAGENUMFILL</Symbol></entry>
|
|
<entry align="left" valign="top">filler for fixed sized 3 column page number.</entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><Symbol>$SECTNUM</Symbol></entry>
|
|
<entry align="left" valign="top">section number or name.</entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><Symbol>$SECTNUMFILL</Symbol></entry>
|
|
<entry align="left" valign="top">filler for fixed sized 8 column section number
|
|
or name.</entry></row></tbody></tgroup></informaltable>
|
|
<para>The default values for the resources are as follows (To improve understanding,
|
|
the blank spaces have been replaced with '.'.):</para>
|
|
<variablelist>
|
|
<varlistentry><term>evenTocHeader and oddTocHeader:</term>
|
|
<listitem>
|
|
<para>$LMARGIN....$VOLUME\n\n</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term>evenTocFooter and oddTocFooter:</term>
|
|
<listitem>
|
|
<para>\n$LMARGIN...$SECTNUM</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term>evenBodyHeader and oddBodyHeader:</term>
|
|
<listitem>
|
|
<para>$LMARGIN$VOLUME$VOLUMEFILL....$PAGENUMFILLPage.$PAGENUMn</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term>evenBodyFooter and oddBodyFooter:</term>
|
|
<listitem>
|
|
<para>\n$LMARGIN$TOPIC$TOPICFILL.....$SECTNUMFILLSection.$SECTNUM\n</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term>evenIndexHeader and oddIndexHeader:</term>
|
|
<listitem>
|
|
<para>$LMARGIN$VOLUME$VOLUMEFILL.....$PAGENUMFILLPage.$PAGENUM\n\n</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term>evenIndexFooter and oddIndexFooter:</term>
|
|
<listitem>
|
|
<para>\n$LMARGIN.......$SECTNUM\n</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<variablelist>
|
|
<varlistentry><term>echoCommand</term>
|
|
<listitem>
|
|
<para>The utility used to echo the <literal>stringData</literal> from stdin
|
|
to stdout.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term>echoArgs</term>
|
|
<listitem>
|
|
<para>The argument string to the <literal>echoCommand</literal>. The string
|
|
must use <literal>printf</literal> formatting and may reference this argument:
|
|
STRING string.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term>foldCommand</term>
|
|
<listitem>
|
|
<para>The utility used to fold a long string into a formatted string with
|
|
a maxiumum column width.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term>foldArgs</term>
|
|
<listitem>
|
|
<para>The argument string to the <literal>foldCommand</literal>. The string
|
|
must use <literal>printf</literal> formatting and may reference these arguments:
|
|
INT column width, STRING filename.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term>prCommand</term>
|
|
<listitem>
|
|
<para>The utility used to format a file in preparation for printing.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term>prArgs</term>
|
|
<listitem>
|
|
<para>The argument string to the <literal>prCommand.</literal> The string
|
|
must use <literal>printf</literal> formatting and may reference these arguments:
|
|
STRING job title, INT page height, STRING filename. The default value is <literal>-h</literal> <literal>%s</literal> <literal>-f</literal> <literal>-l%d</literal> <literal>%s"</literal></para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term>prOffsetArg</term>
|
|
<listitem>
|
|
<para>Sometimes the prArgs is augmented with the option to offset the contents
|
|
by <symbol role="Variable">n</symbol> columns. The value contains the offset
|
|
argument. The string must use <literal>printf</literal> formatting and may
|
|
reference this argument: INT column-offset.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term>manCommand</term>
|
|
<listitem>
|
|
<para>The utility used to recover a formatted Unix man page.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term>manArgs</term>
|
|
<listitem>
|
|
<para>The argument string to the <literal>manCommand.</literal> The string
|
|
must use <literal>printf</literal> formatting and may reference these arguments:
|
|
STRING man-page-name.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term>redirectCmdAndArgs</term>
|
|
<listitem>
|
|
<para>When stdout is to be redirected to a file, this utility and arguments
|
|
are used. The string must use <literal>printf</literal> formatting and may
|
|
reference these arguments: STRING filename</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term>lpCommand</term>
|
|
<listitem>
|
|
<para>The utility is used to print a file. The utility must accept the standard <command>lp</command>(1) utility-line arguments.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term>shCommand</term>
|
|
<listitem>
|
|
<para>The shell script used by <command>dthelpprint</command> to actually invoke
|
|
the <literal>lpCommand</literal> on the target file. The default value is <Filename>/usr/dt/bin/dthelpprint.sh.</Filename></para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term>iconvCmdAndArgs</term>
|
|
<listitem>
|
|
<para>The utility is used to translate a file from one character set to another.
|
|
The argument string must use <literal>printf</literal> formatting and may
|
|
reference these arguments: STRING from-charset, STRING to-charset, STRING
|
|
source-file, STRING dest-file. The default value is <literal>iconv -f %s -t
|
|
%s %s > %s</literal></para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect2>
|
|
</refsect1>
|
|
<refsect1>
|
|
<title>PRINTER CONFIGURATION RESOURCES</title>
|
|
<para>These resources specify printer configuration. This includes a default
|
|
configuration as well as printer-specific configurations. The syntax for specifying
|
|
the resources is</para>
|
|
<ProgramListing><literal>Dthelpprint*printer.</literal> <symbol role="Variable">resource</symbol><literal>:</literal>resource value
|
|
<literal>Dthelpprint*printer.</literal><emphasis>printerName.resource</emphasis> <literal>:</literal>resource value
|
|
</ProgramListing>
|
|
<para>For example,</para>
|
|
<ProgramListing>Dthelpprint*printer.paperSize: help_papersize_legal
|
|
Dthelpprint*printer.laser-c4.paperSize: help_papersize_executive
|
|
</ProgramListing>
|
|
<para>set the default paper size to legal and the paper size on the printer
|
|
named "laser-c4" to executive.</para>
|
|
<refsect2>
|
|
<title>Basic Resource Set</title>
|
|
<informaltable remap="center" orient="port">
|
|
<tgroup cols="4" colsep="0" rowsep="0">
|
|
<colspec align="left" colwidth="1.86in">
|
|
<colspec align="left" colwidth="1.98in">
|
|
<colspec align="left" colwidth="0.77in">
|
|
<colspec align="left" colwidth="1.71in">
|
|
<tbody>
|
|
<row>
|
|
<entry align="left" valign="top"><literal>Name</literal></entry>
|
|
<entry align="left" valign="top"><literal>Class</literal></entry>
|
|
<entry align="left" valign="top"><literal>Type</literal></entry>
|
|
<entry align="left" valign="top"><literal>Default</literal></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">paperSize</systemitem></entry>
|
|
<entry align="left" valign="top"><classname>PaperSize</classname></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">String</structname></entry>
|
|
<entry align="left" valign="top"><literal>help_papersize_letter</literal></entry>
|
|
</row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">colsWidth</systemitem></entry>
|
|
<entry align="left" valign="top"><classname>ColsWidth</classname></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">int</structname></entry>
|
|
<entry align="left" valign="top"><literal>0</literal></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">rowsHeight</systemitem></entry>
|
|
<entry align="left" valign="top"><classname>RowsHeight</classname></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">int</structname></entry>
|
|
<entry align="left" valign="top"><literal>0</literal></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">colsLeftMargin</systemitem></entry>
|
|
<entry align="left" valign="top"><classname>ColsLeftMargin</classname></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">int</structname></entry>
|
|
<entry align="left" valign="top"><literal>10</literal></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">colsRightMargin</systemitem></entry>
|
|
<entry align="left" valign="top"><classname>ColsRightMargin</classname></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">int</structname></entry>
|
|
<entry align="left" valign="top"><literal>10</literal></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">rowsTopMargin</systemitem></entry>
|
|
<entry align="left" valign="top"><classname>RowsTopMargin</classname></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">int</structname></entry>
|
|
<entry align="left" valign="top"><literal>6</literal></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><systemitem class="resource">rowsBottomMargin</systemitem></entry>
|
|
<entry align="left" valign="top"><classname>RowsBottomMargin</classname></entry>
|
|
<entry align="left" valign="top"><structname role="typedef">int</structname></entry>
|
|
<entry align="left" valign="top"><literal>6</literal></entry></row></tbody>
|
|
</tgroup></informaltable>
|
|
<para>These resources are used to specify the printer configuration, specifically
|
|
with respect to the paper used for printing. Paper size can be specified either
|
|
by using the <systemitem class="resource">paperSize</systemitem> resource or by setting an explicit
|
|
size with the <systemitem class="resource">colsWidth</systemitem> and <systemitem class="resource">rowsHeight</systemitem>
|
|
resources. The margin values specify the amount of white space retained around
|
|
the page.</para>
|
|
<variablelist>
|
|
<varlistentry><term>paperSize</term>
|
|
<listitem>
|
|
<para>This resource can be used to set the paper size to predefined dimensions.
|
|
Valid values are <literal>help_papersize_letter,</literal> (8.5 x 11 in; 69
|
|
rows x 91 cols) <literal>help_papersize_legal,</literal> (8.5 x 14 in; 88
|
|
rows x 91 cols) <literal>help_papersize_executive,</literal> (7.25 x 10.5
|
|
in, 66 rows x 77 cols) <literal>help_papersize_a4,</literal> (210 x 297 mm,
|
|
73 rows x 88 cols) and <literal>help_papersize_b5</literal> (182 x 257 mm,
|
|
63 rows x 76 cols). If these dimensions are insufficient, the
|
|
<systemitem class="resource">colsWidth</systemitem> and <systemitem class="resource">rowsHeight</systemitem> resources can be used to provide
|
|
explicit dimensions. All dimensions are given in columns and rows of text
|
|
in the default printer font.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term>colsWidth</term>
|
|
<listitem>
|
|
<para>Width of the paper in columns of characters in the default printer font.
|
|
The value may not be 0 (zero).</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term>rowsHeight</term>
|
|
<listitem>
|
|
<para>Height of the paper in rows of text in the default printer font. The
|
|
value may not be 0 (zero).</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term>colsLeftMargin</term>
|
|
<listitem>
|
|
<para>Width of the left margin in columns of characters in the default printer
|
|
font.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term>colsRightMargin</term>
|
|
<listitem>
|
|
<para>Width of the right margin in columns of characters in the default printer
|
|
font.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term>rowsTopMargin</term>
|
|
<listitem>
|
|
<para>Height of the top margin in rows of text in the default printer font.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term>rowsBottomMargin</term>
|
|
<listitem>
|
|
<para>Height of the bottom margin in rows of text in the default printer font.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect2>
|
|
</refsect1>
|
|
<refsect1>
|
|
<title>ENVIRONMENT VARIABLES</title>
|
|
<para>The CDE Help system uses two environment variables for locating Help
|
|
volumes files within the desktop environment:</para>
|
|
<variablelist>
|
|
<varlistentry><term><emphasis>DTHELPSEARCHPATH</emphasis></term>
|
|
<listitem>
|
|
<para><emphasis>System</emphasis> search path environment variable for locating
|
|
Help volumes on local and/or remote nfs mounted systems.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term><emphasis>DTHELPUSERSEARCHPATH</emphasis></term>
|
|
<listitem>
|
|
<para><emphasis>Users</emphasis> search path environment variable for locating
|
|
user specific Help volumes on local and/or remote nfs mounted systems.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<para>Refer to &cdeman.DtHelpDialog; or &cdeman.DtHelpQuickDialog; for information of setting the <emphasis>DTHELP</emphasis> environment
|
|
variables.</para>
|
|
</refsect1>
|
|
<refsect1>
|
|
<title>INPUT FILES</title>
|
|
<para>The following are input files and resource databases are merged by <command>dthelpprint</command> to construct the complete resource database used by
|
|
the program. Resource collisions are resolved by having the last value take
|
|
precedence.</para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para><Filename>/usr/dt/app-defaults/C/Dthelpprint</Filename></para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><Filename>/usr/lib/X11/app-defaults/Dthelpprint</Filename></para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><Filename>$HOME/Dthelpprint</Filename></para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>display resources or <filename>$HOME/.Xdefaults</filename></para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>screen resources</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>$XENVIRONMENT or <literal>$HOME/.Xdefaults−<hostname></literal></para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>utility−line resources</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</refsect1>
|
|
<refsect1>
|
|
<title>OUTPUT FILES</title>
|
|
<para>The <command>dthelpprint</command> utility always generates an output
|
|
file, either for sending to the printer or to place in a user-specified file.
|
|
</para>
|
|
<variablelist>
|
|
<varlistentry><term><literal>$HOME/.dt/tmp/phlp<process id>_<cnt>.txt</literal></term>
|
|
<listitem>
|
|
<para>These are the temporary files generated by the <command>dthelpprint</command> utility. These files are placed under the user's directory so that
|
|
remote systems can reach the file via NFS.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term><Filename>$PWD/db.dthelpprint</Filename></term>
|
|
<listitem>
|
|
<para>This file is generated in the current directory when the <systemitem class="resource">debugHelpPrint</systemitem> resource is defined. The file constains the complete set of resources
|
|
used by <command>dthelpprint</command> to configure its operation.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<refsect2>
|
|
<title>Warning Messages</title>
|
|
<variablelist>
|
|
<varlistentry><term><literal>Warning: Illegal or missing paper size. help_papersize_letter
|
|
used.</literal></term>
|
|
<listitem>
|
|
<para>Indicates an invalid or missing value of the <literal>paperSize</literal>
|
|
resource or <literal>−paperSize</literal> option. Specify the option
|
|
on the utility line or set a default resource value.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term><literal>Warning: Missing paper size and height and/or
|
|
width. help_papersize_letter used.</literal></term>
|
|
<listitem>
|
|
<para>Indicates that the <systemitem class="resource">printer.colsWidth</systemitem> or <systemitem class="resource">printer.rowsHeight</systemitem> resource was used to override the <systemitem class="resource">paperSize</systemitem> resource and at least one is set to 0 (zero) or has an invalid
|
|
value.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term><literal>Warning: Unable to open display <display></literal></term>
|
|
<listitem>
|
|
<para>Indicates that the display specified by the <systemitem class="resource">display</systemitem>
|
|
resource or <literal>−display</literal> option could not be opened.
|
|
This means that the display's resources cannot be used to configure <command>dthelpprint</command>.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect2>
|
|
<refsect2>
|
|
<title>Error Messages</title>
|
|
<variablelist>
|
|
<varlistentry><term><literal>Error: helpType is topic, but no helpVolume specified.</literal></term>
|
|
<listitem>
|
|
<para>Indicates that the <systemitem class="resource">helpType</systemitem> resource or <literal>−helpType</literal> option was 0 (zero) or unspecified and defaulted
|
|
to 0 (zero) and no helpVolume was specified.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term><literal>Error: unable to locate help volume <volume></literal></term>
|
|
<listitem>
|
|
<para>Indicates that the Help volume could not be found. This occurs when
|
|
the volume isn't correctly specified by a full or relative path or doesn't
|
|
exist in any directory listed by the DtHelp environment variables.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term><literal>Error: problem processing help volume <volume></literal></term>
|
|
<listitem>
|
|
<para>A problem occurred while processing some part of the Help volume.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term><literal>Error: memory allocation failed</literal></term>
|
|
<listitem>
|
|
<para>The program was unable to allocate necessary memory.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term><literal>Error: unable to get topic information:volume
|
|
<vol>, locationId <loc></literal></term>
|
|
<listitem>
|
|
<para>Information about the specified location in the specified volume was
|
|
unavailable or an error occurred while retrieving it from the volume.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term><literal>Error: helpType is string, but no stringData
|
|
specified.</literal></term>
|
|
<listitem>
|
|
<para>The <systemitem class="resource">helpType</systemitem> resource or <literal>−helpType</literal> option is 1 (string) but no <systemitem class="resource">stringData</systemitem> resource
|
|
or <literal>−stringData</literal> option was specified.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term><literal>Error: helpType is dynamic string, but no stringData
|
|
specified.</literal></term>
|
|
<listitem>
|
|
<para>The <systemitem class="resource">helpType</systemitem> resource or
|
|
<literal>−helpType</literal> option is 1 (dynamic string) but no
|
|
<systemitem class="resource">stringData</systemitem>
|
|
resource or <literal>-stringData</literal> option was specified.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term><literal>Error: helpType is man page, but no manPage specified.</literal></term>
|
|
<listitem>
|
|
<para>The <literal>helpType</literal> resource or <literal>−helpType</literal> option is 2 (manual page) but no <literal>manPage</literal> resource
|
|
or <literal>−manPage</literal> option was specified.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term><literal>Error: helpType is file, but no helpFile specified.</literal></term>
|
|
<listitem>
|
|
<para>The <literal>helpType</literal> resource or <literal>−helpType</literal> option is 3 (plain text file) but no <literal>helpFile</literal>
|
|
resource or <literal>−helpFile</literal> option was specified.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term><literal>Error: Illegal helpType <number>.</literal></term>
|
|
<listitem>
|
|
<para>The <systemitem class="resource">helpType</systemitem> resource or <literal>−helpType</literal> option is not in the range 0 to 3.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term><literal>Error: unable to allocate memory for temporary
|
|
file</literal></term>
|
|
<listitem>
|
|
<para>The memory needed to create the temporary file name couldn't be allocated.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry><term><literal>Error: unable to open temporary file</literal></term>
|
|
<listitem>
|
|
<para>The temporary file couldn't be opened for writing.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect2>
|
|
</refsect1>
|
|
<refsect1>
|
|
<title>EXAMPLES</title>
|
|
<programlisting><literal>dthelpprint −helpVolume Help4Help −allTopics −outputFile Help4Help.asc</literal>
|
|
dthelpprint −helpVolume Help4Help −toc −index −printer hplj3
|
|
dthelpprint −helpType 1 −stringData 'test string' −printer hplj3
|
|
dthelpprint −helpType 2 −manPage grep −outputFile grep.man
|
|
dthelpprint −helpType 3 −helpFile aFile −printer hplj3
|
|
</programlisting>
|
|
</refsect1>
|
|
<refsect1>
|
|
<title>SEE ALSO</title>
|
|
<para>&cdeman.DtHelpDialog;, &cdeman.DtHelpQuickDialog;, &cdeman.dthelpview;, <function>man</function>(1), <emphasis>CDE Help System
|
|
Author's and Programmer's Guide.</emphasis></para>
|
|
</refsect1>
|
|
</refentry>
|
|
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->
|
|
<?Pub *0000087805>
|