Restored the "invalid default virtual key binding" workaround that had
[nedit.git] / doc / help.etx
blobd2d4666e633d8dd87df7481ec9a5815002e61c71
1 .. $Id: help.etx,v 1.73 2004/08/01 07:55:25 yooden Exp $
2 .. NOTE: Remember to supply 'version' variable on setext command line.
3 ..       For example,  setext -m -v "version=NEdit Version 6.0".
4 ..
5 .. The following are variable definitions for the various titles below
6 .. ----------------------------------------------------------------------------
7 .. |>title=Nirvana Editor (NEdit) Help Documentation<|
8 .. |>ttlMk==========================================<|
9 .. ----------------------------------------------------------------------------
10 .. ? NEDITDOC~
11                |>ttlMk<|
12                |>title<|
13                |>ttlMk<|
14                
15 |>version<|                                               |>Date<|
16 .. ~ NEDITDOC
18 .. ! NEDITDOC~
19 |>title<|
20 |>ttlMk<|
22 .. ? html~
24 .. .. This table of contents is only for the HTML version of this document.
26 Table of Contents
27 -----------------
29     Getting_Started_                    
30                                         
31     Basic Operation                     Macro/Shell Extensions
32       Selecting_Text_                      Shell_Commands_and_Filters_
33       Finding_and_Replacing_Text_          Learn/Replay_
34       Cut_and_Paste_                       Macro_Language_
35       Using_the_Mouse_                     Macro_Subroutines_
36       Keyboard_Shortcuts_                  Highlighting_Information_
37       Shifting_and_Filling_                Range_Sets_
38       Tabbed_Editing_                      Action_Routines_
39       File_Format_                         
40                                         Customizing
41     Features for Programming              Customizing_NEdit_
42       Programming_with_NEdit_              Preferences_
43       Tabs/Emulated_Tabs_                  X_Resources_
44       Auto/Smart_Indent_                   Key_Binding_
45       Syntax_Highlighting_                 Highlighting_Patterns_
46       Finding_Declarations_(ctags)_        Smart_Indent_Macros_
47       Calltips_
49     Regular Expressions                 NEdit_Command_Line_
50       Basic_Regular_Expression_Syntax_   Client/Server_Mode_
51       Metacharacters_                    Crash_Recovery_
52       Parenthetical_Constructs_          Version_
53       Advanced_Topics_                   GNU_General_Public_License_
54       Example_Regular_Expressions_       Mailing_Lists_
55                                         Problems/Defects_
57 .. ~ html
58 Getting Started
59 ---------------
61   Welcome to NEdit!
62 .. ~ NEDITDOC
63 .. .. What appears below will always print whether or not NEDITDOC is defined.
66   NEdit is a standard GUI (Graphical User Interface) style text editor for
67   programs and plain-text files.  Users of Macintosh and MS Windows based text
68   editors should find NEdit a familiar and comfortable environment.  NEdit
69   provides all of the standard menu, dialog, editing, and mouse support, as
70   well as all of the standard shortcuts to which the users of modern GUI based
71   environments are accustomed.  For users of older style Unix editors, welcome
72   to the world of mouse-based editing!
74 .. ? NEDITDOC~
75 ..   NEdit is freely distributed under the terms of the Gnu General Public
76 ..   License.
78 .. .. This stuff will always be invisible, unless NEDITDOC is defined
79 .. 
80 .. Installing NEdit
81 .. ----------------
82 .. 
83 ..   NEdit is a single stand-alone executable file which can be installed by simply
84 ..   copying the appropriate executable "nedit" for your system.  Both sources and
85 ..   executables are available from http://www.nedit.org.  The optional "nc" (NEdit
86 ..   Client) program is also available for users who want to run nedit in
87 ..   client/server mode.
88 .. 
89 .. Getting Started
90 .. ---------------
91 .. ~ NEDITDOC
93   Help sections of interest to new users are listed under the "Basic Operation"
94   heading in the top-level Help menu:
96       Selecting_Text_
97       Finding_and_Replacing_Text_
98       Cut_and_Paste_
99       Using_the_Mouse_
100       Keyboard_Shortcuts_
101       Shifting_and_Filling_
103   Programmers should also read the introductory section under the "Features for
104   Programming" section:
106       Programming_with_NEdit_
108   If you get into trouble, the Undo command in the Edit menu can reverse any
109   modifications that you make.  NEdit does not change the file you are editing
110   until you tell it to Save.
112 3>Editing an Existing File
114   To open an existing file, choose Open... from the file menu. Select the file
115   that you want to open in the pop-up dialog that appears and click on OK.  You
116   may open any number of files at the same time.  Depending on your settings
117   (cf. "Tabbed_Editing_") each file can appear in its own editor window, or it
118   can appear under a tab in the same editor window.  Using Open... rather than
119   re-typing the NEdit command and running additional copies of NEdit, will give
120   you quick access to all of the files you have open via the Windows menu, and
121   ensure that you don't accidentally open the same file twice.  NEdit has no
122   "main" window.  It remains running as long as at least one editor window is
123   open.
125 3>Creating a New File
127   If you already have an empty (Untitled) window displayed, just begin typing
128   in the window.  To create a new Untitled window, choose New Window or New Tab
129   from the File menu.   To give the file a name and save its contents to the
130   disk, choose Save or Save As... from the File menu.
132 3>Backup Files
134   NEdit maintains periodic backups of the file you are editing so that you can
135   recover the file in the event of a problem such as a system crash, network
136   failure, or X server crash.  These files are saved under the name `~filename`
137   (on Unix) or `_filename` (on VMS), where filename is the name of the file you
138   were editing.  If an NEdit process is killed, some of these backup files may
139   remain in your directory.  (To remove one of these files on Unix, you may
140   have to prefix the `~' (tilde) character with a (backslash) to prevent the
141   shell from interpreting it as a special character.)
143 3>Shortcuts
145   As you become more familiar with NEdit, substitute the control and function
146   keys shown on the right side of the menus for pulling down menus with the
147   mouse.
149   Dialogs are also streamlined so you can enter information quickly and without
150   using the mouse*.  To move the keyboard focus around a dialog, use the tab
151   and arrow keys.  One of the buttons in a dialog is usually drawn with a
152   thick, indented, outline.  This button can be activated by pressing Return or
153   Enter.  The Cancel or Dismiss button can be activated by pressing escape. 
154   For example, to replace the string "thing" with "things" type:
156       <ctrl-r>thing<tab>things<return>
158   To open a file named "whole_earth.c", type:
160       <ctrl-o>who<return>
162   (how much of the filename you need to type depends on the other files in the
163   directory).  See the section called "Keyboard_Shortcuts_" for more details.
165   * Users who have set their keyboard focus mode to "pointer" should set
166   "Popups Under Pointer" in the Default Settings menu to avoid the additional
167   step of moving the mouse into the dialog.
168    ----------------------------------------------------------------------
170 Basic Operation
171 ===============
173 Selecting Text
174 --------------
176   NEdit has two general types of selections, primary (highlighted text), and
177   secondary (underlined text). Selections can cover either a simple range of
178   text between two points in the file, or they can cover a rectangular area of
179   the file. Rectangular selections are only useful with non-proportional (fixed
180   spacing) fonts.
182   To select text for copying, deleting, or replacing, press the left mouse
183   button with the pointer at one end of the text you want to select, and drag
184   it to the other end. The text will become highlighted. To select a whole
185   word, double click (click twice quickly in succession). Double clicking and
186   then dragging the mouse will select a number of words. Similarly, you can
187   select a whole line or a number of lines by triple clicking or triple
188   clicking and dragging. Quadruple clicking selects the whole file. After
189   releasing the mouse button, you can still adjust a selection by holding down
190   the shift key and dragging on either end of the selection. To delete the
191   selected text, press delete or backspace. To replace it, begin typing.
193   To select a rectangle or column of text, hold the Ctrl key while dragging the
194   mouse. Rectangular selections can be used in any context that normal
195   selections can be used, including cutting and pasting, filling, shifting,
196   dragging, and searching. Operations on rectangular selections automatically
197   fill in tabs and spaces to maintain alignment of text within and to the right
198   of the selection. Note that the interpretation of rectangular selections by
199   Fill Paragraph is slightly different from that of other commands, the section
200   titled "Shifting_and_Filling_" has details.
202   The middle mouse button can be used to make an additional selection (called
203   the secondary selection). As soon as the button is released, the contents of
204   this selection will be copied to the insert position of the window where the
205   mouse was last clicked (the destination window). This position is marked by a
206   caret shaped cursor when the mouse is outside of the destination window.  If
207   there is a (primary) selection, adjacent to the cursor in the window, the new
208   text will replace the selected text. Holding the shift key while making the
209   secondary selection will move the text, deleting it at the site of the
210   secondary selection, rather than copying it.
212   Selected text can also be dragged to a new location in the file using the
213   middle mouse button. Holding the shift key while dragging the text will copy
214   the selected text, leaving the original text in place. Holding the control
215   key will drag the text in overlay mode.
217   Normally, dragging moves text by removing it from the selected position at
218   the start of the drag, and inserting it at a new position relative to to the
219   mouse. Dragging a block of text over existing characters, displaces the
220   characters to the end of the selection. In overlay mode, characters which are
221   occluded by blocks of text being dragged are simply removed. When dragging
222   non-rectangular selections, overlay mode also converts the selection to
223   rectangular form, allowing it to be dragged outside of the bounds of the
224   existing text.
226   The section "Using_the_Mouse_" summarizes the mouse commands for making primary
227   and secondary selections. Primary selections can also be made via keyboard
228   commands, see "Keyboard_Shortcuts_".
229    ----------------------------------------------------------------------
231 Finding and Replacing Text
232 --------------------------
234   The Search menu contains a number of commands for finding and replacing text.
236   The Find... and Replace... commands present dialogs for entering text for
237   searching and replacing.  These dialogs also allow you to choose whether you
238   want the search to be sensitive to upper and lower case, or whether to use
239   the standard Unix pattern matching characters (regular expressions). 
240   Searches begin at the current text insertion position.
242   Find Again and Replace Again repeat the last find or replace command without
243   prompting for search strings.  To selectively replace text, use the two
244   commands in combination: Find Again, then Replace Again if the highlighted
245   string should be replaced, or Find Again again to go to the next string.
247   Find Selection searches for the text contained in the current primary
248   selection (see Selecting_Text_).  The selected text does not have to be in the
249   current editor window, it may even be in another program.  For example, if
250   the word dog appears somewhere in a window on your screen, and you want to
251   find it in the file you are editing, select the word dog by dragging the
252   mouse across it, switch to your NEdit window and choose Find Selection from
253   the Search menu.
255   Find Incremental, which opens the interactive search bar, is yet another variation
256   on searching, where every character typed triggers a new search.  After you've
257   completed the search string, the next occurrence in the buffer is found by hitting
258   the Return key, or by clicking on the icon to the left (magnifying glass). Holding
259   a Shift key down finds the previous occurrences.  To the right there is a clear
260   button with an icon resembling "|<". Clicking on it empties the search text widget
261   without disturbing selections.  A middle click on the clear button copies the
262   content of any existing selection into the search text widget and triggers a new
263   search.
264   
266 3>Searching Backwards
268   Holding down the shift key while choosing any of the search or replace
269   commands from the menu (or using the keyboard shortcut), will search in the
270   reverse direction.  Users who have set the search direction using the buttons
271   in the search dialog, may find it a bit confusing that Find Again and Replace
272   Again don't continue in the same direction as the original search (for
273   experienced users, consistency of the direction implied by the shift key is
274   more important).
276 3>Selective Replacement
278   To replace only some occurrences of a string within a file, choose Replace...
279   from the Search menu, enter the string to search for and the string to
280   substitute, and finish by pressing the Find button.  When the first
281   occurrence is highlighted, use either Replace Again (^T) to replace it, or
282   Find Again (^G) to move to the next occurrence without replacing it, and
283   continue in such a manner through all occurrences of interest.
285   To replace all occurrences of a string within some range of text, select the
286   range (see Selecting_Text_), choose Replace... from the Search menu, type the
287   string to search for and the string to substitute, and press the "R. in
288   Selection" button in the dialog.  Note that selecting text in the Replace...
289   dialog will unselect the text in the window.
290    ----------------------------------------------------------------------
292 Cut and Paste
293 -------------
295   The easiest way to copy and move text around in your file or between windows,
296   is to use the clipboard, an imaginary area that temporarily stores text and
297   data.  The Cut command removes the selected text (see Selecting_Text_) from
298   your file and places it in the clipboard.  Once text is in the clipboard, the
299   Paste command will copy it to the insert position in the current window.  For
300   example, to move some text from one place to another, select it by dragging
301   the mouse over it, choose Cut to remove it, click the pointer to move the
302   insert point where you want the text inserted, then choose Paste to insert
303   it.  Copy copies text to the clipboard without deleting it from your file. 
304   You can also use the clipboard to transfer text to and from other Motif
305   programs and X programs which make proper use of the clipboard.
307   There are many other methods for copying and moving text within NEdit windows
308   and between NEdit and other programs.  The most common such method is
309   clicking the middle mouse button to copy the primary selection (to the
310   clicked position).  Copying the selection by clicking the middle mouse button
311   in many cases is the only way to transfer data to and from many X programs. 
312   Holding the Shift key while clicking the middle mouse button moves the text,
313   deleting it from its original position, rather than copying it.  Other
314   methods for transferring text include secondary selections, primary selection
315   dragging, keyboard-based selection copying, and drag and drop.  These are
316   described in detail in the sections: "Selecting_Text_", "Using_the_Mouse_", 
317   and "Keyboard_Shortcuts_".
318    ----------------------------------------------------------------------
320 Using the Mouse
321 ---------------
323   Mouse-based editing is what NEdit is all about, and learning to use the more
324   advanced features like secondary selections and primary selection dragging
325   will be well worth your while.
327   If you don't have time to learn everything, you can get by adequately with
328   just the left mouse button:  Clicking the left button moves the cursor. 
329   Dragging with the left button makes a selection.  Holding the shift key while
330   clicking extends the existing selection, or begins a selection between the
331   cursor and the mouse.  Double or triple clicking selects a whole word or a
332   whole line.
334   This section will make more sense if you also read the section called,
335   "Selecting_Text_", which explains the terminology of selections, that is,
336   what is meant by primary, secondary, rectangular, etc.
339 3>Button and Modifier Key Summary
341   General meaning of mouse buttons and modifier keys:
343 4>  Buttons
345       Button 1 (left)    Cursor position and primary selection
347       Button 2 (middle)  Secondary selections, and dragging and
348                          copying the primary selection
350       Button 3 (right)   Quick-access programmable menu and pan
351                          scrolling
353 4>  Modifier keys
355       Shift   On primary selections, (left mouse button):
356                  Extends selection to the mouse pointer
357               On secondary and copy operations, (middle):
358                  Toggles between move and copy
360       Ctrl    Makes selection rectangular or insertion
361               columnar
363       Alt*    (on release) Exchange primary and secondary
364               selections.
367 3>Left Mouse Button
369   The left mouse button is used to position the cursor and to make primary
370   selections.
372     Click         Moves the cursor
374     Double Click  Selects a whole word
376     Triple Click  Selects a whole line
378     Quad Click    Selects the whole file
380     Shift Click   Adjusts (extends or shrinks) the
381                   selection, or if there is no existing
382                   selection, begins a new selection
383                   between the cursor and the mouse.
385     Ctrl+Shift+   Adjusts (extends or shrinks) the
386     Click         selection rectangularly.
388     Drag          Selects text between where the mouse
389                   was pressed and where it was released.
391     Ctrl+Drag     Selects rectangle between where the
392                   mouse was pressed and where it was
393                   released.
396 3>Right Mouse Button
398   The right mouse button posts a programmable menu for frequently used commands.
400     Click/Drag    Pops up the background menu (programmed
401                   from Preferences -> Default Settings ->
402                   Customize Menus -> Window Background).
404     Ctrl+Drag     Pan scrolling.  Scrolls the window
405                   both vertically and horizontally, as if
406                   you had grabbed it with your mouse.
409 3>Middle Mouse Button
411   The middle mouse button is for making secondary selections, and copying and
412   dragging the primary selection.
414     Click         Copies the primary selection to the
415                   clicked position.
417     Shift+Click   Moves the primary selection to the
418                   clicked position, deleting it from its
419                   original position.
421     Drag          1) Outside of the primary selection:
422                       Begins a secondary selection.
423                   2) Inside of the primary selection:
424                       Moves the selection by dragging.
426     Ctrl+Drag     1) Outside of the primary selection:
427                       Begins a rectangular secondary
428                       selection.
429                   2) Inside of the primary selection:
430                       Drags the selection in overlay
431                       mode (see below).
433   When the mouse button is released after creating a secondary selection:
435     No Modifiers  If there is a primary selection,
436                   replaces it with the secondary
437                   selection.  Otherwise, inserts the
438                   secondary selection at the cursor
439                   position.
441     Shift         Move the secondary selection, deleting
442                   it from its original position.  If
443                   there is a primary selection, the move
444                   will replace the primary selection
445                   with the secondary selection.
446                   Otherwise, moves the secondary
447                   selection to to the cursor position.
449     Alt*          Exchange the primary and secondary
450                   selections.
453   While moving the primary selection by dragging with the middle mouse button:
455     Shift         Leaves a copy of the original
456                   selection in place rather than
457                   removing it or blanking the area.
459     Ctrl          Changes from insert mode to overlay
460                   mode (see below).
462     Escape        Cancels drag in progress.
464   Overlay Mode: Normally, dragging moves text by removing it from the selected
465   position at the start of the drag, and inserting it at a new position
466   relative to to the mouse. When you drag a block of text over existing
467   characters, the existing characters are displaced to the end of the
468   selection.  In overlay mode, characters which are occluded by blocks of text
469   being dragged are simply removed.  When dragging non-rectangular selections,
470   overlay mode also converts the selection to rectangular form, allowing it to
471   be dragged outside of the bounds of the existing text.
473   Mouse buttons 4 and 5 are usually represented by a mouse wheel nowadays. 
474   They are used to scroll up or down in the text window.
476   * The Alt key may be labeled Meta or Compose-Character on some keyboards. 
477   Some window managers, including default configurations of mwm, bind
478   combinations of the Alt key and mouse buttons to window manager operations. 
479   In NEdit, Alt is only used on button release, so regardless of the window
480   manager bindings for Alt-modified mouse buttons, you can still do the
481   corresponding NEdit operation by using the Alt key AFTER the initial mouse
482   press, so that Alt is held while you release the mouse button.  If you find
483   this difficult or annoying, you can re-configure most window managers to skip
484   this binding, or you can re-configure NEdit to use a different key
485   combination.
486    ----------------------------------------------------------------------
488 Keyboard Shortcuts
489 ------------------
491   Most of the keyboard shortcuts in NEdit are shown on the right hand sides of
492   the pull-down menus.  However, there are more which are not as obvious.  These
493   include; dialog button shortcuts; menu and dialog mnemonics; labeled keyboard
494   keys, such as the arrows, page-up, page-down, and home; and optional Shift
495   modifiers on accelerator keys, like [Shift]Ctrl+F.
498 3>Menu Accelerators
500   Pressing the key combinations shown on the right of the menu items is a
501   shortcut for selecting the menu item with the mouse.  Some items have the shift
502   key enclosed in brackets, such as [Shift]Ctrl+F.  This indicates that the shift
503   key is optional.  In search commands, including the shift key reverses the
504   direction of the search.  In Shift commands, it makes the command shift the
505   selected text by a whole tab stop rather than by single characters.
508 3>Menu Mnemonics
510   Pressing the Alt key in combination with one of the underlined characters in
511   the menu bar pulls down that menu.  Once the menu is pulled down, typing the
512   underlined characters in a menu item (without the Alt key) activates that
513   item.  With a menu pulled down, you can also use the arrow keys to select menu
514   items, and the Space or Enter keys to activate them.
517 3>Keyboard Shortcuts within Dialogs
519   One button in a dialog is usually marked with a thick indented outline. 
520   Pressing the Return or Enter key activates this button.
522   All dialogs have either a Cancel or Dismiss button.  This button can be
523   activated by pressing the Escape (or Esc) key.
525   Pressing the tab key moves the keyboard focus to the next item in a dialog. 
526   Within an associated group of buttons, the arrow keys move the focus among the
527   buttons.  Shift+Tab moves backward through the items.
529   Most items in dialogs have an underline under one character in their name. 
530   Pressing the Alt key along with this character, activates a button as if you
531   had pressed it with the mouse, or moves the keyboard focus to the associated
532   text field or list.
534   You can select items from a list by using the arrow keys to move the
535   selection and space to select.
537   In file selection dialogs, you can type the beginning characters of the file
538   name or directory in the list to select files
541 3>Labeled Function Keys
543   The labeled function keys on standard workstation and PC keyboards, like the
544   arrows, and page-up and page-down, are active in NEdit, though not shown in the
545   pull-down menus.
547   Holding down the control key while pressing a named key extends the scope of
548   the action that it performs.  For example, Home normally moves the insert
549   cursor the beginning of a line.  Ctrl+Home moves it to the beginning of the
550   file. Backspace deletes one character, Ctrl+Backspace deletes one word.
552   Holding down the shift key while pressing a named key begins or extends a
553   selection.  Combining the shift and control keys combines their actions.  For
554   example, to select a word without using the mouse, position the cursor at the
555   beginning of the word and press Ctrl+Shift+RightArrow.  The Alt key modifies
556   selection commands to make the selection rectangular.
558   Under X and Motif, there are several levels of translation between keyboard
559   keys and the actions they perform in a program.  The "Customizing_NEdit_", and
560   "X_Resources_" sections of the Help menu have more information on this subject. 
561   Because of all of this configurability, and since keyboards and standards for
562   the meaning of some keys vary from machine to machine, the mappings may be
563   changed from the defaults listed below.
565 3>Modifier Keys (in general)
567     Ctrl   Extends the scope of the action that the key
568            would otherwise perform.  For example, Home
569            normally moves the insert cursor to the beginning
570            of a line. Ctrl+Home moves it to the beginning of
571            the file.  Backspace deletes one character, Ctrl+
572            Backspace deletes one word.
574     Shift  Extends the selection to the cursor position. If
575            there's no selection, begins one between the old
576            and new cursor positions.
578     Alt    When modifying a selection, makes the selection
579            rectangular.
581   (For the effects of modifier keys on mouse button presses, see the section
582   titled "Using_the_Mouse_")
584 3>All Keyboards
586     Escape        Cancels operation in progress: menu
587                   selection, drag, selection, etc.  Also
588                   equivalent to cancel button in dialogs.
590     Backspace     Delete the character before the cursor
592     Ctrl+BS       Delete the word before the cursor
594     Arrows --
596       Left        Move the cursor to the left one character
598       Ctrl+Left   Move the cursor backward one word
599                   (Word delimiters are settable, see
600                   "Customizing_NEdit_", and "X_Resources_")
602       Right       Move the cursor to the right one character
604       Ctrl+Right  Move the cursor forward one word
606       Up          Move the cursor up one line
608       Ctrl+Up     Move the cursor up one paragraph.
609                   (Paragraphs are delimited by blank lines)
611       Down        Move the cursor down one line.
613       Ctrl+Down   Move the cursor down one paragraph.
615     Ctrl+Return   Return with automatic indent, regardless
616                   of the setting of Auto Indent.
618     Shift+Return  Return without automatic indent,
619                   regardless of the setting of Auto Indent.
621     Ctrl+Tab      Insert an ASCII tab character, without
622                   processing emulated tabs.
624     Alt+Ctrl+<c>  Insert the control-code equivalent of
625                   a key <c>
627     Ctrl+/        Select everything (same as Select
628                   All menu item or ^A)
630     Ctrl+\        Unselect
632     Ctrl+U        Delete to start of line
634 3>PC Standard Keyboard
636     Ctrl+Insert   Copy the primary selection to the
637                   clipboard (same as Copy menu item or ^C)
638                   for compatibility with Motif standard key
639                   binding
640     Shift+Ctrl+
641     Insert        Copy the primary selection to the cursor
642                   location.
644     Delete        Delete the character before the cursor.
645                   (Can be configured to delete the character
646                   after the cursor, see "Customizing_NEdit_",
647                   and "X_Resources_")
649     Ctrl+Delete   Delete to end of line.
651     Shift+Delete  Cut, remove the currently selected text
652                   and place it in the clipboard. (same as
653                   Cut menu item or ^X) for compatibility
654                   with Motif standard key binding
655     Shift+Ctrl+
656     Delete        Cut the primary selection to the cursor
657                   location.
659     Home          Move the cursor to the beginning of the
660                   line
662     Ctrl+Home     Move the cursor to the beginning of the
663                   file
665     End           Move the cursor to the end of the line
667     Ctrl+End      Move the cursor to the end of the file
669     PageUp        Scroll and move the cursor up by one page.
671     PageDown      Scroll and move the cursor down by one
672                   page.
674     F10           Make the menu bar active for keyboard
675                   input (Arrow Keys, Return, Escape,
676                   and the Space Bar)
678     Alt+Home      Switch to the previously active document.
680     Ctrl+PageUp   Switch to the previous document.
682     Ctrl+PageDown Switch to the next document.
685 3>Specialty Keyboards  
687   On machines with different styles of keyboards, generally, text editing
688   actions are properly matched to the labeled keys, such as Remove,
689   Next-screen, etc..  If you prefer different key bindings, see the section
690   titled "Key_Binding_" under the Customizing heading in the Help menu.
691    ----------------------------------------------------------------------
693 Shifting and Filling
694 --------------------
696 3>Shift Left, Shift Right
698   While shifting blocks of text is most important for programmers (See Features
699   for Programming), it is also useful for other tasks, such as creating
700   indented paragraphs.
702   To shift a block of text one tab stop to the right, select the text, then
703   choose Shift Right from the Edit menu.  Note that the accelerator keys for
704   these menu items are Ctrl+9 and Ctrl+0, which correspond to the right and
705   left parenthesis on most keyboards.  Remember them as adjusting the text in
706   the direction pointed to by the parenthesis character.  Holding the Shift key
707   while selecting either Shift Left or Shift Right will shift the text by one
708   character.
710   It is also possible to shift blocks of text by selecting the text
711   rectangularly, and dragging it left or right (and up or down as well).  Using
712   a rectangular selection also causes tabs within the selection to be
713   recalculated and substituted, such that the non-whitespace characters remain
714   stationary with respect to the selection.
717 3>Filling  
719   Text filling using the Fill Paragraph command in the Edit menu is one of the
720   most important concepts in NEdit.  And it will be well worth your while to
721   understand how to use it properly.
723   In plain text files, unlike word-processor files, there is no way to tell
724   which lines are continuations of other lines, and which lines are meant to be
725   separate, because there is no distinction in meaning between newline
726   characters which separate lines in a paragraph, and ones which separate
727   paragraphs from other text.  This makes it impossible for a text editor like
728   NEdit to tell parts of the text which belong together as a paragraph from
729   carefully arranged individual lines.
731   In continuous wrap mode (Preferences -> Wrap -> Continuous), lines
732   automatically wrap and unwrap themselves to line up properly at the right
733   margin.  In this mode, you simply omit the newlines within paragraphs and let
734   NEdit make the line breaks as needed.  Unfortunately, continuous wrap mode is
735   not appropriate in the majority of situations, because files with extremely
736   long lines are not common under Unix and may not be compatible with all
737   tools, and because you can't achieve effects like indented sections, columns,
738   or program comments, and still take advantage of the automatic wrapping.
740   Without continuous wrapping, paragraph filling is not entirely automatic. 
741   Auto-Newline wrapping keeps paragraphs lined up as you type, but once
742   entered, NEdit can no longer distinguish newlines which join wrapped text,
743   and newlines which must be preserved.  Therefore, editing in the middle of a
744   paragraph will often leave the right margin messy and uneven.
746   Since NEdit can't act automatically to keep your text lined up, you need to
747   tell it explicitly where to operate, and that is what Fill Paragraph is for. 
748   It arranges lines to fill the space between two margins, wrapping the lines
749   neatly at word boundaries.  Normally, the left margin for filling is inferred
750   from the text being filled.  The first line of each paragraph is considered
751   special, and its left indentation is maintained separately from the remaining
752   lines (for leading indents, bullet points, numbered paragraphs, etc.). 
753   Otherwise, the left margin is determined by the furthest left non-whitespace
754   character.  The right margin is either the Wrap Margin, set in the
755   preferences menu (by default, the right edge of the window), or can also be
756   chosen on the fly by using a rectangular selection (see below).
758   There are three ways to use Fill Paragraph.  The simplest is, while you are
759   typing text, and there is no selection, simply select Fill Paragraph (or type
760   Ctrl+J), and NEdit will arrange the text in the paragraph adjacent to the
761   cursor.  A paragraph, in this case, means an area of text delimited by blank
762   lines.
764   The second way to use Fill Paragraph is with a selection.  If you select a
765   range of text and then chose Fill Paragraph, all of the text in the selection
766   will be filled.  Again, continuous text between blank lines is interpreted as
767   paragraphs and filled individually, respecting leading indents and blank
768   lines.
770   The third, and most versatile, way to use Fill Paragraph is with a
771   rectangular selection.  Fill Paragraph treats rectangular selections
772   differently from other commands.  Instead of simply filling the text inside
773   the rectangular selection, NEdit interprets the right edge of the selection
774   as the requested wrap margin.  Text to the left of the selection is not
775   disturbed (the usual interpretation of a rectangular selection), but text to
776   the right of the selection is included in the operation and is pulled in to
777   the selected region.  This method enables you to fill text to an arbitrary
778   right margin, without going back and forth to the wrap-margin dialog, as well
779   as to exclude text to the left of the selection such as comment bars or other
780   text columns.
781    ----------------------------------------------------------------------
783 Tabbed Editing
784 ----------------
786   NEdit is able to display files in distinct editor windows, or to display files
787   under tabs in the same editor window.  The Options for controlling the tabbed
788   interface are found under Preferences -> Default Settings -> Tabbed Editing 
789   (cf. "Preferences_", also "NEdit_Command_Line_"). 
790   
791   Notice that you can re-group tabs at any time by detaching and attaching them,
792   or moving them, to other windows. This can be done using the Windows menu, or
793   using the context menu, which pops up when right clicking on a tab.
795   You can switch to a tab by simply clicking on it, or you can use the keyboard.
796   The default keybindings to switch tabs (which are Ctrl+PageUp/-Down and Alt+Home,
797   see "Keyboard_Shortcuts_") can be changed using the actions previous_document(),
798   next_document() and last_document().
799   
800    ----------------------------------------------------------------------
802 File Format
803 -----------
805   While plain-text is probably the simplest and most interchangeable file
806   format in the computer world, there is still variation in what plain-text
807   means from system to system.  Plain-text files can differ in character set,
808   line termination, and wrapping.
810   While character set differences are the most obvious and pose the most
811   challenge to portability, they affect NEdit only indirectly via the same font
812   and localization mechanisms common to all X applications.  If your system is
813   set up properly, you will probably never see character-set related problems
814   in NEdit.  NEdit can not display Unicode text files, or any multi-byte
815   character set.
817   The primary difference between an MS DOS format file and a Unix format file,
818   is how the lines are terminated.  Unix uses a single newline character.  MS
819   DOS uses a carriage-return and a newline.  NEdit can read and write both file
820   formats, but internally, it uses the single character Unix standard.  NEdit
821   auto-detects MS DOS format files based on the line termination at the start
822   of the file.  Files are judged to be DOS format if all of the first five line
823   terminators, within a maximum range, are DOS-style.  To change the format in
824   which NEdit writes a file from DOS to Unix or visa versa, use the Save As...
825   command and check or un-check the MS DOS Format button.
827   Wrapping within text files can vary among individual users, as well as from
828   system to system.  Both Windows and MacOS make frequent use of plain text
829   files with no implicit right margin.  In these files, wrapping is determined
830   by the tool which displays them.  Files of this style also exist on Unix
831   systems, despite the fact that they are not supported by all Unix utilities. 
832   To display this kind of file properly in NEdit, you have to select the wrap
833   style called Continuous.  Wrapping modes are discussed in the sections:
834   Customizing -> Preferences, and Basic Operation -> Shifting and Filling.
836   The last and most minute of format differences is the terminating newline. 
837   Some Unix compilers and utilities require a final terminating newline on all
838   files they read and fail in various ways on files which do not have it.  Vi
839   and approximately half of Unix editors enforce the terminating newline on all
840   files that they write; Emacs does not enforce this rule.  Users are divided
841   on which is best.  NEdit makes the final terminating newline optional
842   (Preferences -> Default Settings -> Terminate with Line Break on Save).
843    ----------------------------------------------------------------------
845 Features for Programming
846 ========================
848 Programming with NEdit
849 ----------------------
851   Though general in appearance, NEdit has many features intended specifically
852   for programmers.  Major programming-related topics are listed in separate
853   sections under the heading: "Features for Programming": Syntax_Highlighting_,
854   Tabs/Emulated_Tabs_, Finding_Declarations_(ctags)_, Calltips_, and 
855   Auto/Smart_Indent_.  Minor topics related to programming are discussed below:
857 3>Language Modes
859   When NEdit initially reads a file, it attempts to determine whether the file
860   is in one of the computer languages that it knows about.  Knowing what language
861   a file is written in allows NEdit to assign highlight patterns and smart indent
862   macros, and to set language specific preferences like word delimiters, tab
863   emulation, and auto-indent.  Language mode can be recognized from both the file
864   name and from the first 200 characters of content.  Language mode recognition
865   and language-specific preferences are configured in: Preferences -> Default
866   Settings -> Language Modes....
868   You can set the language mode manually for a window, by selecting it from the
869   menu: Preferences -> Language Modes.
871 3>Backlighting [EXPERIMENTAL]
873   NEdit can be made to set the background color of particular classes of
874   characters to allow easy identification of those characters. This is
875   particularly useful if you need to be able to distinguish between tabs
876   and spaces in a file where the difference is important. The colors used
877   for backlighting are specified by a resource, "nedit*backlightCharTypes". 
878   You can turn backlighting on and off through the
879   Preferences -> Apply Backlighting menu entry.
881   If you prefer to have backlighting turned on for all new windows, use
882   the Preferences -> Default Settings -> Apply Backlighting menu entry. 
883   This settings can be saved along with other preferences using 
884   Preferences -> Save Defaults.
885   
886   **Important:** In future versions of NEdit, the backlighting feature will be
887   extended and reworked such that it becomes easier to configure. The current
888   way of controlling it through a resource is generally considered to be below
889   NEdit's usability standards. These future changes are likely to be
890   incompatible with the current format of the "nedit*backlightCharTypes"
891   resource, though. Therefore, it is expected that there will be no automatic
892   migration path for users who customize the resource.
894 3>Line Numbers
896   To find a particular line in a source file by line number, choose Goto Line
897   #... from the Search menu.  You can also directly select the line number text
898   in the compiler message in the terminal emulator window (xterm, decterm,
899   winterm, etc.) where you ran the compiler, and choose Goto Selected from the
900   Search menu.
902   To find out the line number of a particular line in your file, turn on
903   Statistics Line in the Preferences menu and position the insertion point
904   anywhere on the line.  The statistics line continuously updates the line number
905   of the line containing the cursor.
906   
907   To go to a specific column on a given line, choose Goto Line #... from the
908   Search menu and enter a line number and a column number separated by a 
909   comma.  (e.g. Enter "100,12" for line 100 column 12.)  If you want to go to
910   a column on the current line just leave out the line number.  (e.g. Enter
911   ",45" to go the column 45 on the current line.)
913 3>Matching Parentheses
915   To help you inspect nested parentheses, brackets, braces, quotes, and other
916   characters, NEdit has both an automatic parenthesis matching mode, and a Goto
917   Matching command.  Automatic parenthesis matching is activated when you type,
918   or move the insertion cursor after a parenthesis, bracket, or brace.  It
919   momentarily highlights either the opposite character ('Delimiter') or the
920   entire expression ('Range') when the opposite character is visible in the
921   window. To find a matching character anywhere in the file, select it or
922   position the cursor after it, and choose Goto Matching from the Search menu. 
923   If the character matches itself, such as a quote or slash, select the first
924   character of the pair.  NEdit will match {, (, [, <, ", ', `, /, and \.
925   Holding the Shift key while typing the accelerator key (Shift+Ctrl+M, by
926   default), will select all of the text between the matching characters.
927   
928   When syntax highlighting is enabled, the matching routines can optionally
929   make use of the syntax information for improved accuracy. In that case,
930   a brace inside a highlighted string will not match a brace inside a comment,
931   for instance.
932   
933 3>Opening Included Files
935   The Open Selected command in the File menu understands the C preprocessor's
936   #include syntax, so selecting an #include line and invoking Open Selected will
937   generally find the file referred to, unless doing so depends on the settings of
938   compiler switches or other information not available to NEdit.
940 3>Interface to Programming Tools
942   Integrated software development environments such as SGI's CaseVision and
943   Centerline Software's Code Center, can be interfaced directly with NEdit via
944   the client server interface.  These tools allow you to click directly on
945   compiler and runtime error messages and request NEdit to open files, and select
946   lines of interest.  The easiest method is usually to use the tool's interface
947   for character-based editors like vi, to invoke nc, but programmatic interfaces
948   can also be derived using the source code for nc.
950   There are also some simple compile/review, grep, ctree, and ctags browsers
951   available in the NEdit contrib directory on ftp.nedit.org.
952    ----------------------------------------------------------------------
954 Tabs/Emulated Tabs
955 ------------------
957 3>Changing the Tab Distance
959   Tabs are important for programming in languages which use indentation to show
960   nesting, as short-hand for producing white-space for leading indents.  As a
961   programmer, you have to decide how to use indentation, and how or whether tab
962   characters map to your indentation scheme.
964   Ideally, tab characters map directly to the amount of indent that you use to
965   distinguish nesting levels in your code.  Unfortunately, the Unix standard
966   for interpretation of tab characters is eight characters (probably dating
967   back to mechanical capabilities of the original teletype), which is usually
968   too coarse for a single indent.
970   Most text editors, NEdit included, allow you to change the interpretation of
971   the tab character, and many programmers take advantage of this, and set their
972   tabs to 3 or 4 characters to match their programming style.  In NEdit you set
973   the hardware tab distance in Preferences -> Tabs... for the current window,
974   or Preferences -> Default Settings -> Tabs... (general), or Preferences ->
975   Default Settings -> Language Modes... (language-specific) to change the
976   defaults for future windows.
978   Changing the meaning of the tab character makes programming much easier while
979   you're in the editor, but can cause you headaches outside of the editor,
980   because there is no way to pass along the tab setting as part of a plain-text
981   file.  All of the other tools which display, print, and otherwise process
982   your source code have to be made aware of how the tabs are set, and must be
983   able to handle the change.  Non-standard tabs can also confuse other
984   programmers, or make editing your code difficult for them if their text
985   editors don't support changes in tab distance.
987 3>Emulated Tabs
989   An alternative to changing the interpretation of the tab character is tab
990   emulation.  In the Tabs... dialog(s), turning on Emulated Tabs causes the Tab
991   key to insert the correct number of spaces and/or tabs to bring the cursor
992   the next emulated tab stop, as if tabs were set at the emulated tab distance
993   rather than the hardware tab distance. Backspacing immediately after entering
994   an emulated tab will delete the fictitious tab as a unit, but as soon as you
995   move the cursor away from the spot, NEdit will forget that the collection of
996   spaces and tabs is a tab, and will treat it as separate characters.  To enter
997   a real tab character with "Emulate Tabs" turned on, use Ctrl+Tab.
999   It is also possible to tell NEdit not to insert ANY tab characters at all in
1000   the course of processing emulated tabs, and in shifting and rectangular
1001   insertion/deletion operations, for programmers who worry about the
1002   misinterpretation of tab characters on other systems.
1003    ----------------------------------------------------------------------
1005 ..                             ** NOTE **
1007 .. The following Tabs Dialog and Customize Window Title Dialog sections
1008 .. should only appear in the online documentation, and not in any of 
1009 .. the other possible forms. The rationale is that they are not directly
1010 .. obtained from the Help menu, but are buried in preference dialogs.
1012 .. ? help~
1013 .. Tabs Dialog
1014 .. -----------
1015 .. 
1016 ..   The Tabs dialog controls both the operation of the Tab key, and
1017 ..   the interpretation of tab characters within a file.
1018 ..   
1019 ..   The first field, Tab Spacing, controls how  NEdit responds to
1020 ..   tab characters in a file.  On most Unix and VMS systems the
1021 ..   conventional interpretation of a tab character is to advance the
1022 ..   text position to the nearest multiple of eight characters (a tab
1023 ..   spacing of 8).  However, many programmers of C and other
1024 ..   structured languages, when given the choice, prefer a tab
1025 ..   spacing of 3 or 4 characters.  Setting a three or four character
1026 ..   hardware tab spacing is useful and convenient as long as your
1027 ..   other software tools support it.  Unfortunately, on Unix and VMS
1028 ..   systems, system utilities, such as more, and printing software
1029 ..   can't always properly display files with other than eight
1030 ..   character tabs.
1031 ..   
1032 ..   Selecting "Emulate Tabs" will cause the Tab key to insert the
1033 ..   correct number of spaces or tabs to reach the next tab stop, as
1034 ..   if the tab spacing were set at the value in the "Emulated tab
1035 ..   spacing" field.  Backspacing immediately after entering an
1036 ..   emulated tab will delete it as a unit, but as soon as you move
1037 ..   the cursor away from the spot, NEdit will forget that the
1038 ..   collection of spaces and tabs is a tab, and will treat it as
1039 ..   separate characters.  To enter a real tab character with
1040 ..   "Emulate Tabs" turned on, use Ctrl+Tab.
1041 ..   
1042 ..   In generating emulated tabs, and in Shift Left, Paste Column,
1043 ..   and some rectangular selection operations, NEdit inserts blank
1044 ..   characters (spaces or tabs) to preserve the alignment of
1045 ..   non-blank characters. The bottom toggle button in the Tabs
1046 ..   dialog instructs NEdit whether to insert tab characters as
1047 ..   padding in such situations. Turning this off, will keep NEdit
1048 ..   from automatically inserting tabs. Some software developers
1049 ..   prefer to keep their source code free of tabs to avoid its
1050 ..   misinterpretation on systems with different tab character
1051 ..   conventions.
1052 ..    ----------------------------------------------------------------------
1054 .. Customize Window Title Dialog
1055 .. -----------------------------
1056 .. 
1057 ..   The Customize Window Title dialog allows you to customize 
1058 ..   and test the way information will be displayed in each window's 
1059 ..   title field.
1060 ..   
1061 ..   **Definition of the title**
1062 ..   
1063 ..   The upper half of the dialog can be used to select the various 
1064 ..   components that should be displayed in the title. The layout can be 
1065 ..   fine-tuned by editing the printf() like format string below the 
1066 ..   component buttons: additional characters can be entered, or the 
1067 ..   order can be changed.
1068 ..   
1069 ..   The following sequences are interpreted in the format string:
1070 ..   
1071 ..    %c    ClearCase view tag (only relevant when NEdit is 
1072 ..          used together with ClearCase)
1073 ..    %[n]d directory, with one optional numeric digit n 
1074 ..          specifying the maximum number of trailing directory 
1075 ..          components to display. Skipped components are 
1076 ..          replaced by an ellipsis (...).
1077 ..    %f    file name, without the path name
1078 ..    %h    host name
1079 ..    %s    NEdit server name (server mode only)
1080 ..    %[*]S file status, either verbose (%S) or brief (%*S).
1081 ..          In verbose mode the file status is spelled out: 
1082 ..          read-only, locked, and modified. In brief mode, 
1083 ..          abbreviations and an asterisk are used for the 
1084 ..          respective states: RO, LO, *.
1085 ..    %u    user name
1086 ..   
1087 ..   The format string and the component buttons are continously synchronized.
1088 ..   
1089 ..   The default format is:
1090 ..   
1091 ..     {%c} [%s] %f (%S) - %d
1092 ..   
1093 ..   The resulting title will only contain elements with 
1094 ..   a value. Hence, the title is compressed as follows:
1095 ..   
1096 ..    * Elements with no value are removed.             
1097 ..                                                      
1098 ..    * Empty parenthesis pairs i.e. (), [] or {}, or parenthesis
1099 ..      pairs containing only space(s), are removed.
1100 ..                                                      
1101 ..    * Sequences of spaces are replaced with one space.
1102 ..                                                      
1103 ..    * Leading spaces and dashes are removed.          
1104 ..                                                      
1105 ..    * Trailing spaces and dashes are removed.         
1106 ..   
1107 ..   If the server name and the ClearCase view tag are identical, only 
1108 ..   the first one specified in the format string will be displayed.
1109 ..   
1110 ..   **Previewing the settings**
1111 ..   
1112 ..   The lower part of the dialog can be used to test the selected title
1113 ..   under various conditions. For some of the components that are selected 
1114 ..   for display, various states can be enforced on the preview. 
1115 ..   
1116 ..   For instance, components that are not always active (such the 
1117 ..   NEdit server name) can be turned on or off in the preview.
1118 ..   
1119 .. ~ help
1121 Auto/Smart Indent
1122 -----------------
1124   Programmers who use structured languages usually require some form of
1125   automatic indent, so that they don't have to continually re-type the
1126   sequences of tabs and/or spaces needed to maintain lengthy running indents. 
1127   NEdit therefore offers "smart" indent, in addition to the traditional
1128   automatic indent which simply lines up the cursor position with the previous
1129   line.
1131 3>Smart Indent
1133   Smart indent macros are only available by default for C and C++, and while
1134   these can easily be configured for different default indentation distances,
1135   they may not conform to everyone's exact C programming style.  Smart indent
1136   is programmed in terms of macros in the NEdit macro language which can be
1137   entered in: Preferences -> Default Settings -> Indent -> Program Smart
1138   Indent.  Hooks are provided for intervening at the point that a newline is
1139   entered, either via the user pressing the Enter key, or through
1140   auto-wrapping; and for arbitrary type-in to act on specific characters typed.
1142   To type a newline character without invoking smart-indent when operating in
1143   smart-indent mode, hold the Shift key while pressing the Return or Enter key.
1145 3>Auto-Indent
1147   With Indent set to Auto (the default), NEdit keeps a running indent.  When
1148   you press the Return or Enter key, spaces and tabs are inserted to line up
1149   the insert point under the start of the previous line.
1151   Regardless of indent-mode, Ctrl+Return always does the automatic indent;
1152   Shift+Return always does a return without indent.
1154 3>Block Indentation Adjustment
1156   The Shift Left and Shift Right commands as well as rectangular dragging can
1157   be used to adjust the indentation for several lines at once.  To shift a
1158   block of text one character to the right, select the text, then choose Shift
1159   Right from the Edit menu.  Note that the accelerator keys for these menu
1160   items are Ctrl+9 and Ctrl+0, which correspond to  the right and left
1161   parenthesis on most keyboards.  Remember them as adjusting the text in the
1162   direction pointed to by the parenthesis character.  Holding the Shift key
1163   while selecting either Shift Left or Shift Right will shift the text by one
1164   tab stop (or by one emulated tab stop if tab emulation is turned on).  The
1165   help section "Shifting and Filling" under "Basic Operation" has details.
1166    ----------------------------------------------------------------------
1168 Syntax Highlighting
1169 -------------------
1171   Syntax Highlighting means using colors and fonts to help distinguish language
1172   elements in programming languages and other types of structured files. 
1173   Programmers use syntax highlighting to understand code faster and better, and
1174   to spot many kinds of syntax errors more quickly.
1176   To use syntax highlighting in NEdit, select Highlight Syntax in the
1177   Preferences menu.  If NEdit recognizes the computer language that you are
1178   using, and highlighting rules (patterns) are available for that language, it
1179   will highlight your text, and maintain the highlighting, automatically, as
1180   you type.
1182   If NEdit doesn't correctly recognize the type of the file you are editing,
1183   you can manually select a language mode from Language Modes in the
1184   Preferences menu.  You can also program the method that NEdit uses to
1185   recognize language modes in Preferences -> Default Settings -> Language
1186   Modes....
1188   If no highlighting patterns are available for the language that you want to
1189   use, you can create new patterns relatively quickly.  The Help section
1190   "Highlighting_Patterns_" under "Customizing", has details.
1192   If you are satisfied with what NEdit is highlighting, but would like it to
1193   use different colors or fonts, you can change these by selecting Preferences
1194   -> Default Settings -> Syntax Highlighting -> Text Drawing Styles. 
1195   Highlighting patterns are connected with font and color information through a
1196   common set of styles so that colorings defined for one language will be
1197   similar across others, and patterns within the same language which are meant
1198   to appear identical can be changed in the same place.  To understand which
1199   styles are used to highlight the language you are interested in, you may need
1200   to look at "Highlighting_Patterns_" section, as well.
1202   Syntax highlighting is CPU intensive, and under some circumstances can affect
1203   NEdit's responsiveness.  If you have a particularly slow system, or work with
1204   very large files, you may not want to use it all of the time.  Syntax
1205   highlighting introduces two kinds of delays.  The first is an initial parsing
1206   delay, proportional to the size of the file.  This delay is also incurred
1207   when pasting large sections of text, filtering text through shell commands,
1208   and other circumstances involving changes to large amounts of text.  The
1209   second kind of delay happens when text which has not previously been visible
1210   is scrolled in to view.  Depending on your system, and the highlight patterns
1211   you are using, this may or may not be noticeable.  A typing delay is also
1212   possible, but unlikely if you are only using the built-in patterns.
1213    ----------------------------------------------------------------------
1215 Finding Declarations (ctags)
1216 ----------------------------
1218   NEdit can process tags files generated using the Unix _ctags command or the
1219   Exuberant Ctags program.  Ctags creates index files correlating names of
1220   functions and declarations with their locations in C, Fortran, or Pascal source
1221   code files. (See the ctags manual page for more information).  Ctags produces a
1222   file called "tags" which can be loaded by NEdit.  NEdit can manage any number
1223   of tags files simultaneously.  Tag collisions are handled with a popup menu to
1224   let the user decide which tag to use.  In 'Smart' mode NEdit will automatically
1225   choose the desired tag based on the scope of the file or module. Once loaded,
1226   the information in the tags file enables NEdit to go directly to the
1227   declaration of a highlighted function or data structure name with a single
1228   command.  To load a tags file, select "Load Tags File" from the File menu and
1229   choose a tags file to load, or specify the name of the tags file on the NEdit
1230   command line:
1232       nedit -tags tags
1234   NEdit can also be set to load a tags file automatically when it starts up. 
1235   Setting the X resource nedit.tagFile to the name of a tag file tells NEdit to
1236   look for that file at startup time (see "Customizing_NEdit_").  The file name
1237   can be either a complete path name, in which case NEdit will always load the
1238   same tags file, or a file name without a path or with a relative path, in
1239   which case NEdit will load it starting from the current directory.  The
1240   second option allows you to have different tags files for different projects,
1241   each automatically loaded depending on the directory you're in when you start
1242   NEdit.  Setting the name to "tags" is an obvious choice since this is the
1243   name that ctags uses. NEdit normally evaluates relative path tag file
1244   specifications every time a file is opened. All accessible tag files are
1245   loaded at this time. To disable the automatic loading of tag files specified
1246   as relative paths, set the X resource nedit.alwaysCheckRelativeTagsSpecs to
1247   False.
1249   To unload a tags file, select "Un-load Tags File" from the File menu and
1250   choose from the list of tags files.  NEdit will keep track of tags file updates
1251   by checking the timestamp on the files, and automatically update the tags
1252   cache. 
1254   To find the definition of a function or data structure once a tags file is
1255   loaded, select the name anywhere it appears in your program (see 
1256   "Selecting_Text_") and choose "Find Definition" from the Search menu.
1257    ----------------------------------------------------------------------
1259 Calltips
1260 --------
1261   
1262   Calltips are little yellow boxes that pop up to remind you what the arguments
1263   and return type of a function are.  More generally, they're a UI mechanism to
1264   present a small amount of crucial information in a prominent location.  To 
1265   display a calltip, select some text and choose "Show Calltip" from the Search
1266   menu.  To kill a displayed calltip, hit Esc.
1267   
1268   Calltips get their information from one of two places -- either a tags file (see
1269   "Finding_Declarations_(ctags)_") or a calltips file.  First, any loaded calltips 
1270   files are searched for a definition, and if nothing is found then the tags 
1271   database is searched.  If a tag is found that matches the highlighted text then
1272   a calltip is displayed with the first few lines of the definition -- usually 
1273   enough to show you what the arguments of a function are.
1274   
1275   You can load a calltips file by using choosing "Load Calltips File" from the
1276   File menu.  You can unload a calltips file by selecting it from the 
1277   "Unload Calltips File" submenu of the File menu.  You can also choose one or
1278   more default calltips files to be loaded for each language mode using the 
1279   "Default calltips file(s)" field of the Language Modes dialog.
1280   
1281   The calltips file format is very simple.  calltips files are organized in blocks
1282   separated by blank lines.  The first line of the block is the key, which is the
1283   word that is matched when a calltip is requested.  The rest of the block is
1284   displayed as the calltip.  
1285   
1286   Almost any text at all can appear in a calltip key or a calltip.  There are no
1287   special characters that need to be escaped.  The only issues to note are that
1288   trailing whitespace is ignored, and you cannot have a blank line inside a
1289   calltip.  (Use a single period instead --  it'll be nearly invisible.)  You should
1290   also avoid calltip keys that begin and end with '@*' characters, since those are
1291   used to mark special blocks.
1293   There are five special block types--comment, include, language, alias, and 
1294   version--which are distinguished by their first lines, "@* comment @*", 
1295   "@* include @*", "@* language @*", "@* alias @*", and "@* version @*" respectively 
1296   (without quotes).
1298   Comment blocks are ignored when reading calltips files.
1300   Include blocks specify additional calltips files to load, one per line.  The ~
1301   character can be used for your $HOME directory, but other shell shortcuts like
1302   @* and ? can't be used. Include blocks allow you to make a calltips file for your
1303   project that includes, say, the calltips files for C, Motif, and Xt.
1305   Language blocks specify which language mode the calltips should be used with. 
1306   When a calltip is requested it won't match tips from languages other than the
1307   current language mode.  Language blocks only affect the tips listed after the
1308   block.
1310   Alias blocks allow a calltip to have multiple keys.  The first line of the block
1311   is the key for the calltip to be displayed, and the rest of the lines are
1312   additional keys, one per line, that should also show the calltip.
1314   Version blocks are ignored for the time being.
1316   You can use calltips in your own macros using the calltip() and kill_calltip()
1317   macro subroutines and the $calltip_ID macro variable.  See the 
1318   Macro_Subroutines_ section for details.
1319    ----------------------------------------------------------------------
1320   
1321 Regular Expressions
1322 ===================
1324 Basic Regular Expression Syntax
1325 -------------------------------
1327   Regular expressions (regex's) are useful as a way to match inexact sequences
1328   of characters.  They can be used in the `Find...' and `Replace...' search
1329   dialogs and are at the core of Color Syntax Highlighting patterns.  To specify
1330   a regular expression in a search dialog, simply click on the `Regular
1331   Expression' radio button in the dialog.
1333   A regex is a specification of a pattern to be matched in the searched text. 
1334   This pattern consists of a sequence of tokens, each being able to match a
1335   single character or a sequence of characters in the text, or assert that a
1336   specific position within the text has been reached (the latter is called an
1337   anchor.)  Tokens (also called atoms) can be modified by adding one of a number
1338   of special quantifier tokens immediately after the token.  A quantifier token
1339   specifies how many times the previous token must be matched (see below.)
1341   Tokens can be grouped together using one of a number of grouping constructs,
1342   the most common being plain parentheses.  Tokens that are grouped in this way
1343   are also collectively considered to be a regex atom, since this new larger
1344   atom may also be modified by a quantifier.
1346   A regex can also be organized into a list of alternatives by separating each
1347   alternative with pipe characters, `|'.  This is called alternation.  A match
1348   will be attempted for each alternative listed, in the order specified, until a
1349   match results or the list of alternatives is exhausted (see Alternation_
1350   section below.)
1352 3>The 'Any' Character
1354   If a dot (`.') appears in a regex, it means to match any character exactly
1355   once.  By default, dot will not match a newline character, but this behavior
1356   can be changed (see help topic Parenthetical_Constructs_, under the
1357   heading, Matching Newlines).
1359 3>Character Classes
1361   A character class, or range, matches exactly one character of text, but the
1362   candidates for matching are limited to those specified by the class.  Classes
1363   come in two flavors as described below:
1365      [...]   Regular class, match only characters listed.
1366      [^...]  Negated class, match only characters NOT listed.
1368   As with the dot token, by default negated character classes do not match
1369   newline, but can be made to do so.
1371   The characters that are considered special within a class specification are
1372   different than the rest of regex syntax as follows. If the first character in
1373   a class is the `]' character (second character if the first character is `^')
1374   it is a literal character and part of the class character set.  This also
1375   applies if the first or last character is `-'.  Outside of these rules, two
1376   characters separated by `-' form a character range which includes all the
1377   characters between the two characters as well.  For example, `[^f-j]' is the
1378   same as `[^fghij]' and means to match any character that is not `f', `g',
1379   `h', `i', or `j'.
1381 3>Anchors
1383   Anchors are assertions that you are at a very specific position within the
1384   search text.  NEdit regular expressions support the following anchor tokens:
1386      ^    Beginning of line
1387      $    End of line
1388      <    Left word boundary
1389      >    Right word boundary
1390      \B   Not a word boundary
1392   Note that the \B token ensures that the left and right characters are both
1393   delimiter characters, or that both left and right characters are
1394   non-delimiter characters.  Currently word anchors check only one character,
1395   e.g. the left word anchor `<' only asserts that the left character is a word
1396   delimiter character.  Similarly the right word anchor checks the right
1397   character.
1399 3>Quantifiers
1401   Quantifiers specify how many times the previous regular expression atom may
1402   be matched in the search text.  Some quantifiers can produce a large
1403   performance penalty, and can in some instances completely lock up NEdit.  To
1404   prevent this, avoid nested quantifiers, especially those of the maximal
1405   matching type (see below.)
1407   The following quantifiers are maximal matching, or "greedy", in that they
1408   match as much text as possible.
1410      *   Match zero or more
1411      +   Match one  or more
1412      ?   Match zero or one
1414   The following quantifiers are minimal matching, or "lazy", in that they match
1415   as little text as possible.
1417      *?   Match zero or more
1418      +?   Match one  or more
1419      ??   Match zero or one
1421   One final quantifier is the counting quantifier, or brace quantifier. It
1422   takes the following basic form:
1424      {min,max}  Match from `min' to `max' times the
1425                 previous regular expression atom.
1427   If `min' is omitted, it is assumed to be zero.  If `max' is omitted, it is
1428   assumed to be infinity.  Whether specified or assumed, `min' must be less
1429   than or equal to `max'.  Note that both `min' and `max' are limited to
1430   65535.  If both are omitted, then the construct is the same as `*'.   Note
1431   that `{,}' and `{}' are both valid brace constructs.  A single number
1432   appearing without a comma, e.g. `{3}' is short for the `{min,min}' construct,
1433   or to match exactly `min' number of times.
1435   The quantifiers `{1}' and `{1,1}' are accepted by the syntax, but are
1436   optimized away since they mean to match exactly once, which is redundant
1437   information.  Also, for efficiency, certain combinations of `min' and `max'
1438   are converted to either `*', `+', or `?' as follows:
1440      {} {,} {0,}    *
1441      {1,}           +
1442      {,1} {0,1}     ?
1444   Note that {0} and {0,0} are meaningless and will generate an error message at
1445   regular expression compile time.
1447   Brace quantifiers can also be "lazy".  For example {2,5}? would try to match
1448   2 times if possible, and will only match 3, 4, or 5 times if that is what is
1449   necessary to achieve an overall match.
1451 3>Alternation
1453   A series of alternative patterns to match can be specified by separating them
1454   with vertical pipes, `|'.  An example of _alternation would be `a|be|sea'. 
1455   This will match `a', or `be', or `sea'. Each alternative can be an
1456   arbitrarily complex regular expression. The alternatives are attempted in
1457   the order specified.  An empty alternative can be specified if desired, e.g.
1458   `a|b|'.  Since an empty alternative can match nothingness (the empty string),
1459   this guarantees that the expression will match.
1461 3>Comments
1463   Comments are of the form `(?#<comment text>)' and can be inserted anywhere
1464   and have no effect on the execution of the regular expression.  They can be
1465   handy for documenting very complex regular expressions.  Note that a comment
1466   begins with `(?#' and ends at the first occurrence of an ending parenthesis,
1467   or the end of the regular expression... period.  Comments do not recognize
1468   any escape sequences.
1469    ----------------------------------------------------------------------
1471 Metacharacters
1472 --------------
1474 3>Escaping Metacharacters
1476   In a regular expression (regex), most ordinary characters match themselves.  
1477   For example, `ab%' would match anywhere `a' followed by `b' followed by `%'
1478   appeared in the text.  Other characters don't match themselves, but are
1479   metacharacters. For example, backslash is a special metacharacter which
1480   'escapes' or changes the meaning of the character following it. Thus, to
1481   match a literal backslash would require a regular expression to have two
1482   backslashes in sequence. NEdit provides the following escape sequences so
1483   that metacharacters that are used by the regex syntax can be specified as
1484   ordinary characters.
1486      \(  \)  \-  \[  \]  \<  \>  \{  \}
1487      \.  \|  \^  \$  \*  \+  \?  \&  \\
1489 3>Special Control Characters
1491   There are some special characters that are  difficult or impossible to type. 
1492   Many of these characters can be constructed as a sort of metacharacter or
1493   sequence by preceding a literal character with a backslash. NEdit recognizes
1494   the following special character sequences:
1496      \a  alert (bell)
1497      \b  backspace
1498      \e  ASCII escape character (***)
1499      \f  form feed (new page)
1500      \n  newline
1501      \r  carriage return
1502      \t  horizontal tab
1503      \v  vertical tab
1505      *** For environments that use the EBCDIC character set,
1506          when compiling NEdit set the EBCDIC_CHARSET compiler
1507          symbol to get the EBCDIC equivalent escape
1508          character.)
1510 3>Octal and Hex Escape Sequences
1512   Any ASCII (or EBCDIC) character, except null, can be specified by using
1513   either an octal escape or a hexadecimal escape, each beginning with \0 or \x
1514   (or \X), respectively.  For example, \052 and \X2A both specify the `*'
1515   character.  Escapes for null (\00 or \x0) are not valid and will generate an
1516   error message.  Also, any escape that exceeds \0377 or \xFF will either cause
1517   an error or have any additional character(s) interpreted literally. For
1518   example, \0777 will be interpreted as \077 (a `?' character) followed by `7'
1519   since \0777 is greater than \0377.
1521   An invalid digit will also end an octal or hexadecimal escape.  For example,
1522   \091 will cause an error since `9' is not within an octal escape's range of
1523   allowable digits (0-7) and truncation before the `9' yields \0 which is
1524   invalid.
1526 3>Shortcut Escape Sequences
1528   NEdit defines some escape sequences that are handy shortcuts for commonly
1529   used character classes.
1531    \d  digits            0-9
1532    \l  letters           a-z, A-Z, and locale dependent letters
1533    \s  whitespace        \t, \r, \v, \f, and space
1534    \w  word characters   letters, digits, and underscore, `_'
1536   \D, \L, \S, and \W are the same as the lowercase versions except that the
1537   resulting character class is negated.  For example, \d is equivalent to
1538   `[0-9]', while \D is equivalent to `[^0-9]'.
1540   These escape sequences can also be used within a character class.  For
1541   example, `[\l_]' is the same as `[a-zA-Z@_]', extended with possible locale 
1542   dependent letters. The escape sequences for special characters, and octal
1543   and hexadecimal escapes are also valid within a class.
1545 3>Word Delimiter Tokens
1547   Although not strictly a character class, the following escape sequences
1548   behave similarly to character classes:
1550      \y   Word delimiter character
1551      \Y   Not a word delimiter character
1553   The `\y' token matches any single character that is one of the characters
1554   that NEdit recognizes as a word delimiter character, while the `\Y' token
1555   matches any character that is NOT a word delimiter character.  Word delimiter
1556   characters are dynamic in nature, meaning that the user can change them through
1557   preference settings.  For this reason, they must be handled differently by the
1558   regular expression engine.  As a consequence of this, `\y' and `\Y' can not be
1559   used within a character class specification.
1560    ----------------------------------------------------------------------
1562 Parenthetical Constructs
1563 ------------------------
1565 3>Capturing Parentheses
1567   Capturing Parentheses are of the form `(<regex>)' and can be used to group
1568   arbitrarily complex regular expressions.  Parentheses can be nested, but the
1569   total number of parentheses, nested or otherwise, is limited to 50 pairs. 
1570   The text that is matched by the regular expression between a matched set of
1571   parentheses is captured and available for text substitutions and
1572   backreferences (see below.)  Capturing parentheses carry a fairly high
1573   overhead both in terms of memory used and execution speed, especially if
1574   quantified by `*' or `+'.
1576 3>Non-Capturing Parentheses
1578   Non-Capturing Parentheses are of the form `(?:<regex>)' and facilitate
1579   grouping only and do not incur the overhead of normal capturing parentheses. 
1580   They should not be counted when determining numbers for capturing parentheses
1581   which are used with backreferences and substitutions.  Because of the limit
1582   on the number of capturing parentheses allowed in a regex, it is advisable to
1583   use non-capturing parentheses when possible.
1585 3>Positive Look-Ahead
1587   Positive look-ahead constructs are of the form `(?=<regex>)' and implement a
1588   zero width assertion of the enclosed regular expression.  In other words, a
1589   match of the regular expression contained in the positive look-ahead
1590   construct is attempted.  If it succeeds, control is passed to the next
1591   regular expression atom, but the text that was consumed by the positive
1592   look-ahead is first unmatched (backtracked) to the place in the text where
1593   the positive look-ahead was first encountered.
1595   One application of positive look-ahead is the manual implementation of a
1596   first character discrimination optimization.  You can include a positive
1597   look-ahead that contains a character class which lists every character that
1598   the following (potentially complex) regular expression could possibly start
1599   with.  This will quickly filter out match attempts that can not possibly
1600   succeed.
1602 3>Negative Look-Ahead
1604   Negative look-ahead takes the form `(?!<regex>)' and is exactly the same as
1605   positive look-ahead except that the enclosed regular expression must NOT
1606   match.  This can be particularly useful when you have an expression that is
1607   general, and you want to exclude some special cases.  Simply precede the
1608   general expression with a negative look-ahead that covers the special cases
1609   that need to be filtered out.
1610   
1611 3>Positive Look-Behind
1613   Positive look-behind constructs are of the form `(?<=<regex>)' and implement
1614   a zero width assertion of the enclosed regular expression in front of the
1615   current matching position.  It is similar to a positive look-ahead assertion,
1616   except for the fact the the match is attempted on the text preceding the
1617   current position, possibly even in front of the start of the matching range
1618   of the entire regular expression.
1619   
1620   A restriction on look-behind expressions is the fact that the expression
1621   must match a string of a bounded size.  In other words, `*', `+', and `{n,}'
1622   quantifiers are not allowed inside the look-behind expression. Moreover,
1623   matching performance is sensitive to the difference between the upper and
1624   lower bound on the matching size.  The smaller the difference, the better the
1625   performance.  This is especially important for regular expressions used in
1626   highlight patterns.
1627   
1628   Another (minor) restriction is the fact that look-**ahead** patterns, nor
1629   any construct that requires look-ahead information (such as word boundaries)
1630   are supported at the end of a look-behind pattern (no error is raised, but
1631   matching behaviour is unspecified). It is always possible to place these
1632   look-ahead patterns immediately after the look-behind pattern, where they
1633   will work as expected.
1634   
1635   Positive look-behind has similar applications as positive look-ahead.
1636   
1637 3>Negative Look-Behind
1639   Negative look-behind takes the form `(?<!<regex>)' and is exactly the same as
1640   positive look-behind except that the enclosed regular expression must
1641   NOT match. The same restrictions apply.
1642   
1643   Note however, that performance is even more sensitive to the distance 
1644   between the size boundaries: a negative look-behind must not match for 
1645   **any** possible size, so the matching engine must check **every** size.
1647 3>Case Sensitivity
1649   There are two parenthetical constructs that control case sensitivity:
1651      (?i<regex>)   Case insensitive; `AbcD' and `aBCd' are
1652                    equivalent.
1654      (?I<regex>)   Case sensitive;   `AbcD' and `aBCd' are
1655                    different.
1657   Regular expressions are case sensitive by default, that is, `(?I<regex>)' is
1658   assumed.  All regular expression token types respond appropriately to case
1659   insensitivity including character classes and backreferences.  There is some
1660   extra overhead involved when case insensitivity is in effect, but only to the
1661   extent of converting each character compared to lower case.
1663 3>Matching Newlines
1665   NEdit regular expressions by default handle the matching of newlines in a way
1666   that should seem natural for most editing tasks.  There are situations,
1667   however, that require finer control over how newlines are matched by some
1668   regular expression tokens.
1670   By default, NEdit regular expressions will NOT match a newline character for
1671   the following regex tokens: dot (`.'); a negated character class (`[^...]');
1672   and the following shortcuts for character classes:
1674      `\d', `\D', `\l', `\L', `\s', `\S', `\w', `\W', `\Y'
1676   The matching of newlines can be controlled for the `.' token, negated
1677   character classes, and the `\s' and `\S' shortcuts by using one of the
1678   following parenthetical constructs:
1680      (?n<regex>)  `.', `[^...]', `\s', `\S' match newlines
1682      (?N<regex>)  `.', `[^...]', `\s', `\S' don't match
1683                                             newlines
1685   `(?N<regex>)' is the default behavior.
1687 3>Notes on New Parenthetical Constructs
1689   Except for plain parentheses, none of the parenthetical constructs capture
1690   text.  If that is desired, the construct must be wrapped with capturing
1691   parentheses, e.g. `((?i<regex))'.
1693   All parenthetical constructs can be nested as deeply as desired, except for
1694   capturing parentheses which have a limit of 50 sets of parentheses,
1695   regardless of nesting level.
1697 3>Back References
1699   Backreferences allow you to match text captured by a set of capturing
1700   parenthesis at some later position in your regular expression.  A
1701   backreference is specified using a single backslash followed by a single
1702   digit from 1 to 9 (example: \3).  Backreferences have similar syntax to
1703   substitutions (see below), but are different from substitutions in that they
1704   appear within the regular expression, not the substitution string. The number
1705   specified with a backreference identifies which set of text capturing
1706   parentheses the backreference is associated with. The text that was most
1707   recently captured by these parentheses is used by the backreference to
1708   attempt a match.  As with substitutions, open parentheses are counted from
1709   left to right beginning with 1.  So the backreference `\3' will try to match
1710   another occurrence of the text most recently matched by the third set of
1711   capturing parentheses.  As an example, the regular expression `(\d)\1' could
1712   match `22', `33', or `00', but wouldn't match `19' or `01'.
1714   A backreference must be associated with a parenthetical expression that is
1715   complete.  The expression `(\w(\1))' contains an invalid backreference since
1716   the first set of parentheses are not complete at the point where the
1717   backreference appears.
1719 3>Substitution
1721   Substitution strings are used to replace text matched by a set of capturing
1722   parentheses.  The substitution string is mostly interpreted as ordinary text
1723   except as follows.
1725   The escape sequences described above for special characters, and octal and
1726   hexadecimal escapes are treated the same way by a substitution string. When
1727   the substitution string contains the `&' character, NEdit will substitute the
1728   entire string that was matched by the `Find...' operation. Any of the first
1729   nine sub-expressions of the match string can also be inserted into the
1730   replacement string.  This is done by inserting a `\' followed by a digit from
1731   1 to 9 that represents the string matched by a parenthesized expression
1732   within the regular expression.  These expressions are numbered left-to-right
1733   in order of their opening parentheses.
1735   The capitalization of text inserted by `&' or `\1', `\2', ... `\9' can be
1736   altered by preceding them with `\U', `\u', `\L', or `\l'.  `\u' and `\l'
1737   change only the first character of the inserted entity, while `\U' and `\L'
1738   change the entire entity to upper or lower case, respectively.
1739    ----------------------------------------------------------------------
1741 Advanced Topics
1742 ---------------
1744 3>Substitutions
1746   Regular expression substitution can be used to program automatic editing
1747   operations.  For example, the following are search and replace strings to find
1748   occurrences of the `C' language subroutine `get_x', reverse the first and
1749   second parameters, add a third parameter of NULL, and change the name to
1750   `new_get_x':
1752      Search string:   `get_x *\( *([^ ,]*), *([^\)]*)\)'
1753      Replace string:  `new_get_x(\2, \1, NULL)'
1755 3>Ambiguity
1757   If a regular expression could match two different parts of the text, it will
1758   match the one which begins earliest.  If both begin in the same place but
1759   match different lengths, or match the same length in different ways, life
1760   gets messier, as follows.
1762   In general, the possibilities in a list of alternatives are considered in
1763   left-to-right order.  The possibilities for `*', `+', and `?' are considered
1764   longest-first, nested constructs are considered from the outermost in, and
1765   concatenated constructs are considered leftmost-first. The match that will be
1766   chosen is the one that uses the earliest possibility in the first choice that
1767   has to be made.  If there is more than one choice, the next will be made in
1768   the same manner (earliest possibility) subject to the decision on the first
1769   choice.  And so forth.
1771   For example, `(ab|a)b*c' could match `abc' in one of two ways.  The first
1772   choice is between `ab' and `a'; since `ab' is earlier, and does lead to a
1773   successful overall match, it is chosen.  Since the `b' is already spoken for,
1774   the `b*' must match its last possibility, the empty string, since it must
1775   respect the earlier choice.
1777   In the particular case where no `|'s are present and there is only one `*',
1778   `+', or `?', the net effect is that the longest possible match will be
1779   chosen.  So `ab*', presented with `xabbbby', will match `abbbb'.  Note that
1780   if `ab*' is tried against `xabyabbbz', it will match `ab' just after `x', due
1781   to the begins-earliest rule.  (In effect, the decision on where to start the
1782   match is the first choice to be made, hence subsequent choices must respect
1783   it even if this leads them to less-preferred alternatives.)
1785 3>References
1787   An excellent book on the care and feeding of regular expressions is
1789           Mastering Regular Expressions, 2nd Edition
1790           Jeffrey E. F. Friedl
1791           2002, O'Reilly & Associates
1792           ISBN 0-596-00289-0
1793    ----------------------------------------------------------------------
1795 Example Regular Expressions
1796 ---------------------------
1798   The following are regular expression examples which will match:
1800 * An entire line.
1801 !       ^.*$
1803 * Blank lines.
1804 !       ^$
1806 * Whitespace on a line.
1807 !       \s+
1809 * Whitespace across lines.
1810 !       (?n\s+)
1812 * Whitespace that spans at least two lines. Note minimal matching `*?' quantifier.
1813 !       (?n\s*?\n\s*)
1815 * IP address (not robust).
1816 !       (?:\d{1,3}(?:\.\d{1,3}){3})
1818 * Two character US Postal state abbreviations (includes territories).
1819 !       [ACDF-IK-PR-W][A-Z]
1821 * Web addresses.
1822 !       (?:http://)?www\.\S+
1824 * Case insensitive double words across line breaks.
1825 !       (?i(?n<(\S+)\s+\1>))
1827 * Upper case words with possible punctuation.
1828 !       <[A-Z][^a-z\s]*>
1830    ----------------------------------------------------------------------
1832 Macro/Shell Extensions
1833 ======================
1835 Shell Commands and Filters
1836 --------------------------
1838   The Shell menu (Unix versions only) allows you to execute Unix shell commands
1839   from within NEdit.  You can add items to the menu to extend NEdit's command
1840   set or to incorporate custom automatic editing features using shell commands
1841   or editing languages like awk and sed.  To add items to the menu, select
1842   Preferences -> Default Settings Customize Menus -> Shell Menu.  NEdit comes
1843   pre-configured with a few useful Unix commands like spell and sort, but we
1844   encourage you to add your own custom extensions.
1846   Filter Selection... prompts you for a Unix command to use to process the
1847   currently selected text.  The output from this command replaces the contents
1848   of the selection.
1850   Execute Command... prompts you for a Unix command and replaces the current
1851   selection with the output of the command.  If there is no  selection, it
1852   deposits the output at the current insertion point. In the Shell Command
1853   field, the % character expands to the name (including directory path), and
1854   the # character expands to the current line number of the file in the window.
1855   To include a % or # character in the command, use %% or ##, respectively.  
1857   Execute Command Line uses the position of the cursor in the window to
1858   indicate a line to execute as a shell command line.  The cursor may be
1859   positioned anywhere on the line.  This command allows you to use an NEdit
1860   window as an editable command window for saving output and saving commands
1861   for re-execution. Note that the same character expansions described above
1862   in Execute Command also occur with this command.
1864   The X resource called nedit.shell (See "Customizing_NEdit_") determines which
1865   Unix shell is used to execute commands.  The default value for this resource
1866   is /bin/csh.
1867    ----------------------------------------------------------------------
1869 Learn/Replay
1870 ------------
1872   Selecting Learn Keystrokes from the Macro menu puts NEdit in learn mode.  In
1873   learn mode, keystrokes and menu commands are recorded, to be played back
1874   later, using the Replay Keystrokes command, or pasted into a macro in the
1875   Macro Commands dialog of the Default Settings menu in Preferences.
1877   Note that only keyboard and menu commands are recorded, not mouse clicks or
1878   mouse movements since these have no absolute point of reference, such as
1879   cursor or selection position.  When you do a mouse-based operation in learn
1880   mode, NEdit will beep (repeatedly) to remind you that the operation was not
1881   recorded.
1883   Learn mode is also the quickest and easiest method for writing macros.  The
1884   dialog for creating macro commands contains a button labeled "Paste Learn /
1885   Replay Macro", which will deposit the last sequence learned into the body of
1886   the macro.
1888 3>Repeating Actions and Learn/Replay Sequences
1890   You can repeat the last (keyboard-based) command, or learn/replay sequence
1891   with the Repeat... command in the Macro menu.  To repeat an action, first do
1892   the action (that is, insert a character, do a search, move the cursor), then
1893   select Repeat..., decide how or how many times you want it repeated, and
1894   click OK.  For example, to move down 30 lines through a file, you could type:
1895   <Down Arrow> Ctrl+, 29 <Return>.  To repeat a learn/replay sequence, first
1896   learn it, then select Repeat..., click on Learn/Replay and how you want it
1897   repeated, then click OK.
1899   If the commands you are repeating advance the cursor through the file, you
1900   can also repeat them within a range of characters, or from the current cursor
1901   position to the end of the file.  To iterate over a range of characters, use
1902   the primary selection (drag the left mouse button over the text) to mark the
1903   range you want to operate on, and select "In Selection" in the Repeat dialog.
1905   When using In "Selection" or "To End" with a learned sequence, try to do
1906   cursor movement as the last step in the sequence, since testing of the cursor
1907   position is only done at the end of the sequence execution.  If you do cursor
1908   movement first, for example searching for a particular word then doing a
1909   modification, the position of the cursor won't be checked until the sequence
1910   has potentially gone far beyond the end of your desired range.
1912   It's easy for a repeated command to get out of hand, and you can easily
1913   generate an infinite loop by using range iteration on a command which doesn't
1914   progress.  To cancel a repeating command in progress, type Ctrl+. (period),
1915   or select Cancel Macro from the Macro menu.
1916    ----------------------------------------------------------------------
1918 Macro Language
1919 --------------
1921   Macros can be called from Macro menu commands, window background menu
1922   commands, within the smart-indent framework, from the autoload macro file and
1923   from the command line.
1924   Macro menu and window background menu commands are defined under Preferences
1925   -> Default Settings -> Customize Menus.  Help on creating items in these
1926   menus can be found in the section, Help -> Customizing -> Preferences.
1928   The autoload macro file is a file of macro commands and definitions which
1929   NEdit will automatically execute when it is first started.  Its location is
1930   dependent on your environment:
1931   
1932 * The default place for the file is '$HOME/.nedit/autoload.nm',
1933 * if the variable $NEDIT_HOME is set in your environment it is located at '$NEDIT_HOME/autoload.nm',
1934 * if you are using old-style run control files (i.e. $HOME/.nedit is a regular file) it is located in '$HOME/.neditmacro'.
1936   (For VMS, the file is in '$NEDIT_HOME/autoload.nm' if $NEDIT_HOME is set, in
1937   'SYS$LOGIN:.neditmacro' otherwise.)
1939   NEdit's macro language is a simple interpreter with integer arithmetic,
1940   dynamic strings, and C-style looping constructs (very similar to the
1941   procedural portion of the Unix awk program).  From the macro language, you
1942   can call the same action routines which are bound to keyboard keys and menu
1943   items, as well additional subroutines for accessing and manipulating editor
1944   data, which are specific to the macro language (these are listed in the
1945   sections titled "Macro_Subroutines_", and "Action_Routines_").
1948 3>Syntax
1950   An NEdit macro language program consists of a list of statements, each
1951   terminated by a newline.  Groups of statements which are executed together
1952   conditionally, such as the body of a loop, are surrounded by curly braces
1953   "{}".
1955   Blank lines and comments are also allowed.  Comments begin with a "#" and end
1956   with a newline, and can appear either on a line by themselves, or at the end
1957   of a statement.
1959   Statements which are too long to fit on a single line may be split across
1960   several lines, by placing a backslash "\" character at the end of each line
1961   to be continued.
1964 3>Data Types
1966   The NEdit macro language recognizes only three data types, dynamic character
1967   strings, integer values and associative arrays. In general strings and
1968   integers can be used interchangeably. If a string represents an integer
1969   value, it can be used as an integer. Integers can be compared and
1970   concatenated with strings. Arrays may contain integers, strings, or arrays.
1971   Arrays are stored key/value pairs. Keys are always stored as strings.
1973 4>Integer Constants
1975   Integers are non-fractional numbers in the range of -2147483647 to
1976   2147483647.  Integer constants must be in decimal.  For example:
1978     a = -1
1979     b = 1000
1981 4>Character String Constants
1983   Character string constants are enclosed in double quotes.  For example:
1985      a = "a string"
1986      dialog("Hi there!", "OK")
1988   Strings may also include C-language style escape sequences:
1990      \\ Backslash     \t Tab              \f Form feed
1991      \" Double quote  \b Backspace        \a Alert
1992      \n Newline       \r Carriage return  \v Vertical tab
1994   For example, to send output to the terminal from which NEdit was started, a
1995   newline character is necessary because, like printf, t_print requires
1996   explicit newlines, and also buffers its output on a per-line basis:
1998      t_print("a = " a "\n")
2001 3>Variables
2003   Variable names must begin either with a letter (local variables), or a $
2004   (global variables).  Beyond the first character, variables may also contain
2005   numbers and underscores `_'.  Variables are called in to existence just by
2006   setting them (no explicit declarations are necessary).
2008   Local variables are limited in scope to the subroutine (or menu item
2009   definition) in which they appear.  Global variables are accessible from all
2010   routines, and their values persist beyond the call which created them, until
2011   reset.
2013 4>Built-in Variables
2015   NEdit has a number of permanently defined variables, which are used to access
2016   global editor information and information about the the window in which the
2017   macro is executing.  These are listed along with the built in functions in
2018   the section titled "Macro_Subroutines_".
2021 3>Functions and Subroutines
2023   The syntax of a function or subroutine call is:
2025      function_name(arg1, arg2, ...)
2027   where arg1, arg2, etc. represent the argument values which are passed to
2028   the routine being called.  A function or subroutine call can be on a line by
2029   itself, as above, or if it returns a value, can be invoked within a character
2030   or numeric expression:
2032      a = fn1(b, c) + fn2(d)
2033      dialog("fn3 says: " fn3())
2035   Arguments are passed by value.  This means that you can not return values via
2036   the argument list, only through the function value or indirectly through
2037   agreed-upon global variables.
2039 4>Built-in Functions
2041   NEdit has a wide range of built in functions which can be called from the
2042   macro language.  These routines are divided into two classes, macro-language
2043   functions, and editor action routines.  Editor action routines are more
2044   flexible, in that they may be called either from the macro language, or bound
2045   directly to keys via translation tables.  They are also limited, however, in
2046   that they can not return values.  Macro language routines can return values,
2047   but can not be bound to keys in translation tables.
2049   Nearly all of the built-in subroutines operate on an implied window, which is
2050   initially the window from which the macro was started.  To manipulate the
2051   contents of other windows, use the focus_window subroutine to change the
2052   focus to the ones you wish to modify.  focus_window can also be used to
2053   iterate over all of the currently open windows, using the special keyword
2054   names, "last" and "next".
2056   For backwards compatibility, hyphenated action routine names are allowed, and
2057   most of the existing action routines names which contain underscores have an
2058   equivalent version containing hyphens ('-') instead of underscores.  Use of
2059   these names is discouraged.  The macro parser resolves the ambiguity between
2060   '-' as the subtraction/negation operator, and - as part of an action routine
2061   name by assuming subtraction unless the symbol specifically matches an action
2062   routine name.
2064 4>User Defined Functions
2066   Users can define their own macro subroutines, using the define keyword:
2068      define subroutine_name {
2069         < body of subroutine >
2070      }
2072   Macro definitions can not appear within other definitions, or within macro
2073   menu item definitions (usually they are found in the autoload macro file).
2075   The arguments with which a user-defined subroutine or function was invoked,
2076   are presented as $1, $2, ... , $9 or $args[expr], where expr can be evaluated
2077   to an integer from 1 to the number of arguments.  The number of arguments can
2078   be read from $n_args or $args[]. The array $args[expr] is the only way to
2079   access arguments beyond the first 9.
2081   To return a value from a subroutine, and/or to exit from the subroutine
2082   before the end of the subroutine body, use the return statement:
2084      return <value to return>
2087 3>Operators and Expressions
2089   Operators have the same meaning and precedence that they do in C, except for
2090   ^, which raises a number to a power (y^x means y to the x power), rather than
2091   bitwise exclusive OR.  The table below lists operators in decreasing order of
2092   precedence.
2094      Operators                Associativity
2095      ()
2096      ^                        right to left
2097      - ! ++ --                (unary)
2098      * / %                    left to right
2099      + -                      left to right
2100      > >= < <= == !=          left to right
2101      &                        left to right
2102      |                        left to right
2103      &&                       left to right
2104      ||                       left to right
2105      (concatenation)          left to right
2106      = += -= *= /= %=, &= |=  right to left
2108   The order in which operands are evaluated in an expression is undefined,
2109   except for && and ||, which like C, evaluate operands left to right, but stop
2110   when further evaluation would no longer change the result.
2112 4>Numerical Operators
2114   The numeric operators supported by the NEdit macro language are listed below:
2116      + addition
2117      - subtraction or negation
2118      * multiplication
2119      / division
2120      % modulo
2121      ^ power
2122      & bitwise and
2123      | bitwise or
2125   Increment (++) and decrement (--) operators can also be appended or prepended
2126   to variables within an expression.  Prepended increment/decrement operators
2127   act before the variable is evaluated.  Appended increment/decrement operators
2128   act after the variable is evaluated.
2130 4>Logical and Comparison Operators
2132   Logical operations produce a result of 0 (for false) or 1 (for true).  In a
2133   logical operation, any non-zero value is recognized to mean true.  The
2134   logical and comparison operators allowed in the NEdit macro language are
2135   listed below:
2137      && logical and
2138      || logical or
2139      !  not
2140      >  greater
2141      <  less
2142      >= greater or equal
2143      <= less or equal
2144      == equal (integers and/or strings)
2145      != not equal (integers and/or strings)
2147 4>Character String Operators
2149   The "operator" for concatenating two strings is the absence of an operator. 
2150   Adjoining character strings with no operator in between means concatenation:
2152      d = a b "string" c
2153      t_print("the value of a is: " a)
2155   Comparison between character strings is done with the == and != operators,
2156   (as with integers).  There are a number of useful built-in routines for
2157   working with character strings, which are listed in the section called 
2158   "Macro_Subroutines_".
2160 4>Arrays and Array Operators
2162   Arrays may contain either strings, integers, or other arrays. Arrays are 
2163   associative, which means that they relate two pieces of information, the key
2164   and  the value. The key is always a string; if you use an integer it is
2165   converted to a string.
2167   To determine if a given key is in an array, use the 'in' keyword.
2169       if ("6" in x)
2170           <body>
2172   If the left side of the in keyword is an array, the result is true if every
2173   key in the left array is in the right array. Array values are not compared.
2175   To iterate through all the keys of an array use the 'for' looping construct.
2176   Keys are not guaranteed in any particular order:
2178       for (aKey in x)
2179           <body>
2181   Elements can be removed from an array using the delete command:
2183       delete x[3] # deletes element with key 3
2184       delete x[]  # deletes all elements
2186   The number of elements in an array can be determined by referencing the
2187   array with no indices:
2189       dialog("array x has " x[] " elements", "OK")
2191   Arrays can be combined with some operators. All the following operators only 
2192   compare the keys of the arrays.
2194       result = x + y   (Merge arrays)
2195       
2196   The 'result' is a new array containing keys from both x and y. If
2197   duplicates are present values from y are used.
2198           
2199       result = x - y   (Remove keys)
2201   The 'result' is a new array containing all keys from x that are not in y.
2202           
2203       result = x & y   (Common keys)
2204           
2205   The 'result' is a new array containing all keys which are in both x and y.
2206   The values from y are used.
2207           
2208       result = x | y   (Unique keys)
2209       
2210   The 'result' is a new array containing keys which exist in either x or y, 
2211   but not both.
2213   When duplicate keys are encountered using the + and & operators, the values 
2214   from the array on the right side of the operators are used for the result.
2215   All  of the above operators are array only, meaning both the left and right
2216   sides of the operator must be arrays. The results are also arrays.
2218   Array keys can also contain multiple dimensions:
2219   
2220       x[1, 1, 1] = "string"
2222   These are used in the expected way, e.g.:
2223   
2224       for (i = 1; i < 3; i++)
2225       {
2226           for (j = 1; j < 3; j++)
2227           {
2228               x[i, j] = k++
2229           }
2230       }
2231       
2232   gives the following array:
2233   
2234       x[1, 1] = 0
2235       x[1, 2] = 1
2236       x[2, 1] = 2
2237       x[2, 2] = 3
2239   Internally all indices are part of one string, separated by the string 
2240   $sub_sep (ASCII 0x1c, 'FS'). The first key in the above example is in
2241   fact:
2242   
2243       ["1" $sub_sep "1"]
2245   If you need to extract one of the keys, you can use split(), using 
2246   $sub_sep as the separator.
2248   You can also check for the existence of multi-dimensional array by 
2249   looking for $sub_sep in the key.
2251   Last, you need $sub_sep if you want to use the 'in' keyword.
2252   
2253       if ((1,2) in myArray)
2254       {..}
2255       
2256   doesn't work, but
2257   
2258       if (("1" $sub_sep "2") in myArray)
2259       {..}
2260       
2261   does work.
2263 3>Looping and Conditionals
2265   NEdit supports looping constructs: for and while, and conditional statements:
2266   if and else, with essentially the same syntax as C:
2268      for (<init>, ...; <condition>; <increment>, ...) <body>
2270      while (<condition>) <body>
2272      if (<condition>) <body>
2274      if (<condition>) <body> else <body>
2276   <body>, as in C, can be a single statement, or a list of statements enclosed
2277   in curly braces ({}).  <condition> is an expression which must evaluate to
2278   true for the statements in <body> to be executed.  for loops may also contain
2279   initialization statements, <init>, executed once at the beginning of the
2280   loop, and increment/decrement statements (or any arbitrary statement), which
2281   are executed at the end of the loop, before the condition is evaluated again.
2283   Examples:
2285     for (i=0; i<100; i++)
2286        j = i * 2
2288     for (i=0, j=20; i<20; i++, j--) {
2289        k = i * j
2290        t_print(i, j, k)
2291     }
2293     while (k > 0)
2294     {
2295        k = k - 1
2296        t_print(k)
2297     }
2299     for (;;) {
2300        if (i-- < 1)
2301            break
2302     }
2304   Loops may contain break and continue statements.  A break statement causes an
2305   exit from the innermost loop, a continue statement transfers control to the
2306   end of the loop.
2307    ----------------------------------------------------------------------
2309 Macro Subroutines
2310 -----------------
2312 3>Built in Variables
2314   These variables are read-only and can not be changed.
2316 **$1**, **$2**, **$3**, **$4**, **$5**, **$6**, **$7**, **$8**, **$9**
2317 **$args**[~expr~]
2318 **$n_args**
2319   Argument information. The first 9 arguments (if there are that many) can
2320   be referenced as read-only values using the shorthand form. All arguments
2321   can be accessed as values in the **$args** array, using a numeric index
2322   starting at 1. The total number of arguments received by a function is
2323   given by **$n_args** or **$args[]**.
2325 **$active_pane**
2326   Index of the current pane.
2328 **$auto_indent**
2329   Contains the current preference for auto indent. 
2330   Can be  "off", "on" or "auto".
2332 **$calltip_ID**
2333   Equals the ID of the currently displayed calltip, or 0 if no calltip is
2334   being displayed.
2336 **$cursor**
2337   Position of the cursor in the current window.
2339 **$column**
2340   Column number of the cursor position in the current window.
2342 **$display_width**
2343   Width of the current pane in pixels.
2345 **$em_tab_dist**
2346   If tab emulation is turned on in the Tabs...
2347   dialog of the Preferences menu, value is the
2348   distance between emulated tab stops. If tab
2349   emulation is turned off, value is -1.
2351 **$empty_array**
2352   An array with no elements. This can be used to initialize 
2353   an array to an empty state.
2355 **$file_format**
2356   Current newline format that the file will be saved with. Can 
2357   be "unix", "dos" or "macintosh".
2359 **$file_name**
2360   Name of the file being edited in the current
2361   window, stripped of directory component.
2363 **$file_path**
2364   Directory component of file being edited in the current window.
2366 **$font_name**
2367   Contains the current plain text font name.
2369 **$font_name_bold**
2370   Contains the current bold text font name.
2372 **$font_name_bold_italic**
2373   Contains the current bold-italic text font name.
2375 **$font_name_italic**
2376   Contains the current italic text font name.
2378 **$highlight_syntax**
2379   Whether syntax highlighting is turned on.
2381 **$incremental_backup**
2382   Contains 1 if incremental auto saving is on, otherwise 0.
2384 **$incremental_search_line**
2385   Has a value of 1 if the preference is 
2386   selected to always show the incremental search line, otherwise 0.
2388 **$language_mode**
2389   Name of language mode set in the current window.
2391 **$line**
2392   Line number of the cursor position in the current window.
2394 **$locked**
2395   True if the file has been locked by the user.
2397 **$make_backup_copy**
2398   Has a value of 1 if original file is kept in a 
2399   backup file on save, otherwise 0.
2401 **$max_font_width**
2402   The maximum font width of all the active styles. 
2403   Syntax highlighting styles are only considered if syntax highlighting 
2404   is turned on.
2406 **$min_font_width**
2407   The minimum font width of all the active styles. 
2408   Syntax highlighting styles are only considered if syntax highlighting 
2409   is turned on.
2411 **$modified**
2412   True if the file in the current window has
2413   been modified and the modifications have not
2414   yet been saved.
2416 **$n_display_lines**
2417   The number of lines visible in the currently active pane.
2419 **$n_panes**
2420   The number of panes in the current window.
2422 **$overtype_mode**
2423   True if in Overtype mode.
2425 **$read_only**
2426   True if the file is read only.
2428 **$selection_start, $selection_end**   
2429   Beginning and ending positions of the
2430   primary selection in the current window, or
2431   -1 if there is no text selected in the current window.
2433 **$selection_left, $selection_right**  
2434   Left and right character offsets of the rectangular (primary) selection in
2435   the current window, or -1 if there is no selection or it is not rectangular.
2437 **$server_name**
2438   Name of the current NEdit server.
2440 **$show_line_numbers**
2441   Whether line numbers are shown next to the text.
2443 **$show_matching**
2444   Contains the current preference for showing matching pairs, 
2445   such as "[]" and "{}" pairs. Can be "off", "delimiter", or "range".
2447 **$match_syntax_based**
2448   Whether pair matching should use syntax information, if available.
2450 **$statistics_line**
2451   Has a value of 1 if the statistics line is shown, otherwise 0.
2453 **$sub_sep**
2454   Contains the value of the array sub-script separation string.
2456 **$tab_dist**
2457   The distance between tab stops for a
2458   hardware tab character, as set in the
2459   Tabs... dialog of the Preferences menu.
2461 **$text_length**
2462   The length of the text in the current window.
2464 **$top_line**
2465   The line number of the top line of the currently active pane.
2467 **$use_tabs**
2468   Whether the user is allowing the NEdit to insert tab characters to maintain
2469   spacing in tab emulation and rectangular dragging operations. (The setting of
2470   the "Use tab characters in padding and emulated tabs" button in the Tabs...
2471   dialog of the Preferences menu.)
2473 **$wrap_margin**
2474   The right margin in the current window for text wrapping and filling.
2476 **$wrap_text**
2477   The current wrap text mode. Values are "none", "auto" or "continuous".
2479 ..Disabled for 5.4 release.
2480 ..**$backlight_string**
2481 ..  The current value of the window's backlighting specification. This is empty
2482 ..  if backlighting is turned off. It can be changed through calls to the
2483 ..  built-in macro function set_backlight_string().
2486 3>Built-in Subroutines
2488 **append_file( string, filename )**
2489   Appends a string to a named file. Returns 1 on successful write, or 0 if
2490   unsuccessful.
2492 **beep()**
2493   Ring the bell.
2495 **calltip( "text_or_key" [, pos [, mode or position_modifier, ...]] )**
2496   Pops up a calltip. <pos> is an optional position in the buffer where the tip
2497   will be displayed.  Passing -1 for <pos> is equivalent to not specifying a 
2498   position, and it guarantees that the tip will appear on-screen somewhere even
2499   if the cursor is not.  The upper-left corner of the calltip will appear below
2500   where the cursor would appear if it were at this position.  <mode> is one of
2501   "tipText" (default), "tipKey", or "tagKey". "tipText" displays the text as-is,
2502   "tagKey" uses it as the key to look up a tag, then converts the tag to a
2503   calltip, and "tipKey" uses it as the key to look up a calltip, then falls back
2504   to "tagKey" behavior if that fails.  You'll usually use "tipKey" or "tipText".
2505   Finally, you can modify the placement of the calltip relative to the cursor
2506   position (or <pos>) with one or more of these optional position modifiers:
2507   "center" aligns the center of the calltip with the position.  "right" aligns
2508   the right edge of the calltip with the position.  ("center" and "right" may 
2509   not both be used.)  "above" places the calltip above the position.  "strict"
2510   does not allow the calltip to move from its position in order to avoid going 
2511   off-screen or obscuring the cursor.  Returns the ID of the calltip if it was 
2512   found and/or displayed correctly, 0 otherwise.
2514 **clipboard_to_string()**  
2515   Returns the contents of the clipboard as a macro string. Returns empty
2516   string on error.
2518 **dialog( message, btn_1_label, btn_2_label, ... )**  
2519   Pop up a dialog for querying and presenting information to the user. First
2520   argument is a string to show in the message area of the dialog. Up to eight
2521   additional optional arguments represent labels for buttons to appear along
2522   the bottom of the dialog. Returns the number of the button pressed (the
2523   first button is number 1), or 0 if the user closed the dialog via the window
2524   close box.
2526 **focus_window( window_name )**  
2527   Sets the window on which subsequent macro commands operate. window_name can
2528   be either a fully qualified file name, or one of "last" for the last window
2529   created, or "next" for the next window in the chain from the currently
2530   focused window (the first window being the one returned from calling
2531   focus_window("last"). Returns the name of the newly-focused window, or an
2532   empty string if the requested window was not found.
2534 **get_character( position )**  
2535   Returns the single character at the position
2536   indicated by the first argument to the routine from the current window.
2538 **get_range( start, end )**  
2539   Returns the text between a starting and ending position from the current
2540   window.
2542 **get_selection()**  
2543   Returns a string containing the text currently selected by the primary
2544   selection either from the current window (no keyword), or from anywhere on
2545   the screen (keyword "any").
2547 **getenv( name )**
2548   Gets the value of an environment variable.
2550 **kill_calltip( [calltip_ID] )**
2551   Kills any calltip that is being displayed in the window in which the macro is
2552   running.  If there is no displayed calltip this does nothing.  If a calltip
2553   ID is supplied then the calltip is killed only if its ID is calltip_ID.
2555 **length( string )**
2556   Returns the length of a string
2558 **list_dialog( message, text, btn_1_label, btn_2_label, ... )**  
2559   Pop up a dialog for prompting the user to choose a line from the given text
2560   string. The first argument is a message string to be used as a title for the
2561   fixed text describing the list. The second string provides the list data:
2562   this is a text string in which list entries are separated by newline
2563   characters. Up to seven additional optional arguments represent labels for
2564   buttons to appear along the bottom of the dialog. Returns the line of text
2565   selected by the user as the function value (without any newline separator) or
2566   the empty string if none was selected, and number of the button pressed (the
2567   first button is number 1), in $list_dialog_button. If the user closes the
2568   dialog via the window close box, the function returns the empty string, and
2569   $list_dialog_button returns 0.
2571 **max( n1, n2, ... )**
2572   Returns the maximum value of all of its arguments
2574 **min( n1, n2, ... )**
2575   Returns the minimum value of all of its arguments
2577 **read_file( filename )**  
2578   Reads the contents of a text file into a string. On success, returns 1 in
2579   $read_status, and the contents of the file as a string in the subroutine
2580   return value. On failure, returns the empty string "" and an 0 $read_status.
2582 **replace_in_string( string, search_for, replace_with [, type, "copy"] )**  
2583   Replaces all occurrences of a search string in a string with a replacement
2584   string. Arguments are 1: string to search in, 2: string to search for, 3:
2585   replacement string.  There are two optional arguments.  One is a search type, 
2586   either "literal", "case", "word", "caseWord", "regex", or "regexNoCase".  
2587   The default search type is "literal".  If the optional "copy" argument is
2588   specified, a copy of the input string is returned when no replacements were
2589   performed.  By default an empty string ("") will be returned in this case.
2590   Returns a new string with all of the replacements done.
2592 **replace_range( start, end, string )**  
2593   Replaces all of the text in the current window between two positions.
2595 **replace_selection( string )**  
2596   Replaces the primary-selection selected text in the current window.
2598 **replace_substring( string, start, end, replace_with )**  
2599   Replacing a substring between two positions in a string within another string.
2601 **search( search_for, start [, search_type, wrap, direction] )**  
2602   Searches silently in a window without dialogs, beeps, or changes to the
2603   selection. Arguments are: 1: string to search for, 2: starting position.
2604   Optional arguments may include the strings: "wrap" to make the search wrap
2605   around the beginning or end of the string, "backward" or "forward" to change
2606   the search direction ("forward" is the default), "literal", "case", "word",
2607   "caseWord", "regex", or "regexNoCase" to change the search  type  (default is
2608   "literal"). Returns the starting position of the  match, or -1 if nothing
2609   matched. Also returns the ending position  of the match in $search_end.
2611 **search_string( string, search_for, start [, search_type, direction] )** 
2613   Built-in macro subroutine for searching a string. Arguments are 1: string to
2614   search in, 2: string to search for, 3: starting position. Optional arguments
2615   may include the strings: "wrap" to make the search wrap around the beginning
2616   or end of the string, "backward" or "forward" to change the search direction
2617   ("forward" is the default), "literal", "case", "word", "caseWord", "regex",
2618   or "regexNoCase" to change the search type (default is "literal"). Returns
2619   the starting position of the match, or -1 if nothing matched. Also returns
2620   the ending position of the match in $search_end.
2622 **select( start, end )**  
2623   Selects (with the primary selection) text in the current buffer between a
2624   starting and ending position.
2626 **select_rectangle( start, end, left, right )**  
2627   Selects a rectangular area of text between a starting and ending position,
2628   and confined horizontally to characters displayed between positions "left",
2629   and "right".
2631 ..Disabled for 5.4 release.
2632 ..**set_backlight_string( [string] )**
2633 ..  Applies the given string, which should be in the format of the
2634 ..  nedit*backlightCharTypes X resource, to the current text window, turning on
2635 ..  backlighting.  If the value of the string passed is "default", or if no
2636 ..  parameter is passed, the nedit.backlightCharTypes X resource's own value will
2637 ..  be used.  If the empty string, "", is passed, backlighting will be turned
2638 ..  off.
2640 **set_cursor_pos( position )**
2641   Set the cursor position for the current window.
2643 **shell_command( command, input_string )**  
2644   Executes a shell command, feeding it input from input_string. On completion,
2645   output from the command is returned as the function value, and the command's
2646   exit status is returned in the global variable $shell_cmd_status.
2648 **split(string, separation_string [, search_type])**
2649   Splits a string using the separator specified. Optionally the search_type
2650   argument can specify how the separation_string is interpreted. The default 
2651   is "literal". The returned value is an array with keys beginning at 0.
2653 **string_dialog( message, btn_1_label, btn_2_label, ... )**  
2654   Pops up a dialog prompting the user to enter information. The first argument
2655   is a string to show in the message area of the dialog. Up to nine additional
2656   optional arguments represent labels for buttons to appear along the bottom of
2657   the dialog. Returns the string entered by the user as the function value,
2658   and number of the button pressed (the first button is number 1), in
2659   $string_dialog_button. If the user closes the dialog via the window close
2660   box, the function returns the empty string, and $string_dialog_button returns
2661   0.
2663 **string_compare(string1, string2 [, consider-case])**
2664   Compare two  strings and return 0 if they are equal, -1 if string1 is less
2665   than  string2 or 1 if string1 is greater than string2. The values for the
2666   optional consider-case argument is either "case" or "nocase". The default 
2667   is to do a case sensitive comparison.
2669 **string_to_clipboard( string )**  
2670   Copy the contents of a macro string to the clipboard.
2672 **substring( string, start, end )**  
2673   Returns the portion of a string between a starting and ending position.
2675 **t_print( string1, string2, ... )**  
2676   Writes strings to the terminal (stdout) from which NEdit was started.
2678 **tolower( string )**
2679   Return an all lower-case version of string.
2681 **toupper( string )**
2682   Return an all upper-case version of string.
2684 **valid_number( string )**
2685   Returns 1 if the string can be converted to a number without error
2686   following the same rules that the implicit conversion would. Otherwise 0.
2688 **write_file( string, filename )**  
2689   Writes a string (parameter 1) to a file named in parameter 2. Returns 1 on
2690   successful write, or 0 if unsuccessful.
2693 3>Deprecated Functions
2695   Some functions are included only for supporting legacy macros. You should not
2696   use any of these functions in any new macro you write. Among these are all
2697   action routines with hyphens in their names; use underscores instead
2698   ('find-dialog' -> 'find_dialog').
2700 **match()**
2701   **DEPRECATED** Use select_to_matching() instead.
2703    ----------------------------------------------------------------------
2705 Range Sets
2706 ----------
2708   A rangeset is a set of ranges. A range is a contiguous range of characters
2709   defined by its start and end position in the text buffer.  The user can
2710   create rangesets, identified by arbitrary integers (chosen by the editor when
2711   the rangesets are created), and each range within a rangeset is identified by
2712   a numeric index, counting from 1, in the order of appearance in the text
2713   buffer.  The ranges are adjusted when modifications are made to the text 
2714   buffer: they shuffle around when characters are added or deleted.  However,
2715   ranges within a set will coalesce if the characters between them are removed,
2716   or a new range is added to the set which bridges or overlaps others.
2717   
2718   Using rangesets allows non-contiguous bits of the text to be identified as a
2719   group.
2721   Rangesets can be assigned a background color: characters within a range of a
2722   rangeset will have the background color of the rangeset. If more than one
2723   rangeset includes a given character, its background color will be that of the
2724   most recently created rangeset which has a color defined.
2725   
2726   Rangesets must be created using the rangeset_create() function, which 
2727   will return an identifier for the newly-created rangeset.  This identifier
2728   is then passed to the other rangeset functions to manipulate the rangeset.
2729     
2730   There is a limit to the number of rangesets which can exist at any time -
2731   currently up to 63 in each text buffer.  Care should be taken to destroy
2732   any rangesets which are no longer needed, by using the rangeset_destroy()
2733   function, if this limit is attained.
2735   Rangesets can be named: this is useful for macros which need a fixed
2736   identification for rangesets which are used for the same purpose in
2737   different documents.  Although a new rangeset's number is arbitrary, its
2738   name can be fixed.  This is done using the rangeset_set_name() function. 
2739   Note that rangeset names within a particular document may not be unique.
2740   For this reason, the rangeset_get_by_name() function returns an array of
2741   identifiers, which will be empty if the name has not been associated with
2742   a rangeset.
2744   Warnings: A rangeset is manipulated ONLY through macro routines. Rangesets
2745   can easily become very large, and may exceed the capacity of the running
2746   process.  Coloring relies on proper color names or specifications (such as
2747   the "#rrggbb" hexadecimal digit strings), and appropriate hardware support. 
2748   Behaviours set using rangeset_set_mode() are still experimental.
2752 3>Rangeset read-only variables
2754 **$rangeset_list**
2755   array of active rangeset identifiers, with integer keys starting at 0,
2756   in the order the rangesets were defined.
2759 3>Rangeset functions
2761 **rangeset_create()**
2762 **rangeset_create( n )**
2763   Creates one or more new rangesets. The first form creates a single range
2764   set and returns its identifier; if there are no rangesets available it 
2765   returns 0. The second form creates n new rangesets, and returns an array 
2766   of the rangeset identifiers with keys beginning at 0. If the requested 
2767   number of rangesets is not available it returns an empty array.
2768   
2769 **rangeset_destroy( r )**
2770 **rangeset_destroy( array )**
2771   Deletes all information about a rangeset or a number of rangesets. The
2772   first form destroys the rangeset identified by r. The second form should 
2773   be passed an array of rangeset identifiers with keys beginning at 0 (i.e.
2774   the same form of array returned by rangeset_create(n); it destroys all the
2775   rangesets appearing in the array. If any of the rangesets do not exist,
2776   the function continues without errors. Does not return a value.
2777   
2778 **rangeset_add( r, [start, end] )**
2779 **rangeset_add( r, r0 )**
2780   Adds to the rangeset r. The first form adds the range identified by the
2781   current primary selection to the rangeset, unless start and end are defined,
2782   in which case the range they define is added. Returns the index of the 
2783   newly-added range within the rangeset. The second form adds all ranges in 
2784   the rangeset r0 to the rangeset r, and returns 0.
2785   
2786 **rangeset_subtract( r, [start, end] )**
2787 **rangeset_subtract( r, r0 )**
2788   Removes from the rangeset r. The first form removes the range identified by
2789   the current primary selection from the rangeset, unless start and end are
2790   defined, in which case the range they define is removed. The second form
2791   removes all ranges in the rangeset r0 from the rangeset r. Does not return
2792   a value.
2794 **rangeset_invert( r )**
2795   Changes the rangeset r so that it contains all ranges not in r. Does not
2796   return a value.
2798 **rangeset_get_by_name( name )**
2799   Returns an array of active rangeset identifiers, with integer keys starting at 0,
2800   whose name matches name.
2802 **rangeset_info( r )**
2803   Returns an array containing information about the rangeset r. The array
2804   has the following keys: **defined** (whether a rangeset with identifier
2805   r is defined), **count** (the number of ranges in the rangeset), **color**
2806   (the current background color of the rangeset, an empty string if the
2807   rangeset has no color), **name** (the user supplied name of the rangeset,
2808   an empty string if the rangeset has no name), and **mode** (the name of the
2809   modify-response mode of the rangeset).
2811 **rangeset_range( r, [index] )**
2812   Returns details of a specific range in the rangeset r.  The range is 
2813   specified by index, which should be between 1 and n (inclusive), where
2814   n is the number of ranges in the rangeset.  The return value is an array
2815   containing the keys **start** (the start position of the range) and **end**
2816   (the end position of the range).  If index is not supplied, the region
2817   returned is the span of the entire rangeset (the region starting at the 
2818   start of the first range and ending at the end of the last).  If index
2819   is outside the correct range of values, the function returns an empty array.
2821 **rangeset_includes( r, pos )**
2822   Returns the index of the range in rangeset r which includes pos; returns
2823   0 if pos is not contained in any of the ranges of r.  This can also be used
2824   as a simple true/false function which returns true if pos is contained in
2825   the rangeset.
2826   
2827 **rangeset_set_color( r, color )**
2828   Attempts to apply the color as a background color to the ranges of r. If
2829   color is at empty string, removes the coloring of r.  No check is made 
2830   regarding the validity of color: if the color is invalid (a bad name,
2831   or not supported by the hardware) this has unpredictable effects.
2833 **rangeset_set_name( r, name )**
2834   Apply the name to the rangeset r.
2836 **rangeset_set_mode( r, type )**
2837   Changes the behaviour of the rangeset r when modifications to the text
2838   buffer occur.  type can be one of the following: "maintain" (the default),
2839   "break", "include", "exclude", "ins_del" or "del_ins". (The differences are
2840   fairly subtle.)
2843 Highlighting Information
2844 ------------------------
2846   The user can interrogate the current window to determine the color
2847   highlighting used on a particular piece of text. The following functions
2848   provide information on the highlighting pattern against which text at a
2849   particular position has been matched, its style, color and font attributes
2850   (whether the font is supposed to be bold and/or italic).
2852   These macro functions permit macro writers to generate formatted output which
2853   allows NEdit highlighting to be reproduced. This is suitable for the
2854   generation of HTML or Postscript output, for example.
2855   
2856   Note that if any of the functions is used while in Plain mode or while syntax
2857   highlighting is off, the behaviour is undefined.
2859 **get_pattern_by_name( pattern_name )**
2860   Returns an array containing the pattern attributes for pattern 'pattern_name'.
2861   The elements in this array are:
2863 * **style** -- Highlight style name
2865   If 'pattern_name' is invalid, an empty array is returned.
2867 **get_pattern_at_pos( pos )**
2868   Returns an array containing the pattern attributes of the character at
2869   position 'pos'. The elements in this array are:
2871 * **pattern** -- Highlight pattern name
2872 * **style** -- Highlight style name
2873 * **extent** -- The length in the text which uses the same highlighting pattern
2875   The 'extent' value is measured from position 'pos' going right/down (forward
2876   in the file) only.
2878   If 'pos' is invalid, an empty array is returned.
2880 **get_style_by_name( style_name )**
2881   Returns an array containing the style attributes for style 'style_name'.
2882   The elements in this array are:
2884 * **bold** -- '1' if style is bold, '0' otherwise
2885 * **italic** -- '1' if style is italic, '0' otherwise
2886 * **color** -- Name of the style's color
2887 * **background** -- Name of the background color, if any
2889   The colors use the names specified in the color definitions for the style.
2890   These will either be names matching those the X server recognises, or RGB
2891   (red/green/blue) specifications.
2893   If 'style_name' is invalid, an empty array is returned.
2895 **get_style_at_pos( pos )**
2896   Returns an array containing the style attributes of the character at
2897   position 'pos'. The elements in this array are:
2899 * **style** -- Name of the highlight style
2900 * **bold** -- '1' if style is bold, '0' otherwise
2901 * **italic** -- '1' if style is italic, '0' otherwise
2902 * **color** -- Name of the style's color
2903 * **rgb** -- Color's RGB values ('#rrggbb')
2904 * **background** -- Name of the background color, if any
2905 * **back_rgb** -- Background color's RGB values ('#rrggbb')
2906 * **extent** -- The length in the text which uses the same highlight style
2908   The colors use the names specified in the color definitions for the style.
2909   These will either be names matching those the X server recognises, or RGB
2910   specifications. The values for 'rgb' and 'back_rgb' contain the actual color
2911   values allocated by the X server for the window. If the X server cannot
2912   allocate the specified (named) color exactly, the RGB values in these
2913   entries may not match the specified ones.
2915   The 'extent' value is measured from position 'pos' going right/down (forward
2916   in the file) only.
2918   If 'pos' is invalid, an empty array is returned.
2920    ----------------------------------------------------------------------
2922 Action Routines
2923 ---------------
2925   All of the editing capabilities of NEdit are represented as a special type of
2926   subroutine, called an action routine, which can be invoked from both macros
2927   and translation table entries (see "Key_Binding_" in the
2928   Customizing section of the Help menu).
2931 3>Actions Representing Menu Commands
2933     File Menu                 Search Menu
2934     -----------------------   -------------------------
2935     new()                     find()
2936     open()                    find_dialog()
2937     open_dialog()             find_again()
2938     open_selected()           find_selection()
2939     close()                   replace()
2940     save()                    replace_dialog()
2941     save_as()                 replace_all()
2942     save_as_dialog()          replace_in_selection()
2943     revert_to_saved()         replace_again()
2944     include_file()            goto_line_number()
2945     include_file_dialog()     goto_line_number_dialog()
2946     load_macro_file()         goto_selected()
2947     load_macro_file_dialog()  mark()
2948     load_tags_file()          mark_dialog()
2949     load_tags_file_dialog()   goto_mark()
2950     unload_tags_file()        goto_mark_dialog()
2951     load_tips_file()          goto_matching()
2952     load_tips_file_dialog()   select_to_matching()
2953     unload_tips_file()        find_definition()
2954     print()                   show_tip()
2955     print_selection()         
2956     exit()                    Shell Menu
2957                               -------------------------
2958     Edit Menu                 filter_selection_dialog()
2959     -----------------------   filter_selection()
2960     undo()                    execute_command()
2961     redo()                    execute_command_dialog()
2962     delete()                  execute_command_line()
2963     select_all()              shell_menu_command()
2964     shift_left()              
2965     shift_left_by_tab()       Macro Menu
2966     shift_right()             -------------------------
2967     shift_right_by_tab()      macro_menu_command()
2968     uppercase()               repeat_macro()
2969     lowercase()               repeat_dialog()
2970     fill_paragraph()          
2971     control_code_dialog()     Windows Menu
2972                               -------------------------
2973                               split_pane()
2974                               close_pane()
2975                               detach_document()
2976                               move_document_dialog()
2979   An action representing a menu command is usually named the same as its
2980   corresponding menu item except that all punctuation is removed, all letters
2981   are changed to lower case, and spaces are replaced with underscores.  To
2982   present a dialog to ask the user for input, use the actions with the
2983   `_dialog` suffix. Actions without the `_dialog` suffix take the information
2984   from the routine's arguments (see below).  
2986 3>Menu Action Routine Arguments
2988   Arguments are text strings enclosed in quotes. Below are the menu action
2989   routines which take arguments.  Optional arguments are enclosed in [].
2991     **close**( ["prompt" | "save" | "nosave"] )
2992     
2993     **execute_command**( shell-command )
2994     
2995     **filter_selection**( shell-command )
2996     
2997     **find**( search-string [, ~search-direction~] [, ~search-type~] 
2998        [, ~search-wrap~] )
2999     
3000     **find_again**( [~search-direction~] [, ~search-wrap~] )
3001     
3002     **find_definition**( [tag-name] )
3003     
3004     **find_dialog**( [~search-direction~] [, ~search-type~] 
3005        [, ~keep-dialog~] )
3006     
3007     **find_selection**( [~search-direction~] [, ~search-wrap~] 
3008        [, ~non-regex-search-type~] )
3009     
3010     **goto_line_number**( [~line-number~] [, ~column-number~] )
3011     
3012     **goto_mark**( ~mark-letter~ )
3013     
3014     **include_file**( ~filename~ )
3015     
3016     **load_tags_file**( ~filename~ )
3017     
3018     **macro_menu_command**( ~macro-menu-item-name~ )
3019     
3020     **mark**( ~mark-letter~ )
3021     
3022     **open**( ~filename~ )
3023     
3024     **replace**( search-string, replace-string, 
3025        [, ~search-direction~] [, ~search-type~] [, ~search-wrap~] )
3026        
3027     **replace_again**( [~search-direction~] [, ~search-wrap~] )
3028     
3029     **replace_all**( search-string, replace-string [, ~search-type~] )
3031     **replace_dialog**( [~search-direction~] [, ~search-type~]
3032        [, ~keep-dialog~] )
3033     
3034     **replace_in_selection**( search-string, 
3035        replace-string [, ~search-type~] )
3036        
3037     **save_as**( ~filename~ )
3038     
3039     **shell_menu_command**( ~shell-menu-item-name~ )
3040     
3041     **unload_tags_file**( ~filename~ )
3043     **----------- Some notes on argument types above -----------**
3045     ~filename~       Path names are relative to the directory from
3046                    which NEdit was started. Shell interpreted 
3047                    wildcards and `~' are not expanded.
3049     ~keep-dialog~    Either "keep" or "nokeep".
3051     ~mark-letter~    The mark command limits users to single 
3052                    letters. Inside of macros, numeric marks are
3053                    allowed, which won't interfere with marks set
3054                    by the user.
3056     ~macro-menu-item-name~
3057                    Name of the command exactly as specified in 
3058                    the Macro Menu dialogs.
3059                     
3060     ~non-regex-search-type~ 
3061                    Either "literal", "case", "word", or 
3062                    "caseWord".
3064     ~search-direction~
3065                    Either "forward" or "backward".
3067     ~search-type~    Either "literal", "case", "word", 
3068                    "caseWord", "regex", or "regexNoCase".
3070     ~search-wrap~    Either "wrap" or "nowrap".
3072     ~shell-menu-item-name~
3073                    Name of the command exactly as specified in 
3074                    the Shell Menu dialogs.
3076 3>Window Preferences Actions
3078 **set_auto_indent( "off" | "on" | "smart" )**
3079   Set auto indent mode for the current window.
3081 **set_em_tab_dist( em-tab-distance )**
3082   Set the emulated tab size. An em-tab-distance value of 
3083   0 or -1 translates to no emulated tabs. Em-tab-distance must 
3084   be smaller than 1000.
3086 **set_fonts( font-name, italic-font-name, bold-font-name, bold-italic-font-name )**
3087   Set all the fonts used for the current window.
3089 **set_highlight_syntax( [0 | 1] )**
3090   Set syntax highlighting mode for the current window. 
3091   A value of 0 turns it off and a value of 1 turns it on. 
3092   If no parameters are supplied the option is toggled.
3094 **set_incremental_backup( [0 | 1] )**
3095   Set incremental backup mode for the current window. 
3096   A value of 0 turns it off and a value of 1 turns it on. 
3097   If no parameters are supplied the option is toggled.
3099 **set_incremental_search_line( [0 | 1] )**
3100   Show or hide the incremental search line for the current window. 
3101   A value of 0 turns it off and a value of 1 turns it on. 
3102   If no parameters are supplied the option is toggled.
3104 **set_language_mode( language-mode )**
3105   Set the language mode for the current window. If the language mode is 
3106   "" or unrecognized, it will be set to Plain.
3108 **set_locked( [0 | 1] )**
3109   This only affects the locked status of a file, not it's read-only 
3110   status. Permissions are NOT changed. 
3111   A value of 0 turns it off and a value of 1 turns it on. 
3112   If no parameters are supplied the option is toggled.
3114 **set_make_backup_copy( [0 | 1] )**
3115   Set whether backup copies are made during saves for the current window. 
3116   A value of 0 turns it off and a value of 1 turns it on. 
3117   If no parameters are supplied the option is toggled.
3119 **set_overtype_mode( [0 | 1] )**
3120   Set overtype mode for the current window. 
3121   A value of 0 turns it off and a value of 1 turns it on. 
3122   If no parameters are supplied the option is toggled.
3124 **set_show_line_numbers( [0 | 1] )**
3125   Show or hide line numbers for the current window. 
3126   A value of 0 turns it off and a value of 1 turns it on. 
3127   If no parameters are supplied the option is toggled.
3129 **set_show_matching( "off" | "delimiter" | "range" )**
3130   Set show matching (...) mode for the current window.
3132 **set_match_syntax_based( [0 | 1] )**
3133   Set whether matching should be syntax based for the current window.
3135 **set_statistics_line( [0 | 1] )**
3136   Show or hide the statistics line for the current window. 
3137   A value of 0 turns it off and a value of 1 turns it on. 
3138   If no parameters are supplied the option is toggled.
3140 **set_tab_dist( tab-distance )**
3141   Set the size of hardware tab spacing. Tab-distance must 
3142   must be a value greater than 0 and no greater than 20.
3144 **set_use_tabs( [0 | 1] )**
3145   Set whether tabs are used for the current window. 
3146   A value of 0 turns it off and a value of 1 turns it on. 
3147   If no parameters are supplied the option is toggled.
3149 **set_wrap_margin( wrap-width )**
3150   Set the wrap width for text wrapping of the current window. A value
3151   of 0 means to wrap at window width.
3153 **set_wrap_text( "none" | "auto" | "continuous" )**
3154   Set wrap text mode for the current window.
3156 3>Keyboard-Only Actions
3158   In addition to the arguments listed in the call descriptions below, any
3159   routine involving cursor movement can take the argument "extend", meaning,
3160   adjust the primary selection to the new cursor position. Routines which take
3161   the "extend" argument as well as mouse dragging operations for both primary
3162   and secondary selections can take the optional keyword "rect", meaning, make
3163   the selection rectangular. Any routine that accepts the "scrollbar" argument
3164   will move the display but not the cursor or selection. Routines that accept
3165   the "nobell" argument will fail silently without beeping, when that argument
3166   is supplied.
3168 **backward_character( ["nobell"] )**
3169   Moves the cursor one character to the left.
3171 **backward_paragraph(["nobell"] )**
3172   Moves the cursor to the beginning of the paragraph, or
3173   if the cursor is already at the beginning of a paragraph, moves the cursor to
3174   the beginning of the previous paragraph.  Paragraphs are defined as regions
3175   of text delimited by one or more blank lines.
3177 **backward_word( ["nobell"] )**
3178   Moves the cursor to the beginning of a word, or, if the
3179   cursor is already at the beginning of a word, moves the cursor to the
3180   beginning of the previous word.  Word delimiters are user-settable, and
3181   defined by the X resource wordDelimiters.
3183 **beginning_of_file( ["scrollbar"] )**
3184   Moves the cursor to the beginning of the file.
3186 **beginning_of_line( ["absolute"] )** 
3187   Moves the cursor to the beginning of the line. If
3188   "absolute" is given, always moves to the absolute beginning of line,
3189   regardless of the text wrapping mode.
3191 **beginning_of_selection()**
3192   Moves the cursor to the beginning of the selection
3193   without disturbing the selection.
3195 **copy_clipboard()**
3196   Copies the current selection to the clipboard.
3198 **copy_primary()**
3199   Copies the primary selection to the cursor.
3201 **copy_to()**
3202   If a secondary selection exists, copies the secondary selection to
3203   the cursor.  If no secondary selection exists, copies the primary selection
3204   to the pointer location.
3206 **copy_to_or_end_drag()**
3207   Completes either a secondary selection operation, or a
3208   primary drag.  If the user is dragging the mouse to adjust a secondary
3209   selection, the selection is copied and either inserted at the cursor
3210   location, or, if pending-delete is on and a primary selection exists in the
3211   window, replaces the primary selection.  If the user is dragging a block of
3212   text (primary selection), completes the drag operation and leaves the text at
3213   it's current location.
3215 **cut_clipboard()**
3216   Deletes the text in the primary selection and places it in
3217   the clipboard.
3219 **cut_primary()**
3220   Copies the primary selection to the cursor and deletes it at
3221   its original location.
3223 **delete_selection()**
3224   Deletes the contents of the primary selection.
3226 **delete_next_character( ["nobell"] )**
3227   If a primary selection exists, deletes its contents. 
3228   Otherwise, deletes the character following the cursor.
3230 **delete_previous_character( ["nobell"] )**
3231   If a primary selection exists, deletes its
3232   contents.  Otherwise, deletes the character before the cursor.
3234 **delete_next_word( ["nobell"] )**
3235   If a primary selection exists, deletes its contents. 
3236   Otherwise, deletes the word following the cursor.
3238 **delete_previous_word( ["nobell"] )**
3239   If a primary selection exists, deletes its contents. 
3240   Otherwise, deletes the word before the cursor.
3242 **delete_to_start_of_line( ["nobell", "wrap"] )**
3243   If a primary selection exists, deletes its contents.  Otherwise, deletes the
3244   characters between the cursor and the start of the line. If "wrap" is
3245   given, deletes to the previous wrap point or beginning of line, whichever 
3246   is closest.
3248 **delete_to_end_of_line( ["nobell", "absolute"] )**
3249   If a primary selection exists, deletes its contents. 
3250   Otherwise, deletes the characters between the cursor and the end of the line.
3251   If "absolute" is given, always deletes to the absolute end of line, regardless
3252   of the text wrapping mode.
3254 **deselect_all()**
3255   De-selects the primary selection.
3257 **end_of_file( ["scrollbar"] )**
3258   Moves the cursor to the end of the file.
3260 **end_of_line( ["absolute"] )** 
3261   Moves the cursor to the end of the line.  If
3262   "absolute" is given, always moves to the absolute end of line, regardless
3263   of the text wrapping mode.
3265 **end_of_selection()**
3266   Moves the cursor to the end of the selection without
3267   disturbing the selection.
3269 **exchange( ["nobell"] )**
3270   Exchange the primary and secondary selections.
3272 **extend_adjust()**
3273   Attached mouse-movement events to begin a selection between
3274   the cursor and the mouse, or extend the primary selection to the mouse
3275   position.
3277 **extend_end()**
3278   Completes a primary drag-selection operation.
3280 **extend_start()**
3281   Begins a selection between the cursor and the mouse.  A
3282   drag-selection operation can be started with either extend_start or
3283   grab_focus.
3285 **focus_pane( [relative-pane] | [positive-index] | [negative-index] )**
3286   Move the focus to the requested pane.
3287   Arguments can be specified in the form of a relative-pane 
3288   ("first", "last", "next", "previous"), a positive-index 
3289   (numbers greater than 0, 1 is the same as "first") or a
3290   negative-index (numbers less than 0, -1 is the same as "last").
3291   
3292 **forward_character()**
3293   Moves the cursor one character to the right.
3295 **forward_paragraph( ["nobell"] )**
3296   Moves the cursor to the beginning of the next paragraph. 
3297   Paragraphs are defined as regions of text delimited by one or more blank
3298   lines.
3300 **forward_word( ["tail"] ["nobell"] )**
3301   Moves the cursor to the beginning of the next word.  Word
3302   delimiters are user-settable, and defined by the X resource wordDelimiters.
3303   If the "tail" argument is supplied the cursor will be moved to 
3304   the end of the current word or the end of the next word, if the 
3305   cursor is between words.
3307 **grab_focus()**
3308   Moves the cursor to the mouse pointer location, and prepares for
3309   a possible drag-selection operation (bound to extend_adjust), or multi-click
3310   operation (a further grab_focus action).  If a second invocation of grab
3311   focus follows immediately, it selects a whole word, or a third, a whole line.
3313 **insert_string( "string" )**
3314   If pending delete is on and the cursor is inside the
3315   selection, replaces the selection with "string".  Otherwise, inserts "string"
3316   at the cursor location.
3318 **key_select( "direction" [,"nobell"] )**
3319   Moves the cursor one character in "direction"
3320   ("left", "right", "up", or "down") and extends the selection.  Same as
3321   forward/backward-character("extend"), or process-up/down("extend"), for
3322   compatibility with previous versions.
3324 **move-destination()**
3325   Moves the cursor to the pointer location without
3326   disturbing the selection.  (This is an unusual way of working.  We left it in
3327   for compatibility with previous versions, but if you actually use this
3328   capability, please send us some mail, otherwise it is likely to disappear in
3329   the future.
3331 **move_to()**
3332   If a secondary selection exists, deletes the contents of the
3333   secondary selection and inserts it at the cursor, or if pending-delete is on
3334   and there is a primary selection, replaces the primary selection.  If no
3335   secondary selection exists, moves the primary selection to the pointer
3336   location, deleting it from its original position.
3338 **move_to_or_end_drag()**
3339   Completes either a secondary selection operation, or a
3340   primary drag.  If the user is dragging the mouse to adjust a secondary
3341   selection, the selection is deleted and either inserted at the cursor
3342   location, or, if pending-delete is on and a primary selection exists in the
3343   window, replaces the primary selection.  If the user is dragging a block of
3344   text (primary selection), completes the drag operation and deletes the text
3345   from it's current location.
3347 **newline()**
3348   Inserts a newline character.  If Auto Indent is on, lines up the
3349   indentation of the cursor with the current line.
3351 **newline_and_indent()**
3352   Inserts a newline character and lines up the indentation
3353   of the cursor with the current line, regardless of the setting of Auto
3354   Indent.
3356 **newline_no_indent()**
3357   Inserts a newline character, without automatic
3358   indentation, regardless of the setting of Auto Indent.
3360 **next_page( ["stutter"] ["column"] ["scrollbar"] ["nobell"] )**
3361   Moves the cursor and scroll forward one page.
3362   The parameter "stutter" moves the cursor to the bottom of the display,
3363   unless it is already there, otherwise it will page down.
3364   The parameter "column" will maintain the preferred column while
3365   moving the cursor.
3367 **page_left( ["scrollbar"] ["nobell"] )**
3368   Move the cursor and scroll left one page.
3370 **page_right( ["scrollbar"] ["nobell"] )**
3371   Move the cursor and scroll right one page.
3373 **paste_clipboard()**
3374   Insert the contents of the clipboard at the cursor, or if
3375   pending delete is on, replace the primary selection with the contents of the
3376   clipboard.
3378 **previous_page( ["stutter"] ["column"] ["scrollbar"] ["nobell"] )**
3379   Moves the cursor and scroll backward one page.
3380   The parameter "stutter" moves the cursor to the top of the display,
3381   unless it is already there, otherwise it will page up.
3382   The parameter "column" will maintain the preferred column while
3383   moving the cursor.
3385 **process_bdrag()**
3386   Same as secondary_or_drag_start for compatibility with previous versions.
3388 **process_cancel()**
3389   Cancels the current extend_adjust, secondary_adjust, or
3390   secondary_or_drag_adjust in progress.
3392 **process_down( ["nobell", "absolute"] )**
3393   Moves the cursor down one line.  If "absolute" is given, always moves to the 
3394   next line in the text buffer, regardless of wrapping.
3396 **process_return()**
3397   Same as newline for compatibility with previous versions.
3399 **process_shift_down( ["nobell", "absolute"] )**
3400   Same as process_down("extend") for compatibility with previous versions.
3402 **process_shift_up( ["nobell", "absolute"] )**
3403   Same as process_up("extend") for compatibility with previous versions.
3405 **process_tab()**
3406   If tab emulation is turned on, inserts an emulated tab,
3407   otherwise inserts a tab character.
3409 **process_up( ["nobell", "absolute"] )**
3410   Moves the cursor up one line.  If "absolute" is given, always moves to the 
3411   previous line in the text buffer, regardless of wrapping.
3413 **raise_window([relative-window] | [positive-index] | [negative-index])**
3414   Raise the current focused window to the front if no argument is supplied.
3415   Arguments can be specified in the form of a relative-window 
3416   ("first", "last", "next", "previous"), a positive-index 
3417   (numbers greater than 0, 1 is the same as "last") or a
3418   negative-index (numbers less than 0, -1 is the same as "first").
3419   
3420 **scroll_down( nUnits, ["lines" | "pages"] )**
3421   Scroll the display down (towards the end of the file) by a given
3422   number of units, units being lines or pages. Default units are lines.
3424 **scroll_left( nPixels )**
3425   Scroll the display left by nPixels.
3427 **scroll_right( nPixels )**
3428   Scroll the display right by nPixels.
3430 **scroll_up( nUnits, ["lines" | "pages"] )**
3431   Scroll the display up (towards the beginning of the file) by a given
3432   number of units, units being lines or pages. Default units are lines.
3434 **scroll_to_line( lineNum )**
3435   Scroll to position line number lineNum at the top of
3436   the pane.  The first line of a file is line 1.
3438 **secondary_adjust()**
3439   Attached mouse-movement events to extend the secondary
3440   selection to the mouse position.
3442 **secondary_or_drag_adjust()**
3443   Attached mouse-movement events to extend the
3444   secondary selection, or reposition the primary text being dragged.  Takes two
3445   optional arguments, "copy", and "overlay".  "copy" leaves a copy of the
3446   dragged text at the site at which the drag began.  "overlay" does the drag in
3447   overlay mode, meaning the dragged text is laid on top of the existing text,
3448   obscuring and ultimately deleting it when the drag is complete.
3450 **secondary_or_drag_start()**
3451   To be attached to a mouse down event.  Begins drag
3452   selecting a secondary selection, or dragging the contents of the primary
3453   selection, depending on whether the mouse is pressed inside of an existing
3454   primary selection.
3456 **secondary_start()**
3457   To be attached to a mouse down event.  Begin drag selecting
3458   a secondary selection.
3460 **select_all()**
3461   Select the entire file.
3463 **self_insert()**
3464   To be attached to a key-press event, inserts the character
3465   equivalent of the key pressed.
3467    ----------------------------------------------------------------------
3469 Customizing
3470 ===========
3472 Customizing NEdit
3473 -----------------
3475   NEdit can be customized many different ways.  The most important
3476   user-settable options are presented in the Preferences menu, including all
3477   options that users might need to change during an editing session.  Options
3478   set in the Default Settings sub-menu of the Preferences menu can be preserved
3479   between sessions by selecting Save Defaults, which writes the changes to the
3480   preferences file.  See the section titled "Preferences_" for more details.
3482   User defined commands can be added to NEdit's Shell, Macro, and window
3483   background menus.  Dialogs for creating items in these menus can be found
3484   under Customize Menus in the Default Settings sub menu of the Preferences
3485   menu.
3487   For users who depend on NEdit every day and want to tune every excruciating
3488   detail, there are also X resources for tuning a vast number of such details,
3489   down to the color of each individual button.  See the section "X_Resources_"
3490   for more information, as well as a list of selected resources.
3492   The most common reason customizing your X resources for NEdit, however, is
3493   key binding.  While limited key binding can be done through Preferences
3494   settings (Preferences -> Default Settings -> Customize Menus), you can really
3495   only add keys this way, and each key must have a corresponding menu item. 
3496   Any significant changes to key binding should be made via the Translations
3497   resource and menu accelerator resources.  The sections titled "Key_Binding_"
3498   and "X_Resources_" have more information.
3499    ----------------------------------------------------------------------
3501 Preferences
3502 -----------
3504   The Preferences menu allows you to set options for both the current editing
3505   window, and default values for newly created windows and future NEdit
3506   sessions.  Options in the Preferences menu itself (not in the Default
3507   Settings sub-menu) take effect immediately and refer to the current window
3508   only.  Options in the Default Settings sub-menu provide initial settings for
3509   future windows created using the New or Open commands; options affecting all
3510   windows are also set here.
3511   Preferences set in the Default Settings sub-menu can be saved in a file that
3512   is automatically read by NEdit at startup time, by selecting Save Defaults.
3514 3>Preferences Menu
3516 **Default Settings**
3517   Menu of initial settings for future windows.  Generally the same as the
3518   options in the main part of the menu, but apply as defaults for future
3519   windows created during this NEdit session.  These settings can be saved using
3520   the Save Defaults command below, to be loaded automatically each time NEdit
3521   is started.
3523 **Save Defaults**
3524   Save the default options as set under Default Settings for future NEdit 
3525   sessions.
3527 **Statistics Line**
3528   Show the full file name, line number, and length of the file being edited.
3530 **Incremental Search Line**
3531   Keep the incremental search bar (Search -> Find Incremental) permanently
3532   displayed at the top of the window.
3534 **Show Line Numbers**
3535   Display line numbers to the right of the text.
3537 **Language Mode**
3538   Tells NEdit what language (if any) to assume, for selecting language-specific
3539   features such as highlight patterns and smart indent macros, and setting
3540   language specific preferences like word delimiters, tab emulation, and
3541   auto-indent.  See Features for Programming -> Programming_with_NEdit_ for
3542   more information.
3544 **Auto Indent**
3545   Setting Auto Indent "on" maintains a running indent (pressing the Return key
3546   will line up the cursor with the indent level of the previous line).  If
3547   smart indent macros are available for the current language mode, smart indent
3548   can be selected and NEdit will attempt to guess proper language indentation
3549   for each new line.  See Help -> Features for Programming -> Automatic Indent
3550   for more information.
3552 **Wrap**
3553   Choose between two styles of automatic wrapping or none.  Auto Newline wrap,
3554   wraps text at word boundaries when the cursor reaches the right margin, by
3555   replacing the space or tab at the last word boundary with a newline
3556   character.  Continuous Wrap wraps long lines which extend past the right
3557   margin. Continuous Wrap mode is typically used to produce files where
3558   newlines are omitted within paragraphs, to make text filling automatic (a
3559   kind of poor-man's word processor).  Text of this style is common on Macs and
3560   PCs but is not necessarily supported very well under Unix (except in programs
3561   which deal with e-mail, for which it is often the format of choice).
3563 **Wrap Margin**
3564   Set margin for Auto Newline Wrap, Continuous Wrap, and Fill Paragraph.  Lines
3565   may, be wrapped at the right margin of the window, or the margin can be set
3566   at a specific column.
3568 **Tab Stops**
3569   Set the tab distance (number of characters between tab stops) for tab
3570   characters, and control tab emulation and use of tab characters in padding
3571   and emulated tabs.
3573 **Text Font...**
3574   Change the font(s) used to display text (fonts for menus and dialogs must be
3575   set using X resources for the text area of the window). See below for more
3576   information.
3578 **Highlight Syntax**
3579   If NEdit recognizes the language being edited, and highlighting patterns are
3580   available for that language, use fonts and colors to enhance viewing of the
3581   file.  (See Help -> Features for Programming -> Syntax Highlighting for more
3582   information.
3584 **Make Backup Copy**
3585   On Save, write a backup copy of the file as it existed before the Save
3586   command with the extension .bck (Unix only).
3588 **Incremental Backup**
3589   Periodically make a backup copy of the file being edited under the name
3590   `~filename` on Unix or `_filename` on VMS (see Crash_Recovery_).
3592 **Show Matching (..)**
3593   Momentarily highlight matching parenthesis, brackets, and braces, or the
3594   range between them, when one of these characters is typed, or when the
3595   insertion cursor is positioned after it. Delimiter only highlights the
3596   matching delimiter, while Range highlights the whole range of text between
3597   the matching delimiters.
3598   
3599   Optionally, the matching can make use of syntax information if syntax
3600   highlighting is enabled. Alternatively, the matching is purely character
3601   based. In general, syntax based matching results in fewer false matches.
3603 **Overtype**
3604   In overtype mode, new characters entered replace the characters in front of
3605   the insertion cursor, rather than being inserted before them.
3607 **Read Only**
3608   Lock the file against accidental modification.  This temporarily prevents the
3609   file from being modified in this NEdit session. Note that this is different
3610   from setting the file protection.
3612 3>Preferences -> Default Settings Menu
3614   Options in the Preferences -> Default Settings menu have the same meaning as
3615   those in the top-level Preferences menu, except that they apply to future
3616   NEdit windows and future NEdit sessions if saved with the Save Defaults
3617   command.  Additional options which appear in this menu are:
3619 **Language Modes**
3620   Define language recognition information (for determining language mode from
3621   file name or content) and set language specific preferences.
3623 **Tag Collisions**
3624   How to react to multiple tags for the same name.  Tags are described in the
3625   section: Features for Programmers -> Finding Declarations (ctags).  In Show
3626   All mode, all matching tags are displayed in a dialog.  In Smart mode, if one
3627   of the matching tags is in the current window, that tag is chosen, without
3628   displaying the dialog.
3630 **Colors...**
3631   Change the colors used to display text.  The "Matching (..)" fields change the
3632   colors that matching parens, brackets and braces are flashed when the "Show
3633   Matching (..)" option is enabled.  Note that the foreground colors for plain
3634   text, selected text, and matching paren flashing only apply when syntax
3635   highlighting is disabled.  When syntax highlighting is enabled, text (even
3636   text that appears plain) will always be colored according to its highlighting
3637   style. (For information on changing syntax highlighting styles and matching
3638   patterns use see  Help -> Features for Programming -> Syntax_Highlighting_.)
3640 **Customize Menus**
3641   Add/remove items from the Shell, Macro, and window background menus (see
3642   below).
3644 **Customize Window Title**
3645   Opens a dialog where the information to be displayed in the window's title
3646   field can be defined and tested. The dialog contains a Help button, providing
3647   further information about the options available.
3649 **Searching**
3650   Options for controlling the behavior of Find and Replace commands:
3652   ~Verbose~ - 
3653   Presents search results in dialog form, asks before wrapping a
3654   search back around the beginning (or end) of the file 
3655   (unless Beep On Search Wrap is turned on).
3657   ~Wrap Around~ - 
3658   Search and Replace operations wrap around the beginning (or end) of the file.
3660   ~Beep On Search Wrap~ - 
3661   Beep when Search and Replace operations wrap around the beginning (or end) of
3662   the file (only if Wrap Around is turned on).
3664   ~Keep Dialogs Up~ - 
3665   Don't pop down Replace and Find boxes after searching.
3667   ~Default Search Style~ - 
3668   Initial setting for search type in Find and Replace dialogs.
3670   ~Default Replace Scope~ - 
3671   [THIS OPTION IS ONLY PRESENT WHEN NEDIT WAS COMPILED WITH THE 
3672    -DREPLACE_SCOPE FLAG TO SELECT AN ALTERNATIVE REPLACE DIALOG LAYOUT.]
3674   Initial setting for the scope in the Replace/Find dialog, when a selection
3675   exists. It can be either "In Window", "In Selection", or "Smart". "Smart"
3676   results in "In Window" if the size of the selection is smaller than 1 line,
3677   and to "In Selection" otherwise.
3679 **Syntax Highlighting**
3680   Program and configure enhanced text display for new or supported languages
3681   (See Features for Programming -> Syntax_Highlighting_).
3683 **Tabbed Editing**
3684   Options for controlling the tabbed interface:
3685   
3686   ~Open File in New Tab~ - 
3687   Open files in new tabs, else open files in new windows.
3688   
3689   ~Show Tab Bar~ - 
3690   Show/Hide the tab bar.
3691   
3692   ~Hide Tab Bar when only one Document is open~
3693   
3694   ~Next/Prev Tabs Across Windows~ - 
3695   Suppose there are two windows with three tabs in the first window and two tabs in
3696   the second window.  Enabling this option, if you are on the third tab in the
3697   first window, hitting Ctrl+PageDown would switch to the first tab in the second
3698   window (instead of switching to the first tab in the first window).
3699   
3700   ~Sort Tabs Alphabetically~
3702 **Show Tooltips**
3703   Show file name and path in a tooltip when moving the mouse pointer over a tab
3704   (See Basic Operations -> Tabbed_Editing_).
3706 **Terminate with Line Break on Save**
3707   Some UNIX tools expect that files end with a line feed. If this option is
3708   activated, NEdit will append one if required.
3710 **Sort Open Prev. Menu**
3711   Option to order the File -> Open Previous menu alphabetically, versus in
3712   order of last access.
3714 **Popups Under Pointer**
3715   Display pop-up dialogs centered on the current mouse position, as opposed to
3716   centered on the parent window.  This generally speeds interaction, and is
3717   essential for users who set their window managers so keyboard focus
3718   follows the mouse.
3720 **Auto-Scroll Near Window Top/Bottom**
3721   When this option is enabled the window will automatically scroll when the
3722   cursor comes 4 lines from the top or bottom of the window (except at the
3723   beginning of the file).  The number of lines can be customized with the
3724   nedit.autoScrollVPadding resource.
3726 **Warnings**
3727   Options for controlling the popping up of warning dialogs:
3728   
3729   ~File Modified Externally~ -
3730   Pop up a warning dialog when files get changed external to NEdit.
3731   
3732   ~Check Modified File Contents~ -
3733   If external file modification warnings are requested, also check the file
3734   contents iso. only the modification date.
3736   ~Exit Warnings~ -
3737   Ask before exiting when two or more files are open in an NEdit session.
3739 **Initial Window Size**
3740   Default size for new windows.
3742 3>Changing Font(s)
3744   The font used to display text in NEdit is set under Preferences -> Text Font
3745   (for the current window), or Preferences -> Default Settings Text Font (for
3746   future windows).  These dialogs also allow you to set fonts for syntax
3747   highlighting.  If you don't intend to use syntax highlighting, you can ignore
3748   most of the dialog, and just set the field labeled Primary Font.
3750   Unless you are absolutely certain about the types of files that you will be
3751   editing with NEdit, you should choose a fixed-spacing font.  Many, if not
3752   most, plain-text files are written expecting to be viewed with fixed
3753   character spacing, and will look wrong with proportional spacing.  NEdit's
3754   filling, wrapping, and rectangular operations will also work strangely if you
3755   choose a proportional font.
3757   Note that in the font browser (the dialog brought up by the Browse...
3758   button), the subset of fonts which are shown is narrowed depending on the
3759   characteristics already selected.  It is therefore important to know that you
3760   can unselect characteristics from the lists by clicking on the selected items
3761   a second time.
3763   Fonts for syntax highlighting should ideally match the primary font in both
3764   height and spacing.  A mismatch in spacing will result in similar distortions
3765   as choosing a proportional font: column alignment will sometimes look wrong,
3766   and rectangular operations, wrapping, and filling will behave strangely.  A
3767   mismatch in height will cause windows to re-size themselves slightly when
3768   syntax highlighting is turned on or off, and increase the inter- line spacing
3769   of the text.  Unfortunately, on some systems it is hard to find sets of fonts
3770   which match exactly in height.
3772 3>Customizing Menus
3774   You can add or change items in the Shell, Macro, and window background menus
3775   under Preferences -> Default Settings -> Customize Menus.  When you choose
3776   one of these, you will see a dialog with a list of the current
3777   user-configurable items from the menu on the left.  To change an existing
3778   item, select it from the list, and its properties will appear in the
3779   remaining fields of the dialog, where you may change them.  Selecting the
3780   item "New" from the list allows you to enter new items in the menu.
3782   Hopefully most of the characteristics are self explanatory, but here are a
3783   few things to note:
3785   Accelerator keys are keyboard shortcuts which appear on the right hand side
3786   of the menus, and allow you avoid pulling down the menu and activate the
3787   command with a single keystroke.  Enter accelerators by typing the keys
3788   exactly as you would to activate the command.
3790   Mnemonics are a single letter which should be part of the menu item name,
3791   which allow users to traverse and activate menu items by typing keys when the
3792   menu is pulled down.
3794   In the Shell Command field of the Shell Commands dialog, the % character
3795   expands to the name (including directory path) of the file in the window.  To
3796   include a % character in the command, use %%.
3798   The Menu Entry field can contain special characters for constructing
3799   hierarchical sub-menus, and for making items which appear only in certain
3800   language modes.  The right angle bracket character ">" creates a sub-menu. 
3801   The name of the item itself should be the last element of the path formed
3802   from successive sub-menu names joined with ">".  Menu panes are called in to
3803   existence simply by naming them as part of a Menu Entry name.  To put several
3804   items in the same sub-menu, repeat the same hierarchical sequence for each. 
3805   For example, in the Macro Commands dialog, two items with menu entries: a>b>c
3806   and a>b>d would create a single sub menu under the macro menu called "a",
3807   which would contain a single sub-menu, b, holding the actual items, c and d:
3809       +---++---++---+
3810       |a >||b >||c  |
3811       +---++---+|d  |
3812                 +---+
3814   To qualify a menu entry with a language mode, simply add an at-sign "@@" at
3815   the end of the menu command, followed (no space) by a language mode name.  To
3816   make a menu item which appears in several language modes, append additional
3817   @@s and language mode names.  For example, an item with the menu entry:
3819     Make C Prototypes@@C@@C++
3821   would appear only in C and C++ language modes, and:
3823     Make Class Template@@C++
3825   would appear only in C++ mode.
3827   Menu items with no qualification appear in all language modes.
3829   If a menu item is followed by the single language qualification "@@*", that
3830   item will appear only if there are no applicable language-specific items of
3831   the same name in the same submenu.  For example, if you have the following
3832   three entries in the same menu:
3834     Make Prototypes@@C@@C++
3835     Make Prototypes@@Java
3836     Make Prototypes@@*
3838   The first will be available when the language mode is C or C++, the second
3839   when the language mode is Java, and for all other language modes (including
3840   the "Plain" non-language mode).  If the entry:
3842     Make Prototypes
3844   also exists, this will always appear, meaning that the menu will always have
3845   two "Make Prototypes" entries, whatever the language mode.
3847 3>The NEdit Preferences File
3849   The NEdit saved preferences file is an X resource file, and its contents can
3850   be moved into another X resource file (see X_Resources_).  One reason for
3851   doing so would be to attach server specific preferences, such as a default
3852   font to a particular X server.  Another reason for moving preferences into the
3853   X resource file would be to keep preferences menu options and resource
3854   settable options together in one place.
3855   Though the files are the same format, additional resources should not be added
3856   to the preference file since NEdit modifies this file by overwriting it
3857   completely.  Note also that the contents of the preference file take
3858   precedence over the values of X resources.
3859   Using Save Defaults after moving the contents of your preference file to your
3860   .Xdefaults file will re-create the preference file, interfering with the
3861   options that you have moved.
3862   The location of NEdit's preferences file depends on your environment:
3863   
3864 * The default place for the file is '$HOME/.nedit/nedit.rc',
3865 * if the variable $NEDIT_HOME is set in your environment it is located at '$NEDIT_HOME/nedit.rc',
3866 * you may also use old-style run control files; in this case, the preferences are stored in $HOME/.nedit.
3868   (For VMS, the file is in '$NEDIT_HOME/nedit.rc' if $NEDIT_HOME is set, in
3869   'SYS$LOGIN:.nedit' otherwise.)
3871 3>Sharing Customizations with Other NEdit Users
3873   If you have written macro or shell menu commands, highlight patterns, or
3874   smart-indent macros that you want to share with other NEdit users, you can
3875   make a file which they can load into their NEdit environment.
3877   To load such a file, start NEdit with the command:
3879      nedit -import <file>
3881   In the new NEdit session, verify that the imported patterns or macros do what
3882   you want, then select Preferences -> Save Defaults.  Saving incorporates the
3883   changes into the nedit preferences file, so the next time you run NEdit, you
3884   will not have to import the distribution file.
3886   Loading a customization file is automated, but creating one is not.  To
3887   produce a file to be imported by other users, you must make a copy of your own
3888   NEdit configuration file, and edit it, by hand, to remove everything but the
3889   few items of interest to the recipient.  Leave only the individual
3890   resource(s), and within those resources, only the particular macro, pattern,
3891   style, etc, that you wish to exchange.
3893   For example, to share a highlighting pattern set, you would include the
3894   patterns, any new styles you added, and language mode information only if the
3895   patterns are intended to support a new language rather than updating an
3896   existing one. For example:
3898      nedit.highlightPatterns:\
3899           My Language:1:0{\n\
3900                   Comment:"#":"$"::Comment::\n\
3901                   Loop Header:"^[ \\t]*loop:":::Loop::\n\
3902           }
3903      nedit.languageModes: My Language:.my::::::
3904      nedit.styles: Loop:blue:Bold
3906   Resources are in the format of X resource files, but the format of text
3907   within multiple-item resources like highlight patterns, language modes,
3908   macros, styles, etc., are private to NEdit.  Each resource is a string which
3909   ends at the first newline character not escaped with \, so you must be
3910   careful about how you treat ends of lines.  While you can generally just cut
3911   and paste indented sections, if something which was originally in the middle
3912   of a resource string is now at the end, you must remove the \ line
3913   continuation character(s) so it will not join the next line into the
3914   resource.  Conversely, if something which was originally at the end of a
3915   resource is now in the middle, you'll have to add continuation character(s)
3916   to make sure that the resource string is properly continued from beginning to
3917   end, and possibly newline character(s) (\n) to make sure that it is properly
3918   separated from the next item.
3919    ----------------------------------------------------------------------
3921 X Resources
3922 -----------
3924   NEdit has additional options to those provided in the Preferences menu which
3925   are set using X resources.  Like most other X programs, NEdit can be
3926   customized to vastly unnecessary proportions, from initial window positions
3927   down to the font and shadow colors of each individual button (A complete
3928   discussion of how to do this is left to books on the X Window System).  Key
3929   binding (see "Key_Binding_" is one of the most useful of these resource
3930   settable options.
3932   X resources are usually specified in a file called .Xdefaults or .Xresources
3933   in your home directory (on VMS this is sys$login:decw$xdefaults.dat).  On
3934   some systems, this file is read and its information attached to the X server
3935   (your screen) when you start X.  On other systems, the .Xdefaults file is
3936   read each time you run an X program.  When X resource values are attached to
3937   the X server, changes to the resource file are not available to application
3938   programs until you either run the xrdb program with the appropriate file as
3939   input, or re-start the X server.
3941 3>Selected X Resource Names
3943   The following are selected NEdit resource names and default values for NEdit
3944   options not settable via the Preferences menu (for preference resource names,
3945   see your NEdit preference file):
3947 **nedit.tagFile**: (not defined) 
3949   This can be the name of a file, or multiple files separated by a colon (:)
3950   character, of the type produced by Exuberant Ctags or the Unix ctags
3951   command, which NEdit will load at startup time (see ctag_support_ ). The tag
3952   file provides a database from which NEdit can automatically open files
3953   containing the definition of a particular subroutine or data type.
3955 **nedit.alwaysCheckRelativeTagsSpecs: True**
3957   When this resource is set to True, and there are tag files specified (with
3958   the nedit.tagFile resource, see above) as relative paths, NEdit will evaluate
3959   these tag value paths whenever a file is opened. All accessible tag files
3960   will be loaded at this time. When this resource value is False, relative path
3961   tag specifications will only be evaluated at NEdit startup time.
3963 **nedit.shell**: /bin/csh 
3964   
3965   (Unix systems only) The Unix shell (command interpreter) to use for executing
3966   commands from the Shell menu
3968 **nedit.wordDelimiters**: .,/\\`'!@@#%^&*()-=+{}[]":;<>?
3970   The characters, in addition to blanks and tabs, which mark the boundaries
3971   between words for the move-by-word (Ctrl+Arrow) and select-word (double
3972   click) commands.  Note that this default value may be overridden by the
3973   setting in Preferences -> Default Settings -> Language Modes....
3975 **nedit.remapDeleteKey**: False
3976   
3977   Setting this resource to True forcibly maps the delete key to backspace. This
3978   can be helpful on systems where the bindings have become tangled, and in
3979   environments which mix systems with PC style keyboards and systems with DEC
3980   and Macintosh keyboards.  Theoretically, these bindings should be made using
3981   the standard X/Motif mechanisms, outside of NEdit.  In practice, some
3982   environments where users access several different systems remotely, can be
3983   very hard to configure. If you've given up and are using a backspace key
3984   halfway off the keyboard because you can't figure out the bindings, set this
3985   to True.
3986   
3987 **nedit.typingHidesPointer**: False
3988   
3989   Setting this resource to True causes the mouse pointer to be hidden when you
3990   type in the text area. As soon as the mouse pointer is moved, it will 
3991   reappear.  This is useful to stop the mouse pointer from obscuring text.
3992   
3993 **nedit.overrideDefaultVirtualKeyBindings**: Auto
3995   Motif uses a virtual key binding mechanism that shares the bindings between
3996   different Motif applications. When a first Motif application is started, it
3997   installs some default virtual key bindings and any other Motif application 
3998   that runs afterwards, simply reuses them. Obviously, if the first
3999   application installs an invalid set, all others applications may have 
4000   problems.
4001   
4002   In the past, NEdit has been the victim of invalid bindings installed by other 
4003   applications several times. Through this resource, NEdit can be instructed
4004   to ignore the bindings installed by other applications, and use its own
4005   private bindings. By default, NEdit tries to detect invalid bindings
4006   and ignore them automatically (Auto). Optionally, NEdit can be told to
4007   always keep the installed bindings (Never), or to always override them
4008   (Always).
4010 **nedit.stdOpenDialog**: False
4011   
4012   Setting this resource to True restores the standard Motif style of Open
4013   dialog.  NEdit file open dialogs are missing a text field at the bottom of
4014   the dialog, where the file name can be entered as a string.  The field is
4015   removed in NEdit to encourage users to type file names in the list, a
4016   non-standard, but much faster method for finding files.
4018 **nedit.bgMenuButton**: @~Shift@~Ctrl@~Meta@~Alt<Btn3Down>
4019   
4020   Specification for mouse button / key combination to post the background menu
4021   (in the form of an X translation table event specification).  The event
4022   specification should be as specific as possible, since it will override less
4023   specific translation table entries.
4025 **nedit.maxPrevOpenFiles**: 30
4026   
4027   Number of files listed in the Open Previous sub-menu of the File menu.
4028   Setting this to zero disables the Open Previous menu item and maintenance of
4029   the NEdit file history file.
4031 **nedit.printCommand**: (system specific)
4032   
4033   Command used by the print dialog to print a file, such as, lp, lpr, etc..
4034   The command must be capable of accepting input via stdin (standard input).
4036 **nedit.printCopiesOption**: (system specific)
4037   
4038   Option name used to specify multiple copies to the print command.  If the
4039   option should be separated from its argument by a space, leave a trailing
4040   space. If blank, no "Number of Copies" item will appear in the print dialog.
4042 **nedit.printQueueOption**: (system specific)
4043   
4044   Option name used to specify a print queue to the print command.  If the
4045   option should be separated from its argument by a space, leave a trailing
4046   space. If blank, no "Queue" item will appear in the print dialog.
4048 **nedit.printNameOption**: (system specific)
4049   
4050   Option name used to specify a job name to the print command.  If the option
4051   should be separated from its argument by a space, leave a trailing space. If
4052   blank, no job or file name will be attached to the print job or banner page.
4054 **nedit.printHostOption**: (system specific)
4055   
4056   Option name used to specify a host name to the print command.  If the option
4057   should be separated from its argument by a space, leave a trailing space. If
4058   blank, no "Host" item will appear in the print dialog.
4060 **nedit.printDefaultQueue**: (system specific)
4061   
4062   The name of the default print queue.  Used only to display in the print
4063   dialog, and has no effect on printing.
4065 **nedit.printDefaultHost**: (system specific)
4066   
4067   The node name of the default print host.  Used only to display in the print
4068   dialog, and has no effect on printing.
4070 **nedit.visualID**: Best
4072   If your screen supports multiple visuals (color mapping models), this
4073   resource allows you to manually choose among them.  The default value of
4074   "Best" chooses the deepest (most colors) visual available. Since NEdit does
4075   not depend on the specific characteristics of any given color model, Best
4076   probably IS the best choice for everyone, and the only reason for setting
4077   this resource would be to patch around some kind of X server problem. The
4078   resource may also be set to "Default", which chooses the screen's default
4079   visual (often a color-mapped, PseudoColor, visual for compatibility with
4080   older X applications).  It may also be set to a numeric visual-id value (use
4081   xdpyinfo to see the list of visuals supported by your display), or a visual
4082   class name: PseudoColor, DirectColor, TrueColor, etc..
4084   If you are running under a themed environment (like KDE or CDE) that places
4085   its colors in a shallow visual, and you'd rather have that color scheme
4086   instead of more colors available, then you may need set the visual to
4087   "Default" so that NEdit doesn't choose one with more colors.  (The reason
4088   for this is: if the "best" visual is not the server's default, then NEdit
4089   cannot use the colors provided by your environment.  NEdit will fall back to
4090   its own default color scheme.)
4092 **nedit.installColormap**: False
4094   Force the installation of a private colormap.  If you have a humble 8-bit
4095   color display, and netscape is hogging all of the color cells, you may want
4096   to try turning this on.  On most systems, this will result in colors flashing
4097   wildly when you switch between NEdit and other applications.  But a few
4098   systems (SGI) have hardware support for multiple simultaneous colormaps, and
4099   applications with installed colormaps are well behaved.
4101 **nedit.findReplaceUsesSelection**: False
4103   Controls if the Find and Replace dialogs are automatically loaded with the
4104   contents of the primary selection.
4106 **nedit.stickyCaseSenseButton**: True
4108   Controls if the "Case Sensitive" buttons in the Find and Replace dialogs and
4109   the incremental search bar maintain a separate state for literal and regular
4110   expression searches. Moreover, when set to True, by default literal searches
4111   are case insensitive and regular expression searches are case sensitive. When
4112   set to False, the "Case Sensitive" buttons are independent of the "Regular
4113   Expression" toggle.
4115 **nedit.multiClickTime**: (system specific)
4116   
4117   Maximum time in milliseconds allowed between mouse clicks within double and
4118   triple click actions.
4120 **nedit.undoModifiesSelection**: True
4122   By default, NEdit selects any text inserted or changed through a undo/redo
4123   action.  Set this resource to False if you don't want your selection to be
4124   touched.
4126 **nedit@*scrollBarPlacement**: BOTTOM_RIGHT
4127   
4128   How scroll bars are placed in NEdit windows, as well as various lists and
4129   text fields in the program. Other choices are: BOTTOM_LEFT, TOP_LEFT, or
4130   TOP_RIGHT.
4132 **nedit@*text.autoWrapPastedText**: False
4133   
4134   When Auto Newline Wrap is turned on, apply automatic wrapping (which
4135   normally only applies to typed text) to pasted text as well.
4137 **nedit@*text.heavyCursor**: False
4138   
4139   For monitors with poor resolution or users who have difficulty seeing the
4140   cursor, makes the cursor in the text editing area of the window heavier and
4141   darker.
4143 **nedit.autoScrollVPadding**: 4
4144   
4145   Number of lines to keep the cursor away from the top or bottom line of the 
4146   window when the "Auto-Scroll Near Window Top/Bottom" feature is enabled.
4147   Keyboard operations that would cause the cursor to get closer than
4148   this distance cause the window to scroll up or down instead, except at the 
4149   beginning of the file.  Mouse operations are not affected.
4151 **nedit@*text.blinkRate**: 500
4152   
4153   Blink rate of the text insertion cursor in milliseconds.  Set to zero to stop
4154   blinking.
4156 **nedit@*text.Translations**:
4158   Modifies key bindings (see "Key_Binding_").
4160 **nedit@*foreground**: black
4161   
4162   Default foreground color for menus, dialogs, scroll bars, etc..
4164 **nedit@*background**: #b3b3b3
4165   
4166   Default background color for menus, dialogs, scroll bars, etc..
4168 **nedit@*calltipForeground**: black
4170   Foreground color for calltips
4172 **nedit@*calltipBackground**: LemonChiffon1
4174   Background color for calltips
4176 **nedit@*XmLFolder.inactiveForeground**: #666
4177   
4178   Foreground color for inactive tabs.
4180 **nedit@*fontList**: helvetica medium 12 points
4181   
4182   Default font for menus, dialogs, scroll bars, etc..
4184 **nedit.helpFont**: helvetica medium 12 points
4186   Font used for displaying online help.
4187   
4188 **nedit.boldHelpFont**: helvetica bold 12 points
4190   Bold font for online help.
4191   
4192 **nedit.italicHelpFont**: helvetica italic 12 points
4194   Italic font for online help.
4195   
4196 **nedit.fixedHelpFont**: courier medium 12 points
4198   Fixed font for online help.
4199   
4200 **nedit.boldFixedHelpFont**: courier bold 12 points
4202   Fixed bold for online help.
4203   
4204 **nedit.italicFixedHelpFont**: courier italic 12 points
4206   Fixed italic font for online help.
4207   
4208 **nedit.h1HelpFont**: helvetica bold 14 points
4210   Font for level-1 titles in help text.
4211   
4212 **nedit.h2HelpFont**: helvetica bold italic 12 points
4214   Font for level-2 titles in help text.
4215   
4216 **nedit.h3HelpFont**: courier bold 12 points
4218   Font for level-3 titles in help text.
4220 **nedit.helpLinkFont**: helvetica medium 12 points
4222   Font for hyperlinks in the help text
4224 **nedit.helpLinkColor**: #009900
4226   Color for hyperlinks in the help text
4227   
4228 **nedit.backlightCharTypes**:  0-8,10-31,127:red;9:#dedede;32,160-255:#f0f0f0;128-159:orange
4230   **NOTE: backlighting is ~experimental~** (see "Programming_with_NEdit_").
4232   A string specifying character classes as ranges of ASCII values followed by
4233   the color to be used as their background colors.  The format is:
4235   low[-high]{,low[-high]}:color{;low-high{,low[-high]}:color}
4237   where low and high are ASCII values.
4239   For example:
4240     32-255:#f0f0f0;1-31,127:red;128-159:orange;9-13:#e5e5e5
4242 .. DISABLED for 5.4
4243 ..  The macro built-in function set_backlight_string() allows these strings to be
4244 ..  set for a particular window.
4246 **nc.autoStart**: True 
4248   Whether the nc program should automatically start an NEdit server (without
4249   prompting the user) if an appropriate server is not found.
4251 **nc.serverCommand**: nedit -server
4253   Command used by the nc program to start an NEdit server.
4255 **nc.timeOut**: 10
4257   Basic time-out period used in communication with an NEdit server (seconds).
4259    ----------------------------------------------------------------------
4260   ~The following are Selected widget names (to which you may append~
4261   ~.background, .foreground, .fontList, etc., to change colors, fonts~
4262   ~ and other characteristics):~
4264 **nedit@*statsAreaForm**
4266   Statistics line and incremental search bar.  To get consistent results across
4267   the entire stats line and the incremental search bar, use '*' rather than '.'
4268   to separate the resource name.  For example, to set the foreground color of
4269   both components use:  
4270     nedit*statsAreaForm*foreground
4271   instead of:
4272     nedit*statsAreaForm.foreground
4274 **nedit@*menuBar**
4276   Top-of-window menu-bar.
4278 **nedit@*textHorScrollBar**
4280   Horizontal scroll bar.
4282 **nedit@*textVertScrollBar**
4284   Vertical scroll bar.
4285    ----------------------------------------------------------------------
4287 Key Binding
4288 -----------
4290   There are several ways to change key bindings in NEdit.  The easiest way to
4291   add a new key binding in NEdit is to define a macro in Preferences -> Default
4292   Settings -> Customize Menus -> Macro Menu.  However, if you want to change
4293   existing bindings or add a significant number of new key bindings you will
4294   need to do so via X resources.
4296   Before reading this section, you must understand how to set X resources (see
4297   the help section "X_Resources_").  Since setting X resources is tricky, it is
4298   also helpful when working on key-binding, to set some easier-to-verify
4299   resource at the same time, as a simple check that the NEdit program is
4300   actually seeing your changes.  The appres program is also very helpful in
4301   checking that the resource settings that you make, actually reach the program
4302   for which they are intended in the correct form.
4304 3>Key Binding in General
4306   Keyboard commands are associated with editor action routines through two
4307   separate mechanisms in NEdit.  Commands which appear in pull-down menus have
4308   individual resources designating a keyboard equivalent to the menu command,
4309   called an accelerator key.  Commands which do not have an associated menu
4310   item are bound to keys via the X toolkit translation mechanism.  The methods
4311   for changing these two kinds of bindings are quite different.
4313 3>Key Binding Via Translations
4315   The most general way to bind actions to keys in NEdit is to use the
4316   translation table associated with the text widget.  To add a binding to Alt+Y
4317   to insert the string "Hi!", for example, add lines similar to the following
4318   to your X resource file:
4320     NEdit*text.Translations: #override \n\
4321       Alt<Key>y: insert_string("Hi!") \n
4323   The Help topic "Action_Routines_" lists the actions available to be bound.
4325   Translation tables map key and mouse presses, window operations, and other
4326   kinds of events, to actions. The syntax for translation tables is
4327   simplified here, so you may need to refer to a book on the X window system
4328   for more detailed information.
4330   Note that accelerator resources (discussed below) override translations, and
4331   that most Ctrl+letter and Alt+letter combinations are already bound to an
4332   accelerator key.  To use one of these combinations from a translation table,
4333   therefore, you must first un-bind the original menu accelerator.
4335   A resource for changing a translation table consists of a keyword; #override,
4336   #augment, or #replace; followed by lines (separated by newline characters)
4337   pairing events with actions.  Events begin with modifiers, like Ctrl, Shift,
4338   or Alt, followed by the event type in <>.  BtnDown, Btn1Down, Btn2Down,
4339   Btn1Up, Key, KeyUp are valid event types.  For key presses, the event type is
4340   followed by the name of the key.  You can specify a combination of events,
4341   such as a sequence of key presses, by separating them with commas.  The other
4342   half of the event/action pair is a set of actions.  These are separated from
4343   the event specification by a colon and from each other by spaces.  Actions
4344   are names followed by parentheses, optionally containing one or more
4345   parameters separated by comas.
4347 3>Changing Menu Accelerator Keys
4349   The menu shortcut keys shown at the right of NEdit menu items can also be
4350   changed via X resources.  Each menu item has two resources associated with
4351   it, accelerator, the event to trigger the menu item; and acceleratorText, the
4352   string shown in the menu.  The form of the accelerator resource is the same
4353   as events for translation table entries discussed above, though multiple keys
4354   and other subtleties are not allowed.  The resource name for a menu is the
4355   title in lower case, followed by "Menu", the resource name of menu item is
4356   the name in lower case, run together, with words separated by caps, and all
4357   punctuation removed.  For example, to change Cut to Ctrl+X, you would add the
4358   following to your .Xdefaults file:
4360       nedit*editMenu.cut.accelerator: Ctrl<Key>x
4361       nedit*editMenu.cut.acceleratorText: Ctrl+X
4363   Accelerator keys with optional shift key modifiers, like Find..., have an
4364   additional accelerator resource with Shift appended to the name.  For
4365   example:
4367       nedit*searchMenu.find.acceleratorText: [Shift]Alt+F
4368       nedit*searchMenu.find.accelerator: Alt<Key>f
4369       nedit*searchMenu.findShift.accelerator: Shift Alt<Key>f
4370    ----------------------------------------------------------------------
4372 Highlighting Patterns
4373 ---------------------
4375 3>Writing Syntax Highlighting Patterns
4377   Patterns are the mechanism by which language syntax highlighting is
4378   implemented in NEdit (see Syntax_Highlighting_ under the heading of Features
4379   for Programming). To create syntax highlighting patterns for a new
4380   language, or to modify existing patterns, select "Recognition Patterns" from
4381   "Syntax Highlighting" sub-section of the "Default Settings" sub-menu of the
4382   "Preferences" menu.
4384   First, a word of caution.  As with regular expression matching in general, it
4385   is quite possible to write patterns which are so inefficient that they
4386   essentially lock up the editor as they recursively re-examine the entire
4387   contents of the file thousands of times.  With the multiplicity of patterns,
4388   the possibility of a lock-up is significantly increased in syntax
4389   highlighting.  When working on highlighting patterns, be sure to save your
4390   work frequently.
4392   NEdit's syntax highlighting is unusual in that it works in real-time (as you
4393   type), and yet is completely programmable using standard regular expression
4394   notation.  Other syntax highlighting editors usually fall either into the
4395   category of fully programmable but unable to keep up in real-time, or
4396   real-time but limited programmability.  The additional burden that NEdit
4397   places on pattern writers in order to achieve this speed/flexibility mix, is
4398   to force them to state self-imposed limitations on the amount of context that
4399   patterns may examine when re-parsing after a change.  While the "Pattern
4400   Context Requirements" heading is near the end of this section, it is not
4401   optional, and must be understood before making any any serious effort at
4402   pattern writing.
4404   In its simplest form, a highlight pattern consists of a regular expression to
4405   match, along with a style representing the font an color for displaying any
4406   text which matches that expression.  To bold the word, "highlight", wherever
4407   it appears the text, the regular expression simply would be the word
4408   "highlight".  The style (selected from the menu under the heading of
4409   "Highlight Style") determines how the text will be drawn.  To bold the text,
4410   either select an existing style, such as "Keyword", which bolds text, or
4411   create a new style and select it under Highlight Style.
4413   The full range of regular expression capabilities can be applied in such a
4414   pattern, with the single caveat that the expression must conclusively match
4415   or not match, within the pre-defined context distance (as discussed below
4416   under Pattern Context Requirements).
4418   To match longer ranges of text, particularly any constructs which exceed the
4419   requested context, you must use a pattern which highlights text between a
4420   starting and ending regular expression match.  To do so, select "Highlight
4421   text between starting and ending REs" under "Matching", and enter both a
4422   starting and ending regular expression.  For example, to highlight everything
4423   between double quotes, you would enter a double quote character in both the
4424   starting and ending regular expression fields.  Patterns with both a
4425   beginning and ending expression span all characters between the two
4426   expressions, including newlines.
4428   Again, the limitation for automatic parsing to operate properly is that both
4429   expressions must match within the context distance stated for the pattern
4430   set.
4432   With the ability to span large distances, comes the responsibility to recover
4433   when things go wrong.  Remember that syntax highlighting is called upon to
4434   parse incorrect or incomplete syntax as often as correct syntax.  To stop a
4435   pattern short of matching its end expression, you can specify an error
4436   expression, which stops the pattern from gobbling up more than it should. 
4437   For example, if the text between double quotes shouldn't contain newlines,
4438   the error expression might be "$".  As with both starting and ending
4439   expressions, error expressions must also match within the requested context
4440   distance.
4442 4>Coloring Sub-Expressions
4444   It is also possible to color areas of text within a regular expression
4445   match.  A pattern of this type associates a style with sub-expressions
4446   references of the parent pattern (as used in regular expression substitution
4447   patterns, see the NEdit Help menu item on Regular_Expressions_). 
4448   Sub-expressions of both the starting and ending patterns may be colored.  For
4449   example, if the parent pattern has a starting expression "\<", and end
4450   expression "\>", (for highlighting all of the text contained within angle
4451   brackets), a sub-pattern using "&" in both the starting and ending expression
4452   fields could color the brackets differently from the intervening text.  A
4453   quick shortcut to typing in pattern names in the Parent Pattern field is to
4454   use the middle mouse button to drag them from the Patterns list.
4456 4>Hierarchical Patterns
4458   A hierarchical sub-pattern, is identical to a top level pattern, but is
4459   invoked only between the beginning and ending expression matches of its
4460   parent pattern.  Like the sub-expression coloring patterns discussed above,
4461   it is associated with a parent pattern using the Parent Pattern field in the
4462   pattern specification.  Pattern names can be dragged from the pattern list
4463   with the middle mouse button to the Parent Pattern field.
4465   After the start expression of the parent pattern matches, the syntax
4466   highlighting parser searches for either the parent's end pattern or a
4467   matching sub-pattern.  When a sub-pattern matches, control is not returned to
4468   the parent pattern until the entire sub-pattern has been parsed, regardless
4469   of whether the parent's end pattern appears in the text matched by the
4470   sub-pattern.
4472   The most common use for this capability is for coloring sub-structure of
4473   language constructs (smaller patterns embedded in larger patterns). 
4474   Hierarchical patterns can also simplify parsing by having sub-patterns "hide"
4475   special syntax from parent patterns, such as special escape sequences or
4476   internal comments.
4478   There is no depth limit in nesting hierarchical sub-patterns, but beyond the
4479   third level of nesting, automatic re-parsing will sometimes have to re-parse
4480   more than the requested context distance to guarantee a correct parse (which
4481   can slow down the maximum rate at which the user can type if large sections
4482   of text are matched only by deeply nested patterns).
4484   While this is obviously not a complete hierarchical language parser it is
4485   still useful in many text coloring situations.  As a pattern writer, your
4486   goal is not to completely cover the language syntax, but to generate
4487   colorings that are useful to the programmer.  Simpler patterns are usually
4488   more efficient and also more robust when applied to incorrect code.
4490 4>Deferred (Pass-2) Parsing
4492   NEdit does pattern matching for syntax highlighting in two passes.  The first
4493   pass is applied to the entire file when syntax highlighting is first turned
4494   on, and to new ranges of text when they are initially read or pasted in.  The
4495   second pass is applied only as needed when text is exposed (scrolled in to
4496   view).
4498   If you have a particularly complex set of patterns, and parsing is beginning
4499   to add a noticeable delay to opening files or operations which change large
4500   regions of text, you can defer some of that parsing from startup time, to
4501   when it is actually needed for viewing the text.  Deferred parsing can only
4502   be used with single expression patterns, or begin/end patterns which match
4503   entirely within the requested context distance.  To defer the parsing of a
4504   pattern to when the text is exposed, click on the Pass-2 pattern type button
4505   in the highlight patterns dialog.
4507   Sometimes a pattern can't be deferred, not because of context requirements,
4508   but because it must run concurrently with pass-1 (non-deferred) patterns.  If
4509   they didn't run concurrently, a pass-1 pattern might incorrectly match some
4510   of the characters which would normally be hidden inside of a sequence matched
4511   by the deferred pattern.  For example, C has character constants enclosed in
4512   single quotes.  These typically do not cross line boundaries, meaning they
4513   can be parsed entirely within the context distance of the C pattern set and
4514   should be good candidates for deferred parsing.  However, they can't be
4515   deferred because they can contain sequences of characters which can trigger
4516   pass-one patterns. Specifically, the sequence, '\"', contains a double quote
4517   character, which would be matched by the string pattern and interpreted as
4518   introducing a string.
4520 4>Pattern Context Requirements
4522   The context requirements of a pattern set state how much additional text
4523   around any change must be examined to guarantee that the patterns will match
4524   what they are intended to match.  Context requirements are a promise by NEdit
4525   to the pattern writer, that the regular expressions in his/her patterns will
4526   be matched against at least <line context> lines and <character context>
4527   characters, around any modified text.  Combining line and character
4528   requirements guarantee that both will be met.
4530   Automatic re-parsing happens on EVERY KEYSTROKE, so the amount of context
4531   which must be examined is very critical to typing efficiency.  The more
4532   complicated your patterns, the more critical the context becomes.  To cover
4533   all of the keywords in a typical language, without affecting the maximum rate
4534   at which users can enter text, you may be limited to just a few lines and/or
4535   a few hundred characters of context.
4537   The default context distance is 1 line, with no minimum character
4538   requirement.  There are several benefits to sticking with this default.  One
4539   is simply that it is easy to understand and to comply with.  Regular
4540   expression notation is designed around single line matching.  To span lines
4541   in a regular expression, you must explicitly mention the newline character
4542   "\n", and matches which are restricted to a single line are virtually immune
4543   to lock-ups.  Also, if you can code your patterns to work within a single
4544   line of context, without an additional character-range context requirement,
4545   the parser can take advantage the fact that patterns don't cross line
4546   boundaries, and nearly double its efficiency over a one-line and 1-character
4547   context requirement.  (In a single line context, you are allowed to match
4548   newlines, but only as the first and/or last character.)
4549    ----------------------------------------------------------------------
4551 Smart Indent Macros
4552 -------------------
4554   Smart indent macros can be written for any language, but are usually more
4555   difficult to write than highlighting patterns.  A good place to start, of
4556   course, is to look at the existing macros for C and C++.
4558   Smart indent macros for a language mode consist of standard NEdit macro
4559   language code attached to any or all of the following three activation
4560   conditions: 1) When smart indent is first turned on for a text window
4561   containing code of the language, 2) When a newline is typed and smart indent
4562   is expected, 3) after any character is typed.  To attach macro code to any of
4563   these code "hooks", enter it in the appropriate section in the Preferences ->
4564   Default Settings -> Auto Indent -> Program Smart Indent dialog.
4566   Typically most of the code should go in the initialization section, because
4567   that is the appropriate place for subroutine definitions, and smart indent
4568   macros are complicated enough that you are not likely to want to write them
4569   as one monolithic run of code.  You may also put code in the Common/Shared
4570   Initialization section (accessible through the button in the upper left
4571   corner of the dialog).  Unfortunately, since the C/C++ macros also reside in
4572   the common/shared section, when you add code there, you run some risk of
4573   missing out on future upgrades to these macros, because your changes will
4574   override the built-in defaults.
4576   The newline macro is invoked after the user types a newline, but before the
4577   newline is entered in the buffer.  It takes a single argument ($1) which is
4578   the position at which the newline will be inserted.  It must return the
4579   number of characters of indentation the line should have, or -1.  A return
4580   value of -1 means to do a standard auto-indent.  You must supply a newline
4581   macro, but the code: "return -1" (auto-indent), or "return 0" (no indent) is
4582   sufficient.
4584   The type-in macro takes two arguments.  $1 is the insert position, and $2 is
4585   the character just inserted, and does not return a value.  You can do just
4586   about anything here, but keep in mind that this macro is executed for every
4587   keystroke typed, so if you try to get too fancy, you may degrade performance.
4588    ----------------------------------------------------------------------
4590 NEdit Command Line
4591 ------------------
4593 .. ? help !!#ifndef VMS
4594    **nedit** [-**read**] [-**create**] [-**line** n | +n] [-**server**]
4595       [-**do** command] [-**tags** file] [-**tabs** n] [-**wrap**]
4596       [-**nowrap**] [-**autowrap**] [-**autoindent**] [-**noautoindent**]
4597       [-**autosave**] [-**noautosave**] [-**rows** n] [-**columns** n]
4598       [-**font** font] [-**lm** languagemode] [-**geometry** geometry]
4599       [-**iconic**] [-**noiconic**] [-**display** [host]:server[.screen]
4600       [-**xrm** resourcestring] [-**svrname** name] [-**import** file]
4601       [-**background** color] [-**foreground** color]
4602       [-**tabbed**] [-**untabbed**] [-**group**] [-**V**|-**version**]
4603       [--] [file...]
4605 **-read**
4606   Open the file Read Only regardless of the actual file protection.
4608 **-create**
4609   Don't warn about file creation when a file doesn't exist.
4611 **-line n (or +n)**
4612   Go to line number n
4614 **-server**
4615   Designate this session as an NEdit server, for processing commands from the
4616   nc program.  nc can be used to interface NEdit to code development
4617   environments, mailers, etc., or just as a quick way to open files from the
4618   shell command line without starting a new NEdit session.
4620 **-do command**
4621   Execute an NEdit macro or action on the file following the -do argument on 
4622   the command line. -do is particularly useful from the nc program, where 
4623   nc -do can remotely execute commands in an NEdit -server session.
4625 **-tags file**
4626   Load a file of directions for finding definitions of program subroutines and
4627   data objects.  The file must be of the format generated by Exuberant Ctags,
4628   or the standard Unix ctags command.
4630 **-tabs n**
4631   Set tab stops every n characters.
4633 **-wrap, -nowrap**
4634   Wrap long lines at the right edge of the window rather than continuing them
4635   past it.  (Continuous Wrap mode)
4637 **-autowrap, -noautowrap**
4638   Wrap long lines when the cursor reaches the right edge of the window by
4639   inserting newlines at word boundaries.  (Auto Newline Wrap mode)
4641 **-autoindent, -noautoindent**
4642   Maintain a running indent.
4644 **-autosave, -noautosave**
4645   Maintain a backup copy of the file being edited under the name '~filename'. 
4647 **-rows n**
4648   Default height in characters for an editing window.
4650 **-columns n**
4651   Default width in characters for an editing window.
4653 **-font font (or -fn font)**
4654   Font for text being edited (Font for menus and dialogs can be set with -xrm
4655   "*fontList:font").
4657 **-lm languagemode**
4658   Initial language mode used for editing succeeding files.
4660 **-geometry geometry (or -g geometry)**
4661   The initial size and/or location of editor windows.  The argument geometry
4662   has the form:
4664    [<width>x<height>][+|-][<xoffset>[+|-]<yoffset>]
4666   where <width> and <height> are the desired width and height of the window,
4667   and <xoffset> and <yoffset> are the distance from the edge of the screen to
4668   the window, + for top or left, - for bottom or right.  -geometry can be
4669   specified for individual files on the command line.
4671 **-iconic, -noiconic**
4672   Initial window state for succeeding files.
4674 **-display [host]:server[.screen]**
4675   The name of the X server to use.  host specifies the machine, server
4676   specifies the display server number, and screen specifies the screen number. 
4677   host or screen can be omitted and default to the local machine, and screen 0.
4679 **-background color (or -bg color)**
4680   User interface background color. (Background color for text can be set
4681   separately with -xrm "nedit.textBgColor: color" or using the Preferences ->
4682   Colors dialog).
4684 **-foreground color (or -fg color)**
4685   User interface foreground color. (Foreground color for text can be set
4686   separately with -xrm "nedit.textFgColor: color" or using the Preferences
4687   -> Colors dialog).
4689 **-tabbed**
4690   Open all subsequent files in new tabs. Resets -group option.
4692 **-untabbed**
4693   Open all subsequent files in new windows. Resets -group option.
4695 **-group**
4696   Open all subsequent files as tabs in a new window.
4698 **-xrm resourcestring** 
4699   Set the value of an X resource to override a default
4700   value (see "Customizing_NEdit_").
4702 **-svrname name**
4703   When starting NEdit in server mode, name the server, such that it responds to
4704   requests only when nc is given a corresponding -svrname argument.  By naming
4705   servers, you can run several simultaneously, and direct files and commands
4706   specifically to any one. Specifying a non-empty name automatically designates
4707   this session as an NEdit server, as though -server were specified.
4709 **-import file**
4710   Loads an additional preferences file on top of the existing defaults saved in
4711   your preferences file.  To incorporate macros, language modes, and highlight
4712   patterns and styles written by other users, run NEdit with -import <file>,
4713   then re-save your preference file with Preferences -> Save Defaults.
4715 **-version**
4716   Prints out the NEdit version information. The -V option is synonymous.
4717   
4718 **--**
4719   Treats all subsequent arguments as file names, even if they start with a
4720   dash. This is so NEdit can access files that begin with the dash character.
4722 .. ? help~
4723 !!#else
4725 ..   This documentation for VMS NEdit usage should only appear in the
4726 ..   generated help code, not in any of the printed documentation.
4727 ..   Reasoning is that VMS usage is diminishing and there is a desire
4728 ..   to not clutter up the printed documentation here.
4730   NEDIT [filespec[,...]]
4732   The following qualifiers are accepted:
4734 **/read**
4735   Open the file Read Only regardless of the actual file protection.
4737 **/create**
4738   Don't warn about file creation when a file doesn't exist.
4740 **/line=n**
4741   Go to line #n
4743 **/server** 
4744   Designate this session as an NEdit server for processing commands from the nc
4745   program. The nc program can be used to interface NEdit to code development
4746   environments, mailers, etc., or just as a quick way to open files from the
4747   shell command line without starting a new NEdit session.
4749 **/do=command**
4750   Execute an NEdit action routine. on each file following the /do argument on
4751   the command line.  /do is particularly useful from the nc program, where nc
4752   /do can remotely execute commands in an nedit /server session.
4754 **/tags=file**
4755   Load a file of directions for finding definitions of program subroutines and
4756   data objects.  The file must be of the format generated by the Unix ctags
4757   command.
4759 **/wrap, /nowrap**
4760   Wrap long lines at the right edge of the window rather than continuing them
4761   past it.  (Continuous Wrap mode)
4763 **/autowrap, /noautowrap**
4764   Wrap long lines when the cursor reaches the right edge of the window by
4765   inserting newlines at word boundaries.  (Auto Newline Wrap mode)
4767 **/autoindent, /noautoindent**
4768   Maintain a running indent.
4770 **/autosave, /noautosave**
4771   Maintain a backup copy of the file being edited under the name '_filename'.
4773 **/rows=n**
4774   Default width in characters for an editing window.
4776 **/columns=n**
4777   Default height in characters for an editing window.
4779 **/font=font (or /fn=font)**
4780   Font for text being edited (Font for menus and dialogs can be set with 
4781   /xrm="*fontList:font").
4783 **/display [host]:server[.screen]**
4784   The name of the X server to use.  host specifies the machine, server
4785   specifies the display server number, and screen specifies the screen number. 
4786   host or screen can be omitted and default to the local machine, and screen 0.
4788 **/geometry=geometry (or /g=geometry)**
4789   The initial size and/or location of editor windows. The argument geometry
4790   has the form:
4792     [<width>x<height>][+|-][<xoffset>[+|-]<yoffset>]
4794   where <width> and <height> are the desired width and height of the window,
4795   and <xoffset> and <yoffset> are the distance from the edge of the screen to
4796   the window, + for top or left, - for bottom or right.
4798 **/background=color (or /bg=color)**
4800   Background color. (background color for text can be set separately with 
4801   /xrm="nedit:textBgColor color" or using the Preferences ->
4802   Colors dialog).
4804 **/foreground=color (or /fg=color)**
4805   Foreground color. (foreground color for text can be set separately with
4806   /xrm="nedit:textFgColor color" or using the Preferences ->
4807   Colors dialog).
4809 **/tabbed**
4810   Open all subsequent files in new tabs. Resets /group option.
4812 **/untabbed**
4813   Open all subsequent files in new windows. Resets /group option.
4815 **/group**
4816   Open all subsequent files as tabs in a new window.
4818 **/xrm=resourcestring**
4819   Set the value of an X resource to override a default value 
4820   (see Customizing NEdit).
4822 **/svrname=name**
4823   When starting nedit in server mode, name the server, such that it responds to
4824   requests only when nc is given a corresponding -svrname argument.  By naming
4825   servers, you can run several simultaneously, and direct files and commands
4826   specifically to any one.
4828 **/import=file**
4829   Loads an additional preferences file on top of the existing defaults saved in
4830   your .nedit file.  To incorporate macros, language modes, and highlight
4831   patterns and styles written by other users, run nedit with /import=<file>,
4832   then re-save your .nedit file with Preferences -> Save Defaults.
4834   Unix-style command lines (but not file names) are also acceptable:
4836     nedit -rows 20 -wrap file1.c file2.c
4838   is equivalent to:
4840     nedit /rows=20/wrap file1.c, file2.c",
4841 !!#endif /* VMS */    
4842 .. ~ help
4843    ----------------------------------------------------------------------
4845 Client/Server Mode
4846 ------------------
4848   NEdit can be operated on its own, or as a two-part client/server
4849   application.  Client/server mode is useful for integrating NEdit with
4850   software development environments, mailers, and other programs; or just as a
4851   quick way to open files from the shell command line without starting a new
4852   NEdit session.
4854   To run NEdit in server mode, type:
4856       nedit -server
4858   NEdit can also be started in server mode via the NEdit Client program
4859   (**nc**) when no servers are available.
4861   The nc program, which is distributed along with NEdit, sends commands to
4862   an NEdit server to open files or execute editor actions. It can also be
4863   used on files that are already opened.
4864   
4865   Listing a file on the nc command line means: Open it if it is not already
4866   open and bring the window to the front.
4869   nc supports the following command line options:
4871     **nc** [**-read**] [**-create**]
4872        [**-line** n | **+**n] [**-do** command] [**-lm** languagemode]
4873        [**-svrname** name] [**-svrcmd** command]
4874        [**-ask**] [**-noask**] [**-timeout** seconds]
4875        [**-geometry** geometry | **-g** geometry] [**-icon** | **-iconic**]
4876        [-**tabbed**] [-**untabbed**] [-**group**] [**-wait**]
4877        [**-V** | **-version**]
4878        [**-xrm** resourcestring] [**-display** [host]:server[.screen]]
4879        [**-**-] [file...]
4880   
4881 **-read**
4882   Open the file read-only regardless of its actual permissions. There is no
4883   effect if the file is already open.
4885 **-create**
4886   Don't warn about file creation when a file doesn't exist.
4888 **-line** n, **+**n
4889   Go to line number n. This will also affect files which are already open.
4891 **-do** command
4892   Execute an NEdit macro or action on the file following the -do argument
4893   on the command line.
4894   
4895   If you use this command without a filename, nc would randomly choose one
4896   window to focus and execute the macro in.
4898 **-ask**, **-noask**
4899   Instructs nc to automatically start a server if one is not available.  This
4900   overrides the X resource `nc.autoStart' (see X_Resources_).
4902 **-svrname** name
4903   Explicitly instructs nc which server to connect to, an instance of
4904   nedit(1) with a corresponding -svrname argument.  By naming servers, you
4905   can run several simultaneously, and direct files and commands
4906   specifically to any one. 
4908 **-svrcmd** command
4909   The command which nc uses to start an NEdit server. It is also settable
4910   via the X resource `nc.serverCommand' (see X_Resources_). Defaults to
4911   "nedit -server".
4913 **-lm** languagemode
4914   Initial language mode used.
4916 **-geometry** geometry, **-g** geometry
4917   The initial size and/or location of editor windows. See
4918   NEdit_Command_Line_ for details.
4920 **-icon**, **-iconic**
4921   Initial window state.
4923 **-display** [<host>]:<server>[.<screen>]
4924   The name of the X server to use. See NEdit_Command_Line_ for details.
4926 **-timeout** seconds
4927   Basic time-out period used in communication with an NEdit server.  The
4928   default is 10 seconds. Also settable via the X resource `nc.timeOut'.
4930   Under rare conditions (such as a slow connection), it may be necessary to
4931   increase the time-out period. In most cases, the default is fine.
4933 **-tabbed**
4934   Open all subsequent files in new tabs. Resets -group option.
4936 **-untabbed**
4937   Open all subsequent files in new windows. Resets -group option.
4939 **-group**
4940   Open all subsequent files as tabs in a new window.
4942 **-wait**
4943   Instructs nc not to return to the shell until all files given are closed.
4944   
4945   Normally, nc returns once the files given in its command line are opened
4946   by the server. When this option is given, nc returns only after the last
4947   file given in this call is closed.
4948   
4949   Note that this option affects all files in the command line, not only the
4950   ones following this option.
4951   
4952   Note that nc will wait for all files given in the command line, even if
4953   the files were already opened.
4956 4>Command Line Arguments
4958   In typical Unix style, arguments affect the files which follow them on the
4959   command line, for example:
4961       incorrect:   nc file.c -line 25
4962       correct:     nc -line 25 file.c
4964   -read, -create, and -line affect all of the files which follow them on the
4965   command line.
4966   
4967   The -do macro is executed only once, on the next file on the line.  -do
4968   without a file following it on the command line, executes the macro on the
4969   first available window (presumably when you give a -do command without a
4970   corresponding file or window, you intend it to do something independent of
4971   the window in which it happens to execute).
4972   
4973   The -wait option affects all files named in the command line.
4975 4>Multiple Servers
4977   Sometimes it is useful to have more than one NEdit server running, for
4978   example to keep mail and programming work separate.  The option, -svrname, to
4979   both nedit and nc, allows you to start, and communicate with, separate named
4980   servers.  A named server responds only to requests with the corresponding
4981   -svrname argument.  If you use ClearCase and are within a ClearCase view, the
4982   server name will default to the name of the view (based on the value of the
4983   CLEARCASE_ROOT environment variable).
4985 4>Communication
4987   Communication between nc and nedit is done through the X display. So as long
4988   as the X Window System is set up and working properly, nc will work properly
4989   as well. nc uses the DISPLAY environment variable, the machine name and your
4990   user name to find the appropriate server, meaning, if you have several
4991   machines sharing a common file system, nc will not be able to find a server
4992   that is running on a machine with a different host name, even though it may
4993   be perfectly appropriate for editing a given file.
4995   The command which nc uses to start an nedit server is settable via the X
4996   resource nc.serverCommand, by default, "nedit -server".
4997    ----------------------------------------------------------------------
4999 Crash Recovery
5000 --------------
5002   If a system crash, network failure, X server crash, or program error should
5003   happen while you are editing a file, you can still recover most of your
5004   work.  NEdit maintains a backup file which it updates periodically (every 8
5005   editing operations or 80 characters typed).  This file has the same name
5006   as the file that you are editing, but with the character `~' (tilde) on Unix
5007   or `_' (underscore) on VMS prefixed to the name.  To recover a file after a
5008   crash, simply rename the file to remove the tilde or underscore character,
5009   replacing the older version of the file.  (Because several of the Unix shells
5010   consider the tilde to be a special character, you may have to prefix the
5011   character with a `\' (backslash) when you move or delete an NEdit backup
5012   file.)
5014   Example, to recover the file called "help.c" on Unix type the command:
5016       mv \~help.c help.c
5018   A minor caveat, is that if the file you were editing was in MS DOS format,
5019   the backup file will be in Unix format, and you will need to open the backup
5020   file in NEdit and change the file format back to MS DOS via the Save As...
5021   dialog (or use the Unix unix2dos command outside of NEdit).
5022    ----------------------------------------------------------------------
5024 Version
5025 -------
5026 .. ! help~
5028 |>version<|
5029 |>date<|
5031 .. ~ help
5033 .. There is build time versioning information that is handled specially
5034 .. inside help.c for this section. It needs to have a '%s' string
5035 .. made available for it to appear in the on-line help.
5037 .. ? help %s
5039 .. ======================================================================
5040 .. The policy for credit so far is this:
5042 .. You get "written by" credit if you have contributed significant
5043 .. code or effort to the project.
5045 .. You get a syntax/indent credit if your pattern is compiled into the
5046 .. binary.
5047 .. ======================================================================
5049   NEdit was written by Mark Edel, Joy Kyriakopulos, Christopher Conrad,
5050   Jim Clark, Arnulfo Zepeda-Navratil, Suresh Ravoor, Tony Balinski, Max
5051   Vohlken, Yunliang Yu, Donna Reid, Arne Førlie, Eddy De Greef, Steve
5052   LoBasso, Alexander Mai, Scott Tringali, Thorsten Haude, Steve Haehn,
5053   Andrew Hood, Nathaniel Gray, and TK Soh.
5055   The regular expression matching routines used in NEdit are adapted (with
5056   permission) from original code written by Henry Spencer at the
5057   University of Toronto.
5059   The Microline widgets are inherited from the Mozilla project.
5061   Syntax highlighting patterns and smart indent macros were contributed by:
5062   Simon T. MacDonald,  Maurice Leysens, Matt Majka, Alfred Smeenk,
5063   Alain Fargues, Christopher Conrad, Scott Markinson, Konrad Bernloehr,
5064   Ivan Herman, Patrice Venant, Christian Denat, Philippe Couton,
5065   Max Vohlken, Markus Schwarzenberg, Himanshu Gohel, Steven C. Kapp,
5066   Michael Turomsha, John Fieber, Chris Ross, Nathaniel Gray, Joachim Lous,
5067   Mike Duigou, Seak Teng-Fong, Joor Loohuis, Mark Jones,
5068   and Niek van den Berg.
5070   NEdit sources, executables, additional documentation, and contributed
5071   software are available from the NEdit web site at http://www.nedit.org_.
5073   This program is free software; you can redistribute it and/or
5074   modify it under the terms of the GNU_General_Public_License_
5075   as published by the Free Software Foundation; either version 2
5076   of the License, or (at your option) any later version.
5078   In addition, as a special exception to the GNU GPL, the copyright holders
5079   give permission to link the code of this program with the Motif and Open
5080   Motif libraries (or with modified versions of these that use the same
5081   license), and distribute linked combinations including the two. You must
5082   obey the GNU General Public License in all respects for all of the code
5083   used other than linking with Motif/Open Motif. If you modify this file,
5084   you may extend this exception to your version of the file, but you are
5085   not obligated to do so. If you do not wish to do so, delete this
5086   exception statement from your version.
5088   This program is distributed in the hope that it will be useful,
5089   but WITHOUT ANY WARRANTY; without even the implied warranty of
5090   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
5091   section on the GNU_General_Public_License_ for more details.
5092    ----------------------------------------------------------------------
5094 GNU General Public License
5095 -------------------
5097   GNU GENERAL PUBLIC LICENSE
5099   Version 2, June 1991
5101   Copyright (C) 1989, 1991 Free Software Foundation, Inc. 675 Mass Ave,
5102   Cambridge, MA 02139, USA. Everyone is permitted to copy and distribute
5103   verbatim copies of this license document, but changing it is not allowed.
5105   Preamble
5107   The licenses for most software are designed to take away your freedom to
5108   share and change it. By contrast, the GNU General Public License is intended
5109   to guarantee your freedom to share and change free software--to make sure the
5110   software is free for all its users. This General Public License applies to
5111   most of the Free Software Foundation's software and to any other program
5112   whose authors commit to using it. (Some other Free Software Foundation
5113   software is covered by the GNU Library General Public License instead.) You
5114   can apply it to your programs, too.
5116   When we speak of free software, we are referring to freedom, not price. Our
5117   General Public Licenses are designed to make sure that you have the freedom
5118   to distribute copies of free software (and charge for this service if you
5119   wish), that you receive source code or can get it if you want it, that you
5120   can change the software or use pieces of it in new free programs; and that
5121   you know you can do these things.
5123   To protect your rights, we need to make restrictions that forbid anyone to
5124   deny you these rights or to ask you to surrender the rights. These
5125   restrictions translate to certain responsibilities for you if you distribute
5126   copies of the software, or if you modify it.
5128   For example, if you distribute copies of such a program, whether gratis or
5129   for a fee, you must give the recipients all the rights that you have. You
5130   must make sure that they, too, receive or can get the source code. And you
5131   must show them these terms so they know their rights.
5133   We protect your rights with two steps: (1) copyright the software, and (2)
5134   offer you this license which gives you legal permission to copy, distribute
5135   and/or modify the software.
5137   Also, for each author's protection and ours, we want to make certain that
5138   everyone understands that there is no warranty for this free software. If the
5139   software is modified by someone else and passed on, we want its recipients to
5140   know that what they have is not the original, so that any problems introduced
5141   by others will not reflect on the original authors' reputations.
5143   Finally, any free program is threatened constantly by software patents. We
5144   wish to avoid the danger that redistributors of a free program will
5145   individually obtain patent licenses, in effect making the program
5146   proprietary. To prevent this, we have made it clear that any patent must be
5147   licensed for everyone's free use or not licensed at all.
5149   The precise terms and conditions for copying, distribution and modification
5150   follow.
5152   GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND
5153   MODIFICATION
5155   0. This License applies to any program or other work which contains a notice
5156   placed by the copyright holder saying it may be distributed under the terms
5157   of this General Public License. The "Program", below, refers to any such
5158   program or work, and a "work based on the Program" means either the Program
5159   or any derivative work under copyright law: that is to say, a work containing
5160   the Program or a portion of it, either verbatim or with modifications and/or
5161   translated into another language. (Hereinafter, translation is included
5162   without limitation in the term "modification".) Each licensee is addressed as
5163   "you".
5165   Activities other than copying, distribution and modification are not covered
5166   by this License; they are outside its scope. The act of running the Program
5167   is not restricted, and the output from the Program is covered only if its
5168   contents constitute a work based on the Program (independent of having been
5169   made by running the Program). Whether that is true depends on what the
5170   Program does.
5172   1. You may copy and distribute verbatim copies of the Program's source code
5173   as you receive it, in any medium, provided that you conspicuously and
5174   appropriately publish on each copy an appropriate copyright notice and
5175   disclaimer of warranty; keep intact all the notices that refer to this
5176   License and to the absence of any warranty; and give any other recipients of
5177   the Program a copy of this License along with the Program.
5179   You may charge a fee for the physical act of transferring a copy, and you may
5180   at your option offer warranty protection in exchange for a fee.
5182   2. You may modify your copy or copies of the Program or any portion of it,
5183   thus forming a work based on the Program, and copy and distribute such
5184   modifications or work under the terms of Section 1 above, provided that you
5185   also meet all of these conditions:
5187   a) You must cause the modified files to carry prominent notices stating
5188   that you changed the files and the date of any change.
5190   b) You must cause any work that you distribute or publish, that in whole or
5191   in part contains or is derived from the Program or any part thereof, to be
5192   licensed as a whole at no charge to all third parties under the terms of
5193   this License.
5195   c) If the modified program normally reads commands interactively when run,
5196   you must cause it, when started running for such interactive use in the
5197   most ordinary way, to print or display an announcement including an
5198   appropriate copyright notice and a notice that there is no warranty (or
5199   else, saying that you provide a warranty) and that users may redistribute
5200   the program under these conditions, and telling the user how to view a copy
5201   of this License. (Exception: if the Program itself is interactive but does
5202   not normally print such an announcement, your work based on the Program is
5203   not required to print an announcement.)
5205   These requirements apply to the modified work as a whole. If identifiable
5206   sections of that work are not derived from the Program, and can be reasonably
5207   considered independent and separate works in themselves, then this License,
5208   and its terms, do not apply to those sections when you distribute them as
5209   separate works. But when you distribute the same sections as part of a whole
5210   which is a work based on the Program, the distribution of the whole must be
5211   on the terms of this License, whose permissions for other licensees extend to
5212   the entire whole, and thus to each and every part regardless of who wrote it.
5214   Thus, it is not the intent of this section to claim rights or contest your
5215   rights to work written entirely by you; rather, the intent is to exercise the
5216   right to control the distribution of derivative or collective works based on
5217   the Program.
5219   In addition, mere aggregation of another work not based on the Program with
5220   the Program (or with a work based on the Program) on a volume of a storage or
5221   distribution medium does not bring the other work under the scope of this
5222   License.
5224   3. You may copy and distribute the Program (or a work based on it, under
5225   Section 2) in object code or executable form under the terms of Sections 1
5226   and 2 above provided that you also do one of the following:
5228   a) Accompany it with the complete corresponding machine-readable source
5229   code, which must be distributed under the terms of Sections 1 and 2 above
5230   on a medium customarily used for software interchange; or,
5232   b) Accompany it with a written offer, valid for at least three years, to
5233   give any third party, for a charge no more than your cost of physically
5234   performing source distribution, a complete machine-readable copy of the
5235   corresponding source code, to be distributed under the terms of Sections 1
5236   and 2 above on a medium customarily used for software interchange; or,
5238   c) Accompany it with the information you received as to the offer to
5239   distribute corresponding source code. (This alternative is allowed only for
5240   noncommercial distribution and only if you received the program in object
5241   code or executable form with such an offer, in accord with Subsection b
5242   above.)
5244   The source code for a work means the preferred form of the work for making
5245   modifications to it. For an executable work, complete source code means all
5246   the source code for all modules it contains, plus any associated interface
5247   definition files, plus the scripts used to control compilation and
5248   installation of the executable. However, as a special exception, the source
5249   code distributed need not include anything that is normally distributed (in
5250   either source or binary form) with the major components (compiler, kernel,
5251   and so on) of the operating system on which the executable runs, unless that
5252   component itself accompanies the executable.
5254   If distribution of executable or object code is made by offering access to
5255   copy from a designated place, then offering equivalent access to copy the
5256   source code from the same place counts as distribution of the source code,
5257   even though third parties are not compelled to copy the source along with the
5258   object code.
5260   4. You may not copy, modify, sublicense, or distribute the Program except as
5261   expressly provided under this License. Any attempt otherwise to copy, modify,
5262   sublicense or distribute the Program is void, and will automatically
5263   terminate your rights under this License. However, parties who have received
5264   copies, or rights, from you under this License will not have their licenses
5265   terminated so long as such parties remain in full compliance.
5267   5. You are not required to accept this License, since you have not signed it.
5268   However, nothing else grants you permission to modify or distribute the
5269   Program or its derivative works. These actions are prohibited by law if you
5270   do not accept this License. Therefore, by modifying or distributing the
5271   Program (or any work based on the Program), you indicate your acceptance of
5272   this License to do so, and all its terms and conditions for copying,
5273   distributing or modifying the Program or works based on it.
5275   6. Each time you redistribute the Program (or any work based on the Program),
5276   the recipient automatically receives a license from the original licensor to
5277   copy, distribute or modify the Program subject to these terms and conditions.
5278   You may not impose any further restrictions on the recipients' exercise of
5279   the rights granted herein. You are not responsible for enforcing compliance
5280   by third parties to this License.
5282   7. If, as a consequence of a court judgment or allegation of patent
5283   infringement or for any other reason (not limited to patent issues),
5284   conditions are imposed on you (whether by court order, agreement or
5285   otherwise) that contradict the conditions of this License, they do not excuse
5286   you from the conditions of this License. If you cannot distribute so as to
5287   satisfy simultaneously your obligations under this License and any other
5288   pertinent obligations, then as a consequence you may not distribute the
5289   Program at all. For example, if a patent license would not permit
5290   royalty-free redistribution of the Program by all those who receive copies
5291   directly or indirectly through you, then the only way you could satisfy both
5292   it and this License would be to refrain entirely from distribution of the
5293   Program.
5295   If any portion of this section is held invalid or unenforceable under any
5296   particular circumstance, the balance of the section is intended to apply and
5297   the section as a whole is intended to apply in other circumstances.
5299   It is not the purpose of this section to induce you to infringe any patents
5300   or other property right claims or to contest validity of any such claims;
5301   this section has the sole purpose of protecting the integrity of the free
5302   software distribution system, which is implemented by public license
5303   practices. Many people have made generous contributions to the wide range of
5304   software distributed through that system in reliance on consistent
5305   application of that system; it is up to the author/donor to decide if he or
5306   she is willing to distribute software through any other system and a licensee
5307   cannot impose that choice.
5309   This section is intended to make thoroughly clear what is believed to be a
5310   consequence of the rest of this License.
5312   8. If the distribution and/or use of the Program is restricted in certain
5313   countries either by patents or by copyrighted interfaces, the original
5314   copyright holder who places the Program under this License may add an
5315   explicit geographical distribution limitation excluding those countries, so
5316   that distribution is permitted only in or among countries not thus excluded.
5317   In such case, this License incorporates the limitation as if written in the
5318   body of this License.
5320   9. The Free Software Foundation may publish revised and/or new versions of
5321   the General Public License from time to time. Such new versions will be
5322   similar in spirit to the present version, but may differ in detail to address
5323   new problems or concerns.
5325   Each version is given a distinguishing version number. If the Program
5326   specifies a version number of this License which applies to it and "any later
5327   version", you have the option of following the terms and conditions either of
5328   that version or of any later version published by the Free Software
5329   Foundation. If the Program does not specify a version number of this License,
5330   you may choose any version ever published by the Free Software Foundation.
5332   10. If you wish to incorporate parts of the Program into other free programs
5333   whose distribution conditions are different, write to the author to ask for
5334   permission. For software which is copyrighted by the Free Software
5335   Foundation, write to the Free Software Foundation; we sometimes make
5336   exceptions for this. Our decision will be guided by the two goals of
5337   preserving the free status of all derivatives of our free software and of
5338   promoting the sharing and reuse of software generally.
5340   **NO WARRANTY**
5342   11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR
5343   THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE
5344   STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE
5345   PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED,
5346   INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
5347   FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND
5348   PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE,
5349   YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
5351   12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
5352   WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
5353   REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
5354   INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
5355   OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO
5356   LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR
5357   THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
5358   PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
5359   POSSIBILITY OF SUCH DAMAGES.
5361   END OF TERMS AND CONDITIONS
5362    ----------------------------------------------------------------------
5364 Mailing Lists
5365 -------------
5367   There are two separate mailing lists for nedit users, and one for developers.
5368   Users may post to the developer mailing list to report defects and communicate
5369   with the nedit developers.  Remember that nedit is entirely a volunteer
5370   effort, so please ask questions first to the discussion list, and do your
5371   share to answer other users questions as well.
5373     discuss@@nedit.org_
5374     
5375   General discussion, questions and answers among NEdit users and developers.
5377     announce@@nedit.org_
5379   A low-volume mailing list for announcing new versions.
5381     develop@@nedit.org_
5383   Communication among and with NEdit developers.  
5384   Developers should also subscribe to the discuss list.
5386   To subscribe, send mail to one of the following addresses:
5388     announce-request@@nedit.org_
5389     discuss-request@@nedit.org_
5390     develop-request@@nedit.org_
5392   with the body consisting of the single word
5394     subscribe
5395    ----------------------------------------------------------------------
5397 Problems/Defects
5398 ----------------
5400 3>Solutions to Common Problems
5402   For a much more comprehensive list of common problems and solutions, see the
5403   NEdit FAQ.  The latest version of the FAQ can always be found on the NEdit
5404   web site at:
5406       http://www.nedit.org_.
5408   **P: No files are shown in the "Files" list in the Open... dialog.**
5410   S: When you use the "Filter" field, include the file specification or a
5411   complete directory specification, including the trailing "/" on Unix.  
5412   (See Help in the Open... dialog).
5414   **P: Find Again and Replace Again don't continue in the same direction as the original Find or Replace.**
5416   S: Find Again and Replace Again don't use the direction of the original
5417   search.  The Shift key controls the direction: Ctrl+G means forward,
5418   Shift+Ctrl+G means backward.
5420   **P: Preferences specified in the Preferences menu don't seem to get saved when I select Save Defaults.**
5422   S: NEdit has two kinds of preferences: 1) per-window preferences, in the
5423   Preferences menu, and 2) default settings for preferences in newly created
5424   windows, in the Default Settings sub-menu of the Preferences menu. 
5425   Per-window preferences are not saved by Save Defaults, only Default
5426   Settings.
5428   **P: Columns and indentation don't line up.**
5430   S: NEdit is using a proportional width font.  Set the font to a fixed style
5431   (see Preferences menu).
5433   **P: NEdit performs poorly on very large files.**
5435   S: Turn off Incremental Backup.  With Incremental Backup on, NEdit
5436   periodically writes a full copy of the file to disk.
5438   **P: Commands added to the Shell Commands menu (Unix only) don't output anything until they are finished executing.**
5440   S: If the command output is directed to a dialog, or the input is from a
5441   selection, output is collected together and held until the command
5442   completes.  De-select both of the options and the output will be shown
5443   incrementally as the command executes.
5445   **P: Dialogs don't automatically get keyboard focus when they pop up.**
5447   S: Most X Window managers allow you to choose between two categories of
5448   keyboard focus models: pointer focus, and explicit focus.  Pointer focus
5449   means that as you move the mouse around the screen, the window under the
5450   mouse automatically gets the keyboard focus.  NEdit users who use this
5451   focus model should set "Popups Under Pointer" in the Default Settings sub
5452   menu of the preferences menu in NEdit.  Users with the explicit focus
5453   model, in some cases, may have problems with certain dialogs, such as Find
5454   and Replace.  In MWM this is caused by the mwm resource startupKeyFocus
5455   being set to False (generally a bad choice for explicit focus users). 
5456   NCDwm users should use the focus model "click" instead of "explicit",
5457   again, unless you have set it that way to correct specific problems, this
5458   is the appropriate setting for most explicit focus users.
5460   **P: The Backspace key doesn't work, or deletes forward rather than backward.**
5462   S: While this is an X/Motif binding problem, and should be solved outside of
5463   NEdit in the Motif virtual binding layer (or possibly xmodmap or
5464   translations), NEdit provides an out.  If you set the resource:
5465   nedit.remapDeleteKey to True, NEdit will forcibly map the delete key to
5466   backspace.  The default setting of this resource recently changed, so
5467   users who have been depending on this remapping will now have to set it
5468   explicitly (or fix their bindings).
5470   **P: NEdit crashes when I try to paste text in to a text field in a dialog (like Find or Replace) on my SunOS system.**
5472   S: On many SunOS systems, you have to set up an nls directory before various
5473   inter-client communication features of Motif will function properly. 
5474   There are instructions in README.sun in /pub/v5_0_2/individual/README.sun on 
5475   ftp.nedit.org, as well as a tar file containing a complete nls 
5476   directory: ftp://ftp.nedit.org/pub/v5_0_2/nls.tar. 
5477   README.sun contains directions for setting up an nls directory, which
5478   is required by Motif for handling copy and paste to Motif text fields. 
5480 3>Known Defects
5482   Below is the list of known defects which affect NEdit. The defects your copy
5483   of NEdit will exhibit depend on which system you are running and with which
5484   Motif libraries it was built. Note that there are now Motif 1.2 and/or 2.0
5485   libraries available on ALL supported platforms, and as you can see below
5486   there are far fewer defects in Motif 1.2, so it is in your best interest to
5487   upgrade your system.
5489 4>All Versions
5491 **DEFECT**
5492   Operations between rectangular selections on overlapping lines do nothing.
5493   
5494 ~Work Around~
5495   None.  These operations are very complicated and rarely used.
5497 **DEFECT**
5498   Cut and Paste menu items fail, or possibly crash, 
5499   for very large (multi-megabyte) selections.
5500   
5501 ~Work Around~
5502   Use selection copy (middle mouse button click) 
5503   for transferring larger quantities of data. 
5504   Cut and Paste save the copied text in server 
5505   memory, which is usually limited.
5507 3>Reporting Defects
5509   Submit bugs through the web at:
5510   
5511     http://sf.net/tracker/?func=add&group_id=11005&atid=111005
5513   Please include the first few lines from Help > Version, which identifies
5514   NEdit's version and other system attributes important for diagnosing your
5515   problem.
5516   
5517   The NEdit developers subscribe to both discuss@@nedit.org and
5518   develop@@nedit.org, either of which may be used for reporting defects.  If
5519   you're not sure, or you think the report might be of interest to the general
5520   NEdit user community, send the report to discuss@@nedit.org_.  If it's
5521   something obvious and boring, like we misspelled "anemometer" in the on-line
5522   help, send it to develop@@nedit.org_.  If you don't want to subscribe to the
5523   Mailing_Lists_, please add a note to your mail about cc'ing you on responses.
5525   $$
5527 .. Hyperlinks for this document  ==============================================
5529 .. _discuss@@nedit.org   mailto:discuss@@nedit.org
5530 .. _announce@@nedit.org  mailto:announce@@nedit.org
5531 .. _develop@@nedit.org   mailto:develop@@nedit.org
5532 .. _discuss-request@@nedit.org   mailto:discuss-request@@nedit.org
5533 .. _announce-request@@nedit.org  mailto:announce-request@@nedit.org
5534 .. _develop-request@@nedit.org   mailto:develop-request@@nedit.org
5535 .. _http://www.nedit.org http://www.nedit.org
5536 .. _ctag_support         #ctags
5537 .. _Alternation          #alternation
5539 .. =============================================================================
5541 .. Below is what is used to guide the generation of 'C'-Motif menus.
5542 .. Indentation is SIGNIFICANT in the "Menu" directive lines below. It
5543 .. is used to determine under which menu element another item will belong.
5544 .. The number of spaces indented is not significant, but items to be placed
5545 .. in the same menu panel MUST line up at the same indent level.
5546 .. ALL nodes of this menu "tree" should have help name qualifiers.
5547 .. These are used to produce the internal lists used by NEdit help code.
5549 .. By default, the first character of the menu element will be used as a
5550 .. menu mneumonic key. To use another character in the menu element for this
5551 .. purpose, surround the character with underscores (eg. I w_a_nt 'a').
5553 .. The menu title MUST match the one found in the actual help text (sans
5554 .. special mneumonic key character marking). The help text title may include
5555 .. underlines (for spaces) when it is a hyperlink target.
5557 .. The Help-name is used to generate various data structure names. For
5558 .. instance, the 'start' help name will be used to generate the HelpTopic
5559 .. enumeration value HELP_START and the character array htxt_start which
5560 .. holds the actual help text used in the menu dialogs. Consequently, these
5561 .. names need to be unique and contain only the characters that a 'C'
5562 .. compiler can digest.
5564 .. Menu separator lines use a dash (-) character for the Menu Title. They
5565 .. should also have a unique Help-name.
5567 .. A numerical value following the Help-name (separated from the name by
5568 .. a comma and/or spaces) is part of a menu element hiding scheme implemented
5569 .. in buildHelpMenu (found in 'menu.c'). When the number matches the hideIt
5570 .. value found in the procedure, that element will effectively become invisible.
5571 .. This mechanism was created for particular menu features that are not
5572 .. available to all incarnations of NEdit (in this case, the VMS version).
5574 .. A "Help" directive is used for all other text used as NEdit help, but
5575 .. does not show up in the Help menu.
5577 ..       Menu Title                         # Help-name
5578 .. ------------------------------------------------------------
5579 .. Menu: Getting Started                    # start
5580 .. Menu: Basic Operation                    # basicOp
5581 .. Menu:   Selecting Text                   # select
5582 .. Menu:   Finding and Replacing Text       # search
5583 .. Menu:   Cut and Paste                    # clipboard
5584 .. Menu:   Using the Mouse                  # mouse
5585 .. Menu:   Keyboard Shortcuts               # keyboard
5586 .. Menu:   S_h_ifting and Filling           # fill
5587 .. Menu:   Tabbed Editing                   # interface
5588 .. Menu:   F_i_le Format                    # format
5590 .. Menu: Features for Programming           # features
5591 .. Menu:   Programming with NEdit           # programmer
5592 .. Menu:   Tabs/Emulated Tabs               # tabs
5593 .. Menu:   Auto/Smart Indent                # indent
5594 .. Menu:   Syntax Highlighting              # syntax
5595 .. Menu:   Finding Declarations (ctags)     # tags
5596 .. Menu:   Calltips                         # calltips
5598 .. Menu: Regular Expressions                # regex
5599 .. Menu:   Basic Regular Expression Syntax  # basicSyntax
5600 .. Menu:   Metacharacters                   # escapeSequences
5601 .. Menu:   Parenthetical Constructs         # parenConstructs
5602 .. Menu:   Advanced Topics                  # advancedTopics
5603 .. Menu:   Example Regular Expressions      # examples
5605 .. Menu: Macro/Shell Extensions             # extensions
5606 .. Menu:   Shell Commands and Filters       # shell, 1
5607 .. Menu:   Learn/Replay                     # learn
5608 .. Menu:   Macro Language                   # macro_lang
5609 .. Menu:   M_a_cro Subroutines              # macro_subrs
5610 .. Menu:   Range Sets                       # rangeset
5611 .. Menu:   Highlighting Information         # hiliteInfo
5612 .. Menu:   Action Routines                  # actions
5614 .. Menu: Customizing                        # customizing
5615 .. Menu:   Customizing NEdit                # customize
5616 .. Menu:   Preferences                      # preferences
5617 .. Menu:   X Resources                      # resources
5618 .. Menu:   Key Binding                      # binding
5619 .. Menu:   Highlighting Patterns            # patterns
5620 .. Menu:   Smart Indent Macros              # smart_indent
5622 .. Menu: NEdit Command Line                 # command_line
5623 .. Menu: Client/Server Mode                 # server
5624 .. Menu: Cr_a_sh Recovery                   # recovery
5625 .. Menu: ---------------------------------- # separator1
5626 .. Menu: Version                            # version
5627 .. Menu: GNU General Public License         # distribution
5628 .. Menu: Mailing _L_ists                    # mailing_list
5629 .. Menu: Problems/Defects                   # defects
5630 .. ------------------------------------------------------------
5631 .. Help: Tabs Dialog                        # tabs_dialog
5632 .. Help: Customize Window Title Dialog      # custom_title_dialog