Files
cdesktop/cde/doc/C/guides/man/man1_dt/appinteg.sgm
T

307 lines
8.5 KiB
Plaintext

<!-- $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-->