home *** CD-ROM | disk | FTP | other *** search
/ Usenet 1994 January / usenetsourcesnewsgroupsinfomagicjanuary1994.iso / sources / x / volume4 / xmtool / part02 / README < prev    next >
Encoding:
Text File  |  1989-06-29  |  4.8 KB  |  116 lines
  1.  
  2.  
  3.                  M A I L     T O O L
  4.  
  5.  
  6. A. Introduction
  7.  
  8. This is an approach that uses the X11 Release 3 Toolkit Intrinsics and Toolkit
  9. Athena Widgets to develop a front end tool for using the ucb mail program.
  10. It has most of the features of the mail program. It is independent of the
  11. MH message handling system. The ucb mail program is the mail program that
  12. has the option -N that does not print initial header summary and the option
  13. -f that indicates the name of the file that replaces the system mailbox.
  14. This mail tool does not apply to the other mail program Mail that does not
  15. have these options.
  16.  
  17. Five files and two subdirectories are provided. They are
  18.  
  19.    ./README     -- This file
  20.    ./xmtool.man -- The manual page for xmtool
  21.    ./Imakefile  -- The Imakefile that builds Makefile
  22.    ./Makefile   -- The Makefile that builds xmtool
  23.    ./xmtool.c   -- The source file for xmtool
  24.    ./bitmap     -- The subdirectory that contains 3 bitmap files
  25.    ./hlp    -- The subdirectory that contains 22 on-line help files
  26.  
  27. The software was developed on a Sun 3/60 under Sun OS 3.5 with color monitor. 
  28. It runs well on a Sun 3/50 with black and white monitor. It also runs well
  29. as a client for X servers running on Apollo, Dec, and Hp workstations.
  30.  
  31.  
  32. B. Makefile and the environment variable XMTOOLRESRC
  33.  
  34. After you extract the sources, you need to do the following in order to get
  35. a workable executable code running:
  36.  
  37. 1. Use imake to generate a Makefile. A sample Makefile for Sun machine
  38.    is included.
  39.  
  40. 2. In the Makefile, replace the TOPDIR by the absolute path of the directory
  41.    in your system that contains the X11 Release 3 libraries.
  42.    For example, if your system has the directory /filesys1/X11 that contains
  43.    a subdirectory lib and this subdirectory contains the libraries libXaw.a,
  44.    libXmu.a, libXt.a and libX11.a, then replace TOPDIR by /filesys1/X11.
  45.    Assume your system has the proper paths for the inclusion directories.
  46.    You can build the executable code xmtool.
  47.  
  48. 3. Before you run xmtool, you need to set up the C shell environment variable
  49.    XMTOOLRESRC that points to the absolute path of the directory that
  50.    contains the subdirectories bitmap and hlp such as
  51.  
  52.     setenv XMTOOLRESRC path-name
  53.  
  54.    When xmtool is being started, it gets the content of this environment 
  55.    variable in order to locate the bitmap files and help files.
  56.  
  57.  
  58. C. Help Files
  59.  
  60. There are 22 help files which contain step by step instructions about ways
  61. to use the mail tool. When you are executing xmtool, you can view each of 
  62. these help files by selecting the help option from the menu display. Each 
  63. of these file begins with a rough graphic description such as
  64.  
  65.  |-- message counter
  66.  |    |-- upper limit
  67.  |    |
  68.  V    V
  69. --------------------------------------------------------------------------------
  70. |001|001|plus|minus|range|set counter|view|delete|save|input                   |
  71. --------------------------------------------------------------------------------
  72. --------------------------------------------------------------------------------
  73. |001|incr|select|reply to sender|reply to all|edit|create|...             |help|
  74. --------------------------------------------------------------------------------
  75.  ^
  76.  |-- increment unit
  77.  
  78. This is a description of the menu display and command selection.
  79. When you are executing xmtool, the boxes identified by plus, minus, range and
  80. incr actually display icons instead of texts. Each of the boxes plus and incr 
  81. displays an icon of the shape of a triangle pointing upward. The box minus
  82. displays an icon of the shape of a triangle pointing downward. The box range
  83. displays an icon of the shape of an arrow pointing upward to a horizontal line.
  84. The boxes message counter, upper limit and increment unit are used for
  85. displays only (implemented as label widgets). The box input is used for input
  86. (implemented as asciiString widget). All other boxes are used for command 
  87. selection (implemented as command widgets).
  88.  
  89. To begin to learn xmtool, you will find it easier if you first read the help
  90. files for message counter, set counter, view and/or increment unit. (See a
  91. recommended width of the window that displays these help files in the section
  92. of Fonts)
  93.  
  94. The help files for view, delete, save and mail to list contain description
  95. for ways to handle single message. The help files for range, select and update 
  96. contain description for ways to handle multiple messages. The maximum number
  97. of messages that xmtool handles is 999.
  98.  
  99.  
  100. D. Fonts
  101.  
  102. Xmtool is most suitable with the font 9x15 because it has been developed and
  103. tested with this font. A recommended width of the window that displays the help 
  104. files with this font is 110. Xmtool can be used with any of the other fonts that 
  105. your system supports.
  106.  
  107.  
  108. E. Comments
  109.  
  110. Send comments, flames, etc to chang@edsews.eds.com or
  111.  
  112. Peter Chang
  113. Electronic Data Systems Corporation
  114. 750 Tower Drive
  115. Troy, MI 48007-7019
  116.