[0m


XEDIT(1)	    UNIX Programmer's Manual		 XEDIT(1)



[1mNAME
     [0mxedit - simple text editor for X

[1mSYNTAX
     xedit [0m[ [1m-pollStdin [0m| [1m-waitStdin [0m] [ -_t_o_o_l_k_i_t_o_p_t_i_o_n ... ] [
     _f_i_l_e_n_a_m_e | [1m- [0m]

[1mOPTIONS
     [0m_X_e_d_i_t accepts all of the standard X Toolkit command line
     options (see _X(_1)).  The order of the command line options
     is not important.

     _f_i_l_e_n_a_m_e
	     Specifies the file that is to be loaded during
	     start-up. This is the file which will be edited. If
	     a file is not specified, _x_e_d_i_t lets you load a file
	     or create a new file after it has started up.  If
	     the name "-" is given _x_e_d_i_t reads from the program
	     standard input.

     [1m-pollStdin
	     [0mWhen reading from standard input _x_e_d_i_t will not wait
	     until all the input has been read before displaying
	     the file.	This option makes _x_e_d_i_t behave like
	     _m_o_r_e(1).  While the input is being read new input
	     will appear at the end of the display.  The display
	     will scroll down if necessary to show the new text.
	     The current text may be saved at any time by enter-
	     ing a file name into the file name field and select-
	     ing [1mSave[0m.

     [1m-waitStdin
	     [0mWhen reading from standard input causes _x_e_d_i_t to
	     wait for the end of input before displaying the
	     text.  (The reverse of the [1m-pollStdin [0moption).

     _X_e_d_i_t may also be invoked as _x_l_e_s_s or _x_m_o_r_e.  In these cases
     if no file name is given input is read from the standard
     input of the program (as though - was given as the file
     name) and the [1m-pollStdin [0moption is switched on (unless over-
     ridden by [1m-waitStdin[0m).

[1mDESCRIPTION
     [0m_X_e_d_i_t provides a window consisting of the following four
     areas:

     Commands Section	      A set of commands that allow you to
			      exit _x_e_d_i_t, save the file, or load
			      a new file into the edit window.

     Message Window	      Displays _x_e_d_i_t messages. In addi-
			      tion, this window can be used as a



Printed 29/3/95             Release 4				1






XEDIT(1)	    UNIX Programmer's Manual		 XEDIT(1)



			      scratch pad.

     Filename Display	      Displays the name of the file
			      currently being edited, and whether
			      this file is _R_e_a_d - _W_r_i_t_e or _R_e_a_d
			      _O_n_l_y.

     Edit Window	      Displays the text of the file that
			      you are editing or creating.

[1mEDITING
     [0mThe Athena Text widget is used for the three sections of
     this application that allow text input.  The characters
     typed will go to the Text widget that the pointer cursor is
     currently over.  If the pointer cursor is not over a text
     widget then the keypresses will have no effect on the appli-
     cation.  This is also true for the special key sequences
     that popup dialog widgets, so typing Control-S in the
     filename widget will enable searching in that widget, not
     the edit widget.

     Both the message window and the edit window will create a
     scrollbar if the text to display is too large to fit in that
     window.  Horizontal scrolling is not allowed by default in
     the message window, but can be turned on through the Text
     widget's resources, see _A_t_h_e_n_a _W_i_d_g_e_t _S_e_t for the exact
     resource definition.

[1mCOMMANDS
     [0mQuit    Quits the current editing session. If any changes
	     have not been saved (including input from the stan-
	     dard input), _x_e_d_i_t displays a warning message,
	     allowing the user to save the file.

     Save    If file backups are enabled (see RESOURCES) xedit
	     stores a copy of the original, unedited file in
	     <prefix>_f_i_l_e<suffix>, then overwrites the _f_i_l_e with
	     the contents of the edit window.  The filename is
	     retrieved from the Text widget directly to the right
	     of the _L_o_a_d button.

     Load    Loads the file named in the text widget immediately
	     to the right of the this button and displays it in
	     the Edit window.  If the currently displayed file
	     has been modified a warning message will ask the
	     user to save the changes, or press _l_o_a_d again.
	     Using this option prevents _x_e_d_i_t from reading
	     further input from standard input.

[1mRESOURCES
     [0mFor _x_e_d_i_t the available resources are:




Printed 29/3/95             Release 4				2






XEDIT(1)	    UNIX Programmer's Manual		 XEDIT(1)



     [1mpollStdin ([0mClass [1mPollStdin)
	     [0mSpecifies that, if standard input is being read,
	     _x_e_d_i_t should not wait for end of file before
	     displaying the input.  This has the default value of
	     "no", unless the program is invoked as _x_l_e_s_s or
	     _x_m_o_r_e in which case it has the default value of
	     "yes".

     [1menableBackups ([0mClass [1mEnableBackups)
	     [0mSpecifies that, when edits made to an existing file
	     are saved, _x_e_d_i_t is to copy the original version of
	     that file to <prefix>_f_i_l_e<suffix> before it saves
	     the changes.  The default value for this resource is
	     "off", stating that no backups should be created.

     [1mbackupNamePrefix ([0mClass [1mBackupNamePrefix)
	     [0mSpecifies a string that is to be prepended to the
	     backup filename.  The default is that no string
	     shall be prepended.

     [1mbackupNameSuffix ([0mClass [1mBackupNameSuffix)
	     [0mSpecifies a string that is to be appended to the
	     backup filename.  The default is to append the
	     string ".BAK".

[1mWIDGETS
     [0mIn order to specify resources, it is useful to know the
     hierarchy of the widgets which compose _x_e_d_i_t.  In the nota-
     tion below, indentation indicates hierarchical structure.
     The widget class name is given first, followed by the widget
     instance name.

     Xedit  xedit
	  Paned  paned
	       Paned  buttons
		    Command  quit
		    Command  save
		    Command  load
		    Text  filename
	       Label  bc_label
	       Text  messageWindow
	       Label  labelWindow
	       Text  editWindow


[1mENVIRONMENT
     DISPLAY [0mto get the default host and display number.

     [1mXENVIRONMENT
	     [0mto get the name of a resource file that overrides
	     the global resources stored in the RESOURCE_MANAGER
	     property.



Printed 29/3/95             Release 4				3






XEDIT(1)	    UNIX Programmer's Manual		 XEDIT(1)



[1mFILES
     [0m/usr/lib/X11/app-defaults/Xedit - specifies required
     resources

[1mSEE ALSO
     [0mX(1), xrdb(1), Athena Widget Set

[1mRESTRICTIONS
     [0mThere is no _u_n_d_o function.  While reading from standard
     input it is not possible to prevent the display scrolling to
     the bottom when new input is available.

[1mCOPYRIGHT
     [0mCopyright 1988, Digital Equipment Corporation.
     Copyright 1989, Massachusetts Institute of Technology.
     See _X(_1) for a full statement of rights and permissions.

[1mAUTHOR
     [0mChris D. Peterson, MIT X Consortium




































Printed 29/3/95             Release 4				4



[0m