Initial import of the CDE 2.1.30 sources from the Open Group.
This commit is contained in:
Peter Howkins
84
cde/doc/C/guides/man/man1/dsdm.sgm
Normal file
84
cde/doc/C/guides/man/man1/dsdm.sgm
Normal file
@@ -0,0 +1,84 @@
|
||||
<!-- $XConsortium: dsdm.sgm /main/4 1996/09/08 20:20:34 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.MAN0.rsml.1" Remap="">
|
||||
<RefMeta>
|
||||
<RefEntryTitle>dsdm</RefEntryTitle>
|
||||
<ManVolNum>user cmd</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Command>dsdm</Command></RefName>
|
||||
<RefPurpose>Drop Site Database Manager - Motif/OPENLOOK drag and drop
|
||||
proxy agent
|
||||
</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.-->
|
||||
<!-- **-->
|
||||
<!--- THIS IS NOT NECESSARY FOR CDE:-->
|
||||
<!--- The next line is the SCCS ID line, which must appear in any file-->
|
||||
<!--- under the control of SCCS. It contains extraneous zero-width characters-->
|
||||
<!--- `\&' to prevent SCCS from interpreting it as the SCCS line for this-->
|
||||
<!--- template file. Executing this template will produce a version of the-->
|
||||
<!--- template with these characters removed, thereby generating a valid-->
|
||||
<!--- SCCS line ID for your man page.-->
|
||||
<!--- -->
|
||||
<!--- _source_ is where the page comes from, for example, "UCB 4.3 BSD"-->
|
||||
<!--- or "S5r3". For Sun-originated pages, the "from" information may-->
|
||||
<!--- omitted.-->
|
||||
<!--- -->
|
||||
<!-- %\&Z%%\&M% %\&I% %\&E% SMI; from _source_-->
|
||||
<!--- -->
|
||||
<!--- -->
|
||||
<RefSynopsisDiv>
|
||||
<CmdSynopsis>
|
||||
<Command>dsdm</Command>
|
||||
<!--- -->
|
||||
</CmdSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<!--- -->
|
||||
<Para>The
|
||||
<Command>dsdm</Command>
|
||||
manages a database of all drop sites on the display. When a drag
|
||||
operation is started, the
|
||||
<Command>dsdm</Command>
|
||||
is queried for a list of the drop sites.
|
||||
This drop site information is used by the dragging application to
|
||||
identify drop sites and provide
|
||||
user feedback during the drag operation.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Command>dsdm</Command>
|
||||
provides a drag-and-drop
|
||||
gateway between Motif and OPENLOOK applications.
|
||||
When an object is dropped on a drop site,
|
||||
the
|
||||
<Command>dsdm</Command>
|
||||
gets a drop message from
|
||||
the drop sender application. The
|
||||
<Command>dsdm</Command>
|
||||
then translates
|
||||
the drop message, and sends the translated message
|
||||
to the drop receiver application.
|
||||
<!--- --></Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>WARNINGS</Title>
|
||||
<Para>The
|
||||
<Command>dsdm</Command>
|
||||
must be running before applications are started for the drag-and-drop
|
||||
gateway feature to work.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 01:31:55-->
|
||||
6056
cde/doc/C/guides/man/man1/ksh93.sgm
Normal file
6056
cde/doc/C/guides/man/man1/ksh93.sgm
Normal file
File diff suppressed because it is too large
Load Diff
616
cde/doc/C/guides/man/man1/tt_typ_c.sgm
Normal file
616
cde/doc/C/guides/man/man1/tt_typ_c.sgm
Normal file
@@ -0,0 +1,616 @@
|
||||
<!-- $XConsortium: tt_typ_c.sgm /main/8 1996/09/08 20:20: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. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN1.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN1.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>tt_type_comp</RefEntryTitle>
|
||||
<ManVolNum>user cmd</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Command>tt_type_comp</Command></RefName>
|
||||
<RefPurpose>compile ToolTalk otypes and ptypes
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- $XConsortium: tt_typ_c.sgm /main/8 1996/09/08 20:20:59 rws $-->
|
||||
<!-- 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>tt_type_comp</Command>
|
||||
<Arg Choice="opt">−mMs</Arg>
|
||||
<Arg Choice="opt">−d <Replaceable>db</Replaceable></Arg>
|
||||
<Arg><Replaceable>source_file</Replaceable></Arg>
|
||||
<!-- -->
|
||||
</CmdSynopsis>
|
||||
]]>
|
||||
<![ %CDE.C.XO; [
|
||||
<CmdSynopsis>
|
||||
<Command>tt_type_comp</Command>
|
||||
<Arg Choice="opt">−mMs</Arg>
|
||||
<Arg><Replaceable>source_file</Replaceable></Arg>
|
||||
<!-- -->
|
||||
</CmdSynopsis>
|
||||
]]>
|
||||
<![ %CDE.C.CDE; [
|
||||
<CmdSynopsis>
|
||||
<Command>tt_type_comp</Command>
|
||||
<Arg>−r</Arg>
|
||||
<Arg Choice="opt">−s</Arg>
|
||||
<Arg Choice="opt">−d <Replaceable>db</Replaceable></Arg>
|
||||
<Arg><Replaceable>type</Replaceable></Arg>
|
||||
<Arg>. . .</Arg>
|
||||
</CmdSynopsis>
|
||||
]]>
|
||||
<![ %CDE.C.XO; [
|
||||
<CmdSynopsis>
|
||||
<Command>tt_type_comp</Command>
|
||||
<Arg>−r</Arg>
|
||||
<Arg Choice="opt">−s</Arg>
|
||||
<Arg><Replaceable>type</Replaceable></Arg>
|
||||
<Arg>. . .</Arg>
|
||||
</CmdSynopsis>
|
||||
]]>
|
||||
<![ %CDE.C.CDE; [
|
||||
<CmdSynopsis>
|
||||
<Command>tt_type_comp</Command>
|
||||
<Arg>−p</Arg>
|
||||
<Arg>−O</Arg>
|
||||
<Arg>−P</Arg>
|
||||
<Arg Choice="opt">−sE</Arg>
|
||||
<Arg Choice="opt">−d <Replaceable>db</Replaceable></Arg>
|
||||
</CmdSynopsis>
|
||||
]]>
|
||||
<![ %CDE.C.XO; [
|
||||
<CmdSynopsis>
|
||||
<Command>tt_type_comp</Command>
|
||||
<Arg>−p</Arg>
|
||||
<Arg>−O</Arg>
|
||||
<Arg>−P</Arg>
|
||||
<Arg Choice="opt">−s</Arg>
|
||||
</CmdSynopsis>
|
||||
]]>
|
||||
<CmdSynopsis>
|
||||
<Command>tt_type_comp</Command>
|
||||
<Arg>−p</Arg>
|
||||
<Arg>−O</Arg>
|
||||
<Arg>−P</Arg>
|
||||
<Arg Choice="opt">−s</Arg>
|
||||
<Arg><Replaceable>source_file</Replaceable></Arg>
|
||||
<!-- -->
|
||||
</CmdSynopsis>
|
||||
<CmdSynopsis>
|
||||
<Command>tt_type_comp</Command>
|
||||
<Arg>−x</Arg>
|
||||
<Arg Choice="opt">−s</Arg>
|
||||
<Arg Choice="opt">−o <Replaceable>compiled_file</Replaceable></Arg>
|
||||
<Arg><Replaceable>source_file</Replaceable></Arg>
|
||||
<!-- -->
|
||||
</CmdSynopsis>
|
||||
<CmdSynopsis>
|
||||
<Command>tt_type_comp</Command>
|
||||
<Arg Choice="opt">−hv</Arg>
|
||||
</CmdSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Command>tt_type_comp</Command> utility processes otypes and ptypes.
|
||||
The default action of
|
||||
<Command>tt_type_comp</Command> is to compile types from source form into compiled form and then
|
||||
merge the compiled types into the standard ToolTalk types databases.
|
||||
The
|
||||
<Command>tt_type_comp</Command> utility preprocesses the source types with
|
||||
<Command>cpp</Command>(1), and can optionally write out the compiled types instead of merging
|
||||
them into the standard databases.
|
||||
The
|
||||
<Command>tt_type_comp</Command> utility can also remove types from the standard databases
|
||||
or write out the contents of these databases.
|
||||
<![ %CDE.C.CDE; [</Para>
|
||||
<Para>The
|
||||
<Command>tt_type_comp</Command> utility operates in two fundamental modes: XDR and Classing Engine.
|
||||
XDR mode is the default.
|
||||
In XDR mode, the standard databases are
|
||||
simply serialized ToolTalk data structures,
|
||||
and the format of
|
||||
<Command>tt_type_comp</Command> output files is the same as that of the databases.
|
||||
In Classing Engine mode,
|
||||
the standard databases are in fact the Classing Engine's
|
||||
own databases, and the format of
|
||||
<Command>tt_type_comp</Command> output files is that expected for input to
|
||||
<Command>ce_db_build</Command>(1) and
|
||||
<Command>ce_db_merge</Command>(1). ]]></Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>OPTIONS</Title>
|
||||
<![ %CDE.C.XO; [
|
||||
<Para>The
|
||||
<Command>tt_type_comp</Command> utility supports the &str-Zu;.
|
||||
</Para>
|
||||
]]>
|
||||
<Para>The following options are available:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<![ %CDE.C.CDE; [
|
||||
<VarListEntry>
|
||||
<Term><Literal>−d </Literal><Emphasis>db</Emphasis></Term>
|
||||
<ListItem>
|
||||
<Para>Specify the database to work on, which must be one of
|
||||
<Literal>user</Literal>, <Literal>system</Literal> or
|
||||
<Literal>network</Literal>. For Classing Engine mode these are defined as:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term><Literal>user</Literal></Term>
|
||||
<ListItem>
|
||||
<Para><Filename>$HOME/.cetables/cetables</Filename></Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Literal>system</Literal></Term>
|
||||
<ListItem>
|
||||
<Para><Filename>/etc/cetables/cetables</Filename></Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Literal>network</Literal></Term>
|
||||
<ListItem>
|
||||
<Para><Filename>$OPENWINHOME/lib/cetables/cetables</Filename></Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
<Para>For the XDR format these are defined as:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term><Literal>user</Literal></Term>
|
||||
<ListItem>
|
||||
<Para><Filename>$HOME/.tt/types.xdr</Filename></Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Literal>system</Literal></Term>
|
||||
<ListItem>
|
||||
<Para><Filename>/etc/tt/types.xdr</Filename></Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Literal>network</Literal></Term>
|
||||
<ListItem>
|
||||
<Para><Filename>$OPENWINHOME/etc/tt/types.xdr</Filename></Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
<Para>These three databases form a hierarchy in which the definition of a
|
||||
type in the user database overrides the definition in the system
|
||||
database, and so on.
|
||||
For the merge and remove options, the default database is
|
||||
<Literal>user</Literal>. For the
|
||||
<Literal>−p</Literal>, <Literal>−O</Literal> and
|
||||
<Literal>−P</Literal> options, the default is all three databases.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Literal>−E</Literal></Term>
|
||||
<ListItem>
|
||||
<Para>Use Classing Engine mode, instead of the default XDR mode.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
]]>
|
||||
<VarListEntry>
|
||||
<Term><Literal>−h</Literal></Term>
|
||||
<ListItem>
|
||||
<Para>Write a help message for invoking
|
||||
<Command>tt_type_comp</Command> and then exit.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Literal>−m</Literal></Term>
|
||||
<ListItem>
|
||||
<Para>Merge types into the specified database, updating any existing type with
|
||||
the new definition given.
|
||||
This is the default action.
|
||||
<![ %CDE.C.CDE; [This action is not supported for Classing Engine mode.
|
||||
]]>The specified database is the first element from the
|
||||
<Emphasis>TTPATH</Emphasis> environment variable, or
|
||||
<Filename>$HOME/.tt/types.xdr</Filename> if
|
||||
<Emphasis>TTPATH</Emphasis> is
|
||||
<SystemItem Class="Constant">NULL</SystemItem> or not set.
|
||||
If
|
||||
<Emphasis>TTPATH</Emphasis> is
|
||||
<SystemItem Class="Constant">NULL</SystemItem> or not set, it is considered to be:
|
||||
</Para>
|
||||
<InformalExample Remap="indent">
|
||||
<ProgramListing>$HOME/.tt/types.xdr:\
|
||||
/etc/tt/types.xdr:\
|
||||
/usr/dt/appconfig/tttypes/types.xdr
|
||||
</ProgramListing>
|
||||
</InformalExample>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Literal>−M</Literal></Term>
|
||||
<ListItem>
|
||||
<Para>Merge types into the specified database (see
|
||||
<Literal>−m</Literal>), but only if they do not already
|
||||
exist in that database.
|
||||
<![ %CDE.C.CDE; [This action is not supported for Classing Engine mode.
|
||||
]]></Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Literal>−O</Literal></Term>
|
||||
<ListItem>
|
||||
<Para>Write the names of all otypes read.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Literal>−p</Literal></Term>
|
||||
<ListItem>
|
||||
<Para>Write the ToolTalk types read
|
||||
in a source format suitable for recompilation with
|
||||
<Command>tt_type_comp</Command>.</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Literal>−P</Literal></Term>
|
||||
<ListItem>
|
||||
<Para>Write the names of all ptypes read.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Literal>−o </Literal><Emphasis>compiled_file</Emphasis></Term>
|
||||
<ListItem>
|
||||
<Para>Write the compiled types into the specified file,
|
||||
or to standard output if
|
||||
<Emphasis>compiled_file</Emphasis> is −.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Literal>−r</Literal></Term>
|
||||
<ListItem>
|
||||
<Para>Remove the given ptypes or otypes
|
||||
from the specified database, as indicated by the
|
||||
<Symbol Role="Variable">type</Symbol> operands.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Literal>−s</Literal></Term>
|
||||
<ListItem>
|
||||
<Para>Silent mode.
|
||||
Write nothing to standard output.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Literal>−v</Literal></Term>
|
||||
<ListItem>
|
||||
<Para>Write the version number of
|
||||
<Command>tt_type_comp</Command> and then exit.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Literal>−x</Literal></Term>
|
||||
<ListItem>
|
||||
<Para>Compile source types into a compiled types file, instead of merging
|
||||
them into the standard types databases.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>OPERANDS</Title>
|
||||
<Para>The following operands are supported:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term><Emphasis>source_file</Emphasis></Term>
|
||||
<ListItem>
|
||||
<Para>A pathname of a text file containing ToolTalk source code.
|
||||
If
|
||||
<Emphasis>source_file</Emphasis> is −, standard input is used.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Symbol Role="Variable">type</Symbol></Term>
|
||||
<ListItem>
|
||||
<Para>A name of a type to be removed by the
|
||||
<Literal>−r</Literal> option.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>STDIN</Title>
|
||||
<Para>The standard input is used only if a
|
||||
<Emphasis>source_file</Emphasis> operand is −.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>INPUT FILES</Title>
|
||||
<Para>The input file named by
|
||||
<Emphasis>source_file</Emphasis> is a text file containing ToolTalk source
|
||||
<![ %CDE.C.CDE; [code.
|
||||
]]><![ %CDE.C.XO; [code, which must conform to the format described in
|
||||
<![ %CDE.C.XO; [<XRef Linkend="XCDI.TT.anch.4" Role="2">. ]]>]]></Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>ENVIRONMENT VARIABLES</Title>
|
||||
<Para>The following environment variables affect the execution of
|
||||
<Command>tt_type_comp</Command>:</Para>
|
||||
<VariableList>
|
||||
<![ %CDE.C.CDE; [
|
||||
<VarListEntry>
|
||||
<Term><Emphasis>CEPATH</Emphasis></Term>
|
||||
<ListItem>
|
||||
<Para>In Classing Engine mode, a colon-separated list of directories that
|
||||
tells the Classing Engine where to find the databases that
|
||||
contain (among other things) ToolTalk types.
|
||||
See
|
||||
<Command>ce_db_build</Command>(1).</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>
|
||||
<VarListEntry>
|
||||
<Term><Emphasis>TTPATH</Emphasis></Term>
|
||||
<ListItem>
|
||||
<Para><![ %CDE.C.CDE; [In XDR mode, a
|
||||
]]>
|
||||
<![ %CDE.C.XO; [A
|
||||
]]>
|
||||
colon-separated list of directories that tells the ToolTalk service
|
||||
where to find the ToolTalk types databases.
|
||||
</Para>
|
||||
<![ %CDE.C.CDE; [<Para>The format of this variable is
|
||||
</Para>
|
||||
<InformalExample Remap="indent">
|
||||
<ProgramListing><Emphasis>userDir</Emphasis>[:<Emphasis>systemDir</Emphasis>[:<Emphasis>networkDir</Emphasis>]]
|
||||
</ProgramListing>
|
||||
</InformalExample>
|
||||
]]>
|
||||
</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>tt_type_comp</Command> utility takes the standard action for all signals.
|
||||
</Para>
|
||||
]]>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>STDOUT</Title>
|
||||
<Para>When the
|
||||
<Literal>−h</Literal> option is used,
|
||||
<Command>tt_type_comp</Command> writes to standard output a help message
|
||||
in an unspecified format.
|
||||
</Para>
|
||||
<Para>When the
|
||||
<Literal>−o</Literal> option is used,
|
||||
<Command>tt_type_comp</Command> writes to standard output a listing of all
|
||||
otypes
|
||||
read.
|
||||
</Para>
|
||||
<Para>When the
|
||||
<Literal>−p</Literal> option is used,
|
||||
<Command>tt_type_comp</Command> writes to standard output a listing of
|
||||
all the ToolTalk types read,
|
||||
in a source format suitable for recompilation with
|
||||
<Command>tt_type_comp</Command>.</Para>
|
||||
<Para>When the
|
||||
<Literal>−P</Literal> option is used,
|
||||
<Command>tt_type_comp</Command> writes to standard output a listing of all
|
||||
ptypes
|
||||
read.
|
||||
</Para>
|
||||
<Para>When the
|
||||
<Literal>−v</Literal> option is used,
|
||||
<Command>tt_type_comp</Command> writes to standard output a version number
|
||||
in an unspecified format.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>STDERR</Title>
|
||||
<Para>Used only for diagnostic messages.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>OUTPUT FILES</Title>
|
||||
<Para>When the
|
||||
<Literal>−x</Literal> or
|
||||
<Literal>−d user</Literal> option is used,
|
||||
<Command>tt_type_comp</Command> writes the compiled types in an unspecified format
|
||||
into a user-specified file.
|
||||
Otherwise, it writes the compiled types into the
|
||||
databases described under
|
||||
<Literal>−d</Literal>.</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>1</Term>
|
||||
<ListItem>
|
||||
<Para>Usage;
|
||||
<Command>tt_type_comp</Command> was given invalid command line options.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>2</Term>
|
||||
<ListItem>
|
||||
<Para>A syntax error was found in the source types given to
|
||||
<Command>tt_type_comp</Command>.</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>3</Term>
|
||||
<ListItem>
|
||||
<Para>System error;
|
||||
<Command>tt_type_comp</Command> was interrupted by
|
||||
<SystemItem Class="Constant">SIGINT</SystemItem>, or encountered some system or internal error.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>CONSEQUENCES OF ERRORS</Title>
|
||||
<Para>Default.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<![ %CDE.C.CDE; [<RefSect1>
|
||||
<Title>FILES</Title>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term><Filename>$HOME/.tt/types.xdr</Filename></Term>
|
||||
<ListItem>
|
||||
<Para>User's ToolTalk types database for XDR mode
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Filename>/etc/tt/types.xdr</Filename></Term>
|
||||
<ListItem>
|
||||
<Para>System ToolTalk types database for XDR mode
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Filename>/usr/dt/appconfig/tttypes/types.xdr</Filename></Term>
|
||||
<ListItem>
|
||||
<Para>Network ToolTalk types database for XDR mode
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Filename>$OPENWINHOME/etc/tt/types.xdr</Filename></Term>
|
||||
<ListItem>
|
||||
<Para>Network ToolTalk types database for XDR mode
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Filename>$HOME/.cetables/cetables</Filename></Term>
|
||||
<ListItem>
|
||||
<Para></Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Filename>/etc/cetables/cetables</Filename></Term>
|
||||
<ListItem>
|
||||
<Para></Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Filename>$OPENWINHOME/lib/cetables/cetables</Filename></Term>
|
||||
<ListItem>
|
||||
<Para>Classing Engine databases containing ToolTalk types for CE mode.
|
||||
See
|
||||
<Command>ce_db_build</Command>(1).</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
</RefSect1>
|
||||
]]>
|
||||
<RefSect1>
|
||||
<Title>APPLICATION USAGE</Title>
|
||||
<Para>None.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>EXAMPLES</Title>
|
||||
<Para>None.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.ttsession;, <![ %CDE.C.CDE; [<Command>ce_db_build</Command>(1), <Command>ce_db_merge</Command>(1), ]]><Command>cpp</Command>(1).</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->
|
||||
344
cde/doc/C/guides/man/man1/ttcp.sgm
Normal file
344
cde/doc/C/guides/man/man1/ttcp.sgm
Normal file
@@ -0,0 +1,344 @@
|
||||
<!-- $XConsortium: ttcp.sgm /main/7 1996/08/30 15:42:00 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.MAN2.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN2.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>ttcp</RefEntryTitle>
|
||||
<ManVolNum>user cmd</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Command>ttcp</Command></RefName>
|
||||
<RefPurpose>copy files and inform the ToolTalk service
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- $XConsortium: ttcp.sgm /main/7 1996/08/30 15:42:00 rws $-->
|
||||
<!-- 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>ttcp</Command>
|
||||
<Arg Choice="opt">−pL</Arg>
|
||||
<Arg><Replaceable>filename1</Replaceable></Arg>
|
||||
<Arg><Replaceable>filename2</Replaceable></Arg>
|
||||
<!-- -->
|
||||
</CmdSynopsis>
|
||||
<CmdSynopsis>
|
||||
<Command>ttcp</Command>
|
||||
<Arg>−r</Arg>
|
||||
<Arg Choice="opt">−pL</Arg>
|
||||
<Arg><Replaceable>directory1</Replaceable></Arg>
|
||||
<Arg><Replaceable>directory2</Replaceable></Arg>
|
||||
<!-- -->
|
||||
</CmdSynopsis>
|
||||
<CmdSynopsis>
|
||||
<Command>ttcp</Command>
|
||||
<Arg Choice="opt">−prL</Arg>
|
||||
<Arg><Replaceable>filename</Replaceable></Arg>
|
||||
<Arg>. . .</Arg>
|
||||
<Arg><Replaceable>directory</Replaceable></Arg>
|
||||
<!-- -->
|
||||
</CmdSynopsis>
|
||||
<CmdSynopsis>
|
||||
<Command>ttcp</Command>
|
||||
<Arg>−h</Arg>
|
||||
<Arg>−v</Arg>
|
||||
</CmdSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Command>ttcp</Command> utility
|
||||
invokes the
|
||||
<Command>cp</Command>(1) utility to copy files and directories, and informs ToolTalk about its
|
||||
actions so that the ToolTalk objects associated with those files
|
||||
and directories can also be copied.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>OPTIONS</Title>
|
||||
<![ %CDE.C.XO; [
|
||||
<Para>The
|
||||
<Command>ttcp</Command> utility supports the &str-Zu;.
|
||||
</Para>
|
||||
]]>
|
||||
<Para>The following options are available:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term><Literal>−h</Literal></Term>
|
||||
<ListItem>
|
||||
<Para>Write a help message for invoking
|
||||
<Command>ttcp</Command> and then exit.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Literal>−L</Literal></Term>
|
||||
<ListItem>
|
||||
<Para>Copy the ToolTalk objects of the files, but do not invoke
|
||||
<Command>cp</Command>(1) to copy the actual files.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Literal>−p</Literal></Term>
|
||||
<ListItem>
|
||||
<Para>Preserve.
|
||||
Invoke
|
||||
<Command>cp</Command>(1) with the
|
||||
<Literal>−p</Literal> option, which
|
||||
duplicates not only the contents of the original files
|
||||
or directories, but also the modification time and permission modes.
|
||||
The modification times of ToolTalk objects are preserved only if
|
||||
the invoking process has appropriate privileges.
|
||||
<![ %CDE.C.CDE; [(Super-user permissions are required.)
|
||||
]]></Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Literal>−r</Literal></Term>
|
||||
<ListItem>
|
||||
<Para>Recursively copy the ToolTalk objects of any directories named,
|
||||
along with their files (including any
|
||||
subdirectories and their files), and pass the
|
||||
<Literal>−r</Literal> option to
|
||||
<Command>cp</Command>(1).</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Literal>−v</Literal></Term>
|
||||
<ListItem>
|
||||
<Para>Write the version number of
|
||||
<Command>ttcp</Command> and then exit.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
<Para><![ %CDE.C.XO; [It is unspecified whether the
|
||||
<Literal>−f</Literal>, <Literal>−i</Literal> or
|
||||
<Literal>−R</Literal> options to
|
||||
<Command>cp</Command>(1) are supported.
|
||||
]]><![ %CDE.C.CDE; [The
|
||||
<Literal>−f</Literal>, <Literal>−i</Literal> or
|
||||
<Literal>−R</Literal> options to
|
||||
<Command>cp</Command>(1) are not supported.
|
||||
]]></Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>OPERANDS</Title>
|
||||
<Para>The following operands are supported:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term><Symbol Role="Variable">filename</Symbol></Term>
|
||||
<ListItem>
|
||||
<Para></Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Emphasis>filename1</Emphasis></Term>
|
||||
<ListItem>
|
||||
<Para>A pathname of a file to be copied.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Emphasis>filename2</Emphasis></Term>
|
||||
<ListItem>
|
||||
<Para>A pathname of an existing or nonexisting file,
|
||||
used for the output when a single file is copied.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Emphasis>directory</Emphasis></Term>
|
||||
<ListItem>
|
||||
<Para></Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Emphasis>directory2</Emphasis></Term>
|
||||
<ListItem>
|
||||
<Para>A pathname of a directory to contain the copied files.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Emphasis>directory1</Emphasis></Term>
|
||||
<ListItem>
|
||||
<Para>A pathname of a file hierarchy to be copied with
|
||||
<Literal>−r</Literal>.</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>STDIN</Title>
|
||||
<Para>Not used.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>INPUT FILES</Title>
|
||||
<Para>The input files specified as operands can be of any file type.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>ENVIRONMENT VARIABLES</Title>
|
||||
<Para>The following environment variables affect the execution of
|
||||
<Command>ttcp</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>ttcp</Command> utility takes the standard action for all signals.
|
||||
</Para>
|
||||
]]>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>STDOUT</Title>
|
||||
<Para>When the
|
||||
<Literal>−h</Literal> option is used,
|
||||
<Command>ttcp</Command> writes to standard output a help message
|
||||
in an unspecified format.
|
||||
</Para>
|
||||
<Para>When the
|
||||
<Literal>−v</Literal> option is used,
|
||||
<Command>ttcp</Command> writes to standard output a version number
|
||||
in an unspecified format.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>STDERR</Title>
|
||||
<Para>Used only for diagnostic messages.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>OUTPUT FILES</Title>
|
||||
<Para>The output files can be of any type.
|
||||
</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>All files and ToolTalk objects were copied successfully.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>>0</Term>
|
||||
<ListItem>
|
||||
<Para>An error occurred or the invoked
|
||||
<Command>cp</Command>(1) command exited with a non-zero value.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>CONSEQUENCES OF ERRORS</Title>
|
||||
<Para>Default.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<![ %CDE.C.CDE; [<RefSect1>
|
||||
<Title>FILES</Title>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>/mountpoint/TT_DB</Term>
|
||||
<ListItem>
|
||||
<!-- ex-TP-->
|
||||
<Para>The directory used as a database
|
||||
for the ToolTalk objects of files in the
|
||||
file system mounted at
|
||||
<Emphasis>/mountpoint</Emphasis>.</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
</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; [<Command>cp</Command>(1)]]><![ %CDE.C.XO; [<Command>cp</Command> in the &str-ZC;]]>,
|
||||
&cdeman.ttmv;, &cdeman.tttar;, &cdeman.ttsession;.</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->
|
||||
305
cde/doc/C/guides/man/man1/ttmv.sgm
Normal file
305
cde/doc/C/guides/man/man1/ttmv.sgm
Normal file
@@ -0,0 +1,305 @@
|
||||
<!-- $XConsortium: ttmv.sgm /main/6 1996/08/30 15:42: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. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN3.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN3.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>ttmv</RefEntryTitle>
|
||||
<ManVolNum>user cmd</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Command>ttmv</Command></RefName>
|
||||
<RefPurpose>move or rename files and inform the ToolTalk service
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- $XConsortium: ttmv.sgm /main/6 1996/08/30 15:42:23 rws $-->
|
||||
<!-- 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>ttmv</Command>
|
||||
<Arg Choice="opt">−fL</Arg>
|
||||
<Arg><Replaceable>pathname1</Replaceable></Arg>
|
||||
<Arg><Replaceable>pathname2</Replaceable></Arg>
|
||||
<!-- -->
|
||||
</CmdSynopsis>
|
||||
<CmdSynopsis>
|
||||
<Command>ttmv</Command>
|
||||
<Arg Choice="opt">−fL</Arg>
|
||||
<Arg><Replaceable>pathname</Replaceable></Arg>
|
||||
<Arg>. . .</Arg>
|
||||
<Arg><Replaceable>directory</Replaceable></Arg>
|
||||
<!-- -->
|
||||
</CmdSynopsis>
|
||||
<CmdSynopsis>
|
||||
<Command>ttmv</Command>
|
||||
<Arg>−h</Arg>
|
||||
<Arg>−v</Arg>
|
||||
</CmdSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Command>ttmv</Command> utility
|
||||
invokes
|
||||
<Command>mv</Command>(1) to move files and directories around in the file system and informs
|
||||
ToolTalk about its actions so that the ToolTalk objects
|
||||
associated with those files and directories can also be moved.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Command>ttmv</Command> utility
|
||||
moves the ToolTalk objects before it moves the files and does not
|
||||
check whether the file-moving operation will succeed before performing
|
||||
the object-moving operation.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>OPTIONS</Title>
|
||||
<![ %CDE.C.XO; [
|
||||
<Para>The
|
||||
<Command>ttmv</Command> utility supports the &str-Zu;.
|
||||
</Para>
|
||||
]]>
|
||||
<Para>The following options are available:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term><Literal>−f</Literal></Term>
|
||||
<ListItem>
|
||||
<Para>Force.
|
||||
Do not report any errors, and pass the
|
||||
<Literal>−f</Literal> option to
|
||||
<Command>mv</Command>(1).</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Literal>−h</Literal></Term>
|
||||
<ListItem>
|
||||
<Para>Write a help message for invoking
|
||||
<Command>ttmv</Command> and then exit.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Literal>−L</Literal></Term>
|
||||
<ListItem>
|
||||
<Para>Move the ToolTalk objects of the files, but do not invoke
|
||||
<Command>mv</Command>(1) to move the actual files.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Literal>−v</Literal></Term>
|
||||
<ListItem>
|
||||
<Para>Write the version number of
|
||||
<Command>ttmv</Command> and then exit.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
<Para><![ %CDE.C.XO; [It is unspecified whether the
|
||||
<Literal>−i</Literal> option to
|
||||
<Command>mv</Command>(1) is supported.
|
||||
]]><![ %CDE.C.CDE; [The
|
||||
<Literal>−i</Literal> option to
|
||||
<Command>cp</Command>(1) is not supported.
|
||||
]]></Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>OPERANDS</Title>
|
||||
<Para>The following operands are supported:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term><Emphasis>pathname1</Emphasis></Term>
|
||||
<ListItem>
|
||||
<Para>A pathname of a file to be moved.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Emphasis>pathname2</Emphasis></Term>
|
||||
<ListItem>
|
||||
<Para>A pathname of an existing or nonexisting file,
|
||||
used for the output when a single file is moved.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Emphasis>directory</Emphasis></Term>
|
||||
<ListItem>
|
||||
<Para>A pathname of a directory to contain the moved files.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>STDIN</Title>
|
||||
<Para>Not used.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>INPUT FILES</Title>
|
||||
<Para>The input files specified as operands can be of any file type.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>ENVIRONMENT VARIABLES</Title>
|
||||
<Para>The following environment variables affect the execution of
|
||||
<Command>ttmv</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>ttmv</Command> utility takes the standard action for all signals.
|
||||
</Para>
|
||||
]]>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>STDOUT</Title>
|
||||
<Para>When the
|
||||
<Literal>−h</Literal> option is used,
|
||||
<Command>ttmv</Command> writes to standard output a help message
|
||||
in an unspecified format.
|
||||
</Para>
|
||||
<Para>When the
|
||||
<Literal>−v</Literal> option is used,
|
||||
<Command>ttmv</Command> writes to standard output a version number
|
||||
in an unspecified format.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>STDERR</Title>
|
||||
<Para>Used only for diagnostic messages.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>OUTPUT FILES</Title>
|
||||
<Para>The output files can be of any type.
|
||||
</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>All files and ToolTalk objects were moved successfully.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>>0</Term>
|
||||
<ListItem>
|
||||
<Para>An error occurred or the invoked
|
||||
<Command>mv</Command>(1) command exited with a non-zero value.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>CONSEQUENCES OF ERRORS</Title>
|
||||
<Para>Default.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<![ %CDE.C.CDE; [<RefSect1>
|
||||
<Title>FILES</Title>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>/mountpoint/TT_DB</Term>
|
||||
<ListItem>
|
||||
<!-- ex-TP-->
|
||||
<Para>The directory used as a database
|
||||
for the ToolTalk objects of files in the
|
||||
file system mounted at
|
||||
<Emphasis>/mountpoint</Emphasis>.</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
</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; [<Command>mv</Command>(1)]]><![ %CDE.C.XO; [<Command>mv</Command> in the &str-ZC;]]>,
|
||||
&cdeman.ttsession;.</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->
|
||||
293
cde/doc/C/guides/man/man1/ttrm.sgm
Normal file
293
cde/doc/C/guides/man/man1/ttrm.sgm
Normal file
@@ -0,0 +1,293 @@
|
||||
<!-- $XConsortium: ttrm.sgm /main/6 1996/08/30 15:42: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.XCDI.MAN4.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN4.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>ttrm</RefEntryTitle>
|
||||
<ManVolNum>user cmd</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Command>ttrm</Command></RefName>
|
||||
<RefPurpose>remove files or directories and inform the ToolTalk service
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- $XConsortium: ttrm.sgm /main/6 1996/08/30 15:42:48 rws $-->
|
||||
<!-- 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>ttrm</Command>
|
||||
<Arg Choice="opt">−frL</Arg>
|
||||
<Arg><Replaceable>pathname</Replaceable></Arg>
|
||||
<Arg>. . .</Arg>
|
||||
</CmdSynopsis>
|
||||
<CmdSynopsis>
|
||||
<Command>ttrm</Command>
|
||||
<Arg>−h</Arg>
|
||||
<Arg>−v</Arg>
|
||||
</CmdSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Command>ttrm</Command> utility
|
||||
invokes
|
||||
<Command>rm</Command>(1) to remove files and directories and informs
|
||||
ToolTalk about its actions so that the ToolTalk objects
|
||||
associated with the deleted files and directories can also be deleted.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Command>ttrm</Command> utility
|
||||
removes the ToolTalk objects before it removes the files and does not
|
||||
check whether the file-removing operation will succeed before performing
|
||||
the object-removing operation.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>OPTIONS</Title>
|
||||
<![ %CDE.C.XO; [
|
||||
<Para>The
|
||||
<Command>ttrm</Command> utility supports the &str-Zu;.
|
||||
</Para>
|
||||
]]>
|
||||
<Para>The following options are available:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term><Literal>−f</Literal></Term>
|
||||
<ListItem>
|
||||
<Para>Force.
|
||||
Do not report any errors, and pass the
|
||||
<Literal>−f</Literal> option to
|
||||
<Command>rm</Command>(1).</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Literal>−h</Literal></Term>
|
||||
<ListItem>
|
||||
<Para>Write a help message for invoking
|
||||
<Command>ttrm</Command> and then exit.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Literal>−L</Literal></Term>
|
||||
<ListItem>
|
||||
<Para>Remove the ToolTalk objects of the files or directories, but do not invoke
|
||||
<Command>rm</Command>(1) to remove the actual files or directories.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Literal>−r</Literal></Term>
|
||||
<ListItem>
|
||||
<Para>Recursively remove the ToolTalk objects of any directories named,
|
||||
along with their files (including any
|
||||
subdirectories and their files), and pass the
|
||||
<Literal>−r</Literal> option to
|
||||
<Command>rm</Command>(1).</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Literal>−v</Literal></Term>
|
||||
<ListItem>
|
||||
<Para>Write the version number of
|
||||
<Command>ttrm</Command> and then exit.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
<Para><![ %CDE.C.XO; [It is unspecified whether the
|
||||
<Literal>−i</Literal> or
|
||||
<Literal>−R</Literal> options to
|
||||
<Command>rm</Command>(1) are supported.
|
||||
]]><![ %CDE.C.CDE; [The
|
||||
<Literal>−i</Literal> or
|
||||
<Literal>−R</Literal> options to
|
||||
<Command>rm</Command>(1) are not supported.
|
||||
]]></Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>OPERANDS</Title>
|
||||
<Para>The following operand is supported:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term><Symbol Role="Variable">pathname</Symbol></Term>
|
||||
<ListItem>
|
||||
<Para>A pathname of a file to be removed.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>STDIN</Title>
|
||||
<Para>Not used.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>INPUT FILES</Title>
|
||||
<Para>The input files specified as operands can be of any file type.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>ENVIRONMENT VARIABLES</Title>
|
||||
<Para>The following environment variables affect the execution of
|
||||
<Command>ttrm</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>ttrm</Command> utility takes the standard action for all signals.
|
||||
</Para>
|
||||
]]>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>STDOUT</Title>
|
||||
<Para>When the
|
||||
<Literal>−h</Literal> option is used,
|
||||
<Command>ttrm</Command> writes to standard output a help message
|
||||
in an unspecified format.
|
||||
</Para>
|
||||
<Para>When the
|
||||
<Literal>−v</Literal> option is used,
|
||||
<Command>ttrm</Command> writes to standard output a version number
|
||||
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>All files and ToolTalk objects were removed successfully.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>>0</Term>
|
||||
<ListItem>
|
||||
<Para>An error occurred or the invoked
|
||||
<Command>rm</Command>(1) command exited with a non-zero value.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>CONSEQUENCES OF ERRORS</Title>
|
||||
<Para>Default.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<![ %CDE.C.CDE; [<RefSect1>
|
||||
<Title>FILES</Title>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>/mountpoint/TT_DB</Term>
|
||||
<ListItem>
|
||||
<!-- ex-TP-->
|
||||
<Para>The directory used as a database
|
||||
for the ToolTalk objects of files in the
|
||||
file system mounted at
|
||||
<Emphasis>/mountpoint</Emphasis>.</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
</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; [<Command>rm</Command>(1)]]><![ %CDE.C.XO; [<Command>rm</Command> in the &str-ZC;]]>,
|
||||
&cdeman.ttrmdir;, &cdeman.ttsession;.</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->
|
||||
274
cde/doc/C/guides/man/man1/ttrmdir.sgm
Normal file
274
cde/doc/C/guides/man/man1/ttrmdir.sgm
Normal file
@@ -0,0 +1,274 @@
|
||||
<!-- $XConsortium: ttrmdir.sgm /main/6 1996/08/30 15:43: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. -->
|
||||
|
||||
<![ %CDE.C.CDE; [<RefEntry Id="CDEMX.XCDI.MAN5.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN5.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>ttrmdir</RefEntryTitle>
|
||||
<ManVolNum>user cmd</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Command>ttrmdir</Command></RefName>
|
||||
<RefPurpose>remove empty directories and inform the ToolTalk service
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- $XConsortium: ttrmdir.sgm /main/6 1996/08/30 15:43:07 rws $-->
|
||||
<!-- 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>ttrmdir</Command>
|
||||
<Arg Choice="opt">−L</Arg>
|
||||
<Arg><Replaceable>directory</Replaceable></Arg>
|
||||
<Arg>. . .</Arg>
|
||||
</CmdSynopsis>
|
||||
<CmdSynopsis>
|
||||
<Command>ttrmdir</Command>
|
||||
<Arg>−h</Arg>
|
||||
<Arg>−v</Arg>
|
||||
</CmdSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Command>ttrmdir</Command> utility
|
||||
invokes
|
||||
<Command>rmdir</Command>(1) to remove empty directories and informs
|
||||
ToolTalk about its actions so that the ToolTalk objects
|
||||
associated with the deleted directories can also be deleted.
|
||||
</Para>
|
||||
<Para>The
|
||||
<Command>ttrmdir</Command> utility removes the ToolTalk objects before it removes the directories
|
||||
and does not check whether a directory is empty or whether the
|
||||
directory-removing operation will succeed before performing the
|
||||
object-removing operation.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>OPTIONS</Title>
|
||||
<![ %CDE.C.XO; [
|
||||
<Para>The
|
||||
<Command>ttrmdir</Command> utility supports the &str-Zu;.
|
||||
</Para>
|
||||
]]>
|
||||
<Para>The following options are available:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term><Literal>−h</Literal></Term>
|
||||
<ListItem>
|
||||
<Para>Write a help message for invoking
|
||||
<Command>ttrmdir</Command> and then exit.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Literal>−L</Literal></Term>
|
||||
<ListItem>
|
||||
<Para>Remove the ToolTalk objects of the directories, but do not invoke
|
||||
<Command>rmdir</Command>(1) to remove the actual directories.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Literal>−v</Literal></Term>
|
||||
<ListItem>
|
||||
<Para>Write the version number of
|
||||
<Command>ttrmdir</Command> and then exit.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
<Para><![ %CDE.C.XO; [It is unspecified whether the
|
||||
<Literal>−p</Literal> option to
|
||||
<Command>cp</Command>(1) is supported.
|
||||
]]><![ %CDE.C.CDE; [The
|
||||
<Literal>−p</Literal> option to
|
||||
<Command>cp</Command>(1) is not supported.
|
||||
]]></Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>OPERANDS</Title>
|
||||
<Para>The following operand is supported:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term><Emphasis>directory</Emphasis></Term>
|
||||
<ListItem>
|
||||
<Para>A pathname of an empty directory to be removed.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>STDIN</Title>
|
||||
<Para>Not used.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>INPUT FILES</Title>
|
||||
<Para>The input files specified as operands can be of any file type.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>ENVIRONMENT VARIABLES</Title>
|
||||
<Para>The following environment variables affect the execution of
|
||||
<Command>ttrmdir</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>ttrmdir</Command> utility takes the standard action for all signals.
|
||||
</Para>
|
||||
]]>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>STDOUT</Title>
|
||||
<Para>When the
|
||||
<Literal>−h</Literal> option is used,
|
||||
<Command>ttrmdir</Command> writes to standard output a help message
|
||||
in an unspecified format.
|
||||
</Para>
|
||||
<Para>When the
|
||||
<Literal>−v</Literal> option is used,
|
||||
<Command>ttrmdir</Command> writes to standard output a version number
|
||||
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>All directories and ToolTalk objects were removed successfully.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>>0</Term>
|
||||
<ListItem>
|
||||
<Para>An error occurred or the invoked
|
||||
<Command>rmdir</Command>(1) command exited with a non-zero value.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>CONSEQUENCES OF ERRORS</Title>
|
||||
<Para>Default.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<![ %CDE.C.CDE; [<RefSect1>
|
||||
<Title>FILES</Title>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>/mountpoint/TT_DB</Term>
|
||||
<ListItem>
|
||||
<!-- ex-TP-->
|
||||
<Para>The directory used as a database
|
||||
for the ToolTalk objects of files in the
|
||||
file system mounted at
|
||||
<Emphasis>/mountpoint</Emphasis>.</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
</RefSect1>]]>
|
||||
<RefSect1>
|
||||
<Title>APPLICATION USAGE</Title>
|
||||
<Para>The definition of an empty directory
|
||||
is one that contains, at most,
|
||||
directory entries for dot and dot-dot.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>EXAMPLES</Title>
|
||||
<Para>None.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para><![ %CDE.C.CDE; [<Command>rmdir</Command>(1)]]><![ %CDE.C.XO; [<Command>rmdir</Command> in the &str-ZC;]]>,
|
||||
&cdeman.ttrm;, &cdeman.ttsession;.</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->
|
||||
527
cde/doc/C/guides/man/man1/ttsessio.sgm
Normal file
527
cde/doc/C/guides/man/man1/ttsessio.sgm
Normal file
@@ -0,0 +1,527 @@
|
||||
<!-- $XConsortium: ttsessio.sgm /main/7 1996/09/08 20:21:08 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.MAN6.rsml.1">]]>
|
||||
<![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN6.rsml.1">]]>
|
||||
<RefMeta>
|
||||
<RefEntryTitle>ttsession</RefEntryTitle>
|
||||
<ManVolNum>user cmd</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Command>ttsession</Command></RefName>
|
||||
<RefPurpose>the ToolTalk message server
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- $XConsortium: ttsessio.sgm /main/7 1996/09/08 20:21:08 rws $-->
|
||||
<!-- 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>ttsession</Command>
|
||||
<Arg Choice="opt">−hNpsStv</Arg>
|
||||
<Group>
|
||||
<Arg>−E</Arg>
|
||||
<Arg>−X</Arg>
|
||||
</Group>
|
||||
<Arg Choice="opt">−a <Replaceable>level</Replaceable></Arg>
|
||||
<Arg Choice="opt">−d <Replaceable>display</Replaceable></Arg>
|
||||
<Group>
|
||||
<Arg>−c </Arg>
|
||||
<Arg Choice="opt"><Replaceable>command</Replaceable></Arg>
|
||||
</Group>
|
||||
</CmdSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para>The
|
||||
<Command>ttsession</Command> utility
|
||||
is the ToolTalk message server.
|
||||
This background process must be running
|
||||
before any messages can be sent or received.
|
||||
Each message server defines a
|
||||
<Emphasis>session</Emphasis>.</Para>
|
||||
<Para>The message server has no user interface and typically runs in the
|
||||
background, started either by the user's
|
||||
<Filename>.xinitrc</Filename> file or automatically
|
||||
by any program that needs to send or receive a message.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>OPTIONS</Title>
|
||||
<![ %CDE.C.XO; [
|
||||
<Para>The
|
||||
<Command>ttsession</Command> utility supports the &str-Zu;, except that the
|
||||
<Literal>−c</Literal> option has an optional option-argument,
|
||||
which treats all of the following command-line arguments
|
||||
as a string to be passed to another shell invocation.
|
||||
</Para>
|
||||
]]>
|
||||
<Para>The following options are available:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term><Literal>−a </Literal><Symbol Role="Variable">level</Symbol></Term>
|
||||
<ListItem>
|
||||
<Para>Set the server authentication level.
|
||||
The following
|
||||
<Symbol Role="Variable">level</Symbol> string values are supported:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term><Literal>unix</Literal></Term>
|
||||
<ListItem>
|
||||
<Para>The sender and receiver must have the same user ID.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Literal>des</Literal></Term>
|
||||
<ListItem>
|
||||
<Para>The underlying RPC calls use
|
||||
<SystemItem Class="Constant">AUTH_DES</SystemItem>.</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Literal>−c [</Literal><Symbol Role="Variable">command</Symbol><Literal>]</Literal></Term>
|
||||
<ListItem>
|
||||
<Para>Start a process tree session and run the given command.
|
||||
The
|
||||
<Command>ttsession</Command> utility sets the environment variable
|
||||
<SystemItem Class="Constant">TT_SESSION</SystemItem> to the name of this session.
|
||||
Any process started with this variable in the environment
|
||||
defaults to being in this session.
|
||||
If
|
||||
<Symbol Role="Variable">command</Symbol> is omitted,
|
||||
<Command>ttsession</Command> invokes the shell named by the
|
||||
<SystemItem Class="EnvironVar">SHELL</SystemItem> environment variable.
|
||||
Everything after
|
||||
<Literal>−c</Literal> on the command line is used as the command to be executed.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Literal>−d </Literal><Symbol Role="Variable">display</Symbol></Term>
|
||||
<ListItem>
|
||||
<Para>Specify an X Windows display.
|
||||
The ToolTalk session will consist of those applications
|
||||
displaying on the named display.
|
||||
The default display is identified by the
|
||||
<SystemItem Class="EnvironVar">DISPLAY</SystemItem> environment variable.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Literal>−E</Literal></Term>
|
||||
<ListItem>
|
||||
<Para>Read in the types from the Classing Engine database.
|
||||
If neither
|
||||
<Literal>−E</Literal> nor
|
||||
<Literal>−X</Literal> is given,
|
||||
<Literal>−X</Literal> is assumed.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Literal>−h</Literal></Term>
|
||||
<ListItem>
|
||||
<Para>Write a help message to standard error that
|
||||
describes the command syntax of
|
||||
<Command>ttsession</Command>, and exit.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Literal>−N</Literal></Term>
|
||||
<ListItem>
|
||||
<Para>Maximize the number of clients allowed to connect to (in other words, open
|
||||
procids in) this session by attempting to raise the limit of
|
||||
open file descriptors.
|
||||
The precise number of clients is system-dependent;
|
||||
on some systems this option may have no effect.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Literal>−p</Literal></Term>
|
||||
<ListItem>
|
||||
<Para>Write the name of a new process tree session to standard output, and then
|
||||
fork a background instance of
|
||||
<Command>ttsession</Command> to manage this new session.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Literal>−s</Literal></Term>
|
||||
<ListItem>
|
||||
<Para>Silent.
|
||||
Do not write any warning messages to standard error.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Literal>−S</Literal></Term>
|
||||
<ListItem>
|
||||
<Para>Do not fork a background instance to manage the
|
||||
<Command>ttsession</Command> session.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Literal>−t</Literal></Term>
|
||||
<ListItem>
|
||||
<Para>Turn on trace mode.
|
||||
See
|
||||
<Literal>ASYNCHRONOUS EVENTS</Literal> for how to turn tracing on and off during execution.
|
||||
Tracing displays the state of a message when it is first seen by
|
||||
<Command>ttsession</Command>. The lifetime of the message is then shown by showing the result of
|
||||
matching the message against type signatures (dispatch stage) and then
|
||||
showing the result of matching the message against any registered
|
||||
message patterns (delivery stage).
|
||||
Any attempt to send the message to
|
||||
a given process is also shown together with the success of that attempt.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Literal>−v</Literal></Term>
|
||||
<ListItem>
|
||||
<Para>Write the version number to standard output and exit.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Literal>−X</Literal></Term>
|
||||
<ListItem>
|
||||
<Para>Read in the types from the following XDR format databases:
|
||||
</Para>
|
||||
<InformalExample Remap="indent">
|
||||
<ProgramListing>$HOME/.tt/types.xdr
|
||||
<![ %CDE.C.XO; [<<Emphasis>implementation-specific system and network databases</Emphasis>>
|
||||
]]><![ %CDE.C.CDE; [/etc/tt/types.xdr
|
||||
$OPENWINHOME/etc/tt/types.xdr
|
||||
]]>/usr/dt/appconfig/tttypes/types.xdr
|
||||
</ProgramListing>
|
||||
</InformalExample>
|
||||
<Para>The databases are listed order of decreasing precedence.
|
||||
Entries in
|
||||
<Filename>$HOME/.tt/types.xdr</Filename> override any like entries in the databases
|
||||
lower in the list, and so forth.
|
||||
</Para>
|
||||
<Para>These locations can be overridden by setting the
|
||||
<Emphasis>TTPATH</Emphasis> environment variable.
|
||||
See
|
||||
<Literal>ENVIRONMENT VARIABLES</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>The XDR format databases listed by the
|
||||
<Literal>−X</Literal> option are serialized ToolTalk data structures of
|
||||
an unspecified format, except that it is the same
|
||||
as the format of
|
||||
&cdeman.tt.type.comp; output files.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>ENVIRONMENT VARIABLES</Title>
|
||||
<Para>The following environment variables affect the execution of
|
||||
<Command>ttsession</Command>:</Para>
|
||||
<VariableList>
|
||||
<![ %CDE.C.CDE; [
|
||||
<VarListEntry>
|
||||
<Term><Emphasis>CEPATH</Emphasis></Term>
|
||||
<ListItem>
|
||||
<Para>In Classing Engine mode, this variable tells the Classing Engine
|
||||
where to find the databases that contain ToolTalk types.
|
||||
See
|
||||
<Command>ce_db_build</Command>(1).</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
]]>
|
||||
<VarListEntry>
|
||||
<Term><SystemItem Class="EnvironVar">DISPLAY</SystemItem></Term>
|
||||
<ListItem>
|
||||
<Para>If
|
||||
<SystemItem Class="Constant">TT_SESSION</SystemItem> is not set and
|
||||
<SystemItem Class="EnvironVar">DISPLAY</SystemItem> is set, then the value of
|
||||
<SystemItem Class="EnvironVar">DISPLAY</SystemItem> will be used by all ToolTalk clients to identify the
|
||||
<Command>ttsession</Command> process serving their X display.
|
||||
If no such process is running, the ToolTalk
|
||||
service will auto-start one.
|
||||
</Para>
|
||||
<Para>If
|
||||
<Command>ttsession</Command> is run with the
|
||||
<Literal>−d</Literal> option and
|
||||
<SystemItem Class="EnvironVar">DISPLAY</SystemItem> is not set,
|
||||
<Command>ttsession</Command> sets
|
||||
<SystemItem Class="EnvironVar">DISPLAY</SystemItem> to be the value of the
|
||||
<Literal>−d</Literal> option for itself and all processes it forks.
|
||||
This helps ToolTalk clients to find the right X display when
|
||||
they are auto-started by
|
||||
<Command>ttsession</Command>.</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>
|
||||
<VarListEntry>
|
||||
<Term><Emphasis>TT_ARG_TRACE_WIDTH</Emphasis></Term>
|
||||
<ListItem>
|
||||
<Para>Specify the number of bytes of argument and context values to write when
|
||||
in trace mode.
|
||||
The default is to print the first 40 bytes.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Emphasis>TTPATH</Emphasis></Term>
|
||||
<ListItem>
|
||||
<![ %CDE.C.CDE; [
|
||||
<Para>In XDR mode, a
|
||||
</Para>
|
||||
]]>
|
||||
<![ %CDE.C.XO; [
|
||||
<Para>A
|
||||
</Para>
|
||||
]]>
|
||||
<Para>colon-separated list of directories that tells ToolTalk
|
||||
where to find the ToolTalk types databases.
|
||||
The format of this variable is:
|
||||
</Para>
|
||||
<InformalExample Remap="indent">
|
||||
<ProgramListing><Emphasis>userDir</Emphasis>[:<Emphasis>systemDir</Emphasis>[:<Emphasis>networkDir</Emphasis>]]
|
||||
</ProgramListing>
|
||||
</InformalExample>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Emphasis>TTSESSION_CMD</Emphasis></Term>
|
||||
<ListItem>
|
||||
<Para>Specify the shell command to be used by all ToolTalk clients
|
||||
for auto-starting
|
||||
<Command>ttsession</Command>.</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
<Para>The
|
||||
<Command>ttsession</Command> utility creates the following variable when it invokes another process:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term><SystemItem Class="Constant">TT_FILE</SystemItem></Term>
|
||||
<ListItem>
|
||||
<Para>When
|
||||
<Command>ttsession</Command> invokes a tool to receive a message, it copies the file attribute
|
||||
(if any) of the message into this variable, formatted in the same
|
||||
manner as returned by the
|
||||
&cdeman.tt.message.file; function.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><SystemItem Class="Constant">TT_SESSION</SystemItem></Term>
|
||||
<ListItem>
|
||||
<Para>The
|
||||
<Command>ttsession</Command> utility uses this variable to communicate its session ID to the tools that
|
||||
it starts.
|
||||
The format of the variable is implementation specific.
|
||||
If this variable is set, the ToolTalk client library uses its
|
||||
value as the default session ID.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term><Emphasis>TT_TOKEN</Emphasis></Term>
|
||||
<ListItem>
|
||||
<Para>Inform the ToolTalk client library that it has been invoked by
|
||||
<Command>ttsession</Command>, so that the client can confirm to
|
||||
<Command>ttsession</Command> that it started successfully.
|
||||
The format of the variable is implementation specific.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
<Para>A tool started by
|
||||
<Command>ttsession</Command> must ensure that the
|
||||
<SystemItem Class="Constant">TT_SESSION</SystemItem> and
|
||||
<Emphasis>TT_TOKEN</Emphasis> are present in the environment of any processes it invokes.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>RESOURCES</Title>
|
||||
<Para>None.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>ASYNCHRONOUS EVENTS</Title>
|
||||
<Para>The
|
||||
<Command>ttsession</Command> utility reacts to two signals.
|
||||
If it receives the
|
||||
<SystemItem Class="Constant">SIGUSR1</SystemItem> signal, it toggles trace mode on or off (see the
|
||||
<Literal>−t</Literal> option).
|
||||
If it receives the
|
||||
<SystemItem Class="Constant">SIGUSR2</SystemItem> signal, it rereads the types file.
|
||||
The
|
||||
<Command>ttsession</Command> utility takes the standard action for all other signals.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>STDOUT</Title>
|
||||
<Para>When the
|
||||
<Literal>−v</Literal> option is used,
|
||||
<Command>ttsession</Command> writes the version number in an unspecified format.
|
||||
When
|
||||
<Literal>−p</Literal> is used,
|
||||
<Command>ttsession</Command> writes the name of a new process tree session.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>STDERR</Title>
|
||||
<Para>Used only for diagnostic messages and the help message written by the
|
||||
<Literal>−h</Literal> option.
|
||||
</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>When the
|
||||
<Literal>−c</Literal> child process exits,
|
||||
<Command>ttsession</Command> exits with the status of the exited child.
|
||||
Otherwise, the following exit values are returned:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>0</Term>
|
||||
<ListItem>
|
||||
<Para>Normal termination.
|
||||
Without the
|
||||
<Literal>−c</Literal> or
|
||||
<Literal>−S</Literal> options, a zero exit status means
|
||||
<Command>ttsession</Command> has successfully forked an instance of itself that has begun
|
||||
serving the session.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>1</Term>
|
||||
<ListItem>
|
||||
<Para>Abnormal termination.
|
||||
The
|
||||
<Command>ttsession</Command> utility was given invalid command line options, was interrupted by
|
||||
<SystemItem Class="Constant">SIGINT</SystemItem>, or encountered some internal error.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>2</Term>
|
||||
<ListItem>
|
||||
<Para>Collision.
|
||||
Another
|
||||
<Command>ttsession</Command> was found to be serving the session already.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>CONSEQUENCES OF ERRORS</Title>
|
||||
<![ %CDE.C.XO; [
|
||||
<Para>Default.
|
||||
</Para>
|
||||
]]>
|
||||
<![ %CDE.C.CDE; [
|
||||
<Para>The
|
||||
<Command>ttsession</Command> utility takes the standard action for all signals.
|
||||
</Para>
|
||||
]]>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>APPLICATION USAGE</Title>
|
||||
<Para>Since everything after
|
||||
<Literal>−c</Literal> on the command line is used as the command to be executed,
|
||||
<Literal>−c</Literal> should be the last option.
|
||||
</Para>
|
||||
<Para>Tracing is helpful for seeing how messages are
|
||||
dispatched and delivered, but the output may be voluminous.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>EXAMPLES</Title>
|
||||
<Para>None.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE ALSO</Title>
|
||||
<Para>&cdeman.tt.type.comp;, &cdeman.tt.message.file;.</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->
|
||||
449
cde/doc/C/guides/man/man1/tttar.sgm
Normal file
449
cde/doc/C/guides/man/man1/tttar.sgm
Normal file
@@ -0,0 +1,449 @@
|
||||
<!-- $XConsortium: tttar.sgm /main/11 1996/10/30 16:32: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. -->
|
||||
<![ %CDE.C.CDE; [<refentry id="CDEMX.XCDI.MAN7.rsml.1">]]><![ %CDE.C.XO; [<RefEntry Id="XCDI.MAN7.rsml.1">]]><refmeta>
|
||||
<refentrytitle>tttar</refentrytitle><manvolnum>user cmd</manvolnum></refmeta><refnamediv>
|
||||
<refname><command>tttar</command></refname><refpurpose>process files and ToolTalk
|
||||
objects in an archive</refpurpose></refnamediv><!-- $XConsortium: tttar.sgm
|
||||
/main/4 1995/08/30 23:36:18 rws $--><!-- 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>tttar c</command><arg>t</arg><arg>x</arg><arg choice="opt">EfhpSv</arg><arg choice="opt"><replaceable>tarfile</replaceable></arg><arg><replaceable>pathname</replaceable></arg><arg>. . .</arg>
|
||||
</cmdsynopsis>
|
||||
<cmdsynopsis>
|
||||
<command>tttar c</command><arg>t</arg><arg>xfL</arg><arg choice="opt">EhpRSv</arg><arg><replaceable>tttarfile</replaceable></arg><group><group><arg>−rename <replaceable>oldname</replaceable></arg><arg><replaceable>newname</replaceable></arg></group>
|
||||
<arg>. . .</arg></group><arg><replaceable>pathname</replaceable></arg>
|
||||
<arg>. . .</arg>
|
||||
</cmdsynopsis>
|
||||
<cmdsynopsis>
|
||||
<command>tttar</command><arg>−h</arg><arg>−help</arg>
|
||||
</cmdsynopsis>
|
||||
<cmdsynopsis>
|
||||
<command>tttar</command><arg>−v</arg>
|
||||
</cmdsynopsis>
|
||||
</refsynopsisdiv><refsect1>
|
||||
<title>DESCRIPTION</title>
|
||||
<para>The <command>tttar</command> utility has two fundamentally different
|
||||
modes.</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>Without the <Literal>L</Literal> function modifier, <command>tttar</command>
|
||||
acts as a ToolTalk-aware wrapper for <command>tar</command>(1), archiving (or
|
||||
extracting) multiple files and their ToolTalk objects onto (or from) a single
|
||||
archive, called a <emphasis>tarfile</emphasis>.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>With the <Literal>L</Literal> function modifier, <command>tttar</command>
|
||||
does not invoke <command>tar</command> to archive actual files, but instead
|
||||
archives (or extracts) only ToolTalk objects onto (or from) a single archive,
|
||||
called a <emphasis>tttarfile</emphasis>. Since without the <Literal>L</Literal>
|
||||
function modifier <command>tttar</command> acts like an ToolTalk-aware <command>tar</command>(1), the description below is phrased as if the <Literal>L</Literal>
|
||||
function modifier is in effect. That is, the text refers to <emphasis>tttarfiles</emphasis> instead of <emphasis>tarfiles</emphasis>, and it describes archiving
|
||||
and de-archiving only ``the ToolTalk objects of the named files'' rather than
|
||||
archiving and de-archiving both ``the named files and their ToolTalk objects.''
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
<para>The actions of <command>tttar</command> are controlled by the first
|
||||
argument, the <symbol role="Variable">key</symbol>, a string of characters
|
||||
containing exactly one function letter from the set <literal>ctx</literal>,
|
||||
and one or more of the optional function modifiers listed under <Symbol>OPERANDS</Symbol>. Other arguments to <command>tttar</command> are file or
|
||||
directory names that specify which files to archive or extract ToolTalk objects
|
||||
for. By default, the appearance of a directory name refers recursively to
|
||||
the files and subdirectories of that directory.</para>
|
||||
<para>A file does not have to exist for a ToolTalk object to be associated
|
||||
with its pathname. When <command>tttar</command> descends into a directory,
|
||||
it does not attempt to archive the objects associated with any files that
|
||||
do not exist in the directory.</para>
|
||||
<para>When extracting from a <command>tar</command> archive that is given
|
||||
to <command>tttar</command> either on magnetic tape or on the standard input,
|
||||
the current working directory must be writable, so that the <emphasis>tttarfile</emphasis> can be placed there temporarily.</para>
|
||||
</refsect1><refsect1>
|
||||
<title>OPTIONS</title><![ %CDE.C.XO; [<Para>The
|
||||
<Command>tttar</Command> utility supports the &str-Zu;,
|
||||
except that the
|
||||
<Literal>−help</Literal> and
|
||||
<Literal>−rename</Literal> options are full words, which cannot be combined
|
||||
with the other options, and
|
||||
<Literal>−rename</Literal> can only be used after
|
||||
the first operand,
|
||||
<Emphasis>tttarfile</Emphasis>.</Para>
|
||||
]]>
|
||||
<para>The following options are available:</para>
|
||||
<variablelist>
|
||||
<varlistentry><term><literal>−h</literal></term>
|
||||
<listitem>
|
||||
<para></para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry><term><literal>−help</literal></term>
|
||||
<listitem>
|
||||
<para>Write a help message for invoking <command>tttar</command> and then
|
||||
exit.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry><term><literal>−rename</literal><emphasis> oldname newname</emphasis></term>
|
||||
<listitem>
|
||||
<para>Interpret the next two arguments as an <emphasis>oldname</emphasis>
|
||||
and a <emphasis>newname</emphasis>, respectively, and rename any entry archived
|
||||
as <emphasis>oldname</emphasis> to <emphasis>newname</emphasis>. If <emphasis>oldname</emphasis> is a directory, then <command>tttar</command> recursively
|
||||
renames the entries as well. If more than one <literal>−rename</literal>
|
||||
option applies to an entry (because of one or more parent directories being
|
||||
renamed), the most specific <literal>−rename</literal> option applies.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry><term><literal>−v</literal></term>
|
||||
<listitem>
|
||||
<para>Write the version number of <command>tttar</command> and then exit.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1><refsect1>
|
||||
<title>OPERANDS</title>
|
||||
<para>The following operands are supported:</para>
|
||||
<variablelist>
|
||||
<varlistentry><term><symbol role="Variable">key</symbol></term>
|
||||
<listitem>
|
||||
<para>The <symbol role="Variable">key</symbol> operand consists of a function
|
||||
letter followed immediately by zero or more modifying letters.</para>
|
||||
<para>The function letter is one of the following:</para>
|
||||
<variablelist>
|
||||
<varlistentry><term><literal>c</literal></term>
|
||||
<listitem>
|
||||
<para>Create a new archive and write the ToolTalk objects of the named files
|
||||
onto it.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry><term><literal>t</literal></term>
|
||||
<listitem>
|
||||
<para>Write to standard output the names of all the files in the archive.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry><term><literal>x</literal></term>
|
||||
<listitem>
|
||||
<para>Extract the ToolTalk objects of the named files from the archive. If
|
||||
a named file matches a directory with contents in the archive, this directory
|
||||
is (recursively) extracted. The owner and modification time of the ToolTalk
|
||||
objects are restored (if possible). If no
|
||||
<symbol role="Variable">filename</symbol> arguments are given, the ToolTalk objects of all files named in
|
||||
the archive are extracted.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<para>The following characters can be appended to the function letter. Appending
|
||||
the same character more than once produces undefined results.</para>
|
||||
<variablelist>
|
||||
<varlistentry><term><literal>f</literal></term>
|
||||
<listitem>
|
||||
<para>Use the next argument as the name of the <emphasis>tttarfile</emphasis>.
|
||||
If <emphasis>tttarfile</emphasis> is given as `<literal>−</literal>', <command>tttar</command> writes to the standard output or reads from the standard input,
|
||||
whichever is appropriate.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry><term><literal>h</literal></term>
|
||||
<listitem>
|
||||
<para>Follow symbolic links as if they were normal files or directories. Normally, <command>tttar</command> does not follow symbolic links.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry><term><literal>p</literal></term>
|
||||
<listitem>
|
||||
<para>Preserve. Restore the named files to their original modes, ignoring
|
||||
the present <emphasis>umask</emphasis> value (see <function>umask</function>(2)). <![ %CDE.C.CDE; [The <command>tttar</command> utility also extracts setUID and sticky information for the
|
||||
super-user. This option is only useful with the <literal>x</literal> function
|
||||
letter, and has no meaning if the <Literal>L</Literal> function letter is
|
||||
given. ]]></para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry><term><Literal>L</Literal></term>
|
||||
<listitem>
|
||||
<para>Do not invoke <command>tar</command>(1). <![ %CDE.C.CDE; [This modifier
|
||||
must be used with the <literal>f</literal> function modifier, since reading
|
||||
and writing an <command>tttar</command> archive directly to or from magnetic
|
||||
tape is unimplemented. ]]></para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry><term><Literal>R</Literal></term>
|
||||
<listitem>
|
||||
<para>Do not recurse into directories. <![ %CDE.C.CDE; [This modifier is valid
|
||||
only with the <Literal>L</Literal> function modifier. ]]></para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry><term><literal>v</literal></term>
|
||||
<listitem>
|
||||
<para>Verbose. Write to standard error the name of each file processed, preceded
|
||||
by a string indicating the operation being performed, as follows:</para>
|
||||
<informaltable remap="center" orient="port">
|
||||
<tgroup cols="2" colsep="0" rowsep="0">
|
||||
<colspec align="left" colwidth="140*">
|
||||
<colspec align="left" colwidth="316*">
|
||||
<tbody>
|
||||
<row>
|
||||
<entry align="left" valign="top"><literal>Key Letter</literal></entry>
|
||||
<entry align="left" valign="top"><structname role="typedef">String</structname></entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry align="left" valign="top">c</entry>
|
||||
<entry align="left" valign="top">"a "</entry></row>
|
||||
<row>
|
||||
<entry align="left" valign="top">x</entry>
|
||||
<entry align="left" valign="top">"x "</entry></row></tbody></tgroup></informaltable>
|
||||
<para>The file name may be followed by additional information, such as the
|
||||
size of the file in the archive or file system, in an unspecified format.
|
||||
When used with the <literal>t</literal> function letter, <literal>v</literal>
|
||||
writes to standard output more information about the archive entries than
|
||||
just the name.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<para><![ %CDE.C.XO; [It is unspecified whether the following functions and modifiers are supported:
|
||||
]]><![ %CDE.C.CDE; [The following functions and modifiers are not supported: ]]></para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>The <literal>r</literal> and <literal>u</literal> function letters of <command>tar</command>(1), for incrementally updating an archive.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>The <Literal>X</Literal> and <Literal>F</Literal> function modifiers
|
||||
and the <literal>−I</literal> option of <command>tar</command>(1), for
|
||||
including or excluding files from being archived based on SCCS status or being
|
||||
listed in a special file.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>The <literal>w</literal> function modifier and the <literal>−C</literal> option of <command>tar</command>(1), for pausing or changing directories
|
||||
between the files listed on the command line.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Writing and reading <emphasis>tttarfiles</emphasis> (that is, archives
|
||||
produced with the <Literal>L</Literal> function modifier) directly to and
|
||||
from magnetic tape.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry><term><symbol role="Variable">pathname</symbol></term>
|
||||
<listitem>
|
||||
<para>A pathname of a regular file or directory to be archived (when the <literal>c</literal> function letter is used), extracted ( <literal>x</literal>) or
|
||||
listed ( <literal>t</literal>). When <symbol role="Variable">pathname</symbol>
|
||||
is the pathname of a directory, the action applies to all of the files and
|
||||
(recursively) subdirectories of that directory. When the <literal>f</literal>
|
||||
letter is used in the <symbol role="Variable">key</symbol> operand, the initial
|
||||
<symbol role="Variable">pathname</symbol> operand is interpreted as an archive name,
|
||||
as described previously.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry><term><emphasis>tarfile</emphasis></term>
|
||||
<listitem>
|
||||
<para>A pathname of a regular file to be read or written as an archive of
|
||||
files.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry><term><emphasis>ttarfile</emphasis></term>
|
||||
<listitem>
|
||||
<para>A pathname of a regular file to be read or written as an archive of
|
||||
ToolTalk objects.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1><refsect1>
|
||||
<title>STDIN</title>
|
||||
<para>When the <literal>f</literal> modifier is used with the <literal>t</literal>
|
||||
or <literal>x</literal> function letter and the pathname is −, the standard
|
||||
input is an archive file formatted as described in <literal>EXTENDED DESCRIPTION</literal>. Otherwise, the standard input is not used.</para>
|
||||
</refsect1><refsect1>
|
||||
<title>INPUT FILES</title>
|
||||
<para>The files identified by the <symbol role="Variable">pathname</symbol>
|
||||
operands are regular files or directories. The file identified by the <emphasis>tarfile</emphasis> operand is a regular file formatted as described in <![ %CDE.C.CDE; [ <command>tar</command>(1). ]]><![ %CDE.C.XO; [<Command>tar</Command> in the &str-ZC;.
|
||||
]]>The file identified by the <emphasis>tttarfile</emphasis> operand is a
|
||||
regular file formatted as described in <literal>EXTENDED DESCRIPTION</literal>.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>ENVIRONMENT VARIABLES</title>
|
||||
<para>The following environment variables affect the execution of <command>tttar</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>
|
||||
<varlistentry><term><systemitem class="EnvironVar">TZ</systemitem></term>
|
||||
<listitem>
|
||||
<para>Determine the timezone used with date and time strings.</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>tttar</command> utility takes the standard
|
||||
action for all signals.</para>]]></refsect1><refsect1>
|
||||
<title>STDOUT</title>
|
||||
<para>When the <literal>−h</literal> option is used, <command>tttar</command> writes to standard output a help message in an unspecified format.
|
||||
</para>
|
||||
<para>When the <literal>−v</literal> option is used, <command>tttar</command> writes to standard output a version number in an unspecified format.
|
||||
</para>
|
||||
<para>When the <literal>f</literal> modifier is used with the <literal>c</literal>
|
||||
function letter and the pathname is −, the standard output is an archive
|
||||
file formatted as described in <literal>EXTENDED DESCRIPTION</literal>.</para>
|
||||
<para>Otherwise, the standard output is not used.</para>
|
||||
</refsect1><refsect1>
|
||||
<title>STDERR</title>
|
||||
<para>The standard error is used for diagnostic messages and the file name
|
||||
output described under the <literal>v</literal> modifier (when the <literal>t</literal> function letter is not used).</para>
|
||||
</refsect1><refsect1>
|
||||
<title>OUTPUT FILES</title>
|
||||
<para>Output files are created, as specified by the archive, when the <literal>x</literal> function letter is used.</para>
|
||||
</refsect1><refsect1>
|
||||
<title>EXTENDED DESCRIPTION</title>
|
||||
<para>The archive file produced and read by <command>tttar</command> is formatted
|
||||
as described in <command>tar</command>(1), with the addition of one extra file
|
||||
named <literal>tttarfile</literal>. (If one of the user files being archived
|
||||
is also named <literal>tttarfile</literal>, the results are unspecified.)
|
||||
The <literal>tttarfile</literal> contains all the ToolTalk <symbol role="Variable">spec</symbol> information for the ToolTalk objects in the other files in the
|
||||
archive. The contents of <literal>tttarfile</literal> are written according
|
||||
to the referenced XDR specification (RFC 1014). The only XDR data types used
|
||||
are:</para>
|
||||
<variablelist>
|
||||
<varlistentry><term><StructName Role="typedef">int</StructName></term>
|
||||
<listitem>
|
||||
<para>A four-octet signed integer, most significant octet first</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry><term><literal>string</literal></term>
|
||||
<listitem>
|
||||
<para>A four-octet unsigned integer length, most significant octet first,
|
||||
followed by the characters of the string, followed by sufficient (0 to 3)
|
||||
residual zero octets to make the total number of octets a multiple of four.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<para>The <literal>tttarfile</literal> starts with two integers. The first
|
||||
is always 1, to mark this as the header record. The second is always 1, indicating
|
||||
this is version 1 of the <emphasis>tttarfile</emphasis> format. <![ %CDE.C.CDE; [Any
|
||||
future revisions of the <emphasis>tttarfile</emphasis> format should increment
|
||||
the version number so older programs processing the <emphasis>tttarfile</emphasis>
|
||||
can diagnose the incompatibility. ]]></para>
|
||||
<para>The end of the <literal>tttarfile</literal> is a integer 3, marking
|
||||
the end-of-file record.</para>
|
||||
<para>In between, there is one logical record for each spec. Each logical
|
||||
record starts with an integer 2, marking it as a spec record. Other integer
|
||||
values are reserved for assignment to future data types.</para>
|
||||
<para>After the record identifier, the spec record contains, in sequence:
|
||||
</para>
|
||||
<orderedlist>
|
||||
<listitem>
|
||||
<para>A string giving the Tooltalk object identifier (<emphasis>objid</emphasis>)
|
||||
of the object represented by the spec</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>A string giving the name of the file (as found in the archive table
|
||||
of contents) that contains the contents of the ToolTalk object represented
|
||||
by the spec</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>A string giving the ToolTalk object type identifier (<emphasis>otid</emphasis>) of the ToolTalk object represented by the spec</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>An integer giving the number of properties for this object</para>
|
||||
</listitem>
|
||||
</orderedlist>
|
||||
<para>The properties of the object immediately follow the number of properties.
|
||||
Each property consists of:</para>
|
||||
<orderedlist>
|
||||
<listitem>
|
||||
<para>A string giving the name of the property</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>An integer, which is always zero (for historical compatibility)</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>An integer giving the number of values for this property</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>A string for each value</para>
|
||||
</listitem>
|
||||
</orderedlist>
|
||||
<para>After the values, the next property is found, until all properties for
|
||||
the object have been accounted for; then the next spec is found, until all
|
||||
specs for objects associated with files in the archive are accounted for.
|
||||
</para>
|
||||
</refsect1><refsect1>
|
||||
<title>EXIT STATUS</title>
|
||||
<para>The following exit values are returned:</para>
|
||||
<variablelist>
|
||||
<varlistentry><term>0</term>
|
||||
<listitem>
|
||||
<para>All files and ToolTalk objects were moved successfully.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry><term>>0</term>
|
||||
<listitem>
|
||||
<para>An error occurred or the invoked <command>tar</command>(1) command exited
|
||||
with a non-zero value.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1><refsect1>
|
||||
<title>CONSEQUENCES OF ERRORS</title>
|
||||
<para>Default.</para>
|
||||
</refsect1><![ %CDE.C.CDE; [<refsect1>
|
||||
<title>FILES</title>
|
||||
<variablelist>
|
||||
<varlistentry><term>/mountpoint/TT_DB</term>
|
||||
<listitem>
|
||||
<!-- ex-TP-->
|
||||
<para>The directory used as a database for the ToolTalk objects of files in
|
||||
the file system mounted at <emphasis>/mountpoint</emphasis>.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>]]><refsect1>
|
||||
<title>APPLICATION USAGE</title>
|
||||
<para>None.</para>
|
||||
</refsect1><refsect1>
|
||||
<title>EXAMPLES</title>
|
||||
<para>None.</para>
|
||||
</refsect1><refsect1>
|
||||
<title>SEE ALSO</title><![ %CDE.C.CDE; [<para><command>tar</command>(1), <?Pub Caret></para>]]><![ %CDE.C.XO; [<Para><Command>tar</Command> in the &str-ZC;;
|
||||
</Para>
|
||||
]]>
|
||||
<para>&cdeman.ttcp;, &cdeman.ttsession;.</para>
|
||||
</refsect1></refentry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.2 08/07/95 23:18:47-->
|
||||
<?Pub *0000050473>
|
||||
488
cde/doc/C/guides/man/man1/tttrace.sgm
Normal file
488
cde/doc/C/guides/man/man1/tttrace.sgm
Normal file
@@ -0,0 +1,488 @@
|
||||
<!-- $XConsortium: tttrace.sgm /main/11 1996/10/30 16:33: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.MAN38.rsml.1" Remap="">
|
||||
<RefMeta>
|
||||
<RefEntryTitle>tttrace</RefEntryTitle>
|
||||
<ManVolNum>user cmd</ManVolNum>
|
||||
</RefMeta>
|
||||
<RefNameDiv>
|
||||
<RefName><Command>tttrace</Command></RefName>
|
||||
<RefPurpose>trace ToolTalk calls and messages
|
||||
</RefPurpose>
|
||||
</RefNameDiv>
|
||||
<!-- $XConsortium: tttrace.sgm /main/11 1996/10/30 16:33:07 rws $-->
|
||||
<!-- (c) Copyright 1993, 1994 Sun Microsystems, Inc.-->
|
||||
<!-- (c) Copyright 1993, 1994 Hewlett-Packard Company-->
|
||||
<!-- (c) Copyright 1993, 1994 International Business Machines Corp.-->
|
||||
<!-- (c) Copyright 1993, 1994 Novell, Inc.-->
|
||||
<RefSynopsisDiv>
|
||||
<CmdSynopsis>
|
||||
<Command>tttrace</Command>
|
||||
<Arg Choice="opt">-0FCa</Arg>
|
||||
<Arg Choice="opt">-o<Replaceable>outfile</Replaceable></Arg>
|
||||
<Group>
|
||||
<Arg>-S<Replaceable>session</Replaceable></Arg>
|
||||
<Arg><Replaceable>command</Replaceable></Arg>
|
||||
</Group>
|
||||
</CmdSynopsis>
|
||||
<CmdSynopsis>
|
||||
<Command>tttrace</Command>
|
||||
<Group>
|
||||
<Arg>-e<Replaceable>script</Replaceable></Arg>
|
||||
<Arg>-f<Replaceable>scriptfile</Replaceable></Arg>
|
||||
</Group>
|
||||
<Group>
|
||||
<Arg>-S<Replaceable>session</Replaceable></Arg>
|
||||
<Arg><Replaceable>command</Replaceable></Arg>
|
||||
</Group>
|
||||
</CmdSynopsis>
|
||||
</RefSynopsisDiv>
|
||||
<RefSect1>
|
||||
<Title>DESCRIPTION</Title>
|
||||
<Para><Command>tttrace</Command> traces message traffic through the server for the indicated ToolTalk
|
||||
<Emphasis>session</Emphasis>, or runs
|
||||
<Symbol Role="Variable">command</Symbol> with ToolTalk client tracing turned on. If neither
|
||||
<Emphasis>session</Emphasis> nor
|
||||
<Symbol Role="Variable">command</Symbol> is given, the default session is traced. By default, tracing
|
||||
terminates when
|
||||
<Command>tttrace</Command> exits.
|
||||
</Para>
|
||||
<Para>Tracing of ToolTalk functions looks like this:
|
||||
[<Emphasis>pid</Emphasis>] <Symbol Role="Variable">function_name</Symbol>(<Symbol Role="Variable">params</Symbol>) = <Emphasis>return_value</Emphasis> (<StructName Role="typedef">Tt_status</StructName>)
|
||||
</Para>
|
||||
<Para>With the
|
||||
<Literal>-a</Literal> option, message attributes are printed after a one-line summary
|
||||
of the message:
|
||||
<Emphasis>Tt_state Tt_paradigm Tt_class</Emphasis> (<StructName Role="typedef">Tt_disposition</StructName> in <StructName Role="typedef">Tt_scope</StructName>): <Symbol Role="Variable">status</Symbol> == <StructName Role="typedef">Tt_status</StructName>
|
||||
</Para>
|
||||
<Para>State changes are indicated by:
|
||||
<Emphasis>old_state</Emphasis> => <Emphasis>new_state</Emphasis>.
|
||||
</Para>
|
||||
<Para>Deliveries are indicated by:
|
||||
Tt_message => procid <<Emphasis>recipient_procid</Emphasis>>
|
||||
</Para>
|
||||
<Para>When dispatching is being traced, the reason for each dispatch
|
||||
is one of:
|
||||
</Para>
|
||||
<Para><Symbol>tt_message_send</Symbol>()</Para>
|
||||
<Para><Symbol>tt_message_reject</Symbol>()</Para>
|
||||
<Para><Symbol>tt_message_fail</Symbol>()</Para>
|
||||
<Para><Symbol>tt_message_reply</Symbol>()</Para>
|
||||
<Para><Symbol>tt_session_join</Symbol>()</Para>
|
||||
<Para><Symbol>tt_file_join</Symbol>()</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>tt_message_reply ()</Term>
|
||||
<ListItem>
|
||||
<!-- ex-TP-->
|
||||
<Para>A client called the indicated function.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>tt_message_send_on_exit ()</Term>
|
||||
<ListItem>
|
||||
<!-- ex-TP-->
|
||||
<Para><Command>ttsession</Command> is dispatching on_exit messages for a client that
|
||||
disconnected before calling
|
||||
<Symbol>tt_close</Symbol>().</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>tt_message_accept ()</Term>
|
||||
<ListItem>
|
||||
<!-- ex-TP-->
|
||||
<Para><Command>ttsession</Command> is dispatching messages that had been blocked while
|
||||
a ptype was being started. The started client has now called
|
||||
either
|
||||
<Symbol>tt_message_accept</Symbol>() or
|
||||
<Symbol>tt_message_reply</Symbol>() to indicate that the ptype should be unblocked.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>TT_ERR_PTYPE_START</Term>
|
||||
<ListItem>
|
||||
<!-- ex-TP-->
|
||||
<Para>A ptype instance was started to receive the message, but the
|
||||
start command exited before it connected to
|
||||
<Command>ttsession</Command>.</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>TT_ERR_PROCID</Term>
|
||||
<ListItem>
|
||||
<!-- ex-TP-->
|
||||
<Para><Command>ttsession</Command> lost its connection to the client that was working on this request.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>ttsession -> ttsession</Term>
|
||||
<ListItem>
|
||||
<!-- ex-TP-->
|
||||
<Para>Another session wants this session to find recipients for the message.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>ttsession <- ttsession</Term>
|
||||
<ListItem>
|
||||
<!-- ex-TP-->
|
||||
<Para>Another session wants to update (e.g. fail) a message originating in this
|
||||
session.
|
||||
</Para>
|
||||
<Para>When dispatching is being traced, matching is indicated by one of
|
||||
Tt_message & Tt_pattern {
|
||||
Tt_message & ptype <Emphasis>ptid</Emphasis> {
|
||||
Tt_message & otype <Emphasis>otid</Emphasis> {
|
||||
</Para>
|
||||
<Para>The pattern or signature is printed, followed by
|
||||
} == <Emphasis>match_score</Emphasis>; [/* <Emphasis>mismatch_reason</Emphasis> */]
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>OPTIONS</Title>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>-0</Term>
|
||||
<ListItem>
|
||||
<!-- ex-TP-->
|
||||
<Para>Turn off message tracing in
|
||||
<Emphasis>session</Emphasis>, or run
|
||||
<Symbol Role="Variable">command</Symbol> without message tracing (i.e., with only call tracing).
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>-F</Term>
|
||||
<ListItem>
|
||||
<!-- ex-TP-->
|
||||
<Para>Follow all children forked by
|
||||
<Symbol Role="Variable">command</Symbol> or subsequently started in
|
||||
<Emphasis>session</Emphasis> by
|
||||
<Command>ttsession</Command>. Normally, only the indicated
|
||||
<Symbol Role="Variable">command</Symbol> or
|
||||
<Command>ttsession</Command> instance is traced. When
|
||||
<Literal>-F</Literal> is specified, the process id is included with each line of trace
|
||||
output to indicate which process generated it.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>-C</Term>
|
||||
<ListItem>
|
||||
<!-- ex-TP-->
|
||||
<Para>Do not trace client calls into the ToolTalk API. Default is
|
||||
to trace them.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>-a</Term>
|
||||
<ListItem>
|
||||
<!-- ex-TP-->
|
||||
<Para>Print all attributes, arguments, and context slots of traced messages.
|
||||
The default is to use only a single line when printing a message on
|
||||
the trace output.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>-e script</Term>
|
||||
<ListItem>
|
||||
<!-- ex-TP-->
|
||||
<Para>Take
|
||||
<Emphasis>script</Emphasis> as a
|
||||
<Command>tttrace</Command> setting. See
|
||||
&cdeman.tttracefile;.</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>-f scriptfile</Term>
|
||||
<ListItem>
|
||||
<!-- ex-TP-->
|
||||
<Para>File to read
|
||||
<Command>tttrace</Command> settings from. See
|
||||
&cdeman.tttracefile;. <Literal>-f</Literal> <Literal>-</Literal> causes
|
||||
<Command>tttrace</Command> to read standard input until EOF, which may prevent
|
||||
<Symbol Role="Variable">command</Symbol> from using standard input.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>-o outfile</Term>
|
||||
<ListItem>
|
||||
<!-- ex-TP-->
|
||||
<Para>File to be used for the trace output.
|
||||
</Para>
|
||||
<Para>For session tracing, output goes to standard output of
|
||||
<Command>tttrace</Command>.</Para>
|
||||
<Para>For client tracing, output goes by default to standard error of
|
||||
<Command>tttrace</Command>. For client tracing,
|
||||
<Literal>-o</Literal> <Literal>-</Literal> causes trace output to go to standard output of
|
||||
<Command>tttrace</Command>.</Para>
|
||||
<Para>If the
|
||||
server for
|
||||
<Emphasis>session</Emphasis> is running on a remote host and either
|
||||
</Para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<Para><Emphasis>outfile</Emphasis> is not mounted on that host, or
|
||||
</Para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<Para>the <Literal>-o</Literal> option is omitted,
|
||||
</Para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
<Para>then
|
||||
<Command>tttrace</Command> will fail.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>-S session</Term>
|
||||
<ListItem>
|
||||
<!-- ex-TP-->
|
||||
<Para>Session to trace. Defaults to the
|
||||
<Symbol Role="Variable">default</Symbol> <Emphasis>session</Emphasis> -- the session that <ComputerOutput>tt_open()</ComputerOutput> would contact.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>command</Term>
|
||||
<ListItem>
|
||||
<!-- ex-TP-->
|
||||
<Para>The ToolTalk client command to invoke and trace.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>EXAMPLES</Title>
|
||||
<Para>Here we trace a client that registers a pattern and sends a notice
|
||||
that matches it:
|
||||
</Para>
|
||||
<Screen>% tttrace -a <Emphasis>myclientprogram</Emphasis>
|
||||
tt_open() = 0x51708=="7.jOHHM X 129.144.153.55 0" (TT_OK)
|
||||
tt_fd() = 11 (TT_OK)
|
||||
tt_pattern_create() = 0x50318 (TT_OK)
|
||||
tt_pattern_category_set(0x50318, TT_OBSERVE) = 0 (TT_OK)
|
||||
tt_pattern_scope_add(0x50318, TT_SESSION) = 0 (TT_OK)
|
||||
tt_pattern_op_add(0x50318, 0x2f308=="Hello World") = 0 (TT_OK)
|
||||
tt_default_session() = 0x519e0=="X 129.144.153.55 0" (TT_OK)
|
||||
tt_pattern_session_add(0x50318, 0x519e0=="X 129.144.153.55 0") = 0 (TT_OK)
|
||||
tt_pattern_register(0x50318) = 0 (TT_OK)
|
||||
tt_message_create() = 0x51af0 (TT_OK)
|
||||
tt_message_class_set(0x51af0, TT_NOTICE) = 0 (TT_OK)
|
||||
tt_message_address_set(0x51af0, TT_PROCEDURE) = 0 (TT_OK)
|
||||
tt_message_scope_set(0x51af0, TT_SESSION) = 0 (TT_OK)
|
||||
tt_message_op_set(0x51af0, 0x2f308=="Hello World") = 0 (TT_OK)
|
||||
tt_message_send(0x51af0) ...
|
||||
TT_CREATED => TT_SENT:
|
||||
TT_SENT TT_PROCEDURE TT_NOTICE (TT_DISCARD in TT_SESSION): 0 == TT_OK
|
||||
id: 0 7.jOHHM X 129.144.153.55 0
|
||||
op: Hello World
|
||||
session: X 129.144.153.55 0
|
||||
sender: 7.jOHHM X 129.144.153.55 0
|
||||
= 0 (TT_OK)
|
||||
tt_message_receive() ...
|
||||
Tt_message => procid <7.jOHHM X 129.144.153.55 0>
|
||||
TT_SENT TT_PROCEDURE TT_NOTICE (TT_DISCARD in TT_SESSION): 0 == TT_OK
|
||||
id: 0 7.jOHHM X 129.144.153.55 0
|
||||
op: Hello World
|
||||
session: X 129.144.153.55 0
|
||||
sender: 7.jOHHM X 129.144.153.55 0
|
||||
pattern: 0:7.jOHHM X 129.144.153.55 0
|
||||
= 0x51af0 (TT_OK)
|
||||
</Screen>
|
||||
<Para><Command>ttsession</Command>'s view of this traffic can be seen as follows. Note that the first message
|
||||
traced will almost always be
|
||||
<Command>ttsession</Command>'s reply to the request sent it by
|
||||
<Command>tttrace</Command>.</Para>
|
||||
<Screen>% <Command>tttrace</Command> -a
|
||||
tt_message_reply:
|
||||
TT_SENT => TT_HANDLED:
|
||||
TT_HANDLED TT_PROCEDURE TT_REQUEST (TT_DISCARD in TT_SESSION): 0 == TT_OK
|
||||
id: 0 2.jOHHM X 129.144.153.55 0
|
||||
op: Session_Trace
|
||||
args:
|
||||
TT_IN string: "> /tmp/traceAAAa002oL; version 1; states"[...]
|
||||
session: X 129.144.153.55 0
|
||||
sender: 2.jOHHM X 129.144.153.55 0
|
||||
pattern: 0:X 129.144.153.55 0
|
||||
handler: 0.jOHHM X 129.144.153.55 0
|
||||
Tt_message => procid <2.jOHHM X 129.144.153.55 0>
|
||||
tt_message_send:
|
||||
TT_CREATED TT_PROCEDURE TT_NOTICE (TT_DISCARD in TT_SESSION): 0 == TT_OK
|
||||
id: 0 7.jOHHM X 129.144.153.55 0
|
||||
op: Hello World
|
||||
session: X 129.144.153.55 0
|
||||
sender: 7.jOHHM X 129.144.153.55 0
|
||||
TT_CREATED => TT_SENT:
|
||||
TT_SENT TT_PROCEDURE TT_NOTICE (TT_DISCARD in TT_SESSION): 0 == TT_OK
|
||||
id: 0 7.jOHHM X 129.144.153.55 0
|
||||
op: Hello World
|
||||
session: X 129.144.153.55 0
|
||||
sender: 7.jOHHM X 129.144.153.55 0
|
||||
Tt_message & Tt_pattern {
|
||||
id: 0:7.jOHHM X 129.144.153.55 0
|
||||
category: TT_OBSERVE
|
||||
scopes: TT_SESSION
|
||||
sessions: X 129.144.153.55 0
|
||||
ops: Hello World
|
||||
} == 3;
|
||||
Tt_message => procid <7.jOHHM X 129.144.153.55 0>
|
||||
</Screen>
|
||||
<Para>To trace message flow in a specific, non-default session,
|
||||
</Para>
|
||||
<Screen>% tttrace -S "01 15303 1342177284 1 0 13691 129.144.153.55 2"
|
||||
</Screen>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>ENVIRONMENT</Title>
|
||||
<Para><Command>tttrace</Command> is implemented purely as a ToolTalk client, using the message
|
||||
interface to
|
||||
<Command>ttsession</Command> and the following environmental hook into libtt.
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>TT_TRACE_SCRIPT</Term>
|
||||
<ListItem>
|
||||
<!-- ex-TP-->
|
||||
<Para>If set, tells libtt to turn on client-side tracing as specified in
|
||||
the trace script. If the first character of of the value is '.' or '/',
|
||||
the value is taken to be the pathname of file containing the trace script
|
||||
to use. Otherwise, the value is taken to be an inline trace script.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>FILES</Title>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>$TMPDIR/tttrace.nnn</Term>
|
||||
<ListItem>
|
||||
<!-- ex-TP-->
|
||||
<Para>A
|
||||
<Emphasis>named</Emphasis> <Emphasis>pipe</Emphasis> (see
|
||||
<Filename MoreInfo="RefEntry">mkfifo</Filename>(3C)) in <Symbol>$TMPDIR</Symbol> (see
|
||||
<Filename MoreInfo="RefEntry">tempnam</Filename>(3S)) from which trace output for
|
||||
<Emphasis>session</Emphasis> is read when the
|
||||
<Literal>-o</Literal> option is omitted.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>WARNINGS</Title>
|
||||
<Para>Since (with the
|
||||
<Literal>-F</Literal> option) tracing can follow clients to remote hosts if the environment
|
||||
is properly propagated, it is possible for different processes in
|
||||
the same trace output to be labeled with the same process id.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>SEE</Title>
|
||||
<Para>&cdeman.ttsession;, &cdeman.tttracefile;, the
|
||||
<Literal>Session_Trace</Literal>() ToolTalk request
|
||||
</Para>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>DIAGNOSTICS</Title>
|
||||
<Para>If
|
||||
<Symbol Role="Variable">command</Symbol> is run, then
|
||||
<Command>tttrace</Command> will exit with the exit status of
|
||||
<Symbol Role="Variable">command</Symbol>. Otherwise, exit codes are as follows:
|
||||
</Para>
|
||||
<VariableList>
|
||||
<VarListEntry>
|
||||
<Term>0</Term>
|
||||
<ListItem>
|
||||
<!-- ex-TP-->
|
||||
<Para>Normal termination. Any
|
||||
<Emphasis>session</Emphasis> tracing turned on by this invocation of
|
||||
<Command>tttrace</Command> has now been turned off.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>1</Term>
|
||||
<ListItem>
|
||||
<!-- ex-TP-->
|
||||
<Para>Usage.
|
||||
<Command>tttrace</Command> was given invalid command line options.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>2</Term>
|
||||
<ListItem>
|
||||
<!-- ex-TP-->
|
||||
<Para>Failure.
|
||||
<Command>tttrace</Command> encountered an error while trying to do its job. An error
|
||||
message has been emitted on standard error.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>3</Term>
|
||||
<ListItem>
|
||||
<!-- ex-TP-->
|
||||
<Para>Runaway
|
||||
<Emphasis>session</Emphasis> tracing.
|
||||
<Command>tttrace</Command> could not terminate tracing in
|
||||
<Emphasis>session</Emphasis> before exiting.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>4</Term>
|
||||
<ListItem>
|
||||
<!-- ex-TP-->
|
||||
<Para>Remote
|
||||
<Emphasis>session</Emphasis>. <Command>ttsession</Command> is remote, and
|
||||
<Emphasis>outfile</Emphasis> (if given) is not visible there. Choose a visible file,
|
||||
or run
|
||||
<Command>tttrace</Command> on that remote host.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
<VarListEntry>
|
||||
<Term>5</Term>
|
||||
<ListItem>
|
||||
<!-- ex-TP-->
|
||||
<Para>Old
|
||||
<Emphasis>session</Emphasis>. The
|
||||
<Command>ttsession</Command> for
|
||||
<Emphasis>session</Emphasis> does not support the <ComputerOutput>Session_Trace()</ComputerOutput> request. Run
|
||||
<Literal>kill</Literal> <Literal>-USR1</Literal> on it to turn on old-style tracing.
|
||||
</Para>
|
||||
</ListItem>
|
||||
</VarListEntry>
|
||||
</VariableList>
|
||||
</RefSect1>
|
||||
<RefSect1>
|
||||
<Title>NOTES</Title>
|
||||
<Para>For security purposes, client-side tracing is disabled inside a client
|
||||
when its effective uid or gid is different from its real uid or gid
|
||||
and the real uid is not the super-user.
|
||||
</Para>
|
||||
</RefSect1>
|
||||
</RefEntry>
|
||||
<!--fickle 1.12 mancsf-to-docbook 1.3 08/21/95 21:30:04-->
|
||||
Reference in New Issue
Block a user