cde/programs/dtexec/dtexec.man

   1 .\" $XConsortium: dtexec.man /main/2 1995/07/17 10:50:37 drk $
   2 .\" *************************************************************************
   3 .\" **
   4 .\" ** (c) Copyright 1993,1994 Hewlett-Packard Company
   5 .\" **      All Rights Reserved.
   6 .\" **
   7 .\" ** (c) Copyright 1993,1994 International Business Machines Corp.
   8 .\" **      All Rights Reserved.
   9 .\" **
  10 .\" ** (c) Copyright 1993,1994 Sun Microsystems, Inc.
  11 .\" **      All Rights Reserved.
  12 .\" **
  13 .\" *************************************************************************
  14 .TH dtexec 1X "17 Jan 1994"
  15 .BH "17 Jan 1994"
  16 .\"---
  17 .SH NAME
  18 \fBdtexec\fP \(em A "wrapper" program for command lines to
  19 control when the command exits.
  20 .sp 1
  21 .SH SYNOPSIS
  22 .B dtexec <open_option> <command_line>
  23 .nf
  24 .in 10
  25 .fi
  26 .sp 1
  27 .SH DESCRIPTION
  28 Dtexec is used by the Common Desktop Environment (CDE) when
  29 executing terminal-based actions.  Its'
  30 purpose is to keep the terminal window
  31 open after the command terminates in
  32 the following circumstances:
  33 .sp 1
  34 .in 10
  35 - If the action is of type PERM-TERMINAL.
  36 .sp 1
  37 .in 10
  38 - If the action is of type TERMINAL and
  39 the command "quickly" exits, which
  40 indicates that an error occurred.
  41 .P
  42 The "open_option" arguments are:
  43 .sp 1
  44 .in 10
  45 1. "-1" - Keep the window open when
  46 "command_line" terminates.
  47 .sp 1
  48 2. "0" - Unmap the terminal window after
  49 "command_line" terminates.
  50 .sp 1
  51 3. "n" - Keep the terminal window mapped if
  52 "command_line" terminates within "n" seconds of
  53 starting.  The default value is "3" seconds.  To
  54 change the default, set the component's "waitTime"
  55 or "WaitTime" resource.  For example, to change
  56 the CDE File Manager to wait "5" seconds,
  57 set the following resource: "Dtfile*waitTime: 5".
  58 Dtexec does not have any resources.
  59 .P
  60 Dtexec's default path is "/usr/dt/bin".
  61 To change this
  62 location, set the component's "dtexecPath" or
  63 "DtexecPath" resource.  For example, to change
  64 the CDE File Manager's dtexec path to
  65 "/usr/local/bin", set the following resource:
  66 "Dtfile*dtexecPath: /usr/local/bin".
  67
  68 .sp 1
  69 .SH RETURN VALUE
  70 \fBdtexec\fP returns 0 if successful; otherwise it returns 1.
  71 Successful return from dtexec implies system resources were available
  72 to fork and exec the requested command, not that the requested command
  73 itself executed successfully.
  74 .SH NOTES
  75 .PP
  76 This program is not normally invoked directly by application
  77 programs.  Normally an application program will link with the
  78 Desktop Services Library (DtSvc) which will then invoke \fBdtexec\fP
  79 as needed.
  80 .PP
  81 As mentioned above, an application program can set its
  82 \fIwaitTime\fP and \fIDtexecPath\fP resources to affect the behavior
  83 of DtSvc library invocations of \fIdtexec\fP.