Files
cdesktop/cde/doc/C/guides/man/man1/ttcp.sgm

345 lines
8.9 KiB
Plaintext

<!-- $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">&minus;pL</Arg>
<Arg><Replaceable>filename1</Replaceable></Arg>
<Arg><Replaceable>filename2</Replaceable></Arg>
<!-- -->
</CmdSynopsis>
<CmdSynopsis>
<Command>ttcp</Command>
<Arg>&minus;r</Arg>
<Arg Choice="opt">&minus;pL</Arg>
<Arg><Replaceable>directory1</Replaceable></Arg>
<Arg><Replaceable>directory2</Replaceable></Arg>
<!-- -->
</CmdSynopsis>
<CmdSynopsis>
<Command>ttcp</Command>
<Arg Choice="opt">&minus;prL</Arg>
<Arg><Replaceable>filename</Replaceable></Arg>
<Arg>.&thinsp;.&thinsp;.</Arg>
<Arg><Replaceable>directory</Replaceable></Arg>
<!-- -->
</CmdSynopsis>
<CmdSynopsis>
<Command>ttcp</Command>
<Arg>&minus;h</Arg>
<Arg>&minus;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>&minus;h</Literal></Term>
<ListItem>
<Para>Write a help message for invoking
<Command>ttcp</Command> and then exit.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>&minus;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>&minus;p</Literal></Term>
<ListItem>
<Para>Preserve.
Invoke
<Command>cp</Command>(1) with the
<Literal>&minus;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>&minus;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>&minus;r</Literal> option to
<Command>cp</Command>(1).</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>&minus;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>&minus;f</Literal>, <Literal>&minus;i</Literal> or
<Literal>&minus;R</Literal> options to
<Command>cp</Command>(1) are supported.
]]><![ %CDE.C.CDE; [The
<Literal>&minus;f</Literal>, <Literal>&minus;i</Literal> or
<Literal>&minus;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>&minus;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>&minus;h</Literal> option is used,
<Command>ttcp</Command> writes to standard output a help message
in an unspecified format.
</Para>
<Para>When the
<Literal>&minus;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-->