debian/cdesktop
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Initial import of the CDE 2.1.30 sources from the Open Group.

Browse Source
This commit is contained in:
Peter Howkins
2012-03-10 18:21:40 +00:00
commit 83b6996daa
18978 changed files with 3945623 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

291
cde/doc/C/guides/man/man1_dt/action.sgm Normal file
View File

@@ -0,0 +1,291 @@
<!-- $XConsortium: action.sgm /main/9 1996/09/09 19:38:32 rws $ -->
<!-- (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. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN0.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN0.rsml.1">]]>
<RefMeta>
<RefEntryTitle>dtaction</RefEntryTitle>
<ManVolNum>user cmd</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Command>dtaction</Command></RefName>
<RefPurpose>invoke a &str-XZ; action with specified arguments
</RefPurpose>
</RefNameDiv>
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- *************************************************************************-->
<!-- ** (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- ** (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- ** (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- ** (c) Copyright 1993, 1994, 1995 Novell, Inc-->
<!-- *************************************************************************-->
<RefSynopsisDiv>
<CmdSynopsis>
<Command>dtaction</Command>
<Arg Choice="opt">&minus;contextDir&numsp;<Replaceable>context_dir</Replaceable></Arg>
<Arg Choice="opt">&minus;execHost&numsp;<Replaceable>host_name</Replaceable></Arg>
<Arg Choice="opt">&minus;termOpts&numsp;<Replaceable>terminal_arguments</Replaceable></Arg>
<Arg Choice="opt">&minus;user&numsp;<Replaceable>user_name</Replaceable></Arg>
<Arg><Replaceable>action_name</Replaceable></Arg>
<Arg Choice="opt"><Replaceable>action_arg</Replaceable></Arg>
<Arg>...</Arg>
</CmdSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Command>dtaction</Command> utility allows applications or shell scripts, which are otherwise not
connected into the &str-XZ; development environment, to invoke action requests.
</Para>
<Para>The action called
<Emphasis>action_name</Emphasis> is invoked with the
<Emphasis>action_arg</Emphasis> provided on the command line.
A single
<Emphasis>action_name</Emphasis> is required;
the user may provide any number of
<Emphasis>action_arg</Emphasis>s. Interpretation of the
<Emphasis>action_name</Emphasis> and
<Emphasis>action_arg</Emphasis>s depends on the
definition of the action in the action database (see
<![ %CDE.C.CDE; [&cdeman.dtactionfile;). ]]><![ %CDE.C.XO; [<XRef Linkend="XCDI.ACTI.anch.3" Role="2">). ]]>The action may be defined in one of the system action database files,
or in one of the user's private action database files.
</Para>
<Para>The
<Emphasis>action_arg</Emphasis>s are absolute or relative pathnames of files.
The utility passes this list of files on to the specified action.
</Para>
<Para>Error dialogs are posted when the following conditions are detected:
</Para>
<ItemizedList>
<!-- merged from xo+cde-->
<ListItem>
<Para>could not initialize desktop environment
</Para>
</ListItem>
<ListItem>
<Para>invalid user or password
</Para>
</ListItem>
<ListItem>
<Para>unable to change ID to the desired user
</Para>
</ListItem>
<ListItem>
<Para>no action name specified
</Para>
</ListItem>
</ItemizedList>
</RefSect1>
<RefSect1>
<Title>OPTIONS</Title>
<![ %CDE.C.XO; [
<Para>The
<Command>dtaction</Command> utility does not support the &str-Zu; because it uses
the X Window System convention of full-word options.
</Para>
]]>
<Para>The following options are available:
</Para>
<VariableList>
<VarListEntry>
<Term><Literal>&minus;contextDir</Literal> <Emphasis>context_dir</Emphasis></Term>
<ListItem>
<Para>If the definition of
<Emphasis>action_name</Emphasis> does not define
a current working directory (see
<SystemItem Class="Constant">CWD</SystemItem> in
<![ %CDE.C.CDE; [&cdeman.dtactionfile;) ]]><![ %CDE.C.XO; [<XRef Linkend="XCDI.ACTI.anch.3" Role="2">) ]]>for command actions,
the user can use this option to specify a default directory context.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>&minus;execHost</Literal> <Emphasis>host_name</Emphasis></Term>
<ListItem>
<Para>The user can use this option to specify an alternative execution host,
<Emphasis>host_name</Emphasis>, for a command action.
If the action is not a command
action, the
<Command>dtaction</Command> utility ignores this option.
The action is attempted on
<Emphasis>host_name</Emphasis> instead of the hosts specified in the action's
<SystemItem Class="Constant">EXEC_HOST</SystemItem> (see
<![ %CDE.C.CDE; [&cdeman.dtactionfile;) ]]><![ %CDE.C.XO; [<XRef Linkend="XCDI.ACTI.anch.3" Role="2">) ]]>specification.
An error dialog is posted if it is not possible to invoke the
specified action on any eligible host.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>&minus;termOpts</Literal> <Emphasis>terminal_arguments</Emphasis></Term>
<ListItem>
<Para>This option allows the user to specify arguments intended for the terminal
emulator that is provided for command actions that are not of type
<SystemItem Class="Constant">NO_STDIO</SystemItem>. If there are white-space characters in the
<Emphasis>terminal_arguments</Emphasis> string,
that string must be quoted to protect it from the shell.
These arguments are passed unchanged to the terminal emulator.
The user must ensure that they are reasonable; in particular,
<Emphasis>terminal_arguments</Emphasis> does not allow the argument that specifies the command
to be run in a terminal emulator window (that is,
<Literal>&minus;e</Literal> for
&cdeman.dtterm;).</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>&minus;user</Literal> <Emphasis>user_name</Emphasis></Term>
<ListItem>
<Para>The
<Literal>&minus;user</Literal> option allows a user to specify a user name.
If
<Command>dtaction</Command> is not currently running as that user, a prompt dialog
collects the indicated user password, or the root user
password.
Once a valid password is entered, the
<Command>dtaction</Command> utility changes so
that it is running as the requested user and then
initiates the requested action.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>OPERANDS</Title>
<Para>The following operands are supported:
</Para>
<VariableList>
<VarListEntry>
<Term><Emphasis>action_name</Emphasis></Term>
<ListItem>
<Para>The name of the action to be invoked.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>action_arg</Emphasis></Term>
<ListItem>
<Para>The absolute or relative file names of files.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>STDIN</Title>
<Para>Not used.
</Para>
</RefSect1>
<RefSect1>
<Title>INPUT FILES</Title>
<Para>The input files named as
<Emphasis>action_arg</Emphasis> arguments are
absolute or relative names of files.
</Para>
<Para>The action database files found on
<SystemItem Class="EnvironVar">DTDATABASESEARCHPATH</SystemItem> conform to the format specified in
<![ %CDE.C.CDE; [&cdeman.dtactionfile;. ]]><![ %CDE.C.XO; [<XRef Linkend="XCDI.ACTI.anch.3" Role="2">. ]]></Para>
</RefSect1>
<RefSect1>
<Title>ENVIRONMENT VARIABLES</Title>
<Para>The following environment variable affects the execution of
<Command>dtaction</Command>:</Para>
<VariableList>
<VarListEntry>
<Term><SystemItem Class="EnvironVar">DTDATABASESEARCHPATH</SystemItem></Term>
<ListItem>
<Para>A comma-separated list of directories (with optional host: prefix)
that tells the action service where to find the action databases.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RESOURCES</Title>
<Para>None.
</Para>
</RefSect1>
<RefSect1>
<Title>ASYNCHRONOUS EVENTS</Title>
<![ %CDE.C.XO; [
<Para>Default.
</Para>
]]>
<![ %CDE.C.CDE; [
<Para>The
<Command>dtaction</Command> utility takes the standard action for all signals.
</Para>
]]>
</RefSect1>
<RefSect1>
<Title>STDOUT</Title>
<Para>Not used.
</Para>
</RefSect1>
<RefSect1>
<Title>STDERR</Title>
<Para>The
<Command>dtaction</Command> utility writes diagnostic error messages to standard error,
which is redirected to
<Filename>$HOME/.dt/errorlog</Filename>.</Para>
</RefSect1>
<RefSect1>
<Title>OUTPUT FILES</Title>
<Para>None.
</Para>
</RefSect1>
<RefSect1>
<Title>EXTENDED DESCRIPTION</Title>
<Para>None.
</Para>
</RefSect1>
<RefSect1>
<Title>EXIT STATUS</Title>
<Para>The following exit values are returned:
</Para>
<VariableList>
<VarListEntry>
<Term>0</Term>
<ListItem>
<Para>Successful completion.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>>0</Term>
<ListItem>
<Para>An invocation error was detected.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>CONSEQUENCES OF ERRORS</Title>
<Para>Default.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>None.
</Para>
</RefSect1>
<RefSect1>
<Title>EXAMPLES</Title>
<Para>None.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para><![ %CDE.C.CDE; [&cdeman.dtactionfile;]]><![ %CDE.C.XO; [<XRef Linkend="XCDI.ACTI.anch.3" Role="2">]]>,
&cdeman.dtterm;, &cdeman.dtaction;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->

248
cde/doc/C/guides/man/man1_dt/appgathe.sgm Normal file
View File

@@ -0,0 +1,248 @@
<!-- $XConsortium: appgathe.sgm /main/6 1996/08/31 14:48:52 rws $ -->
<!-- (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.MAN1.rsml.1">
<RefMeta>
<RefEntryTitle>dtappgather</RefEntryTitle>
<ManVolNum>user cmd</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Command>dtappgather</Command></RefName>
<RefPurpose>gather application files for presentation by the
Application Manager
</RefPurpose>
</RefNameDiv>
<!-- CDE Common Source Format, Version 1.0.0-->
<!--- -->
<!-- (c) Copyright 1993, 1994 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994 Novell, Inc.-->
<RefSynopsisDiv>
<CmdSynopsis>
<Command>dtappgather</Command>
<Arg Choice="opt">-r</Arg>
</CmdSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
Application Manager
presents personal, system, and factory applications in
an easy-to-access window.
The
Application Manager
is implemented as a special File Manager view of a
subdirectory that is built on a per-user, per-session basis.
The
<Command>dtappgather</Command> utility is responsible for creating and refreshing
the user's
Application Manager
subdirectory.
</Para>
<Para>The
<Command>dtappgather</Command> utility
is run at login and whenever the user invokes the
<Literal>ReloadApps</Literal> action.
The user's individual subdirectory for the
Application Manager,
<Filename>/var/dt/appconfig/appmanager/$DTUSERSESSION</Filename>, is opened when the user presses the Application Manager control
on the Front Panel.
</Para>
<Para>The sequence of events is as follows:
</Para>
<ItemizedList>
<ListItem>
<Para>When the user logs in, the <Command>Xsession</Command> script sources in the
<Literal>Xsession.d</Literal> script that sets the <SystemItem Class="EnvironVar">DTUSERSESSION</SystemItem> environment
variable.
</Para>
</ListItem>
<ListItem>
<Para><Command>Xsession</Command> then invokes the
<Command>dtsearchpath</Command>
utility to set the <SystemItem Class="EnvironVar">DTAPPSEARCHPATH</SystemItem> environment variable.
</Para>
</ListItem>
<ListItem>
<Para>After
<Command>dtsearchpath</Command>
returns with the <SystemItem Class="EnvironVar">DTAPPSEARCHPATH</SystemItem> assembled,
the <Command>Xsession</Command> script calls
<Command>dtappgather</Command>.</Para>
</ListItem>
<ListItem>
<Para>As its main function,
<Command>dtappgather</Command> traverses the <SystemItem Class="EnvironVar">DTAPPSEARCHPATH</SystemItem>,
examining each possible source of applications and, where
there are existing source subdirectories, creates symbolic links between
the source and the user's <SystemItem Class="EnvironVar">DTUSERSESSION</SystemItem> subdirectory.
</Para>
</ListItem>
<ListItem>
<Para>Finally,
<Command>dtappgather</Command> turns off write permissions on the resulting subdirectory to ensure its
integrity.
</Para>
<Para>A similar sequence occurs when the user double-clicks the <Literal>ReloadApps</Literal>
action after logging in.
</Para>
<Para>Although the value of the <SystemItem Class="EnvironVar">DTAPPSEARCHPATH</SystemItem> can be modified in a
local shell, the
Application Manager
view based on its value is not functional until you log out and
log back in.
Since this can be a tedious venture, you can verify the
Application Manager
view by executing
&cdeman.dtsearchpath; and
<Command>dtappgather</Command> in the local shell.
For
example, to add host
<Literal>trout</Literal> as a system-wide
application server, set the
&cdeman.dtsearchpath; input environment variable,
<Emphasis>DTSPSYSAPPHOSTS</Emphasis>: <Literal>DTSPSYSAPPHOSTS=trout</Literal>: Then, execute
&cdeman.dtsearchpath; to update the
<SystemItem Class="EnvironVar">DTAPPSEARCHPATH</SystemItem> environment
variable.
<Literal>eval</Literal> <Literal>`dtsearchpath`</Literal> Finally, gather the new applications by executing
<Command>dtappgather</Command>. The
Application Manager
will show the new application groups but will not be functional.
</Para>
</ListItem>
</ItemizedList>
</RefSect1>
<RefSect1>
<Title>OPTIONS</Title>
<Para>The
<Literal>-r</Literal>
option causes
<Command>dtappgather</Command> to retain the previous contents of the Application Manager, although
discarding broken links.
At login,
<Command>dtappgather</Command> destroys the user's previous <SystemItem Class="EnvironVar">DTUSERSESSION</SystemItem> subdirectory before
creating a new one.
At <Literal>ReloadApps</Literal> time, the <Literal>-r</Literal> option
is used to minimize visual disruption of any opened
Application Manager
views.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN</Title>
<Para>The command always returns 0 (zero) for successful completion.
</Para>
</RefSect1>
<RefSect1>
<Title>ENVIRONMENT</Title>
<VariableList>
<VarListEntry>
<Term><SystemItem Class="EnvironVar">DTAPPSEARCHPATH</SystemItem></Term>
<ListItem>
<Para>Set by the
&cdeman.dtsearchpath; utility.
<SystemItem Class="EnvironVar">DTAPPSEARCHPATH</SystemItem> controls the places
where
<Command>dtappgather</Command> will gather applications.
The default locations consist of
<Filename>$HOME/.dt/appmanager</Filename> (for end users),
<Filename>/etc/dt/appconfig/appmanager/$LANG</Filename> (for system administrators), and
<Filename>/usr/dt/appconfig/appmanager/$LANG</Filename> (for factory applications).
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="EnvironVar">DTUSERSESSION</SystemItem></Term>
<ListItem>
<Para>Controls the location of the end user's subdirectory where the
Application Manager will be rooted.
The subdirectory name includes
both the user's <Emphasis>$LOGNAME</Emphasis> and <Emphasis>$DISPLAY</Emphasis> in order to
ensure the user's view of the Application Manager remains consistent
across sessions.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>LOCALES</Title>
<Para>When searching for system administrator and factory default
Application Manager
files,
<Command>dtappgather</Command> always uses a value of <Emphasis>$LANG</Emphasis> equal to <Literal>C</Literal>.
When the
user picks a language at login, the corresponding <Emphasis>$LANG</Emphasis>
subdirectories are searched.
If multiple <Emphasis>$LANG</Emphasis> subdirectories exist
in <Filename>/etc/dt/appconfig/appmanager</Filename>, all <Emphasis>$LANG</Emphasis> subdirectories will
appear in the Application Manager; however, if multiple <Emphasis>$LANG</Emphasis>
subdirectories exist in
<Filename>/usr/dt/appconfig/appmanager</Filename> then the
language-specific subdirectory based on the current value of <Emphasis>$LANG</Emphasis> is
chosen instead of the <Literal>C</Literal> subdirectory.
Regardless of locale, all the action files that exist under the user's
<Filename>$HOME/.dt/appmanager</Filename> subdirectory will be symbolically linked
to the user's
Application Manager
subdirectory.
</Para>
</RefSect1>
<RefSect1>
<Title>FILES</Title>
<VariableList>
<VarListEntry>
<Term><Filename>/usr/dt/bin/Xsession</Filename></Term>
<ListItem>
<Para>Among its tasks at login,
the <Command>Xsession</Command> script invokes
&cdeman.dtsearchpath;, and then
<Command>dtappgather</Command>.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Filename>/var/dt/appconfig/appmanager/$DTUSERSESSION</Filename></Term>
<ListItem>
<Para>This subdirectory is where
<Command>dtappgather</Command> assembles the
Application Manager
view for the particular user and CDE session.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>NOTES</Title>
<Para>In the case of multiple search locations having the same name,
<Command>dtappgather</Command> picks only the first and discards the rest.
For example, if the
system administrator sets
<Literal>DTSPSYSAPPHOSTS=tuna:,trout:</Literal>
and if both hosts, <Literal>tuna</Literal> and <Literal>trout</Literal>, have an
<Filename>/etc/dt/appconfig/appmanager/C/Editors</Filename> folder, then only the
<Literal>Editors</Literal> folder from <Literal>tuna</Literal> (the first host) will appear
in the user's Application Manager.
After building the user's <SystemItem Class="EnvironVar">DTUSERSESSION</SystemItem>,
<Command>dtappgather</Command> turns off write permissions on that subdirectory to disallow alteration
by the end user.
Although the end user can resize the
window and rearrange the icons within the window, the Application
Manager is intended to be a read-only source of local
and networked applications.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dtappintegrate;, &cdeman.dtsearchpath;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->

306
cde/doc/C/guides/man/man1_dt/appinteg.sgm Normal file
View File

@@ -0,0 +1,306 @@
<!-- $XConsortium: appinteg.sgm /main/5 1996/09/08 19:49:30 rws $ -->
<!-- (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. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN0.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN0.rsml.1">]]>
<RefMeta>
<RefEntryTitle>dtappintegrate</RefEntryTitle>
<ManVolNum>user cmd</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Command>dtappintegrate</Command></RefName>
<RefPurpose>integrate applications into the &str-XZ;
</RefPurpose>
</RefNameDiv>
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<CmdSynopsis>
<Command>dtappintegrate</Command>
<Arg>&minus;s&numsp;<Replaceable>application_root</Replaceable></Arg>
<Arg Choice="opt">&minus;t&numsp;<Replaceable>target_path</Replaceable></Arg>
<Arg Choice="opt">&minus;l&numsp;<Replaceable>locale</Replaceable></Arg>
<Arg Choice="opt">&minus;u</Arg>
<Arg Choice="opt">&minus;?</Arg>
</CmdSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Command>dtappintegrate</Command> utility integrates applications into &str-XZ;.
Application installation scripts should invoke
<Command>dtappintegrate</Command> as the last step before exiting.
The
<Command>dtappintegrate</Command> <![ %CDE.C.CDE; [utility must be invoked with root user authority.
]]><![ %CDE.C.XO; [utility requires appropriate privileges.
]]></Para>
<Para>When
<Command>dtappintegrate</Command> is invoked with no
<Emphasis>target_path</Emphasis> specified, it creates
symbolic links to the application's &str-XZ; configuration
files under the following default &str-XZ; system locations:
</Para>
<VariableList>
<VarListEntry>
<Term><Filename>/etc/dt/appconfig/types/</Filename><Emphasis>&lt;locale></Emphasis></Term>
<ListItem>
<Para>Contains symbolic links to the application action and datatype files
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Filename>/etc/dt/appconfig/appmanager/</Filename><Emphasis>&lt;locale></Emphasis></Term>
<ListItem>
<Para>Contains symbolic links to the application group subdirectory
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Filename>/etc/dt/appconfig/help/</Filename><Emphasis>&lt;locale></Emphasis></Term>
<ListItem>
<Para>Contains symbolic links to the application help files
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Filename>/etc/dt/appconfig/icons/</Filename><Emphasis>&lt;locale></Emphasis></Term>
<ListItem>
<Para>Contains symbolic links to the application icons
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>OPTIONS</Title>
<![ %CDE.C.XO; [
<Para>The
<Command>dtappintegrate</Command> utility supports the &str-Zu;.
</Para>
]]>
<Para>The following options are available:
</Para>
<VariableList>
<VarListEntry>
<Term><Literal>&minus;s&numsp;</Literal><Emphasis>application_root</Emphasis></Term>
<ListItem>
<Para>Integrate the application files that are located under
<Emphasis>application_root</Emphasis>. The
<Emphasis>application_root</Emphasis> is the top directory
under which all of an application's files are installed.
The
<Command>dtappintegrate</Command> utility looks for application &str-XZ; configuration files in
the following subdirectories, with all C locale subdirectories
containing the application's default &str-XZ; configuration files:
</Para>
<VariableList>
<VarListEntry>
<Term><Emphasis>&lt;application_root></Emphasis><Filename>/dt/appconfig/types/</Filename><Emphasis>&lt;locale></Emphasis></Term>
<ListItem>
<Para>Contains application action and datatype files
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>&lt;application_root></Emphasis><Filename>/dt/appconfig/appmanager/</Filename><Emphasis>&lt;locale></Emphasis></Term>
<ListItem>
<Para>Contains application group files
<!--jcd: pending resolution of naming clash of "application group" vs. "folder"--></Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>&lt;application_root></Emphasis><Filename>/dt/appconfig/icons/</Filename><Emphasis>&lt;locale></Emphasis></Term>
<ListItem>
<Para>Contains application icons
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>&lt;application_root></Emphasis><Filename>/dt/appconfig/help/</Filename><Emphasis>&lt;locale></Emphasis></Term>
<ListItem>
<Para>Contains application help files
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>&minus;t&numsp;</Literal><Emphasis>target_path</Emphasis></Term>
<ListItem>
<Para>Link the application &str-XZ; configuration files to
<Emphasis>target_path</Emphasis> rather than to the default &str-XZ; system locations.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>&minus;l&numsp;</Literal><Symbol Role="Variable">locale</Symbol></Term>
<ListItem>
<Para>Integrate only the files found in the
<Symbol Role="Variable">locale</Symbol> subdirectories.
If this option is not specified, all of the application's &str-XZ;
configuration files are integrated.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>&minus;u</Literal></Term>
<ListItem>
<Para>Destroy the symbolic links previously created by
<Command>dtappintegrate.</Command> If
<Literal>&minus;l</Literal> is specified with the
<Literal>&minus;u</Literal> option, only the
symbolic links to the
&str-XZ; configuration files in the specified
<Symbol Role="Variable">locale</Symbol> subdirectories
are destroyed.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>&minus;?</Literal></Term>
<ListItem>
<Para>Write a help message to standard output that describes the command syntax of
<Command>dtappintegrate</Command> and exit.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>OPERANDS</Title>
<Para>None.
</Para>
</RefSect1>
<RefSect1>
<Title>STDIN</Title>
<Para>Not used.
</Para>
</RefSect1>
<RefSect1>
<Title>INPUT FILES</Title>
<Para>None.
</Para>
</RefSect1>
<RefSect1>
<Title>ENVIRONMENT VARIABLES</Title>
<Para>None.
</Para>
</RefSect1>
<RefSect1>
<Title>RESOURCES</Title>
<Para>None.
</Para>
</RefSect1>
<RefSect1>
<Title>ASYNCHRONOUS EVENTS</Title>
<![ %CDE.C.XO; [
<Para>Default.
</Para>
]]>
<![ %CDE.C.CDE; [
<Para>The
<Command>dtappintegrate</Command> utility takes the standard action for all signals.
</Para>
]]>
</RefSect1>
<RefSect1>
<Title>STDOUT</Title>
<Para>When no option or the
<Literal>&minus;?</Literal> option is used,
<Command>dtappintegrate</Command> writes to standard output a usage message.
</Para>
<Para>During execution,
<Command>dtappintegrate</Command> writes confirmation messages to standard output.
</Para>
</RefSect1>
<RefSect1>
<Title>STDERR</Title>
<Para>Used only for diagnostic messages.
</Para>
</RefSect1>
<RefSect1>
<Title>OUTPUT FILES</Title>
<Para>The
<Command>dtappintegrate</Command> utility
creates the symbolic links to the application's &str-XZ; configuration files.
<![ %CDE.C.CDE; [</Para>
<Para>During execution,
<Command>dtappintegrate</Command> writes to the text file,
<Filename>/tmp/dtappint.log</Filename>, output from the underlying
system commands it invokes.
]]></Para>
</RefSect1>
<RefSect1>
<Title>EXTENDED DESCRIPTION</Title>
<Para>None.
</Para>
</RefSect1>
<RefSect1>
<Title>EXIT STATUS</Title>
<Para>The following exit values are returned:
</Para>
<VariableList>
<VarListEntry>
<Term>0</Term>
<ListItem>
<Para>Successful completion.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>2</Term>
<ListItem>
<Para>Help message displayed.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>3</Term>
<ListItem>
<Para>Not invoked with
<![ %CDE.C.CDE; [root user authority.
]]><![ %CDE.C.XO; [appropriate privileges.
]]></Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>4</Term>
<ListItem>
<Para>Invalid option.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>CONSEQUENCE OF ERRORS</Title>
<Para>Default.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>None.
</Para>
</RefSect1>
<RefSect1>
<Title>EXAMPLES</Title>
<Para>None.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>None.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->

192
cde/doc/C/guides/man/man1_dt/builder.sgm Normal file
View File

@@ -0,0 +1,192 @@
<!-- $XConsortium: builder.sgm /main/12 1996/09/08 19:49:47 rws $ -->
<!-- (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.MAN2.rsml.1">
<refmeta><refentrytitle>dtbuilder</refentrytitle><manvolnum>user cmd</manvolnum>
</refmeta>
<refnamediv><refname><command>dtbuilder</command></refname><refpurpose>the
CDE Application Builder</refpurpose></refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>dtbuilder</command><arg choice="opt">projectfile</arg><arg choice="opt">&minus;useWC&numsp;<replaceable>class<?Pub Caret></replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>The <command>dtbuilder</command> utility is an interactive application
development tool and user interface management system for CDE. Known more
fully as the CDE Application Builder, <command>dtbuilder</command> is designed
to make it easier for developers to construct applications that integrate
well into the CDE. It provides two basic services - aid in assembling Motif
objects into the desired application user interface and generation of appropriate
calls to the routines that support CDE desktop services (e.g. ToolTalk, sessioning,
Help).</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry><term><literal>&minus;useWC&numsp;</literal><emphasis>class</emphasis></term>
<listitem>
<para>Use the specified widget class whenever possible. Valid values are:
</para>
<variablelist>
<varlistentry><term><symbol>dt</symbol></term>
<listitem>
<para>Generate <Symbol>DtComboBox</Symbol> and <Symbol>DtSpinBox</Symbol>
widgets. This value retains the CDE 1.0 behavior.</para>
</listitem>
</varlistentry>
<varlistentry><term><symbol>xm</symbol></term>
<listitem>
<para>Generate <Symbol>XmComboBox</Symbol> and <Symbol>XmSimpleSpinBox</Symbol> widgets. This value selects the Motif/Xm behavior.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>OPERANDS</title>
<para>The <command>dtbuilder</command> utility accepts an optional filename
operand that is interpreted as the name of an application project file that
should be loaded for editing. This file should be in the BIL format defined
for use by the Application Builder.</para>
<para>If no project file is specified, then <command>dtbuilder</command>
comes up "empty", ready for a new application to be developed interactively
by the user.</para>
</refsect1>
<refsect1>
<title>RESOURCES</title>
<para>If the <literal>&minus;useWC</literal> option is not specified, <command>dtbuilder</command> uses the <literal>useWidgetClass</literal> resource in
the Xt resources table to determine which class to use for generated widgets.
The class/type is <symbol>XmCUseWidgetClass</symbol>/<symbol>XtEnum</symbol> and the valid
values are:</para>
<variablelist>
<varlistentry><term><symbol>xm</symbol> (the default)</term>
<listitem>
<para>Generate <Symbol>XmComboBox</Symbol> and <Symbol>XmSimpleSpinBox</Symbol> widgets.
This value selects the Motif/Xm behavior.</para>
</listitem>
</varlistentry>
<varlistentry><term><symbol>dt</symbol></term>
<listitem>
<para>Generate <Symbol>DtComboBox</Symbol> and <Symbol>DtSpinBox</Symbol>
widgets.
This value retains the CDE 1.0 behavior.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>STDIN</title>
<para>Not used.</para>
</refsect1>
<refsect1>
<title>INPUT FILES</title>
<para>A project file to be processed by the
<command>dtbuilder</command> utility must to be in the BIL format defined
for the CDE Application
Builder.</para>
<para>Interactively, the Application Builder provides facilities for loading
additional project files, as well as application module files
(which also must be in the BIL format) and interface files that use
Motif's UIL format.</para>
</refsect1>
<refsect1>
<title>ENVIRONMENT VARIABLES</title>
<para>None.</para>
</refsect1>
<refsect1>
<title>ASYNCHRONOUS EVENTS</title>
<para>The
<command>dtbuilder</command> utility takes the standard action for all signals.
</para>
</refsect1>
<refsect1>
<title>STDOUT</title>
<para>Not used.</para>
</refsect1>
<refsect1>
<title>STDERR</title>
<para>Used only for diagnostic messages.</para>
</refsect1>
<refsect1>
<title>OUTPUT FILES</title>
<para>None by default.</para>
<para>Interactively, the Application Builder provides facilities for writing
("saving") application project and module files, both of which must be
in the BIL format, and also for writing ("exporting") interface files that
use
Motif's UIL format.</para>
</refsect1>
<refsect1>
<title>EXTENDED DESCRIPTION</title>
<para>None.</para>
</refsect1>
<refsect1>
<title>EXIT STATUS</title>
<para>The following exit values are returned:</para>
<variablelist>
<varlistentry><term>0</term>
<listitem>
<para>Normal termination.</para>
</listitem>
</varlistentry>
<varlistentry><term>1</term>
<listitem>
<para>Abnormal termination.
The
<command>dtbuilder</command> utility was unable to allocate necessary memory
or spawn the code generator.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>CONSEQUENCES OF ERRORS</title>
<para>Default.</para>
</refsect1>
<refsect1>
<title>APPLICATION USAGE</title>
<para>Because the
<command>dtbuilder</command> is a complex, highly-interactive tool, users
typically consider the command line interface as little more than the way
to start up the Application Builder.</para>
<para>CDE provides an "AppBuilder" action so the Application Builder can be
invoked through the standard action interface, including through
the Application Manager.</para>
</refsect1>
<refsect1>
<title>EXAMPLES</title>
<variablelist>
<varlistentry><term>dtbuilder</term>
<listitem>
<para>This runs the CDE Application Builder, presuming that the user will
either
be creating a new project or will load one interactively through the
Application Builder's "File" menu.</para>
</listitem>
</varlistentry>
<varlistentry><term>dtbuilder myproject.bip</term>
<listitem>
<!-- ex-TP-->
<para>Starts the CDE Application Builder and instructs it to load the project
defined in the file
<literal>myproject.bip</literal>.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>&cdeman.dtcodegen; &cdeman.BIL;</para>
</refsect1>
</refentry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->
<?Pub *0000007534>

198
cde/doc/C/guides/man/man1_dt/calc.sgm Normal file
View File

@@ -0,0 +1,198 @@
<!-- $XConsortium: calc.sgm /main/6 1996/09/08 19:50:01 rws $ -->
<!-- (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.MAN3.rsml.1">
<refmeta><refentrytitle>dtcalc</refentrytitle><manvolnum>user cmd</manvolnum>
</refmeta>
<refnamediv><refname><command>dtcalc</command></refname><refpurpose>The CDE
Calculator</refpurpose></refnamediv>
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- ** (c) Copyright 1987, 1988, 1989, 1993, 1994 Hewlett-Packard Company-->
<!-- ** (c) Copyright 1993, 1994 International Business Machines Corp.-->
<!-- ** (c) Copyright 1993, 1994 Sun Microsystems, Inc.-->
<!-- ** (c) Copyright 1993, 1994 Novell, Inc.-->
<refsynopsisdiv>
<cmdsynopsis>
<command>dtcalc</command><arg choice="opt">-a accuracy</arg><arg choice="opt">-m mode</arg><arg choice="opt">-b numeric_base</arg><arg choice="opt">-notation
display_notation</arg><arg choice="opt">-trig trigonometric_type</arg><arg
choice="opt">-no_menu_bar</arg><arg choice="opt">-session session_file</arg>
<arg choice="opt">-?</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>The <command>dtcalc</command> utility is a calculator for use within
the CDE. It provides an easy-to-use interface designed to give access to common
arithmetic and financial calculations.</para>
<para>The calculator is designed to operate in much the same way as many
hand-held calculators. It provides three modes of operation: scientific, financial,
and logical. The default operation is scientific, but with the easy-to-use
GUI, changing to the modes of operation is easy. When the operation mode is
changed, a number of the keys change for the new operations.</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<para>The <command>dtcalc</command> utility defines a number of command-line
options that allow the user to configure how the calculator displays itself.
Command-line options have a higher precedence than resources. By using command-line
options a user can override anything specified in a resource file.</para>
<variablelist>
<varlistentry><term><literal>-a</literal> <emphasis>&lt;accuracy></emphasis></term>
<listitem>
<para>This is the initial number of digits displayed after the numeric point.
This value must be in the range 0 to 9. The default value is 2.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>-m</literal> <emphasis>&lt;mode></emphasis></term>
<listitem>
<para>This determines which mode the calculator will display itself in. The
possible values for &lt;<symbol role="Variable">mode</symbol>> are: scientific,
financial, or logical. Scientific is the default mode. Some of the calculator
keys change operations when the calculator's mode is changed.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>-b</literal> <emphasis>&lt;numeric_base></emphasis></term>
<listitem>
<para>This determines which numeric base the calculator will use when it does
calculations. There are four bases the calculator supports: binary (base 2),
octal (base 8), decimal (base 10), or hexadecimal (base 16). The possible
values for &lt;<emphasis>numeric_base</emphasis>> are: binary, octal, decimal,
or hexadecimal. The default is decimal.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>-notation</literal> <emphasis>&lt;display_notation></emphasis></term>
<listitem>
<para>This determines how the answers are to be displayed on the calculator.
The possible values for &lt;<emphasis>display_notation</emphasis>> are: scientific,
engineering, or fixed. The default is fixed.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>-trig</literal> <emphasis>&lt;trigonometric_type></emphasis></term>
<listitem>
<para>This determines how answers are presented when the calculator is in
scientific mode. The possible values for &lt;<emphasis>trigonometric_type</emphasis> > are: degrees, radians, or gradients. The default is degrees.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>-no_menu_bar</literal></term>
<listitem>
<para>This option makes the calculator come up with no menubar.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>-session</literal> <emphasis>&lt;session_file></emphasis></term>
<listitem>
<para>The dtcalc utility runs with the session file specified in the <emphasis>session_file</emphasis> parameter. Session files are generated as a dtcalc
session shuts down.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>-?</literal></term>
<listitem>
<para>This prints out the usage message.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>RESOURCES</title>
<para>The calculator supports a number of resources which make it much more
configurable. Following is the list of supported resources and their default
values.</para>
<refsect2>
<title>Client Resource Set</title>
<informaltable remap="center" orient="port">
<tgroup cols="4" colsep="0" rowsep="0">
<colspec align="left" colwidth="113*">
<colspec align="left" colwidth="115*">
<colspec align="left" colwidth="76*">
<colspec align="left" colwidth="152*">
<tbody>
<row>
<entry align="left" valign="top">Name</entry>
<entry align="left" valign="top">Class</entry>
<entry align="left" valign="top">Type</entry>
<entry align="left" valign="top">Default</entry></row>
<row>
<entry align="left" valign="top">postMenuBar</entry>
<entry align="left" valign="top">PostMenuBar</entry>
<entry align="left" valign="top">Boolean</entry>
<entry align="left" valign="top">True</entry></row>
<row>
<entry align="left" valign="top">accuracy</entry>
<entry align="left" valign="top">Accuracy</entry>
<entry align="left" valign="top">int</entry>
<entry align="left" valign="top">2</entry></row>
<row>
<entry align="left" valign="top">base</entry>
<entry align="left" valign="top">Base</entry>
<entry align="left" valign="top">string</entry>
<entry align="left" valign="top">decimal</entry></row>
<row>
<entry align="left" valign="top">displayNotation</entry>
<entry align="left" valign="top">DisplayNotation</entry>
<entry align="left" valign="top">string</entry>
<entry align="left" valign="top">fixed</entry></row>
<row>
<entry align="left" valign="top">mode</entry>
<entry align="left" valign="top">Mode</entry>
<entry align="left" valign="top">string</entry>
<entry align="left" valign="top">scientific</entry></row>
<row>
<entry align="left" valign="top">trigType</entry>
<entry align="left" valign="top">TrigType</entry>
<entry align="left" valign="top">string</entry>
<entry align="left" valign="top">degrees</entry></row></tbody></tgroup></informaltable>
<variablelist>
<varlistentry><term><literal>Dtcalc*postMenuBar:</literal></term>
<listitem>
<para>Specifies whether the menu bar should appear or not.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>Dtcalc*accuracy:</literal></term>
<listitem>
<para>Specifies whether the menu bar should appear or not.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>Dtcalc*base:</literal></term>
<listitem>
<para>This resource allows the user to change the default for the numeric
base the calculator uses when it does its calculations. The default is "decimal"
which is base 10. Possible values are: <literal>binary</literal> (or <literal>bin</literal>): do calculations in base 2. <literal>octal</literal> (or <literal>oct</literal>): do calculations in base 8. <literal>decimal</literal> (or <literal>dec</literal>): do calculations in base 10. <literal>hexadecimal</literal>
(or <literal>hex</literal>): do calculations in base 16.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>Dtcalc*display:</literal></term>
<listitem>
<para>This resource allows the user to change the default for the way answers
are displayed on the calculator. The default is "fixed". Possible values are: <literal>fixed</literal> (or <literal>fix</literal>): display in fixed mode. <literal>scientific</literal> (or <literal>sci</literal>): display in scientific mode. <literal>engineering</literal> (or <literal>eng</literal>): display in engineering
mode.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<refsect1>
<title>FILES</title>
<variablelist>
<varlistentry><term><Filename>/usr/dt/bin/dtcalc</Filename></term>
<listitem>
<para>This is the executable for the CDE Calculator.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>/usr/dt/app-defaults/&lt;LANG>/Dtcalc</literal></term>
<listitem>
<para>This file includes the application defaults for the CDE Calculator.
</para>
</listitem>
</varlistentry>
</variablelist>
<para></para>
</refsect1>
</refentry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->
<?Pub Caret>
<?Pub *0000037604>

46
cde/doc/C/guides/man/man1_dt/chooser.sgm Normal file
View File

@@ -0,0 +1,46 @@
<!-- $XConsortium: chooser.sgm /main/6 1996/08/31 14:49:27 rws $ -->
<!-- (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.MAN4.rsml.1" Remap="">
<RefMeta>
<RefEntryTitle>dtchooser</RefEntryTitle>
<ManVolNum>user cmd</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Command>dtchooser</Command></RefName>
<RefPurpose>CDE dtlogin chooser screen display utility
</RefPurpose>
</RefNameDiv>
<!--- -->
<!-- (c) Copyright 1993, 1994 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994 Novell, Inc.-->
<!--- -->
<RefSynopsisDiv>
<CmdSynopsis>
<Command>dtchooser</Command>
</CmdSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The CDE dtchooser utility is used by
<Command>dtlogin</Command> to display the host chooser screen on a display when an
<Symbol>XDMCP</Symbol> <Literal>indirect</Literal> request is received. The user can select a host from the
list presented, and
<Command>dtlogin</Command> on that host will display a login screen on the display. There will be one
<Command>dtchooser</Command> process per display on which a chooser screen is visible.
</Para>
<Para>All customization of the chooser screen is done via
<Command>dtlogin</Command> configuration files. Refer to the
&cdeman.dtlogin; man page for information regarding chooser screen customization.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->

417
cde/doc/C/guides/man/man1_dt/cm.sgm Normal file
View File

@@ -0,0 +1,417 @@
<!-- $XConsortium: cm.sgm /main/11 1996/09/08 19:50:10 rws $ -->
<!-- (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.MAN5.rsml.1">
<refmeta><refentrytitle>dtcm</refentrytitle><manvolnum>user cmd</manvolnum>
</refmeta>
<refnamediv><refname><command>dtcm</command></refname><refpurpose>The CDE
Calendar Manager.</refpurpose></refnamediv>
<!-- (c) Copyright 1993, 1994 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994 Novell, Inc.-->
<!-- t-->
<refsynopsisdiv>
<cmdsynopsis>
<command>dtcm</command><arg choice="opt">-v<replaceable>view</replaceable></arg>
<arg choice="opt">-c<replaceable>calendar</replaceable></arg><arg choice="opt">-p<replaceable>printer</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para><command>dtcm</command> is the CDE appointment and resource scheduling
tool. Use it to:</para>
<!--Start of RS / RE range-->
<para>- Display day, week, month, and year views of your calendar</para>
<para>- Schedule single or repeating calendar entries</para>
<para>- Browse and edit another user's calendar</para>
<para>- Schedule reminders to give you notice of events</para>
<para>- Restrict access to your calendar</para>
<para>- Print high-quality hardcopy</para>
<para>- View and Schedule entries for a group of calendars</para>
<para>- Change the time zone context</para>
<para>- Announce appointments via electronic mail</para>
<para>- Schedule appointments received in electronic mail</para>
<!--End of RS / RE range-->
</refsect1>
<refsect1>
<title>OPTIONS</title>
<para><command>dtcm</command> accepts all of the standard X Toolkit command
line options as well as the following:</para>
<variablelist>
<varlistentry><term>-c calendar</term>
<listitem>
<para>Specifies the calendar to display. The default value is equivalent
to $USER@$HOST.</para>
</listitem>
</varlistentry>
<varlistentry><term>-p printer</term>
<listitem>
<para>Specifies the default printer. The default is the system's default
printer.</para>
</listitem>
</varlistentry>
<varlistentry><term>-v view</term>
<listitem>
<para>Specifies the initial view. Values can be "day", "week", "month" or
"year".</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>CONCEPTS</title>
<para>A <emphasis>calendar</emphasis> is a persistent entity existing somewhere
on the network, which contains scheduling data for a <emphasis>user</emphasis>.
A <emphasis>calendar entry</emphasis> is an event recorded within the context
of a calendar. Calendar entries supported by dtcm are <emphasis>appointment</emphasis> and <emphasis>to-do</emphasis>. Calendar entries can be <emphasis>single</emphasis>, or <emphasis>repeat</emphasis> entries. A calendar entry
may have one or more <emphasis>reminders</emphasis> associated with it. A
reminder causes dtcm to notify you by issuing an <emphasis>alarm</emphasis>
when the system time enters your specified <emphasis>reminder notice period</emphasis> before the event. When viewing your calendar, you have the notion
of the <emphasis>current date</emphasis>, which is the date you last selected
by selecting the Day View, or by clicking in any of the other views. The
current date does not change until you select another date, even if you have
navigated out of a view that would contain the current date.</para>
<para>dtcm presents a <emphasis>network calendar model</emphasis>. To operate
on a calendar belonging to some user on the network, dtcm establishes a session
with a <emphasis>calendar server</emphasis>. The calendar server is (conceptually
at least) a separate process running on the host where the calendar is located.
It manages all the calendars for the host on which it is running, and can
service multiple connected applications simultaneously. The calendar server
responds to authentication, session control and calendar transactions initiated
by dtcm. In addition dtcm responds to events occurring at the server, such
as updates caused by other connected applications instances.</para>
</refsect1>
<refsect1>
<title>USAGE</title>
<para>dtcm has a single main window, containing a graphical calendar. You
can choose to view day, week, month or year in the main window. Navigating
between the views is achieved by selecting the view from the <emphasis>View</emphasis> menu, or by clicking one of the navigation buttons displayed in
the current view.</para>
<para><literal>Menu</literal> <literal>Bar</literal></para>
<para><literal>File</literal> <literal>Menu</literal></para>
<variablelist>
<varlistentry><term>Print Current View</term>
<listitem>
<para>Prints hard-copy based on the currently displayed calendar view.</para>
</listitem>
</varlistentry>
<varlistentry><term>Print...</term>
<listitem>
<para>Brings up a Print Setup window that allows you to select the report
type to use for the currently selected view, as well as various printing
options. You can specify a from/to date range, the printer name, and the
number of copies. You can set other more generic options, such as margins
and footers, by clicking on the <literal>More...</literal> button.</para>
</listitem>
</varlistentry>
<varlistentry><term>Options...</term>
<listitem>
<para>Brings up default options for all of dtcm's global attributes.</para>
</listitem>
</varlistentry>
<varlistentry><term>Exit</term>
<listitem>
<para>Terminates the dtcm application.</para>
</listitem>
</varlistentry>
</variablelist>
<para><symbol role="Message">Edit</symbol> <literal>Menu</literal></para>
<variablelist>
<varlistentry><term>Appointment...</term>
<listitem>
<!-- ex-TP-->
<para>Brings up the appointment editor, described below.</para>
</listitem>
</varlistentry>
<varlistentry><term>ToDo...</term>
<listitem>
<!-- ex-TP-->
<para>Brings up the to-do editor, described below.</para>
</listitem>
</varlistentry>
<varlistentry><term>Properties...</term>
<listitem>
<!-- ex-TP-->
<para>Brings up the properties dialog for appointments and to-do entries.
This item is for properties of calendar data entities. For properties of
the dtcm application, use the <emphasis>Properties...</emphasis> entry in
the <emphasis>File</emphasis> menu.</para>
</listitem>
</varlistentry>
</variablelist>
<para><literal>View</literal> <literal>Menu</literal></para>
<variablelist>
<varlistentry><term>Day</term>
<listitem>
<!-- ex-TP-->
<para>Changes the current view in the main window to Day View.</para>
</listitem>
</varlistentry>
<varlistentry><term>Week</term>
<listitem>
<!-- ex-TP-->
<para>Changes the current view in the main window to Week View.</para>
</listitem>
</varlistentry>
<varlistentry><term>Month</term>
<listitem>
<!-- ex-TP-->
<para>Changes the current view in the main window to Month View.</para>
</listitem>
</varlistentry>
<varlistentry><term>Year</term>
<listitem>
<!-- ex-TP-->
<para>Changes the current view in the main window to Year View.</para>
</listitem>
</varlistentry>
<varlistentry><term>Appointment List...</term>
<listitem>
<!-- ex-TP-->
<para>Brings up the <emphasis>Appointment List</emphasis> dialog.</para>
</listitem>
</varlistentry>
<varlistentry><term>ToDo List...</term>
<listitem>
<!-- ex-TP-->
<para>Brings up the <emphasis>ToDo List</emphasis> dialog.</para>
</listitem>
</varlistentry>
<varlistentry><term>Find...</term>
<listitem>
<!-- ex-TP-->
<para>Brings up the <emphasis>Find</emphasis> dislog, which you can use to
locate calendar entries by specifying some search criteria.</para>
</listitem>
</varlistentry>
<varlistentry><term>Go to Date...</term>
<listitem>
<!-- ex-TP-->
<para>Brings up the <emphasis>Go to Date</emphasis> dialog, which allows you
to change the view to a specified date. This is a convenient way to get to
dates that are distant from the current date.</para>
</listitem>
</varlistentry>
</variablelist>
<para><literal>Browse</literal> <literal>Menu</literal></para>
<variablelist>
<varlistentry><term>Show Other Calendar...</term>
<listitem>
<!-- ex-TP-->
<para>Brings up a dialog to let you connect to a different calendar than the
one currently displayed, in the main window. You will still be displaying
a single calendar.</para>
</listitem>
</varlistentry>
<varlistentry><term>Compare Calendars...</term>
<listitem>
<!-- ex-TP-->
<para>Brings up the <emphasis>Compare Calendars</emphasis> dialog, described
below.</para>
</listitem>
</varlistentry>
<varlistentry><term>Menu Editor...</term>
<listitem>
<!-- ex-TP-->
<para>Brings up a dialog that allows you to add frequently used calendars
to the <emphasis>Browse</emphasis> menu for this and future sessions with
dtcm.</para>
</listitem>
</varlistentry>
<varlistentry><term>&lt;user>@&lt;host></term>
<listitem>
<para></para>
<!-- ex-TP-->
</listitem>
</varlistentry>
<varlistentry><term>...</term>
<listitem>
<!-- ex-TP-->
<para>This sequence of entries consists of your own calendar, followed by
an optional list of calendars that you can add to the menu using the <emphasis>Menu Editor...</emphasis> option described above. Your own calendar always
appears first. The other options are listed in alphabetical order.</para>
</listitem>
</varlistentry>
</variablelist>
<para><literal>Secondary</literal> <literal>Windows</literal></para>
<para>In addition to the main window, dtcm has several secondary windows,
which give you access to the scheduling and browsing features of dtcm.</para>
<para>The <emphasis>Appointment Editor</emphasis> allows scheduling of appointments.
An appointment is the most common type of calendar entry. It is useful for
scheduling time-slots in your calendar, and can be exported to other users
either by direct entry to their calendars, or through electronic mail. To
invoke the appointment editor, select it from the <emphasis>Schedule</emphasis>
menu in the main window, or double-click anywhere in the graphical calendar
view.</para>
<para>The <emphasis>To Do Editor</emphasis> allows you to maintain a list
of to-do items for your personal use. To-do entries are not visible to other
dtcm users who are browsing your calendar; they are private to you. To-do
entries differ from appointments in that they do not necessarily appear as
scheduled events in your calendar views. If they have a <emphasis>Due Date</emphasis> associated with them, you will see that on your calendar view.
The main purpose of to-do entries is to allow you to maintain a list of work
items, without necessarily allocating calendar time for them. Invoke the
to-do editor from by selecting it form the <emphasis>Schedule</emphasis> menu
in the main window.</para>
<para>The <emphasis>Group Appointment Editor</emphasis> allows you to schedule
an appointment on multiple calendars at once. Invoke the group appointment
editor by clicking <emphasis>Schedule</emphasis> in the <emphasis>Compare
Calendars</emphasis> window. You may optionally announce the appointment
over electronic mail.</para>
<para>The <emphasis>Compare Calendars</emphasis> window allows you to connect
to several calendars simultaneously, and get a graphical overview of busy
and available time in the resultant "virtual calendar". Invoke the compare
calendars window by selecting it from the <emphasis>Browse</emphasis> menu
in the main window.</para>
<para>The <emphasis>Print Setup Box</emphasis> window allows you to select
the report type to use for the currently selected view. In addition to selecting
the view information, you can set a number of generic and printer-specific
printing options. For example, you can send the output to a file or a printer.
In the case of printed output, you can specify how many copies you want.
You can also access another window to set options specific to the printer/spooler
you are using. For example, you can select paper size, one- or two-sided
printing, and email notification on completion of the print job.</para>
<para>The <emphasis>Options</emphasis> window, accessible from the <emphasis>File</emphasis> menu, gives you access to the dtcm options that you can configure.
There are several categories of options: Editor Defaults; Display Settings;
Access List and Permissions; Printer Settings; Date Format. Set the options
to suit your requirements, and save them by clicking <emphasis>Apply</emphasis>.
</para>
</refsect1>
<refsect1>
<title>RESOURCES</title>
<para>dtcm supports a number of application resources to allow you to configure
its behaviour. The application class name for dtcm is <emphasis>Dtcm</emphasis>. To set application resources, you can copy the system default
version of this file from /usr/dt/app-defaults/&lt;LANG>/Dtcm to a personal
version, typically ~/app-defaults/Dtcm, and edit it with your changes.
Following is the list of supported resources and their default values.</para>
<informaltable remap="center" orient="port">
<tgroup cols="4" colsep="0" rowsep="0">
<colspec align="left" colname="col1" colwidth="121*">
<colspec align="left" colname="col2" colwidth="120*">
<colspec align="left" colwidth="106*">
<colspec align="left" colwidth="109*">
<spanspec nameend="col2" namest="col1" spanname="1to2">
<tbody>
<row>
<entry align="left" spanname="1to2" valign="top"><literal>Application Resources</literal></entry></row>
<row>
<entry align="left" valign="top">Name</entry>
<entry align="left" valign="top">Class</entry>
<entry align="left" valign="top">Type</entry>
<entry align="left" valign="top">Default</entry></row>
<row>
<entry align="left" valign="top">labelFont</entry>
<entry align="left" valign="top">LabelFont</entry>
<entry align="left" valign="top">XmRFontList</entry>
<entry align="left" valign="top">(varies)</entry>
</row>
<row>
<entry align="left" valign="top">viewFont</entry>
<entry align="left" valign="top">ViewFont</entry>
<entry align="left" valign="top">XmRFontList</entry>
<entry align="left" valign="top">(varies)</entry>
</row>
<row>
<entry align="left" valign="top">bold Font</entry>
<entry align="left" valign="top">BoldFont</entry>
<entry align="left" valign="top">XmRFontList</entry>
<entry align="left" valign="top">(varies)</entry>
</row>
<row>
<entry align="left" valign="top">iconFont</entry>
<entry align="left" valign="top">IconFont</entry>
<entry align="left" valign="top">XmRFontList</entry>
<entry align="left" valign="top">-dt-application-bold-r-normal-sans</entry>
</row>
<row>
<entry align="left" valign="top">applicationFontFamily</entry>
<entry align="left" valign="top">ApplicationFontFamily</entry>
<entry align="left" valign="top">XmRXmString</entry>
<entry align="left" valign="top">application</entry>
</row>
</tbody></tgroup></informaltable>
<variablelist>
<varlistentry>
<term>dtcm*labelFont</term>
<listitem>
<para>Specifies the font to use for the labels in the calendar's views.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>dtcm*viewFont</term>
<listitem>
<para>Specifies the font to use for the text of the appointments in the calendar's views.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>dtcm*boldFont</term>
<listitem>
<para>Specifies the font to use for the time ranges in the week view.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>dtcm*iconFont</term>
<listitem>
<para>Specifies the icon font.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>dtcm*applicationFontFamily</term>
<listitem>
<para>Specifies the font family name to use for the text of the appointments in
the calendar's views. A font is used with this family name and an appropriate
size to match the system font size chosen via
<literal>dtstyle</literal>.
<Systemitem class="resource">dtcm*viewFont</systemitem>
and
<Systemitem class="resource">dtcm*boldFont</systemitem>
have a higher precedent than
<Systemitem class="resource">dtcm*applicationFontFamily</systemitem>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>FILES</title>
<variablelist>
<varlistentry><term>/usr/dt/bin/dtcm</term>
<listitem>
<!-- ex-TP-->
<para>This is the executable for dtcm.</para>
</listitem>
</varlistentry>
<varlistentry><term>/usr/dt/app-defaults/&lt;LANG>/Dtcm</term>
<listitem>
<!-- ex-TP-->
<para>This is the system-default application defaults file for dtcm.</para>
</listitem>
</varlistentry>
<varlistentry><term>/usr/dt/bin/rpc/cmsd</term>
<listitem>
<!-- ex-TP-->
<para>This is the calendar daemon (server) that manages calendars on a machine.
</para>
</listitem>
</varlistentry>
<varlistentry><term>/var/spool/calendar/callog.&lt;user></term>
<listitem>
<!-- ex-TP-->
<para>This is the persistent calendar database for a user on this machine.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
</refentry>
<!--fickle 1.12 mancsf-to-docbook 1.3 08/21/95 21:30:04-->
<?Pub *0000016276>

368
cde/doc/C/guides/man/man1_dt/cm_delet.sgm Normal file
View File

@@ -0,0 +1,368 @@
<!-- $XConsortium: cm_delet.sgm /main/10 1996/09/08 19:50:22 rws $ -->
<!-- (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. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN2.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN2.rsml.1">]]>
<RefMeta>
<RefEntryTitle>dtcm_delete</RefEntryTitle>
<ManVolNum>user cmd</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Command>dtcm_delete</Command></RefName>
<RefPurpose>delete appointments from the calendar database
</RefPurpose>
</RefNameDiv>
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<CmdSynopsis>
<Command>dtcm_delete</Command>
<Arg Choice="opt">&minus;c&numsp;<Replaceable>calendar</Replaceable></Arg>
<Arg Choice="opt">&minus;d&numsp;<Replaceable>date</Replaceable></Arg>
<Arg Choice="opt">&minus;v&numsp;<Replaceable>view</Replaceable></Arg>
</CmdSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Command>dtcm_delete</Command> utility is non-GUI interface to the &str-XZ; calendar and appointment services,
used to delete appointments from the calendar
<![ %CDE.C.CDE; [database via the RPC daemon
&cdeman.rpc.cmsd;. ]]><![ %CDE.C.XO; [database.
]]>Appointments are deleted one at a time.
Each of the components of an
appointment is specified using one of the command-line options.
The current list of appointments for the specified date
(see the
<Literal>&minus;d</Literal> and
<Literal>&minus;v</Literal> options) is displayed,
numbered sequentially starting with 1.
The user is prompted for the number to delete.
Once an appointment
is deleted, the list of remaining appointments is redisplayed.
At this point
the user can specify another number, or just
<KeySym>carriage-return</KeySym> to quit.
</Para>
</RefSect1>
<RefSect1>
<Title>OPTIONS</Title>
<![ %CDE.C.XO; [
<Para>The
<Command>dtcm_delete</Command> utility supports the &str-Zu;.
</Para>
]]>
<Para>The following options are available:
</Para>
<VariableList>
<VarListEntry>
<Term><Literal>&minus;c&numsp;</Literal><Emphasis>calendar</Emphasis></Term>
<ListItem>
<Para>Specify the name of the target calendar.
Calendar names
<![ %CDE.C.XO; [are implementation-dependent, but
]]>typically take the form
<Emphasis>user</Emphasis>@ <Emphasis>hostname</Emphasis>, where
<Emphasis>user</Emphasis> is a user's login name and
<Emphasis>hostname</Emphasis> is the host machine name.
<![ %CDE.C.CDE; [An example is
<Literal>felix@cat</Literal>. ]]>If no target calendar is specified,
the calendar defaults to
the current user at the current host machine.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>&minus;d&numsp;</Literal><Emphasis>date</Emphasis></Term>
<ListItem>
<Para>Specify the date for the appointment(s) to be deleted.
The
<Emphasis>date</Emphasis> is specified using the form
<Symbol Role="Variable">mm</Symbol>/ <Emphasis>dd</Emphasis>/ <Emphasis>yy</Emphasis>, where
<Symbol Role="Variable">mm</Symbol>, <Emphasis>dd</Emphasis> and
<Emphasis>yy</Emphasis> are the two-digit month, day and year modulo 100, respectively.
<![ %CDE.C.CDE; [Certain other references such as
``today,'' ``Tuesday,'' ``tomorrow,'' etc.
are correctly calculated.
]]>If no date is specified,
<Emphasis>date</Emphasis> defaults to today's date.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>&minus;v&numsp;</Literal><Emphasis>view</Emphasis></Term>
<ListItem>
<Para>Specify the view span of appointments to display.
The
<Emphasis>view</Emphasis> option-argument can be:
</Para>
<VariableList>
<VarListEntry>
<Term><Literal>day</Literal></Term>
<ListItem>
<Para>Display all appointments for the given date (see
<Literal>&minus;d</Literal> option).
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>week</Literal></Term>
<ListItem>
<Para>Display the full week that contains the given date,
starting with Sunday.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>month</Literal></Term>
<ListItem>
<Para>Display the entire month that contains the given date.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>OPERANDS</Title>
<Para>None.
</Para>
</RefSect1>
<RefSect1>
<Title>STDIN</Title>
<Para>The standard input is used to receive user
replies to the list of appointments to be deleted.
</Para>
</RefSect1>
<RefSect1>
<Title>INPUT FILES</Title>
<Para>None.
</Para>
</RefSect1>
<RefSect1>
<Title>ENVIRONMENT VARIABLES</Title>
<Para>The following environment variables affect the execution of
<Command>dtcm_delete</Command>:</Para>
<VariableList>
<VarListEntry>
<Term><SystemItem Class="EnvironVar">LANG</SystemItem></Term>
<ListItem>
<Para>Provide a default value for the internationalization variables
that are unset or null.
If
<SystemItem Class="EnvironVar">LANG</SystemItem> is unset or null, the corresponding value from the
implementation-specific default locale will be used.
If any of the internationalization variables contains an invalid setting, the
utility behaves as if none of the variables had been defined.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>LC_ALL</Emphasis></Term>
<ListItem>
<Para>If set to a non-empty string value,
override the values of all the other internationalization variables.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>LC_MESSAGES</Emphasis></Term>
<ListItem>
<Para>Determine the locale that is used to affect
the format and contents of diagnostic
messages written to standard error
and informative messages written to standard output.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="EnvironVar">NLSPATH</SystemItem></Term>
<ListItem>
<Para>Determine the location of message catalogues
for the processing of
<Emphasis>LC_MESSAGES</Emphasis>.</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RESOURCES</Title>
<Para>None.
</Para>
</RefSect1>
<RefSect1>
<Title>ASYNCHRONOUS EVENTS</Title>
<![ %CDE.C.XO; [
<Para>Default.
</Para>
]]>
<![ %CDE.C.CDE; [
<Para>The
<Command>dtcm_delete</Command> utility takes the standard action for all signals.
</Para>
]]>
</RefSect1>
<RefSect1>
<Title>STDOUT</Title>
<Para>The standard output contains the list of appointments to be
<![ %CDE.C.CDE; [deleted.
]]><![ %CDE.C.XO; [deleted, in an unspecified format.
]]></Para>
</RefSect1>
<RefSect1>
<Title>STDERR</Title>
<Para>Used only for diagnostic messages.
</Para>
</RefSect1>
<RefSect1>
<Title>OUTPUT FILES</Title>
<Para>None.
</Para>
</RefSect1>
<RefSect1>
<Title>EXTENDED DESCRIPTION</Title>
<Para>None.
</Para>
</RefSect1>
<RefSect1>
<Title>EXIT STATUS</Title>
<Para>The following exit values are returned:
</Para>
<VariableList>
<VarListEntry>
<Term>0</Term>
<ListItem>
<Para>Successful completion.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>>0</Term>
<ListItem>
<Para>An error occurred.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>CONSEQUENCES OF ERRORS</Title>
<Para>Default.
</Para></RefSect1>
<![ %CDE.C.CDE; [<RefSect1>
<Title>FILES</Title>
<Para><Filename>/usr/spool/calendar/callog.username</Filename>,
<Filename>/usr/dt/bin/rpc.cmsd</Filename></Para>
</RefSect1>]]>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>None.
</Para>
</RefSect1>
<RefSect1>
<Title>EXAMPLES</Title>
<![ %CDE.C.XO; [
<Para>None.
</Para>
]]>
<![ %CDE.C.CDE; [
<Para>The simplest form of
<Command>dtcm_delete</Command> has no arguments:
</Para>
<InformalExample Remap="indent">
<ProgramListing>dtcm_delete
Appointments for Tuesday September 25, 1990:
1) Appointment
2) 10:30am-10:45am Morning Tea
3) 2:00pm-3:00pm Staff meeting
4) 4:30pm-5:30pm Phone home
Item to delete (number)? 2
Appointments for Tuesday September 25, 1990:
1) Appointment
2) 2:00pm-3:00pm Staff meeting
3) 4:30pm-5:30pm Phone home
Item to delete (number)?
</ProgramListing>
</InformalExample>
<Para>To delete at a specific date:
</Para>
<InformalExample Remap="indent">
<ProgramListing>dtcm_delete &minus;d 09/26/90
Appointments for Wednesday September 26, 1990:
1) 11:00am-12:00pm Appointment
2) 11:30am-12:30pm Group Lunch
3) 4:00pm-5:00pm Tech Interview
Item to delete (number)? 1
Appointments for Wednesday September 26, 1990:
1) 11:30am-12:30pm Group Lunch
2) 4:00pm-5:00pm Tech Interview
Item to delete (number)?
</ProgramListing>
</InformalExample>
<Para>To delete from a specific target calendar:
</Para>
<InformalExample Remap="indent">
<ProgramListing>dtcm_delete &minus;c felix@cat
Appointments for Tuesday September 25, 1990:
1) Appointment
2) 10:15am-10:30am Coffee
3) 11:15am-11:30am Doughnuts
4) 2:00pm-2:15pm Coffee
5) 3:30pm-3:45pm Snack
6) 4:30pm-4:45pm Coffee
Item to delete (number)? 5
Appointments for Tuesday September 25, 1990:
1) Appointment
2) 10:15am-10:30am Coffee
3) 11:15am-11:30am Doughnuts
4) 2:00pm-2:15pm Coffee
5) 4:30pm-4:45pm Coffee
Item to delete (number)?
</ProgramListing>
</InformalExample>
<Para>To delete multiple appointments:
</Para>
<InformalExample Remap="indent">
<ProgramListing>dtcm_delete
Appointments for Tuesday September 25, 1990:
1) Appointment
2) 10:15am-10:30am Coffee
3) 11:15am-11:30am Doughnuts
4) 2:00pm-2:15pm Coffee
5) 3:30pm-3:45pm Snack
6) 4:30pm-4:45pm Coffee
Item to delete (number)? 5
Appointments for Tuesday September 25, 1990:
1) Appointment
2) 10:15am-10:30am Coffee
3) 11:15am-11:30am Doughnuts
4) 2:00pm-2:15pm Coffee
5) 4:30pm-4:45pm Coffee
Item to delete (number)? 3
Appointments for Tuesday September 25, 1990:
1) Appointment
2) 10:15am-10:30am Coffee
3) 2:00pm-2:15pm Coffee
4) 4:30pm-4:45pm Coffee
Item to delete (number)?
</ProgramListing>
</InformalExample>
]]>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para><![ %CDE.C.CDE; [&cdeman.rpc.cmsd;, &cdeman.dtcm;, ]]>&cdeman.dtcm.insert;, &cdeman.dtcm.lookup;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->

87
cde/doc/C/guides/man/man1_dt/cm_edito.sgm Normal file
View File

@@ -0,0 +1,87 @@
<!-- $XConsortium: cm_edito.sgm /main/6 1996/11/15 15:26:18 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.MAN6.rsml.1">
<RefMeta>
<RefEntryTitle>dtcm_editor</RefEntryTitle>
<ManVolNum>user cmd</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Command>dtcm_editor</Command></RefName>
<RefPurpose>The CDE Environment standalone appointment editor
</RefPurpose>
</RefNameDiv>
<!--- -->
<!-- (c) Copyright 1993, 1994 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994 Novell, Inc.-->
<!--- -->
<!-- t-->
<RefSynopsisDiv>
<CmdSynopsis>
<Command>dtcm_editor</Command>
<Arg Choice="opt">filename</Arg>
</CmdSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The <Command>dtcm_editor</Command> program a stand alone editor for files that
represent <Command>dtcm</Command> appointments. These files are created by either
mailing appointments from within <Command>dtcm</Command>, or by dragging and dropping
appointments from a <Command>dtcm</Command> editor dialog into some kind of
permanent store (a <Command>dtmail</Command> attachment pane, or <Command>dtfile</Command>).
The <Command>dtcm_editor</Command> allows modifying these appointment files,
and writing them back out.
</Para>
</RefSect1>
<RefSect1>
<Title>OPTIONS</Title>
<Para>The only available option is to start the <Command>dtcm_editor</Command> with
a filename. This will cause the editor to operate on that file,
and write out to that file. If the <Command>dtcm_editor</Command> is started
without a file name, it is assumed to have been invoked thru
tooltalk, and acts as a media alliance editor.
</Para>
</RefSect1>
<RefSect1>
<Title>RESOURCES</Title>
<Para><Command>dtcm_editor</Command> supports a number of application resources to
allow you to configure
its behaviour. The application class name for <Command>dtcm_editor</Command>
is <classname>Dtcm</classname>.
To set application resources, you can copy the system default version of
this file from <filename>/usr/dt/app-defaults/&lt;LANG>/Dtcm</filename> to a personal version,
typically <filename>~/app-defaults/Dtcm</filename>, and edit it with your changes.
</Para>
</RefSect1>
<RefSect1>
<Title>FILES</Title>
<VariableList>
<VarListEntry>
<Term><filename>/usr/dt/bin/dtcm_editor</filename></Term>
<ListItem>
<!-- ex-TP-->
<Para>This is the executable for <command>dtcm_editor</command>.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><filename>/usr/dt/app-defaults/&lt;LANG>/Dtcm</filename></Term>
<ListItem>
<!-- ex-TP-->
<Para>This is the system-default application defaults file for <command>dtcm_editor</command>.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->

408
cde/doc/C/guides/man/man1_dt/cm_inser.sgm Normal file
View File

@@ -0,0 +1,408 @@
<!-- $XConsortium: cm_inser.sgm /main/10 1996/09/08 19:50:40 rws $ -->
<!-- (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. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN3.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN3.rsml.1">]]>
<RefMeta>
<RefEntryTitle>dtcm_insert</RefEntryTitle>
<ManVolNum>user cmd</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Command>dtcm_insert</Command></RefName>
<RefPurpose>insert appointments into the calendar database
</RefPurpose>
</RefNameDiv>
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<CmdSynopsis>
<Command>dtcm_insert</Command>
<Arg Choice="opt">&minus;c&numsp;<Replaceable>calendar</Replaceable></Arg>
<Arg Choice="opt">&minus;d&numsp;<Replaceable>date</Replaceable></Arg>
<Arg Choice="opt">&minus;s&numsp;<Replaceable>start</Replaceable></Arg>
<Arg Choice="opt">&minus;e&numsp;<Replaceable>end</Replaceable></Arg>
<Arg Choice="opt">&minus;v&numsp;<Replaceable>view</Replaceable></Arg>
<Arg Choice="opt">&minus;w&numsp;<Replaceable>what</Replaceable></Arg>
</CmdSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Command>dtcm_insert</Command> utility is non-GUI interface to the &str-XZ; calendar and appointment services,
used to add new appointments to the calendar
<![ %CDE.C.CDE; [database via the RPC daemon
&cdeman.rpc.cmsd;. ]]><![ %CDE.C.XO; [database.
]]>Appointments are added one at a time.
Each of the components of an
appointment is specified using one of the command-line options.
Once an appointment
is added, the list of appointments for the specified date
(see the
<Literal>&minus;d</Literal> and
<Literal>&minus;v</Literal> options) is displayed.
</Para>
</RefSect1>
<RefSect1>
<Title>OPTIONS</Title>
<![ %CDE.C.XO; [
<Para>The
<Command>dtcm_insert</Command> utility supports the &str-Zu;.
</Para>
]]>
<Para>The following options are available:
</Para>
<VariableList>
<VarListEntry>
<Term><Literal>&minus;c&numsp;</Literal><Emphasis>calendar</Emphasis></Term>
<ListItem>
<Para>Specify the name of the target calendar.
Calendar names
<![ %CDE.C.XO; [are implementation-dependent, but
]]>typically take the form
<Emphasis>user</Emphasis>@ <Emphasis>hostname</Emphasis>, where
<Emphasis>user</Emphasis> is a user's login name and
<Emphasis>hostname</Emphasis> is the host machine name.
<![ %CDE.C.CDE; [An example is
<Literal>felix@cat</Literal>. ]]>If no target calendar is specified,
the calendar defaults to
the current user at the current host machine.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>&minus;d&numsp;</Literal><Emphasis>date</Emphasis></Term>
<ListItem>
<Para>Specify the date for the appointment(s) to be inserted.
The
<Emphasis>date</Emphasis> is specified using the form
<Symbol Role="Variable">mm</Symbol>/ <Emphasis>dd</Emphasis>/ <Emphasis>yy</Emphasis>, where
<Symbol Role="Variable">mm</Symbol>, <Emphasis>dd</Emphasis> and
<Emphasis>yy</Emphasis> are the two-digit month, day and year modulo 100, respectively.
<![ %CDE.C.CDE; [Certain other references such as
``today,'' ``Tuesday,'' ``tomorrow,'' etc.
are correctly calculated.
]]>If no date is specified,
<Emphasis>date</Emphasis> defaults to today's date.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>&minus;s&numsp;</Literal><Symbol Role="Variable">start</Symbol></Term>
<ListItem>
<Para>Specify the starting time for the appointment.
The time is specified using the form
<Emphasis>hh</Emphasis>: <Symbol Role="Variable">mm</Symbol>. If
<Emphasis>hh</Emphasis> is greater than 12, 24-hour convention (for example,
<Literal>15:30</Literal> instead of
<Literal>3:30 pm</Literal> <Literal>)</Literal> is assumed.
If
<Emphasis>hh</Emphasis> is 0 to 12,
an optional
<Literal>am</Literal> or
<Literal>pm</Literal> suffix can be used, with or without
white space separating the suffix from the
<Symbol Role="Variable">mm</Symbol>. If no suffix is used,
<Literal>am</Literal> is assumed.
If no starting time is specified,
no time is associated with the inserted appointment.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>&minus;e&numsp;</Literal><Emphasis>end</Emphasis></Term>
<ListItem>
<Para>The ending time for the appointment,
in the same format as
<Literal>&minus;s</Literal>. Specifying an ending time without a starting time is an error.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>&minus;v&numsp;</Literal><Emphasis>view</Emphasis></Term>
<ListItem>
<Para>Specify the view span of appointments to display.
The
<Emphasis>view</Emphasis> option-argument can be:
</Para>
<VariableList>
<VarListEntry>
<Term><Literal>day</Literal></Term>
<ListItem>
<Para>Display all appointments for the given date (see
<Literal>&minus;d</Literal> option).
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>week</Literal></Term>
<ListItem>
<Para>Display the full week that contains the given date,
starting with Sunday.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>month</Literal></Term>
<ListItem>
<Para>Display the entire month that contains the given date.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>&minus;w&numsp;</Literal><Emphasis>what</Emphasis></Term>
<ListItem>
<Para>Specify the appointment description text.
Up to 5 lines of text can be specified by placing &bsol;n
(the literal characters &bsol; and n, not
<KeySym>newline</KeySym>) between lines.
If not specified,
<Emphasis>what</Emphasis> defaults to
<Literal>Appointment</Literal>.</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>OPERANDS</Title>
<Para>None.
</Para>
</RefSect1>
<RefSect1>
<Title>STDIN</Title>
<Para>Not used.
</Para>
</RefSect1>
<RefSect1>
<Title>INPUT FILES</Title>
<Para>None.
</Para>
</RefSect1>
<RefSect1>
<Title>ENVIRONMENT VARIABLES</Title>
<Para>The following environment variables affect the execution of
<Command>dtcm_insert</Command>:</Para>
<VariableList>
<VarListEntry>
<Term><SystemItem Class="EnvironVar">LANG</SystemItem></Term>
<ListItem>
<Para>Provide a default value for the internationalization variables
that are unset or null.
If
<SystemItem Class="EnvironVar">LANG</SystemItem> is unset or null, the corresponding value from the
implementation-specific default locale will be used.
If any of the internationalization variables contains an invalid setting, the
utility behaves as if none of the variables had been defined.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>LC_ALL</Emphasis></Term>
<ListItem>
<Para>If set to a non-empty string value,
override the values of all the other internationalization variables.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>LC_MESSAGES</Emphasis></Term>
<ListItem>
<Para>Determine the locale that is used to affect
the format and contents of diagnostic
messages written to standard error
and informative messages written to standard output.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="EnvironVar">NLSPATH</SystemItem></Term>
<ListItem>
<Para>Determine the location of message catalogues
for the processing of
<Emphasis>LC_MESSAGES</Emphasis>.</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RESOURCES</Title>
<Para>None.
</Para>
</RefSect1>
<RefSect1>
<Title>ASYNCHRONOUS EVENTS</Title>
<![ %CDE.C.XO; [
<Para>Default.
</Para>
]]>
<![ %CDE.C.CDE; [
<Para>The
<Command>dtcm_insert</Command> utility takes the standard action for all signals.
</Para>
]]>
</RefSect1>
<RefSect1>
<Title>STDOUT</Title>
<Para>The standard output contains the list of appointments
for the specified view span, including the appointment just
<![ %CDE.C.CDE; [inserted.
]]><![ %CDE.C.XO; [inserted, in an unspecified format.
]]></Para>
</RefSect1>
<RefSect1>
<Title>STDERR</Title>
<Para>Used only for diagnostic messages.
</Para>
</RefSect1>
<RefSect1>
<Title>OUTPUT FILES</Title>
<Para>None.
</Para>
</RefSect1>
<RefSect1>
<Title>EXTENDED DESCRIPTION</Title>
<Para>None.
</Para>
</RefSect1>
<RefSect1>
<Title>EXIT STATUS</Title>
<Para>The following exit values are returned:
</Para>
<VariableList>
<VarListEntry>
<Term>0</Term>
<ListItem>
<Para>Successful completion.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>>0</Term>
<ListItem>
<Para>An error occurred.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>CONSEQUENCES OF ERRORS</Title>
<Para>Default.
</Para></RefSect1>
<![ %CDE.C.CDE; [<RefSect1>
<Title>FILES</Title>
<Para><Filename>/usr/spool/calendar/callog.username</Filename>,
<Filename>/usr/dt/bin/rpc.cmsd</Filename></Para>
</RefSect1>]]>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<![ %CDE.C.XO; [
<Para>None.
</Para>
]]>
<![ %CDE.C.CDE; [
<Para>In the
<Literal>&minus;w</Literal> option, it may be necessary to
escape the &bsol; character (``&bsol;&bsol;n'') or enclose
the string in quotes
to avoid interpretation by the shell.
</Para>
]]>
</RefSect1>
<RefSect1>
<Title>EXAMPLES</Title>
<![ %CDE.C.XO; [
<Para>None.
</Para>
]]>
<![ %CDE.C.CDE; [
<Para>The simplest form of
<Command>dtcm_insert</Command> has no arguments, where the user is prompted
to enter the appointment, line-by-line:
</Para>
<InformalExample Remap="indent">
<ProgramListing>dtcm_insert
Please enter the information for the appointment you wish to add.
Defaults will be shown in parentheses.
Calendar (hlj@poobah):
Date (2/27/1995):
Start (0822): 1200
End (1300):
Repeat (One Time):
What (you may enter up to 5 lines, use &caret;D to finish):
lunch with the calendar team
at Sparcy's
&caret;D
Appointments for Monday February 27, 1995:
1) 1200- 1300 lunch with the calendar team
at Sparcy's
</ProgramListing>
</InformalExample>
<Para>To insert at a specific time:
</Para>
<InformalExample Remap="indent">
<ProgramListing>dtcm_insert &minus;s "11:00 am"
Appointments for Tuesday September 25, 1990:
1) Appointment
2) 11:00am-12:00pm Appointment
</ProgramListing>
</InformalExample>
<Para>To insert at a specific start and end time:
</Para>
<InformalExample Remap="indent">
<ProgramListing>dtcm_insert &minus;s "11:00 am" &minus;e 11:28am
Appointments for Tuesday September 25, 1990:
1) Appointment
2) 11:00am-11:28am Appointment
</ProgramListing>
</InformalExample>
<Para>To insert at a specific time and date:
</Para>
<InformalExample Remap="indent">
<ProgramListing>dtcm_insert &minus;s 11:00am &minus;d 09/26/90
Appointments for Wednesday September 26, 1990:
1) 11:00am-12:00pm Appointment
</ProgramListing>
</InformalExample>
<Para>To insert at a specific time, date, and message:
</Para>
<InformalExample Remap="indent">
<ProgramListing>dtcm_insert &minus;s "11:00 am" &minus;d 09/26/90 &minus;w "call home"
Appointments for Wednesday September 26, 1990:
1) 11:00am-12:00pm Appointment
2) 11:00am-12:00pm call home
</ProgramListing>
</InformalExample>
<Para>To insert a multiple-line appointment:
</Para>
<InformalExample Remap="indent">
<ProgramListing>dtcm_insert &minus;s 12:00 &minus;w "call dentist&bsol;n
no thanks&bsol;ncancel appointment"
Appointments for Tuesday September 25, 1990:
1) Appointment
2) 11:00am-12:00pm Appointment
3) 12:00pm-1:00pm call dentist
no thanks
cancel appointment
</ProgramListing>
</InformalExample>
]]>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para><![ %CDE.C.CDE; [&cdeman.rpc.cmsd;, &cdeman.dtcm;, ]]>&cdeman.dtcm.delete;, &cdeman.dtcm.lookup;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->

354
cde/doc/C/guides/man/man1_dt/cm_looku.sgm Normal file
View File

@@ -0,0 +1,354 @@
<!-- $XConsortium: cm_looku.sgm /main/10 1996/09/08 19:50:48 rws $ -->
<!-- (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. -->
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCSA.MAN4.rsml.1">]]>
<![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN4.rsml.1">]]>
<RefMeta>
<RefEntryTitle>dtcm_lookup</RefEntryTitle>
<ManVolNum>user cmd</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Command>dtcm_lookup</Command></RefName>
<RefPurpose>look up appointments from the calendar database
</RefPurpose>
</RefNameDiv>
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- (c) Copyright 1993, 1994, 1995 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994, 1995 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994, 1995 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994, 1995 Novell, Inc.-->
<RefSynopsisDiv>
<CmdSynopsis>
<Command>dtcm_lookup</Command>
<Arg Choice="opt">&minus;c&numsp;<Replaceable>calendar</Replaceable></Arg>
<Arg Choice="opt">&minus;d&numsp;<Replaceable>date</Replaceable></Arg>
<Arg Choice="opt">&minus;v&numsp;<Replaceable>view</Replaceable></Arg>
</CmdSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Command>dtcm_lookup</Command> utility is non-GUI interface to the &str-XZ; calendar and appointment services,
used to look up appointments from the calendar
<![ %CDE.C.CDE; [database via the RPC daemon
&cdeman.rpc.cmsd;. ]]><![ %CDE.C.XO; [database.
]]>Each component of the calendar entry is specified using one
of the command-line options.
The current list of appointments for the specified date
(see the
<Literal>&minus;d</Literal> and
<Literal>&minus;v</Literal> options) is displayed.
</Para>
</RefSect1>
<RefSect1>
<Title>OPTIONS</Title>
<![ %CDE.C.XO; [
<Para>The
<Command>dtcm_lookup</Command> utility supports the &str-Zu;.
</Para>
]]>
<Para>The following options are available:
</Para>
<VariableList>
<VarListEntry>
<Term><Literal>&minus;c&numsp;</Literal><Emphasis>calendar</Emphasis></Term>
<ListItem>
<Para>Specify the name of the target calendar.
Calendar names
<![ %CDE.C.XO; [are implementation-dependent, but
]]>typically take the form
<Emphasis>user</Emphasis>@ <Emphasis>hostname</Emphasis>, where
<Emphasis>user</Emphasis> is a user's login name and
<Emphasis>hostname</Emphasis> is the host machine name.
<![ %CDE.C.CDE; [An example is
<Literal>felix@cat</Literal>. ]]>If no target calendar is specified,
the calendar defaults to
the current user at the current host machine.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>&minus;d&numsp;</Literal><Emphasis>date</Emphasis></Term>
<ListItem>
<Para>Specify the date for the look up query.
The
<Emphasis>date</Emphasis> is specified using the form
<Symbol Role="Variable">mm</Symbol>/ <Emphasis>dd</Emphasis>/ <Emphasis>yy</Emphasis>, where
<Symbol Role="Variable">mm</Symbol>, <Emphasis>dd</Emphasis> and
<Emphasis>yy</Emphasis> are the two-digit month, day and year modulo 100, respectively.
<![ %CDE.C.CDE; [Certain other references such as
``today,'' ``Tuesday,'' ``tomorrow,'' etc.
are correctly calculated.
]]>If no date is specified,
<Emphasis>date</Emphasis> defaults to today's date.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>&minus;v&numsp;</Literal><Emphasis>view</Emphasis></Term>
<ListItem>
<Para>Specify the view span of appointments to display.
The
<Emphasis>view</Emphasis> option-argument can be:
</Para>
<VariableList>
<VarListEntry>
<Term><Literal>day</Literal></Term>
<ListItem>
<Para>Display all appointments for the given date (see
<Literal>&minus;d</Literal> option).
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>week</Literal></Term>
<ListItem>
<Para>Display the full week that contains the given date,
starting with Sunday.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>month</Literal></Term>
<ListItem>
<Para>Display the entire month that contains the given date.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<![ %CDE.C.CDE; [
<Para>If the
<Emphasis>view</Emphasis> option-argument is not specified, the viewing range defaults to the view
range specified by the user's
<Command>dtcm</Command> options sheet.
If the user has
not specified a range in his or her options sheet, it defaults to the
<Literal>day</Literal> value.
</Para>
]]>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>OPERANDS</Title>
<Para>None.
</Para>
</RefSect1>
<RefSect1>
<Title>STDIN</Title>
<Para>Not used.
</Para>
</RefSect1>
<RefSect1>
<Title>INPUT FILES</Title>
<Para>None.
</Para>
</RefSect1>
<RefSect1>
<Title>ENVIRONMENT VARIABLES</Title>
<Para>The following environment variables affect the execution of
<Command>dtcm_lookup</Command>:</Para>
<VariableList>
<VarListEntry>
<Term><SystemItem Class="EnvironVar">LANG</SystemItem></Term>
<ListItem>
<Para>Provide a default value for the internationalization variables
that are unset or null.
If
<SystemItem Class="EnvironVar">LANG</SystemItem> is unset or null, the corresponding value from the
implementation-specific default locale will be used.
If any of the internationalization variables contains an invalid setting, the
utility behaves as if none of the variables had been defined.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>LC_ALL</Emphasis></Term>
<ListItem>
<Para>If set to a non-empty string value,
override the values of all the other internationalization variables.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>LC_MESSAGES</Emphasis></Term>
<ListItem>
<Para>Determine the locale that is used to affect
the format and contents of diagnostic
messages written to standard error
and informative messages written to standard output.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="EnvironVar">NLSPATH</SystemItem></Term>
<ListItem>
<Para>Determine the location of message catalogues
for the processing of
<Emphasis>LC_MESSAGES</Emphasis>.</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RESOURCES</Title>
<Para>None.
</Para>
</RefSect1>
<RefSect1>
<Title>ASYNCHRONOUS EVENTS</Title>
<![ %CDE.C.XO; [
<Para>Default.
</Para>
]]>
<![ %CDE.C.CDE; [
<Para>The
<Command>dtcm_lookup</Command> utility takes the standard action for all signals.
</Para>
]]>
</RefSect1>
<RefSect1>
<Title>STDOUT</Title>
<Para>The standard output contains the list of appointments
for the specified view
<![ %CDE.C.CDE; [span.
]]><![ %CDE.C.XO; [span, in an unspecified format.
]]></Para>
</RefSect1>
<RefSect1>
<Title>STDERR</Title>
<Para>Used only for diagnostic messages.
</Para>
</RefSect1>
<RefSect1>
<Title>OUTPUT FILES</Title>
<Para>None.
</Para>
</RefSect1>
<RefSect1>
<Title>EXTENDED DESCRIPTION</Title>
<Para>None.
</Para>
</RefSect1>
<RefSect1>
<Title>EXIT STATUS</Title>
<Para>The following exit values are returned:
</Para>
<VariableList>
<VarListEntry>
<Term>0</Term>
<ListItem>
<Para>Successful completion.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>>0</Term>
<ListItem>
<Para>An error occurred.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>CONSEQUENCES OF ERRORS</Title>
<Para>Default.
</Para></RefSect1>
<![ %CDE.C.CDE; [<RefSect1>
<Title>FILES</Title>
<Para><Filename>/usr/spool/calendar/callog.username</Filename>,
<Filename>/usr/dt/bin/rpc.cmsd</Filename></Para>
</RefSect1>]]>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>None.
</Para>
</RefSect1>
<RefSect1>
<Title>EXAMPLES</Title>
<![ %CDE.C.XO; [
<Para>None.
</Para>
]]>
<![ %CDE.C.CDE; [
<Para>The simplest form of
<Command>dtcm_lookup</Command> has no arguments:
</Para>
<InformalExample Remap="indent">
<ProgramListing>dtcm_lookup
Appointments for Tuesday March 29, 1994:
1) Appointment
2) 10:30am-10:45am Morning Tea
3) 2:00pm-3:00pm Staff meeting
4) 4:30pm-5:00pm Phone home
</ProgramListing>
</InformalExample>
<Para>To look up entries for a specific date:
</Para>
<InformalExample Remap="indent">
<ProgramListing>dtcm_lookup &minus;d 03/29/94
Appointments for Wednesday March 30, 1994:
1) 11:00am-12:00pm Appointment
2) 11:30am-12:30pm Group Lunch
3) 4:00pm-5:00pm Tech Interview
</ProgramListing>
</InformalExample>
<Para>To look up entries from a specific target calendar:
</Para>
<InformalExample Remap="indent">
<ProgramListing>dtcm_lookup &minus;c felix@cat
Appointments for Tuesday March 29, 1994:
1) Appointment
2) 10:15am-10:30am Coffee
3) 11:15am-11:30am Doughnuts
4) 2:00pm-2:15pm Coffee
5) 3:30pm-3:45pm Snack
6) 4:30pm-4:45pm Coffee
</ProgramListing>
</InformalExample>
<Para>To look up an entire week's appointments:
</Para>
<InformalExample Remap="indent">
<ProgramListing>dtcm_lookup &minus;v week
Appointments for Sunday March 27, 1994:
1) 6:00am-5:00pm Hiking
Appointments for Monday March 28, 1994:
1) 11:00am-11:30am Sync with East Coast
2) 4:00pm-4:15pm Confirm flight
Appointments for Tuesday March 29, 1994:
1) Appointment
2) 10:15am-10:30am Coffee
3) 11:15am-11:30am Doughnuts
4) 2:00pm-2:15pm Coffee
5) 3:30pm-3:45pm Snack
6) 4:30pm-4:45pm Coffee
Appointments for Wednesday March 30, 1994:
1) 11:00am-11:15am Appointment
2) 11:30am-12:30pm Group Lunch
3) 4:00pm-5:00pm Tech Interview
Appointments for Friday April 1, 1994:
1) Documentation
2) 10:00am-11:00am Staff meeting
Appointments for Saturday April 2, 1994:
1) 9:00am-11:00am Raquetball with Debbie
</ProgramListing>
</InformalExample>
<Para>Notice that Thursday does not appear, since there were no appointments
on that day.
</Para>
]]>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para><![ %CDE.C.CDE; [&cdeman.rpc.cmsd;, &cdeman.dtcm;, ]]>&cdeman.dtcm.insert;, &cdeman.dtcm.delete;.</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->

452
cde/doc/C/guides/man/man1_dt/codegen.sgm Normal file
View File

@@ -0,0 +1,452 @@
<!-- $XConsortium: codegen.sgm /main/10 1996/09/08 19:50:57 rws $ -->
<!-- (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. -->
<![ %CDE.C.CDE; [<refentry id="CDEMX.XCSA.MAN5.rsml.1">]]><![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN5.rsml.1">]]><refmeta>
<refentrytitle>dtcodegen</refentrytitle><manvolnum>user cmd</manvolnum></refmeta><refnamediv>
<refname><command>dtcodegen</command></refname><refpurpose>generate code from
a &str-XZ; application building services project or module file</refpurpose>
</refnamediv><!-- CDE Common Source Format, Version 1.0.0--><!-- (c) Copyright
1993, 1994, 1995 Hewlett-Packard Company--><!-- (c) Copyright 1993, 1994,
1995 International Business Machines Corp.--><!-- (c) Copyright 1993, 1994,
1995 Sun Microsystems, Inc.--><!-- (c) Copyright 1993, 1994, 1995 Novell,
Inc.--><refsynopsisdiv><![ %CDE.C.CDE; [<cmdsynopsis>
<command>dtcodegen</command><arg choice="opt">&minus;changed</arg><arg choice="opt">&minus;main</arg><arg choice="opt">&minus;merge</arg><arg choice="opt">&minus;nomerge</arg><arg choice="opt">&minus;module&numsp;<replaceable>mymod</replaceable></arg>
<arg choice="opt">&minus;useWC&numsp;<replaceable>class</replaceable></arg>
<group><arg>&minus;p</arg><arg>&minus;project&numsp;<replaceable>myproj</replaceable></arg>
</group><group><arg>&minus;np</arg><arg>&minus;noproject</arg></group><arg
choice="opt">&minus;showall</arg><arg choice="opt">&minus;noshowall</arg>
<group><arg>&minus;s</arg><arg>&minus;silent</arg></group><group><arg>&minus;v</arg><arg>&minus;verbose</arg></group><group><arg><replaceable>file</replaceable></arg>
<arg>&numsp;.&thinsp;.&thinsp;.</arg></group>
</cmdsynopsis>]]><![ %CDE.C.XO; [<CmdSynopsis>
<Command>dtcodegen</Command>
<Arg Choice="opt">&minus;changed</Arg>
<Arg Choice="opt">&minus;main</Arg>
<Arg Choice="opt">&minus;merge</Arg>
<Arg Choice="opt">&minus;nomerge</Arg>
<Arg Choice="opt">&minus;showall</Arg>
<Arg Choice="opt">&minus;noshowall</Arg>
<Group>
<Arg>&minus;s</Arg>
<Arg>&minus;silent</Arg>
</Group>
<Group>
<Arg>&minus;v</Arg>
<Arg>&minus;verbose</Arg>
</Group>
<Arg><Replaceable>file</Replaceable></Arg>
<Arg>&numsp;.&thinsp;.&thinsp;.</Arg>
</CmdSynopsis>
]]>
<cmdsynopsis>
<command>dtcodegen</command><arg>&minus;help</arg>
</cmdsynopsis>
</refsynopsisdiv><refsect1>
<title>DESCRIPTION</title>
<para>The <command>dtcodegen</command> utility reads <![ %CDE.C.CDE; [Builder
Interface Language (BIL) ]]>files created by the &str-XZ; application building
services graphical user interface and produces C, Motif and &str-XZ; source
code for the user interface and application elements defined. The <![ %CDE.C.CDE; [BIL ]]>files
supplied can be individual module files <![ %CDE.C.CDE; [(files with a <Filename>.bil</Filename> suffix) ]]>or a project file <![ %CDE.C.CDE; [(files with a <Filename>.bip</Filename> suffix) ]]>that contains references to zero or more module
files.</para>
</refsect1><refsect1>
<title>OPTIONS</title><![ %CDE.C.XO; [<Para>The
<Command>dtcodegen</Command> utility does not support the &str-Zu; because it uses
the X Window System convention of full-word options.
</Para>
]]>
<para>The following options are available:</para>
<variablelist>
<varlistentry><term><literal>&minus;cha<?Pub Caret>nged</literal></term>
<listitem>
<para>Generate only source code for those modules that have changed since
the last time <command>dtcodegen</command> was run.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;help</literal></term>
<listitem>
<para>Write a help message to standard output explaining all <command>dtcodegen</command> options and then terminate.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;main</literal></term>
<listitem>
<para>Produce the project files associated with the application's <function>main</function> routine.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;merge</literal></term>
<listitem>
<para>Merge generated stubs files with previous versions, perpetuating changes
made or custom edits done to the previous stubs file. This is the default
behavior.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;nomerge</literal></term>
<listitem>
<para>Do not merge existing and new <Filename>_stubs.c</Filename> files. This
option overrides the default merging behavior. If both <literal>&minus;merge</literal> and <literal>&minus;nomerge</literal> are used, the one given last
on the command line takes precedence. <![ %CDE.C.CDE; [</para></listitem>
</varlistentry>
<varlistentry><term><literal>&minus;module&numsp;</literal><emphasis>mymod</emphasis></term>
<listitem>
<para>Generate code for the module <emphasis>mymod</emphasis>, (which is expected
to be defined in the file <emphasis>mymod</emphasis> <Filename>.bil</Filename>). Using multiple <literal>&minus;module</literal> options includes
multiple modules in the generated code.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;useWC&numsp;</literal><emphasis>class</emphasis></term>
<listitem>
<para>Use the specified widget class whenever possible. Valid values are:
</para>
<variablelist>
<varlistentry><term><literal>dt</literal></term>
<listitem>
<para>Generate <Symbol>DtComboBox</Symbol> and <Symbol>DtSpinBox</Symbol>
widgets. This value retains the CDE 1.0 behavior.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>xm</literal></term>
<listitem>
<para>Generate <Symbol>XmComboBox</Symbol> and <Symbol>XmSimpleSpinBox</Symbol> widgets. This value selects the Motif/Xm behavior.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;p&thinsp;|&thinsp;&minus;project&numsp;</literal> <emphasis>myproj</emphasis></term>
<listitem>
<para>Generate code for the project <emphasis>myproj</emphasis>, (which is
expected to be defined in the file <emphasis>myproj</emphasis> <Filename>.bip</Filename>).</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;noproject</literal></term>
<listitem>
<para>Ignore the <emphasis>project</emphasis><Filename>.bip</Filename> project
file and use default project settings instead. This is useful in producing
an application from one or a few module files (for example, for testing) as
an alternative to generating the entire project. ]]></para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;showall</literal></term>
<listitem>
<para>Cause the generated application to show (map) all application windows
(main windows and dialogs) at startup, ignoring whether they are set to be
initially visible or not. If no project is specified on the command line, <![ %CDE.C.CDE; [either
by using <literal>&minus;project</literal> or by specifying a <emphasis>project</emphasis> <Filename>.bip</Filename> file as an
operand, ]]><command>dtcodegen</command> performs as if <literal>&minus;showall</literal> had been specified. (The <literal>&minus;noshowall</literal> option
suppresses this behavior).</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;noshowall</literal></term>
<listitem>
<para>Cause the generated application to show at startup (map) only those
windows (main windows and dialogs) whose initially visible attribute is true.
If a project is specified on the command line, <![ %CDE.C.CDE; [either by
using <literal>&minus;project</literal> or by specifying a <emphasis>project</emphasis> <Filename>.bip</Filename> file as an operand, ]]> <command>dtcodegen</command> performs as if <literal>&minus;noshowall</literal> had
been specified. (The <literal>&minus;showall</literal> option suppresses this
behavior).</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;s&thinsp;|&thinsp;&minus;silent</literal></term>
<listitem>
<para>Work silently, producing no output except error messages while generating
source code.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;v&thinsp;|&thinsp;&minus;verbose</literal></term>
<listitem>
<para>Be more verbose in providing progress and status messages during the
generation of source code.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1><refsect1>
<title>OPERANDS</title>
<para>The following operand is supported:</para>
<variablelist>
<varlistentry><term><symbol role="Variable">file</symbol></term>
<listitem>
<para>A pathname of a project or module file. <![ %CDE.C.CDE; [It is not necessary
to specify the <Filename>.bip</Filename> or <Filename>.bil</Filename> extension
for any file because <command>dtcodegen</command> uses a sequence of search
algorithms in the current directory to determine what files should be read
in order to satisfy the specified command line.</para><para>If no
<symbol role="Variable">file</symbol> operands are given, <command>dtcodegen</command>
searches the current directory for a project file (a file with a <Filename>.bip</Filename> suffix). If one is found, it is used as if it had been specified
on the command line. If more than one is found, the first one encountered
is used.</para><para>If one or more <symbol role="Variable">file</symbol>
operands are specified, <command>dtcodegen</command> checks to see if any
of them is a project file in the current working directory, and uses the
first one found. If none of the <symbol role="Variable">file</symbol> operands
are project files, then the directory is searched for a project file. This
search is similar to the no-operand case, but is modified to look for a project
file that contain modules corresponding to other <symbol role="Variable">file</symbol> operands.</para><para>Operands other than the project file are
taken to be module names.</para></listitem>
</varlistentry>
</variablelist>
<para>See the EXAMPLES section for more on the interpretation of filename
operands and how the search features of <command>dtcodegen</command> may be
used.</para>]]><![ %CDE.C.XO; [</Para>
</ListItem>
</VarListEntry>
</VariableList>]]></refsect1><refsect1>
<title>RESOURCES</title>
<para>If the <literal>&minus;useWC</literal> option is not specified, <command>dtcodegen</command> uses the <literal>useWidgetClass</literal> resource in
the Xt resources table to determine which class to use for generated widgets.
The class/type is <Symbol>XmCUseWidgetClass</Symbol>/<Symbol>XtEnum</Symbol> and the valid
values are:</para>
<variablelist>
<varlistentry><term><literal>xm</literal> (the default)</term>
<listitem>
<para>Generate <Symbol>XmComboBox</Symbol> and <Symbol>XmSimpleSpinBox</Symbol> widgets. This value selects the Motif/Xm behavior.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>dt</literal></term>
<listitem>
<para>Generate <Symbol>DtComboBox</Symbol> and <Symbol>DtSpinBox</Symbol>
widgets. This value retains the CDE 1.0 behavior.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1><refsect1>
<title>STDIN</title>
<para>Not used.</para>
</refsect1><refsect1>
<title>INPUT FILES</title>
<para>All input files are text files <![ %CDE.C.XO; [in the format used by the &str-XZ; application building services
graphical user interface.
See
<XRef Linkend="XCSA.APPB.anch.2" Role="3">. ]]><![ %CDE.C.CDE; [in the BIL
format. See &cdeman.BIL;. ]]></para>
</refsect1><refsect1>
<title>ENVIRONMENT VARIABLES</title>
<para>The following environment variables affect the execution of <command>dtcodegen</command>:</para>
<variablelist>
<varlistentry><term><systemitem class="EnvironVar">LANG</systemitem></term>
<listitem>
<para>Provide a default value for the internationalization variables that
are unset or null. If <systemitem class="EnvironVar">LANG</systemitem> is
unset or null, the corresponding value from the implementation-specific default
locale will be used. If any of the internationalization variables contains
an invalid setting, the utility behaves as if none of the variables had been
defined.</para>
</listitem>
</varlistentry>
<varlistentry><term><emphasis>LC_ALL</emphasis></term>
<listitem>
<para>If set to a non-empty string value, override the values of all the other
internationalization variables.</para>
</listitem>
</varlistentry>
<varlistentry><term><emphasis>LC_MESSAGES</emphasis></term>
<listitem>
<para>Determine the locale that is used to affect the format and contents
of diagnostic messages written to standard error and informative messages
written to standard output.</para>
</listitem>
</varlistentry>
<varlistentry><term><systemitem class="EnvironVar">NLSPATH</systemitem></term>
<listitem>
<para>Determine the location of message catalogues for the processing of <emphasis>LC_MESSAGES</emphasis>.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1><refsect1>
<title>ASYNCHRONOUS EVENTS</title><![ %CDE.C.XO; [<Para>Default.
</Para>
]]><![ %CDE.C.CDE; [<para>The <command>dtcodegen</command> utility takes the
standard action for all signals.</para>]]></refsect1><refsect1>
<title>STDOUT</title>
<para>When <literal>&minus;help</literal> is specified, <command>dtcodegen</command> writes to standard output a usage message in an unspecified format.
Otherwise, standard output is not used.</para>
</refsect1><refsect1>
<title>STDERR</title>
<para>When <literal>&minus;verbose</literal> is specified, <command>dtcodegen</command> writes to standard error informational progress messages
and diagnostic messages in an unspecified format.
Otherwise, standard error is used only for diagnostic messages.</para>
</refsect1><refsect1>
<title>OUTPUT FILES</title>
<para>The
<command>dtcodegen</command> utility produces the following files:</para>
<variablelist>
<varlistentry><term><emphasis>modname</emphasis><Filename>_ui.c</Filename></term>
<listitem>
<para>The primary source code file for module
<emphasis>modname</emphasis>, containing C code to create the objects in the
module and
establish connections for those objects.</para>
</listitem>
</varlistentry>
<varlistentry><term><emphasis>modname</emphasis><Filename>_ui.h</Filename></term>
<listitem>
<para>Declarations and C externs for module
<emphasis>modname</emphasis>.</para>
</listitem>
</varlistentry>
<varlistentry><term><emphasis>modname</emphasis><Filename>_stubs.c</Filename></term>
<listitem>
<para>Callback functions for the element handlers specific to module
<emphasis>modname</emphasis>.</para>
</listitem>
</varlistentry>
<varlistentry><term><emphasis>project</emphasis><Filename>.c</Filename></term>
<listitem>
<para>If
<command>dtcodegen</command> is generating code for a project, this file contains
<function>main</function> plus any callback functions that are common across
modules.</para>
</listitem>
</varlistentry>
<varlistentry><term><emphasis>project</emphasis><Filename>.h</Filename></term>
<listitem>
<para>If
<command>dtcodegen</command> is generating code for a project, this file contains
declarations for any callback functions and C externs
that are common across interfaces.</para>
</listitem>
</varlistentry>
<varlistentry><term><filename>.dtcodegen.log</filename></term>
<listitem>
<para>A record of per-module code generation and the date and time of
each module as it was processed.
This data is required to provide support for the
<literal>&minus;changed</literal> option as part of determining which files
need to be regenerated and
which ones do not.</para>
</listitem>
</varlistentry>
</variablelist>
<para>Additional application code should be added to the
<emphasis>modname</emphasis> <Filename>_stubs.c</Filename>, <emphasis>project</emphasis> <Filename>.c</Filename> and
<emphasis>project</emphasis> <Filename>.c</Filename> files, as appropriate,
because their contents are merged across runs of
<command>dtcodegen</command>.</para>
</refsect1><refsect1>
<title>EXTENDED DESCRIPTION</title>
<para>None.</para>
</refsect1><refsect1>
<title>EXIT STATUS</title>
<para>The following exit values are returned:</para>
<variablelist>
<varlistentry><term>0</term>
<listitem>
<para>successful completion</para>
</listitem>
</varlistentry>
<varlistentry><term>>0</term>
<listitem>
<para>an error occurred</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1><refsect1>
<title>CONSEQUENCES OF ERRORS</title>
<para>Because code generation involves the sequential production of a set
of application files, errors that cause the
<command>dtcodegen</command> utility to exit prematurely also may result in
some module or
project source files having been generated while others were not.
Attempts to build the application from this mix of new and old
generated code produce undefined results.</para>
</refsect1><refsect1>
<title>APPLICATION USAGE</title>
<para>Typically the
<command>dtcodegen</command> utility is used indirectly through the
<![ %CDE.C.XO; [&str-XZ; application building services graphical user interface.
]]><![ %CDE.C.CDE; [&str-XZ; Application Builder's Code Generator dialog.
]]>This allows application code to be generated while the user is working
with the Application Builder rather than through a separate interface or
shell command line.
<![ %CDE.C.CDE; [The Code Generator dialog provides a graphical user interface
for
<command>dtcodegen</command> that makes it easy to generate code, build the
resulting application
and then execute it.
]]></para>
<para>In some cases, however, it may be desirable to use the
<command>dtcodegen</command> utility directly.
A common example of this usage is to employ the
code generator from within an application Makefile to produce
a portion of the application code from pre-existing project or module files.
</para>
</refsect1><refsect1>
<title>EXAMPLES</title>
<para>Run the code generator on the application defined by the
project file
<literal>myproject.bip</literal>:</para>
<informalexample remap="indent">
<programlisting><![ %CDE.C.XO; [dtcodegen myproject.bip
]]><![ %CDE.C.CDE; [dtcodegen &minus;p myproject
]]></programlisting>
</informalexample>
<para>Run the code generator for the project
<![ %CDE.C.XO; [in file
]]><literal>myproject.bip</literal>, but only generate code for the module
<![ %CDE.C.XO; [in file
]]><literal>modulename.bil</literal>:</para>
<informalexample remap="indent">
<programlisting><![ %CDE.C.XO; [dtcodegen myproject.bip modulename.bil
]]><![ %CDE.C.CDE; [dtcodegen myproject.bip modulename
]]></programlisting>
</informalexample><![ %CDE.C.CDE; [<para>Search the current working directory
for a project file that
references the module
<literal>mymodule</literal> and then silently generate code for just that
module:</para><informalexample remap="indent">
<programlisting>dtcodegen &minus;silent mymodule</programlisting>
</informalexample><para>In the following example:</para><informalexample remap="indent">
<programlisting>dtcodegen name1 name2</programlisting>
</informalexample><para>if the project file
<literal>name1.bip</literal> exists, it is used and code is generated for
module
<literal>name2.bil</literal>. Otherwise, both
<literal>name1</literal> and
<literal>name2</literal> are taken as the name of modules, the current working
directory is
searched for a project file that references both modules, and code
for those two modules is generated.</para><para>Run the code generator, which
searches the current working
directory for a project file to be processed, and generates all code
associated with that project:</para><informalexample remap="indent">
<programlisting>dtcodegen</programlisting>
</informalexample>]]>
<para>Generate just the files associated with the main routine
for the project
<![ %CDE.C.XO; [in file
<Literal>myproject-file</Literal>, ]]><![ %CDE.C.CDE; [<literal>myproject</literal>, ]]>namely
<Filename>myproject.c</Filename> and
<Filename>myproject.h</Filename>:</para>
<informalexample remap="indent">
<programlisting><![ %CDE.C.XO; [dtcodegen &minus;main myproject-file
]]><![ %CDE.C.CDE; [dtcodegen &minus;main &minus;p myproject
]]></programlisting>
</informalexample>
<para>Search the current working directory for a project file and,
if one is found, generate code for only those modules that have changed
since the code generator was last run:</para>
<informalexample remap="indent">
<programlisting>dtcodegen &minus;changed</programlisting>
</informalexample>
<para>Generate, for the project
<![ %CDE.C.XO; [in file
]]><literal>myproject.bip</literal>, code only for those modules among the
set
<![ %CDE.C.XO; [of files named
]]><literal>module1</literal>, <literal>module2</literal> and
<literal>module3</literal> that have changed since the last time the code
generator was run:</para>
<informalexample remap="indent">
<programlisting><![ %CDE.C.XO; [dtcodegen &minus;changed myproject.bip module1 module2 module3
]]><![ %CDE.C.CDE; [dtcodegen &minus;changed &minus;p myproject module1 module2 module3
]]></programlisting>
</informalexample>
</refsect1><refsect1>
<title>SEE ALSO</title><![ %CDE.C.XO; [<Para>None.
</Para>
]]><![ %CDE.C.CDE; [<para>&cdeman.dtbuilder;, &cdeman.BIL;.
</para>]]></refsect1></refentry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->
<?Pub *0000022239>

154
cde/doc/C/guides/man/man1_dt/config.sgm Normal file
View File

@@ -0,0 +1,154 @@
<!-- $XConsortium: config.sgm /main/6 1996/09/08 19:51:07 rws $ -->
<!-- (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.MAN7.rsml.1" Remap="">
<RefMeta>
<RefEntryTitle>dtconfig</RefEntryTitle>
<ManVolNum>user cmd</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Command>dtconfig</Command></RefName>
<RefPurpose>desktop configuration utility
</RefPurpose>
</RefNameDiv>
<!--- -->
<!-- (c) Copyright 1993, 1994 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994 Novell, Inc.-->
<!--- -->
<!--- -->
<!--- -->
<RefSynopsisDiv>
<CmdSynopsis>
<Command>dtconfig</Command>
<Group>
<Arg>&minus;d</Arg>
<Arg>&minus;e</Arg>
<Arg>&minus;kill</Arg>
<Arg>&minus;reset</Arg>
<Arg>&minus;p</Arg>
</Group>
<!--- -->
<!--- -->
<!--- DESCRIPTION -->
<!--- This section tells concisely what the command does -->
<!--- -->
</CmdSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>Desktop configuration utility. Integrates CDE with the
operating system of the underlying platform. System root login privilege is
required to use
<Command>dtconfig</Command>.
<!--- --></Para>
</RefSect1>
<RefSect1>
<Title>OPTIONS</Title>
<VariableList>
<VarListEntry>
<Term>&minus;d</Term>
<ListItem>
<!-- ex-TP-->
<Para>Disables desktop auto-start feature. At end of boot cycle, platform's native
text based login mechanism will be used.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>&minus;e</Term>
<ListItem>
<!-- ex-TP-->
<Para>Enable's desktop auto-start feature. Desktop login window will display at end
of platform's boot cycle.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>&minus;kill</Term>
<ListItem>
<!-- ex-TP-->
<Para>Kill desktop (window based) login process and any user sessions associated with
it. Return control to system's native text based console.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>&minus;reset</Term>
<ListItem>
<!-- ex-TP-->
<Para>Tell desktop (window based) login process to reread its configuration files
to incorporate any changes.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>&minus;p</Term>
<ListItem>
<!-- ex-TP-->
<Para>Printer actions for any printer known to platform will be created if such print
actions do not already exist in the platform's actions database. This option
is executed automatically at boot time if desktop auto-start has been enabled.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RETURN</Title>
<VariableList>
<VarListEntry>
<Term>0</Term>
<ListItem>
<!-- ex-TP-->
<Para>Successful completion
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>>0</Term>
<ListItem>
<!-- ex-TP-->
<Para>Error condition
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>FILES</Title>
<VariableList>
<VarListEntry>
<Term>/usr/dt/bin/dtconfig</Term>
<ListItem>
<Para>location of dtconfig utility</Para>
<!-- ex-TP-->
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dtlogin;, &cdeman.dtprintinfo;
</Para>
</RefSect1>
<RefSect1>
<Title>NOTES</Title>
<Para>The
<Command>dtconfig</Command> script is an optional utility in the CDE.
It may not be present on all platforms offering this desktop. In such cases,
see platform specific documentation for further information. Alternate
mechanisms may have been supplied. All
<Command>dtconfig</Command> options may not be present on all platforms. Running
<Command>dtconfig</Command> without options will list available options for the platform.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->

54
cde/doc/C/guides/man/man1_dt/convertv.sgm Normal file
View File

@@ -0,0 +1,54 @@
<!-- $XConsortium: convertv.sgm /main/5 1996/09/08 19:51:15 rws $ -->
<!-- (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.MAN8.rsml.1">
<RefMeta>
<RefEntryTitle>dtconvertvf</RefEntryTitle>
<ManVolNum>special file</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Filename>dtconvertvf</Filename></RefName>
<RefPurpose>convert VUE 3.0 action/filetype files to DT syntax
</RefPurpose>
</RefNameDiv>
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- *************************************************************************-->
<!-- ** (c) Copyright 1993, 1994 Hewlett-Packard Company-->
<!-- ** (c) Copyright 1993, 1994 International Business Machines Corp.-->
<!-- ** (c) Copyright 1993, 1994 Sun Microsystems, Inc.-->
<!-- ** (c) Copyright 1993, 1994 Novell, Inc.-->
<!-- *************************************************************************-->
<RefSynopsisDiv>
<Synopsis>dtconvertvf
</Synopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Literal>dtconvertvf</Literal> utility is a filter script for converting VUE 3.0 action and filetype
databases to the new CDE 1.0 datatypes syntax.
If the input is a VUE 3.0
filetype file (*.vf) then its output will be converted to a CDE 1.0 datatypes
file.
It is up to the user to name the output file accordingly.
To be
recognized by CDE 1.0 it must have the <Filename>.dt</Filename> suffix.
</Para>
</RefSect1>
<RefSect1>
<Title>EXAMPLE</Title>
<Para>To convert a single action/filetype file to CDE 1.0 syntax:
sp 1
<Literal>dtconvertvf</Literal> <Literal>&lt;</Literal> <Literal>file.vf</Literal> <Literal>></Literal> <Literal>file.dt</Literal> To convert all action/filetype files in current directory to CDE 1.0 syntax:
for vffile in *.vf; do
<Literal>dtfile=${vffile%.vf}.dt</Literal> <Literal>dtconvertvf</Literal> <Literal>&lt;</Literal> <Literal>$vffile</Literal> <Literal>></Literal> <Literal>$dtfile</Literal> done
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->

129
cde/doc/C/guides/man/man1_dt/create.sgm Normal file
View File

@@ -0,0 +1,129 @@
<!-- $XConsortium: create.sgm /main/4 1996/09/08 19:51:24 rws $ -->
<!-- (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.MAN9.rsml.1" Remap="">
<RefMeta>
<RefEntryTitle>dtcreate</RefEntryTitle>
<ManVolNum>user cmd</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Command>dtcreate</Command></RefName>
<RefPurpose>The CDE Action and Datatype creation client.
</RefPurpose>
</RefNameDiv>
<!--- -->
<!-- (c) Copyright 1993, 1994 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994 Novell, Inc.-->
<!--- -->
<RefSynopsisDiv>
<CmdSynopsis>
<Command>dtcreate</Command>
<Arg Choice="opt"><Replaceable>&lt;filename></Replaceable></Arg>
</CmdSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The CreateAction client is used to create actions and datatypes to
integrate an application into the CDE.
CreateAction provides the most commonly needed functions including the
creation of actions for an application, creation of the associated
datatypes for the application's data files, and the ability to specify
the Open and Print actions for those datatypes. The output from this
tool is a actions and datatypes definition file placed within the
users $HOME/.dt/ types directory and an action file that is placed in
the users $HOME directory. CreateAction also provides the ability to
edit a action and datatypes definition file that was created using
this tool.
</Para>
<RefSect2>
<Title>KEY SUPPORTED TASKS</Title>
<ItemizedList>
<ListItem>
<Para>Creating of actions to represent applications, commands, shell scripts, etc.
</Para>
</ListItem>
<ListItem>
<Para>Creating of datatypes to represent an application's data files.
</Para>
</ListItem>
<ListItem>
<Para>Creating of the Open and Print actions for the datatypes.
</Para>
</ListItem>
<ListItem>
<Para>Creating of the actions and datatypes definition file within the
user's /HOME/.dt/types directory.
</Para>
</ListItem>
<ListItem>
<Para>Creating the action file within the user's home directory. This file
provides the ability for the icon to be visible within the CDE's managers such as the File Manager.
</Para>
</ListItem>
<ListItem>
<Para>Modifying of actions and datatypes definition files that were created
using this tool.
</Para>
</ListItem>
<ListItem>
<Para>Rereading of the action and datatype database so that the actions and
datatypes are available for immediate use.
</Para>
</ListItem>
</ItemizedList>
</RefSect2>
</RefSect1>
<RefSect1>
<Title>OPTIONS</Title>
<VariableList>
<VarListEntry>
<Term>&lt;filename></Term>
<ListItem>
<!-- ex-TP-->
<Para>Loads the
<Emphasis>&lt;filename></Emphasis> action and datatype definition file into CreateAction for modification.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RETURN</Title>
<Para>Exit values are:
</Para>
<VariableList>
<VarListEntry>
<Term>0</Term>
<ListItem>
<Para>Successful completion.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>>0</Term>
<ListItem>
<Para>Error condition occurred.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>EXAMPLES</Title>
<RefSect2>
<Title>dtcreate MyAction.dt</Title>
<Para>dtcreate will load the MyAction.dt action and datatype definition file
and display using dtcreate's graphic user interface.
</Para>
</RefSect2>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->

252
cde/doc/C/guides/man/man1_dt/docbook.sgm Normal file
View File

@@ -0,0 +1,252 @@
<!-- $XConsortium: docbook.sgm /main/7 1996/10/22 12:17:02 rws $ -->
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
<!-- (c) Copyright 1996 International Business Machines Corp. -->
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1996 Novell, Inc. -->
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
<!-- (c) Copyright 1996 Hitachi. -->
<![ %CDE.C.CDE; [<refentry id="cde.INFO.dtdocbook">]]>
<refmeta><refentrytitle>dtdocbook</refentrytitle><manvolnum>user cmd</manvolnum>
</refmeta>
<refnamediv><refname><command>dtdocbook</command></refname><refpurpose>DocBook
to SDL translator</refpurpose></refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>dtdocbook</command><arg choice="opt">&minus;c</arg><arg choice="opt">&minus;d</arg><arg choice="opt">&minus;h</arg><arg choice="opt">&minus;m</arg>
<arg choice="opt">&minus;o <replaceable>file</replaceable></arg><arg choice="opt">&minus;r</arg><arg choice="opt">&minus;s <replaceable>dir</replaceable></arg>
<arg choice="opt">&minus;u</arg><arg choice="opt">&minus;v</arg><arg choice="opt">&minus;x</arg><arg><replaceable>file</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>The <command>dtdocbook</command> command converts documents that conform
to the DocBook 2.2.1 DTD (Document Type Definition) subelement PART to documents
that conform to the SDL 1.2 DTD. The reason for translating DocBook documents
to SDL is to make them readable by the the DtHelp viewer.</para>
<para>The CDE documentation authoring environment produces documents that
conform to the DocBook DTD Version 2.2.1. The CDE online documentation browser
(<command>dtinfo</command>) accepts only documents in the DocBook DTD 2.2.1
format. The CDE online help viewer (<command>DtHelp</command>) accepts only
documents in the SDL DTD Version 1.2 format. Both DocBook and SDL are implementations
of the SGML standard, ISO 8879:1986. <command>dtdocbook</command> translates
document from one format to the other, making them suitable for use with
the help viewer.</para>
<para>During translation, several items are precomputed to accelerate run-time
display of the resulting SDL document. These items include: the table of
contents, the keyword index, cross-reference resolution, and the labeling
of ordered lists. By default, <command>dtdocbook</command> also compresses
the SDL document.</para>
<para><command>dtdocbook</command> requires only the filename of the input
file. Note that the input file can be either a DocBook document or an SDL
document, depending on the operation you want <command>dtdocbook</command>
to perform. If the file name ends in the characters <filename>.sgm</filename>
or <filename>.sdl</filename>, <command>dtdocbook</command> assumes they are
the file name extension removes them to create the base name for all intermediate
files and for the final output file. If the file name does not end in the
characters <filename>.sgm</filename> or <filename>.sdl</filename>, <command>dtdocbook</command> uses the file name as given for the base name. If you
request either compression or decompression (<literal>&minus;c</literal>
or <literal>&minus;d</literal> option) of an existing SDL file, the input
file name extension will be <filename>.sdl</filename>. If you specify neither <literal>&minus;c</literal> nor <literal>&minus;d</literal>, the input file name extension
must be <filename>.sgm</filename>. The output file name extension will always
be <filename>.sdl</filename> unless you specify the <literal>&minus;o</literal>
option, in which case <command>dtdocbook</command> will use the output filename
that you specify.</para>
<para>If you specify the <literal>&minus;c</literal> option and the file is
already compressed, <command>dtdocbook</command> will decompress and recompress
the file. This is a convenient way to verify the integrity of a compressed
SDL file.</para>
<para>If you specify the <literal>&minus;c</literal>
option and the file is already decompressed,
<command>dtdocbook</command> will re-parse the file,
repeat all precomputations, and
update the existing file. This is a convenient way
to verify the integrity of an SDL
file. It also allows you to force a recomputation
of the table of contents to reflect edits
made to the SDL file. You must recompute the table
of contents because it consists
of byte offsets to the individual help topics in the
file.</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<para>The following options are available:</para>
<variablelist>
<varlistentry><term><literal>&minus;c</literal></term>
<listitem>
<para>Compresses an existing SDL file. This option
assumes an
input file name extension of <filename>.sdl</filename>.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;d</literal></term>
<listitem>
<para>Decompresses an existing SDL file. This option
assumes an
input file name extension of <filename>.sdl</filename>.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;h</literal></term>
<listitem>
<para>Outputs a summary of the command and its options
to standard output.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;m</literal></term>
<listitem>
<para>Adds additional SDATA and/or character mapping
files.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;o</literal> <emphasis>file</emphasis></term>
<listitem>
<para>Uses the specified filename for the output file
and does not add any file name extension.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;r</literal></term>
<listitem>
<para>Removes any intermediate files and the output
file. If none exist,
<command>dtdocbook</command> does not issue an error
message.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;s</literal> <emphasis>dir</emphasis></term>
<listitem>
<para>Instructs <command>dtdocbook</command> to find the DocBook SGML declaration
and associated files in the specified directory.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;u</literal></term>
<listitem>
<para>Turns off compression for the output file during translation.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;v</literal></term>
<listitem>
<para>Instructs <command>dtdocbook</command> to generate and display parser
messages during processing (verbose mode).</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;x</literal></term>
<listitem>
<para>Retains intermediate files when finished. This option is used primarily
for debugging <command>dtdocbook</command> itself.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>OPERANDS</title>
<para>The following operand is supported:</para>
<variablelist>
<varlistentry><term><symbol role="Variable">file</symbol></term>
<listitem>
<para>The document file to be input to <command>dtdocbook</command>. The
file can be in either DocBook or SDL format, depending on which options you
specify.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>EXIT STATUS</title>
<variablelist remap="tight">
<varlistentry><term>0</term>
<listitem>
<para>The input file was processed successfully.</para>
</listitem>
</varlistentry>
<varlistentry><term>><?Pub Caret>1</term>
<listitem>
<para>The operation failed.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>ENVIRONMENT VARIABLES</title>
<para><command>dtdocbook</command> references the <systemitem class="environvar">LANG</systemitem> variable to determine the language used for the input file's
contents. <systemitem class="environvar">LANG</systemitem> can be overridden
by the <Symbol>LANG</Symbol> attribute of the DocBook PART element.</para>
</refsect1>
<refsect1>
<title>RESOURCES</title>
<para>None.</para>
</refsect1>
<refsect1>
<title>ACTIONS/MESSAGES</title>
<para>None.</para>
</refsect1>
<refsect1>
<title>ERRORS/WARNINGS</title>
<para><literal>TO BE SUPPLIED</literal></para>
</refsect1>
<refsect1>
<title>FILES</title>
<variablelist>
<varlistentry><term><emphasis>file</emphasis>.sgm</term>
<listitem>
<para>The source file</para>
</listitem>
</varlistentry>
<varlistentry><term><emphasis>file</emphasis>.idx</term>
<listitem>
<para>An intermediate file, typically removed after use</para>
</listitem>
</varlistentry>
<varlistentry><term><emphasis>file</emphasis>.snb</term>
<listitem>
<para>An intermediate file, typically removed after
use</para>
</listitem>
</varlistentry>
<varlistentry><term><emphasis>file</emphasis>.sdl</term>
<listitem>
<para>the output file</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>EXAMPLES</title>
<variablelist>
<varlistentry><term></term>
<listitem>
<para>Remove all files that resulted from previously
processing
the source file <literal>myFile.dbk</literal>:</para>
<para>% <command>dtdocbook</command> <literal>-r myFile.dbk</literal></para>
<para>or (without the .dbk extension)</para>
<para>% <command>dtdocbook</command> <literal>-r myFile</literal></para>
</listitem>
</varlistentry>
<varlistentry><term></term>
<listitem>
<para>Process the file <literal>myFile.dbk</literal>:</para>
<para>% <command>dtdocbook</command> <literal>myFile.dbk</literal></para>
<para>or (without the .dbk extension)</para>
<para>% <command>dtdocbook</command> <literal>myFile</literal></para>
</listitem>
</varlistentry>
<varlistentry><term></term>
<listitem>
<para>Process the file <literal>myFile.dbk</literal>
and write the
SDL output to <Filename>otherFile.sdl</Filename>:</para>
<para>% <command>dtdocbook</command><literal>-o otherFile.sdl
myFile.dbk</literal></para>
<para>or (without the .dbk extension)</para>
<para>% <command>dtdocbook</command><literal>-o otherFile.sdl
myFile</literal></para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>TO BE SUPPLIED</para>
</refsect1>
</refentry>

179
cde/doc/C/guides/man/man1_dt/exec.sgm Normal file
View File

@@ -0,0 +1,179 @@
<!-- $XConsortium: exec.sgm /main/7 1996/09/08 19:51:42 rws $ -->
<!-- (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.MAN10.rsml.1">
<RefMeta>
<RefEntryTitle>dtexec</RefEntryTitle>
<ManVolNum>user cmd</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Command>dtexec</Command></RefName>
<RefPurpose>execute command-based action
<IndexTerm>
<Primary>dtexec</Primary>
</IndexTerm></RefPurpose>
</RefNameDiv>
<!-- *************************************************************************-->
<!-- ** (c) Copyright 1993,1994 Hewlett-Packard Company -->
<!-- ** (c) Copyright 1993,1994 International Business Machines Corp. -->
<!-- ** (c) Copyright 1993,1994 Sun Microsystems, Inc.-->
<!-- ** (c) Copyright 1993,1994 Novell, Inc.-->
<!-- *************************************************************************-->
<RefSynopsisDiv>
<CmdSynopsis>
<Command>dtexec</Command>
<Arg Choice="opt">&minus;open<Replaceable>open_option</Replaceable></Arg>
<Arg Choice="opt">&minus;ttprocid<Replaceable>procid</Replaceable></Arg>
<Arg Choice="opt">&minus;tmp<Replaceable>tmpfile</Replaceable></Arg>
<Arg><Replaceable>cmd</Replaceable></Arg>
<Arg Choice="opt"><Replaceable>cmd_arg ...</Replaceable></Arg>
</CmdSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>&str-XZ; uses the
<Command>dtexec</Command> utility to execute
<SystemItem Class="Constant">COMMAND</SystemItem> actions.
In normal
usage, &str-XZ; automatically invokes
<Command>dtexec</Command> when it is needed.
&str-XZ; users
and administrators do not need to interact directly with
<Command>dtexec</Command>.</Para>
<Para>The primary argument for
<Command>dtexec</Command> is the name of a command to execute and
any command-line options or arguments for that command.
There are
several important services that
<Command>dtexec</Command> provides for the commands that it executes.
These services are controlled via the options specified in the ``OPTIONS''
section in this document.
</Para>
</RefSect1>
<RefSect1>
<Title>OPTIONS</Title>
<Para>The following options are available:
</Para>
<VariableList>
<VarListEntry>
<Term><Literal>-open</Literal> <Emphasis>open_option</Emphasis></Term>
<ListItem>
<Para>The <Literal>-open</Literal> option tells
<Command>dtexec</Command> whether it should continue to run or
exit after the command terminates.
</Para>
<Para>The valid values for
<Emphasis>open_option</Emphasis> are:
</Para>
<VariableList>
<VarListEntry>
<Term><Literal>-1</Literal></Term>
<ListItem>
<Para>(default) continue to execute after <Emphasis>cmd</Emphasis> terminates.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>0</Literal></Term>
<ListItem>
<Para>exit as soon as <Emphasis>cmd</Emphasis> terminates.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>n</Literal></Term>
<ListItem>
<Para>continue to execute if <Emphasis>cmd</Emphasis> terminates
within <Literal>n</Literal> seconds of starting.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>The values <Literal>-1</Literal> and <Literal>n</Literal> are typically used when
<SystemItem Class="Constant">COMMAND</SystemItem> actions are executed in a terminal emulator to control
the lifetime of the terminal window.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>-ttprocid</Literal> <Emphasis>procid</Emphasis></Term>
<ListItem>
<Para>The
<Command>dtexec</Command> command uses the <Literal>-ttprocid</Literal> option
to send ToolTalk messages
back to the application that invoked the
<SystemItem Class="Constant">COMMAND</SystemItem> action.
These
messages are used to convey status information (for example, the command
has terminated).
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>-tmp</Literal> <Emphasis>tmpfile</Emphasis></Term>
<ListItem>
<Para>The <Literal>-tmp</Literal> option names a temporary file that
<Command>dtexec</Command> removes after <Emphasis>cmd</Emphasis> terminates if either no <Emphasis>-ttprocid</Emphasis> option is
supplied or contact is lost with the specified <Emphasis>procid</Emphasis>.
In normal usage, the parent process that starts
<Command>dtexec</Command>, performs this cleanup.
This option can be issued multiple times, once for each tmp file present.
Typically, <Emphasis>tmpfile</Emphasis> also appears as a <Emphasis>cmd_arg</Emphasis>.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>EXIT STATUS</Title>
<Para>The following exit values are returned:
</Para>
<VariableList>
<VarListEntry>
<Term><Literal>0</Literal></Term>
<ListItem>
<Para>Implies all system resources were available to fork and exec the requested
command, not that the requested command executed successfully.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>1</Literal></Term>
<ListItem>
<Para>An error occurred.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>Normally, application programs do not directly invoke this program.
Normally, an application program links with the
action service, which then invokes
<Command>dtexec</Command> as needed.
Applications should use the
<Literal>waitTime</Literal> resource to configure the value of the
<Emphasis>&minus;open_option</Emphasis> and the <Literal>DtexecPath</Literal> resource to configure
the location of
<Command>dtexec</Command>.</Para>
<Para>If <Emphasis>cmd</Emphasis> writes to stderr, the error messages are time stamped
and redirected to the user's errorlog file (<Filename>$HOME/.dt/errorlog</Filename>)
when <Emphasis>open_option</Emphasis> is <Literal>0</Literal>. If <Emphasis>open_option</Emphasis> is set
otherwise, the error messages are typically displayed in the
terminal window.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dtaction;, &cdeman.dtactionfile;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->

1498
cde/doc/C/guides/man/man1_dt/file.sgm Normal file
View File

File diff suppressed because it is too large Load Diff

342
cde/doc/C/guides/man/man1_dt/file_cop.sgm Normal file
View File

@@ -0,0 +1,342 @@
<!-- $XConsortium: file_cop.sgm /main/6 1996/10/30 16:26:59 rws $ -->
<!-- (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.MAN12.rsml.1" Remap="">
<RefMeta>
<RefEntryTitle>dtfile_copy</RefEntryTitle>
<ManVolNum>user cmd</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Command>dtfile_copy</Command></RefName>
<RefPurpose>the CDE File Manager copy utility
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<CmdSynopsis>
<Command>dtfile_copy</Command>
<Arg Choice="opt">options ...</Arg>
<Arg>source_folder target_folder</Arg>
</CmdSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The CDE File Manager copy utility is used to
recursively copy folders and their contents, including subfolders. The
utility's default action is to create a duplicate of the source_folder
in the target_folder's location. Thus objects which exist in the target
but not in the source are deleted, objects which exist in the source but
not in the target are copied, and objects which exist in the target and
in the source are replaced if they are different. The utility compares
both timestamp and size of two objects to determine if they are
identical.
</Para>
<Para>The copy utility is invoked by the File Manager whenever a user requests
a folder be moved or copied. Its use is thus transparent to the user.
However, it can also be explicitly invoked from a shell window. The
utility has many options which can be used to modify its default
behavior.
</Para>
</RefSect1>
<RefSect1>
<Title>OPTIONS</Title>
<Para>The following options are available from the command line:
</Para>
<RefSect2>
<Title>-dontDoIt</Title>
<Para>Write a description of the actions that would be performed to a dialog window,
but do not modify any objects.
</Para>
</RefSect2>
<RefSect2>
<Title>-keepNew</Title>
<Para>If an object exists in the source and target folders, do not replace the
target object if it is newer than the source object.
</Para>
</RefSect2>
<RefSect2>
<Title>-keepOld</Title>
<Para>If an object exists in the source and target folders, rename the
existing target object by appending .old to the name before copying the
source.
</Para>
</RefSect2>
<RefSect2>
<Title>-dontDelete</Title>
<Para>If an object exists in the target folder but not the source, do not
delete the target object.
</Para>
</RefSect2>
<RefSect2>
<Title>-dontAdd</Title>
<Para>If an object exists in the source folder but not the target, do not copy
the source file.
</Para>
</RefSect2>
<RefSect2>
<Title>-dontReplace</Title>
<Para>If an object exists in the source and target folders, do not replace the
target object.
</Para>
</RefSect2>
<RefSect2>
<Title>-dontRecur</Title>
<Para>Process only the files in the source folder, do not process any
subfolders.
</Para>
</RefSect2>
<RefSect2>
<Title>-keepLinks</Title>
<Para>If the target object is a symbolic link to the source object, retain the link
instead of replacing the link by a copy of the source object.
</Para>
</RefSect2>
<RefSect2>
<Title>-keepCopies</Title>
<Para>If a source object is a symbolic link and the target object is a
a copy of the object that the source link points at (i.e., has same
size and timestamp), retain the target object instead of replacing
it by a symbolic link.
</Para>
</RefSect2>
<RefSect2>
<Title>-forceCopies</Title>
<Para>If an object exists in the source and target folders, copy the source
object even if the timestamps and sizes are equal.
</Para>
</RefSect2>
<RefSect2>
<Title>-linkFolders</Title>
<Para>If a folder exists in the source but not the target, create a symbolic link in
the target pointing to the source instead of copying the source folder.
</Para>
</RefSect2>
<RefSect2>
<Title>-linkFiles</Title>
<Para>If a file exists in the source but not the target, create a symbolic link in the
target pointing to the source instead of copying the source file.
</Para>
</RefSect2>
<RefSect2>
<Title>-copyFolders</Title>
<Para>If the source is a symbolic link to a folder, make a copy of the folder
that the source link points at, instead of just copying the link.
</Para>
</RefSect2>
<RefSect2>
<Title>-copyFiles</Title>
<Para>If the source is a symbolic link to a file, makes a copy of the file
that the source link points at, instead of just copying the link.
</Para>
</RefSect2>
<RefSect2>
<Title>-copyTop</Title>
<Para>If the target folder does not exist, create one.
</Para>
</RefSect2>
<RefSect2>
<Title>-move</Title>
<Para>Following a successful copy operation, remove the source folder.
</Para>
</RefSect2>
<RefSect2>
<Title>-confirmReplace</Title>
<Para>If an object exists in the source and target directories, display a
dialog giving a choice of actions before proceeding.
</Para>
</RefSect2>
<RefSect2>
<Title>-confirmErrors</Title>
<Para>If an error occurs processing an object, display a dialog describing the
error before proceeding.
</Para>
</RefSect2>
<RefSect2>
<Title>-popDown</Title>
<Para>Following a successful copy or move operation, automatically remove the
dtfile_copy dialog after the interval specified by the delay option.
</Para>
</RefSect2>
<RefSect2>
<Title>-delay</Title>
<Para>The time, in microseconds, that the dtfile_copy dialog is displayed after a
successful copy operation is completed.
</Para>
</RefSect2>
<RefSect2>
<Title>-slow</Title>
<Para>Pause for a preset time interval between each file operation.
</Para>
</RefSect2>
</RefSect1>
<RefSect1>
<Title>EXAMPLES</Title>
<RefSect2>
<Title>dtfile /u/aUser/FolderA /u/aUser/FolderA.backup</Title>
<Para>The folder /u/aUser/FolderA.backup is made to be a duplicate of
/u/aUser/FolderA. The name of each oject processed is written to a dialog window
with an indication of the operation performed.
</Para>
</RefSect2>
</RefSect1>
<RefSect1>
<Title>RESOURCES</Title>
<programlisting>
<Literal>Name Class Type Default</Literal>
dontDoIt DontDoIt XmRBoolean False
keepNew KeepNew XmRBoolean False
keepOld KeepOld XmRBoolean False
dontDelete DontDelete XmRBoolean False
dontAdd DontAdd XmRBoolean False
dontReplace DontReplace XmRBoolean False
dontRecur DontRecur XmRBoolean False
keepLinks KeepLinks XmRBoolean False
keepCopies KeepCopies XmRBoolean False
forceCopies ForceCopies XmRBoolean False
linkFolders LinkFolders XmRBoolean False
linkFiles LinkFiles XmRBoolean False
copyFolders CopyFolders XmRBoolean False
copyFiles CopyFiles XmRBoolean False
copyTop CopyTop XmRBoolean False
move move XmRBoolean False
confirmReplace ConfirmReplace XmRBoolean False
confirmErrors ConfirmErrors XmRBoolean False
popDown PopDown XmRBoolean False
delay Delay XmRBoolean False
toggle Toggle XmRBoolean True
slow Slow XmRBoolean False
</programlisting>
<RefSect2>
<Title>Dtfile*dontDoIt:</Title>
<Para>Write a description of the actions that would be performed to a dialog window,
but do not modify any objects.
</Para>
</RefSect2>
<RefSect2>
<Title>Dtfile*keepNew:</Title>
<Para>If an object exists in the source and target folders, do not replace the
target object if it is newer than the source object.
</Para>
</RefSect2>
<RefSect2>
<Title>Dtfile*keepOld:</Title>
<Para>If an object exists in the source and target folders, rename the
existing target object by appending .old to the name before copying the
source.
</Para>
</RefSect2>
<RefSect2>
<Title>Dtfile*dontDelete:</Title>
<Para>If an object exists in the target folder but not the source, do not
delete the target object.
</Para>
</RefSect2>
<RefSect2>
<Title>Dtfile*dontAdd:</Title>
<Para>If an object exists in the source folder but not the target, do not copy
the source file.
</Para>
</RefSect2>
<RefSect2>
<Title>Dtfile*dontReplace:</Title>
<Para>If an object exists in the source and target folders, do not replace the
target object.
</Para>
</RefSect2>
<RefSect2>
<Title>Dtfile*dontRecur:</Title>
<Para>Process only the files in the source folder, do not process any
subfolders.
</Para>
</RefSect2>
<RefSect2>
<Title>Dtfile*keepLinks:</Title>
<Para>If the target object is a symbolic link to the source object, retain the link
instead of replacing the link by a copy of the source object.
</Para>
</RefSect2>
<RefSect2>
<Title>Dtfile*keepCopies:</Title>
<Para>If a source object is a symbolic link and the target object is a
a copy of the object that the source link points at (i.e., has same
size and timestamp), retain the target object instead of replacing
it by a symbolic link.
</Para>
</RefSect2>
<RefSect2>
<Title>Dtfile*forceCopies:</Title>
<Para>If an object exists in the source and target folders, copy the source
object even if the timestamps and sizes are equal.
</Para>
</RefSect2>
<RefSect2>
<Title>Dtfile*linkFolders:</Title>
<Para>If a folder exists in the source but not the target, create a symbolic link in
the target pointing to the source instead of copying the source folder.
</Para>
</RefSect2>
<RefSect2>
<Title>Dtfile*linkFiles:</Title>
<Para>If a file exists in the source but not the target, create a symbolic link in the
target pointing to the source instead of copying the source file.
</Para>
</RefSect2>
<RefSect2>
<Title>Dtfile*copyFolders:</Title>
<Para>If the source is a symbolic link to a folder, make a copy of the folder
that the source link points at, instead of just copying the link.
</Para>
</RefSect2>
<RefSect2>
<Title>Dtfile*copyFiles:</Title>
<Para>If the source is a symbolic link to a file, makes a copy of the file
that the source link points at, instead of just copying the link.
</Para>
</RefSect2>
<RefSect2>
<Title>Dtfile*copyTop:</Title>
<Para>If the target folder does not exist, create one.
</Para>
</RefSect2>
<RefSect2>
<Title>Dtfile*move:</Title>
<Para>Following a successful copy operation, remove the source folder.
</Para>
</RefSect2>
<RefSect2>
<Title>Dtfile*confirmReplace:</Title>
<Para>If an object exists in the source and target directories, display a
dialog giving a choice of actions before proceeding.
</Para>
</RefSect2>
<RefSect2>
<Title>Dtfile*confirmErrors:</Title>
<Para>If an error occurs processing an object, display a dialog describing the
error before proceeding.
</Para>
</RefSect2>
<RefSect2>
<Title>Dtfile*popDown:</Title>
<Para>Following a successful copy or move operation, automatically remove the
dtfile_copy dialog after the interval specified by the delay option.
</Para>
</RefSect2>
<RefSect2>
<Title>Dtfile*delay:</Title>
<Para>The time, in microseconds, that the dtfile_copy dialog is displayed after a
successful copy operation is completed.
</Para>
</RefSect2>
<RefSect2>
<Title>Dtfile*slow:</Title>
<Para>Pause for a preset time interval between each file operation.
</Para>
</RefSect2>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->

63
cde/doc/C/guides/man/man1_dt/file_err.sgm Normal file
View File

@@ -0,0 +1,63 @@
<!-- $XConsortium: file_err.sgm /main/3 1996/06/19 18:34:55 rws $ -->
<!-- (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.MAN13.rsml.1" Remap="">
<RefMeta>
<RefEntryTitle>dtfile_error</RefEntryTitle>
<ManVolNum>user cmd</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Command>dtfile_error</Command></RefName>
<RefPurpose>the CDE File Manager error-dialog
script
</RefPurpose>
</RefNameDiv>
<!--- -->
<!-- (c) Copyright 1993, 1994 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994 Novell, Inc.-->
<!--- -->
<RefSynopsisDiv>
<CmdSynopsis>
<Command>dtfile_error error_message</Command>
</CmdSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>This script can be used by applications to display an error dialog when
it would be difficult or impossible to do in the context of the
executing program. For example, it can be used when exec fails in a
child process or if an error is detected before an application's main
window can be realized. It can also be used from a shell script to
display an error dialog.
</Para>
<Para>This script is used by File Manager to display an error dialog when
exec fails within a child process.
</Para>
</RefSect1>
<RefSect1>
<Title>EXAMPLES</Title>
<RefSect2>
<Title>dtfile_error You did something wrong</Title>
<Para>Executed from a command line, this displays an error dialog. The dialog
consists of the message text, "You did something wrong", and an OK
button. Clicking on OK dismisses the dialog.
</Para>
</RefSect2>
<RefSect2>
<Title>execl(dtfile_error, dtfile_error, s, NULL);</Title>
<Para>Executed from within a program, this displays an error dialog. The
dialog consists of the message text in the string s and an OK button.
Clicking on OK dismisses the dialog.
</Para>
</RefSect2>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->

141
cde/doc/C/guides/man/man1_dt/fplist.sgm Normal file
View File

@@ -0,0 +1,141 @@
<!-- $XConsortium: fplist.sgm /main/8 1996/10/30 16:27:23 rws $ -->
<!-- (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.MAN14.rsml.1">
<RefMeta>
<RefEntryTitle>dtfplist</RefEntryTitle>
<ManVolNum>user cmd</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Command>dtfplist</Command></RefName>
<RefPurpose>a general purpose utility for printing the hierarchy of the front panel components
</RefPurpose>
</RefNameDiv>
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- *************************************************************************-->
<!-- ** (c) Copyright 1993, 1994 Hewlett-Packard Company-->
<!-- ** (c) Copyright 1993, 1994 International Business Machines Corp.-->
<!-- ** (c) Copyright 1993, 1994 Sun Microsystems, Inc.-->
<!-- ** (c) Copyright 1993, 1994 Novell, Inc.-->
<!-- *************************************************************************-->
<RefSynopsisDiv>
<CmdSynopsis>
<Command>dtfplist</Command>
</CmdSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Command>dtfplist</Command> utility provides a textual view of what the front panel will look like without
restarting the window manager.
The
<Command>dtfplist</Command> utility provides the ability to get an ASCII text version of the front panel
hierarchy.
This utility will print the hierarchy to standard out.
</Para>
</RefSect1>
<RefSect1>
<Title>OPTIONS</Title>
<Para>None.
</Para>
</RefSect1>
<RefSect1>
<Title>OPERANDS</Title>
<Para>None.
</Para>
</RefSect1>
<RefSect1>
<Title>RESOURCES</Title>
<Para>None.
</Para>
</RefSect1>
<RefSect1>
<Title>STDIN</Title>
<Para>Not used.
</Para>
</RefSect1>
<RefSect1>
<Title>INPUT FILES</Title>
<Para>None.
</Para>
</RefSect1>
<RefSect1>
<Title>ENVIRONMENT VARIABLES</Title>
<Para><SystemItem Class="EnvironVar">DTDATABASESEARCHPATH</SystemItem></Para>
</RefSect1>
<RefSect1>
<Title>ASYCHRONOUS EVENTS</Title>
<Para>None.
</Para>
</RefSect1>
<RefSect1>
<Title>STDOUT</Title>
<Para>The following is the format of hierachy to be written to standard out:
</Para>
<InformalExample Remap="indent">
<ProgramListing><Symbol>PANEL</Symbol> &lt;panel name>
<Symbol>BOX</Symbol> &lt;box name>
<Symbol>CONTROL</Symbol> &lt;control name>
<Symbol>SUBPANEL</Symbol> &lt;subpanel name>
<Symbol>CONTROL</Symbol> &lt;control name>
...
<Symbol>CONTROL</Symbol> &lt;control name>
...
<Symbol>BOX</Symbol> &lt;box name>
...
</ProgramListing>
</InformalExample>
<Para>The hierarchy that will be written to standard out, is the one that will be
used when the front panel is created during the invocation of
<Command>dtwm</Command>.</Para>
</RefSect1>
<RefSect1>
<Title>STDERR</Title>
<Para>Not used.
</Para>
</RefSect1>
<RefSect1>
<Title>OUTPUT FILES</Title>
<Para>None.
</Para>
</RefSect1>
<RefSect1>
<Title>EXTENDED DESCRIPTION</Title>
<Para>None.
</Para>
</RefSect1>
<RefSect1>
<Title>EXIT STATUS</Title>
<Para>None.
</Para>
</RefSect1>
<RefSect1>
<Title>CONSEQUENCES OF ERRORS</Title>
<Para>If the
<SystemItem Class="EnvironVar">DTDATABASESEARCHPATH</SystemItem> is not specified, this utility will not generate
any output.
</Para>
</RefSect1>
<RefSect1>
<Title>APPLICATION USAGE</Title>
<Para>This can be used to debug changes to the front panel configuration files.
</Para>
</RefSect1>
<RefSect1>
<Title>EXAMPLES</Title>
<Para>None.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dtwm;
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->

42
cde/doc/C/guides/man/man1_dt/greet.sgm Normal file
View File

@@ -0,0 +1,42 @@
<!-- $XConsortium: greet.sgm /main/7 1996/08/30 13:25:13 rws $ -->
<!-- (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.MAN15.rsml.1" Remap="">
<RefMeta>
<RefEntryTitle>dtgreet</RefEntryTitle>
<ManVolNum>user cmd</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Command>dtgreet</Command></RefName>
<RefPurpose>CDE dtlogin login screen display utility
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<CmdSynopsis>
<Command>dtgreet</Command>
</CmdSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<note>
<para>The Common Desktop Environment (CDE) dtgreet utility is used by
&cdeman.dtlogin; to display the login screen. It is not
intended to be run directly from the command line.
</para>
</note>
<Para>The CDE dtgreet utility is used by
<Command>dtlogin</Command> to display the login screen on a display. There will be one
<Command>dtgreet</Command> process per display on which a login screen is visible.
</Para>
<Para>All customization of the login screen is done via
<Command>dtlogin</Command> configuration files. Refer to the
&cdeman.dtlogin; man page for information regarding login screen customization.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->

42
cde/doc/C/guides/man/man1_dt/he_ctag1.sgm Normal file
View File

@@ -0,0 +1,42 @@
<!-- $XConsortium: he_ctag1.sgm /main/6 1996/09/08 19:52:09 rws $ -->
<!-- (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.MAN17.rsml.1">
<RefMeta>
<RefEntryTitle>dthelp_ctag1</RefEntryTitle>
<ManVolNum>user cmd</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Command>dthelp_ctag1</Command></RefName>
<RefPurpose>first pass for formal SGML parse of HelpTag source
</RefPurpose>
</RefNameDiv>
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- *************************************************************************-->
<!-- ** (c) Copyright 1993, 1994 Hewlett-Packard Company-->
<!-- ** (c) Copyright 1993, 1994 International Business Machines Corp.-->
<!-- ** (c) Copyright 1993, 1994 Sun Microsystems, Inc.-->
<!-- ** (c) Copyright 1993, 1994 Novell, Inc.-->
<!-- *************************************************************************-->
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The executable
<Command>dthelp_ctag1</Command> is invoked by
&cdeman.dthelptag; as the first
pass of translating the formal (canonical) version of HelpTag markup
into SDL.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dthelptag;, &cdeman.dthelptagdtd;, &cdeman.dtsdldtd;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->

41
cde/doc/C/guides/man/man1_dt/he_htag1.sgm Normal file
View File

@@ -0,0 +1,41 @@
<!-- $XConsortium: he_htag1.sgm /main/6 1996/09/08 19:52:18 rws $ -->
<!-- (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.MAN18.rsml.1">
<RefMeta>
<RefEntryTitle>dthelp_htag1</RefEntryTitle>
<ManVolNum>user cmd</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Command>dthelp_htag1</Command></RefName>
<RefPurpose>first pass for loose (shorthand) parse of HelpTag source
</RefPurpose>
</RefNameDiv>
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- *************************************************************************-->
<!-- ** (c) Copyright 1993, 1994 Hewlett-Packard Company-->
<!-- ** (c) Copyright 1993, 1994 International Business Machines Corp.-->
<!-- ** (c) Copyright 1993, 1994 Sun Microsystems, Inc.-->
<!-- ** (c) Copyright 1993, 1994 Novell, Inc.-->
<!-- *************************************************************************-->
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Command>dthelp_htag1</Command> executable is invoked by
&cdeman.dthelptag; as the first
pass of translating the shorthand version of HelpTag markup into SDL.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dthelptag;, &cdeman.dtsdldtd;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->

115
cde/doc/C/guides/man/man1_dt/he_htag2.sgm Normal file
View File

@@ -0,0 +1,115 @@
<!-- $XConsortium: he_htag2.sgm /main/6 1996/09/08 19:52:26 rws $ -->
<!-- (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.MAN19.rsml.1">
<RefMeta>
<RefEntryTitle>dthelp_htag2</RefEntryTitle>
<ManVolNum>user cmd</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Command>dthelp_htag2</Command></RefName>
<RefPurpose>second pass for parse of HelpTag source
</RefPurpose>
</RefNameDiv>
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- *************************************************************************-->
<!-- ** (c) Copyright 1993, 1994 Hewlett-Packard Company-->
<!-- ** (c) Copyright 1993, 1994 International Business Machines Corp.-->
<!-- ** (c) Copyright 1993, 1994 Sun Microsystems, Inc.-->
<!-- ** (c) Copyright 1993, 1994 Novell, Inc.-->
<!-- *************************************************************************-->
<RefSynopsisDiv>
<CmdSynopsis>
<Command>dthelp_htag2 -</Command>
<Arg Choice="opt">cdhot</Arg>
<Arg>file</Arg>
<Arg Choice="opt">outfile</Arg>
</CmdSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Command>dthelp_htag2</Command> executable
is invoked by
&cdeman.dthelptag; as the second
pass of translating HelpTag markup into SDL.
The
<Command>dthelp_htag2</Command> executable accepts the output of the first pass of
dthelptag (either
&cdeman.dthelp.htag1; or
&cdeman.dthelp.ctag1;) and computes the byte
offsets of virtual pages to be used in the runtime display of the SDL
volume.
If only one file is specified on the command line, the output file
will overwrite the input file.
If two files are specified, the output
will be placed in the second.
If the input file has no .sdl extension, one will be added.
If a
second file name is specified for output, it will be used without
modification.
The options to
<Command>dthelp_ctag2</Command> are:
</Para>
<VariableList>
<VarListEntry>
<Term>&minus;c:</Term>
<ListItem>
<Para>compress the SDL document on a per virtual page basis &minus; if
the document is already compressed, this command will result
in no change to the document.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>&minus;d:</Term>
<ListItem>
<Para>decompress an SDL document &minus; if the document is already
compressed, this command will result in no change to the
document; however, the byte offsets of virtual pages will be
recomputed.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>&minus;h:</Term>
<ListItem>
<Para>print a help message and exit.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>&minus;o:</Term>
<ListItem>
<Para>perform peephole optimization of the SDL document.
In
particular, <Literal>&lt;FORM></Literal> elements containing only a single <Literal>&lt;BLOCK></Literal> or
<Literal>&lt;FORM></Literal> without a user supplied identifier are replaced by that
single <Literal>&lt;BLOCK></Literal> or <Literal>&lt;FORM></Literal> with the identifier of the original
(outer) <Literal>&lt;FORM></Literal>.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>&minus;t:</Term>
<ListItem>
<Para>eliminate any <Literal>&lt;TOSS></Literal> sub-elements that are not used in this SDL
document.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dthelptag;, &cdeman.dthelp.htag1;, &cdeman.dthelp.ctag1;, &cdeman.dtsdldtd;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->

188
cde/doc/C/guides/man/man1_dt/hello.sgm Normal file
View File

@@ -0,0 +1,188 @@
<!-- $XConsortium: hello.sgm /main/8 1996/10/30 16:27:45 rws $ -->
<!-- (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.MAN16.rsml.1" remap="">
<refmeta><refentrytitle>dthello</refentrytitle><manvolnum>user cmd</manvolnum>
</refmeta>
<refnamediv><refname><command>dthello</command></refname><refpurpose>CDE login
transitional greeting</refpurpose></refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>dthello</command>
<arg choice="opt">&minus;display <replaceable>&lt;display></replaceable></arg>
<arg choice="opt">&minus;fground <replaceable>&lt;color></replaceable></arg>
<arg choice="opt">&minus;bground <replaceable>&lt;color></replaceable></arg>
<arg choice="opt">&minus;font <replaceable>&lt;fontname></replaceable></arg>
<arg choice="opt">&minus;string <replaceable>&lt;message></replaceable></arg>
<arg choice="opt">&minus;file <replaceable>&lt;filename></replaceable></arg>
<arg choice="opt">&minus;timeout <replaceable>&lt;seconds></replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>The dthello client provides transition visuals from the end of login
to the start of the window manager in the user's session.</para>
<para>Upon invocation, the dthello client will create an override-redirect
window the size of the screen and draw a specified message on it. At the same
time, a 1x1 window is created that will be picked up by the window manager.
When the window manager reparents the little window (an indication that the
window manager has started), this program exits.</para>
<para>The message may be specified on the command line, or in a text file.
</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<note>
<para>The <command>dthello</command> client is designed to be started by the system and
is not intended to be started directly by users.
</para>
</note>
<variablelist>
<varlistentry><term><literal>&minus;display</literal> <emphasis>display</emphasis></term>
<listitem>
<para>Display id.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;fground</literal> <emphasis>color</emphasis></term>
<listitem>
<para>Foreground color.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;bground</literal> <emphasis>color</emphasis></term>
<listitem>
<para>Background color.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;font</literal> <emphasis>fontname</emphasis></term>
<listitem>
<para>Font.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;string</literal> <emphasis>message</emphasis></term>
<listitem>
<para>String to be displayed in window.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;file</literal> <emphasis>filename</emphasis></term>
<listitem>
<para>Text file name whose contents will be displayed in window.
This option may be specified up to five times.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;timeout</literal> <emphasis>seconds</emphasis></term>
<listitem>
<para>Number of seconds before giving up on the window manager
and terminating.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>RETURN</title>
<para>Exit values are:</para>
<variablelist>
<varlistentry><term>0</term>
<listitem>
<para>Successful completion.</para>
</listitem>
</varlistentry>
<varlistentry><term>>0</term>
<listitem>
<para>Error condition occurred.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>EXAMPLES</title>
<para><command>dthello</command> <literal>-string</literal> <literal>Welcome
to the Desktop</literal> Transition window will contain this message.</para>
</refsect1>
<refsect1>
<title>RESOURCES</title>
<para>NOTE: Resources should be prefaced with the string "Dthello*" when specified.
Resources should be specified in the Dthello app-defaults file.</para>
<informaltable remap="center" orient="port">
<tgroup cols="4" colsep="0" rowsep="0">
<colspec align="left" colwidth="99*">
<colspec align="left" colwidth="109*">
<colspec align="left" colwidth="84*">
<colspec align="left" colwidth="164*">
<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">vbackground</entry>
<entry align="left" valign="top">Vbackground</entry>
<entry align="left" valign="top">Pixel</entry>
<entry align="left" valign="top">dynamic</entry></row>
<row>
<entry align="left" valign="top">vforeground</entry>
<entry align="left" valign="top">Vforeground</entry>
<entry align="left" valign="top">Pixel</entry>
<entry align="left" valign="top">dynamic</entry></row>
<row>
<entry align="left" valign="top">vfont</entry>
<entry align="left" valign="top">Vfont</entry>
<entry align="left" valign="top">FontList</entry>
<entry align="left" valign="top">dynamic</entry></row>
<row>
<entry align="left" valign="top">string</entry>
<entry align="left" valign="top">String</entry>
<entry align="left" valign="top">String</entry>
<entry align="left" valign="top">.........</entry></row>
<row>
<entry align="left" valign="top">file</entry>
<entry align="left" valign="top">File</entry>
<entry align="left" valign="top">String</entry>
<entry align="left" valign="top">NULL</entry></row>
<row>
<entry align="left" valign="top">timeout</entry>
<entry align="left" valign="top">Timeout</entry>
<entry align="left" valign="top">Integer</entry>
<entry align="left" valign="top">240</entry></row></tbody></tgroup></informaltable>
<refsect2><?Pub Caret1>
<title>vbackground</title>
<para>Specifies the background color for the transition message.</para>
</refsect2>
<refsect2>
<title>vforeground</title>
<para>Specifies the foreground color for the transition message.</para>
</refsect2>
<refsect2>
<title>vfont</title>
<para>Specifies the font to use for the transition message.</para>
</refsect2>
<refsect2>
<title>string</title>
<para>Specifies the text to use in the transition message.</para>
</refsect2>
<refsect2>
<title>file</title>
<para>Specifies a file whose contents is to be displayed in addition to the
transition message. Only one file may be specified.</para>
</refsect2>
<refsect2>
<title>timeout</title>
<para>Number of seconds before giving up on the window manager and terminating.
</para>
</refsect2>
</refsect1>
</refentry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->
<?Pub *0000035081>

486
cde/doc/C/guides/man/man1_dt/helpgen.sgm Normal file
View File

@@ -0,0 +1,486 @@
<!-- $XConsortium: helpgen.sgm /main/10 1996/09/08 19:52:43 rws $ -->
<!-- (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.MAN20.rsml.1">
<RefMeta>
<RefEntryTitle>dthelpgen</RefEntryTitle>
<ManVolNum>user cmd</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Command>dthelpgen</Command></RefName>
<RefPurpose>generates a top-level help browser volume
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<CmdSynopsis>
<Command>dthelpgen</Command>
<Arg>&minus;dir<Replaceable>directory</Replaceable></Arg>
<Arg Choice="opt"><Replaceable>options</Replaceable></Arg>
</CmdSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Command>dthelpgen</Command> utility searches for all CDE help family files
installed and registered, and generates a help
volume named browser,
which contains hypertext links to all help
families and volumes found.
By default, the scope of this search
includes only the local system; however, it can be extended to remote
systems using the environment variables described below.
</Para>
<Para>The
<Command>dthelpgen</Command> utility only updates the
browser
help volume if new family files or volumes are detected within
the search path directories.
In the case where no new family files are present,
<Command>dthelpgen</Command> exits.
If new files are present,
<Command>dthelpgen</Command> posts an information dialog telling the user that it's updating the
browser
volume.
</Para>
<Para>By viewing the
browser
help volume and traversing its
hypertext links, the user can navigate through all of the registered
online help information.
</Para>
<Para>To view the
browser
volume, select the Help Viewer control from
the desktop's Front Panel.
The top level of the
browser
volume lists product
families.
The second level, under each family,
lists the volumes that are members of the product family.
</Para>
<Para>CDE users or system administrators typically do not need
to interact directly with the
<Command>dthelpgen</Command> utility.
A
browser
volume is generated (when one does not already exist, or is
out of date) when the user selects the Help Viewer control
from the CDE front panel.
A
browser
volume is also generated when the user executes the
<Literal>ReloadApps</Literal> Action, or runs
<Command>dthelpgen</Command> directly from a terminal window.
In the first two cases, the resulting
browser
volume is placed in the user's
<Filename>$HOME/.dt/help/$DTUSERSESSION</Filename> directory.
When running
<Command>dthelpgen</Command> from a terminal window, the &minus;dir option must be used to specify
the location to create the resulting
browser
file.
</Para>
</RefSect1>
<RefSect1>
<Title>OPTIONS</Title>
<Para>The following options are available:
</Para>
<VariableList>
<VarListEntry>
<Term><Literal>&minus;generate</Literal></Term>
<ListItem>
<Para>Specifies that
<Command>dthelpgen</Command> unconditionally regenerate the
browser
volume
without first checking if new families or help volumes are present.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>&minus;dir</Literal> <Emphasis>directory</Emphasis></Term>
<ListItem>
<Para>Specifies the directory to deposit the generated files.
The specification can use substitution values.
The <Literal>ENVIRONMENT VARIABLES</Literal>
heading describes the substitution values allowed and their effect.
If the environment variable
<SystemItem Class="EnvironVar">LANG</SystemItem> is not set or is
<SystemItem Class="Constant">NULL</SystemItem>, it is forced to
<Literal>C</Literal>.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>&minus;file</Literal> <Emphasis>basename</Emphasis></Term>
<ListItem>
<Para>Specifies the base name for the files generated by
<Command>dthelpgen</Command>. The default
name is
browser.
Extensions are appended to
<Emphasis>basename</Emphasis> to create
the file names for the
help
volume.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>&minus;lang</Literal> <Symbol Role="Variable">language</Symbol></Term>
<ListItem>
<Para>Specifies which language directories to search for
help
Family files and
help volumes.
If this option is not set, the default
<SystemItem Class="EnvironVar">LANG</SystemItem> value is used.
If the
<Literal>&minus;lang</Literal> value is set, it takes precedence over the current environment's
<SystemItem Class="EnvironVar">LANG</SystemItem> setting.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>ENVIRONMENT VARIABLES</Title>
<Para>The CDE help system uses two environment variables for locating
help
volumes and Family 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>Users
search path environment variable for locating user
specific
help
volumes on local and/or remote nfs mounted systems.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>The environment variables contain colon-separated lists of directory paths.
Each directory path can contain both environment variable names as well as
special field descriptors that are expanded at runtime.
</Para>
<Para>Field descriptors consist of a percentage (<Literal>%</Literal>) symbol
followed by a single character.
Field descriptors and their substitution values are:
</Para>
<VariableList>
<VarListEntry>
<Term><Literal>%H</Literal></Term>
<ListItem>
<Para>This value is replaced with the current volume or family name being searched
for.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>%L</Literal></Term>
<ListItem>
<Para>Replaced with the current value of the
<SystemItem Class="EnvironVar">LANG</SystemItem> environment variable.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>%%</Literal></Term>
<ListItem>
<Para>Replaced with a single <Literal>%</Literal>.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>For example, given:
<Literal>DTHELPSEARCHPATH<Literal>="/etc/dt/appconfig/help/%L/%H.sdl"</Literal></Literal></Para>
<Para>The
<Command>dthelpgen</Command> utility looks for files ending with <Filename>.hf</Filename>
in the directory
<Filename>/etc/dt/appconfig/$LANG</Filename>. To find the volumes listed in each <Filename>.hf</Filename>
file,
<Command>dthelpgen</Command> looks in
<Literal>/etc/dt/help/appconfig/$LANG/%H.sdl</Literal> with <Literal>%H</Literal>
replaced with the name of the volume listed in the Family file.
</Para>
<Para>The
<Command>dthelpgen</Command> utility uses both
<Emphasis>DTHELPUSERSEARCHPATH</Emphasis> and
<Emphasis>DTHELPSEARCHPATH</Emphasis>. The default value for
<Emphasis>DTHELPUSERSEARCHPATH</Emphasis> is:
</Para>
<Para><Literal>$HOME/.dt/help/$DTUSERSESSION/%H:
$HOME/.dt/help/$DTUSERSESSION/%H.sdl:
$HOME/.dt/help/$DTUSERSESSION/%H.hv:
$HOME/.dt/help/%H:
$HOME/.dt/help/%H.sdl:
$HOME/.dt/help/%H.hv</Literal>
</Para>
<Para>The
<Emphasis>DTHELPUSERSEARCH</Emphasis> is first searched for the requested volume.
If the volume is not found, the
<Emphasis>DTHELPSEARCHPATH</Emphasis> value is searched.
</Para>
<Para>The default value for
<Emphasis>DTHELPSEARCHPATH</Emphasis> path is:
<Literal>/etc/dt/appconfig/help/%L/%H:
/etc/dt/appconfig/help/%L/%H.sdl:
/etc/dt/appconfig/help/%L/%H.hv:
/etc/dt/appconfig/help/C/%H:
/etc/dt/appconfig/help/C/%H.sdl:
/etc/dt/appconfig/help/C/%H.hv:
/usr/dt/appconfig/help/%L/%H:
/usr/dt/appconfig/help/%L/%H.sdl:
/usr/dt/appconfig/help/%L/%H.hv:
/usr/dt/appconfig/help/C/%H:
/usr/dt/appconfig/help/C/%H.sdl:
/usr/dt/appconfig/help/C/%H.hv</Literal></Para>
</RefSect1>
<RefSect1>
<Title>INPUT FILES</Title>
<Para>The following are input files used by
<Command>dthelpgen</Command>.</Para>
<VariableList>
<VarListEntry>
<Term><Literal>&lt;file>.hf</Literal></Term>
<ListItem>
<Para>runtime Help Family file, accessed directly by
<Command>dthelpgen</Command>.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>&lt;file>.sdl</Literal></Term>
<ListItem>
<Para>runtime Help volume file(s), accessed indirectly through explicit
references within the Help Family file.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>OUTPUT FILES</Title>
<Para>The following are descriptions of the output files generated by
<SystemItem Class="Constant">dthelpgen</SystemItem>.</Para>
<VariableList>
<VarListEntry>
<Term><Literal>browser.hv</Literal></Term>
<ListItem>
<Para>The master runtime browser Help volume file generated by
<Command>dthelpgen</Command>.</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>browser00.ht &amp; browser01.ht</Literal></Term>
<ListItem>
<Para>Runtime browser Help topic files generated by
<Command>dthelpgen</Command>.</Para>
</ListItem>
</VarListEntry>
</VariableList>
<RefSect2>
<Title>Warning Messages</Title>
<VariableList>
<VarListEntry>
<Term><Literal>Zero Volume files found</Literal></Term>
<ListItem>
<Para>Indicates that none of the volumes specified in the Family files are
registered in the system.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>Zero Family files found</Literal></Term>
<ListItem>
<Para>Indicates that no Family files are registered in the system.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect2>
<RefSect2>
<Title>Error Messages</Title>
<VariableList>
<VarListEntry>
<Term><Literal>Element of path is not a directory</Literal></Term>
<ListItem>
<Para>Indicates that some part of the path is not a directory.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>Access denied for directory path.</Literal></Term>
<ListItem>
<Para>Try running as super user?"
Indicates that some part of path does not allow the caller read,
access or write permission.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>Element of path does not exist</Literal></Term>
<ListItem>
<Para>Indicates that some element of path does not exist or is misspelled.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>File system containing path is full</Literal></Term>
<ListItem>
<Para>Indicates that the disc containing the path does not contain any space
or inodes.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>Unable to access path - error status number value</Literal></Term>
<ListItem>
<Para>Indicates that there is an access problem of type
<Symbol Role="Variable">value</Symbol> occurred with path.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>File system containing path is read only</Literal></Term>
<ListItem>
<Para>Indicates that the disc containing the path is mounted read-only.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>Requires root permission to write to path</Literal></Term>
<ListItem>
<Para>Indicates that some part of the path does not allow the user write
permission.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>Write to volume invalid</Literal></Term>
<ListItem>
<Para>Indicates that volume does not have the correct write permissions
for the caller.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>Search Path empty</Literal></Term>
<ListItem>
<Para>Indicates that the environment variables.
<Emphasis>DTHELPUSERSEARCHPATH</Emphasis> and/or
<Emphasis>DTHELPSEARCHPATH</Emphasis> were declared but no paths were specified in the variables.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>`title' resource missing</Literal></Term>
<ListItem>
<Para>Indicates that the title resource in a Family file is missing.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>`abstract' resource missing</Literal></Term>
<ListItem>
<Para>Indicates that the abstract resource in a Family file is missing.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>`volumes' resource missing</Literal></Term>
<ListItem>
<Para>Indicates that the volumes resource in a Family file is missing.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>`character' set resource missing</Literal></Term>
<ListItem>
<Para>Indicates that the CharSet resource in a Family file is missing.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>Unable to access current working directory - error status number value</Literal></Term>
<ListItem>
<Para>Indicates that the &minus;dir option was specified with a relative path and that
<Command>dthelpgen</Command> is unable to get the current working directory.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>Unable to allocate memory</Literal></Term>
<ListItem>
<Para>System resources are used up, no available memory,
<Command>dthelpgen</Command> aborts execution.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>Destination directory missing</Literal></Term>
<ListItem>
<Para>Missing
<Emphasis>directory</Emphasis> value for
<Literal>&minus;dir</Literal> option.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>Invalid system language specified</Literal></Term>
<ListItem>
<Para>Non-supported value used with the
<Literal>&minus;lang</Literal> option.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect2>
</RefSect1>
<RefSect1>
<Title>EXAMPLES</Title>
<VariableList>
<VarListEntry>
<Term><Literal>dthelpgen &minus;dir $HOME/.dt/help</Literal></Term>
<ListItem>
<Para>Creates, if required, a new
browser
help volume in the users home directory under <Literal>.dt/help/</Literal>.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>dthelpview &minus;dir $HOME/.dt/help -generate</Literal></Term>
<ListItem>
<Para>Forces the creation of a new
browser
help volume and places it in the users home directory under <Literal>.dt/help/</Literal>.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dthelpview;, &cdeman.dtsearchpath;, &cdeman.dthffile;, <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-->

1192
cde/doc/C/guides/man/man1_dt/helpprin.sgm Normal file
View File

File diff suppressed because it is too large Load Diff

544
cde/doc/C/guides/man/man1_dt/helptag.sgm Normal file
View File

@@ -0,0 +1,544 @@
<!-- $XConsortium: helptag.sgm /main/9 1996/09/08 19:53:04 rws $ -->
<!-- (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.MAN22.rsml.1">
<RefMeta>
<RefEntryTitle>dthelptag</RefEntryTitle>
<ManVolNum>user cmd</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Command>dthelptag</Command></RefName>
<RefPurpose>compile CDE Help source documents into runtime Help volumes
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<CmdSynopsis>
<Command>dthelptag</Command>
<Arg Choice="opt">options</Arg>
<Arg><Replaceable>file</Replaceable></Arg>
<Arg Choice="opt"><Replaceable>parser&minus;options</Replaceable></Arg>
</CmdSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<note>
<para>This utility has been superseded by the <command>dtdocbook</command> utility,
which converts source documents that conform to the DocBook 2.2.1 DTD
(Document Type Definition) subelement PART to documents
that conform to the SDL 1.2 DTD. The converted DocBook documents
are readable by the DtHelp viewer.
</para>
</note>
<Para>The
<Command>dthelptag</Command> utility is the CDE Help System compiler for translating
HelpTag source markup into the online distribution format suitable for
runtime display.
See the <Emphasis>CDE Help System Author's and Programmer's
Guide</Emphasis> for a description of the HelpTag markup language.
See
&cdeman.dthelpview; for more information on
previewing compiled Help volumes.
</Para>
<Para>The
<Command>dthelptag</Command> utility accepts a single file name as an argument.
If the file name
contains a period (``.''), any characters after the last period are
considered to be the extension.
The
<Command>dthelptag</Command> utility removes all characters after the last period and uses the
resulting name as the base name for all intermediate files and for the
final output files.
</Para>
<Para>If the <Symbol Role="Variable">file</Symbol>
argument has no periods,
<Command>dthelptag</Command> uses the argument as the base name for intermediate and output files
and assumes an extension of <Filename>.htg</Filename>, <Filename>.ctg</Filename> or <Filename>.sdl</Filename>
for the input file.
The <Filename>.ctg</Filename>
extension is assumed when the <Literal>&minus;formal</Literal>
option described below is used.
The <Filename>.sdl</Filename>
extension is assumed when the <Literal>&minus;compress</Literal>
or <Literal>&minus;decompress</Literal>
option (described later in this document) is used.
</Para>
<Para>Several options to
<Command>dthelptag</Command> may precede the file name.
Several arguments directing the
parsing phase of the
<Command>dthelptag</Command> process may follow the file name.
</Para>
<Para>The output file is:
<Symbol Role="Variable">file</Symbol>.sdl &minus; the compiled help volume file.
</Para>
</RefSect1>
<RefSect1>
<Title>OPTIONS</Title>
<Para>The following options are available:
</Para>
<VariableList>
<VarListEntry>
<Term><Literal>&minus;verbose</Literal></Term>
<ListItem>
<Para>The <Literal>&minus;verbose</Literal>
option will cause
<Command>dthelptag</Command> to generate and display parser messages during processing.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>&minus;formal</Literal></Term>
<ListItem>
<Para>The <Literal>&minus;formal</Literal>
option causes
<Command>dthelptag</Command> to accept a subset of the HelpTag language that is strictly compliant
to canonical SGML.
(See the <Emphasis>CDE Help System Author's and Programmer's
Guide</Emphasis>.)
When this option is given, the default extension of the
input file becomes <Filename>.ctg</Filename>.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>&minus;nooptimize</Literal></Term>
<ListItem>
<Para>The <Literal>&minus;nooptimize</Literal>
option eliminates certain optimizations that normally take place
during translation of HelpTag markup to the runtime format.
Using
this option speeds the translation process.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>&minus;clean</Literal></Term>
<ListItem>
<Para>The <Literal>&minus;clean</Literal>
option causes
<Command>dthelptag</Command> to simply remove any intermediate files from the current directory.
No translation takes place.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>&minus;debug</Literal></Term>
<ListItem>
<Para>The <Literal>&minus;debug</Literal>
option causes
<Command>dthelptag</Command> to leave all intermediate files in the current directory.
The <Literal>&minus;debug</Literal>
option also blocks the compression step of
<Command>dthelptag</Command>, leaving the resulting <Filename>.sdl</Filename>
output file in a human-readable form.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>&minus;files</Literal></Term>
<ListItem>
<Para>The <Literal>&minus;files</Literal>
option causes a list of files referenced in the translation process to
be emitted to the standard output.
No translation takes place.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>&minus;help</Literal></Term>
<ListItem>
<Para>The <Literal>&minus;help</Literal> option causes
<Command>dthelptag</Command> to emit a synopsis of the
<Command>dthelptag</Command> command line and a list of options to the standard output.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>&minus;decompress</Literal></Term>
<ListItem>
<Para>The <Literal>&minus;decompress</Literal>
option causes
<Command>dthelptag</Command> to decompress a previously created <Filename>.sdl</Filename>
file.
When this option is specified, the default input extension is <Filename>.sdl</Filename>.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>&minus;compress</Literal></Term>
<ListItem>
<Para>The <Literal>&minus;compress</Literal>
option causes
<Command>dthelptag</Command> to compress a <Filename>.sdl</Filename>
file that either was created by translating a <Filename>.htg</Filename>
or <Filename>.ctg</Filename>
file using the <Literal>&minus;debug</Literal>
option or was previously decompressed using the <Literal>&minus;decompress</Literal>
option.
When this option is specified, the default input extension is <Filename>.sdl</Filename>.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<RefSect2>
<Title>Parser Options</Title>
<Para>Any <Emphasis>parser options</Emphasis>
follow the <Symbol Role="Variable">file</Symbol>
argument on the command line and take the form
<Literal>option=value</Literal>
for those options taking an argument and simply <Literal>option</Literal>
for those options not taking an argument.
Parser options may also be set in the environment variable
<SystemItem Class="EnvironVar">DTTAGOPT</SystemItem>, in a
<Literal>helptag.opt</Literal>
file or in a file named
<Literal>file</Literal><Filename>.opt</Filename>
in the current directory.
The <Literal>helptag.opt</Literal>
file may reside in the current directory or in the directory in which
<Command>dthelptag</Command> is placed.
</Para>
<Para>The order of precedence of the option settings is:
</Para>
<ItemizedList>
<ListItem>
<Para>The file
<Literal>helptag.opt</Literal> in the
<Command>dthelptag</Command> installation directory.
This directory defaults to
<Filename>/usr/dt/bin.</Filename></Para>
</ListItem>
<ListItem>
<Para>The environment variable <SystemItem Class="EnvironVar">DTTAGOPT</SystemItem>.
</Para>
</ListItem>
<ListItem>
<Para>The file
<Literal>helptag.opt</Literal> in the current directory.
</Para>
</ListItem>
<ListItem>
<Para>The file <Symbol Role="Variable">file</Symbol><Filename>.opt</Filename>
in the current directory.
</Para>
</ListItem>
<ListItem>
<Para>The command line.
</Para>
</ListItem>
</ItemizedList>
<Para>Parser options set later in the list override options set earlier.
</Para>
<Para>The parser options supported by
<Command>dthelptag</Command> are:
</Para>
<VariableList>
<VarListEntry>
<Term><Literal>onerror=go</Literal></Term>
<ListItem>
<Para>Cause errors to be non-fatal.
That is, parsing continues and later
phases of the
<Command>dthelptag</Command> process are run even if syntax errors were encountered.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>onerror=stop</Literal></Term>
<ListItem>
<Para>This is the default setting of the <Literal>onerror=</Literal> option.
It causes the
<Command>dthelptag</Command> process to stop upon completion of the parser phase if syntax errors were
encountered during the parse.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>charset=name</Literal></Term>
<ListItem>
<Para>The default character set used by the
help system is ISO8859-1.
A different character set may be specified, for example,
<Literal>name</Literal>,
using the <Literal>charset=</Literal> option.
The character set may also be set in the <Literal>helplang.ent</Literal>
file described in the <Emphasis>CDE Help System Author's and Programmer's Guide</Emphasis>.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>search=path</Literal></Term>
<ListItem>
<Para>Specifies one or more directory <Literal>path(s)</Literal>
to be searched when executing
<Command>dthelptag</Command>. Both
<Command>dthelptag</Command> input files and/or additional graphics or entity declaration
files referenced within the HelpTag markup can be made accessible by setting
this option.
The <Literal>search=</Literal>
option may be specified more that once and the list of directories to
search is accumulated.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>clearsearch</Literal></Term>
<ListItem>
<Para>Clears the list of directories searched for file and
image entities.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>memo</Literal></Term>
<ListItem>
<Para>The <Literal>memo</Literal>
option causes authors' comments to be included in the output.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>nomemo</Literal></Term>
<ListItem>
<Para>Specifies the inverse of the <Literal>memo</Literal>
option.
Both <Literal>memo</Literal>
and <Literal>nomemo</Literal>
may be specified, but the last entry will override any previous setting.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>shortfiles</Literal></Term>
<ListItem>
<Para>Neither the <Literal>shortfiles</Literal> <Emphasis>parser-option</Emphasis>
nor any of its synonyms should be used.
Rather, the <Literal>&minus;shortfiles</Literal>
option should be given as an <Emphasis>option</Emphasis>
to
<Command>dthelptag</Command>. The
<Command>dthelptag</Command> driver needs to know whether the user has requested short file names since
<Command>dthelptag</Command> must know the names of the intermediate files.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>shortfile</Literal></Term>
<ListItem>
<Para>This is a synonym for <Literal>shortfiles</Literal>.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><StructName Role="typedef">short</StructName></Term>
<ListItem>
<Para>This is a synonym for <Literal>shortfiles</Literal>.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>longfiles</Literal></Term>
<ListItem>
<Para>This option and any of its synonyms should not be used for the same
reason that the <Literal>shortfiles</Literal>
option should not be used.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>longfiles</Literal></Term>
<ListItem>
<Para>Long, untruncated file names are the default.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>longfile</Literal></Term>
<ListItem>
<Para>This is a synonym for <Literal>longfiles</Literal>.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><StructName Role="typedef">long</StructName></Term>
<ListItem>
<Para>This is a synonym for <Literal>longfiles</Literal>.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect2>
</RefSect1>
<RefSect1>
<Title>ENVIRONMENT VARIABLES</Title>
<Para><SystemItem Class="EnvironVar">LANG</SystemItem> determines the language in which the input
<Symbol Role="Variable">file</Symbol> is interpreted.
The
<SystemItem Class="EnvironVar">LANG</SystemItem> environment variable can be overridden in the
<Literal>helplang.ent</Literal>
file described in the <Emphasis>CDE Help System Author's and Programmer's Guide</Emphasis>.
</Para>
<Para><SystemItem Class="EnvironVar">DTTAGOPT</SystemItem> may be used to set parser options.
</Para>
<RefSect2>
<Title>International Code Set Support</Title>
<Para>Single- and multi-byte character code sets are supported.
</Para>
</RefSect2>
</RefSect1>
<RefSect1>
<Title>INPUT FILES</Title>
<Para>Following are the input files used by the
<Command>dthelptag</Command> parser:
</Para>
<VariableList>
<VarListEntry>
<Term><Filename>file.htg</Filename></Term>
<ListItem>
<Para>Default input file.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>file.ctg</Literal></Term>
<ListItem>
<Para>Default input file when the <Literal>&minus;formal</Literal>
option has been specified.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>file.st</Literal></Term>
<ListItem>
<Para>Status file and log.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>helplang.ent</Literal></Term>
<ListItem>
<Para>Character set information and localizable replacement text.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>helptag.opt</Literal></Term>
<ListItem>
<Para>Option file.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>OUTPUT FILES</Title>
<Para>Following are the input files used by the
<Command>dthelptag</Command> parser:
</Para>
<VariableList>
<VarListEntry>
<Term><Filename>file.sdl</Filename></Term>
<ListItem>
<Para>Runtime help volume
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>file.err</Literal></Term>
<ListItem>
<Para>Run log and error listing
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>EXTENDED DESCRIPTION</Title>
<Para>The
<Command>dthelptag</Command> utility is a driver program that executes two phases of the
compilation process.
The first phase translates the source markup
into the distribution format.
The second phase enhances the
distribution file by precomputing information such as a list of
identifiers in the file and their locations.
These precomputations,
along with several optimizations, enable rapid runtime display of
the file.
The second phase of the translation process also compresses
the distribution file to reduce file system space required to store
the file.
</Para>
</RefSect1>
<RefSect1>
<Title>EXIT STATUS</Title>
<Para>The following exit values are returned:
</Para>
<VariableList>
<VarListEntry>
<Term>0</Term>
<ListItem>
<Para>Successful completion.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>1</Term>
<ListItem>
<Para>An error was detected in the source file.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>2</Term>
<ListItem>
<Para>An invocation error was detected.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>CONSEQUENCES OF ERRORS</Title>
<Para>Default.
</Para>
</RefSect1>
<RefSect1>
<Title>EXAMPLES</Title>
<VariableList>
<VarListEntry>
<Term><Literal>dthelptag -clean myFile.htg</Literal></Term>
<ListItem>
<Para>Remove all files previously generated by processing a source file
of <Filename>myFile.htg</Filename>.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>dthelptag myFile.htg onerror=go</Literal></Term>
<ListItem>
<Para>Process the file <Filename>myFile.htg</Filename>, not stopping even if there are syntax errors.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>dthelptag myFile.htg</Literal></Term>
<ListItem>
<Para>Process the file <Filename>myFile.htg</Filename>.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dthelpview;, <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-->

245
cde/doc/C/guides/man/man1_dt/helpview.sgm Normal file
View File

@@ -0,0 +1,245 @@
<!-- $XConsortium: helpview.sgm /main/8 1996/09/08 19:53:13 rws $ -->
<!-- (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.MAN23.rsml.1">
<RefMeta>
<RefEntryTitle>dthelpview</RefEntryTitle>
<ManVolNum>user cmd</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Command>dthelpview</Command></RefName>
<RefPurpose>view a CDE help volume
</RefPurpose>
</RefNameDiv>
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- *************************************************************************-->
<!-- ** (c) Copyright 1993, 1994 Hewlett-Packard Company-->
<!-- ** (c) Copyright 1993, 1994 International Business Machines Corp.-->
<!-- ** (c) Copyright 1993, 1994 Sun Microsystems, Inc.-->
<!-- ** (c) Copyright 1993, 1994 Novell, Inc.-->
<!-- *************************************************************************-->
<RefSynopsisDiv>
<CmdSynopsis>
<Command>dthelpview</Command>
<Arg Choice="opt"><Replaceable>options</Replaceable></Arg>
</CmdSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Command>dthelpview</Command> utility supports the viewing of CDE online Help volumes, ASCII files
or manual pages.
The
<Command>dthelpview</Command> utility is an integral part of the CDE application Help
environment.
The
<Command>dthelpview</Command> utility's functionality and user interface is almost completely that
of the standard CDE general Help and quick Help dialog widgets.
(See
&cdeman.DtCreateHelpDialog; and
&cdeman.DtCreateHelpQuickDialog;.)</Para>
</RefSect1>
<RefSect1>
<Title>OPTIONS</Title>
<Para>The following options are available:
</Para>
<VariableList>
<VarListEntry>
<Term><Literal>&minus;helpVolume</Literal> <Emphasis>volume</Emphasis></Term>
<ListItem>
<Para>Specifies the name of the <Literal>&lt;filename>.sdl</Literal> file you want to
view.
If <Literal>locationId</Literal> is not set, the default <Symbol>_HOMETOPIC</Symbol> ID is used.
If the requested volume is in the current working directory, or the Help volume
has been properly registered, no path is required.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>&minus;locationId</Literal> <Emphasis>location_id</Emphasis></Term>
<ListItem>
<Para>Specifies the location ID representing the desired Help topic to be viewed.
By default, Helpview uses <Symbol>_HOMETOPIC</Symbol> if an ID is not specified.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>&minus;file</Literal> <Symbol Role="Variable">file</Symbol></Term>
<ListItem>
<Para>Specifies a particular ASCII text file to be displayed.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>&minus;manPage</Literal> <Emphasis>man_page</Emphasis></Term>
<ListItem>
<Para>Specifies a particular man page to be displayed.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>&minus;man</Literal></Term>
<ListItem>
<Para>Displays a dialog that prompts for a man page to view,
then displays the requested man page.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>ENVIRONMENT VARIABLES</Title>
<Para>The CDE Help system uses two environment variables for locating
Help volumes and Family 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 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 remote nfs mounted systems.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>The environment variables contain colon-separated lists of directory paths.
Each directory path can contain both environment variable names as well as
special field descriptors that are expanded at runtime via each Help component
that uses these environment variables.
</Para>
<Para>Field descriptors consist of a <Literal>%</Literal>
followed by a single character.
Field descriptors and their substitution values are:
</Para>
<VariableList>
<VarListEntry>
<Term><Literal>%H</Literal></Term>
<ListItem>
<Para>This value is replaced with the current volume name being searched
for.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>%L</Literal></Term>
<ListItem>
<Para>Replaced with the current value of the
<SystemItem Class="EnvironVar">LANG</SystemItem> environment variable.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>%%</Literal></Term>
<ListItem>
<Para>Replaced with a single <Literal>%</Literal>.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>The default value for
<Emphasis>DTHELPUSERSEARCHPATH</Emphasis> is:
</Para>
<Para><Literal>$HOME/.dt/help/$DTUSERSESSION/%H:
$HOME/.dt/help/$DTUSERSESSION/%H.sdl:
$HOME/.dt/help/$DTUSERSESSION/%H.hv:
$HOME/.dt/help/%H:
$HOME/.dt/help/%H.sdl:
$HOME/.dt/help/%H.hv</Literal></Para>
<Para>The
<Emphasis>DTHELPUSERSEARCH</Emphasis> is first searched for the requested volume.
If
the volume is not found, the
<Emphasis>DTHELPSEARCHPATH</Emphasis> value is searched.
</Para>
<Para>The default value for <Emphasis>DTHELPSEARCHPATH</Emphasis> path is:
<Literal>/etc/dt/appconfig/help/%L/%H:
/etc/dt/appconfig/help/%L/%H.sdl:
/etc/dt/appconfig/help/%L/%H.hv:
/etc/dt/appconfig/help/C/%H:
/etc/dt/appconfig/help/C/%H.sdl:
/etc/dt/appconfig/help/C/%H.hv:
/usr/dt/appconfig/help/%L/%H:
/usr/dt/appconfig/help/%L/%H.sdl:
/usr/dt/appconfig/help/%L/%H.hv:
/usr/dt/appconfig/help/C/%H:
/usr/dt/appconfig/help/C/%H.sdl:
/usr/dt/appconfig/help/C/%H.hv</Literal></Para>
</RefSect1>
<RefSect1>
<Title>RESOURCES</Title>
<Para>For information on Help dialog widget resources, refer to
&cdeman.DtCreateHelpDialog; or
&cdeman.DtCreateHelpQuickDialog;.</Para>
<Para>The
<Command>dthelpview</Command> utility's specific resources set in the Dthelpview app-defaults file are:
</Para>
<ProgramListing>Dthelpview*manBox*rows: 32
Dthelpview*manBox*columns: 80
Dthelpview*fileBox*rows: 32
Dthelpview*fileBox*columns: 80
Dthelpview*man_text.columns: 20
</ProgramListing>
</RefSect1>
<RefSect1>
<Title>FILE</Title>
<Para>Following files are used in conjunction with the
<Command>dthelpview</Command> application:
</Para>
<VariableList>
<VarListEntry>
<Term><Literal>Dthelpview</Literal></Term>
<ListItem>
<Para>App-defaults file used by
<Command>dthelpview</Command>.</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>EXAMPLES</Title>
<VariableList>
<VarListEntry>
<Term>dthelpview &minus;helpVolume dtintro.sdl &minus;locationId _hometopic</Term>
<ListItem>
<Para>Displays the topic associated with _hometopic in the Help
volume dtintor.sdl.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>dthelpview &minus;file /etc/checklist</Term>
<ListItem>
<Para>Displays the file /etc/checklist in a general Help dialog
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>dthelpview &minus;man grep</Term>
<ListItem>
<Para>Displays the grep man page in a quick Help dialog
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dtsearchpath;, <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-->

266
cde/doc/C/guides/man/man1_dt/huffcode.sgm Normal file
View File

@@ -0,0 +1,266 @@
<!-- $XConsortium: huffcode.sgm /main/7 1996/09/08 19:53:22 rws $ -->
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
<!-- (c) Copyright 1996 International Business Machines Corp. -->
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1996 Novell, Inc. -->
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
<!-- (c) Copyright 1996 Hitachi. -->
<![%CDE.C.CDE; [<refentry id="CDE.SEARCH.huffcode">]]>
<refmeta><refentrytitle>huffcode</refentrytitle><manvolnum>user cmd</manvolnum>
</refmeta>
<refnamediv><refname><command>huffcode</command></refname><refpurpose>
Create optimized DtSearch compression/decompression tables
</refpurpose></refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>huffcode</command>
<arg choice="opt"><group choice="plain">
<arg choice="plain">&minus;l<replaceable>lit_thresh</replaceable></arg>
<arg choice="plain">&minus;l&minus;</arg>
</group></arg>
<arg choice="opt">&minus;o</arg>
<arg choice="plain"><replaceable>huffile</replaceable></arg>
<arg choice="opt"><replaceable>textfile</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para><command>huffcode</command> creates optimized DtSearch
compression/decompression tables.
</para>
<para>Documents stored in a DtSearch database text repository can be first
compressed using a Huffman text compression algorithm. The algorithm
provides optimal compression only with preanalysis of the statistical
distribution of bytes in the database corpus.
<command>huffcode</command> analyses a text corpus and generates
DtSearch compression and decompression tables. It is provided as a
convenience utility for database developers who want to optimize offline
storage requirements. Compression is not used in databases created
without the ability to store text in a DtSearch repository.
</para>
<para><command>huffcode</command> reads a text file as input and writes out
<filename>ophuf.huf</filename> (compression or "encode" table) and
<filename>ophuf.c</filename> (decompression or "decode" table).
<filename>ophuf.huf</filename> is an external ascii file that also
retains the statistical information on how it was generated.
<command>huffcode</command> can be executed repeatedly against different
text samples, continually accumulating results. In the case of a small
or static text corpus, the entire corpus can be fed into
<command>huffcode</command> for optimal huffman compression. In large or
dynamic databases the typical practice is to feed
dynamic f representative text samples.
</para>
<para>The huffman code tables are created once for each API instance (not once
per database) before any documents are loaded. The only program to read
the encode table, an external file, is <command>dtsrload</command>. The
<filename>ophuf.huf</filename> file generated by
<command>huffcode</command> should be used instead of the provided
default file prior to the first run of <command>dtsrload</command> for
any databases to be accessed by a particular API instance. The decode
table, a C module, should be compiled and linked into the application
code ahead of the API library to override the default decode module in
the library. Huf files and decode modules are not user editable.
</para>
<refsect2>
<title>HCTREE_ID</title>
<para>It is imperative that the encode and decode tables reflect identical
byte statistics to prevent decode errors. The first line of
<filename>ophuf.huf</filename> includes a long integer value named
<Symbol>HCTREE_ID</Symbol>. Each execution of
<command>huffcode</command> generates a new, unique
<literal>hctree_id</literal> integer. <command>dtsrload</command> loads
this integer into the database configuration and status record when it
loads the first document into a new database. Thereafter, each execution
of <command>dtsrload</command> for that database confirms that the same
<literal>hctree_id</literal> is used for each document compression. It
will abort if the <filename>ophuf.huf</filename>
<literal>hctree_id</literal> does not match the value for a database
from previous executions.
</para>
<para><literal>hctree_id</literal> is also stored as a variable in the decode
module <filename>ophuf.c</filename>. <function>DtSearchInit</function>
will not open any database listed in the ocf file whose
<literal>hctree_id</literal>, as stored in its configuration and status
record, does not match the value in the decode module. The
<command>dtsrdbrec</command> utility will print the
<literal>hctree_id</literal> value for any database.
</para>
</refsect2>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<para>The following options are available:</para>
<note>
<para>If an option takes a value, the value must be directly appended to
the option name without white space.</para>
</note>
<variablelist>
<varlistentry><term><literal>&minus;l</literal><Symbol Role="Variable">lit_thresh</Symbol></term>
<listitem>
<para>Sets the literal character's minimum threshold to the integer specified
by <Symbol Role="Variable">lit_thresh</Symbol>.
</para>
<para>This Huffman algorithm implements a pseudo-character called the literal
character. It represents all characters whose frequency is so low that
no huffman translation will be attempted. This reduces the maximum
length of the coded bit string when there are lots of zero- or
low-frequency bytes in the text corpus. For example, pure ASCII text
files only occasionally have byte values less than 32 (control
characters) and rarely greater than 127 (high order bit turned on). The
<Symbol Role="Variable">lit_thresh</Symbol> value specifies the literal
character's threshold count. After counting is completed, any character
in the encode table occurring with frequency less than or equal to
<Symbol Role="Variable">lit_thresh</Symbol> will be coded with the
literal character.
</para>
<para>If this option and the <literal>&minus;l&minus;</literal> option are
omitted, the default is <literal>&minus;l0</literal>, meaning that
literal coding is provided only for bytes that never occur (counts of
zero).
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;l&minus;</literal></term>
<listitem>
<para>Disables literal character encoding. Disabling literal character
encoding in corpa with unbalanced byte frequency distributions will lead
to extremely long bit string codes. Most natural language text corpa
are represented by highly unbalanced frequency distributions so this
option is not recommended for most DtSearch applications.
</para>
<para>If this option and the <literal>&minus;l</literal><Symbol Role="Variable">lit_thresh</Symbol> option are omitted, the default is
<literal>&minus;l0</literal>, meaning that literal coding is provided
only for bytes that never occur (counts of zero).
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;o</literal></term>
<listitem>
<para>Suppresses the overwrite prompt. It preauthorizes erasure and
reinitialization of the decode module.
</para>
</listitem>
</varlistentry>
<varlistentry><term><Symbol Role="Variable">textfile</Symbol></term>
<listitem>
<para>Specifies an optional input file of text that is representative of the
entire text corpus of the databases. It should contain bytes in the same
relative abundances as occur in documents in the entire corpus. Since
<command>huffcode</command> can be executed repeatedly with different
document <Symbol Role="Variable">textfile</Symbol>s, it is possible to
analyze the entire actual corpus if it is small enough or static.
</para>
<para>If <Symbol Role="Variable">textfile</Symbol> is not specified, the byte
frequencies in the currently loaded tables are not changed, and the
huffman codes are recomputed with the existing frequencies. This is
useful for examining the relative merits of using different literal
character thresholds.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>OPERANDS</title>
<para>The required input file name (<Symbol Role="Variable">huffile</Symbol>)
is the base file name of the encode table, excluding the
<Filename>.huf</Filename> extension. <command>dtsrload</command> expects
<Symbol Role="Variable">huffile</Symbol> to be
<filename>ophuf</filename>. Similarly, the decode module will be named
<Symbol Role="Variable">huffile</Symbol>.c.
</para>
<para>At the beginning of each new execution, <command>huffcode</command>
tries to open the encode table file and continue byte frequency counting
from the last run. If the huf file represented by
<Symbol Role="Variable">huffile</Symbol> does not exist, the table's counts are
initialized to zeroes. The decode module is recomputed fresh each run,
whether it existed before or not.
</para>
</refsect1>
<refsect1>
<title>ENVIRONMENT VARIABLES</title>
<para>None.</para>
</refsect1>
<refsect1>
<title>RESOURCES</title>
<para>None.</para>
</refsect1>
<refsect1>
<title>ACTIONS/MESSAGES</title>
<para>None.</para>
</refsect1>
<refsect1>
<title>RETURN VALUES</title>
<para>The return values are as follows:</para>
<variablelist>
<varlistentry><term>0</term>
<listitem>
<para><command>huffcode</command> completed successfully.</para>
</listitem>
</varlistentry>
<varlistentry><term>nonzero</term>
<listitem>
<para><command>huffcode</command> encountered an error.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>FILES</title>
<para><command>huffcode</command> reads the specified
<Symbol Role="Variable">huffile</Symbol>. It also reads
<Symbol Role="Variable">textfile</Symbol> if it is
specified.
It writes to
<Symbol Role="Variable">huffile</Symbol>.huf and
<Symbol Role="Variable">huffile</Symbol>.c.
</para>
</refsect1>
<refsect1>
<title>EXAMPLES</title>
<para>Read <filename>ophuf.huf</filename> if it exists and initialize the
internal byte count table with its byte frequency counts. If
<filename>ophuf.huf</filename> does not exist, the internal byte counts
will be initialized to zeros. The encoding table in the original huf
file will be discarded. The text file <filename>foo.txt</filename> will
be read and its individual byte frequencies added to the internal byte
count table. Then, <filename>ophuf.huf</filename> will be written out,
with an encoding scheme based on the current byte counts, and with a
literal character encoding all bytes that have zero frequency. Finally,
if the decode module <filename>ophuf.c</filename> already exists, a
prompt requesting permission to overwrite it will be output to stdout
and, if an affirmative response is read from stdin, a new version
corresponding to the new <filename>ophuf.huf</filename> will be written
out.
</para>
<programlisting>
huffcode ophuf foo.txt
</programlisting>
<para>Read <filename>myappl.huf</filename> and initialize the internal byte
count table with its byte frequency counts. Since no
<filename>textfile</filename> argument is specified, the only possible
action is to build different coding tables using existing frequency
counts in <filename>myappl.huf</filename>. The new tables will be based
on a literal character implementation where only bytes that occur more
than 200 times will be given an encoding; all other bytes will be
encoded with the literal character. After new encoding tables are
generated <filename>myappl.huf</filename> will be written out. The
decode module <filename>myappl.c</filename> will also be written out
without prompting whether it preexists or not.
</para>
<programlisting>
huffcode -l200 -o myappl
</programlisting>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>&cdeman.dtsrcreate;,
&cdeman.dtsrdbrec;,
&cdeman.dtsrload;,
&cdeman.DtSrAPI;,
&cdeman.DtSearch;
</para>
</refsect1>
</refentry>

213
cde/doc/C/guides/man/man1_dt/icon.sgm Normal file
View File

@@ -0,0 +1,213 @@
<!-- $XConsortium: icon.sgm /main/7 1996/09/08 19:53:31 rws $ -->
<!-- (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.MAN24.rsml.1" Remap="">
<RefMeta>
<RefEntryTitle>dticon</RefEntryTitle>
<ManVolNum>user cmd</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Command>dticon</Command></RefName>
<RefPurpose>the Common Desktop Environment Icon Editor
</RefPurpose>
</RefNameDiv>
<!--- -->
<!-- (c) Copyright 1993, 1994 Hewlett-Packard Company-->
<!-- (c) Copyright 1993, 1994 International Business Machines Corp.-->
<!-- (c) Copyright 1993, 1994 Sun Microsystems, Inc.-->
<!-- (c) Copyright 1993, 1994 Novell, Inc.-->
<!--- -->
<RefSynopsisDiv>
<CmdSynopsis>
<Command>dticon</Command>
<Arg Choice="opt">options</Arg>
</CmdSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The Icon Editor provides the facilities that enable the user to create
new icons or modify existing ones.
</Para>
<Para>The Icon Editor uses lines and geometric shape drawing tools in order
to create new icons or modify existing ones. It support XPM and XBM
formats. The Icon Editor, also is capable of grabbing images from the
display and use them as bases for new icons.
</Para>
<Para>The Icon Editor, also, supports drag and drop, allowing the user to
drag an icon file from the file manager onto the Icon Editor window or
icon.
</Para>
<RefSect2>
<Title>Key Supported Tasks</Title>
<!--Start of RS / RE range-->
<Para>- Modify size of window.
</Para>
<Para>- Modify location of window.
</Para>
<Para>- Iconify window.
</Para>
<Para>- Edit a new or existing icon.
</Para>
<Para>- Save the current icon
</Para>
<Para>- Undo the last operation.
</Para>
<Para>- Cut, copy, and paste areas within the Icon Editor drawing tablet.
</Para>
<Para>- Grab images from the display.
</Para>
<Para>- Rotate selected area.
</Para>
<Para>- Scale selected area.
</Para>
<Para>- Flip selected area right or left.
</Para>
<Para>- Resize icon.
</Para>
<Para>- Add a hot spot to the icon.
</Para>
<Para>- Delete a hot spot from icon.
</Para>
<Para>- Clear icon.
</Para>
<Para>- Overlay the icon drawing area with a visible grid.
</Para>
<Para>- Select icon format, XPM or XBM.
</Para>
<Para>- Alter the magnification factor for the drawing tablet.
</Para>
<!--End of RS / RE range-->
<Para>The Icon Editor accepts all of the standard X Toolkit/Widget command
line options. Additional application specific options are listed
below.
</Para>
</RefSect2>
</RefSect1>
<RefSect1>
<Title>OPTIONS</Title>
<Para>The following options are available from the command line:
</Para>
<Para><Literal>&minus;f</Literal> <Emphasis>file</Emphasis></Para>
<Para>This option takes a bitmap or pixmap file name.
If the file ends in .pm or .xpm suffix, it will try reading it as an XPM
file first. If it fails, it will try reading it as an XBM file.
If the file ends in .bm or .xbm suffix, it will try reading it as an XBM
file first. If it fails, it will try reading it as an XPM file.
If the file doesn't match any of these suffixes, it will try reading it
as an XPM file first. If it fails it will try reading it as an XBM file.
</Para>
<Para><Literal>&minus;x</Literal> <Emphasis>widthxheight</Emphasis></Para>
<Para>This option specifies an initial geometry for the icon image. If a
file is specified using the -f option, the size of that icon
supersedes the geometry specified.
</Para>
<Para><Literal>&minus;session</Literal> <Emphasis>file</Emphasis></Para>
<Para>This option takes the name of a session file as an additional
parameter. The Icon Editor is invoked with the specified session file
name. The session file is a file that was previously saved by the Icon
Editor through a session shutdown. This option causes all other
command line options to be ignored, as all settings are taken from the
specified session file.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN</Title>
<Para>Exit values are:
</Para>
<VariableList>
<VarListEntry>
<Term>0</Term>
<ListItem>
<Para>Successful completion.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>>0</Term>
<ListItem>
<Para>Error condition occurred.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>EXAMPLES</Title>
<VariableList>
<VarListEntry>
<Term>dticon -x 24x32</Term>
<ListItem>
<Para>Starts the Icon Editor with an icon template
of width 24 and height 32.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>dticon</Title>
<Para>[Using Tooltalk to integrate dticon in your applications]
Tooltalk makes it possible to use dticon from within your application.
dticon supports the following Tooltalk messages: start, edit, quit.
An application can construct a Tooltalk message, which will include a
buffer containing the icon the application wishes to edit. The format
of the message appears in dticon's ptype file( dticon.ptype). The buffer
in the edit message is constructed to contain the icon contents of an XPM
or an XBM icon file. In the case of an XBM icon containing transparent regions
dticon generates two icon files, an XBM file containing the base icon(
the icon without the transparent regions) and a mask file that indicates
the transparent regions in the icon. The buffer in this case must include
both icon files double buffered, the base icon first and then the mask, both
in the same buffer.
</Para>
<VariableList>
<VarListEntry>
<Term>NOTE:</Term>
<ListItem>
<Para>An application may pass a buffer to dticon containing an XPM icon and
get back a double buffer containing an XBM icon and its mask, and vise versa.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>Suggested</Title>
<Para>- The Common Desktop Environment: ToolTalk Messaging Overview
- The Common Desktop Environment: Programmer's Guide
</Para>
</RefSect1>
<RefSect1>
<Title>RESOURCES</Title>
<VariableList>
<VarListEntry>
<Term>-useFileFilter</Term>
<ListItem>
<Para>This resource instructs the Icon Editor to use the file filter feature
in OPEN and SAVE dialogs.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>FILES</Title>
<Para>Files used by this component.
</Para>
<VariableList>
<VarListEntry>
<Term><Filename>/.../dt/app-defaults/C/Dticon</Filename></Term>
<ListItem>
<Para>App-defaults file.</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.3 08/21/95 21:30:04-->

558
cde/doc/C/guides/man/man1_dt/imsstart.sgm Normal file
View File

@@ -0,0 +1,558 @@
<!-- $XConsortium: imsstart.sgm /main/8 1996/09/08 19:53:40 rws $ -->
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
<!-- (c) Copyright 1996 International Business Machines Corp. -->
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1996 Novell, Inc. -->
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
<!-- (c) Copyright 1996 Hitachi. -->
<![ %CDE.C.CDE; [<refentry id="cde.IMS.dtimsstart">]]>
<refmeta><refentrytitle>dtimsstart</refentrytitle><manvolnum>user cmd</manvolnum>
</refmeta>
<refnamediv><refname><command>dtimsstart</command></refname><refpurpose>launches
an input method server</refpurpose></refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>dtimsstart</command><arg choice="opt">&minus;env</arg><arg choice="opt">&minus;ims <replaceable>name</replaceable></arg><arg choice="opt">&minus;shell <replaceable>name</replaceable></arg><arg choice="opt">&minus;host <replaceable>hostname</replaceable></arg><arg choice="opt">&minus;imsopt <replaceable>options</replaceable></arg>
<arg choice="opt">&minus;list</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>The <command>dtimsstart</command> command launches an IMS (Input Method
Server). <command>dtimsstart</command> is normally invoked automatically
at Xsession startup (user login) by the script <filename>/usr/dt/config/Xsession.d/0020.dtims</filename>.</para>
<para>Depending on the currently selected locale, environment variables,
configuration files, and command-line options, <command>dtimsstart</command>
displays a selection window from which you can select the IMS you want to
use. Once you select the IMS, <command>dtimsstart</command> starts it and
waits until the IMS completes its startup. This is to ensure that applications
wishing to connect to the IMS can do so. <command>dtimsstart</command> then
sets the <Symbol>XMODIFIERS</Symbol> environment variable to ensure that
clients can connect to the selected IMS. Finally, <command>dtimsstart</command>
exits.</para>
<para>Once you select an IMS from the selection window, <command>dtimsstart</command> saves the selection in the IMS Selection File. To have <command>dtimsstart</command> automatically start the previously selected IMS, set
the IMS Selection Mode to <literal>resume-current-input-method</literal>.
You access the IMS Selection Mode by executing the <Symbol>DtImsMode</Symbol>
action located in <literal>Desktop_Tools</literal> in the Application Manager.
</para>
<para>For IMS Selection Mode, you can choose:</para>
<variablelist>
<varlistentry><term><literal>ask-at-login</literal></term>
<listitem>
<para>Instructs <command>dtimsstart</command> to display the selection window
and prompt you for an IMS each time it is invoked.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>resume-current-input-method</literal></term>
<listitem>
<para>Instructs <command>dtimsstart</command> to automatically start the last
selected IMS by using the saved IMS Selection File and without displaying
the selection window.</para>
</listitem>
</varlistentry>
</variablelist>
<refsect2>
<title>Remote Execution of IMS</title>
<para>If you use the <literal>&minus;host</literal> option to have <command>dtimsstart</command> start an IMS on a remote host, <command>dtimsstart</command>
does the following:</para>
<itemizedlist><listitem><para>Executes the <Symbol>DtImsGetRemoteConf</Symbol>
action to retrieve IMS configuration data from the specified remote system
</para>
</listitem><listitem><para>Lists the IMSs registered on the remote system
in the selection window</para>
</listitem><listitem><para>Executes the <Symbol>DtImsRunRemoteIms</Symbol>
action to start the selected IMS on the remote system.</para>
</listitem></itemizedlist>
<para>For more information on configuring remote execution, refer to
the <emphasis>Common
Desktop Environment: Advanced User's and System Administrator's Guide</emphasis>.
</para>
</refsect2>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<para>The following options are available:</para>
<variablelist>
<varlistentry><term><literal>&minus;env</literal></term>
<listitem>
<para>Outputs the contents of the <Symbol>XMODIFIERS</Symbol> environment
variable to stdout. <command>dtimsstart</command> automatically updates this
variable to reflect the currently selected IMS. Use this option to verify
that the intended IMS is the one that is being started. If you omit this
option, no output occurs.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;ims</literal> <emphasis>name</emphasis></term>
<listitem>
<para>The name of the IMS to be started. If you specify this option, <command>dtimsstart</command> starts the IMS without displaying the selection window.
If you omit this option, <command>dtimsstart</command> displays the selection
window.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;shell</literal> <emphasis>name</emphasis></term>
<listitem>
<para>The output format to use, of output, if <literal>&minus;env</literal>
is specified. If you omit this option, <command>dtimsstart</command> uses
the value of $SHELL as the default.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;host</literal> <emphasis>hostname</emphasis></term>
<listitem>
<para>The name of the host on which the IMS is to run. If you omit this option, <command>dtimsstart</command> uses the local host as the default.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;imsopt</literal> <emphasis>options</emphasis></term>
<listitem>
<para>The command line options for the selected IMS.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;list</literal></term>
<listitem>
<para>Instructs <command>dtimsstart</command> to output the names of input
methods registered on the system and then exit immediately.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>EXIT STATUS</title>
<variablelist remap="tight">
<varlistentry><term>0</term>
<listitem>
<para>The IMS was started successfully.</para>
</listitem>
</varlistentry>
<varlistentry><term>1</term>
<listitem>
<para>Execution failed for one of the following reasons:</para>
<itemizedlist><listitem><para>The started IMS did not complete its initialization
within the timeout period.</para>
</listitem><listitem><para>The started IMS process aborted.</para>
</listitem><listitem><para>The IMS specified by the <literal>&minus;ims</literal>
option is not registered.</para>
</listitem></itemizedlist>
</listitem>
</varlistentry>
<varlistentry><term>2</term>
<listitem>
<para>A syntax error was found.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>ENVIRONMENT VARIABLES</title>
<para><command>dtimsstart</command> references the following environment
variables:</para>
<variablelist>
<varlistentry><term><systemitem class="environvar">HOME</systemitem></term>
<listitem>
<para>The home directory.</para>
</listitem>
</varlistentry>
<varlistentry><term><systemitem class="environvar">LANG</systemitem></term>
<listitem>
<para>The locale.</para>
</listitem>
</varlistentry>
<varlistentry><term><systemitem class="environvar">DISPLAY</systemitem></term>
<listitem>
<para>The type of display on which IMS is to be run.</para>
</listitem>
</varlistentry>
</variablelist>
<para>It sets the <systemitem class="environvar">XMODIFIERS</systemitem> variable
to the name of the selected IMS to support application and client connections.
</para>
</refsect1>
<refsect1>
<title>ACTIONS/MESSAGES</title>
<para>The following actions relevant to <command>dtimsstart</command> are
defined in the <filename>dtims.dt</filename> file.</para>
<variablelist>
<varlistentry><term><systemitem class="environvar">DtImsMode</systemitem></term>
<listitem>
<para>Change the IM Selection Mode. This action is located at <literal>Desktop_Tools</literal> in the Application Manager.</para>
</listitem>
</varlistentry>
<varlistentry><term><systemitem class="environvar">DtImsGetRemoteConf</systemitem></term>
<listitem>
<para>Retrieve IMS configuration data on a remote system (used internally
by <command>dtimsstart</command>).</para>
</listitem>
</varlistentry>
<varlistentry><term><systemitem class="environvar">DtImsRunRemoteIms</systemitem></term>
<listitem>
<para>Run an IMS on a remote system (used internally by <command>dtimsstart</command> ).</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>ERRORS/WARNINGS</title>
<para><command>dtimsstart</command> can output the following error messages
to stderr:</para>
<variablelist>
<varlistentry><term>invalid option `<emphasis>string</emphasis>'</term>
<listitem>
<para>Correct the indicated option string.</para>
</listitem>
</varlistentry>
<varlistentry><term>environment variable `HOME' not defined</term>
<listitem>
<para>Make sure that HOME is set properly.</para>
</listitem>
</varlistentry>
<varlistentry><term>environment variable `LANG' not defined</term>
<listitem>
<para>Make sure that LANG is set properly.</para>
</listitem>
</varlistentry>
<varlistentry><term>environment variable `DISPLAY' not defined</term>
<listitem>
<para>Make sure that DISPLAY is set properly.</para>
</listitem>
</varlistentry>
<varlistentry><term>cannot open display &lsquo;<emphasis>display_name</emphasis>&rsquo;&rdquo;</term>
<listitem>
<para>Make sure that DISPLAY is set to the correct value.</para>
</listitem></varlistentry>
</variablelist>
<para><command>dtimsstart</command> can display the following error messages
in an error dialog box:</para>
<variablelist>
<varlistentry><term>cannot open file [<emphasis>/usr/dt/config/ims/start.conf</emphasis> ]</term>
<listitem>
<para>This is an installation error. Re-install the package.
</para>
</listitem>
</varlistentry>
<varlistentry><term>cannot create file [<emphasis>file_path</emphasis>]</term>
<listitem>
<para>Make sure the file and its parent directory have write permission.</para>
</listitem>
</varlistentry>
<varlistentry><term>cannot create directory [<emphasis>$HOME/.dt/ims</emphasis>]</term>
<listitem>
<para>Make sure the parent directory has write permission.</para>
</listitem>
</varlistentry>
<varlistentry><term>missing `<emphasis>entry_name</emphasis>' entry in configuration
file [file_path]</term>
<listitem>
<para>Correct the indicated entry in the indicated file.</para>
</listitem>
</varlistentry>
<varlistentry><term>another `dtimsstart' is already running</term>
<listitem>
<para>Terminate the already running <command>dtimsstart</command> and then
restart.</para>
</listitem>
</varlistentry>
<varlistentry><term>cannot create selection file [<emphasis>file_path</emphasis>]</term>
<listitem>
<para>Make sure the indicated file has write permission.</para>
</listitem>
</varlistentry>
<varlistentry><term>no ims configuration file for `<emphasis>ims_name</emphasis>'</term>
<listitem>
<para>The indicated IMS is registered in the locale configuration file, but
its IMS configuration file does not exist.</para>
</listitem>
</varlistentry>
<varlistentry><term>ims `<emphasis>ims_name</emphasis>' not registered</term>
<listitem>
<para>The indicated IMS name is not registered in the locale configuration
file.</para>
</listitem>
</varlistentry>
<varlistentry><term>no executable file for `<emphasis>ims_name</emphasis>'
[file_path]</term>
<listitem>
<para>The indicated IMS executable does not exist.</para>
</listitem>
</varlistentry>
<varlistentry><term>ims `<emphasis>ims_name</emphasis>' is already running</term>
<listitem>
<para>The indicated IMS is already running on the display.</para>
</listitem>
</varlistentry>
<varlistentry><term>cannot execute ims `<emphasis>ims_name</emphasis>'</term>
<listitem>
<para>The <function>fork</function> call failed. The errno is shown in the
log file, <filename>$HOME/.dt/ims/imslog</filename>.</para>
</listitem>
</varlistentry>
<varlistentry><term>ims `<emphasis>ims_name</emphasis>' aborted</term>
<listitem>
<para>The IMS process aborted. Refer to the log file, <filename>$HOME/.dt/ims/imslog</filename>, for details.</para>
</listitem>
</varlistentry>
<varlistentry><term>ims `<emphasis>ims_name</emphasis>' is not available yet</term>
<listitem>
<para>The indicated IMS was not available within the 3-minute timeout period.
</para>
</listitem>
</varlistentry>
<varlistentry><term>unknown host `<emphasis>host_name</emphasis>'</term>
<listitem>
<para>The network address of the indicated host cannot be found.</para>
</listitem>
</varlistentry>
<varlistentry><term>no ims registered on `<emphasis>host_name</emphasis>'</term>
<listitem>
<para>No IMS is registered on the indicated host for the current locale.</para>
</listitem>
</varlistentry>
<varlistentry><term>ims `<emphasis>ims_name</emphasis>' not registered on
`<emphasis>host_name</emphasis>'</term>
<listitem>
<para>The indicated IMS is not registered on the indicated host.</para>
</listitem>
</varlistentry>
</variablelist>
<para>Note that other error messages can be generated by <function>DtActionInvoke</function> or various Xt functions. These messages are self-explanatory.
</para>
</refsect1>
<refsect1>
<title>FILES</title>
<variablelist>
<varlistentry><term><filename>/usr/dt/bin/dtimsstart</filename></term>
<listitem>
<para><command>dtimsstart</command> executable</para>
</listitem>
</varlistentry>
<varlistentry><term><filename>/usr/dt/app-defaults/&lt;locale_name>/Dtimsstart</filename></term>
<listitem>
<para><command>dtimsstart</command> resource file</para>
</listitem>
</varlistentry>
<varlistentry><term><filename>/usr/dt/appconfig/types/&lt;locale_name>/dtims.dt</filename></term>
<listitem>
<para>action definition file</para>
</listitem>
</varlistentry>
<varlistentry><term><filename>/usr/dt/appconfig/appmanager/&lt;locale_name>/Desktop_Tools/DtImsMode</filename></term>
<listitem>
<para>action files for <function>DtImsMode<function></function></function></para>
</listitem>
</varlistentry>
<varlistentry><term><filename>/usr/dt/lib/nls/msg/&lt;locale_name>/dtimsstart.cat</filename></term>
<listitem>
<para>message catalog file</para>
</listitem>
</varlistentry>
<varlistentry><term><filename>/usr/dt/config/Xsession.d/:0020.dtims</filename></term>
<listitem>
<para>Xsession.d script file</para>
</listitem>
</varlistentry>
<varlistentry><term><filename>/usr/dt/config/ims/start.conf</filename></term>
<listitem>
<para><command>dtimsstart</command> configuration file</para>
</listitem>
</varlistentry>
<varlistentry><term><filename>/usr/dt/config/ims/&lt;locale_name></filename></term>
<listitem>
<para>locale entry files</para>
</listitem>
</varlistentry>
<varlistentry><term><filename>/usr/dt/config/ims/&lt;ims_name></filename></term>
<listitem>
<para>IMS entry files</para>
</listitem>
</varlistentry>
<varlistentry><term><filename>$HOME/.dt/ims/&lt;locale_name></filename></term>
<listitem>
<para>IMS selection file</para>
</listitem>
</varlistentry>
<varlistentry><term><filename>$HOME/.dt/ims/&lt;display_name>/&lt;locale_name></filename></term>
<listitem>
<para>display-specific IMS selection file</para>
</listitem>
</varlistentry>
<varlistentry><term><filename>$HOME/.dt/ims/imslog</filename></term>
<listitem>
<para><command>dtimsstart</command> log file</para>
</listitem>
</varlistentry>
</variablelist>
<refsect2>
<title>Resource Files</title>
<para><command>dtimsstart</command> searches a proper resource file in the
following order and loads the first file successfully opened.</para>
<orderedlist><listitem><para><filename>$HOME/.dt/&lt;display-name>/current/dt.resources</filename></para>
</listitem><listitem><para><filename>$HOME/.dt/&lt;display-name>/home/dt.resources</filename></para>
</listitem><listitem><para><filename>$HOME/.dt/sessions/current/dt.resources</filename></para>
</listitem><listitem><para><filename>$HOME/.dt/sessions/home/dt.resources</filename></para>
</listitem><listitem><para><filename>/usr/dt/config/&lt;locale-name>/sys.resources</filename></para>
</listitem><listitem><para><filename>/usr/dt/config/C/sys.resources</filename></para>
</listitem></orderedlist>
</refsect2>
<refsect2>
<title>Configuration Files</title>
<para><command>dtimsstart</command> refers to the following configuration
files:</para>
<itemizedlist><listitem><para>Locale Entry file</para>
</listitem><listitem><para>IMS configuration file</para>
</listitem><listitem><para>IMS Selection file</para>
</listitem></itemizedlist>
<para>The location and format for each configuration file is listed below.
</para>
<refsect3>
<title>Locale Entry File</title>
<para>This file lists the IMSs that support the locale. Its location is <filename>/usr/dt/config/ims/&lt;locale_name></filename>. The format
is:</para>
<para>@Default: <emphasis>ims_name</emphasis></para>
<para><emphasis>ims_name</emphasis>: <emphasis>label_string</emphasis></para>
<para>For example:</para>
<programlisting><filename>/usr/dt/config/ims/ja_JP.SJIS</filename>
@Default: xjim
xjim: HP XJIM
atok8: ATOK8
vje: VJE-gamma
egbridge: EGBridge
none: No Input Method</programlisting>
</refsect3>
<refsect3>
<title>IMS Entry File</title>
<para>This file describes the attributes of an IMS. Its location is
<filename>/usr/dt/config/ims/&lt;ims_name></filename>. The format is:
</para>
<para><emphasis>attribute_name</emphasis>: <emphasis>attribute_value</emphasis></para>
<para>The IMS attributes are:</para>
<variablelist>
<varlistentry><term><literal>protocols</literal></term>
<listitem>
<para>A required String that lists the supported protocols. The supported
XIM protocols are XIM, Ximp, and Xsi.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>server_name</literal></term>
<listitem>
<para>A required String that identifies the IMS name (used to update the <Symbol>XMODIFIERS</Symbol> environment variable).</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>cmd_path</literal></term>
<listitem>
<para>A required Path type that specifies the absolute path of the executable
file for the identified IMS server. A built-in keyword is used for the local
IM built-in Xlib, which does not need a separate process.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>cmd_param</literal></term>
<listitem>
<para>A String that specifies the command line option(s) for the IMS server.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>env_set</literal></term>
<listitem>
<para>A String that identifies the environment variables to be set, excluding <Symbol>XMODIFIERS</Symbol>.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>env_unset</literal></term>
<listitem>
<para>A String that identifies environment variables to be unset, excluding <Symbol>XMODIFIERS</Symbol>.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>env_pass</literal></term>
<listitem>
<para>A String that identifies the environment variables to be passed to
a remotely executing IMS, excluding <Symbol>LANG</Symbol>, <Symbol>DISPLAY</Symbol>, and <Symbol>XMODIFIERS</Symbol>.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>has_window</literal></term>
<listitem>
<para>A Bool indicating whether the IMS has its own main window appearance
or not. The default is False.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>no_server</literal></term>
<listitem>
<para>A Bool indicating whether <command>dtimsstart</command> should start
the IMS or not. It should be True for the local IM, since it doesn't require
any server process started by <command>dtimsstart</command>. The default
is False.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>no_remote</literal></term>
<listitem>
<para>A Bool indicating whether the IMS allows remote execution or not. The
default is False.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>no_option</literal></term>
<listitem>
<para>A Bool indicating whether the IMS allows the command-line option or
not. If True, any options specfied by <literal>&minus;imsopt</literal> are
ignored, though the value of the <literal>cmd_param</literal> entry is always
applied regardless of this value. It should be True for the local IMS. The
default is False.</para>
</listitem>
</varlistentry>
</variablelist>
<note>
<para>For entries that accept multiple values, the values are separated by
white space(s). If multiple entries of the same name appear in the file,
only the last entry is used.</para>
</note>
<para>For example:</para>
<programlisting><filename>/usr/dt/config/ims/xjim</filename>
protocols: XIM Ximp
server_name: xjim
cmd_path: /usr/bin/X11/xjim
cmd_param: -iconic
env_set:
env_unset:
env_pass:
has_window: true</programlisting>
</refsect3>
<refsect3>
<title>IMS Selection File</title>
<para>This file saves the most recently selected IMS for each locale. Its
location is <filename>$HOME/.dt/ims/[&lt;display_name>/]&lt;locale_name></filename>. The format is:</para>
<para><emphasis>entry_name</emphasis>: <emphasis>entry_value</emphasis></para>
<para>The selection file entries are:<?Pub Caret></para>
<variablelist>
<varlistentry><term><literal>@SelectMode</literal></term>
<listitem>
<para>The most recently set IMS Selection Mode. Valid values are 0 (zero)
(for <literal>ask-at-login</literal>) and 1 (for <literal>resume-current-input-method</literal> ).</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>@ImsName</literal></term>
<listitem>
<para>The name of the most recently selected IMS.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>@HostName</literal></term>
<listitem>
<para>The name of the host on which the IMS runs.</para>
</listitem>
</varlistentry>
</variablelist>
<para>For example:</para>
<programlisting><filename>$HOME/.dt/ims/ja_JP.SJIS</filename>
@SelectMode: 1
@ImsName: atok8
@HostName: host-A</programlisting>
</refsect3>
</refsect2>
</refsect1>
<refsect1>
<title>EXAMPLE</title>
<para>The command to execute <command>dtimsstart</command> in the
<filename>/usr/dt/config/Xsession.d/0020.dtims</filename> script is as follows:</para>
<programlisting>eval ` /usr/dt/bin/dtimsstart -env -shell ksh `</programlisting>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>TO BE SUPPLIED</para>
</refsect1>
</refentry>

800
cde/doc/C/guides/man/man1_dt/info.sgm Normal file
View File

@@ -0,0 +1,800 @@
<!-- $XConsortium: info.sgm /main/13 1996/10/30 11:38:13 cdedoc $ -->
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
<!-- (c) Copyright 1996 International Business Machines Corp. -->
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1996 Novell, Inc. -->
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
<!-- (c) Copyright 1996 Hitachi. -->
<![ %CDE.C.CDE; [<refentry id="CDE.INFO.dtinfo">]]>
<RefMeta>
<refentrytitle>dtinfo</refentrytitle>
<manvolnum>user cmd</manvolnum></refmeta>
<refnamediv>
<refname><command>dtinfo</command></refname>
<refpurpose>browse on-line information</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>dtinfo</command>
<arg choice="opt">&minus;help</arg>
<arg choice="opt">&minus;l <replaceable>infolib</replaceable></arg>
<arg choice="opt">&minus;sect <replaceable>section</replaceable>
<arg choice="opt"><group choice="req" rep="repeat"><arg choice="plain">&minus;<replaceable>section</replaceable></arg>
<arg choice="plain">,<replaceable>section</replaceable></arg>
</group></arg></arg>
<arg choice="opt">&minus;secondary</arg>
<arg choice="opt">&minus;verbose</arg>
<arg choice="opt">&minus;print</arg>
<arg choice="opt">&minus;hierarchy</arg>
<arg choice="opt">&minus;printer <replaceable>x_print_server</replaceable></arg>
<arg choice="opt">&minus;copies <replaceable>number</replaceable></arg>
<arg choice="opt">&minus;paperSize <replaceable>size</replaceable></arg>
<arg choice="opt">&minus;s</arg>
</cmdsynopsis>
</refsynopsisdiv><refsect1>
<title>DESCRIPTION</title>
<para>The <command>dtinfo</command> command starts the desktop on-line
information browser, also known as the CDE Information Manager.
On-line information is typically packaged into an
information library (infolib), which is a hierarchy of bookcases
containing SGML books (see the &cdeman.dtinfogen; command).
The browser offers an ability to view, search, and print on-line
information with a high degree of control. Bookmarks and annotations may
be attached at desired points for later recall.
</para>
<refsect2>
<title>Generalized Locator Format</title>
<para>The generalized locator format is used as an identifier for target
information. The following format shows the fully specified case,
although it is usually not required to
uniquely identify sections:
</para>
<para><literal>mmdb:INFOLIB=</literal><symbol role="variable">ilib_path</symbol><literal>&amp;BOOKCASE=</literal><symbol role="variable">bc_name</symbol><literal>&amp;LOCATOR=</literal><symbol role="variable">locator</symbol>
</para>
<para>where <symbol role="variable">ilib_path</symbol> is the infolib's path on disk;
<symbol role="variable">bc_name</symbol> is the name of the bookcase (an MMDB); and
<symbol role="variable">locator</symbol> is the MMDB locator value.
The locator itself must be a unique reference across
document collections by the time an infolib's build process is complete.
</para>
<para>If just <Symbol>INFOLIB</Symbol> is present, the collection
corresponding to the infolib is returned. To display at the beginning of
a known bookcase, use the form:
</para>
<para><literal>mmdb:INFOLIB=</literal><symbol role="variable">ilib_path</symbol><literal>&amp;BOOKCASE=</literal><symbol role="variable">bc_name</symbol>
</para>
<para>Note, however, that bookcase names are less protected from change than
locators, and should not be relied upon for other than dynamically
verifiable bookcase targets.
</para>
<para>If a locator is not expected to be in the desktop default infolib,
identify its infolib by including the full file path name for the
information library (<symbol role="variable">ilib_path</symbol>). The most common
form of reference is then either:
</para>
<para><literal>mmdb:INFOLIB=</literal><symbol role="variable">ilib_path</symbol><literal>&amp;LOCATOR=</literal><symbol role="variable">locator</symbol>
</para>
<para>or:
</para>
<para><literal>mmdb:LOCATOR=</literal><symbol role="variable">locator</symbol>
</para>
<para>If INFOLIB and BOOKCASE are omitted, a locator is looked up in all
loaded information libraries. If no information libraries are currently
loaded, the locator is looked up in the default information library(s)
specified by <systemitem class="environvar">DTINFOLIBDEFAULT</systemitem>.
For the <literal>-sect</literal> argument, the value(s) "locator" alone
is sufficient to reach the desired section, if it occurs in the default infolib,
or those indicated by <literal>-l</literal> arguments.
</para>
<refsect3>
<title>Persistent User Settings</title>
<para>A few characteristics are saved across browser sessions. These are
bookmarks, annotations, named search scopes, and certain user
preferences. All of these are saved on a locale-specific basis. Query
history and browse history lists are provided, but are not persistent
across sessions.
</para>
</refsect3>
</refsect2>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<para>The following options are available:
</para>
<variablelist>
<varlistentry><term><literal>&minus;help</literal></term>
<listitem>
<para>Prints a summary of the command's syntax.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;l</literal> <symbol role="variable">infolib</symbol></term>
<listitem>
<para>Specifies an absolute file path or the filename of an information library.
If an infolib's filename is specified, the search path specified by
<systemitem class="environvar">DTINFOLIBSEARCHPATH</systemitem>
is used to help locate the file. If the <literal>-l</literal> option
is omitted, the browser displays the default information library(s)
specified by <systemitem class="environvar">DTINFOLIBDEFAULT</systemitem>.
This option can be specified more than once.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;secondary</literal></term>
<listitem>
<para>Starts a secondary instance of <command>dtinfo</command>. Secondary
instances do not respond to <symbol>Dtinfo_ShowInfoAtLoc</symbol>
and <symbol>Dtinfo_LoadInfoLib</symbol> ToolTalk messages.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;verbose</literal></term>
<listitem>
<para>Prints information on the terminal as the command runs, if
<command>dtinfo</command> is started from the command line.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;sect</literal> <symbol role="variable">section</symbol>[{&minus;<symbol role="variable">section</symbol>|,<symbol role="variable">section</symbol>}&hellip;]</term>
<listitem>
<para>Specifies the infolib section or sections to either display
or print. Sections can be specified in generalized locator format.
</para>
<para>To specify a range of sections, use the form:
</para>
<para><literal>&minus;sect</literal> <symbol role="variable">section</symbol><literal>-</literal><symbol role="variable">section</symbol>
</para>
<para>where the start and end sections are separated by the hyphen character.
</para>
<para>To specify a discontiguous list of sections, use the form:
</para>
<para><literal>&minus;sect</literal> <symbol role="variable">section</symbol>,<symbol role="variable">section</symbol>
</para>
<para>where the sections in the list are separated by the comma character.
</para>
<para>If the <literal>-print</literaL> option is specified, the sections are printed.
Otherwise, <command>dtinfo</command> loads the specified infolib(s) and displays
all the sections in separate browser windows.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;print</literal></term>
<listitem>
<para>Instructs <command>dtinfo</command> to print the locations specified
with the <literal>-sect</literal> option. Printing of an entire infolib
from the command line is disallowed. If a specified location is not at
the top of a section, the section containing the location is printed.
</para>
</listitem>
</varlistentry>
</variablelist>
<refsect2>
<title>Print Control Options</title>
<para>These options are valid only if the <literal>&minus;print</literal>
option is also specified.
</para>
<variablelist>
<varlistentry><term><literal>&minus;hierarchy</literal></term>
<listitem>
<para>Prints an entire specified section and all of its subsections. By
default, only the specified section is printed.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;printer</literal> <symbol role="variable">x_print_server</symbol></term>
<listitem>
<para>Specifies which X Print server to use. If this is not specified as a
command-line option or resource, the value is taken from the
environment.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;copies</literal> <symbol role="variable">number</symbol></term>
<listitem>
<para>Specifies how many copies to print. The default value is 1. This option
is ignored when generating an output file.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;paperSize</literal> <symbol role="variable">size</symbol></term>
<listitem>
<para>Specifies a size of paper to which the output should be formatted. Valid
sizes are <literal>iso-a4</literal>, <literal>iso-b4</literal>,
<literal>na-letter</literal>, and <literal>na-legal</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;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. If this
option is specified, the <literal>-copies</literal> option is ignored.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;s</literal></term>
<listitem>
<para>Specifies silent printing. <command>dtinfo</command> does not write to
either standard out or standard error, nor does it attempt to open any
windows.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<refsect1>
<title>PRINT FEATURES</title>
<para>This section describes the features that affect printing with
<command>dtinfo</command>.
</para>
<refsect2>
<title>Page Numbers</title>
<para>
Pages are numbered relative to the print job. For example, if a
section spans over four printed pages, the pages are numbered
1-4. To get page numbers starting relative to the front of the book, it
is necessary to print the entire contents of the book. When
printing more than one book (a bookcase, for example) the page numbering
is reset to page 1 at the start of each book. A section is determined
to be a book if it is a Table of Contents.
</para>
<para>
When specifying "what to print" all references are given in logical
terms. You cannot specify a page range since this
number has no real meaning until the document is rendered to a given
page size. "What to print" is specified as a section or list of sections
in generalized locator format. It is also possible to specify a range of
sections.
</para>
</refsect2>
<refsect2>
<title>Table of Contents</title>
<para>The table of contents can be printed as part of a book or as a separate
section. When printed as part of a book, it is always printed last to
allow the page number references to be calculated while the document is
printing. When printed separately, the page numbers are not calculated.
</para>
</refsect2>
<refsect2>
<title>Image Scaling</title>
<para>
Dtinfo supports a number of graphic file formats: Tiff, XPM, XWD, GIF,
JPEG, and CGM. Of all these formats, only CGM is a natural "scalable"
format made of vectors and independent coordinates, much like
PostScript. All the other graphic formats are specified in Dots Per Inch
(DPI) and designed for a given resolution. Since most displays have a
resolution of between 90/100 DPI and printers commonly have resolutions
of 300/600 DPI, printed documents can end up with graphics 3 or 6 times
smaller than their screen counterparts, especially when the surrounding
fonts are scaled to match the screen size.
</para>
<para>To address this problem, <command>dtinfo</command> automatically scales
a graphic according to the following formula:
</para>
<programlisting>
printed_image_size= image_size * (resolution / 100 DPI)
</programlisting>
<para>During scaling it is important that the image not be scaled in excess of
the hard page boundary. See "Hard Page Boundaries" for more detail.
</para>
</refsect2>
<refsect2>
<title>Hard Page Boundaries</title>
<para>On-line documentation is often developed with little or no consideration
for printability. As a result, on-line documents often have graphics or
tables that exceed the hard-page boundaries of the printed media. The
<command>dtinfo</command> command attempts to correct these problems
during the layout-for-print process by a combination of page break
insertions, rotation (landscape/portrait), and scalable objects.
</para>
<para>Graphic objects that are too wide for the page are scaled down to the
page width.
</para>
<para>Graphic objects that are too tall for the remaining page height are
started on the next page. If a graphic object is too tall for a single
page it is scaled down to the page height.
</para>
<para>Table objects that are too wide for the page are started on the next
page and rotated for landscape printing. If a table is still too large,
it is scaled to the page height. Once the table has been printed, an
additional page break is performed and the remainder of the printing
resumes in the default page orientation. Space left in the current page
layout is filled by flow-up of subsequent text.
</para>
</refsect2>
<refsect2>
<title>Hard Copy Page Style Rendering</title>
<para><command>dtinfo</command> hard copy page-style rendering, with addition
of headers and footers, page breaks, and numbering. For these
characteristics, it is necessary to use print-specific style sheet
features.
</para>
</refsect2>
<refsect2>
<title>Background Printing</title>
<para><command>dtinfo</command> allows simultaneous browsing and multiple
print requests to be active in parallel.
</para>
</refsect2>
</refsect1>
<refsect1>
<title>RESOURCES</title>
<refsect2>
<title>XRM Resources</title>
<para>The XRM resources understood by
<command>dtinfo</command> are as follows:
</para>
<variablelist>
<varlistentry><term><systemitem class="resource">BrowseGeometry</systemitem></term>
<listitem>
<para>Specifies the default size of reading windows in pixel dimensions, x by
y. The default is <literal>500x630</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry><term><systemitem class="resource">BrowseLock</systemitem></term>
<listitem>
<para>Specifies whether the current reading window is automatically "pinned"
when a new document display request is made (<literal>on</literal>) or
not (<literal>off</literal>). If <literal>on</literal>, the new document
appears in a new reading window. System resources utilized are often
much higher in the <literal>on</literal> mode. The default is
<literal>off</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry><term><systemitem class="resource">DisplayFirstHit</systemitem></term>
<listitem>
<para>Specifies whether the first document listed in the search results list
is displayed automatically (<literal>true</literal>) or not
(<literal>false</literal>). The default is <literal>false</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry><term><systemitem class="resource">FontScale</systemitem></term>
<listitem>
<para>Specifies the relative size to use for text in all reading windows,
compared to the publisher-specified font size, where 0 means "per style
sheet". Possible values are -2, -1, 0, 1, 2, 3, 4, and 5. Invalid values
default to 0. A non-zero value is used by the browser to associate
incrementally larger sizes of the same font, when possible. The default
is <literal>0</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry><term><systemitem class="resource">MapAutoUpdate</systemitem></term>
<listitem>
<para>Specifies whether the graphical map (when visible) is automatically
updated as the user moves to new documents (<literal>true</literal>) or
not (<literal>false</literal>). The default is <literal>true</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry><term><systemitem class="resource">MapGeometry</systemitem></term>
<listitem>
<para>Specifies the default size of the graphical map window in pixel
dimensions, x by y. The default is <literal>520x350</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry><term><systemitem class="resource">MaxSearchHits</systemitem></term>
<listitem>
<para>Specifies the maximum number of document titles to be displayed in the
Search Results List window in fulfillment of a query. The entries in the
search results list are ordered roughly by importance to the query, so a
value here includes the most relevant results. The default is
<literal>50</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry><term><systemitem class="resource">NodeHistSize</systemitem></term>
<listitem>
<para>Specifies the maximum number of document visits to be maintained in
the browse history list. Duplicates are not displayed in the list, but
re-visits change the list order by moving a previously viewed document
to the top. The browse history is not saved across
<command>dtinfo</command> sessions. The default is
<literal>100</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry><term><systemitem class="resource">SearchHistorySize</systemitem></term>
<listitem>
<para>Specifies the maximum number of previously performed queries to be
maintained for the search history list. Using the search history list is
a quick way to re-access the results of a prior query. The search
history is not saved across <command>dtinfo</command> sessions. The
default is <literal>50</literal>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2>
<title>Display Color Resources</title>
<para>The following resources set colors for various <command>dtinfo</command>
display features:
</para>
<variablelist>
<varlistentry><term><systemitem class="resource">Dtinfo*display_area.background</systemitem></term>
<listitem>
<para>Specifies the background color for on-line document presentation. The
user is cautioned to avoid choices of background color which match the
color used for either hypertext links or search hits. The keyboard
traversal highlight color should also be considered when setting this
resource. There is no default.
</para>
</listitem>
</varlistentry>
<varlistentry><term><systemitem class="resource">Dtinfo*display_area.foreground</systemitem></term>
<listitem>
<para>Specifies the foreground color for on-line document presentation (used
for text not otherwise highlighted). The user is cautioned to avoid
choices of foreground color which match the color used for either
hypertext links or search hits. There is no default.
</para>
</listitem>
</varlistentry>
<varlistentry><term><systemitem class="resource">Dtinfo*doc_list.background</systemitem></term>
<listitem>
<para>Specifies the background color for the infolib book list. There is no
default.
</para>
</listitem>
</varlistentry>
<varlistentry><term><systemitem class="resource">Dtinfo*doc_list.foreground</systemitem></term>
<listitem>
<para>Specifies the foreground color for the infolib book list.
There is no default.
</para>
</listitem>
</varlistentry>
<varlistentry><term><systemitem class="resource">Dtinfo.results*list.background</systemitem></term>
<listitem>
<para>Specifies the background color for the search results list.
There is no default.
</para>
</listitem>
</varlistentry>
<varlistentry><term><systemitem class="resource">Dtinfo.results*list.foreground</systemitem></term>
<listitem>
<para>Specifies the foreground color for the search results list.
There is no default.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2>
<title>Print-Related Resources</title>
<para>For print-related resources, see "Descendants" and
"Resources" in &cdeman.DtPrintSetupBox;.
</para>
</refsect2>
</refsect1>
<refsect1>
<title>STDIN</title>
<para>Not used.</para>
</refsect1><refsect1>
<title>ENVIRONMENT VARIABLES</title>
<para>The following environment variables affect the execution of <command>dtinfo</command>:
</para>
<variablelist>
<varlistentry><term><systemitem class="EnvironVar">DTINFOLIBSEARCHPATH</systemitem></term>
<listitem>
<para>Specifies the search path for locating information libraries on local
and remote mounted systems.
</para>
</listitem>
</varlistentry>
<varlistentry><term><systemitem class="EnvironVar">DTINFOLIBDEFAULT</systemitem></term>
<listitem>
<para>Specifies the name of the default information library(s) to load if the
<literal>-l</literal> or <literal>-sect</literal> option is not
specified. Multiple information libraries can be specified by a comma
separated list. By default, <systemitem class="EnvironVar">DTINFOLIBDEFAULT</systemitem> is initialized
to the CDE infolib cde.
Note that <command>dtinfo</command> will not start if there is no infolib specified explicitly
or by default. <systemitem class="EnvironVar">DTINFOLIBDEFAULT</systemitem> requires
the definition of an applicable <systemitem class="EnvironVar">DTINFOLIBSEARCHPATH</systemitem>.
</para>
</listitem>
</varlistentry>
<varlistentry><term><systemitem class="EnvironVar">PDPRINTER</systemitem>,
<systemitem class="EnvironVar">LPDEST</systemitem>,
<systemitem class="EnvironVar">PRINTER</systemitem></term>
<listitem>
<para>Specify the name of the printer to use if the
<literal>-printer</literal> option, <systemitem class="EnvironVar">XPRINTER</systemitem> environment variable,
and <systemitem class="resource">XpPrinter</systemitem> resource
are not specified. <command>dtinfo</command> checks <systemitem class="EnvironVar">PDPRINTER</systemitem> first, <systemitem class="EnvironVar">LPDEST</systemitem> next, and <systemitem class="EnvironVar">PRINTER</systemitem> last to obtain a printer name
that can be used to generate an X Printer Specifier to use for the
default X Printer shown in the Printer Name text field. The
<symbol role="variable">host</symbol>:<symbol role="variable">display</symbol> portion of the
specifier is obtained by checking if the X Server to which the client
application is connected is an X Print Server managing printer
<symbol role="variable">name</symbol>. If not, the list of X Print Servers specified
in the <systemitem class="resource">XpServerList</systemitem>
resource is queried, until the first X Printer with a matching printer
name is found.
</para>
</listitem>
</varlistentry>
<varlistentry><term><systemitem class="EnvironVar">XPRINTER</systemitem></term>
<listitem>
<para>Specifies the default destination X Printer Specifier for the
<function>DtPrintSetupBox</function>. If the specifier is just a
<symbol role="variable">printerName</symbol>, the
<symbol role="variable">host</symbol>:<symbol role="variable">display</symbol> portion of the
specifier is obtained by checking if the X Server to which the client
application is connected is an X Print Server managing
<symbol role="variable">printerName</symbol>. Otherwise, the first server in the
<systemitem class="resource">XpServerList</systemitem> resource
or the <systemitem class="EnvironVar">XPSERVERLIST</systemitem>
environment variable that manages the printer will be used. If the
:<symbol role="variable">display</symbol> number is omitted, :0 is assumed.
</para>
</listitem>
</varlistentry>
<varlistentry><term><systemitem class="EnvironVar">DTPRINTSILENT</systemitem></term>
<listitem>
<para>Specifies whether to display a Print dialog box if the
<literal>-s</literal> option is not specified. When the variable is set
to <literal>True</literal>, the Print dialog is not displayed. If the
variable is not set, the dialog is displayed.
</para>
</listitem>
</varlistentry>
<varlistentry><term><systemitem class="EnvironVar">XPDMDISPLAY</systemitem></term>
<listitem>
<para>Specifies whether an alternate X Print Server will be used to find the
PDM_MANAGER selection. If the variable is not set, an alternate X Print
Server will not be used.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>ACTIONS/MESSAGES</title>
<para><command>dtinfo</command> registers with ToolTalk to handle the following ToolTalk requests:
</para>
<variablelist>
<varlistentry><term><symbol role="Message">DtInfo_LoadInfoLib</symbol></term>
<listitem>
<para>Causes <command>dtinfo</command> to load the specified infolib or the
default infolib, if none is specified.
</para>
</listitem>
</varlistentry>
<varlistentry><term><symbol role="Message">DtInfo_ShowInfoAtLoc</symbol></term>
<listitem>
<para>Causes <command>dtinfo</command> to display a particular section
of data or topic.
</para>
</listitem>
</varlistentry>
<varlistentry><term><symbol role="Message">DtInfo_PrintInfoAtLoc</symbol></term>
<listitem>
<para>Routes print requests back to the requesting <command>dtinfo</command>
process after the end-user drags one or more sections from the book list
and drops them on the printer icon in the front panel.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>Desktop actions invoking the browser are:
</para>
<variablelist>
<varlistentry><term><Symbol>DtShowInfoAtLoc</Symbol></term>
<listitem>
<para>Sends a <symbol role="Message">DtInfo_ShowInfoAtLoc</symbol> message.
</para>
</listitem>
</varlistentry>
<varlistentry><term><Symbol>DtLoadInfoLib</Symbol></term>
<listitem>
<para>Sends a <symbol role="Message">DtInfo_LoadInfoLib</symbol> message.
</para>
</listitem>
</varlistentry>
<varlistentry><term><Symbol>DtPrintInfoAtLoc</Symbol></Term>
<listitem>
<para>Sends a <symbol role="Message">DtInfo_PrintInfoAtLoc</symbol> message.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>Use of any default desktop representations to start
<command>dtinfo</command> from its icon or the icon of an infolib causes
<command>dtinfo</command> to be invoked via the desktop action
mechanism.
</para>
</refsect1>
<refsect1>
<title>STDOUT</title>
<para>Not used.</para>
</refsect1><refsect1>
<title>STDERR</title>
<para>Not used.</para>
</refsect1><refsect1>
<title>INPUT FILES</title>
<para>For input, <command>dtinfo</command> accepts the file path,
relative or absolute, for one or more information libraries.
</para>
</refsect1><refsect1>
<title>OUTPUT FILES</title>
<para>For output, <command>dtinfo</command> produces a file to hold
print-ready output, if the <literal>&minus;outputFile</literal> and the
<literal>&minus;print</literal> options are specified.
</para>
</refsect1><refsect1>
<title>EXTENDED DESCRIPTION</title>
<para>None.</para>
</refsect1><refsect1>
<title>RETURN VALUE</title>
<para>A non-zero return value for <command>dtinfo</command> implies an error
condition on start-up.
</para>
</refsect1>
<refsect1>
<title>ERRORS/WARNINGS</title>
<refsect2>
<title>Warning Messages</title>
<variablelist>
<varlistentry><term><literal>Warning: Illegal or missing paper size.</literal></term>
<listitem>
<para>This warning indicates an invalid value of the <systemitem class="resource">paperSize</systemitem> resource or
<literal>-paperSize</literal> option. Correctly specify the option on
the utility line or set a default resource value.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>Warning: Illegal number of copies.</literal></term>
<listitem>
<para>This warning is displayed when both the <literal>-outputFile</literal>
and <literal>-copies</literal> options are specified, and the number of
copies is greater than 1.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2>
<title>Error Messages</title>
<variablelist>
<varlistentry><term><literal>Error: Unable to open x print server &lt;x_print_server></literal></term>
<listitem>
<para>This error indicates that the display specified by the printer resource
or <literal>-printer</literal> option could not be opened.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>Error: section not found.</literal></term>
<listitem>
<para>This error indicates that the specified section locator could not be
found.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>Error: invalid section specification &lt;section>.</literal></term>
<listitem>
<para>This error indicates that specified section locator was incorrectly formatted.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>Error: printing of the entire infolib is not supported.</literal></term>
<listitem>
<para>Use the <literal>-sect</literal> option to identify the specific
sections to print.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>Error: unable to allocate memory for temporary file.</literal></term>
<listitem>
<para>This error indicates that the memory needed to create the temporary file
name could not be allocated.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>Error: unable to open temporary file.</literal></term>
<listitem>
<para>This error indicates that the temporary file could not be opened for
writing.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<refsect1>
<title>EXAMPLES</title>
<para>Start the browser and display the default information library:
</para>
<programlisting>% dtinfo</programlisting>
<para>Start the browser with a library located at <filename>/cdrom/encyclopedia.dti</filename>:
</para>
<programlisting>% dtinfo -l /cdrom/encyclopedia.dti</programlisting>
<para>Start the browser with a library from the search path:
</para>
<programlisting>% dtinfo -l encyclopedia</programlisting>
<para>Start the browser with a specific section to display:
</para>
<programlisting>% dtinfo -sect mmdb:INFOLIB=encyclopedia&amp;LOCATOR=home_topic
</programlisting>
<para>or:
</para>
<programlisting>% dtinfo -sect INFOUG.SEARCH.DIV.5,INFOUG.SEARCH.DIV.22
</programlisting>
<para>An alternate form of the previous command:
</para>
<programlisting>% dtinfo -l /cdrom/encyclopedia.dti -sect mmdb:LOCATOR=home_topic
</programlisting>
<para>Print a specific section without starting <command>dtinfo</command>:
</para>
<programlisting>% dtinfo -print -sect INFOUG.NAVIGATE.DIV.3
</programlisting>
<para>Printing of an entire infolib is not supported from the command line:
</para>
<programlisting>
% dtinfo -print -l /cdrom/encyclopedia.dti
*** Error ***
</programlisting>
<para>Examples for the use of <command>dtinfo</command> directly:
</para>
<programlisting>
% dtaction DtLoadInfoLib /usr/dt/infolib/C/cde.dti
</programlisting>
<programlisting>
% dtaction DtShowInfoAtLoc /usr/dt/infolib/C/cde.dti GI.RGFBE.1698OL
</programlisting>
<para>
If the infolib path environment variable is defined:
</para>
<programlisting>
% dtaction DtShowInfoAtLoc cde INFOUG.GSTART.DIV.3
</programlisting>
</refsect1>
<refsect1>
<title>FILES</title>
<para>Command line start-up recognizes an infolib directory path (see
&cdeman.DtMmdbInfoLibInfo;).
The name of the directory and its contained files
is used to ascertain whether it is a valid infolib.
</para>
<para>User-specific files for bookmarks and annotations are internally managed
under the locale-specific directory
<filename>$HOME/.dt/dtinfo/%L/marks/</filename>.
</para>
<para>User preferences, set via the Preferences dialog in an instance of
<command>dtinfo</command>, and user-defined search scopes are saved in
the generated file
<filename>$HOME/.dt/dtinfo/%L/preferences</filename>.
</para>
<para>Application specific resources are defined in
<filename>/usr/dt/app-defaults/%L/Dtinfo</filename>.
</para>
<para>Utility files and supporting data for dtinfo are found in the system location
<filename>/usr/dt/infolib</filename>.
</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>
<filename>Generalized Locator Format</filename>(4),
&cdeman.dtinfogen;,
&cdeman.DtPrintSetupBox;,
&cdeman.DtInfo.LoadInfoLib;,
&cdeman.DtInfo.ShowInfoAtLoc;,
&cdeman.DtInfo.PrintInfoAtLoc;,
&cdeman.dtinfoaction;,
&cdeman.DtMmdbInfoLibInfo;
</Para>
</refsect1></refentry>

361
cde/doc/C/guides/man/man1_dt/infogen.sgm Normal file
View File

@@ -0,0 +1,361 @@
<!-- $XConsortium: infogen.sgm /main/8 1996/11/15 15:37:49 cdedoc $ -->
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
<!-- (c) Copyright 1996 International Business Machines Corp. -->
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1996 Novell, Inc. -->
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
<!-- (c) Copyright 1996 Hitachi. -->
<![ %CDE.C.CDE; [<refentry id="CDE.INFO.dtinfogen">]]>
<RefMeta>
<refentrytitle>dtinfogen</refentrytitle>
<manvolnum>user cmd</manvolnum></refmeta>
<refnamediv>
<refname><command>dtinfogen</command></refname>
<refpurpose>access DtInfo Toolkit functions</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>dtinfogen</command>
<arg choice="opt">&minus;h</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>dtinfogen admin</command>
<arg choice="opt">&minus;h</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>dtinfogen build</command>
<arg choice="opt">&minus;h</arg>
<arg choice="opt">&minus;T <replaceable>TmpDir</replaceable></arg>
<arg choice="opt">&minus;m <replaceable>CatalogFile</replaceable></arg>
<arg choice="plain">&minus;l <replaceable>Library</replaceable></arg>
<arg choice="plain">&minus;d <replaceable>LibraryDescription</replaceable></arg>
<arg choice="plain">&minus;n <replaceable>LibraryShortName</replaceable></arg>
<arg choice="plain"><replaceable>Bookcase</replaceable> ...</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>dtinfogen tocgen</command>
<arg choice="opt">&minus;h</arg>
<arg choice="opt">&minus;T <replaceable>TmpDir</replaceable></arg>
<arg choice="opt">&minus;m <replaceable>CatalogFile</replaceable></arg>
<arg choice="opt">&minus;id <replaceable>TOCid</replaceable></arg>
<arg choice="opt">&minus;title <replaceable>TOCtitle</replaceable></arg>
<arg choice="plain"><replaceable>document</replaceable> ...</arg>
<arg choice="plain">&minus;f <replaceable>TOCfile</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>dtinfogen update</command>
<arg choice="opt">&minus;h</arg>
<arg choice="opt">&minus;T <replaceable>TmpDir</replaceable></arg>
<arg choice="opt">&minus;m <replaceable>CatalogFile</replaceable></arg>
<arg choice="plain">&minus;b <replaceable>BookcaseName</replaceable></arg>
<arg choice="plain">&minus;l <replaceable>library</replaceable></arg>
<arg choice="plain"><replaceable>stylesheet</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>dtinfogen validate</command>
<arg choice="opt">&minus;h</arg>
<arg choice="opt">&minus;T <replaceable>TmpDir</replaceable></arg>
<arg choice="opt">&minus;m <replaceable>CatalogFile</replaceable></arg>
<arg choice="plain"><replaceable>SGMLdocument</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>The DtInfo Toolkit command, <command>dtinfogen</command>, is used to create and modify
hypertext information libraries.
<command>dtinfogen</command> implements its functions
through a set of subcommands:
</para>
<variablelist>
<varlistentry><term><command>admin</command></term>
<listitem>
<para>Modify the contents of an information library by copying, renaming,
rearranging, or removing bookcases. You can also list the contents of a
library.
</para>
</listitem>
</varlistentry>
<varlistentry><term><command>build</command></term>
<listitem>
<para>Build a DtInfo information library from bookcase
specifications.
</para>
</listitem>
</varlistentry>
<varlistentry><term><command>tocgen</command></term>
<listitem>
<para>Generate a hypertext table of contents for a book.
</para>
</listitem>
</varlistentry>
<varlistentry><term><command>update</command></term>
<listitem>
<para>Replace existing style sheet information in a bookcase.
</para>
</listitem>
</varlistentry>
<varlistentry><term><command>validate</command></term>
<listitem>
<para>Verify that a document conforms to SGML and to the
DocBook.DTD.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<para>The following options are available:
</para>
<variablelist>
<varlistentry><term><literal>&minus;h</literal></term>
<listitem><para>Displays a help message for each available option.
</para></listitem>
</varlistentry>
<varlistentry><term><literal>&minus;T</literal> <replaceable>TmpDir</replaceable></term>
<listitem><para>Specifies the directory in which temporary files are placed during the
build process. The default is to use the environment variable
<systemitem class="environvar">TMPDIR</systemitem>. If variable
<systemitem class="environvar">TMPDIR</systemitem> is not set,
<filename>/usr/tmp</filename> is used.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;m</literal> <replaceable>CatalogFile</replaceable></term>
<listitem><para>Specifies a catalog file conforming to the SGML Open specification for
resolving SGML entities. You can use multiple
<literal>&minus;m</literal> options to specify as many
<replaceable>CatalogFile</replaceable>s as you wish.
</para></listitem>
</varlistentry>
<varlistentry><term><literal>&minus;l</literal> <replaceable>Library</replaceable></term>
<listitem><para>Specifies the location of the information library to build.
<replaceable>Library</replaceable> is the name of the directory that
contains the built bookcase(s).
</para></listitem>
</varlistentry>
<varlistentry><term><literal>&minus;d</literal> <replaceable>LibraryDescription</replaceable></term>
<listitem><para><replaceable>LibraryDescription</replaceable> is a brief description of
the information library to be built.
</para></listitem>
</varlistentry>
<varlistentry><term><literal>&minus;n</literal> <replaceable>LibraryShortName</replaceable></term>
<listitem><para><replaceable>LibraryShortName</replaceable> specifies an abbreviated name for
the information library to be built.
</para></listitem>
</varlistentry>
<varlistentry><term><replaceable>bookcase</replaceable></term>
<listitem><para>The SGML bookcase instance conforming to the
dtinfoBook.dtd.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;f</literal> <replaceable>TOCfile</replaceable></term>
<listitem><para>Specifies the SGML instance of a hypertext table of contents conforming
to the dtinfoTOC.dtd.
</para></listitem>
</varlistentry>
<varlistentry><term><replaceable>document</replaceable></term>
<listitem><para>A DocBook SGML source file.
</para></listitem>
</varlistentry>
<varlistentry><term><literal>&minus;b</literal> <replaceable>BookcaseName</replaceable></term>
<listitem><para>The name of the bookcase whose style sheet information will be updated.
The content of the <Symbol>BOOKCASENAME</Symbol> element in the
dtinfoBook.dtd.
</para></listitem>
</varlistentry>
<varlistentry><term><replaceable>stylesheet</replaceable></term>
<listitem><para>The style sheet that is to be updated in the bookcase.
</para></listitem>
</varlistentry>
<varlistentry><term><replaceable>SGMLdocument</replaceable></term>
<listitem><para>Any SGML document to be validated.
</para></listitem>
</varlistentry>
<varlistentry><term><literal>&minus;id</literal> <replaceable>TOCid</replaceable></term>
<listitem><para>The unique identifier of the hypertext table of contents
document.
</para></listitem>
</varlistentry>
<varlistentry><term><literal>&minus;title</literal> <replaceable>TOCtitle</replaceable></term>
<listitem><para>The title of the table of contents. This title will be
displayed in the DtInfo Browser.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>admin</title>
<para>The <command>admin</command> subcommand is an interactive script for
modifying an existing information library without rebuilding it. It
displays a command line menu from which you select one of the following
administration functions to perform on a specified information library:
</para>
<itemizedlist>
<listitem><para>Copy a bookcase from another library.
</para></listitem>
<listitem><para>Remove a bookcase from a library.
</para></listitem>
<listitem><para>List the bookcases in a library.
</para></listitem>
<listitem><para>Rename a bookcase.
</para></listitem>
<listitem><para>Rearrange bookcases within a library.
</para></listitem>
</itemizedlist>
<refsect2>
<title>Example</title>
<para>Enter the <command>dtinfogen admin</command> command in a shell window:
</para>
<literallayout><command>dtinfogen admin</command>
</literallayout>
<para>The following menu appears:
</para>
<literallayout>
1) Copy a bookcase from another library
2) Remove a bookcase
3) List bookcases in a library
4) Rename a bookcase
5) Rearrange bookcases in a library
6) Exit
Please enter your choice [1-6]
</literallayout>
<para>Enter the number associated with the administrative task you
want to perform.
<command>dtinfogen admin</command> prompts for additional input as
required.
</para>
</refsect2>
</refsect1>
<refsect1>
<title>build</title>
<para>The <command>build</command> subcommand compiles a bookcase specification into a
hypertext database. It validates the hypertext links, the identifier
uniqueness, and the hierarchical structure of the bookcase elements.
It also creates a full-text search index.
</para>
<refsect2>
<title>Example</title>
<para>Enter the <command>dtinfogen&nbsp;build</command> command in a shell
window.
</para>
<para>To build an information library containing multiple bookcases,
an example command might be:
</para>
<programlisting>
<userinput>build -l
</userinput> <replaceable>UNIXLib</replaceable><userinput> -T
</userinput> <filename>/usr/pers</filename><userinput>
</userinput> <replaceable>ProgBooks</replaceable><userinput>
</userinput> <replaceable>RefBooks</replaceable><userinput>
</userinput> <replaceable>UAdminBooks</replaceable>
</programlisting>
<para>This <command>build</command> command creates a document database from
three bookcases (<replaceable>ProgBooks</replaceable>,
<replaceable>RefBooks</replaceable>, and
<replaceable>UAdminBooks</replaceable>) and reports any errors. It uses
<filename>/usr/pers</filename> to store temporary intermediate files,
and it deposits the database in a directory (library) called
<replaceable>UNIXLib</replaceable>.
</para>
</refsect2>
</refsect1>
<refsect1>
<title>tocgen</title>
<para>The <command>tocgen</command> subcommand reads the SGML-conforming
source file(s) for a book and generates a hypertext table of contents.
</para>
<refsect2>
<title>Example</title>
<para>Enter the <command>dtinfogen tocgen</command> command in a shell
window.
</para>
<para>To generate a hypertext table of contents for a book containing six SGML
book source files, each of which contains a separate chapter, an example
command might be:
</para>
<programlisting><userinput>dtinfogen tocgen -T
</userinput> <filename>/usr/pers</filename><userinput> -f
</userinput> <replaceable>Perl.TOC</replaceable><userinput> -id
</userinput> <replaceable>Perl0594</replaceable>
<userinput>-title</userinput> <replaceable>&ldquo;Perl Table of Contents&rdquo; Perl.01 Perl.02 Perl.03 Perl.04 Perl.05 Perl.06</replaceable>
</programlisting>
<para>This <command>tocgen</command> command generates a table of contents file named
<replaceable>Perl.TOC</replaceable> with the unique identifier
<replaceable>Perl0594</replaceable> and the title
<replaceable>PerlTable of Contents</replaceable>.
<command>tocgen</command> parses the files
<replaceable>Perl.01</replaceable>,
<replaceable>Perl.02</replaceable>,
<replaceable>Perl.03</replaceable>,
<replaceable>Perl.04</replaceable>,
<replaceable>Perl.05</replaceable>, and
<replaceable>Perl.06</replaceable> to produce the TOC.
</para>
<para>The <command>tocgen</command> process uses
<filename>/usr/pers</filename> to store temporary intermediate files
during processing.
</para>
</refsect2>
</refsect1>
<refsect1>
<title>update</title>
<para>The <command>dtinfogen update</command> command dynamically replaces
existing style sheets in the DtInfo document database.
</para>
<refsect2>
<title>Example</title>
<para>Enter the <command>dtinfogen update</command> command in a shell window.
</para>
<para>Here is an example of a <command>dtinfogen update</command> command used
to reformat the documents and/or document sections that use the
specified style sheet:
</para>
<programlisting><userinput>dtinfogen update -T
</userinput> <filename>/usr/pers</filename><userinput> -b
</userinput> <replaceable>ICE9</replaceable><userinput> -l
</userinput> <replaceable>Brunn style</replaceable>
</programlisting>
<para>This <command>update</command> command reformats the documents or
document sections in the <replaceable>Brunn</replaceable> information
library that use the style sheet named <replaceable>style</replaceable>,
that is specified in the bookcase named <replaceable>ICE9</replaceable>.
</para>
</refsect2>
</refsect1>
<refsect1>
<title>validate</title>
<para>The <command>dtinfogen validate</command> command performs SGML
validation on bookcase specifications, on individual book source files,
or any SGML document.
</para>
<refsect2>
<title>Examples</title>
<para>Enter the <command>dtinfogen validate</command> in a shell window.
</para>
<para>Here is an example of a <command>dtinfogen validate</command> command
that performs validation on three SGML book source files:
</para>
<programlisting>
<userinput>dtinfogen validate
</userinput> <replaceable>03.Structure.N</replaceable><userinput>
</userinput> <replaceable>04.Process.N</replaceable><userinput>
</userinput> <replaceable>05.BookArea.N</replaceable>
</programlisting>
<para>This <command>validate</command> command verifies the SGML compliance of
the three files, <replaceable>03.Structure.N</replaceable>,
<replaceable>04.Process.N</replaceable>, and <replaceable>05.BookArea.N</replaceable>,
based on their DTD(s).
</para>
</refsect2>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>&cdeman.dtinfo;,
&cdeman.dtinfoBook.dtd;,
&cdeman.dtinfoStyle.dtd;,
&cdeman.dtinfoTOC.dtd;
</Para>
</refsect1></refentry>

3327
cde/doc/C/guides/man/man1_dt/ksh.sgm Normal file
View File

File diff suppressed because it is too large Load Diff

2076
cde/doc/C/guides/man/man1_dt/login.sgm Normal file
View File

File diff suppressed because it is too large Load Diff

576
cde/doc/C/guides/man/man1_dt/lp.sgm Normal file
View File

@@ -0,0 +1,576 @@
<!-- $XConsortium: lp.sgm /main/7 1996/09/08 19:54:51 rws $ -->
<!-- (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.MAN26.rsml.1">
<RefMeta>
<RefEntryTitle>dtlp</RefEntryTitle>
<ManVolNum>user cmd</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Command>dtlp</Command></RefName>
<RefPurpose>gather lp arguments and print a file
</RefPurpose>
</RefNameDiv>
<!-- CDE Common Source Format, Version 1.0.0-->
<!-- *************************************************************************-->
<!-- ** (c) Copyright 1993, 1994 Hewlett-Packard Company-->
<!-- ** (c) Copyright 1993, 1994 International Business Machines Corp.-->
<!-- ** (c) Copyright 1993, 1994 Sun Microsystems, Inc.-->
<!-- ** (c) Copyright 1993, 1994 Novell, Inc.-->
<!-- *************************************************************************-->
<RefSynopsisDiv>
<CmdSynopsis>
<Command>dtlp</Command>
<Arg Choice="opt">-b <Replaceable>banner_title</Replaceable></Arg>
<Arg Choice="opt">-d <Replaceable>lpdest</Replaceable></Arg>
<Arg Choice="opt">-m <Replaceable>print_command</Replaceable></Arg>
<Arg Choice="opt">-n <Replaceable>copy_count</Replaceable></Arg>
<Arg Choice="opt">-o <Replaceable>other_options</Replaceable></Arg>
<Arg Choice="opt">-u <Replaceable>user_filename</Replaceable></Arg>
<Arg Choice="opt">-a</Arg>
<Arg Choice="opt">-e</Arg>
<Arg Choice="opt">-h</Arg>
<Arg Choice="opt">-r</Arg>
<Arg Choice="opt">-s</Arg>
<Arg Choice="opt">-v</Arg>
<Arg Choice="opt">-w</Arg>
<Arg Choice="opt"><Replaceable>print_file</Replaceable></Arg>
</CmdSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Command>dtlp</Command> command line utility is a front-end to the
<Literal>lp</Literal> subsystem.
The
<Command>dtlp</Command> utility
gathers
<Literal>lp</Literal> print options and prints a specified
file.
It operates in two modes:
</Para>
<VariableList>
<VarListEntry>
<Term><Literal>GUI mode</Literal></Term>
<ListItem>
<Para>By default,
<Command>dtlp</Command> posts a
<Symbol Role="Message">Print</Symbol> dialog that appears with <Symbol Role="Message">Print</Symbol>,
<Literal>Cancel</Literal>, and <Literal>Help</Literal> pushbuttons.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>Silent mode</Literal></Term>
<ListItem>
<Para>When invoked with the <Emphasis>silent</Emphasis> flag,
<Command>dtlp</Command> does not present the GUI input dialog.
It collects input arguments from the command line and environment
variables.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<RefSect2>
<Title>The Print Dialog</Title>
<Para>When invoked normally,
<Command>dtlp</Command> posts a
<Symbol Role="Message">Print</Symbol> dialog that shows:
</Para>
<VariableList>
<VarListEntry>
<Term><Literal>File</Literal></Term>
<ListItem>
<Para>The name of the file to print (a read-only text label).
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>Printer</Literal></Term>
<ListItem>
<Para>The printer device.
The default is the value of the <SystemItem Class="EnvironVar">LPDEST</SystemItem> environment variable.
If
<SystemItem Class="EnvironVar">LPDEST</SystemItem> is unset, then the properly localized string
<Literal>Default</Literal>
appears in the text field.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>Copies</Literal></Term>
<ListItem>
<Para>The number of copies to print.
The default is 1.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>Banner Page Title</Literal></Term>
<ListItem>
<Para>The title to appear on the printed banner page,
and if formatted, in the header of each page.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>Print Page Numbers</Literal></Term>
<ListItem>
<Para>A checkbox to indicate
whether the file should be printed formatted (run through the
<Literal>pr -f</Literal> command) or printed unformatted.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>Print Command Options</Literal></Term>
<ListItem>
<Para>Any options to be passed directly to the
<Literal>lp</Literal> command.
For example, some implementations support the <Literal>-o2</Literal>
option to
<Literal>lp</Literal> to enable double-page printing.
</Para>
<Para>When the user presses the <Symbol Role="Message">Print</Symbol> button, these settings are
passed onto the
<Literal>lp</Literal> subsystem,
along with the values of any other environment settings (see the
<Symbol>ENVIRONMENT</Symbol> heading in this man page).
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect2>
</RefSect1>
<RefSect1>
<Title>OPTIONS</Title>
<Para>The
<Command>dtlp</Command> command accepts a <Emphasis>print_file</Emphasis> name specification.
If a
<Emphasis>print_file</Emphasis> is not specified, standard input is assumed.
When used in
this fashion, the <Literal>-u</Literal> <Emphasis>user_filename</Emphasis> option can be used to
pass a name to
<Command>dtlp</Command> for display in the
<Symbol Role="Message">Print</Symbol> dialog.
</Para>
<RefSect2>
<Title>Command Line Options and the ENVIRONMENT Setting</Title>
<Para>The
<Command>dtlp</Command> command
is sensitive to some ENVIRONMENT settings.
In the case in which both a command line option and a
complementary environment
setting are
specified, the command line option takes precedence.
</Para>
</RefSect2>
<RefSect2>
<Title>Command Line Options</Title>
<VariableList>
<VarListEntry>
<Term>&minus;b banner_title</Term>
<ListItem>
<Para>Set the string used in printing the banner on the title page.
If the <Literal>-r</Literal> option is also specified, then print this same string
on the page headers.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>&minus;d lpdest</Term>
<ListItem>
<Para>Set the printer destination for the file.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>&minus;m print_command</Term>
<ListItem>
<Para>Use this value as the path name of the
<Literal>lp</Literal> print command.
The default is
<Literal>lp</Literal>.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>&minus;n copy_count</Term>
<ListItem>
<Para>Print this many copies.
Default is 1.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>&minus;o other_options</Term>
<ListItem>
<Para>Pass these options directly through to the
<Literal>print_command</Literal>, without any interpretation.
This setting is
intended for users with advanced printing knowledge.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>&minus;u user_filename</Term>
<ListItem>
<Para>Use this value as the name of file as it should appear in the
<Symbol Role="Message">Print</Symbol> dialog or print output.
Default is <Literal>print_file</Literal>.
Equivalent to the <Emphasis>DTPRINTUSERFILENAME</Emphasis>
setting under the <Symbol>ENVIRONMENT</Symbol> heading in this man page.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>&minus;a</Term>
<ListItem>
<Para>Causes the file to be formatted with the <Literal>man</Literal>
command.
If set, then other formatting specifications (such
as <Literal>-r</Literal>) are ignored.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>&minus;e</Term>
<ListItem>
<Para>Remove the file after printing it.
This functionality is intended for temporary files generated by
applications that
don't need to persist beyond the act of printing.
Equivalent to the <Emphasis>DTPRINTFILEREMOVE</Emphasis>.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>&minus;h</Term>
<ListItem>
<Para>Print out a help message.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>&minus;r</Term>
<ListItem>
<Para>Format the file before printing it, by running it through
the <Literal>pr -f</Literal> command.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>&minus;s</Term>
<ListItem>
<Para>Print the file silently, without posting the
<Symbol Role="Message">Print</Symbol> dialog.
Equivalent to the <Emphasis>DTPRINTSILENT</Emphasis>
setting under the <Symbol>ENVIRONMENT</Symbol> heading in this man page.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>&minus;v</Term>
<ListItem>
<Para>Print out verbose messages during the print process.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>&minus;w</Term>
<ListItem>
<Para>Causes output to the printer to be sent raw, with no
interpretation of tabs, backspaces, formfeeds, and
binary characters.
Useful for printing <Symbol>PCL</Symbol> and <Symbol>PS</Symbol> files.
If set, then other formatting specifications (such
as <Literal>-r</Literal>) are ignored; however, the <Literal>-a</Literal> option
will take precedence over this setting.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>print_file</Term>
<ListItem>
<Para>Print this file.
If <Emphasis>print_file</Emphasis>
is not supplied, standard input is assumed.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect2>
</RefSect1>
<RefSect1>
<Title>ENVIRONMENT</Title>
<Para>Following are the names and meanings
of the environment values that affect the operation of
<Command>dtlp</Command>:
</Para>
<VariableList>
<VarListEntry>
<Term><SystemItem Class="EnvironVar">LANG</SystemItem></Term>
<ListItem>
<Para>Use the specified value to determine the locale of the message strings that
appear in the
<Symbol Role="Message">Print</Symbol> dialog.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="EnvironVar">LPDEST</SystemItem></Term>
<ListItem>
<Para>Use the specified value as the printer destination for the file.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>DTPRINTCWD</Emphasis></Term>
<ListItem>
<Para>If set to an existing, usable directory, this setting
causes
<Command>dtlp</Command> to execute the
<Literal>lp</Literal> command pipeline from that
directory.
By default, uses the current directory
from which
<Command>dtlp</Command> is invoked.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>DTPRINTFILEREMOVE</Emphasis></Term>
<ListItem>
<Para>Equivalent to the <Literal>-e</Literal>
command line setting.
Value must be <SystemItem Class="Constant">True</SystemItem>
or <SystemItem Class="Constant">False</SystemItem> (case is ignored).
Default is <SystemItem Class="Constant">False</SystemItem>.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>DTPRINTSILENT</Emphasis></Term>
<ListItem>
<Para>Equivalent to the <Literal>-s</Literal>
command line setting.
Value must be <SystemItem Class="Constant">True</SystemItem>
or <SystemItem Class="Constant">False</SystemItem> (case is ignored).
Default is <SystemItem Class="Constant">False</SystemItem>.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>DTPRINTUSERFILENAME</Emphasis></Term>
<ListItem>
<Para>Equivalent to the <Literal>-u</Literal>
command line setting.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<RefSect2>
<Title>Reconciling Options</Title>
<Para>In the case of conflicting formatting options,
<Command>dtlp</Command> uses the following decisions to reconcile them:
</Para>
<ItemizedList>
<ListItem>
<Para>If any <Emphasis>raw</Emphasis>
(as with <Option>-w</Option>), or <Symbol Role="Variable">man</Symbol> (as with
<Literal>-a</Literal>)
options are specified, all
other page formatting and numbering options are turned off;
otherwise, page printing and formatting are allowed.
</Para>
</ListItem>
<ListItem>
<Para>In a formatted operation:
If a banner title is specified (as with
<Literal>-b</Literal>), it will be used
as the page header.
</Para>
</ListItem>
<ListItem>
<Para>If a user filename is specified (as with
<Literal>-u</Literal> or
<Emphasis>DTPRINTUSERFILENAME</Emphasis>), it will be used as the page
header;
otherwise, the filename itself will be used as the page header.
</Para>
</ListItem>
</ItemizedList>
</RefSect2>
</RefSect1>
<RefSect1>
<Title>RETURN VALUES</Title>
<VariableList>
<VarListEntry>
<Term>0</Term>
<ListItem>
<Para>Command completed successfully.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>-1</Term>
<ListItem>
<Para>The user pressed the <Literal>Cancel</Literal> button.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>2</Term>
<ListItem>
<Para>Usage error.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>3</Term>
<ListItem>
<Para>There is no specified file to print.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>4</Term>
<ListItem>
<Para>Unable to find the <Command>dtksh</Command> initialization file,
<Filename>/usr/dt/scripts/DtFuncs.sh</Filename>.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>5</Term>
<ListItem>
<Para>The file is an invalid file (for example, a directory or a device file).
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>6</Term>
<ListItem>
<Para>The user has no read permission on the file.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>EXAMPLES</Title>
<RefSect2>
<Title>Command Line</Title>
<Para>The following command line causes
<Command>dtlp</Command> to post a
<Symbol Role="Message">Print</Symbol> dialog
for <Literal>file1</Literal> with a name displayed of
<Literal>Your File</Literal> and with the default printer chosen:
<Literal>/usr/dt/bin/dtlp -u "Your File" file1</Literal>
The following command line causes
<Command>dtlp</Command> to silently print two copies of <Literal>file2</Literal> on printer
<Literal>laser3</Literal>:
<Literal>/usr/dt/bin/dtlp -n 2 -d laser3 -s file2</Literal>
</Para>
</RefSect2>
<RefSect2>
<Title>Action Definition</Title>
<Para>The following <Symbol Role="Message">Print</Symbol> action would cause a <Symbol>PCL</Symbol> file to
be printed using the
<Command>dtlp</Command> command.
</Para>
<InformalExample Remap="indent">
<ProgramListing>ACTION Print
{
LABEL Print
ARG_TYPE PCL
TYPE COMMAND
WINDOW_TYPE NO_STDIO
EXEC_STRING /usr/dt/bin/dtlp -w %Arg_1%
}
</ProgramListing>
</InformalExample>
<Para>The following <Symbol Role="Message">Print</Symbol> action would cause a man page file to
be printed using the
<Command>dtlp</Command> command.
</Para>
<InformalExample Remap="indent">
<ProgramListing>ACTION Print
{
LABEL Print
ARG_TYPE MAN_PAGE
TYPE COMMAND
WINDOW_TYPE NO_STDIO
EXEC_STRING /usr/dt/bin/dtlp -a %Arg_1%
}
</ProgramListing>
</InformalExample>
<Para>By default,
these actions will post the
<Symbol Role="Message">Print</Symbol> dialog.
</Para>
</RefSect2>
</RefSect1>
<RefSect1>
<Title>LOCALES AND CODESETS</Title>
<Para>The strings that appear in the
<Symbol Role="Message">Print</Symbol> dialog are localizable.
</Para>
</RefSect1>
<RefSect1>
<Title>FILES</Title>
<VariableList>
<VarListEntry>
<Term><Filename>/usr/dt/appconfig/types/C/print.dt</Filename></Term>
<ListItem>
<Para>Defines the default system <Symbol Role="Message">Print</Symbol> action.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Filename>/usr/dt/appconfig/types/C/dt.dt</Filename></Term>
<ListItem>
<Para>Defines the default <Symbol Role="Message">Print</Symbol> actions for
man pages (type <Symbol>MAN</Symbol>), ASCII files (type <Symbol>TEXTFILE</Symbol>),
PCL files (type <Symbol>PCL</Symbol>), and PS files (type <Symbol>POSTSCRIPT</Symbol>).
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>/etc/dt/appconfig/types/C/*.dt</Literal></Term>
<ListItem>
<Para>The datatype files that implement the per-printer <Symbol Role="Message">Print</Symbol>
action; these are created by the <Literal>dtprintinfo -populate</Literal> command.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Filename>/usr/dt/scripts/DtFuncs.sh</Filename></Term>
<ListItem>
<Para>The <Command>dtksh</Command> initialization file that defines a number
of GUI convenience functions, as for creating a dialog box.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>BUGS</Title>
<Para>The
<Command>dtlp</Command> <Symbol Role="Message">Print</Symbol> dialog cannot accept quote marks (either <Literal>'</Literal> or <Literal>"</Literal>)
in the <Literal>Banner Page Title</Literal> text field.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dtsearchpath;, &cdeman.dtprintinfo;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->

475
cde/doc/C/guides/man/man1_dt/mail.sgm Normal file
View File

@@ -0,0 +1,475 @@
<!-- $XConsortium: mail.sgm /main/12 1996/10/30 18:20:57 rws $ -->
<!-- (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.MAN27.rsml.1">
<refmeta><refentrytitle>dtmail</refentrytitle><manvolnum>user cmd</manvolnum>
</refmeta>
<refnamediv><refname><command>dtmail</command></refname><refpurpose>the desktop
mailer</refpurpose></refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>dtmail</command><arg choice="opt">&minus;h</arg><arg choice="opt">&minus;c</arg><arg choice="opt">&minus;f<replaceable>mailfile</replaceable></arg><group><arg>&minus;a <replaceable>file1</replaceable></arg><arg>...<replaceable>fileN</replaceable></arg></group>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>The <emphasis>Dtmail</emphasis> program is a mailer for use on the desktop.
It provides an easy-to-use interface for viewing, filing, composing and
sending electronic mail containers and mail messages.</para>
<para>The Mailer provides a GUI-based interface for manipulating electronic
mail messages that can have attachments. Use the interface to compose a
message, view a message or a container holding messages, load new mail, copy
or move messages from one container to another, delete messages, reply to
messages, add and delete attachments to a message when composing, and view
contents of attachments in a message. The Mailer also provides a mail-pervasive
desktop environment by providing a public Tooltalk API. Other clients can
use the Tooltalk API to compose and send messages.</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry><term>&minus;a file1 ... fileN</term>
<listitem>
<!-- ex-TP-->
<para>Bring up a Compose window with &thinsp;file1&thinsp; through &thinsp;fileN&thinsp;
as attachments.</para>
</listitem>
</varlistentry>
<varlistentry><term>&minus;c</term>
<listitem>
<!-- ex-TP-->
<para>Bring up an empty Compose window</para>
</listitem>
</varlistentry>
<varlistentry><term>&minus;f filename</term>
<listitem>
<!-- ex-TP-->
<para>This specifies the mail file to be loaded in at start up time. Ordinarily,
the mailfile pointed to by the environment variable MAIL is read in as the
user's inbox. Use of this option overrides the use of the MAIL variable.
</para>
</listitem>
</varlistentry>
<varlistentry><term>&minus;h</term>
<listitem>
<!-- ex-TP-->
<para>Display help for command line options</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>RESOURCES</title>
<para>The Mailer provides the following resources:</para>
<variablelist>
<varlistentry><term>Dtmail*Message_List*doubleClickInterval</term>
<listitem>
<!-- ex-TP-->
<para>The double click time out (in milliseconds) for the scrolling message
header list. Default is 400 milliseconds.</para>
</listitem>
</varlistentry>
<varlistentry><term>Dtmail*Message_List*background</term>
<listitem>
<!-- ex-TP-->
<para>Color to use for the scrolling message header list background. Default
is system dependent.</para>
</listitem>
</varlistentry>
<varlistentry><term>Dtmail*Message_List*foreground</term>
<listitem>
<!-- ex-TP-->
<para>Color to use for the scrolling message header list foreground. Default
is system dependent.</para>
</listitem>
</varlistentry>
<varlistentry><term>Dtmail*Message_List*fontList</term>
<listitem>
<!-- ex-TP-->
<para>The list of fonts to use in the scrolling message header list. The
list must contain two fonts. The first must be tagged "plain" and is the
font used to render the header text. The second must be tagged "attach" and
is used to render the attachment indicator. Default is to use system dependent
fixed width fonts.</para>
</listitem>
</varlistentry>
<varlistentry><term>Dtmail*Work_Area*Text*background</term>
<listitem>
<!-- ex-TP-->
<para>Color to use for the View and Compose window text background. Default
is system dependent.</para>
</listitem>
</varlistentry>
<varlistentry><term>Dtmail*Work_Area*Text*foreground</term>
<listitem>
<!-- ex-TP-->
<para>Color to use for the View and Compose window text foreground. Default
is system dependent.</para>
</listitem>
</varlistentry>
<varlistentry><term>Dtmail*Work_Area*Text*fontList</term>
<listitem>
<!-- ex-TP-->
<para>The list of fonts to use in the View and Compose windows. Font tag
"plain". Default is to use a system dependent variable width font.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>MAIL VARIABLES</title>
<para>In addition to the variables recognized by <Filename MoreInfo="RefEntry">mailx</Filename>(1), <command>dtmail</command> recognizes those listed below. They can be set by editing
your <Filename>.mailrc</Filename> file; however, since most of the variables
are accessible through the Mailer Options menu, we strongly recommend that
you modify them there to reduce the chance of error. Unless otherwise noted,
the default for the following variables is <emphasis>off.</emphasis></para>
<variablelist>
<varlistentry><term>additionalfields</term>
<listitem>
<!-- ex-TP-->
<para>A list of header fields to access via the <literal>Format</literal>
menu. This variable can be accessed through the <literal>Custom Fields:</literal>, <literal>Header Field:</literal>, and <literal>Default Value:</literal> portions of the Compose Window
category in the Mail Options dialog.</para>
</listitem>
</varlistentry>
<varlistentry><term>bell</term>
<listitem>
<!-- ex-TP-->
<para>The number of times to ring the bell when new mail arrives. This variable
can be accessed through the <symbol role="Message">Signal</symbol> <literal>New Mail</literal> portion in the Message
Header List category of the Mail Options dialog. The default is 0.</para>
</listitem>
</varlistentry>
<varlistentry><term>composeinterval</term>
<listitem>
<!-- ex-TP-->
<para>The interval in seconds for checkpointing to dead.letter. Default is
every 600 seconds (10 minutes).</para>
</listitem>
</varlistentry>
<varlistentry><term>dontlogmessages</term>
<listitem>
<!-- ex-TP-->
<para>This variable controls whether or not the <literal>Log Message</literal> item is selected in the File Menu in the Compose window.
The default is to log messages. This variable can be accessed through the <literal>Log all sent messages</literal> item in the Message Filing category of the Mail Options dialog.
</para>
</listitem>
</varlistentry>
<varlistentry><term>expert</term>
<listitem>
<!-- ex-TP-->
<para>Set expert mode in which minimal confirmations are requested. This variable
can be accessed through the <literal>Show confirmation notices</literal> check box in the Advanced category of
the Mail Options dialog. <!--filemenu2 supersedes filemenu. dtmail does not
support filemenu--><!--.TP--><!--.B filemenu--></para>
</listitem>
</varlistentry>
<varlistentry><term>filemenu2</term>
<listitem>
<!-- ex-TP-->
<para>A list of files from which to initialize the <literal>Move</literal>,
and <literal>Copy To</literal> menus. These can be absolute
pathnames or pathnames relative to the directory specified in the <emphasis>folder</emphasis> variable. This variable can be accessed through the <literal>Move Menu</literal> and <literal>Copy To Menu:</literal> scrolling list in
the Message Filing category of the Mail Options dialog.</para>
</listitem>
</varlistentry>
<varlistentry><term>filemenusize</term>
<listitem>
<!-- ex-TP-->
<para>Specifies the maximum number of entries in the <literal>Move</literal>,
and <literal>Copy To</literal> menus. The default is 10.
</para>
</listitem>
</varlistentry>
<varlistentry><term>flash</term>
<listitem>
<!-- ex-TP-->
<para>The number of times to flash the window or icon when new mail arrives.
This variable can be accessed through the Signal New Mail portion of the
Message Header List category of the Mail Options Dialog. The default is 0.
</para>
</listitem>
</varlistentry>
<varlistentry><term>folder</term>
<listitem>
<!-- ex-TP-->
<para>The directory for saving mail files. This variable can be accessed
through the <literal>Start Looking In</literal> item in the Mail Filing category of the Mail Options Dialog.
</para>
</listitem>
</varlistentry>
<varlistentry><term>headerlines</term>
<listitem>
<!-- ex-TP-->
<para>The number of lines to display at a time in the scrolling header list.
This variable can be accessed through the <symbol role="Message">Display</symbol>
item in the Message View category of the Mail Options dialog. The default
is 15.</para>
</listitem>
</varlistentry>
<varlistentry><term>hideattachments</term>
<listitem>
<!-- ex-TP-->
<para>Hide the attachments pane in the Compose Message window by default.
This variable can be accessed through the <literal>Show Attachment List</literal> item in the Compose Window category
of the Mail Options dialog. The default is to show the attachment pane.</para>
</listitem>
</varlistentry>
<varlistentry><term>indentprefix</term>
<listitem>
<!-- ex-TP-->
<para>When indentprefix is set, the string that it is set to is used to mark
indented lines from included messages. The default indentprefix is "> ". This
variable can be accessed through the <literal>Indent String</literal> item in the Compose Window category of
the Mail Options dialog. <!-- [ 8/11/94 dipol ]--><!-- Don't think we support
this anymore--><!-- .B popuplines--><!-- The number of lines in the View Message
and Compose Message--><!-- Windows.--><!-- This variable can be accessed through
the Mail Tool--><!-- Property Sheet in the Message Window category as--><!--
.B Display--><!-- __ Lines of Text. The default is 30.--><!-- .TP--><!--
.B printmail--><!-- The command to use to print a message. This variable
can--><!-- be accessed through the Mail Tool Property Sheet in the--><!--
Message Window category as--><!-- .B Print Script.--><!-- The default is \fBlp
-s\fP.--></para>
</listitem>
</varlistentry>
<varlistentry><term>keepdeleted</term>
<listitem>
<!-- ex-TP-->
<para>Don't purge the mailbox of deleted messages when closing (exiting) dtmail.
Default is to ask the user if they would like to purge the mailbox on exit.
This variable can be set in the <literal>Destroy Deleted Messages</literal> portion in the Message Header List
category of the Mail Options dialog. See <literal>quietdelete</literal>
</para>
</listitem>
</varlistentry>
<varlistentry><term>quietdelete</term>
<listitem>
<!-- ex-TP-->
<para>Don't ask for confirmation when purging the mailbox of deleted messages
when exiting dtmail. This variable can be set in the <literal>Destroy Deleted Messages</literal> portion in the Message Header
List category of the Mail Options dialog. See <literal>keepdeleted</literal>
</para>
</listitem>
</varlistentry>
<varlistentry><term>record</term>
<listitem>
<!-- ex-TP-->
<para>The mail file in which to record outgoing messages. You can control
recording of outgoing mail on a per message basis by the <literal>Log Message</literal> item in the Compose window's File menu. The <emphasis>dontlogmessages</emphasis> variable controls whether or not this item is selected by default.
The <emphasis>record</emphasis> variable may be set through the <literal>Mailbox for Sent Messages:</literal> item in the Message Filing category of the Mail Options
Dialog. If <emphasis>record</emphasis> is not set and the user chooses to
log a message then the message will be saved in ~/sent.mail.</para>
</listitem>
</varlistentry>
<varlistentry><term>retrieveinterval</term>
<listitem>
<!-- ex-TP-->
<para>The interval in seconds to check for new mail. This variable can be
accessed through the <literal>Check for New Mail Every:</literal>
item in the Message Header List category of the Mail Options Dialog. The default
is 300 seconds.</para>
</listitem>
</varlistentry>
<varlistentry><term>saveinterval</term>
<listitem>
<!-- ex-TP-->
<para>The interval (in seconds) at which to checkpoint the state of the mail
box to disk. Default is 1800 seconds (30 minutes). This variable can be set
using the <literal>Update Mailbox State</literal> item in the Advanced category of the Mail Options dialog. <!--.TP--><!--.B
save--><!--Save contents of each Compose Message window in a dead.letter file
until the--><!--message is delivered successfully. If a Compose Message window
is quit, and--><!--a new one is brought up, the new window will reuse the
dead.letter from the--><!--previous window. The first dead.letter file is
called dead.letter, the--><!--second one is called dead.letter.1, the third
dead.letter.2, and so on.--><!--The default is--><!--.I on.--><!--.TP--></para>
</listitem>
</varlistentry>
<varlistentry><term>showmsgnum</term>
<listitem>
<!-- ex-TP-->
<para>Show message numbers in the scrolling list of message headers. This
variable can be set using the <literal>Display message numbers</literal> item in the Message Header List
category of the Mail Options dialog. Default is to not show message numbers. <literal>showto</literal> Show the "To" field of mail messages in the Header Window
if the mail is from the same user that is reading mail (eg. you). This variable
is accessed using the <literal>Show To: recipient when mail is</literal> item in the Message Header List category of the Mail Options
dialog. <!--.B sortfilemenu--><!--Sort the--><!--.B Move, Copy,--><!--and--><!--.B
Load--><!--menus alphabetically.--><!--.TP--><!--.B suppressautoretrieve--><!--Do
not automatically retrieve new mail messages.--><!--This variable can be accessed
through the Mail Tool--><!--Property Sheet in the Header Window category as--><!--the
Automatically display headers check box.--><!--Default is to automatically
retrieve new mail.--></para>
</listitem>
</varlistentry>
<varlistentry><term>strictmime</term>
<listitem>
<!-- ex-TP-->
<para>Use strict MIME character encoding for outgoing mail. In this case all
lines longer than 72 characters are broken with a newline (and a trailing
"=" is appended to the line), and all trailing spaces are encoded (appearing
as "=20"). Any time character encoding takes place all "=" must be protected
and are therefore are encoded as "=3d". Note that 8 bit characters are always
encoded, even if strictmime is not specified. If you typically send mail to
users of non MIME compliant readers you may want to consider not specifying
strictmime. This variable can be set by selecting the <literal>Use strict MIME character encoding</literal> item in the Advanced category of the Mail Options dialog.
The default is to use more relaxed character encoding (ie don't break long
lines and don't protect trailing spaces).</para>
</listitem>
</varlistentry>
<varlistentry><term>templates</term>
<listitem>
<!-- ex-TP-->
<para>A list of <emphasis>name:path</emphasis> pairs to access via the <literal>Templates</literal> item in the <literal>Format</literal> menu of the Compose
window. <symbol role="Variable">name</symbol> appears in the menu; <emphasis>path</emphasis> is the file included when name is selected. This variable
can be accessed in the Template category of the Mail Options dialog.</para>
</listitem>
</varlistentry>
<varlistentry><term>toolcols</term>
<listitem>
<!-- ex-TP-->
<para>Default width of the primary windows (in columns). This variable can
be accessed through the item in the Message View category of the Mail Options
dialog. <!--.B trash--><!--The name of the trash bin, which may be accessed
--><!--just like any other mail file.--><!--If set, all deleted messages are
moved to the trash bin. --><!--The trash bin is emptied when you commit changes.
This--><!--option degrades the performance of--><!--.B dtmail--><!--and
is not recommended.--></para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>MAIL COMMANDS</title>
<para>In addition to the commands recognized by <Filename MoreInfo="RefEntry">mailx</Filename>(1)
in the <emphasis>.mailrc</emphasis> file, <command>dtmail</command> also recognizes
the following commands.</para>
<variablelist>
<varlistentry><term>ignore [header-field...]</term>
<listitem>
<!-- ex-TP-->
<para>Suppress displaying of the specified header fields. Examples of header
fields to ignore are Status and Received. The fields are also ignored when
the message is printed. This variable can be accessed through the Abbreviated
Header item in the Message View category of the Mail Options dialog.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>PRINTING</title>
<para>You can print messages using command invocation by selecting the
message or messages to be printed and then activating the <literal>Print...</literal> command in the <literal>Message</literal> pulldown menu in the <command>dtmail</command> menu bar or the <literal>Print...</literal> command in the
<literal>Mailer - Messages</literal> popup menu that is displayed on
<literal>BMenu Down</literal> events in the message list.</para>
<para>In addition, you can use the <literal>Print</literal> command button
located at the bottom of the message headers list to print the currently
selected messages. In this case, the print job is started using the print
setup context from the last print command without displaying any of the print
setup dialogs.</para>
<para>Alternatively, you can print messages using Drag and Drop invocation.
</para>
<para>Messages containing attachments are printed with summary lines in place
of the attachment. You must print attachments individually in separate
print job invocations.</para>
<para>You can choose to print multiple messages either as a single print
job or as separate print jobs. If you print multiple messages in
a single print job, you can choose to separate the messages using
a blank line or a page break.</para>
<para>To print a mailboxes, use CDE Drag and Drop to drag the icon for the
mailbox from the File Manager to the printer icon in
the desktop.</para>
<para>When you invoke printing, whether by command invocation or by
drag and drop, <command>dtmail</command> displays a Print Setup window that
allows you to set a number of generic and printer-specific printing
options. For example, you can send the output to a file
or a printer. In the case of printed output, you can specify how many copies
you want. You can also access another window to set options specific to
the printer/spooler you are using. For example, you can select paper size,
orientation, a banner page title, one- or two-sided printing, and email notification
on completion of the print job.</para>
</refsect1>
<refsect1>
<title>ENVIRONMENT VARIABLES</title>
<para>The following are environment variables taken from the execution environment
and are not alterable within <command>dtmail</command>.</para>
<variablelist>
<varlistentry><term>HOME= directory</term>
<listitem>
<!-- ex-TP-->
<para>The user's home directory.</para>
</listitem>
</varlistentry>
<varlistentry><term>MAIL= filename</term>
<listitem>
<!-- ex-TP-->
<para>The name of the initial mailbox file to read (in lieu of the standard
system mailbox). The default is system dependent.
See FILE section.</para>
</listitem>
</varlistentry>
<varlistentry><term>MAILRC= filename</term>
<listitem>
<!-- ex-TP-->
<para>The name of the start-up file.
Default is
$HOME/.mailrc.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>FILES</title>
<variablelist>
<varlistentry><term>/var/mail/* (Sun)</term>
<listitem>
<para></para>
<!-- ex-TP-->
</listitem>
</varlistentry>
<varlistentry><term>/var/spool/mail/* (IBM)</term>
<listitem>
<para></para>
<!-- ex-TP-->
</listitem>
</varlistentry>
<varlistentry><term>/usr/mail* (HP)</term>
<listitem>
<!-- ex-TP-->
<para>System mailboxes</para>
</listitem>
</varlistentry>
<varlistentry><term>/etc/mail/mailx.rc</term>
<listitem>
<!-- ex-TP-->
<para>System setup file that is read in before ~/.mailrc.</para>
</listitem>
</varlistentry>
<varlistentry><term>~/.mailrc</term>
<listitem>
<!-- ex-TP-->
<para>Start-up file for
<command>mail</command> and
<command>dtmail</command>.</para>
</listitem>
</varlistentry>
<varlistentry><term>/usr/dt/bin/dtmail</term>
<listitem>
<!-- ex-TP-->
<para>Executable for the desktop Mailer.</para>
</listitem>
</varlistentry>
<varlistentry><term>/usr/dt/app-defaults/&lt;LANG>/Dtmail</term>
<listitem>
<!-- ex-TP-->
<para>Application defaults for the desktop Mailer.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
</refentry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->
<?Pub *0000022737>

67
cde/doc/C/guides/man/man1_dt/mailpr.sgm Normal file
View File

@@ -0,0 +1,67 @@
<!-- $XConsortium: mailpr.sgm /main/5 1996/09/08 19:55:10 rws $ -->
<!-- (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.MAN28.rsml.1">
<RefMeta>
<RefEntryTitle>dtmailpr</RefEntryTitle>
<ManVolNum>user cmd</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Command>dtmailpr</Command></RefName>
<RefPurpose>electronic mail message print filter
</RefPurpose>
</RefNameDiv>
<!--(c) Copyright 1993, 1994 Hewlett-Packard Company-->
<!--(c) Copyright 1993, 1994 International Business Machines Corp.-->
<!--(c) Copyright 1993, 1994 Sun Microsystems, Inc.-->
<!--(c) Copyright 1993, 1994 Novell, Inc.-->
<RefSynopsisDiv>
<CmdSynopsis>
<Command>dtmailpr</Command>
<Arg Choice="opt">&minus;f<Replaceable>filename</Replaceable></Arg>
<Arg Choice="opt">&minus;p</Arg>
</CmdSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Command>dtmailpr</Command> program reads a
<Symbol Role="Variable">filename</Symbol> (which contains one or more mail messages from
<Emphasis>mailx</Emphasis> or
<Command>dtmail</Command>), and sends the message to standard out with headers abbreviated
and attachments removed. If no filename argument is provided
<Command>dtmailpr</Command> reads from standard in.
</Para>
<Para><Command>dtmailpr</Command> adds an attachment summary in place of the actual attachments.
</Para>
</RefSect1>
<RefSect1>
<Title>OPTIONS</Title>
<VariableList>
<VarListEntry>
<Term>&minus;p</Term>
<ListItem>
<!-- ex-TP-->
<Para>Insert page breaks between each mail message so that they print one
per page.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>&minus;f filename</Term>
<ListItem>
<!-- ex-TP-->
<Para>Read from the specified file instead of standard in.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->

823
cde/doc/C/guides/man/man1_dt/pad.sgm Normal file
View File

@@ -0,0 +1,823 @@
<!-- $XConsortium: pad.sgm /main/12 1996/09/08 19:55:19 rws $ -->
<!-- (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. -->
<![ %CDE.C.CDE; [<refentry id="CDEMX.XCSA.MAN7.rsml.1">]]><![ %CDE.C.XO; [<RefEntry Id="XCSA.MAN7.rsml.1">]]><refmeta>
<refentrytitle>dtpad</refentrytitle><manvolnum>user cmd</manvolnum></refmeta><refnamediv>
<refname><command>dtpad</command></refname><refpurpose>edit text files</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>dtpad</command><arg choice="opt">&minus;<replaceable>options</replaceable></arg>
<arg choice="opt"><replaceable>file</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv><refsect1>
<title>DESCRIPTION</title>
<para>The <command>dtpad</command> utility is a basic editor that supports
editing text files in a manner consistent with other common Graphical User
Interface text manipulation and file access mechanisms. Cursor positioning
and text selection as well as access to various edit operations can be done
via the standard Motif text manipulation mechanisms using the mouse or user-definable
key combinations. Text can be cut, copied or pasted, or dragged to and from
the Text Editor and/or other compliant application windows via the standard
Motif Clipboard and ICCCM Primary and Secondary selection mechanisms. Also,
standard dialogs are presented for accessing files and printing text.</para>
<para>The Text Editor also provides the following features:</para>
<itemizedlist><![ %CDE.C.CDE; [<listitem>
<para>Pull down menus for common edit and file operations.</para>
</listitem>]]>
<listitem>
<para>Undo of the previous edit operation.</para>
</listitem>
<listitem>
<para>Search and replace.</para></listitem><![ %CDE.C.CDE; [<listitem>
<para>Spell checking.</para></listitem>]]>
<listitem>
<para>Simple formatting.</para></listitem><![ %CDE.C.CDE; [<listitem>
<para>Wrap-to-fit and overstrike modes.</para>
</listitem>
<listitem>
<para>Optional status line &minus; allowing cursor positioning by line number.
</para>
</listitem>
<listitem>
<para>Automatic file save on many abnormal termination conditions.</para>
</listitem>
<listitem>
<para>Mechanism for automatic session save and restore.</para>
</listitem>]]>
</itemizedlist>
<para><![ %CDE.C.CDE; [In the &str-XZ;, the Text Editor can be a drag target
for &str-XZ; files, allowing a File Manager file icon to be dropped on a Text
Editor window for insertion in the current text. Also, in &str-XZ;, the Text
Editor operates in a transparent client-server mode in which all text editing
for a display is handled by a single Text Editor server process. In this mode,
invoking the Text Editor causes the invoked Text Editor process to be relegated
to the role of a requestor process that simply sends an edit request to the
server process where the actual editing is handled. The server creates and
maintains a separate edit window for each edit request and notifies the requestor
when its edit window is closed. The requestor normally just blocks until told
by the server to exit; however, if the server cannot honor the edit request
(for example, it can't access the directory containing the requestor's file),
the requestor handles the editing by itself. If a Text Editor server for a
display is not running when an edit request is made, &str-XZ; automatically
starts one, normally on the &str-XZ; session server (which need not be the
same as the requestor's host). The normal client-server behavior can be disabled
or altered via the Client and Server Control options described under the <Symbol>OPTIONS</Symbol> heading in this manual page. ]]></para>
</refsect1>
<refsect1>
<title>OPTIONS</title><![ %CDE.C.XO; [<Para>The
<Command>dtpad</Command> utility does not support the &str-Zu; because it uses
the X Window System convention of full-word options.
</Para>
]]>
<para>The following options are available:
</para>
<refsect2>
<title>Basic Command Line Options</title>
<variablelist>
<varlistentry><term><literal>&minus;saveOnClose</literal></term>
<listitem>
<para>Automatically and silently saves the current text when there are unsaved
changes and the Text Editor is closed. The default action for this situation
posts a dialog asking whether or not to save the current text. This option
inhibits the posting of the Save dialog when the Text Editor is closed. The
Save dialog is always posted when a new file is specified and there are unsaved
changes.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;missingFileWarning</literal></term>
<listitem>
<para>Posts a Warning dialog whenever a file name is specified and the file
does not exist or cannot be accessed.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;noReadOnlyWarning</literal></term>
<listitem>
<para>Disables the Warning dialog posted whenever a file is specified for
which the user does not have write permission. The default posts a Warning
dialog whenever this situation occurs.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;noNameChange</literal></term>
<listitem>
<para>Indicates that the default file name associated with the current text
is not to change when the text is saved under a name different than what it
was read in under. The current text can still be saved under a different file
name; however, the default file name does not change. By default, the default
file name is automatically changed to correspond to the last name under which
the current text was saved.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;viewOnly</literal></term>
<listitem>
<para>Disallows editing of text in the edit window, essentially turning the
Text Editor into a text viewer. The default allows text editing in the edit
window even if the text was obtained from a file for which the user does not
have write permission.</para>
</listitem>
</varlistentry>
</variablelist>
<![ %CDE.C.CDE; [<variablelist>
<varlistentry><term><literal>&minus;statusLine</literal></term>
<listitem>
<para>Displays a status line at the bottom of the edit window. The status
line shows the line number of the line where the text cursor is currently
positioned. The text cursor can be positioned to a specific line by selecting
the line number window in the status line, typing the desired number and pressing
the Return key. Normally, a status line is not displayed.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;wrapToFit</literal></term>
<listitem>
<para>Initially turns on wrap-to-fit mode. Wrap-to-fit mode can be toggled
on or off via the <symbol role="Message">Edit</symbol> menu Wrap-to-fit button
and normally is initially turned off.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;workspaceList</literal> <emphasis>workspace_list</emphasis></term>
<listitem>
<para>Displays the edit window for the current invocation of the Text Editor
in the specified workspace or workspaces. The default displays the edit window
in the workspace in which the Text Editor was invoked. The <emphasis>workspace_list</emphasis> argument specifies a blank-separated list of &str-XZ; workspaces.
If more than one workspace is specified, the list must be enclosed in quotes.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;session</literal> <emphasis>session_file</emphasis></term>
<listitem>
<para>Restores the Text Editor to all text editing windows and settings that
were in effect at a previous &str-XZ; shutdown. All other command-line options
are ignored when this option is specified. The <emphasis>session_file</emphasis>
argument specifies a Text Editor session file, previously saved at session
shutdown by the Text Editor, to be used to restore the Text Editor to its
state at shutdown.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<!-- dd: this is bad because we're in the middle of a CDE.C.CDE mark... -->
<refsect2>
<title>Client and Server Control Options</title>
<variablelist>
<varlistentry><term><literal>&minus;standAlone</literal></term>
<listitem>
<para>Forces the current invocation of the Text Editor to do its own text
processing in its own window, independent of the Text Editor server. This
is useful for displaying the Text Editor with an environment different from
that of other edit windows controlled by the server as, for example, to specify
a different locale or different color resources. The Text Editor still supports
file drag and drop in this mode.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;noBlocking</literal></term>
<listitem>
<para>Terminates the Text Editor requestor process as soon as the Text Editor
server determines that it can handle the requestor's edit request. If this
option is not specified, the requestor blocks, terminating only when it receives
notification from the server that its edit window has been closed.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;server</literal></term>
<listitem>
<para>Forces a Text Editor server to be started up (if one is not already
running) to process all subsequent edit requests for the display. These edit
requests are normally generated by subsequent invocations of the Text Editor
without the <literal>&minus;standAlone</literal> command-line option and cause
the server to create a separate edit window to handle each request. Users
normally do not need to use this option since the initial edit request for
the display causes the &str-XZ; to start a Text Editor server automatically.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;exitOnLastClose</literal></term>
<listitem>
<para>Specifies that the Text Editor server process is to terminate when the
last edit window for the display is closed. It should only be used with the <literal>&minus;server</literal> option since it only applies to the server process.
If this option is not specified, the Text Editor server remains active indefinitely,
even when all active edit windows have been closed.</para>
</listitem>
</varlistentry>
</variablelist>
]]>
</refsect2></refsect1><refsect1>
<title>OPERANDS</title>
<para>The following operand is supported:</para>
<variablelist>
<varlistentry><term><symbol role="Variable">file</symbol></term>
<listitem>
<para>The file to be edited or viewed. If no <symbol role="Variable">file</symbol>
is specified, the Text Editor opens a new (empty) edit window and
the file name must be specified when the contents are saved.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1><refsect1>
<title>RESOURCES</title><![ %CDE.C.CDE; [<para>The <command>dtpad</command>
utility supports the specific Text Editor resources described here plus the
standard resources related to the Text Editor widget hierarchy. The main widgets
that make up the Text Editor hierarchy are shown under this heading to aid
in specifying resources. The widget instance name is shown first, followed
by the widget class name in parentheses. Indentation indicates hierarchical
structure.</para><informalexample remap="indent">
<programlisting>dtpad (Dtpad)
main (MainWindow)
bar (MenuBar)
fileMenu (PulldownMenu)
editMenu (PulldownMenu)
formatMenu (PulldownMenu)
optionsMenu (PulldownMenu)
helpMenu (PulldownMenu)
editor (DtEditor)</programlisting>
</informalexample><para>The client-server architecture of <command>dtpad</command>
restricts the scope of resources that can be specified for individual edit
windows that the Text Editor server handles. For efficiency, only the resources
specific to the Text Editor are passed on the Text Editor server. None of
the standard widget resources, except for geometry, are passed on from the
requestor Text Editor to the Text Editor server. These resources are loaded
according to the environment on the server's host at the time the server is
started up. If more control is required, the <literal>&minus;standAlone</literal>
command-line option is used to create a separate, stand alone <command>dtpad</command> process where any and all of the standard resources, such as <literal>fontList</literal> or <literal>colors</literal>, can be loaded according to
the environment on the requestor's host.</para>]]>
<informaltable remap="center" orient="port">
<tgroup cols="4" colsep="0" rowsep="0">
<?PubTbl tgroup dispwid="6.33in">
<colspec align="left" colname="col1" colwidth="181*">
<colspec align="left" colname="col2" colwidth="180*">
<colspec align="left" colwidth="70*">
<colspec align="left" colwidth="91*">
<spanspec nameend="col2" namest="col1" spanname="1to2">
<tbody>
<row>
<entry align="left" spanname="1to2" valign="top"><literal>Basic Resources</literal></entry>
</row>
<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"><literal>saveOnClose</literal></entry>
<entry align="left" valign="top"><literal>SaveOnClose</literal></entry>
<entry align="left" valign="top"><structname role="typedef">Boolean</structname></entry>
<entry align="left" valign="top">False</entry>
</row>
<row>
<entry align="left" valign="top"><literal>missingFileWarning</literal></entry>
<entry align="left" valign="top"><literal>MissingFileWarning</literal></entry>
<entry align="left" valign="top"><structname role="typedef">Boolean</structname></entry>
<entry align="left" valign="top">False</entry>
</row>
<row>
<entry align="left" valign="top"><literal>readOnlyWarning</literal></entry>
<entry align="left" valign="top"><literal>ReadOnlyWarning</literal></entry>
<entry align="left" valign="top"><structname role="typedef">Boolean</structname></entry>
<entry align="left" valign="top">True</entry>
</row>
<row>
<entry align="left" valign="top"><literal>nameChange</literal></entry>
<entry align="left" valign="top"><literal>NameChange</literal></entry>
<entry align="left" valign="top"><structname role="typedef">Boolean</structname></entry>
<entry align="left" valign="top">True</entry>
</row>
<row>
<entry align="left" valign="top"><literal>viewOnly</literal></entry>
<entry align="left" valign="top"><literal>ViewOnly</literal></entry>
<entry align="left" valign="top"><structname role="typedef">Boolean</structname></entry>
<entry align="left" valign="top">False</entry>
</row><![ %CDE.C.CDE; [<row>
<entry align="left" valign="top"><literal>statusLine</literal></entry>
<entry align="left" valign="top"><literal>StatusLine</literal></entry>
<entry align="left" valign="top"><structname role="typedef">Boolean</structname></entry>
<entry align="left" valign="top">False</entry>
</row><row>
<entry align="left" valign="top"><literal>wrapToFit</literal></entry>
<entry align="left" valign="top"><literal>WrapToFit</literal></entry>
<entry align="left" valign="top"><structname role="typedef">Boolean</structname></entry>
<entry align="left" valign="top">False</entry>
</row><row>
<entry align="left" valign="top"><literal>workspaceList</literal></entry>
<entry align="left" valign="top"><literal>WorkspaceList</literal></entry>
<entry align="left" valign="top"><structname role="typedef">String</structname></entry>
<entry align="left" valign="top">NULL</entry>
</row><row>
<entry align="left" valign="top"><literal>session</literal></entry>
<entry align="left" valign="top"><literal>Session</literal></entry>
<entry align="left" valign="top"><structname role="typedef">String</structname></entry>
<entry align="left" valign="top">NULL</entry>
</row>]]></tbody>
</tgroup>
</informaltable>
<variablelist>
<varlistentry><term><literal>saveOnClose</literal></term>
<listitem>
<para>Indicates whether the Text Editor is to save automatically the current
text when there are unsaved changes and the Text Editor is closed. Setting
this resource to True automatically saves unsaved changes when the Text Editor
is closed. This is equivalent to specifying the <literal>&minus;saveOnClose</literal> command-line option.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>missingFileWarning</literal></term>
<listitem>
<para>Indicates whether a warning dialog is to be posted when a file is specified
that does not exist or cannot be accessed. Setting this resource to True displays
the warning. This is equivalent to specifying the <literal>&minus;missingFileWarning</literal> command-line option.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>readOnlyWarning</literal></term>
<listitem>
<para>Indicates whether a warning dialog is to be posted when a file for which
the user does not have write permission is read. Setting this resource to
False suppresses the warning. This is equivalent to specifying the <literal>&minus;noReadOnlyWarning</literal> command-line option.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>nameChange</literal></term>
<listitem>
<para>Indicates whether the current file name is to be changed when the current
text is saved under a new name. Setting this resource to False does not allow
the name to be reset. This is equivalent to specifying the <literal>&minus;noNameChange</literal> command-line option.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>viewOnly</literal></term>
<listitem>
<para>Indicates whether text only be viewed or whether it can be edited in
the edit window. Setting this resource to True disables text editing. This
is equivalent to specifying the <literal>&minus;viewOnly</literal> command-line
option.</para>
</listitem>
</varlistentry><![ %CDE.C.XO; [</VariableList>]]><![ %CDE.C.CDE; [<varlistentry>
<term><literal>statusLine</literal></term>
<listitem>
<para>Indicates whether the Text Editor is to display the status line at the
bottom of the edit window. Setting this resource to True displays the status
line. This is equivalent to specifying the <literal>&minus;statusLine</literal>
command-line option.</para>
</listitem>
</varlistentry><varlistentry><term><literal>wrapToFit</literal></term>
<listitem>
<para>Indicates whether the Text Editor is to enable wrap-to-fit mode when
the editor is started. Setting this resource to True enables wrap-to-fit mode.
This is equivalent to specifying the <literal>&minus;wrapToFit</literal> command-line
option.</para>
</listitem>
</varlistentry><varlistentry><term><literal>workspaceList</literal></term>
<listitem>
<para>Indicates which workspace or workspaces the Text Editor is to be displayed
in. This is equivalent to specifying the <literal>&minus;workspaceList</literal>
command-line option.</para>
</listitem>
</varlistentry><varlistentry><term><literal>session</literal></term>
<listitem>
<para>Specifies the saved session file to use in restoring a previously saved
Text Editor session. This is equivalent to specifying the <literal>&minus;session</literal> command-line argument.</para>
</listitem>
</varlistentry></variablelist>
<informaltable remap="center" orient="port">
<tgroup cols="4" colsep="0" rowsep="0">
<colspec align="left" colname="col1" colwidth="155*">
<colspec align="left" colname="col2" colwidth="147*">
<colspec align="left" colwidth="74*">
<colspec align="left" colwidth="80*">
<spanspec nameend="col2" namest="col1" spanname="1to2">
<tbody>
<row>
<entry align="left" spanname="1to2" valign="top"><literal>Client-Server Control
Resources</literal></entry>
</row>
<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"><literal>standAlone</literal></entry>
<entry align="left" valign="top"><literal>StandAlone</literal></entry>
<entry align="left" valign="top"><structname role="typedef">Boolean</structname></entry>
<entry align="left" valign="top">False</entry>
</row>
<row>
<entry align="left" valign="top"><literal>blocking</literal></entry>
<entry align="left" valign="top"><literal>Blocking</literal></entry>
<entry align="left" valign="top"><structname role="typedef">Boolean</structname></entry>
<entry align="left" valign="top">True</entry>
</row>
<row>
<entry align="left" valign="top"><literal>server</literal></entry>
<entry align="left" valign="top"><literal>Server</literal></entry>
<entry align="left" valign="top"><structname role="typedef">Boolean</structname></entry>
<entry align="left" valign="top">False</entry>
</row>
<row>
<entry align="left" valign="top"><literal>exitOnLastClose</literal></entry>
<entry align="left" valign="top"><literal>ExitOnLastClose</literal></entry>
<entry align="left" valign="top"><structname role="typedef">Boolean</structname></entry>
<entry align="left" valign="top">False</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<refsect2>
<title>Client And Server Control Resources</title>
<variablelist>
<varlistentry><term><literal>standAlone</literal></term>
<listitem>
<para>Specifies whether the Text Editor is to run as a separate, independent
Text Editor process without using the Text Editor server. Setting this resource
to True invokes a separate, independent process. This is equivalent to specifying
the <literal>&minus;standAlone</literal> command-line option.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>blocking</literal></term>
<listitem>
<para>Specifies that the client Text Editor process is not to terminate until
receiving notification from the Text Editor server that the user exited or
closed its edit window. Setting this resource to False causes the client process
to exit immediately when the server determines that it can handle its edit
request. This is equivalent to specifying the <literal>&minus;noBlocking</literal>
command-line option.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>server</literal></term>
<listitem>
<para>Specifies that the Text Editor is to be started in server mode to handle
all processing for all subsequent edit requests for the display. Setting this
resource to True is equivalent to specifying the <literal>&minus;server</literal>
command-line option.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>exitOnLastClose</literal></term>
<listitem>
<para>Specifies that the Text Editor server is to terminate when the last
edit window for the display is closed. Setting this resource to True is equivalent
to specifying the <literal>&minus;exitOnLastClose</literal> command-line option.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>]]></refsect1><refsect1>
<title>STDIN</title>
<para>Not used.</para>
</refsect1><refsect1>
<title>INPUT FILES</title>
<para>None.</para>
</refsect1><refsect1>
<title>PRINTING</title>
<para><command>dtpad</command> allows you to print either frgaments of text
files or complete text files.</para>
<para>You print a fragment from a text file using Drag and Drop. Select the
portion you want to print and drag the selected text over the printer icon
on the desktop. This Drag and Drop action displays a print setup dialog
that allows you to configure the print job and execute it.</para>
<para>You can print a complete text file either from the File Manager or
from within <command>dtpad</command>.</para>
<para>To print from the File Manager, select the file's icon and drag it
over the printer icon on the desktop. As with printing a text file fragment,
this Drag and Drop action displays a print setup dialog that allows you
to configure the print job and execute it.</para>
<para>You can print the currently open document from within <command>dtpad</command> in either of two ways:</para>
<itemizedlist><listitem><para>By selecting <literal>Print</literal> from the <literal>File</literal> pulldown menu. With this method, <command>dtpad</command>
prints the current file using the print setup options established by the
last print job. No print setup dialog is displayed.<?Pub Caret></para>
</listitem><listitem><para>By selecting <literal>Print...</literal> from the <literal>File</literal> pulldown menu. This method gives you the most control over
the printing process and the resulting output. When you select <literal>Print...</literal>, <command>dtpad</command> displays a Print Setup window
that allows you to set a number of generic and printer-specific printing options.
For example, you can send the output to a file or a printer. In the case
of printed output, you can specify how many copies you want. You can also
access another window to set options specific to the printer/spooler you are
using. For example, you can select paper size, orientation, a banner page
title, one- or two-sided printing, and email notification on completion of
the print job.</para>
</listitem></itemizedlist>
</refsect1><refsect1>
<title>ENVIRONMENT VARIABLES</title>
<para>The following environment variables affect the execution of <command>dtpad</command>:</para>
<variablelist>
<varlistentry><term><systemitem class="EnvironVar">DISPLAY</systemitem></term>
<listitem>
<para>Specify the default X Windows display to connect to.</para>
</listitem>
</varlistentry>
<varlistentry><term><systemitem class="EnvironVar">LANG</systemitem></term>
<listitem>
<para>Provide a default value for the internationalization variables that
are unset or null. If <systemitem class="EnvironVar">LANG</systemitem> is
unset or null, the corresponding value from the implementation-specific default
locale will be used. If any of the internationalization variables contains
an invalid setting, the utility behaves as if none of the variables had been
defined.</para>
</listitem>
</varlistentry>
<varlistentry><term><emphasis>LC_ALL</emphasis></term>
<listitem>
<para>If set to a non-empty string value, override the values of all the other
internationalization variables.</para>
</listitem>
</varlistentry>
<varlistentry><term><emphasis>LC_MESSAGES</emphasis></term>
<listitem>
<para>Determine the locale that is used to affect the format and contents
of diagnostic messages written to standard error and informative messages
written to standard output.</para>
</listitem>
</varlistentry>
<varlistentry><term><systemitem class="EnvironVar">NLSPATH</systemitem></term>
<listitem>
<para>Determine the location of message catalogues for the processing of <emphasis>LC_MESSAGES</emphasis>.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1><refsect1>
<title>ASYNCHRONOUS EVENTS</title><![ %CDE.C.XO; [<Para>Default.
</Para>
]]><![ %CDE.C.CDE; [<refsect2>
<title>ToolTalk Messages</title>
<para>The following ToolTalk Desktop and Media requests are supported by the
Text Editor server:</para>
<variablelist>
<varlistentry><term>C_STRING</term>
<listitem>
<para>Text in an arbitrary codeset</para>
</listitem>
</varlistentry>
<varlistentry><term>_DT_DATA</term>
<listitem>
<para>Data that does not match any other data type</para>
</listitem>
</varlistentry>
</variablelist>
<para>In addition, the Text Editor supports the messages below for any media
type that does not have a specific editor registered.</para>
<para>The following messages are supported from the Media Exchange message
set:</para>
<variablelist>
<varlistentry><term><emphasis>Instantiate</emphasis></term>
<listitem>
<para>Opens a new edit window for composing arbitrary file(s).</para>
</listitem>
</varlistentry>
<varlistentry><term><symbol role="Message">Edit</symbol></term>
<listitem>
<para>Opens a new edit window for editing an existing file or buffer or for
composing a specific new file or buffer.</para>
</listitem>
</varlistentry>
<varlistentry><term><symbol role="Message">Display</symbol></term>
<listitem>
<para>Opens a new edit window for displaying an existing file or buffer.</para>
</listitem>
</varlistentry>
</variablelist>
<para>The following messages are supported from the Desktop message set:</para>
<variablelist>
<varlistentry><term><symbol role="Message">Quit</symbol></term>
<listitem>
<para>Terminates the text editing services or closes a specific Text Editor
edit window as specified by the <emphasis>operation2Quit</emphasis> argument.
The <emphasis>operation2Quit</emphasis> argument must be the message ID of
the Media Exchange request that created the edit window.</para>
<para>The default actions for notifying the user, saving or returning text
and closing edit windows are:</para>
<itemizedlist>
<listitem>
<para>If <emphasis>operation2Quit</emphasis> is specified, the specified edit
window is closed; otherwise, all edit window(s) are closed and the text editing
services are terminated</para>
</listitem>
<listitem>
<para>If there are unsaved changes, the user is notified and allowed to save
the text and/or abort the <symbol role="Message">Quit</symbol>; otherwise,
the user is not notified and the text is not saved (or returned if a buffer
is being edited)</para>
</listitem>
</itemizedlist>
<para>Both the <emphasis>silent</emphasis> and <emphasis>force</emphasis>
arguments are supported. However, the semantics of <emphasis>silent</emphasis>
differ from the Desktop message set in that the text editing services provides
user notification only when there are unsaved changes, rather than user notification
when an edit window is terminated. The following table describes variances
in the default action for various combination of <emphasis>silent</emphasis>
and <emphasis>force</emphasis>.</para>
<informaltable remap="center" orient="port">
<tgroup cols="3" colsep="0" rowsep="0">
<colspec align="left" colwidth="69*">
<colspec align="left" colwidth="80*">
<colspec align="left" colwidth="307*">
<tbody>
<row>
<entry align="left" valign="top"><emphasis>silent</emphasis></entry>
<entry align="left" valign="top"><emphasis>force</emphasis></entry>
<entry align="left" valign="top"><symbol role="Variable">action</symbol></entry>
</row>
<row>
<entry align="left" valign="top"><systemitem class="Constant">False</systemitem></entry>
<entry align="left" valign="top"><systemitem class="Constant">False</systemitem></entry>
<entry align="left" valign="top"><symbol role="Variable">default</symbol></entry>
</row>
<row>
<entry align="left" valign="top"><systemitem class="Constant">True</systemitem></entry>
<entry align="left" valign="top"><systemitem class="Constant">False</systemitem></entry>
<entry align="left" valign="top">If there are unsaved changes, the user is
not notified, the text is not saved and the edit window is not terminated.</entry>
</row>
<row>
<entry align="left" valign="top"><systemitem class="Constant">False</systemitem></entry>
<entry align="left" valign="top"><systemitem class="Constant">True</systemitem></entry>
<entry align="left" valign="top">If there are unsaved changes, the user is
still notified and allowed to save the text, but cannot abort the
<symbol role="Message">Quit</symbol>.</entry>
</row>
<row>
<entry align="left" valign="top"><systemitem class="Constant">True</systemitem></entry>
<entry align="left" valign="top"><systemitem class="Constant">True</systemitem></entry>
<entry align="left" valign="top">If there are unsaved changes, the user is
not notified, the text is not saved and the edit window is closed.</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<para>Whenever the <symbol role="Message">Quit</symbol> request is not carried
out (i.e., in the default case when the user explicitly aborts the
<symbol role="Message">Quit</symbol> or when <emphasis>silent</emphasis> is True and <emphasis>force</emphasis> is not specified or is False), the <symbol role="Message">
Quit</symbol> request is failed with <systemitem class="Constant">TT_DESKTOP_ECANCELED</systemitem>.</para>
</listitem>
</varlistentry>
<varlistentry><term><symbol role="Message">Save</symbol></term>
<listitem>
<para>Saves a specific edit window opened via an <symbol role="Message">Edit</symbol>
request. The ID argument must have the <literal>messageID</literal>
vtype and have the value of the message ID of the <symbol role="Message">
Edit</symbol> request that created the edit window.</para>
</listitem>
</varlistentry>
<varlistentry><term><symbol role="Message">Saved</symbol></term>
<listitem>
<para>Sent when a file has been saved, as the result of a <symbol role="Message">
Save</symbol> request or a user action.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>]]></refsect1><refsect1>
<title>STDOUT</title>
<para>Not used.</para>
</refsect1><refsect1>
<title>STDERR</title>
<para>Not used.</para>
</refsect1><refsect1>
<title>OUTPUT FILES</title>
<para>None.</para>
</refsect1><refsect1>
<title>EXTENDED DESCRIPTION</title>
<para>None.</para>
</refsect1><refsect1>
<title>EXIT STATUS</title>
<para>The following exit values are returned:</para>
<variablelist>
<varlistentry><term>0</term>
<listitem>
<para>Successful completion.</para>
</listitem>
</varlistentry>
<varlistentry><term>>0</term>
<listitem>
<para>An error occurred.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1><refsect1>
<title>CONSEQUENCES OF ERRORS</title>
<para>Default.</para>
</refsect1><refsect1>
<title>APPLICATION USAGE</title>
<para>None.</para>
</refsect1><refsect1>
<title>EXAMPLES</title>
<para>None.</para><![ %CDE.C.CDE; [</refsect1>
<refsect1>
<title>NOTES</title>
<refsect2>
<title>Modes of Operation</title>
<para>Each instance of the Text Editor operates in one of three modes:</para>
<variablelist>
<varlistentry><term><literal>Requestor Mode</literal></term>
<listitem>
<para>When the Text Editor is started without any overriding command-line
options (that is, <literal>&minus;standAlone</literal> or <literal>&minus;server</literal>), it always attempts to run in this mode. In this mode it simply
sends an edit request to a separate Text Editor server process and then blocks
(does nothing) until it receives a notice from the server when its edit request
is done, at which time it exits. If <literal>&minus;noBlocking</literal> is
specified, it exits immediately after the server accepts its edit request
rather than waiting until the edit request is done.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>StandAlone Mode</literal></term>
<listitem>
<para>If the Text Editor server cannot process the edit request from the Text
Editor instance (for example, the server process doesn't exist or can't be
started, or it can't access the requestor's file), or if <literal>&minus;standAlone</literal> is specified on the command line, the Text Editor instance operates
in <literal>standAlone</literal> mode. In this mode the Text Editor creates
its own edit window and handles all processing for this window on its own.
In addition, it does not handle any edit requests from outside sources and
it exits when its edit window is closed.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>Server Mode</literal></term>
<listitem>
<para>When <literal>&minus;server</literal> is specified on the command line,
the Text Editor instance operates as a server for all Text Editor edit requests
for the same display. That is, it creates a separate edit window and does
the actual editing for all Text Editor instances running to the same display
that do not have <literal>&minus;standAlone</literal> specified on their command
line. Only one Text Editor server for a display can exist, and in the &str-XZ;,
this instance is normally started automatically if it's not running at the
time an edit request is made.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2>
<title>Automatic File Save</title>
<para>The Text Editor automatically saves the current text to a panic save
file before exiting whenever it encounters a panic signal or an internal X
error. Panic signals are signals such as SIGHUP, SIGINT, SIGQUIT, SIGILL,
SIGABRT, SIGIOT, SIGEMT, SIGFPE, SIGBUS, SIGSEGV, SIGSYS, SIGPIPE and SIGTERM.
Internal X errors are both non fatal X Error events (as trapped by <function>XSetErrorHandler</function>(3)), such as a failure in X server memory allocation,
and fatal X errors (as trapped by <Symbol>XSetIOErrorHandler</Symbol>),
such as losing the connection to the X server. The Text Editor constructs
the name of the panic save file by bracketing the file name as supplied by
the user (or <literal>noName</literal> if none is supplied) with enough number
symbols ( <literal>#</literal>) to make the name unique.</para>
</refsect2>
<refsect2>
<title>Wrap-to-fit Mode and Formatting</title>
<para>Wrap-to-fit mode and text formatting are essentially independent operations.
Wrap-to-fit mode pertains to the dynamic display of lines, as delimited by <keysym>newline</keysym> characters, which exceed the width of the Text Editor window
and is based on the left and right window boundaries. When wrap-to-fit mode
is off (the default), each line of text is displayed on a single line on the
display and text entered at the right window boundary causes the window to
scroll automatically to the right to accommodate the new text until an actual <keysym>newline</keysym> character is entered (normally, by pressing the Return key).
When wrap-to-fit mode is on, lines longer than the window width are automatically
wrapped at the right window margin to one or more display lines, and text
entered at the right window boundary is automatically broken on a word boundary
to the first column of the next display line. Wrap-to-fit mode is dynamic
in that wrapped lines are automatically adjusted when text is inserted or
deleted or when the window is resized. Wrap-to-fit mode only affects the display
of lines; it does not actually insert <keysym>newline</keysym> characters
in the text.</para>
<para>Text formatting is a static operation that inserts actual <keysym>newline</keysym> (and/or <keysym>space</keysym>) characters directly in the text
to match it to the left and right margins (and justification mode) specified
in the Format Settings dialog. Format settings affect text only when explicitly
applied and have no affect on wrap-to-fit mode or previously formatted text.
Initially, and whenever the window is resized, the right format margin is
automatically set to the window width to match the wrap-to-fit boundary.</para>
</refsect2>
</refsect1>
<refsect1>
<title>FILES</title>
<variablelist>
<varlistentry><term><Filename>/usr/dt/app-defaults/$LANG/Dtpad</Filename></term>
<listitem>
<para>Text Editor Application Defaults.</para>
</listitem>
</varlistentry>
<varlistentry><term><Filename>/usr/dt/lib/nls/msg/$LANG/dtpad.cat</Filename></term>
<listitem>
<para>Text Editor Message Catalog.</para>
</listitem>
</varlistentry>
<varlistentry><term><Filename>/usr/dt/appconfig/help/$LANG/Textedit.sdl</Filename></term>
<listitem>
<para>Text Editor Help Volume.</para>
</listitem>
</varlistentry>
<varlistentry><term><Filename>/usr/dt/appconfig/types/$LANG/dtpad.dt</Filename></term>
<listitem>
<para>Contains Text Editor action definitions used by the Text Editor.</para>
</listitem>
</varlistentry>
<varlistentry><term><Filename>/usr/dt/appconfig/tttypes/types.xdr</Filename></term>
<listitem>
<para>ToolTalk process-types file containing message definitions used by the
Text Editor.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>#&lt;file name>#</literal></term>
<listitem>
<para>Panic save file (see <literal>Automatic File Save</literal>).</para>
</listitem>
</varlistentry>
</variablelist>]]></refsect1><refsect1>
<title>SEE ALSO</title><![ %CDE.C.CDE; [<para>&cdeman.DtEditor;.
</para>]]><![ %CDE.C.XO; [<Para>None.
</Para>
]]></refsect1></refentry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:40:24-->

297
cde/doc/C/guides/man/man1_dt/pdm.sgm Normal file
View File

@@ -0,0 +1,297 @@
<!-- $XConsortium: pdm.sgm /main/4 1996/10/22 09:42:03 rws $ -->
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
<!-- (c) Copyright 1996 International Business Machines Corp. -->
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1996 Novell, Inc. -->
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
<!-- (c) Copyright 1996 Hitachi. -->
<refentry id="cde.XPRINT.dtpdm">
<refmeta>
<refentrytitle>dtpdm</refentrytitle><manvolnum>user cmd</manvolnum>
</refmeta>
<refnamediv>
<refname><command>dtpdm</command></refname>
<refpurpose>Print Dialog Manager to provide
printer-specific GUIs
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>dtpdm</command>
<arg choice="opt">&minus;vdisplay <replaceable>vdpy</replaceable></arg>
<arg choice="opt">&minus;window <replaceable>vwid</replaceable></arg>
<arg choice="opt">&minus;pdisplay <replaceable>pdpy</replaceable></arg>
<arg choice="opt">&minus;pcontext <replaceable>pcid</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para><command>dtpdm</command> is the Print Dialog Manager (PDM) that is
invoked by the Print Dialog Manager Daemon (<command>dtpdmd</command>) to
provide printer-specific GUIs on behalf of a printing application. It is
a process separate from the print server.
</para>
<para>At an application&rsquo;s request <command>dtpdm</command> posts to
the user&rsquo;s display a set of printer-specific dialogs that enable the
user to configure a variety of printer options.
</para>
<para>The <command>dtpdm</command> program provides a setup dialog to X printing
applications that allows the user to set printer specific and job specific
options. The setup dialog appears to be part of the application, but it is
actually managed by the <command>dtpdm</command> on behalf of the application.
It is capable of providing dialogs in all locales for which there exist applicable
message catalogs.
</para>
<para><command>dtpdm</command> presents a dialog containing
the printer name and description plus an <literal>XmNotebook</literal>
widget. This widget contains two tabs: one for the Printer
Setup Box and one for the Job Setup Box. Each of these boxes provides
controls that allow for configuration of various printing options.
</para>
<para>The <command>dtpdm</command> dialog also contains three pushbuttons
labelled <literal>OK</literal>, <literal>Cancel</literal>, and <literal>Help</literal>. When the user presses <literal>OK</literal>, <command>dtpdm</command> dismisses the dialog and sets the newly configured printing options
in the current print context (via <function>XpSetAttributes</function>).
When the user presses <literal>Cancel</literal>, <command>dtpdm</command>
dismisses the dialog and makes no changes to the print context.
</para>
<refsect2>
<title>Printer Setup Box</title>
<para>The Printer Setup box presents options specific to the currently selected
printer. The options presented may vary in other PDM implementations. The
printer setup options presented by <command>dtpdm</command> are as follows:
</para>
<variablelist>
<varlistentry><term>Printer Information</term>
<listitem>
<para>Provides information about the X Printer. The information consists of the
printer model and the document
format used to generate documents sent to this X Printer.
</para>
</listitem>
</varlistentry>
<varlistentry><term>Page Orientation</term>
<listitem>
<para>Specifies how the output will be oriented on the page. The orientation options
presented in the menu depend on the printer, but up to four orientations
are possible: portrait, landscape, reverse portrait, and reverse landscape.
An icon adjacent to the <literal>Options</literal> menu presents a graphical
illustration showing the current selection.
</para>
</listitem>
</varlistentry>
<varlistentry><term>Printed Sides</term>
<listitem>
<para>Specifies single or double-sided printing. The actual choices available depend
on the printer, but up to three choices are possible: simplex, duplex, and
tumble. An icon adjacent to the <literal>Options</literal> menu presents
a graphical illustration showing the current selection.
</para>
</listitem>
</varlistentry>
<varlistentry><term>Tray</term>
<listitem>
<para>Specifies the printer tray from which the media will be drawn. The
<literal>Auto-select</literal> tray option is available
for all printers. Selecting this
option indicates no preference as to which tray to use. Remaining Tray selections
are dependent on the printer.
</para>
</listitem>
</varlistentry>
<varlistentry><term>Page Size</term>
<listitem>
<para>Specifies the media size for printing. The entries in this list box depend on
whether the <literal>Loaded in Printer</literal> or <literal>All Sizes</literal>
radio button is selected.
</para>
</listitem>
</varlistentry>
<varlistentry><term>Loaded in Printer</term>
<listitem>
<para>Provides a list of the media sizes currently available on the printer. If the
current <literal>Tray</literal> option is <literal>Auto-select</literal>,
the user will see all media sizes available in all of the printer&rsquo;s
trays. If a specific tray is selected, only the media size loaded in that
tray will be shown. Information on which media size is available in which
tray is provided by the system administrator via the
<literal>input-trays-medium</literal> attribute.
If the system administrator does not provide this information,
the <literal>Loaded in Printer</literal> radio button will be inactive.
</para>
</listitem>
</varlistentry>
<varlistentry><term>All Sizes</term>
<listitem>
<para>Provides a list of all supported media sizes available for the printer. If the
user selects this button, the <literal>Tray</literal> option is set to
<literal>Auto-select</literal>. This button is provided for the following situations:
</para>
<itemizedlist>
<listitem>
<para>If the system administrator has not specified
which sizes are loaded in the printer
</para>
</listitem>
<listitem>
<para>If a desired media size is not loaded and the printer
prompts for the requested size
</para>
</listitem>
<listitem>
<para>If the output never reaches an actual printer (for
example, when printing to a file)
</para>
</listitem></itemizedlist>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2>
<title>Job Setup Box</title>
<para>The Job Setup box presents options specific to the spooler controlling
the printer. The options presented may vary in other PDM implementations,
depending on the spooler. The job setup options presented by <command>dtpdm</command> are as follows:
</para>
<variablelist>
<varlistentry><term>Send Mail When Done</term>
<listitem>
<para>Instructs <command>dtpdm</command> to send an email message to the user
when the job is completed.
</para>
</listitem>
</varlistentry>
<varlistentry><term>Banner Page Title</term>
<listitem>
<para>Specifies the text the user wants to appear on the banner page of the
output.
</para>
</listitem>
</varlistentry>
<varlistentry><term>Print Command Options</term>
<listitem>
<para>Specifies command line options and arguments that the user wants to
pass to the spooler. <command>dtpdm</command> performs no parsing of this
field. All parsing and argument validation is performed by the underlying
spooler.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<para>The following options are available:</para>
<variablelist>
<varlistentry><term><literal>&minus;vdisplay</literal> <emphasis>vdpy</emphasis></term>
<listitem>
<para>Specifies the display connection to the Video X-Server.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;window</literal> <emphasis>vwid</emphasis></term>
<listitem>
<para>Specifies the window id on the Video X-Server to which the PDM&rsquo;s
dialogs should be posted as transient windows.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;pdisplay</literal> <emphasis>pdpy</emphasis></term>
<listitem>
<para>Specifies the display connection to the Print X-Server.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;pcontext</literal> <emphasis>pcid</emphasis></term>
<listitem>
<para>Specifies the print context id on the Print X-Server. The PDM uses
this id to gain access to the print context being used by the requesting
application.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>ENVIRONMENT VARIABLES</title>
<para>The Dt Print Dialog Manager uses the environment variable
<systemitem class="environvar">LANG</systemitem> to identify
the location of its localized message file.
</para>
</refsect1>
<refsect1>
<title>RESOURCES</title>
<para>None.</para>
</refsect1>
<refsect1>
<title>ACTIONS/MESSAGES</title>
<para>None.</para>
</refsect1>
<refsect1>
<title>RETURN VALUES</title>
<para>The return values (defined as integer constants in
<filename>Dt/dtpdmd.h</filename>) are as follows:</para>
<variablelist>
<varlistentry><term><literal>PDM_EXIT_OK</literal></term>
<listitem>
<para>The PDM is telling the PDMD that the user selected <literal>OK</literal>
to dismiss the PDM.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>PDM_EXIT_CANCEL</literal></term>
<listitem>
<para>The PDM is telling the PDMD that the user selected
<literal>CANCEL</literal> to dismiss the PDM.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>DM_EXIT_VXAUTH</literal></term>
<listitem>
<para>The PDM is telling the PDMD that it did not have proper authority to
make a display connection on the Video X-Server.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>PDM_EXIT_PXAUTH</literal></term>
<listitem>
<para>The PDM is telling the PDMD that it did not have proper authority to
make a display connection to the Print X-Server.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>PDM_EXIT_ERROR</literal></term>
<listitem>
<para>The PDM is telling the PDMD that it encountered an error.
</para>
</listitem>
</varlistentry>
<varlistentry><term>all other values</term>
<listitem>
<para>The PDMD treats all unknown return values the same as
<literal>PDM_EXIT_ERROR</literal>. Such return values
are likely from uncontrollable exit conditions
often found in other libraries (for example, untrapped XIO errors from libX).
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>ERRORS/WARNINGS</title>
<para>None.</para>
</refsect1>
<refsect1>
<title>FILES</title>
<para>None.</para>
</refsect1>
<refsect1>
<title>EXAMPLES</title>
<para>None.</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para><function>dtpdmd</function>1</para>
</refsect1>
</refentry>

248
cde/doc/C/guides/man/man1_dt/pdmd.sgm Normal file
View File

@@ -0,0 +1,248 @@
<!-- $XConsortium: pdmd.sgm /main/4 1996/10/22 09:43:45 rws $ -->
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
<!-- (c) Copyright 1996 International Business Machines Corp. -->
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1996 Novell, Inc. -->
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
<!-- (c) Copyright 1996 Hitachi. -->
<refentry id="CDE.XPRINT.DTPDMD">
<refmeta><refentrytitle>dtpdmd</refentrytitle><manvolnum>user cmd</manvolnum>
</refmeta>
<refnamediv>
<refname><command>dtpdmd</command></refname>
<refpurpose>
Print Dialog Manager daemon
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>dtpdmd</command><arg choice="opt">&minus;d <replaceable>display</replaceable></arg>
<arg choice="opt">&minus;a <replaceable>selection</replaceable></arg>
<arg choice="opt">&minus;p <replaceable>pdm</replaceable></arg>
<arg choice="opt">&minus;P <replaceable>pdm</replaceable></arg>
<arg choice="opt">&minus;s</arg>
<arg choice="opt">&minus;l <replaceable>logfile</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>The <command>dtpdmd</command> command uses the Print Dialog Manager
Selection Protocol to start a Print Dialog Manager (PDM) on behalf of an
application.</para>
<para><command>dtpdmd</command> is a long-lived daemon process that receives
client requests for a PDM, uses some lookup rules, and then starts an appropriate
PDM to service the request. When the PDM finishes, control returns to <command>dtpdmd</command> and <command>dtpdmd</command> in turn responds to the client
with the final status.</para>
<refsect2>
<title>PDMD/PDM Protocol</title>
<para><command>dtpdmd</command> uses a specific protocol to communicate with
the PDM. Communication to the PDM is done via a standardized command line
and environment.
Communication from the PDM is done via standardized exit codes.</para>
<refsect3>
<title>Standardized Command Line</title>
<para>The standardized command line is as follows:</para>
<cmdsynopsis>
<command>dt-pdm-command</command>
<arg choice="opt"><replaceable>dt-pdm-options</replaceable></arg>
<arg choice="plain">&minus;vdisplay <replaceable>vdpy</replaceable></arg>
<arg choice="plain">&minus;window <replaceable>vwid</replaceable></arg>
<arg choice="plain">&minus;pdisplay <replaceable>pdpy</replaceable></arg>
<arg choice="plain">&minus;pcontext <replaceable>pcid</replaceable></arg>
</cmdsynopsis>
<variablelist>
<varlistentry><term><emphasis>dt-pdm-command</emphasis></term>
<listitem>
<para>Specifies the path for the PDM executable.
It is derived by the <command>dtpdmd</command> from either the
<literal>&minus;p</literal> or <literal>&minus;P</literal> option.
</para>
</listitem>
</varlistentry>
<varlistentry><term><emphasis>dt-pdm-options</emphasis></term>
<listitem>
<para>Specifies options that may have accompanied the <emphasis>dt-pdm-command</emphasis>,
whether specified on the <command>dtpdmd</command> command line by the
<literal>&minus;p</literal> or <literal>&minus;P</literal> option or from other sources.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;vdisplay</literal> <emphasis>vdpy</emphasis></term>
<listitem>
<para>Specifies the display connection to the Video X-Server.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;window</literal> <emphasis>vwid</emphasis></term>
<listitem>
<para>Specifies the window id on the Video X-Server to which the PDM&rsquo;s
dialogs should be posted as transient windows.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;pdisplay</literal> <emphasis>pdpy</emphasis></term>
<listitem>
<para>Specifies the display connection to the Print X-Server.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;pcontext</literal> <emphasis>pcid</emphasis></term>
<listitem>
<para>Specifies the print context id on the Print X-Server. The PDM uses
this id to gain access to the print context being used by the requesting
application.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect3>
<refsect3>
<title>Standardized Exit Codes</title>
<para>The standardized exit codes (defined as integer constants in
<filename>Dt/dtpdmd.h</filename>) are as follows:
</para>
<variablelist>
<varlistentry><term><literal>PDM_EXIT_OK</literal></term>
<listitem>
<para>The PDM is telling the PDMD that the user selected <literal>OK</literal>
to dismiss the PDM.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>PDM_EXIT_CANCEL</literal></term>
<listitem>
<para>The PDM is telling the PDMD that the user selected <literal>CANCEL</literal> to dismiss the PDM.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>DM_EXIT_VXAUTH</literal></term>
<listitem>
<para>The PDM is telling the PDMD that it did not have proper authority to
make a display connection on the Video X-Server.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>PDM_EXIT_PXAUTH</literal></term>
<listitem>
<para>The PDM is telling the PDMD that it did not have proper authority to
make a display connection to the Print X-Server.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>PDM_EXIT_ERROR</literal></term>
<listitem>
<para>The PDM is telling the PDMD that it encountered an error.</para>
</listitem>
</varlistentry>
<varlistentry><term>all other values</term>
<listitem>
<para>The PDMD treats all unknown return values the same as <literal>PDM_EXIT_ERROR</literal>. Such return values are likely from uncontrollable exit conditions
often found in other libraries (for example, untrapped XIO errors from libX).
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect3>
</refsect2>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<para>The following options are available:</para>
<variablelist>
<varlistentry><term><literal>&minus;d</literal> <emphasis>display</emphasis></term>
<listitem>
<para>Specifies the display connection to an X-Server upon which an X-selection
will be created and managed for requests. If specified, it overrides the
environment variable <systemitem class="environvar">XPDMDISPLAY</systemitem>.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;a</literal> <emphasis>selection</emphasis></term>
<listitem>
<para>Specifies an alternative X-selection name for <command>dtpdmd</command>
to create and manage. If specified, it overrides the environment variable
<systemitem class="environvar">XPDMSELECTION</systemitem>. By default,
the selection name is <literal>PDM_MANAGER</literal>.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;p</literal> <emphasis>pdm</emphasis></term>
<listitem>
<para>Specifies a PDM execution string to use if no other PDM execution string
can be derived, usually from the Server Attribute
<literal>dt-pdm-command</literal> from the X-Server.
By default, the execution string is <literal>dtpdm</literal>.
All execution strings are applied against the current search path.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;P</literal> <emphasis>pdm</emphasis></term>
<listitem>
<para>Specifies an alternative PDM execution string that overrides all other
sources of such execution strings. All execution strings are applied
against the current search path.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;s</literal></term>
<listitem>
<para>Instructs <command>dtpdmd</command> to turn on the security exchange
portion of the PDM Selection Protocol. By default, <command>dtpdmd</command>
does not exchange security information with an application over the wire,
so the appearance of <literal>auto hosting</literal> cannot be done.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;l</literal> <emphasis>logfile</emphasis></term>
<listitem>
<para>Specifies a file for <command>dtpdmd</command> to use for logging errors
and warnings. Entries are time-stamped and may be generated by <command>dtpdmd</command> or any child PDM via stderr. The previous contents of the
log file are destroyed. By default, <filename>/dev/null</filename> is used.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>ENVIRONMENT VARIABLES</title>
<para>Prior to starting a PDM, the <command>dtpdmd</command> may
first modify the following environment variable:
</para>
<variablelist>
<varlistentry><term><systemitem class="environvar">XAUTHORITY</systemitem></term>
<listitem>
<para>If the <command>dtpdmd</command> has come into possession of X-authority
information that the PDM will need, it sets this environment
variable so that the PDM will automatically have access to the proper
X-authority information.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>In addition, the <command>dtpdmd</command> may set a locale hint
passed to it by the PDM Selection Protocol from the client prior
to starting a PDM. On POSIX systems, <function>setlocale</function>(3C)
will be used.
</para>
</refsect1>
<refsect1>
<title>RESOURCES</title>
<para>None.</para>
</refsect1>
<refsect1>
<title>ACTIONS/MESSAGES</title>
<para>None.</para>
</refsect1>
<refsect1>
<title>ERRORS/WARNINGS</title>
<para>None.</para>
</refsect1>
<refsect1>
<title>FILES</title>
<para>None.</para>
</refsect1>
<refsect1>
<title>EXAMPLES</title>
<para>None.</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para><function>dtpdm</function>1</para>
</refsect1>
</refentry>

256
cde/doc/C/guides/man/man1_dt/printinf.sgm Normal file
View File

@@ -0,0 +1,256 @@
<!-- $XConsortium: printinf.sgm /main/10 1996/10/30 16:29:22 rws $ -->
<!-- (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.MAN29.rsml.1">
<RefMeta>
<RefEntryTitle>dtprintinfo</RefEntryTitle>
<ManVolNum>user cmd</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Command>dtprintinfo</Command></RefName>
<RefPurpose>the CDE Print Viewer
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<CmdSynopsis>
<Command>dtprintinfo</Command>
<Group>
<Arg>-p &lt;<Replaceable>printer</Replaceable></Arg>
<Arg>></Arg>
<Arg>-all</Arg>
<Arg>-populate</Arg>
<Arg>-help</Arg>
</Group>
</CmdSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The Print Viewer program provides a graphical interface that
displays the status of print queues and print jobs.
Additional information about print queues or print
jobs can be retrieved within the interface, individual print
queue labels and icons can be customized, and individual
print jobs can be canceled. Print jobs can be submitted by
dragging files, text, or attachments from other CDE programs
and dropping them on a print queue icon in a Print Viewer window.
</Para>
<RefSect2>
<Title>KEY SUPPORTED TASKS</Title>
<ItemizedList>
<ListItem>
<Para>Displaying configured print queues on the system.
</Para>
</ListItem>
<ListItem>
<Para>Displaying print queue and print job properties.
</Para>
</ListItem>
<ListItem>
<Para>Changing print queue labels and icons.
</Para>
</ListItem>
<ListItem>
<Para>Submitting print jobs.
</Para>
</ListItem>
<ListItem>
<Para>Canceling print jobs.
</Para>
</ListItem>
</ItemizedList>
</RefSect2>
</RefSect1>
<RefSect1>
<Title>NO OPTIONS</Title>
<Para>When the Print Viewer is started without any options,
it shows the LPDEST printer or the system default printer if
LPDEST is not set.
</Para>
</RefSect1>
<RefSect1>
<Title>OPTIONS</Title>
<RefSect2>
<Title>-p <Emphasis>&lt;printer></Emphasis></Title>
<Para>Display information only for the specified <Emphasis>&lt;printer></Emphasis>.
</Para>
</RefSect2>
<RefSect2>
<Title>-all</Title>
<Para>Display information for all printers.
</Para>
</RefSect2>
<RefSect2>
<Title>-populate</Title>
<Para>The
<Emphasis>-populate</Emphasis> option is available only for root. This
option creates default printer actions for all printers
in /etc/dt/appconfig/types/LANG. If LANG is not defined,
the actions are created in /etc/dt/appconfig/types/C.
The post-installation process uses the
<Emphasis>-populate</Emphasis> feature to create default printer actions in /etc/dt/appconfig/types/C.
</Para>
</RefSect2>
<RefSect2>
<Title>-help</Title>
<Para>Display command line option help.
</Para>
</RefSect2>
<RefSect2>
<Title>-session <Emphasis>&lt;session_file></Emphasis></Title>
<Para>The Print Viewer creates a session file when you exit the desktop. When you
start the desktop again, the Print Viewer uses the session file specified
in the session_file parameter to restore the view settings, which printers are
shown and which printers are opened.
</Para>
</RefSect2>
</RefSect1>
<RefSect1>
<Title>RESOURCES</Title>
<Para>The Print Viewer does not defined any application specific resources.
</Para>
</RefSect1>
<RefSect1>
<Title>ENVIRONMENT</Title>
<RefSect2>
<Title>LPDEST</Title>
<Para>This environment variable determines which print queue to display
when the Print Viewer is started without any options.
</Para>
</RefSect2>
<RefSect2>
<Title>XMICONSEARCHPATH</Title>
<Para>This environment variable determines which icon folders to
search when customizing a printer's icon set.
</Para>
</RefSect2>
</RefSect1>
<RefSect1>
<Title>BROADCAST MESSAGES</Title>
<Para>The Print Viewer responds to ReloadActions messages and sends
a ReloadActions message when you customize a printer's icon name
or icon set.
</Para>
</RefSect1>
<RefSect1>
<Title>WARNING MESSAGES</Title>
<!--Start of RS / RE range-->
<Para>- Are you sure you want to cancel &lt;<Emphasis>job</Emphasis>>? -
</Para>
<!--End of RS / RE range-->
<Para>The Print Viewer displays a prompt before a print &lt;<Emphasis>job</Emphasis>> is canceled.
</Para>
</RefSect1>
<RefSect1>
<Title>EXIT STATUS</Title>
<Para>The following exit values are returned:
</Para>
<VariableList>
<VarListEntry>
<Term>0</Term>
<ListItem>
<Para>Successful completion.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>>0</Term>
<ListItem>
<Para>An invocation error was detected.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>EXAMPLES</Title>
<RefSect2>
<Title>dtprintinfo</Title>
<Para>Display the status of the LPDEST printer or the system default printer.
</Para>
</RefSect2>
<RefSect2>
<Title>dtprintinfo -p lp0</Title>
<Para>Display the status of the print queue called <Emphasis>lp0</Emphasis>.
</Para>
</RefSect2>
<RefSect2>
<Title>dtprintinfo -all</Title>
<Para>Display the status of all print queues.
</Para>
</RefSect2>
</RefSect1>
<RefSect1>
<Title>RELATED INFORMATION</Title>
<RefSect2>
<Title>CDE Print Specific Actions</Title>
<Para>Two print specific actions are created for each printer on the system.
These actions are defined in &lt;printer>.dt files located in
/etc/dt/appconfig/types/$LANG.
</Para>
</RefSect2>
<RefSect2>
<Title>&lt;printer>_Print</Title>
<Para>This action displays the status of the print queue specified by the
<Emphasis>&lt;printer></Emphasis> parameter.
</Para>
</RefSect2>
<RefSect2>
<Title>&lt;printer>_Print &lt;file></Title>
<Para>This action invokes the Print action for the <Emphasis>&lt;file></Emphasis> on the printer
specified by the <Emphasis>&lt;printer></Emphasis> parameter.
</Para>
</RefSect2>
</RefSect1>
<RefSect1>
<Title>FILES</Title>
<RefSect2>
<Title>dtprintinfo</Title>
<Para>Executable file. This file is located in /usr/dt/bin.
</Para>
</RefSect2>
<RefSect2>
<Title>Dtprintinfo</Title>
<Para>Application defaults file. This file is located in /usr/dt/app-defaults/$LANG.
</Para>
</RefSect2>
<RefSect2>
<Title>print.dt</Title>
<Para>CDE Print action definition file. This file is located in
/usr/dt/appconfig/types/$LANG.
</Para>
</RefSect2>
<RefSect2>
<Title>&lt;printer>.dt (Global actions)</Title>
<Para>The Print Viewer stores a &lt;printer>.dt action file for each printer on the
system. These files are located in /etc/dt/appconfig/types/$LANG.
</Para>
</RefSect2>
<RefSect2>
<Title>&lt;printer>.dt (customized actions)</Title>
<Para>The Print Viewer stores a &lt;printer>.dt action file for each customized
printer. These files are located in the $HOME/.dt/types.
</Para>
</RefSect2>
<RefSect2>
<Title>dtprintinfo.cat</Title>
<Para>Message catalog. This file is located in /usr/dt/lib/nls/msg/$LANG.
</Para>
</RefSect2>
<RefSect2>
<Title>Printmgr.sdl, PM*.tif, PM*.pm</Title>
<Para>Help files. These files are located in /usr/dt/appconfig/help/$LANG and
/usr/dt/appconfig/help/$LANG/graphics.
</Para>
</RefSect2>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dtlp;,&cdeman.dtprintinfoaction;</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.3 08/21/95 21:30:04-->

496
cde/doc/C/guides/man/man1_dt/screen.sgm Normal file
View File

@@ -0,0 +1,496 @@
<!-- $XConsortium: screen.sgm /main/9 1996/10/30 16:29:45 rws $ -->
<!-- (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.MAN30.rsml.1" remap="">
<refmeta><refentrytitle>dtscreen</refentrytitle><manvolnum>user cmd</manvolnum>
</refmeta>
<refnamediv><refname><command>dtscreen</command></refname><refpurpose>the
Common Desktop Environment animated screen savers</refpurpose></refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>dtscreen</command><arg choice="opt">&minus;display <replaceable>dsp</replaceable></arg><arg choice="opt">&minus;delay <replaceable>usecs</replaceable></arg>
<arg choice="opt">&minus;batchcount <replaceable>num</replaceable></arg><arg
choice="opt">&minus;saturation <replaceable>value</replaceable></arg><arg
choice="opt">&minus;nice <replaceable>nicelevel</replaceable></arg><arg choice="opt">&minus;mode <replaceable>mode</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>The dtscreen client supports the following key tasks.</para>
<!--Start of RS / RE range-->
<para>- Draws an animated image on a provided window id(s).</para>
<para>- Does not assume the size of the provided window(s).</para>
<para>- Provides a set of selectable animated images.</para>
<para>- Animation parameters such as nice, speed, number and saturation may
be specified.</para>
<!--End of RS / RE range-->
<para>The dtscreen client provides the default screen saver animations for
the desktop. When launched, it will query the desktop using the API for the
set for window ids on which to draw. These window ids could be the cover windows
created by the session manager for session lock, or a window embedded in the
style manager's session lock customization dialog. Once obtained, the dtscreen
client will proceed to draw in these windows using the specified options.
If dtscreen cannot obtain the set of window ids, it will create its own. Normally,
the dtscreen client will be invoked directly by the session manager, or by
the style manager.</para>
<para>Note that the Session Manager, dtsession, is responsible for locking
the session and prompting for a password to unlock.</para>
<para>The session manager may launch the dtscreen client to provide screen
saver animations during session lock. Refer to the session manager specification
for resources controlling the launching of screen savers by the session manager.
</para>
<para>The style manager may launch the dtscreen client to provide a preview
of a screen saver animation during customization. Refer to the style manager
specification for information on how to integrate a screen saver client such
as dtscreen into the desktop.</para>
<para>The dtsession client provides a selectable set of animations. These
are:</para>
<variablelist>
<varlistentry><term>hop</term>
<listitem>
<para>Hopalong iterated fractals.</para>
</listitem>
</varlistentry>
<varlistentry><term>life</term>
<listitem>
<para>Conway's game of life.</para>
</listitem>
</varlistentry>
<varlistentry><term>qix</term>
<listitem>
<para>Spinning lines.</para>
</listitem>
</varlistentry>
<varlistentry><term>image</term>
<listitem>
<para>Random bouncing image.</para>
</listitem>
</varlistentry>
<varlistentry><term>swarm</term>
<listitem>
<para>Swarm of bees.</para>
</listitem>
</varlistentry>
<varlistentry><term>rotor</term>
<listitem>
<para>Rotor</para>
</listitem>
</varlistentry>
<varlistentry><term>pyro</term>
<listitem>
<para>Fireworks.</para>
</listitem>
</varlistentry>
<varlistentry><term>flame</term>
<listitem>
<para>Cosmic Flame Fractals.</para>
</listitem>
</varlistentry>
<varlistentry><term>worm</term>
<listitem>
<para>Wiggly Worms.</para>
</listitem>
</varlistentry>
<varlistentry><term>random</term>
<listitem>
<para>Random mode.</para>
</listitem>
</varlistentry>
</variablelist>
<para>The dtscreen client animations are based on xlock(1).</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<para><literal>&minus;display</literal> <emphasis>dsp</emphasis></para>
<!--Start of RS / RE range-->
<para>The display on which animations will be drawn.</para>
<!--End of RS / RE range-->
<para><literal>&minus;delay</literal> <emphasis>usecs</emphasis></para>
<!--Start of RS / RE range-->
<para>The delay option sets the speed at which a mode will operate. It simply
sets the number of microseconds to delay between batches of "hopalong pixels",
"qix lines", "life generations", "image blits", and "swarm motions".</para>
<!--End of RS / RE range-->
<para><literal>&minus;batchcount</literal> <emphasis>num</emphasis></para>
<!--Start of RS / RE range-->
<para>The batchcount option sets the number of things to do per batch to num.
In qix mode this refers to the number of lines rendered in the same color.
In hop mode this refers to the number of pixels rendered in the same color.
In image mode this refers to the number of X logos on the screen at once.
in swarm mode this refers to the number of bees. In life mode it means nothing.
</para>
<!--End of RS / RE range-->
<para><literal>&minus;saturation</literal> <emphasis>value</emphasis></para>
<!--Start of RS / RE range-->
<para>The saturation option sets the saturation of the color ramp used to
value. 0 is grayscale, 1 is very rich color and 0.4 is a nice pastel.</para>
<!--End of RS / RE range-->
<para><literal>&minus;nice</literal> <emphasis>nicelevel</emphasis></para>
<!--Start of RS / RE range-->
<para>The nice option sets the system nicelevel of the dtscreen process to
nicelevel.</para>
<!--End of RS / RE range-->
<para><literal>&minus;mode</literal> <emphasis>mode</emphasis></para>
<!--Start of RS / RE range-->
<para>The mode option specifies which animation should be displayed. Values
are:</para>
<!--End of RS / RE range-->
<variablelist>
<varlistentry><term>hop</term>
<listitem>
<para>Hopalong iterated fractals.</para>
</listitem>
</varlistentry>
<varlistentry><term>life</term>
<listitem>
<para>Conway's game of life.</para>
</listitem>
</varlistentry>
<varlistentry><term>qix</term>
<listitem>
<para>Spinning lines.</para>
</listitem>
</varlistentry>
<varlistentry><term>image</term>
<listitem>
<para>Random bouncing image.</para>
</listitem>
</varlistentry>
<varlistentry><term>swarm</term>
<listitem>
<para>Swarm of bees.</para>
</listitem>
</varlistentry>
<varlistentry><term>rotor</term>
<listitem>
<para>Rotor</para>
</listitem>
</varlistentry>
<varlistentry><term>pyro</term>
<listitem>
<para>Fireworks.</para>
</listitem>
</varlistentry>
<varlistentry><term>flame</term>
<listitem>
<para>Cosmic Flame Fractals.</para>
</listitem>
</varlistentry>
<varlistentry><term>worm</term>
<listitem>
<para>Wiggly Worms.</para>
</listitem>
</varlistentry>
<varlistentry><term>random</term>
<listitem>
<para>Random mode.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>RETURN VALUE</title>
<para>Exit values are:</para>
<variablelist>
<varlistentry><term>0</term>
<listitem>
<para>Successful completion.</para>
</listitem>
</varlistentry>
<varlistentry><term>>0</term>
<listitem>
<para>Error condition occurred.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>EXAMPLES</title>
<refsect2>
<title>dtscreen -mode swarm</title>
<para>Display the swarm animation.</para>
</refsect2>
</refsect1>
<refsect1>
<title>RESOURCES</title>
<informaltable remap="center" orient="port">
<tgroup cols="4" colsep="0" rowsep="0">
<colspec align="left" colwidth="155*">
<colspec align="left" colwidth="147*">
<colspec align="left" colwidth="74*">
<colspec align="left" colwidth="81*">
<tbody>
<row>
<entry><literal>Name</literal></entry>
<entry><literal>ClassClass</literal></entry>
<entry><literal>Type</literal></entry>
<entry><literal>Default</literal></entry></row>
<row>
<entry>mode</entry>
<entry>Mode</entry>
<entry>String</entry>
<entry>swarm</entry></row>
<row>
<entry>nice</entry>
<entry>Nice</entry>
<entry>Int</entry>
<entry>16</entry></row>
<row>
<entry>delay</entry>
<entry>Delay</entry>
<entry>Int</entry>
<entry>1000</entry></row>
<row>
<entry>batchcount</entry>
<entry>Batchcount</entry>
<entry>Int</entry>
<entry>100</entry></row>
<row>
<entry>saturation</entry>
<entry>Saturation</entry>
<entry>Float</entry>
<entry>1.0</entry></row>
<row>
<entry>hop.delay</entry>
<entry>Delay</entry>
<entry>Int</entry>
<entry>0</entry></row>
<row>
<entry>hop.batchcount</entry>
<entry>Batchcount</entry>
<entry>Int</entry>
<entry>1000</entry></row>
<row>
<entry>hop.saturation</entry>
<entry>Saturation</entry>
<entry>Float</entry>
<entry>1</entry></row>
<row>
<entry>image.delay</entry>
<entry>Delay</entry>
<entry>Int</entry>
<entry>2000000</entry></row>
<row>
<entry>image.batchcount</entry>
<entry>Batchcount</entry>
<entry>Int</entry>
<entry>8</entry></row>
<row>
<entry>image.saturation</entry>
<entry>Saturation</entry>
<entry>Float</entry>
<entry>0.2</entry></row>
<row>
<entry>qix.delay</entry>
<entry>Delay</entry>
<entry>Int</entry>
<entry>30000</entry></row>
<row>
<entry>qix.batchcount</entry>
<entry>Batchcount</entry>
<entry>Int</entry>
<entry>64</entry></row>
<row>
<entry>qix.saturation</entry>
<entry>Saturation</entry>
<entry>Float</entry>
<entry>1</entry></row>
<row>
<entry>life.delay</entry>
<entry>Delay</entry>
<entry>Int</entry>
<entry>1000000</entry></row>
<row>
<entry>life.batchcount</entry>
<entry>Batchcount</entry>
<entry>Int</entry>
<entry>1</entry></row>
<row>
<entry>life.saturation</entry>
<entry>Saturation</entry>
<entry>Float</entry>
<entry>1</entry></row>
<row>
<entry>swarm.delay</entry>
<entry>Delay</entry>
<entry>Int</entry>
<entry>10000</entry></row>
<row>
<entry>swarm.batchcount</entry>
<entry>Batchcount</entry>
<entry>Int</entry>
<entry>100</entry></row>
<row>
<entry>swarm.saturation</entry>
<entry>Saturation</entry>
<entry>Float</entry>
<entry>1</entry></row>
<row>
<entry>rotor.delay</entry>
<entry>Delay</entry>
<entry>Int</entry>
<entry>10000</entry></row>
<row>
<entry>rotor.batchcount</entry>
<entry>Batchcount</entry>
<entry>Int</entry>
<entry>4</entry></row>
<row>
<entry>rotor.saturation</entry>
<entry>Saturation</entry>
<entry>Float</entry>
<entry>0.4</entry></row>
<row>
<entry>pyro.delay</entry>
<entry>Delay</entry>
<entry>Int</entry>
<entry>15000</entry></row>
<row>
<entry>pyro.batchcount</entry>
<entry>Batchcount</entry>
<entry>Int</entry>
<entry>40</entry></row>
<row>
<entry>pyro.saturation</entry>
<entry>Saturation</entry>
<entry>Float</entry>
<entry>1.0</entry></row>
<row>
<entry>flame.delay</entry>
<entry>Delay</entry>
<entry>Int</entry>
<entry>10000</entry></row>
<row>
<entry>flame.batchcount</entry>
<entry>Batchcount</entry>
<entry>Int</entry>
<entry>20</entry></row>
<row>
<entry>flame.saturation</entry>
<entry>Saturation</entry>
<entry>Float</entry>
<entry>1.0</entry></row>
<row>
<entry>worm.delay</entry>
<entry>Delay</entry>
<entry>Int</entry>
<entry>10000</entry></row>
<row>
<entry>worm.batchcount</entry>
<entry>Batchcount</entry>
<entry>Int</entry>
<entry>20</entry></row>
<row>
<entry>worm.saturation</entry>
<entry>Saturation</entry>
<entry>Float</entry>
<entry>1.0</entry></row></tbody></tgroup></informaltable>
<refsect2>
<title>delay</title>
<para>The delay option sets the speed at which a mode will operate. It simply
sets the number of microseconds to delay between batches of "hopalong pixels",
"qix lines", "life generations", "image blits", and "swarm motions".</para>
</refsect2>
<refsect2>
<title>batchcount</title>
<para>The batchcount option sets the number of things to do per batch to num.
In qix mode this refers to the number of lines rendered in the same color.
In hop mode this refers to the number of pixels rendered in the same color.
In image mode this refers to the number of X logos on the screen at once.
in swarm mode this refers to the number of bees. In life mode it means nothing.
</para>
</refsect2>
<refsect2>
<title>saturation</title>
<para>The saturation option sets the saturation of the color ramp used to
value. 0 is grayscale, 1 is very rich color and 0.4 is a nice pastel.</para>
</refsect2>
<refsect2>
<title>nice</title>
<para>The nice option sets the system nicelevel of the dtscreen process to
nicelevel.</para>
</refsect2>
<refsect2>
<title>mode</title>
<para>The mode option specifies which animation should be displayed. Values
are:</para>
<variablelist>
<varlistentry><term>hop</term>
<listitem>
<para>Hopalong iterated fractals.</para>
</listitem>
</varlistentry>
<varlistentry><term>life</term>
<listitem>
<para>Conway's game of life.</para>
</listitem>
</varlistentry>
<varlistentry><term>qix</term>
<listitem>
<para>Spinning lines.</para>
</listitem>
</varlistentry>
<varlistentry><term>image</term>
<listitem>
<para>Random bouncing image.</para>
</listitem>
</varlistentry>
<varlistentry><term>swarm</term>
<listitem>
<para>Swarm of bees.</para>
</listitem>
</varlistentry>
<varlistentry><term>rotor</term>
<listitem>
<para>Rotor</para>
</listitem>
</varlistentry>
<varlistentry><term>pyro</term>
<listitem>
<para>Fireworks.</para>
</listitem>
</varlistentry>
<varlistentry><term>flame</term>
<listitem>
<para>Cosmic Flame Fractals.</para>
</listitem>
</varlistentry>
<varlistentry><term>worm</term>
<listitem>
<para>Wiggly Worms.</para>
</listitem>
</varlistentry>
<varlistentry><term>random</term>
<listitem>
<para>Random mode.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<refsect1>
<title>SEE</title>
<variablelist>
<varlistentry><term>dtsession</term>
<listitem><?Pub Caret1>
<para>Launches the dtscreen client during session lock. Provides resources
that can be used to control this event. Locks and unlocks a session.</para>
</listitem>
</varlistentry>
<varlistentry><term>dtstyle</term>
<listitem>
<para>Launched the dtscreen client during session lock customization. Provides
the methods by which additional screen saver clients may be integrated into
the desktop.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
</refentry>
<!--fickle 1.12 mancsf-to-docbook 1.3 08/21/95 21:30:04-->
<?Pub *0000043125>

896
cde/doc/C/guides/man/man1_dt/searchpa.sgm Normal file
View File

@@ -0,0 +1,896 @@
<!-- $XConsortium: searchpa.sgm /main/15 1996/10/31 09:40:34 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.MAN31.rsml.1">
<RefMeta>
<RefEntryTitle>dtsearchpath</RefEntryTitle>
<ManVolNum>user cmd</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Command>dtsearchpath</Command></RefName>
<RefPurpose>set desktop search paths
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<CmdSynopsis>
<Command>dtsearchpath</Command>
<Arg>-u <Replaceable>username</Replaceable></Arg>
<Arg Choice="opt">-v</Arg>
<Arg Choice="opt">-o</Arg>
<Arg Choice="opt">-csh</Arg>
<Arg Choice="opt">-ksh</Arg>
</CmdSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>The
<Command>dtsearchpath</Command> command line utility
sets local and remote locations that desktop components should
search for Application Manager groups, for filetype and action
definitions,
for desktop icons, and for help files.
</Para>
<Para>The <Filename>/usr/dt/bin/Xsession</Filename> startup script sources
the user's
<Filename>$HOME/.dtprofile</Filename>
script and any scripts located under <Filename>/etc/dt/config/Xsession.d</Filename>
and <Filename>/usr/dt/config/Xsession.d</Filename>.
After sourcing the <Filename>Xsession.d</Filename>
files, the <Command>Xsession</Command> script will invoke
<Filename>/usr/dt/bin/dtsearchpath</Filename> to
set and export the environment variables
<SystemItem Class="EnvironVar">DTAPPSEARCHPATH</SystemItem>, <SystemItem Class="EnvironVar">DTDATABASESEARCHPATH</SystemItem>, <Emphasis>DTHELPSEARCHPATH</Emphasis>, <SystemItem Class="EnvironVar">XMICONSEARCHPATH</SystemItem>, and
<Emphasis>XMICONBMSEARCHPATH</Emphasis> (see the
<Symbol>ENVIRONMENT</Symbol> heading in this man page for a more detailed description).
</Para>
<RefSect2>
<Title>Search Path Syntax</Title>
<Para>Each of the exported search path variables is supported by, that is,
built from, two comma-separated search path environment variables.
For example:
<SystemItem Class="EnvironVar">DTAPPSEARCHPATH</SystemItem> is supported by
<Emphasis>DTSPSYSAPPHOSTS</Emphasis> and
<Emphasis>DTSPUSERAPPHOSTS</Emphasis>. <SystemItem Class="EnvironVar">XMICONSEARCHPATH</SystemItem> is supported by
<Emphasis>DTSPSYSICON</Emphasis> and
<Emphasis>DTSPUSERICON</Emphasis>.</Para>
<Para>The input search path environment variables fall into two categories &minus;
those that support the host:/path syntax and those that do not.
If the name of
the input environment variable contains the string
<Emphasis>HOSTS</Emphasis>, it will
support host:/path syntax.
The syntax for search paths that support
host:/path is:
</Para>
<InformalExample Remap="indent">
<ProgramListing>search path element
[ <Emphasis>host</Emphasis> <Literal>|</Literal> <Emphasis>pathname</Emphasis> <Literal>|</Literal> <Emphasis>hostname+pathname</Emphasis> ]
host
&lt;hostname>:
pathname
/&lt;<Emphasis>absolute path</Emphasis>>
</ProgramListing>
</InformalExample>
<Para>The syntax for search paths that do not support host:/path is:
</Para>
<InformalExample Remap="indent">
<ProgramListing>search path element
[ <Symbol Role="Variable">pathname</Symbol> ]
pathname
/&lt;<Emphasis>absolute path</Emphasis>>
</ProgramListing>
</InformalExample>
</RefSect2>
<RefSect2>
<Title>Examples</Title>
<Para>To set the Icon search path to include the
<Filename>/usr/local/games/icons</Filename> subdirectory,
the following line would appear
in a script in the <Filename>/etc/dt/config/Xsession.d/</Filename> subdirectory:
<Literal>DTSPSYSICON=/usr/local/games/icons</Literal>
To set the Database search path to include host <Literal>marlin</Literal>,
the following line would appear
in a script in the <Filename>/etc/dt/config/Xsession.d/</Filename> subdirectory:
<Literal>DTSPSYSDATABASEHOSTS=marlin:</Literal>
To set the Application Manager path to include the applications on host
steelhead under subdirectory <Filename>/usr/local</Filename>, and under the default
help location on host <Literal>halibut</Literal>,
the following line would appear
in a script in the <Filename>/etc/dt/config/Xsession.d/</Filename> subdirectory:
<Literal>DTSPSYSAPPHOSTS=steelhead:/usr/local,halibut:</Literal>
The
<Command>dtsearchpath</Command> command line utility
parses these path elements and transforms them into a form suitable
for the desktop components.
</Para>
<Para>If a
<Literal>host</Literal> element is included,
then the Tooltalk library's filename mapping capabilities will
control how
a path to files on that host are constructed.
For example, the path to file
<Filename>/tmp/file</Filename> on host <Literal>goby</Literal> may be constructed
as <Filename>/net/goby/tmp/file</Filename> or as <Filename>/nfs/goby/tmp/file</Filename>.
</Para>
</RefSect2>
<RefSect2>
<Title>Default Locations</Title>
<Para>By default,
<Command>dtsearchpath</Command> sets up three search locations for each subsystem.
In search
order, they are:
</Para>
<ItemizedList>
<ListItem>
<Para>The user's personal location, under <Filename>$HOME/.dt</Filename>.
</Para>
</ListItem>
<ListItem>
<Para>The system administrator's configuration location, under
<Filename>/etc/dt/appconfig</Filename>.
</Para>
</ListItem>
<ListItem>
<Para>The factory default location, under <Filename>/usr/dt/appconfig</Filename>.
</Para>
</ListItem>
</ItemizedList>
</RefSect2>
<RefSect2>
<Title>Precedence</Title>
<Para>When searching a path for a particular item, such as an icon file, the
desktop will always be satisfied by the first item found.
For example,
when searching for an icon whose basename is
<Literal>beeper</Literal>,
if that icon exists in both the
<Filename>/etc/dt/appconfig/icons</Filename>
and the
<Filename>/usr/dt/appconfig/icons</Filename> subdirectories,
then the icon under
<Filename>/etc/dt/appconfig/icons</Filename>
will be found first and used, because that
element appears first in the
<SystemItem Class="EnvironVar">XMICONSEARCHPATH</SystemItem>.
The search terminates when the first match occurs.
</Para>
<Para>Each of the <Emphasis>DTSPSYS</Emphasis> search path environment variables has a
corresponding <Emphasis>DTSPUSER</Emphasis> environment variable which will take
precedence over the system setting.
The <Emphasis>DTSPUSER</Emphasis> values will
be prepended to the <Symbol>DT</Symbol> search path whereas the
<Emphasis>DTSPSYS</Emphasis> values will come after the
<Filename>$HOME/.dt</Filename> configuration location but before the factory default location.
The relationship between the system administrator's customization and the
default <Filename>/etc/dt</Filename> configuration location is up to the user of the
<Emphasis>DTSPSYS</Emphasis> value.
</Para>
</RefSect2>
</RefSect1>
<RefSect1>
<Title>OPTIONS</Title>
<VariableList>
<VarListEntry>
<Term><Literal>&minus;u user</Literal></Term>
<ListItem>
<Para>Causes
<Command>dtsearchpath</Command> to return the search paths for the specified user.
This option is useful
for system administrators who need to understand the search paths for
a particular user.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>&minus;v</Literal></Term>
<ListItem>
<Para>The verbose option causes
<Command>dtsearchpath</Command> to print to standard output the values of the search environment
formatted for easier human reading. By default, the command runs silently.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>&minus;csh</Literal></Term>
<ListItem>
<Para>Causes <Command>dtsearchpath</Command> to return values suitable for
evaluation by a C Shell script. By default, the command returns values suitable for
evaluation by a Bourne Shell script.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>&minus;ksh</Literal></Term>
<ListItem>
<Para>Causes <Command>dtsearchpath</Command> to return values suitable fore
evaluation by a Korn Shell script. By default, the command returns values suitable for
evaluation by a Bourne Shell script.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RETURN VALUES</Title>
<VariableList>
<VarListEntry>
<Term>0</Term>
<ListItem>
<Para>Command completed successfully.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term>1</Term>
<ListItem>
<Para>Command invoked with incorrect usage.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>ENVIRONMENT</Title>
<Para>The values set by
<Command>dtsearchpath</Command> are passed through to the individual desktop subsystems, such as
the action
database and the help system, by means of environment variables.
</Para>
<Para>The <Emphasis>DTSPSYSAPPHOSTS</Emphasis> variable is the primary environment
variable and drives the remaining search paths for filetypes and
actions, for desktop icons, and for help files.
</Para>
<Para>In the following list, all values are derived from three places: the
user's <Filename>$HOME</Filename> directory (<Filename>$HOME/.dt</Filename>),
the system configuration directory (<Filename>/etc/dt/appconfig</Filename>),
and the factory defaults directory (<Filename>/usr/dt/appconfig</Filename>).
The values are listed as transformed for the individual desktop
subsystems.
</Para>
<Para>To verify these values, execute
<Command>dtsearchpath</Command> with the verbose (<Literal>-v</Literal>) option.
<SystemItem Class="EnvironVar">DTAPPSEARCHPATH</SystemItem>, <Emphasis>DTSPSYSAPPHOSTS</Emphasis>, <Emphasis>DTSPUSERAPPHOSTS</Emphasis>: Used to discover application hosts and their registry subdirectories.
The default transformed value is:
<Filename>$HOME/.dt/appmanager
/etc/dt/appconfig/appmanager/%L
/etc/dt/appconfig/appmanager/C
/usr/dt/appconfig/appmanager/%L
/usr/dt/appconfig/appmanager/C</Filename>
Where <Literal>%L</Literal> is the value of the
<SystemItem Class="EnvironVar">LANG</SystemItem> environment variable.
</Para>
<Para>The value of
<SystemItem Class="EnvironVar">DTAPPSEARCHPATH</SystemItem> can be altered by either of two
environment variables:
<Emphasis>DTSPSYSAPPHOSTS</Emphasis> and/or
<Emphasis>DTSPUSERAPPHOSTS</Emphasis>. <Emphasis>DTSPSYSAPPHOSTS</Emphasis> is for use by system administrators.
Values are
specified by adding a ksh script to the
<Filename>/etc/dt/config/Xsession.d</Filename> directory that exports the variable.
export DTSPSYSAPPHOSTS=marlin:,goby:/vipapps,/opt
The expected syntax for
<Emphasis>DTSPSYSAPPHOSTS</Emphasis> is a comma-separated list.
<Emphasis>DTSPSYSAPPHOSTS</Emphasis> accepts host:, host:/path, or just /path.
The effect
is to insert a searchpath after the configuration location
(<Filename>/etc/dt/appconfig/appmanager</Filename>) and before the factory default location
(<Filename>/usr/dt/appconfig/appmanager</Filename>).
<Filename>$HOME/.dt/appmanager
/etc/dt/appconfig/appmanager/%L
/etc/dt/appconfig/appmanager/C
/nfs/marlin/etc/dt/appconfig/appmanager/%L
/nfs/marlin/etc/dt/appconfig/appmanager/C
/nfs/goby/vipapps/appconfig/appmanager/%L
/nfs/goby/vipapps/appconfig/appmanager/C
/opt/appconfig/appmanager/%L
/opt/appconfig/appmanager/C
/usr/dt/appconfig/appmanager/%L
/usr/dt/appconfig/appmanager/C</Filename>
If the system administrator wants the local configuration directory to
appear in a different location within the configurable search paths,
the special host term 'localhost:' can be inserted anywhere into the
environment variable:
export DTSPSYSAPPHOSTS=marlin:,localhost:,goby:/vipapps,/opt
The resulting value for
<SystemItem Class="EnvironVar">DTAPPSEARCHPATH</SystemItem> would be:
<Filename>$HOME/.dt/appmanager
/nfs/marlin/etc/dt/appconfig/appmanager/%L
/nfs/marlin/etc/dt/appconfig/appmanager/C
/etc/dt/appconfig/appmanager/%L
/etc/dt/appconfig/appmanager/C
/nfs/goby/vipapps/appconfig/appmanager/%L
/nfs/goby/vipapps/appconfig/appmanager/C
/opt/appconfig/appmanager/%L
/opt/appconfig/appmanager/C
/usr/dt/appconfig/appmanager/%L
/usr/dt/appconfig/appmanager/C</Filename>
In fact, the value 'localhost:' can be inserted anywhere in the
<Emphasis>DTSPSYSAPPHOSTS</Emphasis> value and its order within the
<Emphasis>DTSPSYSAPPHOSTS</Emphasis> will be reflected in the
<SystemItem Class="EnvironVar">DTAPPSEARCHPATH</SystemItem> value.
<Emphasis>DTSPUSERAPPHOSTS</Emphasis> is for use by end users.
Values are specified by exporting
the value in the user's .dtprofile.
export DTSPUSERAPPHOSTS=appsvr:,/myapps
<Emphasis>DTSPUSERAPPHOSTS</Emphasis> also accepts host:, host:/path, and /path
specifications.
The effect is to insert a searchpath before any other
searchpath.
<Filename>/nfs/appsvr/etc/dt/appconfig/appmanager/%L
/nfs/appsvr/etc/dt/appconfig/appmanager/C
/myapps/appmanager/%L
/myapps/appmanager/C
$HOME/.dt/appmanager
/etc/dt/appconfig/appmanager/%L
/etc/dt/appconfig/appmanager/C
/usr/dt/appconfig/appmanager/%L
/usr/dt/appconfig/appmanager/C</Filename>
<SystemItem Class="EnvironVar">DTDATABASESEARCHPATH</SystemItem>, <Emphasis>DTSPSYSDATABASEHOSTS</Emphasis>, <Emphasis>DTSPUSERDATABASEHOSTS</Emphasis>: Used to collect filetype and action definitions, as expressed in
<Filename>*.dt</Filename> files.
The default transformed value is:
<Filename>$HOME/.dt/types
/etc/dt/appconfig/types/%L
/etc/dt/appconfig/types/C
/usr/dt/appconfig/types/%L
/usr/dt/appconfig/types/C</Filename>
Where <Literal>%L</Literal> is the value of the
<SystemItem Class="EnvironVar">LANG</SystemItem> environment variable.
</Para>
<Para>The value of
<SystemItem Class="EnvironVar">DTDATABASESEARCHPATH</SystemItem> can be altered by either of two
environment variables:
<Emphasis>DTSPSYSDATABASEHOSTS</Emphasis> and/or
<Emphasis>DTSPUSERDATABASEHOSTS</Emphasis>. <Emphasis>DTSPSYSDATABASEHOSTS</Emphasis> is for use by system administrators.
Values are
specified by adding a ksh script to the <Filename>/etc/dt/config/Xsession.d</Filename>
directory that exports the variable.
export DTSPSYSDATABASEHOSTS=marlin:,goby:/vipapps,/opt
The expected syntax for
<Emphasis>DTSPSYSDATABASEHOSTS</Emphasis> is a comma-separated
list.
<Emphasis>DTSPSYSDATABASEHOSTS</Emphasis> accepts host:, host:/path, or just /path.
The effect is to insert a searchpath after the configuration location
(<Filename>/etc/dt/appconfig/types</Filename>) and before the factory default location
(<Filename>/usr/dt/appconfig/types</Filename>).
<Filename>$HOME/.dt/types
/etc/dt/appconfig/types/%L
/etc/dt/appconfig/types/C
marlin:/etc/dt/appconfig/types/%L
marlin:/etc/dt/appconfig/types/C
goby:/vipapps/appconfig/types/%L
goby:/vipapps/appconfig/types/C
/opt/appconfig/types/%L
/opt/appconfig/types/C
/usr/dt/appconfig/types/%L
/usr/dt/appconfig/types/C</Filename>
As is the case for
<SystemItem Class="EnvironVar">DTAPPSEARCHPATH</SystemItem>, the placement of the local configuration
directory can be affected by the adding special host term 'localhost:'
to the
<Emphasis>DTSPSYSDATABASEHOSTS</Emphasis> environment variable.
export DTSPSYSDATABASEHOSTS=marlin:,localhost:,goby:/vipapps
The resulting value for
<SystemItem Class="EnvironVar">DTDATABASESEARCHPATH</SystemItem> would be:
<Filename>$HOME/.dt/types
marlin:/etc/dt/appconfig/types/%L
marlin:/etc/dt/appconfig/types/C
/etc/dt/appconfig/types/%L
/etc/dt/appconfig/types/C
goby:/vipapps/appconfig/types/%L
goby:/vipapps/appconfig/types/C
/usr/dt/appconfig/types/%L
/usr/dt/appconfig/types/C</Filename>
</Para>
<Para><Emphasis>DTSPUSERDATABASEHOSTS</Emphasis> is for use by end users.
Values are specified by
exporting the value in the user's .dtprofile.
</Para>
<Para>export DTSPUSERDATABASEHOSTS=dbsvr:,/mytypes
<Emphasis>DTSPUSERDATABASEHOSTS</Emphasis> also accepts host:, host:/path, and /path
specifications.
The effect is to insert a searchpath before any other
searchpath.
<Filename>dbsvr:/etc/dt/appconfig/types/%L
dbsvr:/etc/dt/appconfig/types/C
/mytypes/types/%L
/mytypes/types/C
$HOME/.dt/types
/etc/dt/appconfig/types/%L
/etc/dt/appconfig/types/C
/usr/dt/appconfig/types/%L
/usr/dt/appconfig/types/C</Filename>
<SystemItem Class="EnvironVar">XMICONSEARCHPATH</SystemItem>, <Emphasis>XMICONBMSEARCHPATH</Emphasis>, <Emphasis>DTSPSYSICON</Emphasis>, <Emphasis>DTSPUSERICON</Emphasis>: Used to locate desktop icons.
The default transformed value is:
<Filename>$HOME/.dt/icons/%B%M.pm
$HOME/.dt/icons/%B%M.bm
$HOME/.dt/icons/%B
/etc/dt/appconfig/icons/%L/%B%M.pm
/etc/dt/appconfig/icons/%L/%B%M.bm
/etc/dt/appconfig/icons/%L/%B
/etc/dt/appconfig/icons/C/%B%M.pm
/etc/dt/appconfig/icons/C/%B%M.bm
/etc/dt/appconfig/icons/C/%B
/usr/dt/appconfig/icons/%L/%B%M.pm
/usr/dt/appconfig/icons/%L/%B%M.bm
/usr/dt/appconfig/icons/%L/%B
/usr/dt/appconfig/icons/C/%B%M.pm
/usr/dt/appconfig/icons/C/%B%M.bm
/usr/dt/appconfig/icons/C/%B</Filename></Para>
<Para>Where
<Literal>%B</Literal> is the basename of the requested icon,
<Literal>%M</Literal> is the magnitude
(size) of the icon, and
<Literal>%L</Literal> is the value of the
<SystemItem Class="EnvironVar">LANG</SystemItem> environment variable.
</Para>
<Para>The value of
<SystemItem Class="EnvironVar">XMICONSEARCHPATH</SystemItem> can be altered by either of two
environment variables:
<Emphasis>DTSPSYSICON</Emphasis> and/or
<Emphasis>DTSPUSERICON</Emphasis>. <Emphasis>DTSPSYSICON</Emphasis> is for use by system administrators.
Values are
specified by adding a ksh script to the
<Filename>/etc/dt/config/Xsession.d</Filename> directory that exports the variable.
export DTSPSYSICON=/vipapps/icons
</Para>
<Para>The expected syntax for
<Emphasis>DTSPSYSICON</Emphasis> is a comma-separated list.
<Emphasis>DTSPSYSICON</Emphasis> accepts the /path format.
The effect
is to insert a searchpath after the configuration location
(<Filename>/etc/dt/appconfig/icons</Filename>) and before the factory default location
(<Filename>/usr/dt/appconfig/icons</Filename>).
<Filename>$HOME/.dt/icons/%B%M.pm
$HOME/.dt/icons/%B%M.bm
$HOME/.dt/icons/%B%M
/etc/dt/appconfig/icons/%L/%B%M.pm
/etc/dt/appconfig/icons/%L/%B%M.bm
/etc/dt/appconfig/icons/%L/%B%M
/etc/dt/appconfig/icons/C/%B%M.pm
/etc/dt/appconfig/icons/C/%B%M.bm
/etc/dt/appconfig/icons/C/%B%M
/vipapps/icons/%L/%B%M.pm
/vipapps/icons/%L/%B%M.bm
/vipapps/icons/%L/%B%M
/vipapps/icons/C/%B%M.pm
/vipapps/icons/C/%B%M.bm
/vipapps/icons/C/%B%M
usr/dt/appconfig/icons/%L/%B%M.pm
/usr/dt/appconfig/icons/%L/%B%M.bm
/usr/dt/appconfig/icons/%L/%B%M
/usr/dt/appconfig/types/C/%B%M.pm
/usr/dt/appconfig/types/C/%B%M.bm
/usr/dt/appconfig/types/C/%B%M</Filename>
</Para>
<Para>The placement of the local configuration directory can be affected by
the adding the path term
<Filename>/etc/dt/appconfig</Filename> to the
<Emphasis>DTSPSYSICON</Emphasis> environment variable.
export DTSPSYSICON=/vipapps/icons,/etc/dt/appconfig
</Para>
<Para>The resulting value for
<SystemItem Class="EnvironVar">XMICONSEARCHPATH</SystemItem> would be:
</Para>
<Para><Filename>$HOME/.dt/icons/%B%M.pm
$HOME/.dt/icons/%B%M.bm
$HOME/.dt/icons/%B%M
/vipapps/icons/%L/%B%M.pm
/vipapps/icons/%L/%B%M.bm
/vipapps/icons/%L/%B%M
/vipapps/icons/C/%B%M.pm
/vipapps/icons/C/%B%M.bm
/vipapps/icons/C/%B%M
/etc/dt/appconfig/icons/%L/%B%M.pm
/etc/dt/appconfig/icons/%L/%B%M.bm
/etc/dt/appconfig/icons/%L/%B%M
/etc/dt/appconfig/icons/C/%B%M.pm
/etc/dt/appconfig/icons/C/%B%M.bm
/etc/dt/appconfig/icons/C/%B%M
usr/dt/appconfig/icons/%L/%B%M.pm
/usr/dt/appconfig/icons/%L/%B%M.bm
/usr/dt/appconfig/icons/%L/%B%M
/usr/dt/appconfig/types/C/%B%M.pm
/usr/dt/appconfig/types/C/%B%M.bm
/usr/dt/appconfig/types/C/%B%M</Filename>
<Emphasis>DTSPUSERICON</Emphasis> is for use by end users.
Values are specified by
exporting the value in the user's .dtprofile.
</Para>
<Para>export DTSPUSERICON=$HOME/myicons
</Para>
<Para><Emphasis>DTSPUSERICON</Emphasis> accepts /path specifications.
The effect is to insert a
searchpath before any other searchpath.
</Para>
<Para><Filename>$HOME/myicons/%B%M.pm
$HOME/myicons/%B%M.bm
$HOME/myicons/%B%M
$HOME/.dt/icons/%B%M.pm
$HOME/.dt/icons/%B%M.bm
$HOME/.dt/icons/%B%M
/etc/dt/appconfig/icons/%L/%B%M.pm
/etc/dt/appconfig/icons/%L/%B%M.bm
/etc/dt/appconfig/icons/%L/%B%M
/etc/dt/appconfig/icons/C/%B%M.pm
/etc/dt/appconfig/icons/C/%B%M.bm
/etc/dt/appconfig/icons/C/%B%M
/usr/dt/appconfig/icons/%L/%B%M.pm
/usr/dt/appconfig/icons/%L/%B%M.bm
/usr/dt/appconfig/icons/%L/%B%M
/usr/dt/appconfig/types/C/%B%M.pm
/usr/dt/appconfig/types/C/%B%M.bm
/usr/dt/appconfig/types/C/%B%M</Filename>
<Emphasis>DTHELPSEARCHPATH</Emphasis>, <Emphasis>DTSPSYSHELP</Emphasis>, <Emphasis>DTSPUSERHELP</Emphasis>:</Para>
<Para>Used to locate help volumes and families for the desktop help
subsystem.
The default transformed value is:
<Filename>$HOME/.dt/help/&lt;session>/%H
$HOME/.dt/help/&lt;session>/%H.sdl
$HOME/.dt/help/&lt;session>/%H.hv
$HOME/.dt/help/%H
$HOME/.dt/help/%H.sdl
$HOME/.dt/help/%H.hv
/etc/dt/appconfig/help/%L/%H
/etc/dt/appconfig/help/%L/%H.sdl
/etc/dt/appconfig/help/%L/%H.hv
/etc/dt/appconfig/help/C/%H
/etc/dt/appconfig/help/C/%H.sdl
/etc/dt/appconfig/help/C/%H.hv
/usr/dt/appconfig/help/%L/%H
/usr/dt/appconfig/help/%L/%H.sdl
/usr/dt/appconfig/help/%L/%H.hv
/usr/dt/appconfig/help/C/%H
/usr/dt/appconfig/help/C/%H.sdl
/usr/dt/appconfig/help/C/%H.hv</Filename>
</Para>
<Para>Where
<Literal>%H</Literal> is the basename of the requested help volume, and
<Literal>%L</Literal> is the
value of the
<SystemItem Class="EnvironVar">LANG</SystemItem> environment variable.
</Para>
<Para>The value of
<Emphasis>DTHELPSEARCHPATH</Emphasis> can be altered by either of two
environment variables:
<Emphasis>DTSPSYSHELP</Emphasis> and/or
<Emphasis>DTSPUSERHELP</Emphasis>. <Emphasis>DTSPSYSHELP</Emphasis> is for use by system administrators.
Values are
specified by adding a ksh script to the
<Filename>/etc/dt/config/Xsession.d</Filename> directory that exports the variable.
</Para>
<Para>export DTSPSYSHELP=/vipapps/help
</Para>
<Para>The expected syntax for
<Emphasis>DTSPSYSHELP</Emphasis> is a comma-separated list.
<Emphasis>DTSPSYSHELP</Emphasis> accepts the /path format.
The effect
is to insert a searchpath after the configuration location
(<Filename>/etc/dt/appconfig/help</Filename>) and before the factory default location
(<Filename>/usr/dt/appconfig/help</Filename>).
<Filename>$HOME/.dt/help/&lt;session>/%H
$HOME/.dt/help/&lt;session>/%H.sdl
$HOME/.dt/help/&lt;session>/%H.hv
$HOME/.dt/help/%H
$HOME/.dt/help/%H.sdl
$HOME/.dt/help/%H.hv
/etc/dt/appconfig/help/%L/%H
/etc/dt/appconfig/help/%L/%H.sdl
/etc/dt/appconfig/help/%L/%H.hv
/etc/dt/appconfig/help/C/%H
/etc/dt/appconfig/help/C/%H.sdl
/etc/dt/appconfig/help/C/%H.hv
/vipapps/help/%L/%H
/vipapps/help/%L/%H.sdl
/vipapps/help/%L/%H.hv
/vipapps/help/C/%H
/vipapps/help/C/%H.sdl
/vipapps/help/C/%H.hv
/usr/dt/appconfig/help/%L/%H
/usr/dt/appconfig/help/%L/%H.sdl
/usr/dt/appconfig/help/%L/%H.hv
/usr/dt/appconfig/help/C/%H
/usr/dt/appconfig/help/C/%H.sdl
/usr/dt/appconfig/help/C/%H.hv</Filename>
The placement of the local configuration directory can be affected by
the adding the path term <Filename>/etc/dt/appconfig</Filename>
to the
<Emphasis>DTSPSYSHELP</Emphasis> environment variable.
</Para>
<Para>export DTSPSYSHELP=/vipapps/help,/etc/dt/appconfig
</Para>
<Para>The resulting value for
<Emphasis>DTHELPSEARCHPATH</Emphasis> would be:
<Filename>$HOME/.dt/help/&lt;session>/%H
$HOME/.dt/help/&lt;session>/%H.sdl
$HOME/.dt/help/&lt;session>/%H.hv
$HOME/.dt/help/%H
$HOME/.dt/help/%H.sdl
$HOME/.dt/help/%H.hv
/vipapps/help/%L/%H
/vipapps/help/%L/%H.sdl
/vipapps/help/%L/%H.hv
/vipapps/help/C/%H
/vipapps/help/C/%H.sdl
/vipapps/help/C/%H.hv
/etc/dt/appconfig/help/%L/%H
/etc/dt/appconfig/help/%L/%H.sdl
/etc/dt/appconfig/help/%L/%H.hv
/etc/dt/appconfig/help/C/%H
/etc/dt/appconfig/help/C/%H.sdl
/etc/dt/appconfig/help/C/%H.hv
/usr/dt/appconfig/help/%L/%H
/usr/dt/appconfig/help/%L/%H.sdl
/usr/dt/appconfig/help/%L/%H.hv
/usr/dt/appconfig/help/C/%H
/usr/dt/appconfig/help/C/%H.sdl
/usr/dt/appconfig/help/C/%H.hv</Filename>
<Emphasis>DTSPUSERHELP</Emphasis> is for use by end users.
Values are specified by
exporting the value in the user's .dtprofile.
</Para>
<Para>export DTSPUSERHELP=$HOME/myhelp
</Para>
<Para><Emphasis>DTSPUSERHELP</Emphasis> accepts /path specifications.
The effect is to insert a
searchpath before any other searchpath.
<Filename>$HOME/myhelp/%H
$HOME/myhelp/%H.sdl
$HOME/myhelp/%H.hv
$HOME/.dt/help/&lt;session>/%H
$HOME/.dt/help/&lt;session>/%H.sdl
$HOME/.dt/help/&lt;session>/%H.hv
$HOME/.dt/help/%H
$HOME/.dt/help/%H.sdl
$HOME/.dt/help/%H.hv
/etc/dt/appconfig/help/%L/%H
/etc/dt/appconfig/help/%L/%H.sdl
/etc/dt/appconfig/help/%L/%H.hv
/etc/dt/appconfig/help/C/%H
/etc/dt/appconfig/help/C/%H.sdl
z.br
/etc/dt/appconfig/help/C/%H.hv
/usr/dt/appconfig/help/%L/%H
/usr/dt/appconfig/help/%L/%H.sdl
/usr/dt/appconfig/help/%L/%H.hv
/usr/dt/appconfig/help/C/%H
/usr/dt/appconfig/help/C/%H.sdl
/usr/dt/appconfig/help/C/%H.hv</Filename>
</Para>
<Para>(See also the <Symbol>OPTIMIZATIONS</Symbol> heading in this man page.)
</Para>
<Para>At the conclusion of <Command>dtsearchpath</Command>, <Emphasis>DTSPSYS</Emphasis> and
<Emphasis>DTSPUSER</Emphasis> variables are explicitly unset, so that only the
<Emphasis>DT*SEARCHPATH</Emphasis> values remain.
</Para>
<Para><Emphasis>MANPATH</Emphasis>, <Emphasis>DTMANPATH</Emphasis>:
</Para>
<Para>In addition to setting the application search paths,
<Command>dtsearchpath</Command> augments the <Emphasis>MANPATH</Emphasis> environment variable with the path to the
CDE man pages,
<Filename>/usr/dt/man.</Filename> For example, if the value of <Emphasis>MANPATH</Emphasis> prior to execution of:
<Command>dtsearchpath</Command> is
<Filename>/net/manserver/usr/man:/usr/man</Filename>
then the augmented value will be:
<Filename>/usr/dt/man:/net/manserver/usr/man:/usr/man</Filename>.
</Para>
<Para>If the <Emphasis>MANPATH</Emphasis> environment variable is not set prior to the
invocation of
<Command>dtsearchpath</Command>, the system-defined default value of <Emphasis>MANPATH</Emphasis> will be included in the
augmented <Emphasis>MANPATH</Emphasis> value.
For example, if the system-defined
default value is:
<Filename>/usr/man:/usr/local/man</Filename>
then
<Command>dtsearchpath</Command> will generate a <Emphasis>MANPATH</Emphasis> value of:
<Filename>/usr/dt/man:/usr/man:/usr/local/man</Filename>
</Para>
<Para><systemitem class="environvar">DTSROCFPATH</systemitem>:
</para>
<para><systemitem class="environvar">DTSROCFPATH</systemitem> is used
by the <function>DtSearchInit</function> function to locate the default API
configuration <filename>ocf</filename> file. If the
<symbol role="Variable">ocf_file</symbol> argument is NULL,
<function>DtSearchInit</function> looks for an <filename>ocf</filename>
file with a base name of either <filename>dtsearch.ocf</filename> or
<filename>austext.ocf</filename> in the directory specified by <systemitem class="environvar">DTSROCFPATH</systemitem>, in the current working directory,
or in the <systemitem class="environvar">HOME</systemitem> directory, in that order.
</para>
<Para><systemitem class="environvar">DTINFOLIBSEARCHPATH</systemitem>,
<systemitem class="environvar">DTINFOLIBDEFAULT</systemitem>:
</para>
<para><systemitem class="environvar">DTINFOLIBSEARCHPATH</systemitem> is used
by <command>dtinfo</command> to locate information libraries on local
and remote mounted systems. <systemitem class="environvar">DTINFOLIBDEFAULT</systemitem> is used by
<command>dtinfo</command> to identify the default information library(s)
to load if the <literal>-l</literal> or <literal>-sect</literal> option
is not specified.
</para>
<Para><systemitem class="environvar">DTINFOLIBSEARCHPATH</systemitem> and
<systemitem class="environvar">DTINFOLIBDEFAULT</systemitem>
are defined at installation time by <command>dtsearchpath</command>.
</para>
<para>The default infolib search path includes personal, system-wide, and
built-in locations as follows:
</para>
<variablelist>
<varlistentry><term>System-wide location</term>
<listitem>
<para><filename>/etc/dt/infolib/language/%I.dti</filename>
</para>
</listitem>
</varlistentry>
<varlistentry><term>Built-in location</term>
<listitem>
<para><filename>/usr/dt/appconfig/infolib/language/%I.dti</filename>
</para>
</listitem>
</varlistentry>
</variablelist>
<para>The default language is C.
</para>
<para>When a location is added to the application search path, the appropriate
infolib subdirectory is automatically added to the infolib search path.
</para>
<para>For example, if the application server <literal>hosta:</literal> is
added to the application search path, the directory
<filename>hosta:/etc/dt/appconfig/infolib/language</filename> is
automatically added to the infolib search path.
</para>
<para>The infolib search path is assembled from the built-in locations and the
following input variables:
</para>
<variablelist>
<varlistentry><term><systemitem class="environvar">DTSPSYSINFOLIB</systemitem></term>
<listitem>
<para>System-wide infolib search path input variable
</para>
</listitem>
</varlistentry>
<varlistentry><term><systemitem class="environvar">DTSPUSERINFOLIB</systemitem></term>
<listitem>
<para>Personal infolib search path input variable
</para>
</listitem>
</varlistentry>
</variablelist>
<para>Use these input variables to specify locations outside the application
search path.
</para>
<para>The assembled database search path is specified by the output variable
<systemitem class="environvar">DTINFOLIBSEARCHPATH</systemitem>.
</para>
<para>The syntax for the <systemitem class="environvar">DTSPSYSINFOLIB</systemitem> and <systemitem class="environvar">DTSPUSERINFOLIB</systemitem>
variables is:
</para>
<para><literal>VARIABLE =</literal> <emphasis>location</emphasis> <literal>[,</literal> <emphasis>location</emphasis><literal>]</literal>
</para>
<para>where <emphasis>location</emphasis> is the pathname for a directory on the
local (session server) system. Use this syntax to add a local directory.
</para>
<para>To specify a location on another system, use its network file name.
For example:
</para>
<programlisting>
/nfs/servera/projects/infolib.
</programlisting>
<para>The value of the infolib search path ( <systemitem class="environvar">DTINFOLIBSEARCHPATH</systemitem>) is created by
assembling the following locations, listed in order of precedence:
</para>
<orderedlist>
<listitem><para>Locations specified using the <systemitem class="environvar">DTSPUSERINFOLIB</systemitem> variable
</para></listitem>
<listitem><para>Locations derived from the <systemitem class="environvar">DTSPUSERAPPHOSTS</systemitem> variable
</para></listitem>
<listitem><para>The default location:
<filename>/etc/dt/appconfig/infolib/language/%I.dti</filename>
</para></listitem>
<listitem><para>Locations specified using the <systemitem class="environvar">DTSPSYSINFOLIB</systemitem> variable
</para></listitem>
<listitem><para>Locations derived from the <systemitem class="environvar">DTSPSYSAPPHOSTS</systemitem> variable
</para></listitem>
<listitem><para><filename>/usr/dt/appconfig/infolib/language/%I.dti</filename>
</para></listitem>
</orderedlist>
</RefSect1>
<RefSect1>
<Title>LOCALES</Title>
<Para>Each of the search path elements contain a path that references the
<SystemItem Class="EnvironVar">LANG</SystemItem> variable using the
<Literal>%L</Literal> construct.
When the user
selects a different language from the greeting screen and logs in, the
search path will already be set up.
At the same time, the
factory defaults are still included, but after the localized elements.
</Para>
<Para>For example, if the user chooses
the German locale
from the greeting screen, then his/her
<SystemItem Class="EnvironVar">DTDATABASESEARCHPATH</SystemItem>
will already include these elements, as specified by the <SystemItem Class="EnvironVar">LANG</SystemItem> value
set at session startup:
<Filename>$HOME/.dt/types
/etc/dt/appconfig/types/%L
/etc/dt/appconfig/types/C
/usr/dt/appconfig/types/%L
/usr/dt/appconfig/types/C</Filename>
</Para>
<Para>(See also the <Symbol>OPTIMIZATIONS</Symbol> heading in this man page.)
</Para>
<Para>Note that the search path does not use locales under the user's
<Filename>$HOME</Filename> directory.
Whether the user adds personal icons under
<Filename>$HOME/.dt/icons</Filename> or personal applications under
<Filename>$HOME/.dt/appmanager</Filename>, they will be found regardless of the language
selected at login.
</Para>
</RefSect1>
<RefSect1>
<Title>OPTIMIZATIONS</Title>
<Para>Before exporting the search paths to the user's environment,
<Command>dtsearchpath</Command> first checks to ensure that each subdirectory exists.
If a directory
does not exist at login, then that element will not be added to the
user's search path, to save needless file system accesses by the
desktop components.
</Para>
</RefSect1>
<RefSect1>
<Title>FILES</Title>
<VariableList>
<VarListEntry>
<Term><Filename>$HOME/.dtprofile</Filename></Term>
<ListItem>
<Para>Enables setting of the user's
<Emphasis>DTSPUSER</Emphasis> environment variables.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Filename>Xsession.d/*</Filename></Term>
<ListItem>
<Para>Enables setting of the system
<Emphasis>DTSPSYS</Emphasis> environment variables.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>NOTES</Title>
<Para>In order to inject the values from
<Command>dtsearchpath</Command> into the user's environment, the command must be
<Emphasis>eval'd</Emphasis>,
as is done by the
<Command>Xsession</Command>
login script.
</Para>
<Para>eval `/usr/dt/bin/dtsearchpath`
Simply running
<Command>dtsearchpath</Command> from the command line will have no affect on the parent shell.
</Para>
<Para>It is not possible to affect the DT search paths after logging in.
Components such as the Window Manager and File Manager inherit the
values from
<Command>dtsearchpath</Command> by being invoked from the same shell.
Hence, if the system
administrator creates a new search path element for the end user,
the user will not be able to access it until the next login.
</Para>
</RefSect1>
<RefSect1>
<Title>SEE ALSO</Title>
<Para>&cdeman.dtappgather;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->

130
cde/doc/C/guides/man/man1_dt/sess_res.sgm Normal file
View File

@@ -0,0 +1,130 @@
<!-- $XConsortium: sess_res.sgm /main/9 1996/09/08 19:55:58 rws $ -->
<!-- (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.MAN33.rsml.1" Remap="">
<RefMeta>
<RefEntryTitle>dtsession_res</RefEntryTitle>
<ManVolNum>user cmd</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Command>dtsession_res</Command></RefName>
<RefPurpose>CDE dtsession resource load utility
</RefPurpose>
</RefNameDiv>
<RefSynopsisDiv>
<CmdSynopsis>
<Command>dtsession_res -load</Command>
<Arg>-merge</Arg>
<Arg Choice="opt">-system</Arg>
<Arg Choice="opt">-xdefaults</Arg>
<Arg Choice="opt">-file &lt;name></Arg>
</CmdSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<note>
<para>The Common Desktop Environment (CDE) <command>dtsession_res</command>
utility is used by <command>dtsession</command> and the
<literal>ReloadResources</literal> action to load session resources. It
is not intended to be run directly from the command line.
</para>
</note>
<Para>The CDE dtsession_res utility uses
<Filename MoreInfo="RefEntry">xrdb</Filename>(1) to load the session resources into the
RESOURCE_MANAGER property of the root window of the display. The session
resources are gathered from the following files:
</Para>
<!--Start of RS / RE range-->
<Para>- /usr/dt/config/$LANG/sys.resources
</Para>
<Para>- /etc/dt/config/$LANG/sys.resources
</Para>
<Para>- $HOME/.Xdefaults
</Para>
<Para>- $HOME/.dt/&lt;session dir>/dt.resources
</Para>
<!--End of RS / RE range-->
<Para>Refer to the
&cdeman.dtsession;
man page for more information on these files and their content.
</Para>
<Para>The
<Command>dtsession_res</Command> utility provides support for display-specific resources by converting
the $DISPLAY value into a
<Filename MoreInfo="RefEntry">cpp</Filename>(1) macro that can be used in a session resource file to limit resource
definitions to a particular display. It does this by converting all
&acute;.' (dot) and ':' (colon) characters to '_', stripping off any screen
specification and finally prefixing 'DISPLAY_' to the result. For example,
a $DISPLAY of ':0' would be 'DISPLAY_0', and a $DISPLAY of 'blanco.gato.com:0.0'
would be 'DISPLAY_blanco_gato_com_0'. The resulting value can be used
as part of a
<Literal>cpp</Literal> test in a session resource file. For example:
</Para>
<programlisting>
Myapp*resource: value
#ifdef DISPLAY_blanco_gato_com_0
Myapp*resource: specialvalue1
#endif
#ifdef DISPLAY_pablo_gato_com_0
Myapp*resource: specialvalue2
#endif
</programlisting>
</RefSect1>
<RefSect1>
<Title>OPTIONS</Title>
<RefSect2>
<Title>-load</Title>
<Para>Replace the current RESOURCE_MANAGER content with the session resources.
</Para>
</RefSect2>
<RefSect2>
<Title>-merge</Title>
<Para>Merge the current RESOURCE_MANAGER content with the session resources.
</Para>
</RefSect2>
<RefSect2>
<Title>-system</Title>
<Para>Load or merge the system session resources.
</Para>
</RefSect2>
<RefSect2>
<Title>-xdefaults</Title>
<Para>Load or merge the $HOME/.Xdefault file.
</Para>
</RefSect2>
<RefSect2>
<Title>-file &lt;name></Title>
<Para>Load or merge the file specified by &lt;name>.
</Para>
</RefSect2>
</RefSect1>
<RefSect1>
<Title>EXAMPLES</Title>
<Para>The
<Command>dtsession_res</Command> utility is not intended to be run from the command line. Refer to the
<Literal>ReloadResources</Literal> action for information on how to reload session resources in a
user's session.
</Para>
<Para>dtsession_res -load -system -xdefaults \
-file $HOME/.dt/sessions/current/dt.resources
</Para>
<Para>Replaces the RESOURCE_MANAGER with the content of the following files:
</Para>
<Para>- /usr/dt/config/$LANG/sys.resources,
</Para>
<Para>- /etc/dt/config/$LANG/sys.resources,
</Para>
<Para>- $HOME/.Xdefaults and
</Para>
<Para>- $HOME/.dt/sessions/current/dt.resources files.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.3 08/21/95 21:30:04-->

1348
cde/doc/C/guides/man/man1_dt/session.sgm Normal file
View File

File diff suppressed because it is too large Load Diff

290
cde/doc/C/guides/man/man1_dt/srcreate.sgm Normal file
View File

@@ -0,0 +1,290 @@
<!-- $XConsortium: srcreate.sgm /main/9 1996/09/08 19:56:18 rws $ -->
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
<!-- (c) Copyright 1996 International Business Machines Corp. -->
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1996 Novell, Inc. -->
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
<!-- (c) Copyright 1996 Hitachi. -->
<![ %CDE.C.CDE; [<refentry id="CDE.SEARCH.dtsrcreate">]]>
<refmeta><refentrytitle>dtsrcreate</refentrytitle><manvolnum>user cmd</manvolnum>
</refmeta>
<refnamediv><refname><command>dtsrcreate</command></refname><refpurpose>Create
and initialize a DtSearch database</refpurpose></refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>dtsrcreate</command><arg choice="opt">&minus;q</arg><arg choice="opt">&minus;o</arg><arg choice="opt">&minus;fd</arg><arg choice="opt">&minus;fa</arg><arg choice="opt">&minus;a<replaceable>abstr</replaceable></arg><arg
choice="opt">&minus;d<replaceable>dir</replaceable></arg><arg choice="opt">&minus;wn<replaceable>min</replaceable></arg><arg choice="opt">&minus;wx <replaceable>max</replaceable></arg><arg choice="opt">&minus;l<replaceable>lang</replaceable></arg>
<arg choice="plain"><replaceable>dbname</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>The <command>dtsrcreate</command> command creates and initializes an
instance of a DtSearch database. A DtSearch database consists of a set of
related files. If the specified database already exists, after prompting for
confirmation, <command>dtsrcreate</command> will erase and reinitialize the
preexisting database.
</para>
<refsect2>
<title>Database Name</title>
<para>The <symbol role="Variable">dbname</symbol> argument is the database
name. It is a 1 to 8 ascii character string used at creation time as a base
file name, and as a general database identifier thereafter. All created database
files are named by assembling the base name, plus a period and a 1 to 3 ASCII
character suffix. The database names <literal>dtsearch</literal> and <literal>austext</literal> are reserved and may not be specified.</para>
</refsect2>
<refsect2>
<title>Target Directory</title>
<para>The <symbol role="Variable">dbname</symbol> argument can include an
optional path prefix. If it does, the database files will be created and initialized
in the specified target directory. If no path prefix is specified, the target
directory is the current working directory.</para>
</refsect2>
<refsect2>
<title>Model File</title>
<para>One of the created database files is based on a model file,
<filename>dtsearch.dbe</filename>, provided with DtSearch. Database creation will fail
if the model file cannot be found. <command>dtsrcreate</command> looks for
the model file first in the directory specified by a command line option,
if any; secondly in the current working directory; and thirdly in the optional <symbol role="Variable">dbname</symbol> target directory.</para>
</refsect2>
<refsect2>
<title>Configuration Options</title>
<para>DtSearch databases can be customized with a number of configuration
options that are specified only at creation time. Initialization consists
of loading into the database a configuration and status record identifying
the configuration options for the particular database instance. After initialization, <command>dtsrcreate</command> prints a small report of the current contents of the
configuration record to stdout. (See also &cdeman.dtsrdbrec;,
which prints the report without changing the database).</para>
</refsect2>
<refsect2>
<title>Database Types</title>
<para>The customizable features available at database creation time fall into
clusters of related capabilities that constitute a set of basic database types.
When you select a database type, you prespecify a number of features that
are optimized for the basic type of database you want.</para>
<para>In the <Symbol>DtSearch</Symbol> database type, documents are not
stored in a repository and are not available from the search engine after
a search. The abstract returned from a search typically contains a document
reference, usually the file name, and the application is itself responsible
for accessing the document. Hilighting of search words is possible when the
application passes the document cleartext back to the DtSearch API.</para>
<para>In an <literal>AusText</literal> database type, compressed documents
are stored directly into a repository and the originals are thereafter ignored.
The abstracts returned from searches are typically descriptive of the documents
they represent, and are displayed directly to users. Documents can be retrieved
from an <literal>AusText</literal> type database through the API, and the
search words are highlighted as desired.</para>
</refsect2>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<para>The following options are available:</para>
<note>
<para>If an option takes a value, the value must be directly appended to the
option name without white space.</para>
</note>
<variablelist>
<varlistentry><term><literal>&minus;q</literal></term>
<listitem>
<para>Suppresses printing of configuration record report.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;o</literal></term>
<listitem>
<para>Suppresses overwrite prompt; preauthorizes erasure and reinitialization
of preexisting database.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;d</literal><symbol role="Variable">dir</symbol></term>
<listitem>
<para>Specifies where to find the model <filename>dtsearch.dbe</filename>
file, rather than in the current working directory or target directory.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;fd</literal></term>
<listitem>
<para>Configure a <Symbol>DtSearch</Symbol> type database. This is the default.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;fa</literal></term>
<listitem>
<para>Configure an <literal>AusText</literal> type database.</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;a</literal><symbol role="Variable">abstr</symbol></term>
<listitem>
<para>Set the maximum abstract size to <symbol role="Variable">abstr</symbol>
bytes. This is the maximum permitted length in characters for an abstract
string. To optimize space considerations in the database the choice for abstract
length may be adjusted upward. Default size depends on the specified database
type. (See &cdeman.dtsrfzkfiles; and &cdeman.DtSearch;
for more information about abstract fields.)</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;wn</literal><symbol role="Variable">min</symbol></term>
<listitem>
<para>Change minimum word size to <symbol role="Variable">min</symbol> characters.
This is the minimum word size in characters to be indexed in the database.
Document and query words shorter than the minimum are treated as stop list
words (see &cdeman.dtsrfzkfiles;). The minimum can be overridden
for specific individual words by adding them to the optional include list
file (see &cdeman.dtsrfzkfiles;). For most natural languages the
default minimum word size is usually correct; permitting very short words
will usually cause a significant increase in the storage requirements for
the database. This option is typically applicable to single-byte European
languages and may be ignored by multibyte language processors. (See
&cdeman.DtSearch; for more information about DtSearch word sizes).</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;wx</literal><symbol role="Variable">max</symbol></term>
<listitem>
<para>Change maximum word size to <symbol role="Variable">max</symbol> characters.
This is the maximum word size in characters. Smaller is better since extraordinarily
long words in most documents do not represent words at all, but nonsemantic
symbol strings. To optimize space considerations in the database, the choice
for maximum word size will usually be adjusted upward. For most natural languages
the default maximum word size is usually correct. This option is typically
applicable to single-byte European languages and may be ignored by multibyte
language processors. (See &cdeman.DtSearch; for more information
about DtSearch word sizes).</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;l</literal><symbol role="Variable">lang</symbol></term>
<listitem>
<para>Change the language number to <symbol role="Variable">lang</symbol>.
The default is 0.</para>
<para>Supported languages include:</para>
<informaltable>
<tgroup cols="3" colsep="0" rowsep="0">
<colspec align="left" colwidth="0.51in">
<colspec align="left" colwidth="1.36in">
<colspec align="left" colwidth="4.35in">
<tbody>
<row>
<entry align="left" valign="top"><para>0</para></entry>
<entry align="left" valign="top"><para><Symbol>DtSrLaENG</Symbol></para></entry>
<entry align="left" valign="top"><para>English, ASCII character set</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>1</para></entry>
<entry align="left" valign="top"><para><symbol>DtSrLaENG2</symbol></para></entry>
<entry align="left" valign="top"><para>English, ISO Latin-1 character set
</para></entry></row>
<row>
<entry align="left" valign="top"><para>2</para></entry>
<entry align="left" valign="top"><para><Symbol>DtSrLaESP</Symbol></para></entry>
<entry align="left" valign="top"><para>Spanish, ISO Latin-1 character set
</para></entry></row>
<row>
<entry align="left" valign="top"><para>3</para></entry>
<entry align="left" valign="top"><para><Symbol>DtSrLaFRA</Symbol></para></entry>
<entry align="left" valign="top"><para>French, ISO Latin-1 character set</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>4</para></entry>
<entry align="left" valign="top"><para><Symbol>DtSrLaITA</Symbol></para></entry>
<entry align="left" valign="top"><para>Italian, ISO Latin-1 character set
</para></entry></row>
<row>
<entry align="left" valign="top"><para>5</para></entry>
<entry align="left" valign="top"><para><Symbol>DtSrLaDEU</Symbol></para></entry>
<entry align="left" valign="top"><para>German, ISO Latin-1 character set</para></entry>
</row>
<row>
<entry align="left" valign="top"><para>6</para></entry>
<entry align="left" valign="top"><para><Symbol>DtSrLaJPN</Symbol></para></entry>
<entry align="left" valign="top"><para>Japanese, packed EUC character set;
all possible kanji substrings are indexed</para></entry></row>
<row>
<entry align="left" valign="top"><para>7</para></entry>
<entry align="left" valign="top"><para><symbol>DtSrLaJPN2</symbol></para></entry>
<entry align="left" valign="top"><para>Japanese, packed EUC character set;
only individual kanjis are indexed, plus compounds from a knj language file
</para></entry></row></tbody></tgroup></informaltable>
<para>Specifying an unsupported language number will establish a DtSearch
custom language for the database. (See &cdeman.DtSearch; for
information about DtSearch languages).</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>OPERAND</title>
<para>The <symbol role="Variable">dbname</symbol> operand specifies the new
DtSearch database. It consists of an optional path prefix, a 1- to 8-character
database name, an optional period, and an optional 1- to 3-character extension.
This is the name that the other build tools and the the search API will use
to reference the database.</para>
</refsect1>
<refsect1>
<title>ENVIRONMENT VARIABLES</title>
<para>None.</para>
</refsect1>
<refsect1>
<title>RESOURCES</title>
<para>None.</para>
</refsect1>
<refsect1>
<title>ACTIONS/MESSAGES</title>
<para>None.</para>
</refsect1>
<refsect1>
<title>RETURN VALUES</title>
<para>The return values are as follows:</para>
<variablelist>
<varlistentry><term>0</term>
<listitem>
<para><command>dtsrcreate</command> completed successfully.</para>
</listitem>
</varlistentry>
<varlistentry><term>non-zero</term>
<listitem>
<para><command>dtsrcreate</command> encountered an error.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>FILES</title>
<para><command>dtsrcreate</command> reads <filename>dtsearch.dbe</filename>.
</para>
<para>It creates or reinitializes the following database files:</para>
<simplelist>
<member><symbol role="Variable">dbname</symbol>.d00</member>
<member><symbol role="Variable">dbname</symbol>.d01</member>
<member><symbol role="Variable">dbname</symbol>.d21</member>
<member><symbol role="Variable">dbname</symbol>.d22</member>
<member><symbol role="Variable">dbname</symbol>.d23</member>
<member><symbol role="Variable">dbname</symbol>.k00</member>
<member><symbol role="Variable">dbname</symbol>.k01</member>
<member><symbol role="Variable">dbname</symbol>.k21</member>
<member><symbol role="Variable">dbname</symbol>.k22</member>
<member><symbol role="Variable">dbname</symbol>.k23</member>
</simplelist>
<para>It deletes the file <symbol role="Variable">dbname</symbol>.d99.</para>
<para>Note that not all necessary database files are created by <command>dtsrcreate</command>. Some additional files are included in the DtSearch distribution,
are created by later database build programs, or may be provided by the developer.
</para>
</refsect1>
<refsect1>
<title>EXAMPLES</title>
<para>Create a standard DtSearch type database named <literal>mydb</literal>
that will index ASCII English words of standard length for that language.
</para>
<programlisting>dtsrcreate mydb</programlisting>
<para>Create an AusText type database named <literal>jpndb</literal>. It will
index Japanese words expressed in packed EUC, with automatic compounding of
all kanji substrings. When the text contains embedded ASCII, words that are
between 2 and 20 characters long will be indexed. At least 150 bytes will
be available for the abstract field.</para>
<programlisting><?Pub Caret>dtsrcreate -fa -a150 -wn2 -wx20 -l6 jpndb</programlisting>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>&cdeman.dtsrdbrec;, &cdeman.DtSrAPI;,
&cdeman.dtsrdbfiles;, &cdeman.DtSearch;</para>
</refsect1>
</refentry>

100
cde/doc/C/guides/man/man1_dt/srdbrec.sgm Normal file
View File

@@ -0,0 +1,100 @@
<!-- $XConsortium: srdbrec.sgm /main/6 1996/09/08 19:56:28 rws $ -->
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
<!-- (c) Copyright 1996 International Business Machines Corp. -->
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1996 Novell, Inc. -->
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
<!-- (c) Copyright 1996 Hitachi. -->
<![%CDE.C.CDE; [<refentry id="CDE.SEARCH.dtsrdbrec">]]>
<refmeta><refentrytitle>dtsrdbrec</refentrytitle><manvolnum>user cmd</manvolnum>
</refmeta>
<refnamediv><refname><command>dtsrdbrec</command></refname><refpurpose>
Produce DtSearch database configuration and status report
</refpurpose></refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>dtsrdbrec</command>
<arg choice="plain"><replaceable>dbname</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para><command>dtsrdbrec</command> produces a configuration and status report on
the specified DtSearch database.
</para>
<para>DtSearch databases can be customized with a number of configuration
options that are specified at creation time. The
<command>dtsrcreate</command> program loads into the database a
configuration and status record identifying the configuration options
for that particular database instance. In addition, compression
algorithm, document counts, and related data are maintained in the
status record by <command>dtsrload</command> and
<command>dtsrindex</command>.
</para>
<para><command>dtsrdbrec</command> prints to stdout a small report of the
current contents of the configuration and status record. It is identical
to the report printed by <command>dtsrcreate</command> when the database
is created, but can be produced at any time without disturbing the
database itself.
</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<para>None.
</para>
</refsect1>
<refsect1>
<title>OPERAND</title>
<para>The <Symbol Role="Variable">dbname</Symbol> argument specifies the name
of the database for which the report is to be produced. A path prefix is
optional. The database name is the 1 to 8 ASCII character string used at
creation time
</para>
</refsect1>
<refsect1>
<title>ENVIRONMENT VARIABLES</title>
<para>None.</para>
</refsect1>
<refsect1>
<title>RESOURCES</title>
<para>None.</para>
</refsect1>
<refsect1>
<title>ACTIONS/MESSAGES</title>
<para>None.</para>
</refsect1>
<refsect1>
<title>RETURN VALUES</title>
<para>None.
</para>
</refsect1>
<refsect1>
<title>FILES</title>
<para><command>dtsrdbrec</command> opens all core database files for
<Symbol Role="Variable">dbname</Symbol>.
</para>
</refsect1>
<refsect1>
<title>EXAMPLES</title>
<para>Print a status report for a database named <filename>mydb</filename> in
the current working directory.
</para>
<programlisting>
dtsrdbrec mydb
</programlisting>
<para>Print a status report for a database named <filename>mydb</filename> in
the directory <filename>/u/dtsearch</filename>.
</para>
<programlisting>
dtsrdbrec /u/dtsearch/mydb
</programlisting>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>&cdeman.dtsrcreate;,
&cdeman.dtsrdbfiles;,
&cdeman.DtSearch;
</para>
</refsect1>
</refentry>

197
cde/doc/C/guides/man/man1_dt/srhan.sgm Normal file
View File

@@ -0,0 +1,197 @@
<!-- $XConsortium: srhan.sgm /main/7 1996/09/08 19:56:38 rws $ -->
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
<!-- (c) Copyright 1996 International Business Machines Corp. -->
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1996 Novell, Inc. -->
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
<!-- (c) Copyright 1996 Hitachi. -->
<![%CDE.C.CDE; [<refentry id="CDE.SEARCH.dtsrhan">]]>
<refmeta><refentrytitle>dtsrhan</refentrytitle><manvolnum>user
cmd</manvolnum>
</refmeta>
<refnamediv><refname><command>dtsrhan</command></refname><refpurpose>Create
a DtSearch fzk file</refpurpose></refnamediv>
<refsynopsisdiv>
<cmdsynopsis> <command>dtsrhan</command> <arg
choice="opt">&minus;m</arg> <arg choice="opt">&minus;oo</arg> <arg
choice="opt">&minus;oa</arg> <arg
choice="opt">&minus;w<replaceable>screensz</replaceable></arg> <arg
choice="plain"><replaceable>hanfile</replaceable></arg> <arg
choice="plain"><replaceable>textfile</replaceable></arg> <arg
choice="opt"><replaceable>fzkfile</replaceable></arg> </cmdsynopsis>
</refsynopsisdiv>
<refsect1> <title>DESCRIPTION</title>
<para><command>dtsrhan</command> is a filter utility that creates a correctly
formatted fzk file from a file of unformatted input text documents using
a user-written profile called a han file. The han file identifies
specific data fields in the input text from which the fzk fields can be
generated.
</para>
<para><command>dtsrhan</command> makes a single
forward pass through the text file. Its profiling ability is limited to
line number, column number, and simple string pattern matching. It is
usable only for ASCII text input files and ASCII fzk output files;
nonASCII languages are not supported.
</para>
<para><command>dtsrhan</command> is a convenience utility only; its use is
optional. Canonical fzk files for input to <function>dtsrload</function>
and <function>dtsrindex</function> may be generated in any other
desirable way.
</para>
</refsect1>
<refsect1> <title>OPTIONS</title>
<para>The following options are available:</para> <note>
<para>If an
option takes a value, the value must be directly appended to the option
name without white space.</para> </note>
<variablelist>
<varlistentry><term><literal>&minus;m</literal></term>
<listitem>
<para>Switches off all messages except error messages.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;oo</literal></term>
<listitem>
<para>Overwrite preexisting fzk file. If this option and the
<literal>&minus;oa</literal> option are omitted and the output fzk file
already exists, <command>dtsrhan</command> prompts for which option to
use.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;oa</literal></term>
<listitem>
<para>Append new output to preexisting fzk file. If this option and the
<literal>&minus;oo</literal> option are omitted and the output fzk file
already exists, <command>dtsrhan</command> prompts for which option to
use.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;w</literal><symbol role="Variable">screensz</symbol></term>
<listitem>
<para>Sets the
target screen width to <symbol role="Variable">screensz</symbol>
characters. <command>dtsrhan</command> wraps long text lines at the
nearest whitespace to ensure that no text line in the fzk file is longer
than <symbol role="Variable">screensz</symbol> characters. This option
is typically used to ensure that output lines are not wider than the
anticipated end user screen width. The default value is 79.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>OPERANDS</title>
<para><command>dtsrhan</command> takes the
following operands:</para>
<variablelist>
<varlistentry><term><symbol role="Variable">hanfile</symbol></term>
<listitem>
<para>Specifies the
name of the profile han file. If the base file name does not include an
extension, <command>dtsrhan</command> assumes an extension of
<Filename>.han</Filename>. The argument may include a fully qualified path
prefix or a prefix relative to the current working directory. See
&cdeman.dtsrhanfile; for the format of a han file.
</para>
</listitem>
</varlistentry>
<varlistentry><term><symbol role="Variable">textfile</symbol></term>
<listitem>
<para>Specifies the
name of the input text file. <command>dtsrhan</command> does not assume
any extension.
</para>
<para>The input file may contain text that will
be mapped to a single database object or document, or it may contain
multiple documents separated by the end-of-record markers specified in
the han file. No assumptions are made concerning the format of the input
file other than the fact that it consists of ASCII text with line feeds
at reasonable lengths.
</para>
</listitem>
</varlistentry>
<varlistentry><term><symbol role="Variable">fzkfile</symbol></term>
<listitem>
<para>Specifies the name of the output fzk file. If this
option is omitted, <command>dtsrhan</command> constructs the fzk file
name from the name of the input file, including the path prefix if any,
with an <Filename>.fzk</Filename> suffix appended. See
&cdeman.dtsrfzkfiles; for the format of a fzk file.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>ENVIRONMENT VARIABLES</title>
<para>None.</para>
</refsect1>
<refsect1> <title>RESOURCES</title>
<para>None.</para>
</refsect1>
<refsect1> <title>ACTIONS/MESSAGES</title>
<para>None.</para>
</refsect1>
<refsect1> <title>RETURN VALUES</title>
<para>The return
values are as follows:</para>
<variablelist>
<varlistentry><term>0</term>
<listitem>
<para><command>dtsrhan</command> completed successfully.
</para>
</listitem>
</varlistentry>
<varlistentry><term>non-zero</term>
<listitem>
<para><command>dtsrhan</command> encountered an error.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>FILES</title>
<para><command>dtsrhan</command> reads the specified text file and the
specified han file, and writes to the specified fzk file.
</para>
</refsect1>
<refsect1>
<title>EXAMPLES</title>
<para>Convert the documents in the ASCII text file
<filename>docs.txt</filename> to an fzk file named
<filename>docs.fzk</filename> using the profile
<filename>myprofile.han</filename>, all in the current working
directory.
</para>
<programlisting>
dtsrhan myprofile docs.txt
</programlisting>
<para>Convert the documents in the ASCII text file <filename>myin</filename> in the
current working directory, to an fzk file named <filename>myout.fzk</filename>
in the <filename>fzkdir</filename> subdirectory of the current working directory,
using the han file located at <filename>/u/dtsearch/mypro.han3</filename>.
If <filename>myout.fzk</filename> already exists, the fzk records for the document(s)
in <filename>myin</filename> will be appended to it.
If any lines in <filename>myin</filename> have more than 132 characters, they will
be wrapped at the nearest whitespace less than 132 characters.
</para>
<programlisting>
dtsrhan -oa -w132 /u/dtsearch/mypro.han3 myin fzkdir/myout
</programlisting>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>&cdeman.dtsrload;,
&cdeman.dtsrindex;,
&cdeman.dtsrfzkfiles;,
&cdeman.dtsrhanfile;,
&cdeman.DtSearch;
</para>
</refsect1>
</refentry>

274
cde/doc/C/guides/man/man1_dt/srindex.sgm Normal file
View File

@@ -0,0 +1,274 @@
<!-- $XConsortium: srindex.sgm /main/7 1996/09/08 19:56:47 rws $ -->
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
<!-- (c) Copyright 1996 International Business Machines Corp. -->
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1996 Novell, Inc. -->
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
<!-- (c) Copyright 1996 Hitachi. -->
<![%CDE.C.CDE; [<refentry id="CDE.SEARCH.dtsrindex">]]>
<refmeta><refentrytitle>dtsrindex</refentrytitle><manvolnum>user cmd</manvolnum>
</refmeta>
<refnamediv><refname><command>dtsrindex</command></refname><refpurpose>Load
inverted index for document objects</refpurpose></refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>dtsrindex</command>
<arg choice="plain">&minus;d<replaceable>dbname</replaceable></arg>
<arg choice="opt">&minus;t<replaceable>etxstr</replaceable></arg>
<arg choice="opt"><group choice="plain"><arg choice="plain">&minus;h0</arg>
<arg choice="plain">&minus;h<replaceable>hashsz</replaceable></arg>
</group></arg>
<arg choice="opt">&minus;r<replaceable>recdots</replaceable></arg>
<arg choice="opt">&minus;b<replaceable>batchsz</replaceable></arg>
<arg choice="opt">&minus;c<replaceable>cachesz</replaceable></arg>
<arg choice="opt">&minus;i<replaceable>inbufsz</replaceable></arg>
<arg choice="plain"><replaceable>file</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para><command>dtsrindex</command> is the second of a pair of programs that
load a database with documents data from an input fzk file.
<command>dtsrload</command> loads document header information and
optionally the documents themselves. <command>dtsrindex</command> parses
words from document text and loads them into the inverted index files.
Word parsing is performed in the specified language and linguistic
codeset of the database. The inverted index contains the search terms
used for subsequent online queries.
</para>
<para>An fzk file can be generated by <command>dtsrhan</command> manually with
a text editor, or by a special application program created for the
purpose. Typically the same fzk file is used for
<command>dtsrload</command> and <command>dtsrindex</command>. However,
it is not required and there are situations where it may not be
desirable. If the same fzk file is not used by both programs, the one
used for <command>dtsrindex</command> must represent the same objects in
the same order. Only the unique key line and the text portions of the
file are used by this program. (See &cdeman.dtsrfzkfiles; for
information about DtSearch fzk files).
</para>
<para>A document's unique key in the fzk file must already preexist in the
database (that is, <command>dtsrload</command> must be executed before
<command>dtsrindex</command>). If any words are already indexed for the
unique document key, indicating <command>dtsrload</command> "updated"
the document, then the newly parsed words from the current fzk file will
totally replace the previously indexed words.
</para>
<para>When duplicate record ids are encountered in a single fzk file, only the
first occurrence of the document is indexed into the database; the
second one is discarded. Sinxe this is exactly the same discard order as
<command>dtsrload</command>, the same fzk file can be used for both
programs. Duplicate record ids are maintained during execution with a
hash table.
</para>
<para><command>dtsrindex</command> performs two passes. In the first pass,
<command>dtsrindex</command> constructs an inverted index in memory of
all the words it parses from the fzk file. Since the index is built in
memory, it is possible to run out of memory for very large fzk files.
For this reason very large fzk files are processed in batches. Execution
time in the first pass depends on the size of the fzk file.
</para>
<para>In the second pass, <command>dtsrindex</command> merges the information
in the memory index into the database's disk inverted index. Execution
time in the second pass depends on both the size of the incoming fzk
file and the overall size of the database.
</para>
<para>If <command>dtsrindex</command> is interrupted in the first pass, it
can be reexecuted without database damage. However if it is interrupted
in the second pass, the database will be corrupted. Database backups
are always recommended.
</para>
<caution>
<para>To prevent database corruption, execute <command>dtsrindex</command>
only after all users of a preexisting database have exited their search
programs. For a single fzk file, <command>dtsrload</command> must be
executed immediately before <command>dtsrindex</command> so that
<command>dtsrindex</command> can map the words it indexes to the correct
internal database addresses. Only after both programs successfully
complete execution may users again be allowed to perform online searches
of the database.
</para>
</caution>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<para>The following options are available:</para>
<note>
<para>If an option takes a value, the value must be directly appended to
the option name without white space.</para>
</note>
<variablelist>
<varlistentry><term><literal>&minus;d</literal><Symbol Role="Variable">dbname</Symbol></term>
<listitem>
<para>Specifies the 1 to 8 ASCII character name of the database to be
updated.
If an optional directory path is not prepended to the database
name, <command>dtsrindex</command> will attempt to open the database from
the current working directory. File name extensions for database
files are automatically appended.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;t</literal><Symbol Role="Variable">etxstr</Symbol></term>
<listitem>
<para>Specifies the end of document text delimiter string. The default
document separator in an fzk file is an ASCII form feed character
followed by an ASCII line feed ('\f\n'). For certain multibyte languages
it may be more convenient to specify a nonASCII string as the document
delimiter.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;h0</literal></term>
<listitem>
<para>Instructs <command>dtsrindex</command> to not check for duplicate
record ids. This option should not be specified unless it
is certain that there are no duplicate ids in the fzk file.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;h</literal><Symbol Role="Variable">hashsz</Symbol></term>
<listitem>
<para>Sets the duplicate record id hash table size to <Symbol Role="Variable">hashsz</Symbol>. The default is 3000.
<command>dtsrindex</command> will execute more efficiently if the
specified table size is larger than the number of documents in the fzk
file.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;r</literal><Symbol Role="Variable">recdots</Symbol></term>
<listitem>
<para>Instructs <command>dtsrindex</command> to print a progress character to
stdout for every <Symbol Role="Variable">recdots</Symbol> documents
processed during the first pass. The default is 20.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;b</literal><Symbol Role="Variable">batchsz</Symbol></term>
<listitem>
<para>Sets the batch size to <Symbol Role="Variable">batchsz</Symbol>. The
default is 10000. The batch size is the maximum number of records
processed in Pass 1 before copying the in memory index to disk in Pass
2. Larger batch sizes significantly improve execution time in Pass 2,
but require exponentially larger amounts of memory. The default batch
size has been optimized for moderately fast machines with large amounts
of memory.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;c</literal><Symbol Role="Variable">cachesz</Symbol></term>
<listitem>
<para>Sets the number of 1024 byte cache pages used by the DtSearch Database
Management System to <Symbol Role="Variable">cachesz</Symbol>. The
default is 64. The cache size affects memory paging performance for word
b-trees. <Symbol Role="Variable">cachesz</Symbol>should be greater than
or equal to 16, in even powers of 2. The default is usually sufficient.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;i</literal><Symbol Role="Variable">inbufsz</Symbol></term>
<listitem>
<para>Sets the size of the input line buffer to <Symbol Role="Variable">inbufsz</Symbol>. The default is 1024 bytes. This
buffer is used only for reading the four ASCII header lines for each
document in an fzk file. (The text portion of each document is parsed on
the fly a word at a time.) Increasing <Symbol Role="Variable">inbufsz</Symbol> may be appropriate for very large
abstracts, but the default is sufficient in most cases.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>OPERANDS</title>
<para>The required input file name (<Symbol Role="Variable">file</Symbol>)
identifies the file to be processed by <command>dtsrindex</command>. It
can optionally include a path prefix, either from root or relative to
the current working directory. If a file name extension is not
specified, <command>dtsrindex</command> assumes a default extension of
<Filename>.fzk</Filename>.
</para>
</refsect1>
<refsect1>
<title>ENVIRONMENT VARIABLES</title>
<para>None.</para>
</refsect1>
<refsect1>
<title>RESOURCES</title>
<para>None.</para>
</refsect1>
<refsect1>
<title>ACTIONS/MESSAGES</title>
<para>None.</para>
</refsect1>
<refsect1>
<title>RETURN VALUES</title>
<para>The return values are as follows:</para>
<variablelist>
<varlistentry><term>0</term>
<listitem>
<para><command>dtsrindex</command> completed successfully.</para>
</listitem>
</varlistentry>
<varlistentry><term>1</term>
<listitem>
<para><command>dtsrindex</command> successfully
recovered from an error. This occurs when one or more
documents were discarded because of a partially invalid
fzk file format, duplicate record ids, or empty record text.
</para>
</listitem>
</varlistentry>
<varlistentry><term>>1</term>
<listitem>
<para><command>dtsrindex</command> encountered a fatal error.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>FILES</title>
<para><command>dtsrindex</command> reads the specified fzk file and opens
all the database and related language files for the specified
database name.
</para>
<para><command>dtsrindex</command> updates the following database files:
</para>
<simplelist>
<member><symbol role="Variable">dbname</symbol>.d21</member>
<member><symbol role="Variable">dbname</symbol>.d22</member>
<member><symbol role="Variable">dbname</symbol>.d23</member>
<member><symbol role="Variable">dbname</symbol>.k21</member>
<member><symbol role="Variable">dbname</symbol>.k22</member>
<member><symbol role="Variable">dbname</symbol>.k23</member>
<member><symbol role="Variable">dbname</symbol>.d99</member>
</simplelist>
</refsect1>
<refsect1>
<title>EXAMPLES</title>
<para>Index all words in the fzk file named <filename>batch1.fzk</filename> in
the current working directory into database <filename>mydb</filename>.
</para>
<programlisting>
dtsrindex -dmydb batch1
</programlisting>
<para>Load database <filename>mydb</filename> with the documents specified in
the fzk file <filename>/u/dtsearch/jpndocs.1</filename>. Three ASCII
plus signs at the bottom of each document signals the end of document
text and the beginning of the next fzk file record.
</para>
<programlisting>
dtsrindex -dmydb -t+++ /u/dtsearch/jpndocs.1
</programlisting>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>&cdeman.dtsrload;,
&cdeman.dtsrhan;,
&cdeman.dtsrfzkfiles;,
&cdeman.DtSearch;
</para>
</refsect1>
</refentry>

191
cde/doc/C/guides/man/man1_dt/srkdump.sgm Normal file
View File

@@ -0,0 +1,191 @@
<!-- $XConsortium: srkdump.sgm /main/6 1996/09/08 19:56:56 rws $ -->
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
<!-- (c) Copyright 1996 International Business Machines Corp. -->
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1996 Novell, Inc. -->
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
<!-- (c) Copyright 1996 Hitachi. -->
<![%CDE.C.CDE; [<refentry id="CDE.SEARCH.dtsrkdump">]]>
<refmeta><refentrytitle>dtsrkdump</refentrytitle><manvolnum>user cmd</manvolnum>
</refmeta>
<refnamediv><refname><command>dtsrkdump</command></refname><refpurpose>
Produce reports about DtSearch database keys
</refpurpose></refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>dtsrkdump</command>
<group choice="plain">
<arg choice="plain">&minus;o</arg>
<arg choice="plain">&minus;w</arg>
<arg choice="plain">&minus;ow</arg>
</group>
<arg choice="opt">&minus;v</arg>
<arg choice="opt"><group choice="plain">
<arg choice="plain">&minus;t<replaceable>threshold</replaceable></arg>
<arg choice="plain">&minus;p<replaceable>percent</replaceable></arg>
</group></arg>
<arg choice="plain"><replaceable>dbname</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para><command>dtsrkdump</command> is a convenience utility that traverses the
word/stem, document, or both b-trees for the specified DtSearch database
and prints a summary report about the keys to stdout. The
<literal>&minus;v</literal> option additionally prints a detailed key by
key report. <command>dtsrkdump</command> can be used to confirm
integrity of the b-trees, and to count and report currently available
documents and keytypes.
</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<para>The following options are available:</para>
<note>
<para>If an option takes a value, the value must be directly appended to
the option name without white space.</para>
</note>
<variablelist>
<varlistentry><term><literal>&minus;o</literal></term>
<listitem>
<para>Instructs <command>dtsrkdump</command> to produce a report for unique
document keys. You must specify this argument or the <literal>&minus;w</literal>
or <literal>&minus;ow</literal> argument.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;w</literal></term>
<listitem>
<para>Instructs <command>dtsrkdump</command> to produce a report for word and
stem keys. You must specify this argument or the
<literal>&minus;o</literal> or <literal>&minus;ow</literal> argument.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;ow</literal></term>
<listitem>
<para>Instructs <command>dtsrkdump</command> to produce reports for both
unique document keys and word and stem keys. You must specify this
argument or the <literal>&minus;o</literal> or
<literal>&minus;w</literal> argument.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;v</literal></term>
<listitem>
<para>Specifies verbose mode, which generates a report item for every key in
the database. Use this option with caution when working with very large
databases.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;t</literal><Symbol Role="Variable">threshold</Symbol></term>
<listitem>
<para>Sets the frequency of occurrence threshold for reporting words to
<Symbol Role="Variable">threshold</Symbol>. <command>dtsrkdump</command>
will output only those words that occure in at least
<Symbol Role="Variable">threshold</Symbol> records. Setting the threshhold to 1
will output all words. If neither the <literal>&minus;t</literal> nor
<literal>&minus;p</literal> option is specified, the default threshold
is <literal>&minus;t100</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;t</literal><Symbol Role="Variable">percent</Symbol></term>
<listitem>
<para>Sets the frequency threshold for reporting words to a percentage of all
records. <Symbol Role="Variable">percent</Symbol> is a floating-point
number between 0 and 100, and can include the decimal point.
<command>dtsrkdump</command> will output only those words that occur
in at least <Symbol Role="Variable">percent</Symbol> of all records. If
neither the <literal>&minus;t</literal> nor <literal>&minus;p</literal>
option is specified, the default threshold is <literal>&minus;t100</literal>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>OPERAND</title>
<para>The <Symbol Role="Variable">dbname</Symbol> argument specifies the name
of the database to be traversed. A path prefix is optional. The database
name is the 1 to 8 ASCII character string used at creation time
</para>
</refsect1>
<refsect1>
<title>ENVIRONMENT VARIABLES</title>
<para>None.</para>
</refsect1>
<refsect1>
<title>RESOURCES</title>
<para>None.</para>
</refsect1>
<refsect1>
<title>ACTIONS/MESSAGES</title>
<para>None.</para>
</refsect1>
<refsect1>
<title>RETURN VALUES</title>
<para>The return values are as follows:</para>
<variablelist>
<varlistentry><term>0</term>
<listitem>
<para><command>dtsrkdump</command> completed successfully.</para>
</listitem>
</varlistentry>
<varlistentry><term>non-zero</term>
<listitem>
<para><command>dtsrkdump</command> encountered an error.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>FILES</title>
<para><command>dtsrkdump</command> opens all database files for
<Symbol Role="Variable">dbname</Symbol>.
</para>
</refsect1>
<refsect1>
<title>EXAMPLES</title>
<para>Output a summary report on the objects (documents) in the local database
named <filename>mydb</filename>. The summary report will print the
document count for each keytype in the database.
</para>
<programlisting>
dtsrkdump -o mydb
</programlisting>
<para>Output a summary report on the words and stems in the local database
named <filename>mydb</filename>. The summary report will print the count
of each index term in the database from the three word b-trees.
</para>
<programlisting>
dtsrkdump -w mydb
</programlisting>
<para>Output every document key in database <filename>jpndb</filename> in
directory <filename>/usr/dtsearch</filename>, plus a summary report of
the document count for each keytype in the database, plus every word or
stem that occurs in 20 or more documents, plus a summary report of
counts of each term for the word b-trees.
</para>
<programlisting>
dtsrkdump -ow -v -t20 /usr/dtsearch/jpndb
</programlisting>
<para>Output the same as the previous example except that the detail word and
stem will only contain terms that occur in 80.5% or more of the
database.
</para>
<programlisting>
dtsrkdump -ow -v -p80.5 /usr/dtsearch/jpndb
</programlisting>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>&cdeman.dtsrdbfiles;,
&cdeman.DtSearch;
</para>
</refsect1>
</refentry>

249
cde/doc/C/guides/man/man1_dt/srload.sgm Normal file
View File

@@ -0,0 +1,249 @@
<!-- $XConsortium: srload.sgm /main/7 1996/09/08 19:57:05 rws $ -->
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
<!-- (c) Copyright 1996 International Business Machines Corp. -->
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1996 Novell, Inc. -->
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
<!-- (c) Copyright 1996 Hitachi. -->
<![%CDE.C.CDE; [<refentry id="CDE.SEARCH.dtsrload">]]>
<refmeta><refentrytitle>dtsrload</refentrytitle><manvolnum>user cmd</manvolnum>
</refmeta>
<refnamediv><refname><command>dtsrload</command></refname><refpurpose>Load
document objects in a database</refpurpose></refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>dtsrload</command>
<arg choice="plain">&minus;d<replaceable>dbname</replaceable></arg>
<arg choice="opt">&minus;c</arg>
<arg choice="opt">&minus;t<replaceable>etxstr</replaceable></arg>
<arg choice="opt"><group choice="plain"><arg choice="plain">&minus;h0</arg>
<arg choice="plain">&minus;h<replaceable>hashsz</replaceable></arg>
</group></arg>
<arg choice="opt">&minus;e<replaceable>hufname</replaceable></arg>
<arg choice="opt">&minus;p<replaceable>dotcnt</replaceable></arg>
<arg choice="plain"><replaceable>file</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para><command>dtsrload</command> loads document header information and, in
AusText type databases, documents themselves into a DtSearch database.
The input is a file of one or more documents in a simple canonical
format (fzk file). An fzk file can be generated by
<command>dtsrhan</command> manually with a text editor, or by a special
application program created for the purpose. Typically the same fzk file
is used for <command>dtsrload</command> and
<command>dtsrindex</command>, but it is not required and there are
situations where it may not be desirable. (See
&cdeman.dtsrfzkfiles; for information about DtSearch fzk files).
</para>
<para><command>dtsrload</command> also maintains the current total document
count in the database's configuration and status record.
</para>
<para>If a document's unique key in the fzk file does not preexist in the
database, <command>dtsrload</command> considers the document to be new
and does not add it as a new document. If the document's key already
exists in the database, <command>dtsrload</command> totally replaces its
record with the one in the fzk file. When duplicate record ids are
encountered in a single fzk file, only the first occurrence of the
document is loaded into the database, the second one is discarded.
Duplicate record ids are maintained during execution with a hash table.
</para>
<para><command>dtsrload</command> also performs a data compression function for
documents that are actually stored in a database repository (that is,
AusText type databases). In order to do this an encode
compression huf file must be available.
(See &cdeman.huffcode; for information about DtSearch document compression.)
</para>
<para><command>dtsrload</command> also performs a data compression function for
documents that are actually stored in a database repository (that is,
AusText type databases). In order to do this an encode
compression huf file must be available.
(See &cdeman.huffcode; for information about DtSearch document compression.)
</para>
<para><command>dtsrload</command> does not index the words used to access the
database. This is done by <command>dtsrindex</command>. To prevent
database link corruption, execute <command>dtsrindex</command>
immediately after <command>dtsrload</command>.
</para>
<caution>
<para>To prevent database corruption, execute <command>dtsrload</command> only
after all users of a preexisting database have exited their search
programs to prevent database corruption. For a single fzk file,
<command>dtsrload</command> must be executed immediately before
<command>dtsrindex</command> so that <command>dtsrindex</command> can
map the words it indexes to the correct internal database addresses.
Only after both programs successfully complete execution may users again
be allowed to perform online searches of the database.
</para>
</caution>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<para>The following options are available:</para>
<note>
<para>If an option takes a value, the value must be directly appended to
the option name without white space.</para>
</note>
<variablelist>
<varlistentry><term><literal>&minus;d</literal><Symbol Role="Variable">dbname</Symbol></term>
<listitem>
<para>Specifies the 1 to 8 ASCII character name of the database to be
updated.
If an optional directory path is not prepended to the database
name, <command>dtsrload</command> will attempt to open the database from
the current working directory. File name extensions for database
files are automatically appended.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;c</literal></term>
<listitem>
<para>Instructs <command>dtsrload</command> to initialize the database total
document count by counting existing records before loading the current
batch. This option is usually not required.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;t</literal><Symbol Role="Variable">etxstr</Symbol></term>
<listitem>
<para>Specifies the end of document text delimiter string. The default
document separator in an fzk file is an ASCII form feed character
followed by an ASCII line feed ('\f\n'). For certain multibyte languages
it may be more convenient to specify a nonASCII string as the document
delimiter.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;h0</literal></term>
<listitem>
<para>Instructs <command>dtsrload</command> to not check for duplicate
record ids. This option should not be specified unless it
is certain that there are no duplicate ids in the fzk file.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;h</literal><Symbol Role="Variable">hashsz</Symbol></term>
<listitem>
<para>Sets the duplicate record id hash table size to
<Symbol Role="Variable">hashsz</Symbol>. The default is 3000.
<command>dtsrload</command> will execute more efficiently if the
specified table size is larger than the number of documents in the fzk
file.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;e</literal><Symbol Role="Variable">hufname</Symbol></term>
<listitem>
<para>Sets the compression encode file name to
<Symbol Role="Variable">hufname</Symbol>. The default is
<filename>ophuf.huf</filename>. The file name can include a path prefix.
This option is ignored unless the database type is AusText.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>&minus;p</literal><Symbol Role="Variable">dotcount</Symbol></term>
<listitem>
<para>Instructs <command>dtsrload</command> to print a progress character to
stdout for every <Symbol Role="Variable">dotcount</Symbol> documents
processed. The default is 20.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>OPERANDS</title>
<para>The required input file name (<Symbol Role="Variable">file</Symbol>)
identifies the file to be processed by <command>dtsrload</command>. It
can optionally include a path prefix, either from root or relative to
the current working directory. If a file name extension is not
specified, <command>dtsrload</command> assumes a default extension of
<Filename>.fzk</Filename>.
</para>
</refsect1>
<refsect1>
<title>ENVIRONMENT VARIABLES</title>
<para>None.</para>
</refsect1>
<refsect1>
<title>RESOURCES</title>
<para>None.</para>
</refsect1>
<refsect1>
<title>ACTIONS/MESSAGES</title>
<para>None.</para>
</refsect1>
<refsect1>
<title>RETURN VALUES</title>
<para>The return values are as follows:</para>
<variablelist>
<varlistentry><term>0</term>
<listitem>
<para><command>dtsrload</command> completed successfully.</para>
</listitem>
</varlistentry>
<varlistentry><term>1</term>
<listitem>
<para><command>dtsrload</command> successfully
recovered from an error. This occurs when one or more
documents were discarded because of a partially invalid
fzk file format, duplicate record ids, or empty record text.
</para>
</listitem>
</varlistentry>
<varlistentry><term>>1</term>
<listitem>
<para><command>dtsrload</command> encountered a fatal error.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>FILES</title>
<para><command>dtsrload</command> reads the specified fzk file and opens
all the database and related language files for the specified
database name.
</para>
<para>For AusText type databases, it also reads the compression encode file
<filename>ophuf.huf</filename>.
</para>
<para><command>dtsrload</command> updates the following database files:
</para>
<simplelist>
<member><symbol role="Variable">dbname</symbol>.d00</member>
<member><symbol role="Variable">dbname</symbol>.d01</member>
<member><symbol role="Variable">dbname</symbol>.k00</member>
<member><symbol role="Variable">dbname</symbol>.k01</member>
</simplelist>
</refsect1>
<refsect1>
<title>EXAMPLES</title>
<para>Load database <filename>mydb</filename> with the documents specified in
the fzk file named <filename>batch1.fzk</filename> in the current
working directory.
</para>
<programlisting>
dtsrload -dmydb batch1
</programlisting>
<para>Load database <filename>mydb</filename> with the documents specified in
the fzk file <filename>/u/dtsearch/jpndocs.1</filename>. Three ASCII
plus signs at the bottom of each document signals the end of document
text and the beginning of the next fzk file record.
</para>
<programlisting>
dtsrload -dmydb -t+++ /u/dtsearch/jpndocs.1
</programlisting>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>&cdeman.dtsrhan;,
&cdeman.dtsrindex;,
&cdeman.huffcode;,
&cdeman.dtsrfzkfiles;,
&cdeman.DtSearch;
</para>
</refsect1>
</refentry>

1080
cde/doc/C/guides/man/man1_dt/style.sgm Normal file
View File

File diff suppressed because it is too large Load Diff

1492
cde/doc/C/guides/man/man1_dt/term.sgm Normal file
View File

File diff suppressed because it is too large Load Diff

119
cde/doc/C/guides/man/man1_dt/types.sgm Normal file
View File

@@ -0,0 +1,119 @@
<!-- $XConsortium: types.sgm /main/8 1996/10/30 16:35:10 rws $ -->
<!-- (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.MAN35.rsml.1">
<RefMeta>
<RefEntryTitle>dttypes</RefEntryTitle>
<ManVolNum>user cmd</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Command>dttypes</Command></RefName>
<RefPurpose>Generates a list of the DT Action and DataTypes definitions.
</RefPurpose>
</RefNameDiv>
<!-- ** (c) Copyright 1993, 1994 Hewlett-Packard Company-->
<!-- ** (c) Copyright 1993, 1994 International Business Machines Corp.-->
<!-- ** (c) Copyright 1993, 1994 Sun Microsystems, Inc.-->
<!-- ** (c) Copyright 1993, 1994 Novell, Inc.-->
<!-- **-->
<RefSynopsisDiv>
<CmdSynopsis>
<Command>dttypes</Command>
<Arg Choice="opt">-help</Arg>
<Arg>dttypes</Arg>
<Arg Choice="opt">-type filename</Arg>
<Arg>dttypes</Arg>
<Arg Choice="opt">-db database</Arg>
<Group>
<Arg>-w</Arg>
<Arg Choice="opt">rec_name regexp</Arg>
<Arg Choice="opt">fld_name regexp</Arg>
<Arg Choice="opt">fld_value regexp</Arg>
</Group>
<Group>
<Arg>-l</Arg>
<Arg Choice="opt">rec_name</Arg>
<Arg Choice="opt">rec_info</Arg>
<Arg Choice="opt">fld_name regexp</Arg>
<Arg Choice="opt">fld_value</Arg>
</Group>
</CmdSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>Dttypes is a client that lists the Action and DataTypes definitions. This is
useful in understanding where DT is getting the information for its
databases and how it is using that information to construct the databases.
By default it prints out the entire set of databases.
</Para>
</RefSect1>
<RefSect1>
<Title>OPTIONS</Title>
<Para>The optional command_list is composed of one or more of the following:
</Para>
<variablelist>
<varlistentry><term>-help</term>
<listitem><para>prints out the usage message.
</para></listitem></varlistentry>
<varlistentry><term>-type filename</term>
<listitem><para>where filename is the name of a file to be typed.
</Para></listitem></varlistentry>
<varlistentry><term>-db database</term>
<listitem><para>where database uses all the DataBases whose name matches the regular expression database. Currently: DATA_CRITERIA, DATA_ATTRIBUTES or ACTION.
</para></listitem></varlistentry>
<varlistentry><term>-w search_list</term>
<listitem><para>where search_list consists of one or more of the following:
<orderedlist>
<listitem><para>rec_name reg_exp - finds all records whose name matches the regular expression reg_exp.</para></listitem>
<listitem><para>fld_name reg_exp - finds all records whose field name matches the regular expression reg_exp.</para></listitem>
<listitem><para>fld_value reg_exp - finds all records whose field values matches the regular expression reg_exp.</para></listitem>
</orderedlist>
</para></listitem></varlistentry>
<varlistentry><term>-l display_list</term>
<listitem><para>where display_list consist of one or more of the following:
<orderedlist>
<listitem><para>rec_name - displays the name of the records found.</para></listitem>
<listitem><para>rec_info - displays the file the record was found in.</para></listitem>
<listitem><para>fld_name [reg_exp] - displays the names of the attributes found in that record.</para>
<para>If a reg_exp is specified then only those fields that match will be displayed.</para></listitem>
<listitem><para>fld_value - displays the values of the attributes found in the record.</para></listitem>
</orderedlist>
</para></listitem></varlistentry>
</variablelist>
</RefSect1>
<RefSect1>
<Title>SEE</Title>
<Para>&cdeman.DtDtsLoadDataTypes;,
&cdeman.DtDtsDataToDataType;,
&cdeman.DtDtsFileToDataType;,
&cdeman.DtDtsFileToAttributeList;,
&cdeman.DtDtsFileToAttributeValue;,
&cdeman.DtDtsBufferToDataType;,
&cdeman.DtDtsBufferToAttributeList;,
&cdeman.DtDtsBufferToAttributeValue;,
&cdeman.DtDtsDataTypeToAttributeList;,
&cdeman.DtDtsDataTypeToAttributeValue;,
&cdeman.DtDtsFreeDataType;,
&cdeman.DtDtsFreeAttributeList;,
&cdeman.DtDtsFreeAttributeValue;,
&cdeman.DtDtsRelease;,
&cdeman.DtDtsDataTypeNames;,
&cdeman.DtDtsFindAttribute;,
&cdeman.DtDtsFreeDataTypeNames;,
&cdeman.DtDtsSetDataType;,
&cdeman.DtDtsDataTypeIsAction;,
&cdeman.DtActionLabel;,
&cdeman.DtActionDescription;,
&cdeman.DtActionExists;,
&cdeman.DtActionInvoke;,
&cdeman.dtaction;
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->

201
cde/doc/C/guides/man/man1_dt/udcexch.sgm Normal file
View File

@@ -0,0 +1,201 @@
<!-- $XConsortium: udcexch.sgm /main/8 1996/09/08 19:57:46 rws $ -->
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
<!-- (c) Copyright 1996 International Business Machines Corp. -->
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1996 Novell, Inc. -->
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
<!-- (c) Copyright 1996 Hitachi. -->
<![ %CDE.C.CDE; [<refentry id="cde.UDC.dtudcexch">]]>
<refmeta><refentrytitle>dtudcexch</refentrytitle><manvolnum>user cmd</manvolnum>
</refmeta>
<refnamediv><refname><command>dtudcexch</command>
</refname>
<refpurpose>UDC data exchange utility
</refpurpose></refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>dtudcexch</command>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>The <command>dtudcexch</command> utility is a tool for exchanging User
Defined Character (UDC) glyph images between systems. It runs only in
GUI mode.
</para>
<para><command>dtudcexch</command> provides the system administrator with a
mechanism for distributing UDC glyph images among different systems.
Specifically, it allows UDC glyph images to be created on one system
using the UDC Font Editor (<command>dtudcfonted</command>) and then
propagated to other systems. <command>dtudcexch</command> stores the UDC
glyph images in a BDF (Bitmap Distribution Format) file, which is
transported to a target system. On the taregt system,
<command>dtudcexch</command> is run again, this time to extract the
images from the BDF file and add them to the appropriate font file.
</para>
<para><command>dtudcexch</command> provides both an export and an import
function. The export function reads the selected UDC
glyph images from a font file and stores them in a BDF file for transfer
to other systems. The import function reads all UDC glyph images in a
BDF file and adds them to a specified font file.
</para>
<para><command>dtudcexch</command> searches font files in the directories
that are specified on the X server&rsquo;s font path or in the <systemitem class="environvar">DTUDCFONTPATH</systemitem> environment variable. It accepts
only UDC fonts that are available in the current locale and that are defined
in the X NLS database.
</para>
<para>When exporting, <command>dtudcexch</command> uses glyph indexes of the
UDC code area in the PCF/SNF font file to select the UDC glyph images. It
stores the converted images in the BDF-format file at the same glyph indexes.
When importing, <command>dtudcexch</command> adds the UDC glyph images to
the PCF/SNF font file at the same glyph indexes found in the BDF file. The
UDC code area information is defined in the X NLS database.
</para>
<para>To create different glyph indexes for the images on the target system,
you can edit the BDF file before you invoke the import function.
</para>
<refsect2>
<title>Starting the Exchange Utility</title>
<para>Start the Exchange Utility by entering the <command>dtudcexch</command>
command. The <literal>Starting</literal> window appears.
</para>
</refsect2>
<refsect2>
<title>Exporting UDCs</title>
<para>To export UDCs:
</para>
<orderedlist>
<listitem>
<para>Select the <literal>export function</literal> button on the
<literal>Starting</literal> window. The <literal>Font
Selection</literal> window appears. (This window is the same as the
<literal>Font Selection</literal> window in the Font Editor. For a
description of the available operations on this window, see
&cdeman.dtudcfonted;.)
</para>
</listitem>
<listitem>
<para>Select a font on the <literal>Font Selection</literal> window and click
<literal>Open</literal>. The <literal>UDC Glyph Indexes
Selection</literal> window appears. This window lists all the glyph
indexes for all the UDC glyph images contained in the selected font.
</para>
</listitem>
<listitem>
<para>Select one or more glyph indexes on the window. (To select multiple
glyph indexes, use the <literal>Ctrl</literal> or
<literal>Shift</literal> key as usual.) Then click
<Literal>OK</Literal>. The <literal>BDF File Selection</literal> window
appears.
</para>
</listitem>
<listitem>
<para>Specify a file name on the <literal>BDF File Selection</literal> window
and click <Literal>OK</Literal>. <command>dtudcexch</command> creates
the file and stores the glyph images of the selected glyph indexes in
the file in BDF format. <command>dtudcexch</command> then terminates.
</para>
</listitem>
</orderedlist>
</refsect2>
<refsect2>
<title>Importing UDCs</title>
<para>To import UDCs:
</para>
<orderedlist>
<listitem>
<para>Select the <literal>import function</literal> button on the
<literal>Starting</literal> window. The <literal>BDF File
Selection</literal> window appears.
</para>
</listitem>
<listitem>
<para>Specify the name of the BDF file that contains the UDC glyph images to
be imported and click <Literal>OK</Literal>. The <literal>Font
Selection</literal> window appears.
</para>
</listitem>
<listitem>
<para>Select an XLFD (X Logical Font Description) font file and click
<literal>Open</literal>. <command>dtudcexch</command> adds all glyph
imagees in the BDF file to the selected font.
<command>dtudcexch</command> then terminates.
</para>
</listitem>
</orderedlist>
</refsect2>
</refsect1>
<refsect1>
<title>EXIT STATUS</title>
<variablelist remap="tight">
<varlistentry><term>0</term>
<listitem>
<para><command>dtudcexch</command> terminated successfully.</para>
</listitem>
</varlistentry>
<varlistentry><term>>1</term>
<listitem>
<para>An error occurred.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>ENVIRONMENT VARIABLES</title>
<para><command>dtudcexch</command> references the <systemitem class="environvar">DTUDCFONTPATH</systemitem> variable, which is a colon-separated list of directories
to search when looking for UDC font files.
</para>
</refsect1>
<refsect1>
<title>RESOURCES</title>
<para>None.</para>
</refsect1>
<refsect1>
<title>ACTIONS/MESSAGES</title>
<para>None.</para>
</refsect1>
<refsect1>
<title>ERRORS/WARNINGS</title>
<variablelist>
<varlistentry><term>Failed to open the selected font. You have no right to
access the font file, or the format of the file is not consistent.</term>
<listitem>
<para>An error occurred when attempting to open the PCF/SNF font file.</para>
</listitem>
</varlistentry>
<varlistentry><term>Failed to open <emphasis>BDF-font-file</emphasis>. ou
have no right to access the file, or the format of the file is not consistent.</term>
<listitem>
<para>An error occurred when attempting to open the BDF font file.</para>
</listitem>
</varlistentry>
<varlistentry><term>Glyph images in this BDF file can't be added to
the font.</term>
<listitem>
<para>An error occurred when attempting to save the PCF/SNF font file.</para>
</listitem>
</varlistentry>
<varlistentry><term>There are one or more glyph images being overwritten.
Overwrite?</term>
<listitem>
<para>One or more glyph images in the PCF/SNF font file will be replaced
by glyph images from the BDF file.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>FILES</title>
<para>None.</para>
</refsect1>
<refsect1>
<title>EXAMPLES</title>
<para>None.</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>&cdeman.dtudcfonted;
</para>
</refsect1>
</refentry>

563
cde/doc/C/guides/man/man1_dt/udcfonte.sgm Normal file
View File

@@ -0,0 +1,563 @@
<!-- $XConsortium: udcfonte.sgm /main/8 1996/09/08 19:57:56 rws $ -->
<!-- (c) Copyright 1996 Digital Equipment Corporation. -->
<!-- (c) Copyright 1996 Hewlett-Packard Company. -->
<!-- (c) Copyright 1996 International Business Machines Corp. -->
<!-- (c) Copyright 1996 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1996 Novell, Inc. -->
<!-- (c) Copyright 1996 FUJITSU LIMITED. -->
<!-- (c) Copyright 1996 Hitachi. -->
<![ %CDE.C.CDE; [<refentry id="cde.UDC.dtudcfonted">]]>
<refmeta><refentrytitle>dtudcfonted</refentrytitle>
<manvolnum>user cmd</manvolnum>
</refmeta>
<refnamediv><refname><command>dtudcfonted</command></refname>
<refpurpose>Edit user-defined characters
</refpurpose></refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>dtudcfonted</command>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>The <command>dtudcfonted</command> utility is a tool for editing user-defined
characters (UDCs). It runs only in GUI mode.
</para>
<para>The procedure for editing user-defined characters is:
</para>
<orderedlist>
<listitem>
<para>Start the font editor to display the <literal>Font Selection</literal> window.
</para>
</listitem>
<listitem>
<para>Select the code set, style, and character size of the font to be edited.
The <literal>Font Selection</literal> window lists the fonts satisfying
these specifications. After specifying a font, select the
<literal>Open</literal> button to display the
<literal>Character Edit</literal> window.
</para>
</listitem>
<listitem>
<para>Edit a character pattern in the <literal>Character Edit</literal>
window. You can register the code for the character to be edited, and
you can delete unnecessary characters.
</para>
</listitem>
<listitem>
<para>After editing the character pattern, select <literal>Save</literal> from
the <literal>Font</literal> menu to register the edited character pattern
with the user-defined character file.
</para>
</listitem>
<listitem>
<para>Edit another font by selecting <literal>Open</literal>
from the <literal>Font</literal> menu. The
<literal>Font Selection</literal> window is displayed.
Repeat steps 2 through 5.
</para>
</listitem>
</orderedlist>
<refsect2>
<title>Starting the Font Editor</title>
<para>Start the font editor by entering the
<command>dtudcfonted</command> command. The <literal>Font Selection</literal>
window appears.
</para>
</refsect2>
<refsect2>
<title>Selecting the Font</title>
<para>The <literal>Font Selection</literal> window is displayed immediately
after the utility is started, or by choosing <literal>Open</literal>
from the <literal>Font</literal> menu on the <literal>Character Edit</literal> window. The
code sets for the editable font files are listed in <literal>Codeset Selection</literal>.
</para>
<para>To list the applicable fonts (files), select the code set, style, and
definition character size of the desired font in the selection item field.
Specifying one font and then selecting the <literal>Open</literal> button
displays the <literal>Character Edit</literal> window. Selecting the
<literal>Cancel</literal> button closes the <literal>Font
Selection</literal> window and terminates the UDC font editor.
</para>
</refsect2>
<refsect2>
<title>Editing Characters</title>
<para>Character patterns are edited on the <literal>Character Edit</literal>
window. The <literal>Character Edit</literal> window contains:
</para>
<itemizedlist>
<listitem>
<para>A list of the characters being edited
</para>
</listitem>
<listitem>
<para>The editing pane, with each square corresponding to one dot
</para>
</listitem>
<listitem>
<para>Drawing tools
</para>
</listitem>
<listitem>
<para>The currently displayed character pattern in the exact size and its code
</para>
</listitem>
</itemizedlist>
<para>Select the code for the character to be edited from the
character list. This displays the associated character pattern
in the edit pane. If the character pattern has not been created in
the UDC area, nothing is displayed.
</para>
<para>If the character code is not registered, add the code on the
<literal>Character Control</literal> window, or copy the pattern on the
<literal>Character Copy</literal> window. For details on how to add
character codes, see "Adding and Deleting Character Codes". For details
on how to copy character patterns, see "Copying Character Patterns".
</para>
<para>Characters are edited on the edit pane using the following operations:
</para>
<variablelist>
<varlistentry><term>Marking Dots</term>
<listitem>
<para>To mark one dot at the cursor position:
</para>
<orderedlist>
<listitem>
<para>Choose <literal>Pencil</literal> at the top of the drawing tools.
</para>
</listitem>
<listitem>
<para>Move the cursor to the appropriate position.
</para>
</listitem>
<listitem>
<para>Click the left mouse button.
</para>
</listitem>
</orderedlist>
</listitem>
</varlistentry>
<varlistentry><term>Drawing Straight Lines</term>
<listitem>
<para>To draw a straight line (one dot wide):
</para>
<orderedlist>
<listitem>
<para>Choose <literal>Straight line</literal> from the drawing tools.
</para>
</listitem>
<listitem>
<para>Move the cursor to the line start position, and then press the left mouse button.
</para>
</listitem>
<listitem>
<para>While holding down the left mouse button, move the cursor to the line
end position. Then release the left button.
</para>
</listitem>
</orderedlist>
<para>To cancel the line after starting, move the cursor outside the edit
pane, then release the left button.
</para>
</listitem>
</varlistentry>
<varlistentry><term>Drawing Rectangles</term>
<listitem>
<para>To draw a rectangle (one dot wide):
</para>
<orderedlist>
<listitem>
<para>Choose <literal>Rectangle</literal> from the drawing tools.
</para>
</listitem>
<listitem>
<para>Move the cursor to one corner of the rectangle, then press the left
mouse button.
</para>
</listitem>
<listitem>
<para>While holding down the left mouse button, move the cursor to the
diagonally opposite corner. Then release the left button.
</para>
</listitem>
</orderedlist>
<para>To cancel the rectangle after specifying one corner, move the cursor
outside the edit pane, then release the left button.
</para>
</listitem>
</varlistentry>
<varlistentry><term>Drawing Circles</term>
<listitem>
<para>To draw a circle (one dot wide):
</para>
<orderedlist>
<listitem>
<para>Choose <literal>Circle</literal> from the drawing tools.
</para>
</listitem>
<listitem>
<para>Move the cursor to the center of the circle, then press the left mouse
button.
</para>
</listitem>
<listitem>
<para>While holding down the left mouse button, move the cursor to a point on
the circumference of the circle. Then release the left button.
</para>
</listitem>
</orderedlist>
<para>To cancel the circle after selecting the center point, move the cursor
outside the edit pane, then release the left button.
</para>
</listitem>
</varlistentry>
<varlistentry><term>Selecting an Area for Editing</term>
<listitem>
<para>To select a rectangular area for editing:
</para>
<orderedlist>
<listitem>
<para>Choose <literal>Select</literal> from the drawing tools.
</para>
</listitem>
<listitem>
<para>Move the cursor to one corner of the rectangle, then press the left
mouse button.
</para>
</listitem>
<listitem>
<para>While holding down the left mouse button, move the cursor to the
diagonally opposite corner. Then release the left button.
To cancel the rectangular area after specifying one corner, move the cursor
outside the edit pane, then release the left button.
</para>
</listitem>
<listitem>
<para>Choose the desired function from the <literal>Edit</literal> menu.
</para>
</listitem>
</orderedlist>
</listitem>
</varlistentry>
<varlistentry><term>Clearing an Area</term>
<listitem>
<para>To clear all the dots within a selected area, choose
<literal>Clear</literal> from the <literal>Edit</literal> menu.
</para>
</listitem>
</varlistentry>
<varlistentry><term>Setting an Area</term>
<listitem>
<para>To set all the dots within a selected area,
choose <literal>Set</literal> from the <literal>Edit</literal> menu.
</para>
</listitem>
</varlistentry>
<varlistentry><term>Reversing Video in an Area</term>
<listitem>
<para>To reverse the video (change black dots to white and vice cersa) within
a selected area, choose <literal>Reverse video</literal> from the
<literal>Edit</literal> menu.
</para>
</listitem>
</varlistentry>
<varlistentry><term>Copying an Area</term>
<listitem>
<para>To copy a selected area:
</para>
<orderedlist>
<listitem>
<para>Choose <literal>Copy</literal> from the <literal>Edit</literal> menu.
</para>
</listitem>
<listitem>
<para>Choose <literal>Paste</literal> from the <literal>Edit</literal> menu.
</para>
</listitem>
<listitem>
<para>Move the cursor to the copy destination within the edit pane.
The frame of the selected area moves with the cursor.
</para>
</listitem>
<listitem>
<para>Click the left mouse button.
</para>
</listitem>
</orderedlist>
</listitem>
</varlistentry>
<varlistentry><term>Moving an Area</term>
<listitem>
<para>To move a selected area:
</para>
<orderedlist>
<listitem>
<para>Choose <literal>Cut</literal> from the <literal>Edit</literal> menu.
</para>
</listitem>
<listitem>
<para>Choose <literal>Paste</literal> from the <literal>Edit</literal> menu.
</para>
</listitem>
<listitem>
<para>Move the cursor to the copy destination within the edit pane.
The frame of the selected area moves with the cursor.
</para>
</listitem>
<listitem>
<para>Click the left mouse button.
</para>
</listitem>
</orderedlist>
</listitem>
</varlistentry>
<varlistentry><term>Rotating an Area</term>
<listitem>
<para>To rotate the contents of a selected area 90 degrees clockwise,
choose <literal>Rotate</literal> from the <literal>Edit</literal> menu.
</para>
</listitem>
</varlistentry>
<varlistentry><term>Flipping an Area</term>
<listitem>
<para>To flip the contents of a selected area vertically,
choose <literal>Flip vertically</literal> from the <literal>Edit</literal> menu.
</para>
<para>To flip the contents of a selected area horizontally,
choose <literal>Flip horizontally</literal> from the <literal>Edit</literal> menu.
</para>
</listitem>
</varlistentry>
<varlistentry><term>Inverting Dots</term>
<listitem>
<para>To invert (change from black to white and vice versa) the dot at the
current cursor location, click the middle mouse button.
</para>
</listitem>
</varlistentry>
<varlistentry><term>Canceling Edits</term>
<listitem>
<para>To cancel the results of the most recent edit operation,
choose <literal>Cancel</literal> from the <literal>Edit</literal> menu.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2>
<title>Adding and Deleting Character Codes</title>
<para>Character codes are added and deleted on the <literal>Character
Control</literal> window. To display this window,
choose <literal>Add/Delete</literal> from the <literal>Character</literal> menu.
</para>
<refsect3>
<title>Adding Character Codes</title>
<para>To add a character code, specify its four hexadecimal digits within the
user-defined character area. To add a range of characters, specify the
four hexadecimal digits for the last character code in the range in the
right input field. After specifying a single character code or a range,
select the <literal>Add</literal> button.
</para>
<para>The character code is added to a list of the characters being edited on
the <literal>Character Edit</literal> window. The character to be edited
is the first character of the added character code (or the added
character code field). If already registered, the character pattern for
the specified character code is not changed.
</para>
</refsect3>
<refsect3>
<title>Deleting Character Codes</title>
<para>To delete a character code, specify its four hexadecimal digits within
the user-defined character area. To delete a range of characters,
specify the four hexadecimal digits for the last character code in the
range in the right input field. After specifying a single character code
or a range, select the <literal>Delete</literal> button. The
<literal>Character Deletion Confirmation</literal> window appears.
Choose <Literal>OK</Literal> to delete the character. Choose
<literal>Cancel</literal> to cancel the deletion.
</para>
<para>Deleting a character code removes it from the list of characters being
edited on the <literal>Character Edit</literal> window. The character
code following the deleted character code becomes the current editable
character code. Note that a deleted character code is not actually
removed from the user-defined character file until you choose
<literal>Save</literal> on the <literal>Font</literal> menu.
</para>
</refsect3>
</refsect2>
<refsect2>
<title>Entering Character Codes Graphically</title>
<para>To enter a character code graphically, choose the
<literal>Code</literal> button on the <literal>Character
Control</literal> window. The <literal>Character Code Input</literal>
window appears. On this window, click on the desired character, then
press the <literal>Apply</literal> button to insert the code for the
selected character in the code input field of the <literal>Character
Control</literal> window.
</para>
</refsect2>
<refsect2>
<title>Copying Character Patterns</title>
<para>You can copy character patterns already registered or created using the
<literal>Character Copy window</literal>. To access this window, choose
<literal>Copy</literal> from the <literal>Character</literal> menu.
Copying adds the character code specified for the copy destination to
the list of the character list on the Editing window.
</para>
<para>To copy a character pattern:
</para>
<orderedlist>
<listitem>
<para>Select the size of the character to be copied from the character size
selection field, then enter the four-hexadecimal-digit code for the
character in the copy code field. To copy a range of character patterns
in a single operation, enter the code for the last character in the
range in the right input field.
</para>
</listitem>
<listitem>
<para>Specify the four-hexadecimal-digit code for the copy destination.
Multiple character patterns are copied in a single
operation in ascending order of codes starting at the specified copy
destination code. A code in the user-defined character area can be
specified.
</para>
</listitem>
<listitem>
<para>Select the <literal>Copy</literal> button. If the destination area
already contains the copied character pattern, the
<literal>Confirmation</literal> window appears. To replace the existing
pattern with the copy, select <literal>Close</literal>. To cancel the
copy, select <literal>Cancel</literal>.
</para>
<para>Note that if the size of the copy source character differs from that of the copy
destination character, the pattern is automatically enlarged or reduced
for copying.
</para>
</listitem>
</orderedlist>
<para>You can also perform a composite copy, which ORs the dots in the source
character pattern with the dots in the destination character pattern. To
copy a composite pattern, specify the copy source and the copy
destination, then choose the <literal>Copy Compositions</literal> button.
</para>
</refsect2>
<refsect2>
<title>Getting Information</title>
<para>The <literal>Information</literal> menu provides explanations of the
following items:
</para>
<variablelist>
<varlistentry><term>XLFD name</term>
<listitem>
<para>Displays the <literal>XLFD name</literal> window,
which lists the file name and XLFD name of the font
being edited.
</para>
</listitem>
</varlistentry>
<varlistentry><term>Code area</term>
<listitem>
<para>Displays the <literal>Code area</literal> window, which provides
information about the code area.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2>
<title>Saving Editing Results</title>
<para>To save your edits on a character pattern, you must save the
pattern in the user-defined character file. Choose <literal>Save</literal>
from the <literal>Font</literal>.
</para>
</refsect2>
<refsect2>
<title>Exiting the Font Editor</title>
<para>To exit from the Font Editor, choose <literal>Exit</literal> from the
<literal>Font</literal> menu or <literal>Close</literal> from the window
menu. If you have not saved the edited pattern, the <literal>Termination
Confirmation</literal> window appears and asks whether you want to save
the pattern or not. Choose <literal>Save</literal> to save your edits,
<literal>Not Save</literal> to discard your edits, or
<literal>Cancel</literal> to abort the exit itself.
</para>
</refsect2>
</refsect1>
<refsect1>
<title>EXIT STATUS</title>
<variablelist remap="tight">
<varlistentry><term>0</term>
<listitem>
<para>The Font Editor exited successfully.</para>
</listitem>
</varlistentry>
<varlistentry><term>>1</term>
<listitem>
<para>An error occurred.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>ENVIRONMENT VARIABLES</title>
<para><command>dtudcfonted</command> references the <systemitem class="environvar">DTUDCFONTPATH</systemitem> variable, which is a colon-separated list of directories
to search when looking for UDC font files.
</para>
</refsect1>
<refsect1>
<title>RESOURCES</title>
<para>None.</para>
</refsect1>
<refsect1>
<title>ACTIONS/MESSAGES</title>
<para>None.</para>
</refsect1>
<refsect1>
<title>ERRORS/WARNINGS</title>
<para>The following errors can occur when the font file is read or saved:
</para>
<programlisting>
Failed in reading the selected font file.
Failed in the registration of the selected font file.
</programlisting>
<para>The following errors can occur when the UDC is added, deleted, or copied:
</para>
<programlisting>
The specified code is without the range of UDC code.
Because the memory allocation cannot be done, it is not possible to add.
The specified copy origin code is without the range of UDC code.
The specified copy target code is without the range of UDC code.
There is no character in the specified area.
</programlisting>
<para>The following errors can occur when the font file is opened:
</para>
<programlisting>
Because the selected font file is already open for editing by another
user, it cannot be opened.
Failed to open the selected font file.
You have no right to access for the font file, or the format of the file
is not consistent.
</programlisting>
</refsect1>
<refsect1>
<title>FILES</title>
<para>None.</para>
</refsect1>
<refsect1>
<title>EXAMPLES</title>
<para>None.</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>&cdeman.dtudcexch;
</para>
</refsect1>
</refentry>

2494
cde/doc/C/guides/man/man1_dt/wm.sgm Normal file
View File

File diff suppressed because it is too large Load Diff