mirror of
git://git.code.sf.net/p/cdesktopenv/code
synced 2025-03-09 15:50:02 +00:00
293 lines
7.5 KiB
Text
293 lines
7.5 KiB
Text
<!-- $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-->
|