CDE/cde/doc/C/guides/man/man1/ttrmdir.sgm

<!-- $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">&minus;L</Arg>
<Arg><Replaceable>directory</Replaceable></Arg>
<Arg>.&thinsp;.&thinsp;.</Arg>
</CmdSynopsis>
<CmdSynopsis>
<Command>ttrmdir</Command>
<Arg>&minus;h</Arg>
<Arg>&minus;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>&minus;h</Literal></Term>
<ListItem>
<Para>Write a help message for invoking
<Command>ttrmdir</Command> and then exit.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Literal>&minus;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>&minus;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>&minus;p</Literal> option to
<Command>cp</Command>(1) is supported.
]]><![ %CDE.C.CDE; [The
<Literal>&minus;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>&minus;h</Literal> option is used,
<Command>ttrmdir</Command> writes to standard output a help message
in an unspecified format.
</Para>
<Para>When the
<Literal>&minus;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-->