1 .. $Id: help.etx,v 1.38 2003/01/02 01:48:29 yooden Exp $
2 .. NOTE: Remember to supply 'version' variable on setext command line.
3 .. For example, setext -m -v "version=NEdit Version 6.0".
5 .. The following are variable definitions for the various titles below
6 .. ----------------------------------------------------------------------------
7 .. |>title=Nirvana Editor (NEdit) Help Documentation<|
8 .. |>ttlMk==========================================<|
9 .. ----------------------------------------------------------------------------
24 .. .. This table of contents is only for the HTML version of this document.
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 File_Format_ Action_Routines_
40 Features for Programming Customizing_NEdit_
41 Programming_with_NEdit_ Preferences_
42 Tabs/Emulated_Tabs_ X_Resources_
43 Auto/Smart_Indent_ Key_Binding_
44 Syntax_Highlighting_ Highlighting_Patterns_
45 Finding_Declarations_(ctags)_ Smart_Indent_Macros_
48 Regular Expressions NEdit_Command_Line_
49 Basic_Regular_Expression_Syntax_ Client/Server_Mode_
50 Metacharacters_ Crash_Recovery_
51 Parenthetical_Constructs_ Version_
52 Advanced_Topics_ Distribution_Policy_
53 Example_Regular_Expressions_ Mailing_Lists_
62 .. .. What appears below will always print whether or not NEDITDOC is defined.
65 NEdit is a standard GUI (Graphical User Interface) style text editor for
66 programs and plain-text files. Users of Macintosh and MS Windows based text
67 editors should find NEdit a familiar and comfortable environment. NEdit
68 provides all of the standard menu, dialog, editing, and mouse support, as
69 well as all of the standard shortcuts to which the users of modern GUI based
70 environments are accustomed. For users of older style Unix editors, welcome
71 to the world of mouse-based editing!
74 .. NEdit is freely distributed under the terms of the Gnu General Public
77 .. .. This stuff will always be invisible, unless NEDITDOC is defined
82 .. NEdit is a single stand-alone executable file which can be installed by simply
83 .. copying the appropriate executable "nedit" for your system. Both sources and
84 .. executables are available from http://www.nedit.org. The optional "nc" (NEdit
85 .. Client) program is also available for users who want to run nedit in
86 .. client/server mode.
92 Help sections of interest to new users are listed under the "Basic Operation"
93 heading in the top-level Help menu:
96 * Finding_and_Replacing_Text_
100 * Shifting_and_Filling_
102 Programmers should also read the introductory section under the "Features for
103 Programming" section:
105 Programming_with_NEdit_
107 If you get into trouble, the Undo command in the Edit menu can reverse any
108 modifications that you make. NEdit does not change the file you are editing
109 until you tell it to Save.
111 3>Editing an Existing File
113 To open an existing file, choose Open... from the file menu. Select the file
114 that you want to open in the pop-up dialog that appears and click on OK. You
115 may open any number of files at the same time. Each file will appear in its
116 own editor window. Using Open... rather than re-typing the NEdit command and
117 running additional copies of NEdit, will give you quick access to all of the
118 files you have open via the Windows menu, and ensure that you don't
119 accidentally open the same file twice. NEdit has no "main" window. It
120 remains running as long as at least one editor window is open.
122 3>Creating a New File
124 If you already have an empty (Untitled) window displayed, just begin typing
125 in the window. To create a new Untitled window, choose New from the File
126 menu. To give the file a name and save its contents to the disk, choose Save
127 or Save As... from the File menu.
131 NEdit maintains periodic backups of the file you are editing so that you can
132 recover the file in the event of a problem such as a system crash, network
133 failure, or X server crash. These files are saved under the name `~filename`
134 (on Unix) or `_filename` (on VMS), where filename is the name of the file you
135 were editing. If an NEdit process is killed, some of these backup files may
136 remain in your directory. (To remove one of these files on Unix, you may
137 have to prefix the `~' (tilde) character with a (backslash) to prevent the
138 shell from interpreting it as a special character.)
142 As you become more familiar with NEdit, substitute the control and function
143 keys shown on the right side of the menus for pulling down menus with the
146 Dialogs are also streamlined so you can enter information quickly and without
147 using the mouse*. To move the keyboard focus around a dialog, use the tab
148 and arrow keys. One of the buttons in a dialog is usually drawn with a
149 thick, indented, outline. This button can be activated by pressing Return or
150 Enter. The Cancel or Dismiss button can be activated by pressing escape.
151 For example, to replace the string "thing" with "things" type:
153 <ctrl-r>thing<tab>things<return>
155 To open a file named "whole_earth.c", type:
159 (how much of the filename you need to type depends on the other files in the
160 directory). See the section called "Keyboard_Shortcuts_" for more details.
162 * Users who have set their keyboard focus mode to "pointer" should set
163 "Popups Under Pointer" in the Default Settings menu to avoid the additional
164 step of moving the mouse into the dialog.
165 ----------------------------------------------------------------------
173 NEdit has two general types of selections, primary (highlighted text), and
174 secondary (underlined text). Selections can cover either a simple range of
175 text between two points in the file, or they can cover a rectangular area of
176 the file. Rectangular selections are only useful with non-proportional (fixed
179 To select text for copying, deleting, or replacing, press the left mouse
180 button with the pointer at one end of the text you want to select, and drag
181 it to the other end. The text will become highlighted. To select a whole
182 word, double click (click twice quickly in succession). Double clicking and
183 then dragging the mouse will select a number of words. Similarly, you can
184 select a whole line or a number of lines by triple clicking or triple
185 clicking and dragging. Quadruple clicking selects the whole file. After
186 releasing the mouse button, you can still adjust a selection by holding down
187 the shift key and dragging on either end of the selection. To delete the
188 selected text, press delete or backspace. To replace it, begin typing.
190 To select a rectangle or column of text, hold the Ctrl key while dragging the
191 mouse. Rectangular selections can be used in any context that normal
192 selections can be used, including cutting and pasting, filling, shifting,
193 dragging, and searching. Operations on rectangular selections automatically
194 fill in tabs and spaces to maintain alignment of text within and to the right
195 of the selection. Note that the interpretation of rectangular selections by
196 Fill Paragraph is slightly different from that of other commands, the section
197 titled "Shifting_and_Filling_" has details.
199 The middle mouse button can be used to make an additional selection (called
200 the secondary selection). As soon as the button is released, the contents of
201 this selection will be copied to the insert position of the window where the
202 mouse was last clicked (the destination window). This position is marked by a
203 caret shaped cursor when the mouse is outside of the destination window. If
204 there is a (primary) selection, adjacent to the cursor in the window, the new
205 text will replace the selected text. Holding the shift key while making the
206 secondary selection will move the text, deleting it at the site of the
207 secondary selection, rather than copying it.
209 Selected text can also be dragged to a new location in the file using the
210 middle mouse button. Holding the shift key while dragging the text will copy
211 the selected text, leaving the original text in place. Holding the control
212 key will drag the text in overlay mode.
214 Normally, dragging moves text by removing it from the selected position at
215 the start of the drag, and inserting it at a new position relative to to the
216 mouse. Dragging a block of text over existing characters, displaces the
217 characters to the end of the selection. In overlay mode, characters which are
218 occluded by blocks of text being dragged are simply removed. When dragging
219 non-rectangular selections, overlay mode also converts the selection to
220 rectangular form, allowing it to be dragged outside of the bounds of the
223 The section "Using_the_Mouse_" sumarizes the mouse commands for making primary
224 and secondary selections. Primary selections can also be made via keyboard
225 commands, see "Keyboard_Shortcuts_".
226 ----------------------------------------------------------------------
228 Finding and Replacing Text
229 --------------------------
231 The Search menu contains a number of commands for finding and replacing text.
233 The Find... and Replace... commands present dialogs for entering text for
234 searching and replacing. These dialogs also allow you to choose whether you
235 want the search to be sensitive to upper and lower case, or whether to use
236 the standard Unix pattern matching characters (regular expressions).
237 Searches begin at the current text insertion position.
239 Find Again and Replace Again repeat the last find or replace command without
240 prompting for search strings. To selectively replace text, use the two
241 commands in combination: Find Again, then Replace Again if the highlighted
242 string should be replaced, or Find Again again to go to the next string.
244 Find Selection searches for the text contained in the current primary
245 selection (see Selecting_Text_). The selected text does not have to be in the
246 current editor window, it may even be in another program. For example, if
247 the word dog appears somewhere in a window on your screen, and you want to
248 find it in the file you are editing, select the word dog by dragging the
249 mouse across it, switch to your NEdit window and choose Find Selection from
252 Find Incremental is yet another variation on searching, where every character
253 typed triggers a new search. Incremental searching is generally the quickest
254 way to find something in a file, because it gives you the immediate feedback
255 of seeing how your search is progressing, so you never need to type more than
256 the minimally sufficient search string to reach your target.
258 3>Searching Backwards
260 Holding down the shift key while choosing any of the search or replace
261 commands from the menu (or using the keyboard shortcut), will search in the
262 reverse direction. Users who have set the search direction using the buttons
263 in the search dialog, may find it a bit confusing that Find Again and Replace
264 Again don't continue in the same direction as the original search (for
265 experienced users, consistency of the direction implied by the shift key is
268 3>Selective Replacement
270 To replace only some occurrences of a string within a file, choose Replace...
271 from the Search menu, enter the string to search for and the string to
272 substitute, and finish by pressing the Find button. When the first
273 occurrence is highlighted, use either Replace Again (^T) to replace it, or
274 Find Again (^G) to move to the next occurrence without replacing it, and
275 continue in such a manner through all occurrences of interest.
277 To replace all occurrences of a string within some range of text, select the
278 range (see Selecting_Text_), choose Replace... from the Search menu, type the
279 string to search for and the string to substitute, and press the "R. in
280 Selection" button in the dialog. Note that selecting text in the Replace...
281 dialog will unselect the text in the window.
282 ----------------------------------------------------------------------
287 The easiest way to copy and move text around in your file or between windows,
288 is to use the clipboard, an imaginary area that temporarily stores text and
289 data. The Cut command removes the selected text (see Selecting_Text_) from
290 your file and places it in the clipboard. Once text is in the clipboard, the
291 Paste command will copy it to the insert position in the current window. For
292 example, to move some text from one place to another, select it by dragging
293 the mouse over it, choose Cut to remove it, click the pointer to move the
294 insert point where you want the text inserted, then choose Paste to insert
295 it. Copy copies text to the clipboard without deleting it from your file.
296 You can also use the clipboard to transfer text to and from other Motif
297 programs and X programs which make proper use of the clipboard.
299 There are many other methods for copying and moving text within NEdit windows
300 and between NEdit and other programs. The most common such method is
301 clicking the middle mouse button to copy the primary selection (to the
302 clicked position). Copying the selection by clicking the middle mouse button
303 in many cases is the only way to transfer data to and from many X programs.
304 Holding the Shift key while clicking the middle mouse button moves the text,
305 deleting it from its original position, rather than copying it. Other
306 methods for transferring text include secondary selections, primary selection
307 dragging, keyboard-based selection copying, and drag and drop. These are
308 described in detail in the sections: "Selecting_Text_", "Using_the_Mouse_",
309 and "Keyboard_Shortcuts_".
310 ----------------------------------------------------------------------
315 Mouse-based editing is what NEdit is all about, and learning to use the more
316 advanced features like secondary selections and primary selection dragging
317 will be well worth your while.
319 If you don't have time to learn everything, you can get by adequately with
320 just the left mouse button: Clicking the left button moves the cursor.
321 Dragging with the left button makes a selection. Holding the shift key while
322 clicking extends the existing selection, or begins a selection between the
323 cursor and the mouse. Double or triple clicking selects a whole word or a
326 This section will make more sense if you also read the section called,
327 "Selecting_Text_", which explains the terminology of selections, that is,
328 what is meant by primary, secondary, rectangular, etc.
331 3>Button and Modifier Key Summary
333 General meaning of mouse buttons and modifier keys:
337 Button 1 (left) Cursor position and primary selection
339 Button 2 (middle) Secondary selections, and dragging and
340 copying the primary selection
342 Button 3 (right) Quick-access programmable menu and pan
347 Shift On primary selections, (left mouse button):
348 Extends selection to the mouse pointer
349 On secondary and copy operations, (middle):
350 Toggles between move and copy
352 Ctrl Makes selection rectangular or insertion
355 Alt* (on release) Exchange primary and secondary
361 The left mouse button is used to position the cursor and to make primary
364 Click Moves the cursor
366 Double Click Selects a whole word
368 Triple Click Selects a whole line
370 Quad Click Selects the whole file
372 Shift Click Adjusts (extends or shrinks) the
373 selection, or if there is no existing
374 selection, begins a new selection
375 between the cursor and the mouse.
377 Ctrl+Shift+ Adjusts (extends or shrinks) the
378 Click selection rectangularly.
380 Drag Selects text between where the mouse
381 was pressed and where it was released.
383 Ctrl+Drag Selects rectangle between where the
384 mouse was pressed and where it was
390 The right mouse button posts a programmable menu for frequently used commands.
392 Click/Drag Pops up the background menu (programmed
393 from Preferences -> Default Settings ->
394 Customize Menus -> Window Background).
396 Ctrl+Drag Pan scrolling. Scrolls the window
397 both vertically and horizontally, as if
398 you had grabbed it with your mouse.
401 3>Middle Mouse Button
403 The middle mouse button is for making secondary selections, and copying and
404 dragging the primary selection.
406 Click Copies the primary selection to the
409 Shift+Click Moves the primary selection to the
410 clicked position, deleting it from its
413 Drag 1) Outside of the primary selection:
414 Begins a secondary selection.
415 2) Inside of the primary selection:
416 Moves the selection by dragging.
418 Ctrl+Drag 1) Outside of the primary selection:
419 Begins a rectangular secondary
421 2) Inside of the primary selection:
422 Drags the selection in overlay
425 When the mouse button is released after creating a secondary selection:
427 No Modifiers If there is a primary selection,
428 replaces it with the secondary
429 selection. Otherwise, inserts the
430 secondary selection at the cursor
433 Shift Move the secondary selection, deleting
434 it from its original position. If
435 there is a primary selection, the move
436 will replace the primary selection
437 with the secondary selection.
438 Otherwise, moves the secondary
439 selection to to the cursor position.
441 Alt* Exchange the primary and secondary
445 While moving the primary selection by dragging with the middle mouse button:
447 Shift Leaves a copy of the original
448 selection in place rather than
449 removing it or blanking the area.
451 Ctrl Changes from insert mode to overlay
454 Escape Cancels drag in progress.
456 Overlay Mode: Normally, dragging moves text by removing it from the selected
457 position at the start of the drag, and inserting it at a new position
458 relative to to the mouse. When you drag a block of text over existing
459 characters, the existing characters are displaced to the end of the
460 selection. In overlay mode, characters which are occluded by blocks of text
461 being dragged are simply removed. When dragging non-rectangular selections,
462 overlay mode also converts the selection to rectangular form, allowing it to
463 be dragged outside of the bounds of the existing text.
465 Mouse buttons 4 and 5 are usually represented by a mouse wheel nowadays.
466 They are used to scroll up or down in the text window.
468 * The Alt key may be labeled Meta or Compose-Character on some keyboards.
469 Some window managers, including default configurations of mwm, bind
470 combinations of the Alt key and mouse buttons to window manager operations.
471 In NEdit, Alt is only used on button release, so regardless of the window
472 manager bindings for Alt-modified mouse buttons, you can still do the
473 corresponding NEdit operation by using the Alt key AFTER the initial mouse
474 press, so that Alt is held while you release the mouse button. If you find
475 this difficult or annoying, you can re-configure most window managers to skip
476 this binding, or you can re-configure NEdit to use a different key
478 ----------------------------------------------------------------------
483 Most of the keyboard shortcuts in NEdit are shown on the right hand sides of
484 the pull-down menus. However, there are more which are not as obvious. These
485 include; dialog button shortcuts; menu and dialog mnemonics; labeled keyboard
486 keys, such as the arrows, page-up, page-down, and home; and optional Shift
487 modifiers on accelerator keys, like [Shift]Ctrl+F.
492 Pressing the key combinations shown on the right of the menu items is a
493 shortcut for selecting the menu item with the mouse. Some items have the shift
494 key enclosed in brackets, such as [Shift]Ctrl+F. This indicates that the shift
495 key is optional. In search commands, including the shift key reverses the
496 direction of the search. In Shift commands, it makes the command shift the
497 selected text by a whole tab stop rather than by single characters.
502 Pressing the Alt key in combination with one of the underlined characters in
503 the menu bar pulls down that menu. Once the menu is pulled down, typing the
504 underlined characters in a menu item (without the Alt key) activates that
505 item. With a menu pulled down, you can also use the arrow keys to select menu
506 items, and the Space or Enter keys to activate them.
509 3>Keyboard Shortcuts within Dialogs
511 One button in a dialog is usually marked with a thick indented outline.
512 Pressing the Return or Enter key activates this button.
514 All dialogs have either a Cancel or Dismiss button. This button can be
515 activated by pressing the Escape (or Esc) key.
517 Pressing the tab key moves the keyboard focus to the next item in a dialog.
518 Within an associated group of buttons, the arrow keys move the focus among the
519 buttons. Shift+Tab moves backward through the items.
521 Most items in dialogs have an underline under one character in their name.
522 Pressing the Alt key along with this character, activates a button as if you
523 had pressed it with the mouse, or moves the keyboard focus to the associated
526 You can select items from a list by using the arrow keys to move the
527 selection and space to select.
529 In file selection dialogs, you can type the beginning characters of the file
530 name or directory in the list to select files
533 3>Labeled Function Keys
535 The labeled function keys on standard workstation and PC keyboards, like the
536 arrows, and page-up and page-down, are active in NEdit, though not shown in the
539 Holding down the control key while pressing a named key extends the scope of
540 the action that it performs. For example, Home normally moves the insert
541 cursor the beginning of a line. Ctrl+Home moves it to the beginning of the
542 file. Backspace deletes one character, Ctrl+Backspace deletes one word.
544 Holding down the shift key while pressing a named key begins or extends a
545 selection. Combining the shift and control keys combines their actions. For
546 example, to select a word without using the mouse, position the cursor at the
547 beginning of the word and press Ctrl+Shift+RightArrow. The Alt key modifies
548 selection commands to make the selection rectangular.
550 Under X and Motif, there are several levels of translation between keyboard
551 keys and the actions they perform in a program. The "Customizing_NEdit_", and
552 "X_Resources_" sections of the Help menu have more information on this subject.
553 Because of all of this configurability, and since keyboards and standards for
554 the meaning of some keys vary from machine to machine, the mappings may be
555 changed from the defaults listed below.
557 3>Modifier Keys (in general)
559 Ctrl Extends the scope of the action that the key
560 would otherwise perform. For example, Home
561 normally moves the insert cursor to the beginning
562 of a line. Ctrl+Home moves it to the beginning of
563 the file. Backspace deletes one character, Ctrl+
564 Backspace deletes one word.
566 Shift Extends the selection to the cursor position. If
567 there's no selection, begins one between the old
568 and new cursor positions.
570 Alt When modifying a selection, makes the selection
573 (For the effects of modifier keys on mouse button presses, see the section
574 titled "Using_the_Mouse_")
578 Escape Cancels operation in progress: menu
579 selection, drag, selection, etc. Also
580 equivalent to cancel button in dialogs.
582 Backspace Delete the character before the cursor
584 Ctrl+BS Delete the word before the cursor
588 Left Move the cursor to the left one character
590 Ctrl+Left Move the cursor backward one word
591 (Word delimiters are settable, see
592 "Customizing_NEdit_", and "X_Resources_")
594 Right Move the cursor to the right one character
596 Ctrl+Right Move the cursor forward one word
598 Up Move the cursor up one line
600 Ctrl+Up Move the cursor up one paragraph.
601 (Paragraphs are delimited by blank lines)
603 Down Move the cursor down one line.
605 Ctrl+Down Move the cursor down one paragraph.
607 Ctrl+Return Return with automatic indent, regardless
608 of the setting of Auto Indent.
610 Shift+Return Return without automatic indent,
611 regardless of the setting of Auto Indent.
613 Ctrl+Tab Insert an ASCII tab character, without
614 processing emulated tabs.
616 Alt+Ctrl+<c> Insert the control-code equivalent of
619 Ctrl+/ Select everything (same as Select
624 Ctrl+U Delete to start of line
626 3>PC Standard Keyboard
628 Ctrl+Insert Copy the primary selection to the
629 clipboard (same as Copy menu item or ^C)
630 for compatibility with Motif standard key
633 Insert Copy the primary selection to the cursor
636 Delete Delete the character before the cursor.
637 (Can be configured to delete the character
638 after the cursor, see "Customizing_NEdit_",
641 Ctrl+Delete Delete to end of line.
643 Shift+Delete Cut, remove the currently selected text
644 and place it in the clipboard. (same as
645 Cut menu item or ^X) for compatibility
646 with Motif standard key binding
648 Delete Cut the primary selection to the cursor
651 Home Move the cursor to the beginning of the
654 Ctrl+Home Move the cursor to the beginning of the
657 End Move the cursor to the end of the line
659 Ctrl+End Move the cursor to the end of the file
661 PageUp Scroll and move the cursor up by one page.
663 Ctrl+PageUp Scroll and move the cursor left by one
665 PageDown Scroll and move the cursor down by one
668 Ctrl+PageDown Scroll and move the cursor right by one
671 F10 Make the menu bar active for keyboard
672 input (Arrow Keys, Return, Escape,
675 3>Specialty Keyboards
677 On machines with different styles of keyboards, generally, text editing
678 actions are properly matched to the labeled keys, such as Remove,
679 Next-screen, etc.. If you prefer different key bindings, see the section
680 titled "Key_Binding_" under the Customizing heading in the Help menu.
681 ----------------------------------------------------------------------
686 3>Shift Left, Shift Right
688 While shifting blocks of text is most important for programmers (See Features
689 for Programming), it is also useful for other tasks, such as creating
692 To shift a block of text one tab stop to the right, select the text, then
693 choose Shift Right from the Edit menu. Note that the accelerator keys for
694 these menu items are Ctrl+9 and Ctrl+0, which correspond to the right and
695 left parenthesis on most keyboards. Remember them as adjusting the text in
696 the direction pointed to by the parenthesis character. Holding the Shift key
697 while selecting either Shift Left or Shift Right will shift the text by one
700 It is also possible to shift blocks of text by selecting the text
701 rectangularly, and dragging it left or right (and up or down as well). Using
702 a rectangular selection also causes tabs within the selection to be
703 recalculated and substituted, such that the non-whitespace characters remain
704 stationary with respect to the selection.
709 Text filling using the Fill Paragraph command in the Edit menu is one of the
710 most important concepts in NEdit. And it will be well worth your while to
711 understand how to use it properly.
713 In plain text files, unlike word-processor files, there is no way to tell
714 which lines are continuations of other lines, and which lines are meant to be
715 separate, because there is no distinction in meaning between newline
716 characters which separate lines in a paragraph, and ones which separate
717 paragraphs from other text. This makes it impossible for a text editor like
718 NEdit to tell parts of the text which belong together as a paragraph from
719 carefully arranged individual lines.
721 In continuous wrap mode (Preferences -> Wrap -> Continuous), lines
722 automatically wrap and unwrap themselves to line up properly at the right
723 margin. In this mode, you simply omit the newlines within paragraphs and let
724 NEdit make the line breaks as needed. Unfortunately, continuous wrap mode is
725 not appropriate in the majority of situations, because files with extremely
726 long lines are not common under Unix and may not be compatible with all
727 tools, and because you can't achieve effects like indented sections, columns,
728 or program comments, and still take advantage of the automatic wrapping.
730 Without continuous wrapping, paragraph filling is not entirely automatic.
731 Auto-Newline wrapping keeps paragraphs lined up as you type, but once
732 entered, NEdit can no longer distinguish newlines which join wrapped text,
733 and newlines which must be preserved. Therefore, editing in the middle of a
734 paragraph will often leave the right margin messy and uneven.
736 Since NEdit can't act automatically to keep your text lined up, you need to
737 tell it explicitly where to operate, and that is what Fill Paragraph is for.
738 It arranges lines to fill the space between two margins, wrapping the lines
739 neatly at word boundaries. Normally, the left margin for filling is inferred
740 from the text being filled. The first line of each paragraph is considered
741 special, and its left indentation is maintained separately from the remaining
742 lines (for leading indents, bullet points, numbered paragraphs, etc.).
743 Otherwise, the left margin is determined by the furthest left non-whitespace
744 character. The right margin is either the Wrap Margin, set in the
745 preferences menu (by default, the right edge of the window), or can also be
746 chosen on the fly by using a rectangular selection (see below).
748 There are three ways to use Fill Paragraph. The simplest is, while you are
749 typing text, and there is no selection, simply select Fill Paragraph (or type
750 Ctrl+J), and NEdit will arrange the text in the paragraph adjacent to the
751 cursor. A paragraph, in this case, means an area of text delimited by blank
754 The second way to use Fill Paragraph is with a selection. If you select a
755 range of text and then chose Fill Paragraph, all of the text in the selection
756 will be filled. Again, continuous text between blank lines is interpreted as
757 paragraphs and filled individually, respecting leading indents and blank
760 The third, and most versatile, way to use Fill Paragraph is with a
761 rectangular selection. Fill Paragraph treats rectangular selections
762 differently from other commands. Instead of simply filling the text inside
763 the rectangular selection, NEdit interprets the right edge of the selection
764 as the requested wrap margin. Text to the left of the selection is not
765 disturbed (the usual interpretation of a rectangular selection), but text to
766 the right of the selection is included in the operation and is pulled in to
767 the selected region. This method enables you to fill text to an arbitrary
768 right margin, without going back and forth to the wrap-margin dialog, as well
769 as to exclude text to the left of the selection such as comment bars or other
771 ----------------------------------------------------------------------
776 While plain-text is probably the simplest and most interchangeable file
777 format in the computer world, there is still variation in what plain-text
778 means from system to system. Plain-text files can differ in character set,
779 line termination, and wrapping.
781 While character set differences are the most obvious and pose the most
782 challenge to portability, they affect NEdit only indirectly via the same font
783 and localization mechanisms common to all X applications. If your system is
784 set up properly, you will probably never see character-set related problems
785 in NEdit. NEdit can not display Unicode text files, or any multi-byte
788 The primary difference between an MS DOS format file and a Unix format file,
789 is how the lines are terminated. Unix uses a single newline character. MS
790 DOS uses a carriage-return and a newline. NEdit can read and write both file
791 formats, but internally, it uses the single character Unix standard. NEdit
792 auto-detects MS DOS format files based on the line termination at the start
793 of the file. Files are judged to be DOS format if all of the first five line
794 terminators, within a maximum range, are DOS-style. To change the format in
795 which NEdit writes a file from DOS to Unix or visa versa, use the Save As...
796 command and check or un-check the MS DOS Format button.
798 Wrapping within text files can vary among individual users, as well as from
799 system to system. Both Windows and MacOS make frequent use of plain text
800 files with no implicit right margin. In these files, wrapping is determined
801 by the tool which displays them. Files of this style also exist on Unix
802 systems, despite the fact that they are not supported by all Unix utilities.
803 To display this kind of file properly in NEdit, you have to select the wrap
804 style called Continuous. Wrapping modes are discussed in the sections:
805 Customizing -> Preferences, and Basic Operation -> Shifting and Filling.
807 The last and most minute of format differences is the terminating newline.
808 Some Unix compilers and utilities require a final terminating newline on all
809 files they read and fail in various ways on files which do not have it. Vi
810 and approximately half of Unix editors enforce the terminating newline on all
811 files that they write; Emacs does not enforce this rule. Users are divided
812 on which is best. NEdit makes the final terminating newline optional
813 (Preferences -> Default Settings -> Append Line Feed on Save).
814 ----------------------------------------------------------------------
816 Features for Programming
817 ========================
819 Programming with NEdit
820 ----------------------
822 Though general in appearance, NEdit has many features intended specifically
823 for programmers. Major programming-related topics are listed in separate
824 sections under the heading: "Features for Programming": Syntax_Highlighting_,
825 Tabs/Emulated_Tabs_, Finding_Declarations_(ctags)_, Calltips_, and
826 Auto/Smart_Indent_. Minor topics related to programming are discussed below:
830 When NEdit initially reads a file, it attempts to determine whether the file
831 is in one of the computer languages that it knows about. Knowing what language
832 a file is written in allows NEdit to assign highlight patterns and smart indent
833 macros, and to set language specific preferences like word delimiters, tab
834 emulation, and auto-indent. Language mode can be recognized from both the file
835 name and from the first 200 characters of content. Language mode recognition
836 and language-specific preferences are configured in: Preferences -> Default
837 Settings -> Language Modes....
839 You can set the language mode manually for a window, by selecting it from the
840 menu: Preferences -> Language Modes.
844 Nedit can be made to set the background color of particular classes of
845 characters to allow easy identifcation of those characters. This is
846 particularly useful if you need to be able to distiguish between tabs
847 and spaces in a file where the difference is important. The colors used
848 for backlighting are specified by a resource, "nedit*backlightCharTypes"
849 but can be changed for a particular window using the macro built-in function
850 set_backlight_string(). You can turn backlighting on and off through the
851 Preferences -> Apply Backlighting menu entry.
853 If you prefer to have backlighting turned on for all new windows, use
854 the Preferences -> Default Settings -> Backlighting -> Apply Backlighting
855 menu entry. If you wish to set the current window's backlighting settings
856 for new windows, use Preferences -> Default Settings -> Backlighting ->
857 Use Current. These settings will be saved along with other preferences
858 using Preferences -> Save Defaults.
862 To find a particular line in a source file by line number, choose Goto Line
863 #... from the Search menu. You can also directly select the line number text
864 in the compiler message in the terminal emulator window (xterm, decterm,
865 winterm, etc.) where you ran the compiler, and choose Goto Selected from the
868 To find out the line number of a particular line in your file, turn on
869 Statistics Line in the Preferences menu and position the insertion point
870 anywhere on the line. The statistics line continuously updates the line number
871 of the line containing the cursor.
873 To go to a specific column on a given line, choose Goto Line #... from the
874 Search menu and enter a line number and a column number separated by a
875 comma. (e.g. Enter "100,12" for line 100 column 12.) If you want to go to
876 a column on the current line just leave out the line number. (e.g. Enter
877 ",45" to go the column 45 on the current line.)
879 3>Matching Parentheses
881 To help you inspect nested parentheses, brackets, braces, quotes, and other
882 characters, NEdit has both an automatic parenthesis matching mode, and a Goto
883 Matching command. Automatic parenthesis matching is activated when you type,
884 or move the insertion cursor after a parenthesis, bracket, or brace. It
885 momentarily highlights either the opposite character ('Delimiter') or the
886 entire expression ('Range') when the opposite character is visible in the
887 window. To find a matching character anywhere in the file, select it or
888 position the cursor after it, and choose Goto Matching from the Search menu.
889 If the character matches itself, such as a quote or slash, select the first
890 character of the pair. NEdit will match {, (, [, <, ", ', `, /, and \.
891 Holding the Shift key while typing the accelerator key (Shift+Ctrl+M, by
892 default), will select all of the text between the matching characters.
894 When syntax highlighting is enabled, the matching routines can optionally
895 make use of the syntax information for improved accuracy. In that case,
896 a brace inside a highlighted string will not match a brace inside a comment,
899 3>Opening Included Files
901 The Open Selected command in the File menu understands the C preprocessor's
902 #include syntax, so selecting an #include line and invoking Open Selected will
903 generally find the file referred to, unless doing so depends on the settings of
904 compiler switches or other information not available to NEdit.
906 3>Interface to Programming Tools
908 Integrated software development environments such as SGI's CaseVision and
909 Centerline Software's Code Center, can be interfaced directly with NEdit via
910 the client server interface. These tools allow you to click directly on
911 compiler and runtime error messages and request NEdit to open files, and select
912 lines of interest. The easiest method is usually to use the tool's interface
913 for character-based editors like vi, to invoke nc, but programmatic interfaces
914 can also be derived using the source code for nc.
916 There are also some simple compile/review, grep, ctree, and ctags browsers
917 available in the NEdit contrib directory on ftp.nedit.org.
918 ----------------------------------------------------------------------
923 3>Changing the Tab Distance
925 Tabs are important for programming in languages which use indentation to show
926 nesting, as short-hand for producing white-space for leading indents. As a
927 programmer, you have to decide how to use indentation, and how or whether tab
928 characters map to your indentation scheme.
930 Ideally, tab characters map directly to the amount of indent that you use to
931 distinguish nesting levels in your code. Unfortunately, the Unix standard
932 for interpretation of tab characters is eight characters (probably dating
933 back to mechanical capabilities of the original teletype), which is usually
934 too coarse for a single indent.
936 Most text editors, NEdit included, allow you to change the interpretation of
937 the tab character, and many programmers take advantage of this, and set their
938 tabs to 3 or 4 characters to match their programming style. In NEdit you set
939 the hardware tab distance in Preferences -> Tabs... for the current window,
940 or Preferences -> Default Settings -> Tabs... (general), or Preferences ->
941 Default Settings -> Language Modes... (language-specific) to change the
942 defaults for future windows.
944 Changing the meaning of the tab character makes programming much easier while
945 you're in the editor, but can cause you headaches outside of the editor,
946 because there is no way to pass along the tab setting as part of a plain-text
947 file. All of the other tools which display, print, and otherwise process
948 your source code have to be made aware of how the tabs are set, and must be
949 able to handle the change. Non-standard tabs can also confuse other
950 programmers, or make editing your code difficult for them if their text
951 editors don't support changes in tab distance.
955 An alternative to changing the interpretation of the tab character is tab
956 emulation. In the Tabs... dialog(s), turning on Emulated Tabs causes the Tab
957 key to insert the correct number of spaces and/or tabs to bring the cursor
958 the next emulated tab stop, as if tabs were set at the emulated tab distance
959 rather than the hardware tab distance. Backspacing immediately after entering
960 an emulated tab will delete the fictitious tab as a unit, but as soon as you
961 move the cursor away from the spot, NEdit will forget that the collection of
962 spaces and tabs is a tab, and will treat it as separate characters. To enter
963 a real tab character with "Emulate Tabs" turned on, use Ctrl+Tab.
965 It is also possible to tell NEdit not to insert ANY tab characters at all in
966 the course of processing emulated tabs, and in shifting and rectangular
967 insertion/deletion operations, for programmers who worry about the
968 misinterpretation of tab characters on other systems.
969 ----------------------------------------------------------------------
973 .. The following Tabs Dialog and Customize Window Title Dialog sections
974 .. should only appear in the online documentation, and not in any of
975 .. the other possible forms. The rationale is that they are not directly
976 .. obtained from the Help menu, but are buried in preference dialogs.
982 .. The Tabs dialog controls both the operation of the Tab key, and
983 .. the interpretation of tab characters within a file.
985 .. The first field, Tab Spacing, controls how NEdit responds to
986 .. tab characters in a file. On most Unix and VMS systems the
987 .. conventional interpretation of a tab character is to advance the
988 .. text position to the nearest multiple of eight characters (a tab
989 .. spacing of 8). However, many programmers of C and other
990 .. structured languages, when given the choice, prefer a tab
991 .. spacing of 3 or 4 characters. Setting a three or four character
992 .. hardware tab spacing is useful and convenient as long as your
993 .. other software tools support it. Unfortunately, on Unix and VMS
994 .. systems, system utilities, such as more, and printing software
995 .. can't always properly display files with other than eight
998 .. Selecting "Emulate Tabs" will cause the Tab key to insert the
999 .. correct number of spaces or tabs to reach the next tab stop, as
1000 .. if the tab spacing were set at the value in the "Emulated tab
1001 .. spacing" field. Backspacing immediately after entering an
1002 .. emulated tab will delete it as a unit, but as soon as you move
1003 .. the cursor away from the spot, NEdit will forget that the
1004 .. collection of spaces and tabs is a tab, and will treat it as
1005 .. separate characters. To enter a real tab character with
1006 .. "Emulate Tabs" turned on, use Ctrl+Tab.
1008 .. In generating emulated tabs, and in Shift Left, Paste Column,
1009 .. and some rectangular selection operations, NEdit inserts blank
1010 .. characters (spaces or tabs) to preserve the alignment of
1011 .. non-blank characters. The bottom toggle button in the Tabs
1012 .. dialog instructs NEdit whether to insert tab characters as
1013 .. padding in such situations. Turning this off, will keep NEdit
1014 .. from automatically inserting tabs. Some software developers
1015 .. prefer to keep their source code free of tabs to avoid its
1016 .. misinterpretation on systems with different tab character
1018 .. ----------------------------------------------------------------------
1020 .. Customize Window Title Dialog
1021 .. -----------------------------
1023 .. The Customize Window Title dialog allows you to customize
1024 .. and test the way information will be displayed in each window's
1027 .. **Definition of the title**
1029 .. The upper half of the dialog can be used to select the various
1030 .. components that should be displayed in the title. The layout can be
1031 .. fine-tuned by editing the printf() like format string below the
1032 .. component buttons: additional characters can be entered, or the
1033 .. order can be changed.
1035 .. The following sequences are interpreted in the format string:
1037 .. %c ClearCase view tag (only relevant when NEdit is
1038 .. used together with ClearCase)
1039 .. %[n]d directory, with one optional numeric digit n
1040 .. specifying the maximum number of trailing directory
1041 .. components to display. Skipped components are
1042 .. replaced by an ellipsis (...).
1043 .. %f file name, without the path name
1045 .. %s NEdit server name (server mode only)
1046 .. %[*]S file status, either verbose (%S) or brief (%*S).
1047 .. In verbose mode the file status is spelled out:
1048 .. read-only, locked, and modified. In brief mode,
1049 .. abbreviations and an asterisk are used for the
1050 .. respective states: RO, LO, *.
1053 .. The format string and the component buttons are continously synchronized.
1055 .. The default format is:
1057 .. {%c} [%s] %f (%S) - %d
1059 .. The resulting title will only contain elements with
1060 .. a value. Hence, the title is compressed as follows:
1062 .. * Elements with no value are removed.
1064 .. * Empty parenthesis pairs i.e. (), [] or {}, or parenthesis
1065 .. pairs containing only space(s), are removed.
1067 .. * Sequences of spaces are replaced with one space.
1069 .. * Leading spaces and dashes are removed.
1071 .. * Trailing spaces and dashes are removed.
1073 .. If the server name and the ClearCase view tag are identical, only
1074 .. the first one specified in the format string will be displayed.
1076 .. **Previewing the settings**
1078 .. The lower part of the dialog can be used to test the selected title
1079 .. under various conditions. For some of the components that are selected
1080 .. for display, various states can be enforced on the preview.
1082 .. For instance, components that are not always active (such the
1083 .. NEdit server name) can be turned on or off in the preview.
1090 Programmers who use structured languages usually require some form of
1091 automatic indent, so that they don't have to continually re-type the
1092 sequences of tabs and/or spaces needed to maintain lengthy running indents.
1093 Version 5.0 of NEdit is the first release of NEdit to offer "smart" indent,
1094 at least experimentally, in addition to the traditional automatic indent
1095 which simply lines up the cursor position with the previous line.
1099 Smart Indent in this release must still be considered somewhat experimental.
1100 Smart indent macros are only available by default for C and C++, and while
1101 these can easily be configured for different default indentation distances,
1102 they may not conform to everyone's exact C programming style. Smart indent
1103 is programmed in terms of macros in the NEdit macro language which can be
1104 entered in: Preferences -> Default Settings -> Indent -> Program Smart
1105 Indent. Hooks are provided for intervening at the point that a newline is
1106 entered, either via the user pressing the Enter key, or through
1107 auto-wrapping; and for arbitrary type-in to act on specific characters typed.
1109 To type a newline character without invoking smart-indent when operating in
1110 smart-indent mode, hold the Shift key while pressing the Return or Enter key.
1114 With Indent set to Auto (the default), NEdit keeps a running indent. When
1115 you press the Return or Enter key, spaces and tabs are inserted to line up
1116 the insert point under the start of the previous line.
1118 Regardless of indent-mode, Ctrl+Return always does the automatic indent;
1119 Shift+Return always does a return without indent.
1121 3>Block Indentation Adjustment
1123 The Shift Left and Shift Right commands as well as rectangular dragging can
1124 be used to adjust the indentation for several lines at once. To shift a
1125 block of text one character to the right, select the text, then choose Shift
1126 Right from the Edit menu. Note that the accelerator keys for these menu
1127 items are Ctrl+9 and Ctrl+0, which correspond to the right and left
1128 parenthesis on most keyboards. Remember them as adjusting the text in the
1129 direction pointed to by the parenthesis character. Holding the Shift key
1130 while selecting either Shift Left or Shift Right will shift the text by one
1131 tab stop (or by one emulated tab stop if tab emulation is turned on). The
1132 help section "Shifting and Filling" under "Basic Operation" has details.
1133 ----------------------------------------------------------------------
1138 Syntax Highlighting means using colors and fonts to help distinguish language
1139 elements in programming languages and other types of structured files.
1140 Programmers use syntax highlighting to understand code faster and better, and
1141 to spot many kinds of syntax errors more quickly.
1143 To use syntax highlighting in NEdit, select Highlight Syntax in the
1144 Preferences menu. If NEdit recognizes the computer language that you are
1145 using, and highlighting rules (patterns) are available for that language, it
1146 will highlight your text, and maintain the highlighting, automatically, as
1149 If NEdit doesn't correctly recognize the type of the file you are editing,
1150 you can manually select a language mode from Language Modes in the
1151 Preferences menu. You can also program the method that NEdit uses to
1152 recognize language modes in Preferences -> Default Settings -> Language
1155 If no highlighting patterns are available for the language that you want to
1156 use, you can create new patterns relatively quickly. The Help section
1157 "Highlighting_Patterns_" under "Customizing", has details.
1159 If you are satisfied with what NEdit is highlighting, but would like it to
1160 use different colors or fonts, you can change these by selecting Preferences
1161 -> Default Settings -> Syntax Highlighting -> Text Drawing Styles.
1162 Highlighting patterns are connected with font and color information through a
1163 common set of styles so that colorings defined for one language will be
1164 similar across others, and patterns within the same language which are meant
1165 to appear identical can be changed in the same place. To understand which
1166 styles are used to highlight the language you are interested in, you may need
1167 to look at "Highlighting_Patterns_" section, as well.
1169 Syntax highlighting is CPU intensive, and under some circumstances can affect
1170 NEdit's responsiveness. If you have a particularly slow system, or work with
1171 very large files, you may not want to use it all of the time. Syntax
1172 highlighting introduces two kinds of delays. The first is an initial parsing
1173 delay, proportional to the size of the file. This delay is also incurred
1174 when pasting large sections of text, filtering text through shell commands,
1175 and other circumstances involving changes to large amounts of text. The
1176 second kind of delay happens when text which has not previously been visible
1177 is scrolled in to view. Depending on your system, and the highlight patterns
1178 you are using, this may or may not be noticeable. A typing delay is also
1179 possible, but unlikely if you are only using the built-in patterns.
1180 ----------------------------------------------------------------------
1182 Finding Declarations (ctags)
1183 ----------------------------
1185 NEdit can process tags files generated using the Unix _ctags command or the
1186 Exuberant Ctags program. Ctags creates index files correlating names of
1187 functions and declarations with their locations in C, Fortran, or Pascal source
1188 code files. (See the ctags manual page for more information). Ctags produces a
1189 file called "tags" which can be loaded by NEdit. NEdit can manage any number
1190 of tags files simultaneously. Tag collisions are handled with a popup menu to
1191 let the user decide which tag to use. In 'Smart' mode NEdit will automatically
1192 choose the desired tag based on the scope of the file or module. Once loaded,
1193 the information in the tags file enables NEdit to go directly to the
1194 declaration of a highlighted function or data structure name with a single
1195 command. To load a tags file, select "Load Tags File" from the File menu and
1196 choose a tags file to load, or specify the name of the tags file on the NEdit
1201 NEdit can also be set to load a tags file automatically when it starts up.
1202 Setting the X resource nedit.tagFile to the name of a tag file tells NEdit to
1203 look for that file at startup time (see "Customizing_NEdit_"). The file name
1204 can be either a complete path name, in which case NEdit will always load the
1205 same tags file, or a file name without a path or with a relative path, in
1206 which case NEdit will load it starting from the current directory. The
1207 second option allows you to have different tags files for different projects,
1208 each automatically loaded depending on the directory you're in when you start
1209 NEdit. Setting the name to "tags" is an obvious choice since this is the
1210 name that ctags uses. NEdit normally evaluates relative path tag file
1211 specifications every time a file is opened. All accessible tag files are
1212 loaded at this time. To disable the automatic loading of tag files specified
1213 as relative paths, set the X resource nedit.alwaysCheckRelativeTagsSpecs to
1216 To unload a tags file, select "Un-load Tags File" from the File menu and
1217 choose from the list of tags files. NEdit will keep track of tags file updates
1218 by checking the timestamp on the files, and automatically update the tags
1221 To find the definition of a function or data structure once a tags file is
1222 loaded, select the name anywhere it appears in your program (see
1223 "Selecting_Text_") and choose "Find Definition" from the Search menu.
1224 ----------------------------------------------------------------------
1229 Calltips are little yellow boxes that pop up to remind you what the arguments
1230 and return type of a function are. More generally, they're a UI mechanism to
1231 present a small amount of crucial information in a prominent location. To
1232 display a calltip, select some text and choose "Show Calltip" from the Search
1233 menu. To kill a displayed calltip, hit Esc.
1235 Calltips get their information from one of two places -- either a tags file (see
1236 "Finding_Declarations_(ctags)_") or a calltips file. First, any loaded calltips
1237 files are searched for a definition, and if nothing is found then the tags
1238 database is searched. If a tag is found that matches the hilighted text then
1239 a calltip is displayed with the first few lines of the definition -- usually
1240 enough to show you what the arguments of a function are.
1242 You can load a calltips file by using choosing "Load Calltips File" from the
1243 File menu. You can unload a calltips file by selecting it from the
1244 "Unload Calltips File" submenu of the File menu. You can also choose one or
1245 more default calltips files to be loaded for each language mode using the
1246 "Default calltips file(s)" field of the Language Modes dialog.
1248 The calltips file format is very simple. calltips files are organized in blocks
1249 separated by blank lines. The first line of the block is the key, which is the
1250 word that is matched when a calltip is requested. The rest of the block is
1251 displayed as the calltip.
1253 Almost any text at all can appear in a calltip key or a calltip. There are no
1254 special characters that need to be escaped. The only issues to note are that
1255 trailing whitespace is ignored, and you cannot have a blank line inside a
1256 calltip. (Use a single period instead -- it'll be nearly invisible.) You should
1257 also avoid calltip keys that begin and end with '@*' characters, since those are
1258 used to mark special blocks.
1260 There are five special block types--comment, include, language, alias, and
1261 version--which are distinguished by their first lines, "@* comment @*",
1262 "@* include @*", "@* language @*", "@* alias @*", and "@* version @*" respectively
1265 Comment blocks are ignored when reading calltips files.
1267 Include blocks specify additional calltips files to load, one per line. The ~
1268 character can be used for your $HOME directory, but other shell shortcuts like
1269 @* and ? can't be used. Include blocks allow you to make a calltips file for your
1270 project that includes, say, the calltips files for C, Motif, and Xt.
1272 Language blocks specify which language mode the calltips should be used with.
1273 When a calltip is requested it won't match tips from languages other than the
1274 current language mode. Language blocks only affect the tips listed after the
1277 Alias blocks allow a calltip to have multiple keys. The first line of the block
1278 is the key for the calltip to be displayed, and the rest of the lines are
1279 additional keys, one per line, that should also show the calltip.
1281 Version blocks are ignored for the time being.
1283 You can use calltips in your own macros using the calltip() and kill_calltip()
1284 macro subroutines and the $calltip_ID macro variable. See the
1285 Macro_Subroutines_ section for details.
1286 ----------------------------------------------------------------------
1291 Basic Regular Expression Syntax
1292 -------------------------------
1294 Regular expressions (regex's) are useful as a way to match inexact sequences
1295 of characters. They can be used in the `Find...' and `Replace...' search
1296 dialogs and are at the core of Color Syntax Highlighting patterns. To specify
1297 a regular expression in a search dialog, simply click on the `Regular
1298 Expression' radio button in the dialog.
1300 A regex is a specification of a pattern to be matched in the searched text.
1301 This pattern consists of a sequence of tokens, each being able to match a
1302 single character or a sequence of characters in the text, or assert that a
1303 specific position within the text has been reached (the latter is called an
1304 anchor.) Tokens (also called atoms) can be modified by adding one of a number
1305 of special quantifier tokens immediately after the token. A quantifier token
1306 specifies how many times the previous token must be matched (see below.)
1308 Tokens can be grouped together using one of a number of grouping constructs,
1309 the most common being plain parentheses. Tokens that are grouped in this way
1310 are also collectively considered to be a regex atom, since this new larger
1311 atom may also be modified by a quantifier.
1313 A regex can also be organized into a list of alternatives by separating each
1314 alternative with pipe characters, `|'. This is called alternation. A match
1315 will be attempted for each alternative listed, in the order specified, until a
1316 match results or the list of alternatives is exhausted (see Alternation_
1319 3>The 'Any' Character
1321 If a dot (`.') appears in a regex, it means to match any character exactly
1322 once. By default, dot will not match a newline character, but this behavior
1323 can be changed (see help topic Parenthetical_Constructs_, under the
1324 heading, Matching Newlines).
1328 A character class, or range, matches exactly one character of text, but the
1329 candidates for matching are limited to those specified by the class. Classes
1330 come in two flavors as described below:
1332 [...] Regular class, match only characters listed.
1333 [^...] Negated class, match only characters NOT listed.
1335 As with the dot token, by default negated character classes do not match
1336 newline, but can be made to do so.
1338 The characters that are considered special within a class specification are
1339 different than the rest of regex syntax as follows. If the first character in
1340 a class is the `]' character (second character if the first character is `^')
1341 it is a literal character and part of the class character set. This also
1342 applies if the first or last character is `-'. Outside of these rules, two
1343 characters separated by `-' form a character range which includes all the
1344 characters between the two characters as well. For example, `[^f-j]' is the
1345 same as `[^fghij]' and means to match any character that is not `f', `g',
1350 Anchors are assertions that you are at a very specific position within the
1351 search text. NEdit regular expressions support the following anchor tokens:
1355 < Left word boundary
1356 > Right word boundary
1357 \B Not a word boundary
1359 Note that the \B token ensures that the left and right characters are both
1360 delimiter characters, or that both left and right characters are
1361 non-delimiter characters. Currently word anchors check only one character,
1362 e.g. the left word anchor `<' only asserts that the left character is a word
1363 delimiter character. Similarly the right word anchor checks the right
1368 Quantifiers specify how many times the previous regular expression atom may
1369 be matched in the search text. Some quantifiers can produce a large
1370 performance penalty, and can in some instances completely lock up NEdit. To
1371 prevent this, avoid nested quantifiers, especially those of the maximal
1372 matching type (see below.)
1374 The following quantifiers are maximal matching, or "greedy", in that they
1375 match as much text as possible.
1377 * Match zero or more
1381 The following quantifiers are minimal matching, or "lazy", in that they match
1382 as little text as possible.
1384 *? Match zero or more
1385 +? Match one or more
1386 ?? Match zero or one
1388 One final quantifier is the counting quantifier, or brace quantifier. It
1389 takes the following basic form:
1391 {min,max} Match from `min' to `max' times the
1392 previous regular expression atom.
1394 If `min' is omitted, it is assumed to be zero. If `max' is omitted, it is
1395 assumed to be infinity. Whether specified or assumed, `min' must be less
1396 than or equal to `max'. Note that both `min' and `max' are limited to
1397 65535. If both are omitted, then the construct is the same as `*'. Note
1398 that `{,}' and `{}' are both valid brace constructs. A single number
1399 appearing without a comma, e.g. `{3}' is short for the `{min,min}' construct,
1400 or to match exactly `min' number of times.
1402 The quantifiers `{1}' and `{1,1}' are accepted by the syntax, but are
1403 optimized away since they mean to match exactly once, which is redundant
1404 information. Also, for efficiency, certain combinations of `min' and `max'
1405 are converted to either `*', `+', or `?' as follows:
1411 Note that {0} and {0,0} are meaningless and will generate an error message at
1412 regular expression compile time.
1414 Brace quantifiers can also be "lazy". For example {2,5}? would try to match
1415 2 times if possible, and will only match 3, 4, or 5 times if that is what is
1416 necessary to achieve an overall match.
1420 A series of alternative patterns to match can be specified by separating them
1421 with vertical pipes, `|'. An example of _alternation would be `a|be|sea'.
1422 This will match `a', or `be', or `sea'. Each alternative can be an
1423 arbitrarily complex regular expression. The alternatives are attempted in
1424 the order specified. An empty alternative can be specified if desired, e.g.
1425 `a|b|'. Since an empty alternative can match nothingness (the empty string),
1426 this guarantees that the expression will match.
1430 Comments are of the form `(?#<comment text>)' and can be inserted anywhere
1431 and have no effect on the execution of the regular expression. They can be
1432 handy for documenting very complex regular expressions. Note that a comment
1433 begins with `(?#' and ends at the first occurrence of an ending parenthesis,
1434 or the end of the regular expression... period. Comments do not recognize
1435 any escape sequences.
1436 ----------------------------------------------------------------------
1441 3>Escaping Metacharacters
1443 In a regular expression (regex), most ordinary characters match themselves.
1444 For example, `ab%' would match anywhere `a' followed by `b' followed by `%'
1445 appeared in the text. Other characters don't match themselves, but are
1446 metacharacters. For example, backslash is a special metacharacter which
1447 'escapes' or changes the meaning of the character following it. Thus, to
1448 match a literal backslash would require a regular expression to have two
1449 backslashes in sequence. NEdit provides the following escape sequences so
1450 that metacharacters that are used by the regex syntax can be specified as
1451 ordinary characters.
1453 \( \) \- \[ \] \< \> \{ \}
1454 \. \| \^ \$ \* \+ \? \& \\
1456 3>Special Control Characters
1458 There are some special characters that are difficult or impossible to type.
1459 Many of these characters can be constructed as a sort of metacharacter or
1460 sequence by preceding a literal character with a backslash. NEdit recognizes
1461 the following special character sequences:
1465 \e ASCII escape character (***)
1466 \f form feed (new page)
1472 *** For environments that use the EBCDIC character set,
1473 when compiling NEdit set the EBCDIC_CHARSET compiler
1474 symbol to get the EBCDIC equivalent escape
1477 3>Octal and Hex Escape Sequences
1479 Any ASCII (or EBCDIC) character, except null, can be specified by using
1480 either an octal escape or a hexadecimal escape, each beginning with \0 or \x
1481 (or \X), respectively. For example, \052 and \X2A both specify the `*'
1482 character. Escapes for null (\00 or \x0) are not valid and will generate an
1483 error message. Also, any escape that exceeds \0377 or \xFF will either cause
1484 an error or have any additional character(s) interpreted literally. For
1485 example, \0777 will be interpreted as \077 (a `?' character) followed by `7'
1486 since \0777 is greater than \0377.
1488 An invalid digit will also end an octal or hexadecimal escape. For example,
1489 \091 will cause an error since `9' is not within an octal escape's range of
1490 allowable digits (0-7) and truncation before the `9' yields \0 which is
1493 3>Shortcut Escape Sequences
1495 NEdit defines some escape sequences that are handy shortcuts for commonly
1496 used character classes.
1499 \l letters a-z, A-Z, and locale dependent letters
1500 \s whitespace \t, \r, \v, \f, and space
1501 \w word characters letters, digits, and underscore, `_'
1503 \D, \L, \S, and \W are the same as the lowercase versions except that the
1504 resulting character class is negated. For example, \d is equivalent to
1505 `[0-9]', while \D is equivalent to `[^0-9]'.
1507 These escape sequences can also be used within a character class. For
1508 example, `[\l_]' is the same as `[a-zA-Z@_]', extended with possible locale
1509 dependent letters. The escape sequences for special characters, and octal
1510 and hexadecimal escapes are also valid within a class.
1512 3>Word Delimiter Tokens
1514 Although not strictly a character class, the following escape sequences
1515 behave similarly to character classes:
1517 \y Word delimiter character
1518 \Y Not a word delimiter character
1520 The `\y' token matches any single character that is one of the characters
1521 that NEdit recognizes as a word delimiter character, while the `\Y' token
1522 matches any character that is NOT a word delimiter character. Word delimiter
1523 characters are dynamic in nature, meaning that the user can change them through
1524 preference settings. For this reason, they must be handled differently by the
1525 regular expression engine. As a consequence of this, `\y' and `\Y' can not be
1526 used within a character class specification.
1527 ----------------------------------------------------------------------
1529 Parenthetical Constructs
1530 ------------------------
1532 3>Capturing Parentheses
1534 Capturing Parentheses are of the form `(<regex>)' and can be used to group
1535 arbitrarily complex regular expressions. Parentheses can be nested, but the
1536 total number of parentheses, nested or otherwise, is limited to 50 pairs.
1537 The text that is matched by the regular expression between a matched set of
1538 parentheses is captured and available for text substitutions and
1539 backreferences (see below.) Capturing parentheses carry a fairly high
1540 overhead both in terms of memory used and execution speed, especially if
1541 quantified by `*' or `+'.
1543 3>Non-Capturing Parentheses
1545 Non-Capturing Parentheses are of the form `(?:<regex>)' and facilitate
1546 grouping only and do not incur the overhead of normal capturing parentheses.
1547 They should not be counted when determining numbers for capturing parentheses
1548 which are used with backreferences and substitutions. Because of the limit
1549 on the number of capturing parentheses allowed in a regex, it is advisable to
1550 use non-capturing parentheses when possible.
1552 3>Positive Look-Ahead
1554 Positive look-ahead constructs are of the form `(?=<regex>)' and implement a
1555 zero width assertion of the enclosed regular expression. In other words, a
1556 match of the regular expression contained in the positive look-ahead
1557 construct is attempted. If it succeeds, control is passed to the next
1558 regular expression atom, but the text that was consumed by the positive
1559 look-ahead is first unmatched (backtracked) to the place in the text where
1560 the positive look-ahead was first encountered.
1562 One application of positive look-ahead is the manual implementation of a
1563 first character discrimination optimization. You can include a positive
1564 look-ahead that contains a character class which lists every character that
1565 the following (potentially complex) regular expression could possibly start
1566 with. This will quickly filter out match attempts that can not possibly
1569 3>Negative Look-Ahead
1571 Negative look-ahead takes the form `(?!<regex>)' and is exactly the same as
1572 positive look-ahead except that the enclosed regular expression must NOT
1573 match. This can be particularly useful when you have an expression that is
1574 general, and you want to exclude some special cases. Simply precede the
1575 general expression with a negative look-ahead that covers the special cases
1576 that need to be filtered out.
1578 3>Positive Look-Behind
1580 Positive look-behind constructs are of the form `(?<=<regex>)' and implement
1581 a zero width assertion of the enclosed regular expression in front of the
1582 current matching position. It is similar to a positive look-ahead assertion,
1583 except for the fact the the match is attempted on the text preceeding the
1584 current position, possibly even in front of the start of the matching range
1585 of the entire regular expression.
1587 A restriction on look-behind expressions is the fact that the expression
1588 must match a string of a bounded size. In other words, `*', `+', and `{n,}'
1589 quantifiers are not allowed inside the look-behind expression. Moreover,
1590 matching performance is sensitive to the difference between the upper and
1591 lower bound on the matching size. The smaller the difference, the better the
1592 performance. This is especially important for regular expressions used in
1595 Another (minor) restriction is the fact that look-**ahead** patterns, nor
1596 any construct that requires look-ahead information (such as word boundaries)
1597 are supported at the end of a look-behind pattern (no error is raised, but
1598 matching behaviour is unspecified). It is always possible to place these
1599 look-ahead patterns immediately after the look-behind pattern, where they
1600 will work as expected.
1602 Positive look-behind has similar applications as positive look-ahead.
1604 3>Negative Look-Behind
1606 Negative look-behind takes the form `(?<!<regex>)' and is exactly the same as
1607 positive look-behind except that the enclosed regular expression must
1608 NOT match. The same restrictions apply.
1610 Note however, that performance is even more sensitive to the distance
1611 between the size boundaries: a negative look-behind must not match for
1612 **any** possible size, so the matching engine must check **every** size.
1616 There are two parenthetical constructs that control case sensitivity:
1618 (?i<regex>) Case insensitive; `AbcD' and `aBCd' are
1621 (?I<regex>) Case sensitive; `AbcD' and `aBCd' are
1624 Regular expressions are case sensitive by default, that is, `(?I<regex>)' is
1625 assumed. All regular expression token types respond appropriately to case
1626 insensitivity including character classes and backreferences. There is some
1627 extra overhead involved when case insensitivity is in effect, but only to the
1628 extent of converting each character compared to lower case.
1632 NEdit regular expressions by default handle the matching of newlines in a way
1633 that should seem natural for most editing tasks. There are situations,
1634 however, that require finer control over how newlines are matched by some
1635 regular expression tokens.
1637 By default, NEdit regular expressions will NOT match a newline character for
1638 the following regex tokens: dot (`.'); a negated character class (`[^...]');
1639 and the following shortcuts for character classes:
1641 `\d', `\D', `\l', `\L', `\s', `\S', `\w', `\W', `\Y'
1643 The matching of newlines can be controlled for the `.' token, negated
1644 character classes, and the `\s' and `\S' shortcuts by using one of the
1645 following parenthetical constructs:
1647 (?n<regex>) `.', `[^...]', `\s', `\S' match newlines
1649 (?N<regex>) `.', `[^...]', `\s', `\S' don't match
1652 `(?N<regex>)' is the default behavior.
1654 3>Notes on New Parenthetical Constructs
1656 Except for plain parentheses, none of the parenthetical constructs capture
1657 text. If that is desired, the construct must be wrapped with capturing
1658 parentheses, e.g. `((?i<regex))'.
1660 All parenthetical constructs can be nested as deeply as desired, except for
1661 capturing parentheses which have a limit of 50 sets of parentheses,
1662 regardless of nesting level.
1666 Backreferences allow you to match text captured by a set of capturing
1667 parenthesis at some later position in your regular expression. A
1668 backreference is specified using a single backslash followed by a single
1669 digit from 1 to 9 (example: \3). Backreferences have similar syntax to
1670 substitutions (see below), but are different from substitutions in that they
1671 appear within the regular expression, not the substitution string. The number
1672 specified with a backreference identifies which set of text capturing
1673 parentheses the backreference is associated with. The text that was most
1674 recently captured by these parentheses is used by the backreference to
1675 attempt a match. As with substitutions, open parentheses are counted from
1676 left to right beginning with 1. So the backreference `\3' will try to match
1677 another occurrence of the text most recently matched by the third set of
1678 capturing parentheses. As an example, the regular expression `(\d)\1' could
1679 match `22', `33', or `00', but wouldn't match `19' or `01'.
1681 A backreference must be associated with a parenthetical expression that is
1682 complete. The expression `(\w(\1))' contains an invalid backreference since
1683 the first set of parentheses are not complete at the point where the
1684 backreference appears.
1688 Substitution strings are used to replace text matched by a set of capturing
1689 parentheses. The substitution string is mostly interpreted as ordinary text
1692 The escape sequences described above for special characters, and octal and
1693 hexadecimal escapes are treated the same way by a substitution string. When
1694 the substitution string contains the `&' character, NEdit will substitute the
1695 entire string that was matched by the `Find...' operation. Any of the first
1696 nine sub-expressions of the match string can also be inserted into the
1697 replacement string. This is done by inserting a `\' followed by a digit from
1698 1 to 9 that represents the string matched by a parenthesized expression
1699 within the regular expression. These expressions are numbered left-to-right
1700 in order of their opening parentheses.
1702 The capitalization of text inserted by `&' or `\1', `\2', ... `\9' can be
1703 altered by preceding them with `\U', `\u', `\L', or `\l'. `\u' and `\l'
1704 change only the first character of the inserted entity, while `\U' and `\L'
1705 change the entire entity to upper or lower case, respectively.
1706 ----------------------------------------------------------------------
1713 Regular expression substitution can be used to program automatic editing
1714 operations. For example, the following are search and replace strings to find
1715 occurrences of the `C' language subroutine `get_x', reverse the first and
1716 second parameters, add a third parameter of NULL, and change the name to
1719 Search string: `get_x *\( *([^ ,]*), *([^\)]*)\)'
1720 Replace string: `new_get_x(\2, \1, NULL)'
1724 If a regular expression could match two different parts of the text, it will
1725 match the one which begins earliest. If both begin in the same place but
1726 match different lengths, or match the same length in different ways, life
1727 gets messier, as follows.
1729 In general, the possibilities in a list of alternatives are considered in
1730 left-to-right order. The possibilities for `*', `+', and `?' are considered
1731 longest-first, nested constructs are considered from the outermost in, and
1732 concatenated constructs are considered leftmost-first. The match that will be
1733 chosen is the one that uses the earliest possibility in the first choice that
1734 has to be made. If there is more than one choice, the next will be made in
1735 the same manner (earliest possibility) subject to the decision on the first
1736 choice. And so forth.
1738 For example, `(ab|a)b*c' could match `abc' in one of two ways. The first
1739 choice is between `ab' and `a'; since `ab' is earlier, and does lead to a
1740 successful overall match, it is chosen. Since the `b' is already spoken for,
1741 the `b*' must match its last possibility, the empty string, since it must
1742 respect the earlier choice.
1744 In the particular case where no `|'s are present and there is only one `*',
1745 `+', or `?', the net effect is that the longest possible match will be
1746 chosen. So `ab*', presented with `xabbbby', will match `abbbb'. Note that
1747 if `ab*' is tried against `xabyabbbz', it will match `ab' just after `x', due
1748 to the begins-earliest rule. (In effect, the decision on where to start the
1749 match is the first choice to be made, hence subsequent choices must respect
1750 it even if this leads them to less-preferred alternatives.)
1754 An excellent book on the care and feeding of regular expressions is
1756 Mastering Regular Expressions, 2nd Edition
1757 Jeffrey E. F. Friedl
1758 2002, O'Reilly & Associates
1760 ----------------------------------------------------------------------
1762 Example Regular Expressions
1763 ---------------------------
1765 The following are regular expression examples which will match:
1773 * Whitespace on a line.
1776 * Whitespace across lines.
1779 * Whitespace that spans at least two lines. Note minimal matching `*?' quantifier.
1782 * IP address (not robust).
1783 ! (?:\d{1,3}(?:\.\d{1,3}){3})
1785 * Two character US Postal state abbreviations (includes territories).
1786 ! [ACDF-IK-PR-W][A-Z]
1789 ! (?:http://)?www\.\S+
1791 * Case insensitive double words across line breaks.
1792 ! (?i(?n<(\S+)\s+\1>))
1794 * Upper case words with possible punctuation.
1796 ----------------------------------------------------------------------
1798 Macro/Shell Extensions
1799 ======================
1801 Shell Commands and Filters
1802 --------------------------
1804 The Shell menu (Unix versions only) allows you to execute Unix shell commands
1805 from within NEdit. You can add items to the menu to extend NEdit's command
1806 set or to incorporate custom automatic editing features using shell commands
1807 or editing languages like awk and sed. To add items to the menu, select
1808 Preferences -> Default Settings Customize Menus -> Shell Menu. NEdit comes
1809 pre-configured with a few useful Unix commands like spell and sort, but we
1810 encourage you to add your own custom extensions.
1812 Filter Selection... prompts you for a Unix command to use to process the
1813 currently selected text. The output from this command replaces the contents
1816 Execute Command... prompts you for a Unix command and replaces the current
1817 selection with the output of the command. If there is no selection, it
1818 deposits the output at the current insertion point. In the Shell Command
1819 field, the % character expands to the name (including directory path), and
1820 the # character expands to the current line number of the file in the window.
1821 To include a % or # character in the command, use %% or ##, respectively.
1823 Execute Command Line uses the position of the cursor in the window to
1824 indicate a line to execute as a shell command line. The cursor may be
1825 positioned anywhere on the line. This command allows you to use an NEdit
1826 window as an editable command window for saving output and saving commands
1827 for re-execution. Note that the same character expansions described above
1828 in Execute Command also occur with this command.
1830 The X resource called nedit.shell (See "Customizing_NEdit_") determines which
1831 Unix shell is used to execute commands. The default value for this resource
1833 ----------------------------------------------------------------------
1838 Selecting Learn Keystrokes from the Macro menu puts NEdit in learn mode. In
1839 learn mode, keystrokes and menu commands are recorded, to be played back
1840 later, using the Replay Keystrokes command, or pasted into a macro in the
1841 Macro Commands dialog of the Default Settings menu in Preferences.
1843 Note that only keyboard and menu commands are recorded, not mouse clicks or
1844 mouse movements since these have no absolute point of reference, such as
1845 cursor or selection position. When you do a mouse-based operation in learn
1846 mode, NEdit will beep (repeatedly) to remind you that the operation was not
1849 Learn mode is also the quickest and easiest method for writing macros. The
1850 dialog for creating macro commands contains a button labeled "Paste Learn /
1851 Replay Macro", which will deposit the last sequence learned into the body of
1854 3>Repeating Actions and Learn/Replay Sequences
1856 You can repeat the last (keyboard-based) command, or learn/replay sequence
1857 with the Repeat... command in the Macro menu. To repeat an action, first do
1858 the action (that is, insert a character, do a search, move the cursor), then
1859 select Repeat..., decide how or how many times you want it repeated, and
1860 click OK. For example, to move down 30 lines through a file, you could type:
1861 <Down Arrow> Ctrl+, 29 <Return>. To repeat a learn/replay sequence, first
1862 learn it, then select Repeat..., click on Learn/Replay and how you want it
1863 repeated, then click OK.
1865 If the commands you are repeating advance the cursor through the file, you
1866 can also repeat them within a range of characters, or from the current cursor
1867 position to the end of the file. To iterate over a range of characters, use
1868 the primary selection (drag the left mouse button over the text) to mark the
1869 range you want to operate on, and select "In Selection" in the Repeat dialog.
1871 When using In "Selection" or "To End" with a learned sequence, try to do
1872 cursor movement as the last step in the sequence, since testing of the cursor
1873 position is only done at the end of the sequence execution. If you do cursor
1874 movement first, for example searching for a particular word then doing a
1875 modification, the position of the cursor won't be checked until the sequence
1876 has potentially gone far beyond the end of your desired range.
1878 It's easy for a repeated command to get out of hand, and you can easily
1879 generate an infinite loop by using range iteration on a command which doesn't
1880 progress. To cancel a repeating command in progress, type Ctrl+. (period),
1881 or select Cancel Macro from the Macro menu.
1882 ----------------------------------------------------------------------
1887 Macros can be called from Macro menu commands, window background menu
1888 commands, within the smart-indent framework, from the autoload macro file and
1889 from the command line.
1890 Macro menu and window background menu commands are defined under Preferences
1891 -> Default Settings -> Customize Menus. Help on creating items in these
1892 menus can be found in the section, Help -> Customizing -> Preferences.
1894 The autoload macro file is a file of macro commands and definitions which
1895 NEdit will automatically execute when it is first started. Its location is
1896 dependent on your environment:
1898 * The default place for the file is '$HOME/.nedit/autoload.nm',
1899 * if the variable $NEDIT_HOME is set in your environment it is located at '$NEDIT_HOME/autoload.nm',
1900 * if you are using old-style run control files (i.e. $HOME/.nedit is a regular file) it is located in '$HOME/.neditmacro'.
1902 (For VMS, the file is in '$NEDIT_HOME/autoload.nm' if $NEDIT_HOME is set, in
1903 'SYS$LOGIN:.neditmacro' otherwise.)
1905 NEdit's macro language is a simple interpreter with integer arithmetic,
1906 dynamic strings, and C-style looping constructs (very similar to the
1907 procedural portion of the Unix awk program). From the macro language, you
1908 can call the same action routines which are bound to keyboard keys and menu
1909 items, as well additional subroutines for accessing and manipulating editor
1910 data, which are specific to the macro language (these are listed in the
1911 sections titled "Macro_Subroutines_", and "Action_Routines_").
1916 An NEdit macro language program consists of a list of statements, each
1917 terminated by a newline. Groups of statements which are executed together
1918 conditionally, such as the body of a loop, are surrounded by curly braces
1921 Blank lines and comments are also allowed. Comments begin with a "#" and end
1922 with a newline, and can appear either on a line by themselves, or at the end
1925 Statements which are too long to fit on a single line may be split across
1926 several lines, by placing a backslash "\" character at the end of each line
1932 The NEdit macro language recognizes only three data types, dynamic character
1933 strings, integer values and associative arrays. In general strings and
1934 integers can be used interchangeably. If a string represents an integer
1935 value, it can be used as an integer. Integers can be compared and
1936 concatenated with strings. Arrays may contain integers, strings, or arrays.
1937 Arrays are stored key/value pairs. Keys are always stored as strings.
1941 Integers are non-fractional numbers in the range of -2147483647 to
1942 2147483647. Integer constants must be in decimal. For example:
1947 4>Character String Constants
1949 Character string constants are enclosed in double quotes. For example:
1952 dialog("Hi there!", "Dismiss")
1954 Strings may also include C-language style escape sequences:
1956 \\ Backslash \t Tab \f Form feed
1957 \" Double quote \b Backspace \a Alert
1958 \n Newline \r Carriage return \v Vertical tab
1960 For example, to send output to the terminal from which NEdit was started, a
1961 newline character is necessary because, like printf, t_print requires
1962 explicit newlines, and also buffers its output on a per-line basis:
1964 t_print("a = " a "\n")
1969 Variable names must begin either with a letter (local variables), or a $
1970 (global variables). Beyond the first character, variables may also contain
1971 numbers and underscores `_'. Variables are called in to existence just by
1972 setting them (no explicit declarations are necessary).
1974 Local variables are limited in scope to the subroutine (or menu item
1975 definition) in which they appear. Global variables are accessible from all
1976 routines, and their values persist beyond the call which created them, until
1979 4>Built-in Variables
1981 NEdit has a number of permanently defined variables, which are used to access
1982 global editor information and information about the the window in which the
1983 macro is executing. These are listed along with the built in functions in
1984 the section titled "Macro_Subroutines_".
1987 3>Functions and Subroutines
1989 The syntax of a function or subroutine call is:
1991 function_name(arg1, arg2, ...)
1993 where arg1, arg2, etc. represent up to 9 argument values which are passed to
1994 the routine being called. A function or subroutine call can be on a line by
1995 itself, as above, or if it returns a value, can be invoked within a character
1996 or numeric expression:
1998 a = fn1(b, c) + fn2(d)
1999 dialog("fn3 says: " fn3())
2001 Arguments are passed by value. This means that you can not return values via
2002 the argument list, only through the function value or indirectly through
2003 agreed-upon global variables.
2005 4>Built-in Functions
2007 NEdit has a wide range of built in functions which can be called from the
2008 macro language. These routines are divided into two classes, macro-language
2009 functions, and editor action routines. Editor action routines are more
2010 flexible, in that they may be called either from the macro language, or bound
2011 directly to keys via translation tables. They are also limited, however, in
2012 that they can not return values. Macro language routines can return values,
2013 but can not be bound to keys in translation tables.
2015 Nearly all of the built-in subroutines operate on an implied window, which is
2016 initially the window from which the macro was started. To manipulate the
2017 contents of other windows, use the focus_window subroutine to change the
2018 focus to the ones you wish to modify. focus_window can also be used to
2019 iterate over all of the currently open windows, using the special keyword
2020 names, "last" and "next".
2022 For backwards compatibility, hyphenated action routine names are allowed, and
2023 most of the existing action routines names which contain underscores have an
2024 equivalent version containing hyphens ('-') instead of underscores. Use of
2025 these names is discouraged. The macro parser resolves the ambiguity between
2026 '-' as the subtraction/negation operator, and - as part of an action routine
2027 name by assuming subtraction unless the symbol specifically matches an action
2030 4>User Defined Functions
2032 Users can define their own macro subroutines, using the define keyword:
2034 define subroutine_name {
2035 < body of subroutine >
2038 Macro definitions can not appear within other definitions, or within macro
2039 menu item definitions (usually they are found in the autoload macro file).
2041 The arguments with which a user-defined subroutine or function was invoked,
2042 are presented as $1, $2, ... , $9. The number of arguments can be read from
2045 To return a value from a subroutine, and/or to exit from the subroutine
2046 before the end of the subroutine body, use the return statement:
2048 return <value to return>
2051 3>Operators and Expressions
2053 Operators have the same meaning and precedence that they do in C, except for
2054 ^, which raises a number to a power (y^x means y to the x power), rather than
2055 bitwise exclusive OR. The table below lists operators in decreasing order of
2058 Operators Associativity
2064 > >= < <= == != left to right
2069 (concatenation) left to right
2070 = += -= *= /= %=, &= |= right to left
2072 The order in which operands are evaluated in an expression is undefined,
2073 except for && and ||, which like C, evaluate operands left to right, but stop
2074 when further evaluation would no longer change the result.
2076 4>Numerical Operators
2078 The numeric operators supported by the NEdit macro language are listed below:
2081 - subtraction or negation
2089 Increment (++) and decrement (--) operators can also be appended or prepended
2090 to variables within an expression. Prepended increment/decrement operators
2091 act before the variable is evaluated. Appended increment/decrement operators
2092 act after the variable is evaluated.
2094 4>Logical and Comparison Operators
2096 Logical operations produce a result of 0 (for false) or 1 (for true). In a
2097 logical operation, any non-zero value is recognized to mean true. The
2098 logical and comparison operators allowed in the NEdit macro language are
2108 == equal (integers and/or strings)
2109 != not equal (integers and/or strings)
2111 4>Character String Operators
2113 The "operator" for concatenating two strings is the absence of an operator.
2114 Adjoining character strings with no operator in between means concatenation:
2117 t_print("the value of a is: " a)
2119 Comparison between character strings is done with the == and != operators,
2120 (as with integers). There are a number of useful built-in routines for
2121 working with character strings, which are listed in the section called
2122 "Macro_Subroutines_".
2124 4>Arrays and Array Operators
2126 Arrays may contain either strings, integers, or other arrays. Arrays are
2127 associative, which means that they relate two pieces of information, the key
2128 and the value. The key is always a string; if you use an integer it is
2129 converted to a string.
2131 To determine if a given key is in an array, use the 'in' keyword.
2136 If the left side of the in keyword is an array, the result is true if every
2137 key in the left array is in the right array. Array values are not compared.
2139 To iterate through all the keys of an array use the 'for' looping construct.
2140 Keys are not guaranteed in any particular order:
2145 Elements can be removed from an array using the delete command:
2147 delete x[3] # deletes element with key 3
2148 delete x[] # deletes all elements
2150 The number of elements in an array can be determined by referencing the
2151 array with no indices:
2153 dialog("array x has " x[] " elements", "OK")
2155 Arrays can be combined with some operators. All the following operators only
2156 compare the keys of the arrays.
2158 result = x + y (Merge arrays)
2160 The 'result' is a new array containing keys from both x and y. If
2161 duplicates are present values from y are used.
2163 result = x - y (Remove keys)
2165 The 'result' is a new array containing all keys from x that are not in y.
2167 result = x & y (Common keys)
2169 The 'result' is a new array containing all keys which are in both x and y.
2170 The values from y are used.
2172 result = x | y (Unique keys)
2174 The 'result' is a new array containing keys which exist in either x or y,
2177 When duplicate keys are encountered using the + and & operators, the values
2178 from the array on the right side of the operators are used for the result.
2179 All of the above operators are array only, meaning both the left and right
2180 sides of the operator must be arrays. The results are also arrays.
2182 Array keys can also contain multiple dimensions:
2184 x[1, 1, 1] = "string"
2186 These are used in the expected way, e.g.:
2188 for (i = 1; i < 3; i++)
2190 for (j = 1; j < 3; j++)
2196 gives the following array:
2203 Internally all indices are part of one string, separated by the string
2204 $sub_sep (ASCII 0x18). The first key in the above example is in fact
2208 If you need to extract one of the keys, you can use split(), using
2209 $sub_sep as the separator.
2211 You can also check for the existence of multi-dimensional array by
2212 looking for $sub_sep in the key.
2214 Last, you need $sub_sep if you want to use the 'in' keyword.
2216 if ((1,2) in myArray)
2221 if (("1" $sub_sep "2") in myArray)
2226 3>Looping and Conditionals
2228 NEdit supports looping constructs: for and while, and conditional statements:
2229 if and else, with essentially the same syntax as C:
2231 for (<init>, ...; <condition>; <increment>, ...) <body>
2233 while (<condition>) <body>
2235 if (<condition>) <body>
2237 if (<condition>) <body> else <body>
2239 <body>, as in C, can be a single statement, or a list of statements enclosed
2240 in curly braces ({}). <condition> is an expression which must evaluate to
2241 true for the statements in <body> to be executed. for loops may also contain
2242 initialization statements, <init>, executed once at the beginning of the
2243 loop, and increment/decrement statements (or any arbitrary statement), which
2244 are executed at the end of the loop, before the condition is evaluated again.
2248 for (i=0; i<100; i++)
2251 for (i=0, j=20; i<20; i++, j--) {
2267 Loops may contain break and continue statements. A break statement causes an
2268 exit from the innermost loop, a continue statement transfers control to the
2270 ----------------------------------------------------------------------
2275 3>Built in Variables
2277 These variables are read-only and can not be changed.
2280 Index of the current pane.
2283 Contains the current preference for auto indent.
2284 Can be "off", "on" or "auto".
2287 Equals the ID of the currently displayed calltip, or 0 if no calltip is
2291 Position of the cursor in the current window.
2294 Column number of the cursor position in the current window.
2297 Width of the current pane in pixels.
2300 If tab emulation is turned on in the Tabs...
2301 dialog of the Preferences menu, value is the
2302 distance between emulated tab stops. If tab
2303 emulation is turned off, value is -1.
2306 An array with no elements. This can be used to initialize
2307 an array to an empty state.
2310 Current newline format that the file will be saved with. Can
2311 be "unix", "dos" or "macintosh".
2314 Name of the file being edited in the current
2315 window, stripped of directory component.
2318 Directory component of file being edited in the current window.
2321 Contains the current plain text font name.
2324 Contains the current bold text font name.
2326 **$font_name_bold_italic**
2327 Contains the current bold-italic text font name.
2329 **$font_name_italic**
2330 Contains the current italic text font name.
2332 **$highlight_syntax**
2333 Whether syntax highlighting is turned on.
2335 **$incremental_backup**
2336 Contains 1 if incremental auto saving is on, otherwise 0.
2338 **$incremental_search_line**
2339 Has a value of 1 if the preference is
2340 selected to always show the incremental search line, otherwise 0.
2343 Name of language mode set in the current window.
2346 Line number of the cursor position in the current window.
2349 True if the file has been locked by the user.
2351 **$make_backup_copy**
2352 Has a value of 1 if original file is kept in a
2353 backup file on save, otherwise 0.
2356 The maximum font width of all the active styles.
2357 Syntax highlighting styles are only considered if syntax highlighting
2361 The minimum font width of all the active styles.
2362 Syntax highlighting styles are only considered if syntax highlighting
2366 True if the file in the current window has
2367 been modified and the modifications have not
2370 **$n_display_lines**
2371 The number of lines visible in the currently active pane.
2374 The number of panes in the current window.
2377 True if in Overtype mode.
2380 True if the file is read only.
2382 **$selection_start, $selection_end**
2383 Beginning and ending positions of the
2384 primary selection in the current window, or
2385 -1 if there is no text selected in the current window.
2387 **$selection_left, $selection_right**
2388 Left and right character offsets of the rectangular (primary) selection in
2389 the current window, or -1 if there is no selection or it is not rectangular.
2392 Name of the current NEdit server.
2394 **$show_line_numbers**
2395 Whether line numbers are shown next to the text.
2398 Contains the current preference for showing matching pairs,
2399 such as "[]" and "{}" pairs. Can be "off", "delimiter", or "range".
2401 **$match_syntax_based**
2402 Whether pair matching should use syntax information, if available.
2404 **$statistics_line**
2405 Has a value of 1 if the statistics line is shown, otherwise 0.
2408 Contains the value of the array sub-script separation string.
2411 The distance between tab stops for a
2412 hardware tab character, as set in the
2413 Tabs... dialog of the Preferences menu.
2416 The length of the text in the current window.
2419 The line number of the top line of the currently active pane.
2422 Whether the user is allowing the NEdit to insert tab characters to maintain
2423 spacing in tab emulation and rectangular dragging operations. (The setting of
2424 the "Use tab characters in padding and emulated tabs" button in the Tabs...
2425 dialog of the Preferences menu.)
2428 The right margin in the current window for text wrapping and filling.
2431 The current wrap text mode. Values are "none", "auto" or "continuous".
2433 **$backlight_string**
2434 The current value of the window's backlighting specification. This is empty
2435 if backlighting is turned off. It can be changed through calls to the
2436 built-in macro function set_backlight_string().
2439 3>Built-in Subroutines
2441 **append_file( string, filename )**
2442 Appends a string to a named file. Returns 1 on successful write, or 0 if
2448 **calltip( "text_or_key" [, mode [, pos [, position_modifier ...]]] )**
2449 Pops up a calltip. <pos> is an optional position in the buffer where the tip
2450 will be displayed. Passing -1 for <pos> is equivalent to not specifying a
2451 position, and it guarantees that the tip will appear on-screen somewhere even
2452 if the cursor is not. The upper-left corner of the calltip will appear below
2453 where the cursor would appear if it were at this position. <mode> is one of
2454 "tipText" (default), "tipKey", or "tagKey". "tipText" displays the text as-is,
2455 "tagKey" uses it as the key to look up a tag, then converts the tag to a
2456 calltip, and "tipKey" uses it as the key to look up a calltip, then falls back
2457 to "tagKey" behavior if that fails. You'll usually use "tipKey" or "tipText".
2458 Finally, you can modify the placement of the calltip relative to the cursor
2459 position (or <pos>) with one or more of these optional position modifiers:
2460 "center" aligns the center of the calltip with the position. "right" aligns
2461 the right edge of the calltip with the position. ("center" and "right" may
2462 not both be used.) "above" places the calltip above the position. "strict"
2463 does not allow the calltip to move from its position in order to avoid going
2464 off-screen or obscuring the cursor. Returns the ID of the calltip if it was
2465 found and/or displayed correctly, 0 otherwise.
2467 **clipboard_to_string()**
2468 Returns the contents of the clipboard as a macro string. Returns empty
2471 **dialog( message, btn_1_label, btn_2_label, ... )**
2472 Pop up a dialog for querying and presenting information to the user. First
2473 argument is a string to show in the message area of the dialog. Up to eight
2474 additional optional arguments represent labels for buttons to appear along
2475 the bottom of the dialog. Returns the number of the button pressed (the
2476 first button is number 1), or 0 if the user closed the dialog via the window
2479 **focus_window( window_name )**
2480 Sets the window on which subsequent macro commands operate. window_name can
2481 be either a fully qualified file name, or one of "last" for the last window
2482 created, or "next" for the next window in the chain from the currently
2483 focused window (the first window being the one returned from calling
2484 focus_window("last"). Returns the name of the newly-focused window, or an
2485 empty string if the requested window was not found.
2487 **get_character( position )**
2488 Returns the single character at the position
2489 indicated by the first argument to the routine from the current window.
2491 **get_range( start, end )**
2492 Returns the text between a starting and ending position from the current
2496 Returns a string containing the text currently selected by the primary
2497 selection either from the current window (no keyword), or from anywhere on
2498 the screen (keyword "any").
2501 Gets the value of an environment variable.
2503 **kill_calltip( [calltip_ID] )**
2504 Kills any calltip that is being displayed in the window in which the macro is
2505 running. If there is no displayed calltip this does nothing. If a calltip
2506 ID is supplied then the calltip is killed only if its ID is calltip_ID.
2508 **length( string )**
2509 Returns the length of a string
2511 **list_dialog( message, text, btn_1_label, btn_2_label, ... )**
2512 Pop up a dialog for prompting the user to choose a line from the given text
2513 string. The first argument is a message string to be used as a title for the
2514 fixed text describing the list. The second string provides the list data:
2515 this is a text string in which list entries are separated by newline
2516 characters. Up to seven additional optional arguments represent labels for
2517 buttons to appear along the bottom of the dialog. Returns the line of text
2518 selected by the user as the function value (without any newline separator) or
2519 the empty string if none was selected, and number of the button pressed (the
2520 first button is number 1), in $list_dialog_button. If the user closes the
2521 dialog via the window close box, the function returns the empty string, and
2522 $list_dialog_button returns 0.
2524 **max( n1, n2, ... )**
2525 Returns the maximum value of all of its arguments
2527 **min( n1, n2, ... )**
2528 Returns the minimum value of all of its arguments
2530 **read_file( filename )**
2531 Reads the contents of a text file into a string. On success, returns 1 in
2532 $read_status, and the contents of the file as a string in the subroutine
2533 return value. On failure, returns the empty string "" and an 0 $read_status.
2535 **replace_in_string( string, search_for, replace_with [, type, "copy"] )**
2536 Replaces all occurrences of a search string in a string with a replacement
2537 string. Arguments are 1: string to search in, 2: string to search for, 3:
2538 replacement string. There are two optional arguments. One is a search type,
2539 either "literal", "case", "word", "caseWord", "regex", or "regexNoCase".
2540 The default search type is "literal". If the optional "copy" argument is
2541 specified, a copy of the input string is returned when no replacements were
2542 performed. By default an empty string ("") will be returned in this case.
2543 Returns a new string with all of the replacements done.
2545 **replace_range( start, end, string )**
2546 Replaces all of the text in the current window between two positions.
2548 **replace_selection( string )**
2549 Replaces the primary-selection selected text in the current window.
2551 **replace_substring( string, start, end, replace_with )**
2552 Replacing a substring between two positions in a string within another string.
2554 **search( search_for, start [, search_type, wrap, direction] )**
2555 Searches silently in a window without dialogs, beeps, or changes to the
2556 selection. Arguments are: 1: string to search for, 2: starting position.
2557 Optional arguments may include the strings: "wrap" to make the search wrap
2558 around the beginning or end of the string, "backward" or "forward" to change
2559 the search direction ("forward" is the default), "literal", "case", "word",
2560 "caseWord", "regex", or "regexNoCase" to change the search type (default is
2561 "literal"). Returns the starting position of the match, or -1 if nothing
2562 matched. Also returns the ending position of the match in $search_end.
2564 **search_string( string, search_for, start [, search_type, direction] )**
2566 Built-in macro subroutine for searching a string. Arguments are 1: string to
2567 search in, 2: string to search for, 3: starting position. Optional arguments
2568 may include the strings: "wrap" to make the search wrap around the beginning
2569 or end of the string, "backward" or "forward" to change the search direction
2570 ("forward" is the default), "literal", "case", "word", "caseWord", "regex",
2571 or "regexNoCase" to change the search type (default is "literal"). Returns
2572 the starting position of the match, or -1 if nothing matched. Also returns
2573 the ending position of the match in $search_end.
2575 **select( start, end )**
2576 Selects (with the primary selection) text in the current buffer between a
2577 starting and ending position.
2579 **select_rectangle( start, end, left, right )**
2580 Selects a rectangular area of text between a starting and ending position,
2581 and confined horizontally to characters displayed between positions "left",
2584 **set_backlight_string( [string] )**
2585 Applies the given string, which should be in the format of the
2586 nedit*backlightCharTypes X resource, to the current text window, turning on
2587 backlighting. If the value of the string passed is "default", or if no
2588 parameter is passed, the nedit.backlightCharTypes X resource's own value will
2589 be used. If the empty string, "", is passed, backlighting will be turned
2592 **set_cursor_pos( position )**
2593 Set the cursor position for the current window.
2595 **shell_command( command, input_string )**
2596 Executes a shell command, feeding it input from input_string. On completion,
2597 output from the command is returned as the function value, and the command's
2598 exit status is returned in the global variable $shell_cmd_status.
2600 **split(string, separation_string [, search_type])**
2601 Splits a string using the separator specified. Optionally the search_type
2602 argument can specify how the separation_string is interpreted. The default
2603 is "literal". The returned value is an array with keys beginning at 0.
2605 **string_dialog( message, btn_1_label, btn_2_label, ... )**
2606 Pops up a dialog prompting the user to enter information. The first argument
2607 is a string to show in the message area of the dialog. Up to nine additional
2608 optional arguments represent labels for buttons to appear along the bottom of
2609 the dialog. Returns the string entered by the user as the function value,
2610 and number of the button pressed (the first button is number 1), in
2611 $string_dialog_button. If the user closes the dialog via the window close
2612 box, the function returns the empty string, and $string_dialog_button returns
2615 **string_compare(string1, string2 [, consider-case])**
2616 Compare two strings and return 0 if they are equal, -1 if string1 is less
2617 than string2 or 1 if string1 is greater than string2. The values for the
2618 optional consider-case argument is either "case" or "nocase". The default
2619 is to do a case sensitive comparison.
2621 **string_to_clipboard( string )**
2622 Copy the contents of a macro string to the clipboard.
2624 **substring( string, start, end )**
2625 Returns the portion of a string between a starting and ending position.
2627 **t_print( string1, string2, ... )**
2628 Writes strings to the terminal (stdout) from which NEdit was started.
2630 **tolower( string )**
2631 Return an all lower-case version of string.
2633 **toupper( string )**
2634 Return an all upper-case version of string.
2636 **valid_number( string )**
2637 Returns 1 if the string can be converted to a number without error
2638 following the same rules that the implicit conversion would. Otherwise 0.
2640 **write_file( string, filename )**
2641 Writes a string (parameter 1) to a file named in parameter 2. Returns 1 on
2642 successful write, or 0 if unsuccessful.
2643 ----------------------------------------------------------------------
2648 The user can define range sets, identified by an alphabetic character. A
2649 range set contains ranges, defined by start and end positions in the text
2650 buffer. These ranges are adjusted when modifications are made to the text
2651 buffer: they shuffle around when characters are added or deleted. However,
2652 ranges within a set will coalesce if the characters between them are removed,
2653 or a new range is added to the set which bridges or overlaps others.
2655 Using range sets allows non-contiguous bits of the text to be identified as a
2658 Range sets can be assigned a background color: characters within a range of a
2659 range set will have the background color of the range set. If more than one
2660 rangeset includes a given character, its background color will be that of the
2661 most recently created range set which has a color defined.
2663 Warnings: A range set is manipulated ONLY through macro routines. Range sets
2664 can easily become very large, and may exceed the capacity of the running
2665 process. Coloring relies on proper color names or specifications (such as
2666 the "#rrggbb" hexadecimal digit strings), and appropriate hardware support.
2667 Behaviours set using rangeset_set_modify_response() are still experimental.
2670 3>Range set read-only variables
2672 These are set by calls to the range set functions.
2675 string of active rangeset letters in reverse order of definition.
2678 label of most recently accessed rangeset.
2681 color (if any) of most recently accessed rangeset.
2683 **$rangeset_modify_response**
2684 modify response name of most recently accessed rangeset.
2686 **$rangeset_ranges**
2687 number of ranges in most recently accessed rangeset.
2689 **$rangeset_range_index**
2690 most recently accessed range in rangeset (or -1).
2692 **$rangeset_range_start**
2693 start position of most recently accessed range (or -1).
2695 **$rangeset_range_end**
2696 end position of most recently accessed range (or -1).
2698 3>Range set functions
2700 **rangeset_defined( r, [index] )**
2701 Returns true if the range identified by the letter r is defined, false if
2702 not. If a non-negative index is supplied, this is used to set up the range
2703 set macro variables for the range specified in the set; if index is greater
2704 than the value of rangeset_get_count(r), the return value is false.
2706 **rangeset_inverse( r )**
2707 Changes the range set r so that it contains all ranges not in r. Returns the
2708 number of entries if successful.
2710 **rangeset_add( r, [start, end] )**
2711 **rangeset_add( r, r0 )**
2712 Adds to the range set r. The first form adds the range identified by the
2713 current primary selection to the range set, unless start and end are defined,
2714 in which case the range they define is added. The second form allows all
2715 ranges in the range set identified by r0 to be added to the range set r. If r
2716 has not yet been defined, it will be at this point. Returns the number of
2717 non-contiguous ranges in r after the addition.
2719 **rangeset_remove( r, [start, end] )**
2720 **rangeset_remove( r, r0 )**
2721 Removes from the range set r. The first form removes the range identified by
2722 the current primary selection from the range set, unless start and end are
2723 defined, in which case the range they define is removed. The second form
2724 allows all ranges in the range set identified by r0 to be removed from the
2725 range set r. Returns the number of non-contiguous ranges in r after the
2728 **rangeset_forget( r )**
2729 Deletes all information about the range set identified by r. A subsequent
2730 call to rangeset_defined(r) will return false.
2732 **rangeset_get_count( r )**
2733 Returns the number of non-contiguous ranges in the range set r.
2735 **rangeset_select( r, [index] )**
2736 Selects the region starting at the start of the first range in the range set
2737 r and ending at the end of the last, unless index is supplied, in which case
2738 the range in the range set identified by the index will be selected. index
2739 should satisfy the conditions 0 <= index and index < rangeset_get_count(r).
2740 Returns true if successful.
2742 **rangeset_includes_pos( r, pos )**
2743 Returns true if there is a range in the range set r which contains pos.
2745 **rangeset_set_color( r, [color] )**
2746 Removes the coloring of range set r if no color name is supplied, otherwise
2747 attempts to apply the color as a background color to the ranges of r. No
2748 check is made regarding the validity of color: if the color is invalid (a bad
2749 name, or not supported by the hardware) this has no effect. If r is
2750 undefined, this function will define it with no ranges.
2752 **rangeset_set_modify_response( r, type )**
2753 Changes the behaviour of the range set r when modifications to the text
2754 buffer occur. type can be one of the following: "maintain" (the default),
2755 "break", "include", "exclude", "ins_del" or "del_ins". (The differences are
2759 Highlighting Information
2760 ------------------------
2762 The user can interrogate the current window to determine the color
2763 highlighting used on a particular piece of text. The following functions
2764 provide information on the highlighting pattern against which text at a
2765 particular position has been matched, its style, color and font attributes
2766 (whether the font is supposed to be bold and/or italic).
2768 Some other functions allow macros to access style information given the name
2769 of a highlighting pattern, or a highlighting style name.
2771 These macro functions permit macro writers to generate formatted output which
2772 allows NEdit highlighting to be reproduced. This is suitable for the
2773 generation of HTML or Postscript output, for example.
2775 3>Highlighting information functions
2777 **get_style( pos )**
2778 returns an array containing the attributes of the character at position
2779 "pos". **"style"** (name of the highlight style), **"color"** (name of the
2780 color), **"rgb"** (the actual screen color expressed in red, green and blue
2781 hexadecimal values as "#rrggbb"), **"bold"** (true or false) and **"italic"**
2782 (true or false), **"background"** (name of the background color, if any) and
2783 **"back_rgb"** (the background color values).
2785 **get_pattern( pos )**
2786 returns an array containing the attributes of the character at position
2787 "pos". **"pattern"** (highlight pattern name), **"style"** (highlight style
2788 name) and **"extension"** (the length in the text which uses the same
2789 highlighting pattern)
2791 **highlight_pattern_of_pos( [pos] )**
2792 ~Deprecated: use get_pattern(pos)["pattern"]~
2793 returns the pattern name for highlighting used at the position in the text.
2794 If no position is supplied, the current cursor position will be used.
2796 **highlight_style_of_pos( [pos] )**
2797 ~Deprecated: use either get_pattern(pos)["style"] or get_style(pos)["style"]~
2798 returns the name of the highlighting style applied at the given position
2799 (defaults to the cursor position).
2801 **highlight_color_of_pos( [pos] )**
2802 ~Deprecated: use get_style(pos)["color"]~
2803 returns the name of the color used by the highlighting style applied at the
2804 given position (defaults to the cursor position).
2806 **highlight_color_value_of_pos( [pos] )**
2807 ~Deprecated: use get_style(pos)["rgb"]~
2808 returns the value of the color by the highlighting style applied at the given
2809 position (defaults to the cursor position). This is a hexadecimal formatted
2810 value, preceded by the "#" sign; each of three pairs of hexadecimal digits
2811 indicate the color value for the red, green and blue components of the color,
2812 in the range 0 to 255 (0 - 0xFF), for example "#ffff80" is a light yellow
2815 **highlight_style_of_pos_is_bold( [pos] )**
2816 ~Deprecated: use get_style(pos)["bold"]~
2817 returns true (non-zero) if the highlighting style applied at the given
2818 position (defaults to the cursor position) uses a bold font.
2820 **highlight_style_of_pos_is_italic( [pos] )**
2821 ~Deprecated: use get_style(pos)["italic"]~
2822 returns true (non-zero) if the highlighting style applied at the given
2823 position (defaults to the cursor position) uses an italic font.
2825 **highlight_pattern_extends_from( [pos] )**
2826 ~Deprecated: use get_pattern(pos)["extension"]~
2827 returns the length in the text starting at the given position (defaults to
2828 the cursor position) which uses the same highlighting pattern as that
2831 **highlight_pattern_style( pat_name )**
2832 returns the name of the style used by a particular named highlighting
2835 **highlight_style_color( style_name )**
2836 returns the name of the color used by a particular named highlighting style.
2838 **highlight_style_color_value( style_name )**
2839 returns the value of the color used by a particular named highlighting style.
2841 **highlight_style_is_bold( style_name )**
2842 returns true (non-zero) if the particular named highlighting style uses a
2845 **highlight_style_is_italic( style_name )**
2846 returns true (non-zero) if the particular named highlighting style uses an
2848 ----------------------------------------------------------------------
2853 All of the editing capabilities of NEdit are represented as a special type of
2854 subroutine, called an action routine, which can be invoked from both macros
2855 and translation table entries (see "Key_Binding_" in the
2856 Customizing section of the Help menu).
2859 3>Actions Representing Menu Commands
2861 File Menu Search Menu
2862 ----------------------- -------------------------
2864 open() find_dialog()
2865 open_dialog() find_again()
2866 open_selected() find_selection()
2868 save() replace_dialog()
2869 save_as() replace_all()
2870 save_as_dialog() replace_in_selection()
2871 revert_to_saved() replace_again()
2872 include_file() goto_line_number()
2873 include_file_dialog() goto_line_number_dialog()
2874 load_macro_file() goto_selected()
2875 load_macro_file_dialog() mark()
2876 load_tags_file() mark_dialog()
2877 load_tags_file_dialog() goto_mark()
2878 unload_tags_file() goto_mark_dialog()
2879 print() goto_matching()
2880 print_selection() select_to_matching()
2881 exit() find_definition()
2883 Edit Menu Shell Menu
2884 ----------------------- -------------------------
2885 undo() filter_selection_dialog()
2886 redo() filter_selection()
2887 delete() execute_command()
2888 select_all() execute_command_dialog()
2889 shift_left() execute_command_line()
2890 shift_left_by_tab() shell_menu_command()
2892 shift_right_by_tab() Macro Menu
2893 uppercase() -------------------------
2894 lowercase() macro_menu_command()
2895 fill_paragraph() repeat_macro()
2896 control_code_dialog() repeat_dialog()
2899 -------------------------
2903 An action representing a menu command is named the same as its corresponding
2904 menu item except that all punctuation is removed, all letters are changed to
2905 lower case, and spaces are replaced with underscores. To present a dialog to
2906 ask the user for input, use the actions with the `_dialog` suffix. Actions
2907 without the `_dialog` suffix take the information from the routine's
2908 arguments (see below).
2910 3>Menu Action Routine Arguments
2912 Arguments are text strings enclosed in quotes. Below are the menu action
2913 routines which take arguments. Optional arguments are enclosed in [].
2915 **close**( ["prompt" | "save" | "nosave"] )
2917 **execute_command**( shell-command )
2919 **filter_selection**( shell-command )
2921 **find**( search-string [, ~search-direction~] [, ~search-type~]
2924 **find_again**( [~search-direction~] [, ~search-wrap~] )
2926 **find_definition**( [tag-name] )
2928 **find_dialog**( [~search-direction~] [, ~search-type~]
2931 **find_selection**( [~search-direction~] [, ~search-wrap~]
2932 [, ~non-regex-search-type~] )
2934 **goto_line_number**( [~line-number~] [, ~column-number~] )
2936 **goto_mark**( ~mark-letter~ )
2938 **include_file**( ~filename~ )
2940 **load_tags_file**( ~filename~ )
2942 **macro_menu_command**( ~macro-menu-item-name~ )
2944 **mark**( ~mark-letter~ )
2946 **open**( ~filename~ )
2948 **replace**( search-string, replace-string,
2949 [, ~search-direction~] [, ~search-type~] [, ~search-wrap~] )
2951 **replace_again**( [~search-direction~] [, ~search-wrap~] )
2953 **replace_dialog**( [~search-direction~] [, ~search-type~]
2956 **replace_in_selection**( search-string,
2957 replace-string [, ~search-type~] )
2959 **save_as**( ~filename~ )
2961 **shell_menu_command**( ~shell-menu-item-name~ )
2963 **unload_tags_file**( ~filename~ )
2965 **----------- Some notes on argument types above -----------**
2967 ~filename~ Path names are relative to the directory from
2968 which NEdit was started. Shell interpreted
2969 wildcards and `~' are not expanded.
2971 ~keep-dialog~ Either "keep" or "nokeep".
2973 ~mark-letter~ The mark command limits users to single
2974 letters. Inside of macros, numeric marks are
2975 allowed, which won't interfere with marks set
2978 ~macro-menu-item-name~
2979 Name of the command exactly as specified in
2980 the Macro Menu dialogs.
2982 ~non-regex-search-type~
2983 Either "literal", "case", "word", or
2987 Either "forward" or "backward".
2989 ~search-type~ Either "literal", "case", "word",
2990 "caseWord", "regex", or "regexNoCase".
2992 ~search-wrap~ Either "wrap" or "nowrap".
2994 ~shell-menu-item-name~
2995 Name of the command exactly as specified in
2996 the Shell Menu dialogs.
2998 3>Window Preferences Actions
3000 **set_auto_indent( "off" | "on" | "smart" )**
3001 Set auto indent mode for the current window.
3003 **set_em_tab_dist( em-tab-distance )**
3004 Set the emulated tab size. An em-tab-distance value of
3005 0 or -1 translates to no emulated tabs. Em-tab-distance must
3006 be smaller than 1000.
3008 **set_fonts( font-name, italic-font-name, bold-font-name, bold-italic-font-name )**
3009 Set all the fonts used for the current window.
3011 **set_highlight_syntax( [0 | 1] )**
3012 Set syntax highlighting mode for the current window.
3013 A value of 0 turns it off and a value of 1 turns it on.
3014 If no parameters are supplied the option is toggled.
3016 **set_incremental_backup( [0 | 1] )**
3017 Set incremental backup mode for the current window.
3018 A value of 0 turns it off and a value of 1 turns it on.
3019 If no parameters are supplied the option is toggled.
3021 **set_incremental_search_line( [0 | 1] )**
3022 Show or hide the incremental search line for the current window.
3023 A value of 0 turns it off and a value of 1 turns it on.
3024 If no parameters are supplied the option is toggled.
3026 **set_language_mode( language-mode )**
3027 Set the language mode for the current window. If the language mode is
3028 "" or unrecognized, it will be set to Plain.
3030 **set_locked( [0 | 1] )**
3031 This only affects the locked status of a file, not it's read-only
3032 status. Permissions are NOT changed.
3033 A value of 0 turns it off and a value of 1 turns it on.
3034 If no parameters are supplied the option is toggled.
3036 **set_make_backup_copy( [0 | 1] )**
3037 Set whether backup copies are made during saves for the current window.
3038 A value of 0 turns it off and a value of 1 turns it on.
3039 If no parameters are supplied the option is toggled.
3041 **set_overtype_mode( [0 | 1] )**
3042 Set overtype mode for the current window.
3043 A value of 0 turns it off and a value of 1 turns it on.
3044 If no parameters are supplied the option is toggled.
3046 **set_show_line_numbers( [0 | 1] )**
3047 Show or hide line numbers for the current window.
3048 A value of 0 turns it off and a value of 1 turns it on.
3049 If no parameters are supplied the option is toggled.
3051 **set_show_matching( "off" | "delimiter" | "range" )**
3052 Set show matching (...) mode for the current window.
3054 **set_match_syntax_based( [0 | 1] )**
3055 Set whether matching should be syntax based for the current window.
3057 **set_statistics_line( [0 | 1] )**
3058 Show or hide the statistics line for the current window.
3059 A value of 0 turns it off and a value of 1 turns it on.
3060 If no parameters are supplied the option is toggled.
3062 **set_tab_dist( tab-distance )**
3063 Set the size of hardware tab spacing. Tab-distance must
3064 must be a value greater than 0 and no greater than 20.
3066 **set_use_tabs( [0 | 1] )**
3067 Set whether tabs are used for the current window.
3068 A value of 0 turns it off and a value of 1 turns it on.
3069 If no parameters are supplied the option is toggled.
3071 **set_wrap_margin( wrap-width )**
3072 Set the wrap width for text wrapping of the current window. A value
3073 of 0 means to wrap at window width.
3075 **set_wrap_text( "none" | "auto" | "continuous" )**
3076 Set wrap text mode for the current window.
3078 3>Keyboard-Only Actions
3080 In addition to the arguments listed in the call descriptions below, any
3081 routine involving cursor movement can take the argument "extend", meaning,
3082 adjust the primary selection to the new cursor position. Routines which take
3083 the "extend" argument as well as mouse dragging operations for both primary
3084 and secondary selections can take the optional keyword "rect", meaning, make
3085 the selection rectangular. Any routine that accepts the "scrollbar" argument
3086 will move the display but not the cursor or selection. Routines that accept
3087 the "nobell" argument will fail silently without beeping, when that argument
3090 **backward_character( ["nobell"] )**
3091 Moves the cursor one character to the left.
3093 **backward_paragraph(["nobell"] )**
3094 Moves the cursor to the beginning of the paragraph, or
3095 if the cursor is already at the beginning of a paragraph, moves the cursor to
3096 the beginning of the previous paragraph. Paragraphs are defined as regions
3097 of text delimited by one or more blank lines.
3099 **backward_word( ["nobell"] )**
3100 Moves the cursor to the beginning of a word, or, if the
3101 cursor is already at the beginning of a word, moves the cursor to the
3102 beginning of the previous word. Word delimiters are user-settable, and
3103 defined by the X resource wordDelimiters.
3105 **beginning_of_file( ["scrollbar"] )**
3106 Moves the cursor to the beginning of the file.
3108 **beginning_of_line( ["absolute"] )**
3109 Moves the cursor to the beginning of the line. If
3110 "absolute" is given, always moves to the absolute beginning of line,
3111 regardless of the text wrapping mode.
3113 **beginning_of_selection()**
3114 Moves the cursor to the beginning of the selection
3115 without disturbing the selection.
3117 **copy_clipboard()**
3118 Copies the current selection to the clipboard.
3121 Copies the primary selection to the cursor.
3124 If a secondary selection exists, copies the secondary selection to
3125 the cursor. If no secondary selection exists, copies the primary selection
3126 to the pointer location.
3128 **copy_to_or_end_drag()**
3129 Completes either a secondary selection operation, or a
3130 primary drag. If the user is dragging the mouse to adjust a secondary
3131 selection, the selection is copied and either inserted at the cursor
3132 location, or, if pending-delete is on and a primary selection exists in the
3133 window, replaces the primary selection. If the user is dragging a block of
3134 text (primary selection), completes the drag operation and leaves the text at
3135 it's current location.
3138 Deletes the text in the primary selection and places it in
3142 Copies the primary selection to the cursor and deletes it at
3143 its original location.
3145 **delete_selection()**
3146 Deletes the contents of the primary selection.
3148 **delete_next_character( ["nobell"] )**
3149 If a primary selection exists, deletes its contents.
3150 Otherwise, deletes the character following the cursor.
3152 **delete_previous_character( ["nobell"] )**
3153 If a primary selection exists, deletes its
3154 contents. Otherwise, deletes the character before the cursor.
3156 **delete_next_word( ["nobell"] )**
3157 If a primary selection exists, deletes its contents.
3158 Otherwise, deletes the word following the cursor.
3160 **delete_previous_word( ["nobell"] )**
3161 If a primary selection exists, deletes its contents.
3162 Otherwise, deletes the word before the cursor.
3164 **delete_to_start_of_line( ["nobell", "wrap"] )**
3165 If a primary selection exists, deletes its contents. Otherwise, deletes the
3166 characters between the cursor and the start of the line. If "wrap" is
3167 given, deletes to the previous wrap point or beginning of line, whichever
3170 **delete_to_end_of_line( ["nobell", "absolute"] )**
3171 If a primary selection exists, deletes its contents.
3172 Otherwise, deletes the characters between the cursor and the end of the line.
3173 If "absolute" is given, always deletes to the absolute end of line, regardless
3174 of the text wrapping mode.
3177 De-selects the primary selection.
3179 **end_of_file( ["scrollbar"] )**
3180 Moves the cursor to the end of the file.
3182 **end_of_line( ["absolute"] )**
3183 Moves the cursor to the end of the line. If
3184 "absolute" is given, always moves to the absolute end of line, regardless
3185 of the text wrapping mode.
3187 **end_of_selection()**
3188 Moves the cursor to the end of the selection without
3189 disturbing the selection.
3191 **exchange( ["nobell"] )**
3192 Exchange the primary and secondary selections.
3195 Attached mouse-movement events to begin a selection between
3196 the cursor and the mouse, or extend the primary selection to the mouse
3200 Completes a primary drag-selection operation.
3203 Begins a selection between the cursor and the mouse. A
3204 drag-selection operation can be started with either extend_start or
3207 **focus_pane( [relative-pane] | [positive-index] | [negative-index] )**
3208 Move the focus to the requested pane.
3209 Arguments can be specified in the form of a relative-pane
3210 ("first", "last", "next", "previous"), a positive-index
3211 (numbers greater than 0, 1 is the same as "first") or a
3212 negative-index (numbers less than 0, -1 is the same as "last").
3214 **forward_character()**
3215 Moves the cursor one character to the right.
3217 **forward_paragraph( ["nobell"] )**
3218 Moves the cursor to the beginning of the next paragraph.
3219 Paragraphs are defined as regions of text delimited by one or more blank
3222 **forward_word( ["tail"] ["nobell"] )**
3223 Moves the cursor to the beginning of the next word. Word
3224 delimiters are user-settable, and defined by the X resource wordDelimiters.
3225 If the "tail" argument is supplied the cursor will be moved to
3226 the end of the current word or the end of the next word, if the
3227 cursor is between words.
3230 Moves the cursor to the mouse pointer location, and prepares for
3231 a possible drag-selection operation (bound to extend_adjust), or multi-click
3232 operation (a further grab_focus action). If a second invocation of grab
3233 focus follows immediately, it selects a whole word, or a third, a whole line.
3235 **insert_string( "string" )**
3236 If pending delete is on and the cursor is inside the
3237 selection, replaces the selection with "string". Otherwise, inserts "string"
3238 at the cursor location.
3240 **key_select( "direction" [,"nobell"] )**
3241 Moves the cursor one character in "direction"
3242 ("left", "right", "up", or "down") and extends the selection. Same as
3243 forward/backward-character("extend"), or process-up/down("extend"), for
3244 compatibility with previous versions.
3246 **move-destination()**
3247 Moves the cursor to the pointer location without
3248 disturbing the selection. (This is an unusual way of working. We left it in
3249 for compatibility with previous versions, but if you actually use this
3250 capability, please send us some mail, otherwise it is likely to disappear in
3254 If a secondary selection exists, deletes the contents of the
3255 secondary selection and inserts it at the cursor, or if pending-delete is on
3256 and there is a primary selection, replaces the primary selection. If no
3257 secondary selection exists, moves the primary selection to the pointer
3258 location, deleting it from its original position.
3260 **move_to_or_end_drag()**
3261 Completes either a secondary selection operation, or a
3262 primary drag. If the user is dragging the mouse to adjust a secondary
3263 selection, the selection is deleted and either inserted at the cursor
3264 location, or, if pending-delete is on and a primary selection exists in the
3265 window, replaces the primary selection. If the user is dragging a block of
3266 text (primary selection), completes the drag operation and deletes the text
3267 from it's current location.
3270 Inserts a newline character. If Auto Indent is on, lines up the
3271 indentation of the cursor with the current line.
3273 **newline_and_indent()**
3274 Inserts a newline character and lines up the indentation
3275 of the cursor with the current line, regardless of the setting of Auto
3278 **newline_no_indent()**
3279 Inserts a newline character, without automatic
3280 indentation, regardless of the setting of Auto Indent.
3282 **next_page( ["stutter"] ["column"] ["scrollbar"] ["nobell"] )**
3283 Moves the cursor and scroll forward one page.
3284 The parameter "stutter" moves the cursor to the bottom of the display,
3285 unless it is already there, otherwise it will page down.
3286 The parameter "column" will maintain the preferred column while
3289 **page_left( ["scrollbar"] ["nobell"] )**
3290 Move the cursor and scroll left one page.
3292 **page_right( ["scrollbar"] ["nobell"] )**
3293 Move the cursor and scroll right one page.
3295 **paste_clipboard()**
3296 Insert the contents of the clipboard at the cursor, or if
3297 pending delete is on, replace the primary selection with the contents of the
3300 **previous_page( ["stutter"] ["column"] ["scrollbar"] ["nobell"] )**
3301 Moves the cursor and scroll backward one page.
3302 The parameter "stutter" moves the cursor to the top of the display,
3303 unless it is already there, otherwise it will page up.
3304 The parameter "column" will maintain the preferred column while
3308 Same as secondary_or_drag_start for compatibility with previous versions.
3310 **process_cancel()**
3311 Cancels the current extend_adjust, secondary_adjust, or
3312 secondary_or_drag_adjust in progress.
3314 **process_down( ["nobell", "absolute"] )**
3315 Moves the cursor down one line. If "absolute" is given, always moves to the
3316 next line in the text buffer, regardless of wrapping.
3318 **process_return()**
3319 Same as newline for compatibility with previous versions.
3321 **process_shift_down( ["nobell", "absolute"] )**
3322 Same as process_down("extend") for compatibility with previous versions.
3324 **process_shift_up( ["nobell", "absolute"] )**
3325 Same as process_up("extend") for compatibility with previous versions.
3328 If tab emulation is turned on, inserts an emulated tab,
3329 otherwise inserts a tab character.
3331 **process_up( ["nobell", "absolute"] )**
3332 Moves the cursor up one line. If "absolute" is given, always moves to the
3333 previous line in the text buffer, regardless of wrapping.
3335 **raise_window([relative-window] | [positive-index] | [negative-index])**
3336 Raise the current focused window to the front if no argument is supplied.
3337 Arguments can be specified in the form of a relative-window
3338 ("first", "last", "next", "previous"), a positive-index
3339 (numbers greater than 0, 1 is the same as "last") or a
3340 negative-index (numbers less than 0, -1 is the same as "first").
3342 **scroll_down(nLines)**
3343 Scroll the display down (towards the end of the file) by nLines.
3345 **scroll_left( nPixels )**
3346 Scroll the display left by nPixels.
3348 **scroll_right( nPixels )**
3349 Scroll the display right by nPixels.
3351 **scroll_up( nLines )**
3352 Scroll the display up (towards the beginning of the file) by nLines.
3354 **scroll_to_line( lineNum )**
3355 Scroll to position line number lineNum at the top of
3356 the pane. The first line of a file is line 1.
3358 **secondary_adjust()**
3359 Attached mouse-movement events to extend the secondary
3360 selection to the mouse position.
3362 **secondary_or_drag_adjust()**
3363 Attached mouse-movement events to extend the
3364 secondary selection, or reposition the primary text being dragged. Takes two
3365 optional arguments, "copy", and "overlay". "copy" leaves a copy of the
3366 dragged text at the site at which the drag began. "overlay" does the drag in
3367 overlay mode, meaning the dragged text is laid on top of the existing text,
3368 obscuring and ultimately deleting it when the drag is complete.
3370 **secondary_or_drag_start()**
3371 To be attached to a mouse down event. Begins drag
3372 selecting a secondary selection, or dragging the contents of the primary
3373 selection, depending on whether the mouse is pressed inside of an existing
3376 **secondary_start()**
3377 To be attached to a mouse down event. Begin drag selecting
3378 a secondary selection.
3381 Select the entire file.
3384 To be attached to a key-press event, inserts the character
3385 equivalent of the key pressed.
3387 ----------------------------------------------------------------------
3395 NEdit can be customized many different ways. The most important
3396 user-settable options are presented in the Preferences menu, including all
3397 options that users might need to change during an editing session. Options
3398 set in the Default Settings sub-menu of the Preferences menu can be preserved
3399 between sessions by selecting Save Defaults, which writes the changes to the
3400 preferences file. See the section titled "Preferences_" for more details.
3402 User defined commands can be added to NEdit's Shell, Macro, and window
3403 background menus. Dialogs for creating items in these menus can be found
3404 under Customize Menus in the Default Settings sub menu of the Preferences
3407 For users who depend on NEdit every day and want to tune every excruciating
3408 detail, there are also X resources for tuning a vast number of such details,
3409 down to the color of each individual button. See the section "X_Resources_"
3410 for more information, as well as a list of selected resources.
3412 The most common reason customizing your X resources for NEdit, however, is
3413 key binding. While limited key binding can be done through Preferences
3414 settings (Preferences -> Default Settings -> Customize Menus), you can really
3415 only add keys this way, and each key must have a corresponding menu item.
3416 Any significant changes to key binding should be made via the Translations
3417 resource and menu accelerator resources. The sections titled "Key_Binding_"
3418 and "X_Resources_" have more information.
3419 ----------------------------------------------------------------------
3424 The Preferences menu allows you to set options for both the current editing
3425 window, and default values for newly created windows and future NEdit
3426 sessions. Options in the Preferences menu itself (not in the Default
3427 Settings sub-menu) take effect immediately and refer to the current window
3428 only. Options in the Default Settings sub-menu provide initial settings for
3429 future windows created using the New or Open commands; options affecting all
3430 windows are also set here.
3431 Preferences set in the Default Settings sub-menu can be saved in a file that
3432 is automatically read by NEdit at startup time, by selecting Save Defaults.
3436 **Default Settings**
3437 Menu of initial settings for future windows. Generally the same as the
3438 options in the main part of the menu, but apply as defaults for future
3439 windows created during this NEdit session. These settings can be saved using
3440 the Save Defaults command below, to be loaded automatically each time NEdit
3444 Save the default options as set under Default Settings for future NEdit
3448 Show the full file name, line number, and length of the file being edited.
3450 **Incremental Search Line**
3451 Keep the incremental search bar (Search -> Find Incremental) permanently
3452 displayed at the top of the window.
3454 **Show Line Numbers**
3455 Display line numbers to the right of the text.
3458 Tells NEdit what language (if any) to assume, for selecting language-specific
3459 features such as highlight patterns and smart indent macros, and setting
3460 language specific preferences like word delimiters, tab emulation, and
3461 auto-indent. See Features for Programming -> Programming_with_NEdit_ for
3465 Setting Auto Indent "on" maintains a running indent (pressing the Return key
3466 will line up the cursor with the indent level of the previous line). If
3467 smart indent macros are available for the current language mode, smart indent
3468 can be selected and NEdit will attempt to guess proper language indentation
3469 for each new line. See Help -> Features for Programming -> Automatic Indent
3470 for more information.
3473 Choose between two styles of automatic wrapping or none. Auto Newline wrap,
3474 wraps text at word boundaries when the cursor reaches the right margin, by
3475 replacing the space or tab at the last word boundary with a newline
3476 character. Continuous Wrap wraps long lines which extend past the right
3477 margin. Continuous Wrap mode is typically used to produce files where
3478 newlines are omitted within paragraphs, to make text filling automatic (a
3479 kind of poor-man's word processor). Text of this style is common on Macs and
3480 PCs but is not necessarily supported very well under Unix (except in programs
3481 which deal with e-mail, for which it is often the format of choice).
3484 Set margin for Auto Newline Wrap, Continuous Wrap, and Fill Paragraph. Lines
3485 may, be wrapped at the right margin of the window, or the margin can be set
3486 at a specific column.
3489 Set the tab distance (number of characters between tab stops) for tab
3490 characters, and control tab emulation and use of tab characters in padding
3494 Change the font(s) used to display text (fonts for menus and dialogs must be
3495 set using X resources for the text area of the window). See below for more
3498 **Highlight Syntax**
3499 If NEdit recognizes the language being edited, and highlighting patterns are
3500 available for that language, use fonts and colors to enhance viewing of the
3501 file. (See Help -> Features for Programming -> Syntax Highlighting for more
3504 **Make Backup Copy**
3505 On Save, write a backup copy of the file as it existed before the Save
3506 command with the extension .bck (Unix only).
3508 **Incremental Backup**
3509 Periodically make a backup copy of the file being edited under the name
3510 `~filename` on Unix or `_filename` on VMS (see Crash_Recovery_).
3512 **Show Matching (..)**
3513 Momentarily highlight matching parenthesis, brackets, and braces, or the
3514 range between them, when one of these characters is typed, or when the
3515 insertion cursor is positioned after it. Delimiter only highlights the
3516 matching delimiter, while Range highlights the whole range of text between
3517 the matching delimiters.
3519 Optionally, the matching can make use of syntax information if syntax
3520 highlighting is enabled. Alternatively, the matching is purely character
3521 based. In general, syntax based matching results in fewer false matches.
3524 In overtype mode, new characters entered replace the characters in front of
3525 the insertion cursor, rather than being inserted before them.
3528 Lock the file against accidental modification. This temporarily prevents the
3529 file from being modified in this NEdit session. Note that this is different
3530 from setting the file protection.
3532 3>Preferences -> Default Settings Menu
3534 Options in the Preferences -> Default Settings menu have the same meaning as
3535 those in the top-level Preferences menu, except that they apply to future
3536 NEdit windows and future NEdit sessions if saved with the Save Defaults
3537 command. Additional options which appear in this menu are:
3540 Define language recognition information (for determining language mode from
3541 file name or content) and set language specific preferences.
3544 How to react to multiple tags for the same name. Tags are described in the
3545 section: Features for Programmers -> Finding Declarations (ctags). In Show
3546 All mode, all matching tags are displayed in a dialog. In Smart mode, if one
3547 of the matching tags is in the current window, that tag is chosen, without
3548 displaying the dialog.
3551 Add/remove items from the Shell, Macro, and window background menus (see
3554 **Customize Window Title**
3555 Opens a dialog where the information to be displayed in the windows's title
3556 field can be defined and tested. The dialog contains a Help button, providing
3557 further information about the options available.
3560 Options for controlling the behavior of Find and Replace commands:
3563 Presents search results in dialog form, asks before wrapping a
3564 search back around the beginning (or end) of the file
3565 (unless Beep On Search Wrap is turned on).
3568 Search and Replace operations wrap around the beginning (or end) of the file.
3570 ~Beep On Search Wrap~ -
3571 Beep when Search and Replace operations wrap around the beginning (or end) of
3572 the file (only if Wrap Around is turned on).
3575 Don't pop down Replace and Find boxes after searching.
3577 ~Default Search Style~ -
3578 Initial setting for search type in Find and Replace dialogs.
3580 ~Default Replace Scope~ -
3581 [THIS OPTION IS ONLY PRESENT WHEN NEDIT WAS COMPILED WITH THE
3582 -DREPLACE_SCOPE FLAG TO SELECT AN ALTERNATIVE REPLACE DIALOG LAYOUT.]
3584 Initial setting for the scope in the Replace/Find dialog, when a selection
3585 exists. It can be either "In Window", "In Selection", or "Smart". "Smart"
3586 results in "In Window" if the size of the selection is smaller than 1 line,
3587 and to "In Selection" otherwise.
3589 **Syntax Highlighting**
3590 Program and configure enhanced text display for new or supported languages
3591 (See Features for Programming -> Syntax_Highlighting_).
3593 **Append Line Feed on Save**
3594 Some UNIX tools expect that files end with a line feed. If this option is
3595 activated, NEdit will append one if required.
3597 **Sort Open Prev. Menu**
3598 Option to order the File -> Open Previous menu alphabetically, versus in
3599 order of last access.
3601 **Popups Under Pointer**
3602 Display pop-up dialogs centered on the current mouse position, as opposed to
3603 centered on the parent window. This generally speeds interaction, and is
3604 essential for users who users who set their window managers so keyboard focus
3608 Options for controlling the popping up of warning dialogs:
3610 ~File Modified Externally~ -
3611 Pop up a warning dialog when files get changed external to NEdit.
3613 ~Check Modified File Contents~ -
3614 If external file modification warnings are requested, also check the file
3615 contents iso. only the modification date.
3618 Ask before exiting when two or more files are open in an NEdit session.
3620 **Initial Window Size**
3621 Default size for new windows.
3625 The font used to display text in NEdit is set under Preferences -> Text Font
3626 (for the current window), or Preferences -> Default Settings Text Font (for
3627 future windows). These dialogs also allow you to set fonts for syntax
3628 highlighting. If you don't intend to use syntax highlighting, you can ignore
3629 most of the dialog, and just set the field labeled Primary Font.
3631 Unless you are absolutely certain about the types of files that you will be
3632 editing with NEdit, you should choose a fixed-spacing font. Many, if not
3633 most, plain-text files are written expecting to be viewed with fixed
3634 character spacing, and will look wrong with proportional spacing. NEdit's
3635 filling, wrapping, and rectangular operations will also work strangely if you
3636 choose a proportional font.
3638 Note that in the font browser (the dialog brought up by the Browse...
3639 button), the subset of fonts which are shown is narrowed depending on the
3640 characteristics already selected. It is therefore important to know that you
3641 can unselect characteristics from the lists by clicking on the selected items
3644 Fonts for syntax highlighting should ideally match the primary font in both
3645 height and spacing. A mismatch in spacing will result in similar distortions
3646 as choosing a proportional font: column alignment will sometimes look wrong,
3647 and rectangular operations, wrapping, and filling will behave strangely. A
3648 mismatch in height will cause windows to re-size themselves slightly when
3649 syntax highlighting is turned on or off, and increase the inter- line spacing
3650 of the text. Unfortunately, on some systems it is hard to find sets of fonts
3651 which match exactly in height.
3655 You can add or change items in the Shell, Macro, and window background menus
3656 under Preferences -> Default Settings -> Customize Menus. When you choose
3657 one of these, you will see a dialog with a list of the current
3658 user-configurable items from the menu on the left. To change an existing
3659 item, select it from the list, and its properties will appear in the
3660 remaining fields of the dialog, where you may change them. Selecting the
3661 item "New" from the list allows you to enter new items in the menu.
3663 Hopefully most of the characteristics are self explanatory, but here are a
3666 Accelerator keys are keyboard shortcuts which appear on the right hand side
3667 of the menus, and allow you avoid pulling down the menu and activate the
3668 command with a single keystroke. Enter accelerators by typing the keys
3669 exactly as you would to activate the command.
3671 Mnemonics are a single letter which should be part of the menu item name,
3672 which allow users to traverse and activate menu items by typing keys when the
3673 menu is pulled down.
3675 In the Shell Command field of the Shell Commands dialog, the % character
3676 expands to the name (including directory path) of the file in the window. To
3677 include a % character in the command, use %%.
3679 The Menu Entry field can contain special characters for constructing
3680 hierarchical sub-menus, and for making items which appear only in certain
3681 language modes. The right angle bracket character ">" creates a sub-menu.
3682 The name of the item itself should be the last element of the path formed
3683 from successive sub-menu names joined with ">". Menu panes are called in to
3684 existence simply by naming them as part of a Menu Entry name. To put several
3685 items in the same sub-menu, repeat the same hierarchical sequence for each.
3686 For example, in the Macro Commands dialog, two items with menu entries: a>b>c
3687 and a>b>d would create a single sub menu under the macro menu called "a",
3688 which would contain a single sub-menu, b, holding the actual items, c and d:
3695 To qualify a menu entry with a language mode, simply add an at-sign "@@" at
3696 the end of the menu command, followed (no space) by a language mode name. To
3697 make a menu item which appears in several language modes, append additional
3698 @@s and language mode names. For example, an item with the menu entry:
3700 Make C Prototypes@@C@@C++
3702 would appear only in C and C++ language modes, and:
3704 Make Class Template@@C++
3706 would appear only in C++ mode.
3708 Menu items with no qualification appear in all language modes.
3710 If a menu item is followed by the single language qualification "@@*", that
3711 item will appear only if there are no applicable language-specific items of
3712 the same name in the same submenu. For example, if you have the following
3713 three entries in the same menu:
3715 Make Prototypes@@C@@C++
3716 Make Prototypes@@Java
3719 The first will be available when the language mode is C or C++, the second
3720 when the language mode is Java, and for all other language modes (including
3721 the "Plain" non-language mode). If the entry:
3725 also exists, this will always appear, meaning that the menu will always have
3726 two "Make Prototypes" entries, whatever the language mode.
3728 3>The NEdit Preferences File
3730 The NEdit saved preferences file is an X resource file, and its contents can
3731 be moved into another X resource file (see X_Resources_). One reason for
3732 doing so would be to attach server specific preferences, such as a default
3733 font to a particular X server. Another reason for moving preferences into the
3734 X resource file would be to keep preferences menu options and resource
3735 settable options together in one place.
3736 Though the files are the same format, additional resources should not be added
3737 to the preference file since NEdit modifies this file by overwriting it
3738 completely. Note also that the contents of the preference file take
3739 precedence over the values of X resources.
3740 Using Save Defaults after moving the contents of your preference file to your
3741 .Xdefaults file will re-create the preference file, interfering with the
3742 options that you have moved.
3743 The location of NEdit's preferences file depends on your environment:
3745 * The default place for the file is '$HOME/.nedit/nedit.rc',
3746 * if the variable $NEDIT_HOME is set in your environment it is located at '$NEDIT_HOME/nedit.rc',
3747 * you may also use old-style run control files; in this case, the preferences are stored in $HOME/.nedit.
3749 (For VMS, the file is in '$NEDIT_HOME/nedit.rc' if $NEDIT_HOME is set, in
3750 'SYS$LOGIN:.nedit' otherwise.)
3752 3>Sharing Customizations with Other NEdit Users
3754 If you have written macro or shell menu commands, highlight patterns, or
3755 smart-indent macros that you want to share with other NEdit users, you can
3756 make a file which they can load into their NEdit environment.
3758 To load such a file, start NEdit with the command:
3760 nedit -import <file>
3762 In the new NEdit session, verify that the imported patterns or macros do what
3763 you want, then select Preferences -> Save Defaults. Saving incorporates the
3764 changes into the nedit preferences file, so the next time you run NEdit, you
3765 will not have to import the distribution file.
3767 Loading a customization file is automated, but creating one is not. To
3768 produce a file to be imported by other users, you must make a copy of your own
3769 NEdit configuration file, and edit it, by hand, to remove everything but the
3770 few items of interest to the recipient. Leave only the individual
3771 resource(s), and within those resources, only the particular macro, pattern,
3772 style, etc, that you wish to exchange.
3774 For example, to share a highlighting pattern set, you would include the
3775 patterns, any new styles you added, and language mode information only if the
3776 patterns are intended to support a new language rather than updating an
3777 existing one. For example:
3779 nedit.highlightPatterns:\
3781 Comment:"#":"$"::Comment::\n\
3782 Loop Header:"^[ \\t]*loop:":::Loop::\n\
3784 nedit.languageModes: My Language:.my::::::
3785 nedit.styles: Loop:blue:Bold
3787 Resources are in the format of X resource files, but the format of text
3788 within multiple-item resources like highlight patterns, language modes,
3789 macros, styles, etc., are private to NEdit. Each resource is a string which
3790 ends at the first newline character not escaped with \, so you must be
3791 careful about how you treat ends of lines. While you can generally just cut
3792 and paste indented sections, if something which was originally in the middle
3793 of a resource string is now at the end, you must remove the \ line
3794 continuation character(s) so it will not join the next line into the
3795 resource. Conversely, if something which was originally at the end of a
3796 resource is now in the middle, you'll have to add continuation character(s)
3797 to make sure that the resource string is properly continued from beginning to
3798 end, and possibly newline character(s) (\n) to make sure that it is properly
3799 separated from the next item.
3800 ----------------------------------------------------------------------
3805 NEdit has additional options to those provided in the Preferences menu which
3806 are set using X resources. Like most other X programs, NEdit can be
3807 customized to vastly unnecessary proportions, from initial window positions
3808 down to the font and shadow colors of each individual button (A complete
3809 discussion of how to do this is left to books on the X Windows System). Key
3810 binding (see "Key_Binding_" is one of the most useful of these resource
3813 X resources are usually specified in a file called .Xdefaults or .Xresources
3814 in your home directory (on VMS this is sys$login:decw$xdefaults.dat). On
3815 some systems, this file is read and its information attached to the X server
3816 (your screen) when you start X. On other systems, the .Xdefaults file is
3817 read each time you run an X program. When X resource values are attached to
3818 the X server, changes to the resource file are not available to application
3819 programs until you either run the xrdb program with the appropriate file as
3820 input, or re-start the X server.
3822 3>Selected X Resource Names
3824 The following are selected NEdit resource names and default values for NEdit
3825 options not settable via the Preferences menu (for preference resource names,
3826 see your NEdit preference file):
3828 **nedit.tagFile**: (not defined)
3830 This can be the name of a file, or multiple files separated by a colon (:)
3831 character, of the type produced by Exuberant Ctags or the Unix ctags
3832 command, which NEdit will load at startup time (see ctag_support_ ). The tag
3833 file provides a database from which NEdit can automatically open files
3834 containing the definition of a particular subroutine or data type.
3836 **nedit.alwaysCheckRelativeTagsSpecs: True**
3838 When this resource is set to True, and there are tag files specified (with
3839 the nedit.tagFile resource, see above) as relative paths, NEdit will evaluate
3840 these tag value paths whenever a file is opened. All accessible tag files
3841 will be loaded at this time. When this resource value is False, relative path
3842 tag specifications will only be evaluated at NEdit startup time.
3844 **nedit.shell**: /bin/csh
3846 (Unix systems only) The Unix shell (command interpreter) to use for executing
3847 commands from the Shell menu
3849 **nedit.wordDelimiters**: .,/\\`'!@@#%^&*()-=+{}[]":;<>?
3851 The characters, in addition to blanks and tabs, which mark the boundaries
3852 between words for the move-by-word (Ctrl+Arrow) and select-word (double
3853 click) commands. Note that this default value may be overridden by the
3854 setting in Preferences -> Default Settings -> Language Modes....
3856 **nedit.remapDeleteKey**: False
3858 Setting this resource to True forcibly maps the delete key to backspace. This
3859 can be helpful on systems where the bindings have become tangled, and in
3860 environments which mix systems with PC style keyboards and systems with DEC
3861 and Macintosh keyboards. Theoretically, these bindings should be made using
3862 the standard X/Motif mechanisms, outside of NEdit. In practice, some
3863 environments where users access several different systems remotely, can be
3864 very hard to configure. If you've given up and are using a backspace key
3865 halfway off the keyboard because you can't figure out the bindings, set this
3868 **nedit.typingHidesPointer**: False
3870 Setting this resource to True causes the mouse pointer to be hidden when you
3871 type in the text area. As soon as the mouse pointer is moved, it will
3872 reappear. This is useful to stop the mouse pointer from obscuring text.
3874 **nedit.overrideDefaultVirtualKeyBindings**: Auto
3876 Motif uses a virtual key binding mechanism that shares the bindings between
3877 different Motif applications. When a first Motif application is started, it
3878 installs some default virtual key bindings and any other Motif application
3879 that runs afterwards, simply reuses them. Obviously, if the first
3880 application installs an invalid set, all others applications may have
3883 In the past, NEdit has been the victim of invalid bindings installed by other
3884 applications several times. Through this resource, NEdit can be instructed
3885 to ignore the bindings installed by other applications, and use its own
3886 private bindings. By default, NEdit tries to detect invalid bindings
3887 and ignore them automatically (Auto). Optionally, NEdit can be told to
3888 always keep the installed bindings (Never), or to always override them
3891 **nedit.stdOpenDialog**: False
3893 Setting this resource to True restores the standard Motif style of Open
3894 dialog. NEdit file open dialogs are missing a text field at the bottom of
3895 the dialog, where the file name can be entered as a string. The field is
3896 removed in NEdit to encourage users to type file names in the list, a
3897 non-standard, but much faster method for finding files.
3899 **nedit.bgMenuButton**: @~Shift@~Ctrl@~Meta@~Alt<Btn3Down>
3901 Specification for mouse button / key combination to post the background menu
3902 (in the form of an X translation table event specification). The event
3903 specification should be as specific as possible, since it will override less
3904 specific translation table entries.
3906 **nedit.maxPrevOpenFiles**: 30
3908 Number of files listed in the Open Previous sub-menu of the File menu.
3909 Setting this to zero disables the Open Previous menu item and maintenance of
3910 the NEdit file history file.
3912 **nedit.printCommand**: (system specific)
3914 Command used by the print dialog to print a file, such as, lp, lpr, etc..
3915 The command must be capable of accepting input via stdin (standard input).
3917 **nedit.printCopiesOption**: (system specific)
3919 Option name used to specify multiple copies to the print command. If the
3920 option should be separated from its argument by a space, leave a trailing
3921 space. If blank, no "Number of Copies" item will appear in the print dialog.
3923 **nedit.printQueueOption**: (system specific)
3925 Option name used to specify a print queue to the print command. If the
3926 option should be separated from its argument by a space, leave a trailing
3927 space. If blank, no "Queue" item will appear in the print dialog.
3929 **nedit.printNameOption**: (system specific)
3931 Option name used to specify a job name to the print command. If the option
3932 should be separated from its argument by a space, leave a trailing space. If
3933 blank, no job or file name will be attached to the print job or banner page.
3935 **nedit.printHostOption**: (system specific)
3937 Option name used to specify a host name to the print command. If the option
3938 should be separated from its argument by a space, leave a trailing space. If
3939 blank, no "Host" item will appear in the print dialog.
3941 **nedit.printDefaultQueue**: (system specific)
3943 The name of the default print queue. Used only to display in the print
3944 dialog, and has no effect on printing.
3946 **nedit.visualID**: Best
3948 If your screen supports multiple visuals (color mapping models), this
3949 resource allows you to manually choose among them. The default value of
3950 "Best" chooses the deepest (most colors) visual available. Since NEdit does
3951 not depend on the specific characteristics of any given color model, Best
3952 probably IS the best choice for everyone, and the only reason for setting
3953 this resource would be to patch around some kind of X server problem. The
3954 resource may also be set to "Default", which chooses the screen's default
3955 visual (often a color-mapped, PseudoColor, visual for compatibility with
3956 older X applications). It may also be set to a numeric visual-id value (use
3957 xdpyinfo to see the list of visuals supported by your display), or a visual
3958 class name: PseudoColor, DirectColor, TrueColor, etc..
3960 If you are running under a themed environment (like KDE or CDE) that places
3961 its colors in a shallow visual, and you'd rather have that color scheme
3962 instead of more colors available, then you may need set the visual to
3963 "Default" so that NEdit doesn't choose one with more colors. (The reason
3964 for this is: if the "best" visual is not the server's default, then NEdit
3965 cannot use the colors provided by your environment. NEdit will fall back to
3966 its own default color scheme.)
3968 **nedit.installColormap**: False
3970 Force the installation of a private colormap. If you have a humble 8-bit
3971 color display, and netscape is hogging all of the color cells, you may want
3972 to try turning this on. On most systems, this will result in colors flashing
3973 wildly when you switch between NEdit and other applications. But a few
3974 systems (SGI) have hardware support for multiple simultaneous colormaps, and
3975 applications with installed colormaps are well behaved.
3977 **nedit.findReplaceUsesSelection**: False
3979 Controls if the Find and Replace dialogs are automatically loaded with the
3980 contents of the primary selection.
3982 **nedit.stickyCaseSenseButton**: True
3984 Controls if the "Case Sensitive" buttons in the Find and Replace dialogs and
3985 the incremental search bar maintain a separate state for literal and regular
3986 expression searches. Moreover, when set to True, by default literal searches
3987 are case insensitive and regular expression searches are case sensitive. When
3988 set to False, the "Case Sensitive" buttons are independent of the "Regular
3991 **nedit.printDefaultHost**: (system specific)
3993 The node name of the default print host. Used only to display in the print
3994 dialog, and has no effect on printing.
3996 **nedit.multiClickTime**: (system specific)
3998 Maximum time in milliseconds allowed between mouse clicks within double and
3999 triple click actions.
4001 **nedit@*scrollBarPlacement**: BOTTOM_LEFT
4003 How scroll bars are placed in NEdit windows, as well as various lists and
4004 text fields in the program. Other choices are: BOTTOM_RIGHT, TOP_LEFT, or
4007 **nedit@*text.autoWrapPastedText**: False
4009 When Auto Newline Wrap is turned on, apply automatic wrapping (which
4010 normally only applies to typed text) to pasted text as well.
4012 **nedit@*text.foreground**: black
4014 Foreground color of the text editing area of the NEdit window.
4016 **nedit@*text.background**: white
4018 Background color of the text editing area of the NEdit window.
4020 **nedit@*text.selectForeground**: black
4022 Foreground (text) color for selections in the text editing area of the NEdit
4025 **nedit@*text.selectBackground**: gray80
4027 Color for selections in the text editing area of the NEdit window.
4029 **nedit@*text.highlightForeground**: white
4031 Foreground (text) color for highlights (parenthesis flashing) in the text
4032 editing area of the NEdit window.
4034 **nedit@*text.highlightBackground**: red
4036 Color for highlights (parenthesis flashing) in the text editing area of the
4039 **nedit@*text.cursorForeground**: black
4041 Color for text cursor in the text editing area of the NEdit window.
4043 **nedit@*text.lineNumForeground**: gray47
4045 Color for displaying line numbers in the NEdit window.
4047 **nedit@*text.heavyCursor**: False
4049 For monitors with poor resolution or users who have difficulty seeing the
4050 cursor, makes the cursor in the text editing area of the window heavier and
4053 **nedit@*text.cursorVPadding**: 0
4055 Number of lines to keep the cursor away from the top or bottom line of the
4056 window. Keyboard operations that would cause the cursor to get closer than
4057 this distance cause the window to scroll up or down instead, except at the
4058 beginning of the file. Mouse operations are not affected.
4060 **nedit@*text.blinkRate**: 500
4062 Blink rate of the text insertion cursor in milliseconds. Set to zero to stop
4065 **nedit@*text.Translations**:
4067 Modifies key bindings (see below).
4069 **nedit@*foreground**: black
4071 Default foreground color for menus, dialogs, scroll bars, etc..
4073 **nedit@*background**: #b3b3b3
4075 Default background color for menus, dialogs, scroll bars, etc..
4077 **nedit@*fontList**: helvetica medium 12 points
4079 Default font for menus, dialogs, scroll bars, etc..
4081 **nedit.helpFont**: helvetica medium 12 points
4083 Font used for displaying online help.
4085 **nedit.boldHelpFont**: helvetica bold 12 points
4087 Bold font for online help.
4089 **nedit.italicHelpFont**: helvetica italic 12 points
4091 Italic font for online help.
4093 **nedit.fixedHelpFont**: courier medium 12 points
4095 Fixed font for online help.
4097 **nedit.boldFixedHelpFont**: courier bold 12 points
4099 Fixed bold for online help.
4101 **nedit.italicFixedHelpFont**: courier italic 12 points
4103 Fixed italic font for online help.
4105 **nedit.h1HelpFont**: helvetica bold 14 points
4107 Font for level-1 titles in help text.
4109 **nedit.h2HelpFont**: helvetica bold italic 12 points
4111 Font for level-2 titles in help text.
4113 **nedit.h3HelpFont**: courier bold 12 points
4115 Font for level-3 titles in help text.
4117 **nedit.helpLinkFont**: helvetica medium 12 points
4119 Font for hyperlinks in the help text
4121 **nedit.helpLinkColor**: #009900
4123 Color for hyperlinks in the help text
4125 **nedit.backlightCharTypes**: 0-8,10-31,127:red;9:#dedede;32-126,160-255:#f0f0f0;128-159:orange
4127 A string specifying character classes as ranges of ASCII values followed by
4128 the color to be used as their background colors. The format is:
4130 low[-high]{,low[-high]}:color{;low-high{,low[-high]}:color}
4132 where low and high are ASCII values.
4135 32-255:#f0f0f0;1-31,127:red;128-159:orange;9-13:#e5e5e5
4137 The macro built-in function set_backlight_string() allows these strings to be
4138 set for a particular window.
4140 **nc.autoStart**: True
4142 Whether the nc program should automatically start an NEdit server (without
4143 prompting the user) if an appropriate server is not found.
4145 **nc.serverCommand**: nedit -server
4147 Command used by the nc program to start an NEdit server.
4151 Basic time-out period used in communication with an NEdit server (seconds).
4153 ----------------------------------------------------------------------
4154 ~The following are Selected widget names (to which you may append~
4155 ~.background, .foreground, .fontList, etc., to change colors, fonts~
4156 ~ and other characteristics):~
4158 **nedit@*statsAreaForm**
4160 Statistics line and incremental search bar. To get consistent results across
4161 the entire stats line and the incremental search bar, use '*' rather than '.'
4162 to separate the resource name. For example, to set the foreground color of
4163 both components use:
4164 nedit*statsAreaForm*foreground
4166 nedit*statsAreaForm.foreground
4170 Top-of-window menu-bar.
4172 **nedit@*textHorScrollBar**
4174 Horizontal scroll bar.
4176 **nedit@*textVertScrollBar**
4178 Vertical scroll bar.
4183 ----------------------------------------------------------------------
4188 There are several ways to change key bindings in NEdit. The easiest way to
4189 add a new key binding in NEdit is to define a macro in Preferences -> Default
4190 Settings -> Customize Menus -> Macro Menu. However, if you want to change
4191 existing bindings or add a significant number of new key bindings you will
4192 need to do so via X resources.
4194 Before reading this section, you must understand how to set X resources (see
4195 the help section "X_Resources_"). Since setting X resources is tricky, it is
4196 also helpful when working on key-binding, to set some easier-to-verify
4197 resource at the same time, as a simple check that the NEdit program is
4198 actually seeing your changes. The appres program is also very helpful in
4199 checking that the resource settings that you make, actually reach the program
4200 for which they are intended in the correct form.
4202 3>Key Binding in General
4204 Keyboard commands are associated with editor action routines through two
4205 separate mechanisms in NEdit. Commands which appear in pull-down menus have
4206 individual resources designating a keyboard equivalent to the menu command,
4207 called an accelerator key. Commands which do not have an associated menu
4208 item are bound to keys via the X toolkit translation mechanism. The methods
4209 for changing these two kinds of bindings are quite different.
4211 3>Key Binding Via Translations
4213 The most general way to bind actions to keys in NEdit is to use the
4214 translation table associated with the text widget. To add a binding to Alt+Y
4215 to insert the string "Hi!", for example, add lines similar to the following
4216 to your X resource file:
4218 NEdit*text.Translations: #override \n\
4219 Alt<Key>y: insert_string("Hi!") \n
4221 The Help topic "Action_Routines_" lists the actions available to be bound.
4223 Translation tables map key and mouse presses, window operations, and other
4224 kinds of events, to actions. The syntax for translation tables is
4225 simplified here, so you may need to refer to a book on the X window system
4226 for more detailed information.
4228 Note that accelerator resources (discussed below) override translations, and
4229 that most Ctrl+letter and Alt+letter combinations are already bound to an
4230 accelerator key. To use one of these combinations from a translation table,
4231 therefore, you must first un-bind the original menu accelerator.
4233 A resource for changing a translation table consists of a keyword; #override,
4234 #augment, or #replace; followed by lines (separated by newline characters)
4235 pairing events with actions. Events begin with modifiers, like Ctrl, Shift,
4236 or Alt, followed by the event type in <>. BtnDown, Btn1Down, Btn2Down,
4237 Btn1Up, Key, KeyUp are valid event types. For key presses, the event type is
4238 followed by the name of the key. You can specify a combination of events,
4239 such as a sequence of key presses, by separating them with commas. The other
4240 half of the event/action pair is a set of actions. These are separated from
4241 the event specification by a colon and from each other by spaces. Actions
4242 are names followed by parentheses, optionally containing one or more
4243 parameters separated by comas.
4245 3>Changing Menu Accelerator Keys
4247 The menu shortcut keys shown at the right of NEdit menu items can also be
4248 changed via X resources. Each menu item has two resources associated with
4249 it, accelerator, the event to trigger the menu item; and acceleratorText, the
4250 string shown in the menu. The form of the accelerator resource is the same
4251 as events for translation table entries discussed above, though multiple keys
4252 and other subtleties are not allowed. The resource name for a menu is the
4253 title in lower case, followed by "Menu", the resource name of menu item is
4254 the name in lower case, run together, with words separated by caps, and all
4255 punctuation removed. For example, to change Cut to Ctrl+X, you would add the
4256 following to your .Xdefaults file:
4258 nedit*editMenu.cut.accelerator: Ctrl<Key>x
4259 nedit*editMenu.cut.acceleratorText: Ctrl+X
4261 Accelerator keys with optional shift key modifiers, like Find..., have an
4262 additional accelerator resource with Shift appended to the name. For
4265 nedit*searchMenu.find.acceleratorText: [Shift]Alt+F
4266 nedit*searchMenu.find.accelerator: Alt<Key>f
4267 nedit*searchMenu.findShift.accelerator: Shift Alt<Key>f
4268 ----------------------------------------------------------------------
4270 Highlighting Patterns
4271 ---------------------
4273 3>Writing Syntax Highlighting Patterns
4275 Patterns are the mechanism by which language syntax highlighting is
4276 implemented in NEdit (see Syntax_Highlighting_ under the heading of Features
4277 for Programming). To create syntax highlighting patterns for a new
4278 language, or to modify existing patterns, select "Recognition Patterns" from
4279 "Syntax Highlighting" sub-section of the "Default Settings" sub-menu of the
4282 First, a word of caution. As with regular expression matching in general, it
4283 is quite possible to write patterns which are so inefficient that they
4284 essentially lock up the editor as they recursively re-examine the entire
4285 contents of the file thousands of times. With the multiplicity of patterns,
4286 the possibility of a lock-up is significantly increased in syntax
4287 highlighting. When working on highlighting patterns, be sure to save your
4290 NEdit's syntax highlighting is unusual in that it works in real-time (as you
4291 type), and yet is completely programmable using standard regular expression
4292 notation. Other syntax highlighting editors usually fall either into the
4293 category of fully programmable but unable to keep up in real-time, or
4294 real-time but limited programmability. The additional burden that NEdit
4295 places on pattern writers in order to achieve this speed/flexibility mix, is
4296 to force them to state self-imposed limitations on the amount of context that
4297 patterns may examine when re-parsing after a change. While the "Pattern
4298 Context Requirements" heading is near the end of this section, it is not
4299 optional, and must be understood before making any any serious effort at
4302 In its simplest form, a highlight pattern consists of a regular expression to
4303 match, along with a style representing the font an color for displaying any
4304 text which matches that expression. To bold the word, "highlight", wherever
4305 it appears the text, the regular expression simply would be the word
4306 "highlight". The style (selected from the menu under the heading of
4307 "Highlight Style") determines how the text will be drawn. To bold the text,
4308 either select an existing style, such as "Keyword", which bolds text, or
4309 create a new style and select it under Highlight Style.
4311 The full range of regular expression capabilities can be applied in such a
4312 pattern, with the single caveat that the expression must conclusively match
4313 or not match, within the pre-defined context distance (as discussed below
4314 under Pattern Context Requirements).
4316 To match longer ranges of text, particularly any constructs which exceed the
4317 requested context, you must use a pattern which highlights text between a
4318 starting and ending regular expression match. To do so, select "Highlight
4319 text between starting and ending REs" under "Matching", and enter both a
4320 starting and ending regular expression. For example, to highlight everything
4321 between double quotes, you would enter a double quote character in both the
4322 starting and ending regular expression fields. Patterns with both a
4323 beginning and ending expression span all characters between the two
4324 expressions, including newlines.
4326 Again, the limitation for automatic parsing to operate properly is that both
4327 expressions must match within the context distance stated for the pattern
4330 With the ability to span large distances, comes the responsibility to recover
4331 when things go wrong. Remember that syntax highlighting is called upon to
4332 parse incorrect or incomplete syntax as often as correct syntax. To stop a
4333 pattern short of matching its end expression, you can specify an error
4334 expression, which stops the pattern from gobbling up more than it should.
4335 For example, if the text between double quotes shouldn't contain newlines,
4336 the error expression might be "$". As with both starting and ending
4337 expressions, error expressions must also match within the requested context
4340 4>Coloring Sub-Expressions
4342 It is also possible to color areas of text within a regular expression
4343 match. A pattern of this type associates a style with sub-expressions
4344 references of the parent pattern (as used in regular expression substitution
4345 patterns, see the NEdit Help menu item on Regular_Expressions_).
4346 Sub-expressions of both the starting and ending patterns may be colored. For
4347 example, if the parent pattern has a starting expression "\<", and end
4348 expression "\>", (for highlighting all of the text contained within angle
4349 brackets), a sub-pattern using "&" in both the starting and ending expression
4350 fields could color the brackets differently from the intervening text. A
4351 quick shortcut to typing in pattern names in the Parent Pattern field is to
4352 use the middle mouse button to drag them from the Patterns list.
4354 4>Hierarchical Patterns
4356 A hierarchical sub-pattern, is identical to a top level pattern, but is
4357 invoked only between the beginning and ending expression matches of its
4358 parent pattern. Like the sub-expression coloring patterns discussed above,
4359 it is associated with a parent pattern using the Parent Pattern field in the
4360 pattern specification. Pattern names can be dragged from the pattern list
4361 with the middle mouse button to the Parent Pattern field.
4363 After the start expression of the parent pattern matches, the syntax
4364 highlighting parser searches for either the parent's end pattern or a
4365 matching sub-pattern. When a sub-pattern matches, control is not returned to
4366 the parent pattern until the entire sub-pattern has been parsed, regardless
4367 of whether the parent's end pattern appears in the text matched by the
4370 The most common use for this capability is for coloring sub-structure of
4371 language constructs (smaller patterns embedded in larger patterns).
4372 Hierarchical patterns can also simplify parsing by having sub-patterns "hide"
4373 special syntax from parent patterns, such as special escape sequences or
4376 There is no depth limit in nesting hierarchical sub-patterns, but beyond the
4377 third level of nesting, automatic re-parsing will sometimes have to re-parse
4378 more than the requested context distance to guarantee a correct parse (which
4379 can slow down the maximum rate at which the user can type if large sections
4380 of text are matched only by deeply nested patterns).
4382 While this is obviously not a complete hierarchical language parser it is
4383 still useful in many text coloring situations. As a pattern writer, your
4384 goal is not to completely cover the language syntax, but to generate
4385 colorings that are useful to the programmer. Simpler patterns are usually
4386 more efficient and also more robust when applied to incorrect code.
4388 4>Deferred (Pass-2) Parsing
4390 NEdit does pattern matching for syntax highlighting in two passes. The first
4391 pass is applied to the entire file when syntax highlighting is first turned
4392 on, and to new ranges of text when they are initially read or pasted in. The
4393 second pass is applied only as needed when text is exposed (scrolled in to
4396 If you have a particularly complex set of patterns, and parsing is beginning
4397 to add a noticeable delay to opening files or operations which change large
4398 regions of text, you can defer some of that parsing from startup time, to
4399 when it is actually needed for viewing the text. Deferred parsing can only
4400 be used with single expression patterns, or begin/end patterns which match
4401 entirely within the requested context distance. To defer the parsing of a
4402 pattern to when the text is exposed, click on the Pass-2 pattern type button
4403 in the highlight patterns dialog.
4405 Sometimes a pattern can't be deferred, not because of context requirements,
4406 but because it must run concurrently with pass-1 (non-deferred) patterns. If
4407 they didn't run concurrently, a pass-1 pattern might incorrectly match some
4408 of the characters which would normally be hidden inside of a sequence matched
4409 by the deferred pattern. For example, C has character constants enclosed in
4410 single quotes. These typically do not cross line boundaries, meaning they
4411 can be parsed entirely within the context distance of the C pattern set and
4412 should be good candidates for deferred parsing. However, they can't be
4413 deferred because they can contain sequences of characters which can trigger
4414 pass-one patterns. Specifically, the sequence, '\"', contains a double quote
4415 character, which would be matched by the string pattern and interpreted as
4416 introducing a string.
4418 4>Pattern Context Requirements
4420 The context requirements of a pattern set state how much additional text
4421 around any change must be examined to guarantee that the patterns will match
4422 what they are intended to match. Context requirements are a promise by NEdit
4423 to the pattern writer, that the regular expressions in his/her patterns will
4424 be matched against at least <line context> lines and <character context>
4425 characters, around any modified text. Combining line and character
4426 requirements guarantee that both will be met.
4428 Automatic re-parsing happens on EVERY KEYSTROKE, so the amount of context
4429 which must be examined is very critical to typing efficiency. The more
4430 complicated your patterns, the more critical the context becomes. To cover
4431 all of the keywords in a typical language, without affecting the maximum rate
4432 at which users can enter text, you may be limited to just a few lines and/or
4433 a few hundred characters of context.
4435 The default context distance is 1 line, with no minimum character
4436 requirement. There are several benefits to sticking with this default. One
4437 is simply that it is easy to understand and to comply with. Regular
4438 expression notation is designed around single line matching. To span lines
4439 in a regular expression, you must explicitly mention the newline character
4440 "\n", and matches which are restricted to a single line are virtually immune
4441 to lock-ups. Also, if you can code your patterns to work within a single
4442 line of context, without an additional character-range context requirement,
4443 the parser can take advantage the fact that patterns don't cross line
4444 boundaries, and nearly double its efficiency over a one-line and 1-character
4445 context requirement. (In a single line context, you are allowed to match
4446 newlines, but only as the first and/or last character.)
4447 ----------------------------------------------------------------------
4452 Smart indent macros can be written for any language, but are usually more
4453 difficult to write than highlighting patterns. A good place to start, of
4454 course, is to look at the existing macros for C and C++.
4456 Smart indent macros for a language mode consist of standard NEdit macro
4457 language code attached to any or all of the following three activation
4458 conditions: 1) When smart indent is first turned on for a text window
4459 containing code of the language, 2) When a newline is typed and smart indent
4460 is expected, 3) after any character is typed. To attach macro code to any of
4461 these code "hooks", enter it in the appropriate section in the Preferences ->
4462 Default Settings -> Auto Indent -> Program Smart Indent dialog.
4464 Typically most of the code should go in the initialization section, because
4465 that is the appropriate place for subroutine definitions, and smart indent
4466 macros are complicated enough that you are not likely to want to write them
4467 as one monolithic run of code. You may also put code in the Common/Shared
4468 Initialization section (accessible through the button in the upper left
4469 corner of the dialog). Unfortunately, since the C/C++ macros also reside in
4470 the common/shared section, when you add code there, you run some risk of
4471 missing out on future upgrades to these macros, because your changes will
4472 override the built-in defaults.
4474 The newline macro is invoked after the user types a newline, but before the
4475 newline is entered in the buffer. It takes a single argument ($1) which is
4476 the position at which the newline will be inserted. It must return the
4477 number of characters of indentation the line should have, or -1. A return
4478 value of -1 means to do a standard auto-indent. You must supply a newline
4479 macro, but the code: "return -1" (auto-indent), or "return 0" (no indent) is
4482 The type-in macro takes two arguments. $1 is the insert position, and $2 is
4483 the character just inserted, and does not return a value. You can do just
4484 about anything here, but keep in mind that this macro is executed for every
4485 keystroke typed, so if you try to get too fancy, you may degrade performance.
4486 ----------------------------------------------------------------------
4491 .. ? help !!#ifndef VMS
4492 **nedit** [-**read**] [-**create**] [-**line** n | +n] [-**server**]
4493 [-**do** command] [-**tags** file] [-**tabs** n] [-**wrap**]
4494 [-**nowrap**] [-**autowrap**] [-**autoindent**] [-**noautoindent**]
4495 [-**autosave**] [-**noautosave**] [-**rows** n] [-**columns** n]
4496 [-**font** font] [-**lm** languagemode] [-**geometry** geometry]
4497 [-**iconic**] [-**noiconic**] [-**display** [host]:server[.screen]
4498 [-**xrm** resourcestring] [-**svrname** name] [-**import** file]
4499 [-**background** color] [-**foreground** color] [-**V**|-**version**]
4503 Open the file Read Only regardless of the actual file protection.
4506 Don't warn about file creation when a file doesn't exist.
4512 Designate this session as an NEdit server, for processing commands from the
4513 nc program. nc can be used to interface NEdit to code development
4514 environments, mailers, etc., or just as a quick way to open files from the
4515 shell command line without starting a new NEdit session.
4518 Execute an NEdit macro or action. On each file following the -do argument on
4519 the command line. -do is particularly useful from the nc program, where nc
4520 -do can remotely execute commands in an NEdit -server session.
4523 Load a file of directions for finding definitions of program subroutines and
4524 data objects. The file must be of the format gen- erated by Exuberant Ctags,
4525 or the standard Unix ctags command.
4528 Set tab stops every n characters.
4531 Wrap long lines at the right edge of the window rather than continuing them
4532 past it. (Continuous Wrap mode)
4534 **-autowrap, -noautowrap**
4535 Wrap long lines when the cursor reaches the right edge of the window by
4536 inserting newlines at word boundaries. (Auto Newline Wrap mode)
4538 **-autoindent, -noautoindent**
4539 Maintain a running indent.
4541 **-autosave, -noautosave**
4542 Maintain a backup copy of the file being edited under the name '~filename'.
4545 Default height in characters for an editing window.
4548 Default width in characters for an editing window.
4550 **-font font (or -fn font)**
4551 Font for text being edited (Font for menus and dialogs can be set with -xrm
4554 **-lm languagemode**
4555 Initial language mode used for editing succeeding files.
4557 **-geometry geometry (or -g geometry)**
4558 The initial size and/or location of editor windows. The argument geometry
4561 [<width>x<height>][+|-][<xoffset>[+|-]<yoffset>]
4563 where <width> and <height> are the desired width and height of the window,
4564 and <xoffset> and <yoffset> are the distance from the edge of the screen to
4565 the window, + for top or left, - for bottom or right. -geometry can be
4566 specified for individual files on the command line.
4568 **-iconic, -noiconic**
4569 Initial window state for succeeding files.
4571 **-display [host]:server[.screen]**
4572 The name of the X server to use. host specifies the machine, server
4573 specifies the display server number, and screen specifies the screen number.
4574 host or screen can be omitted and default to the local machine, and screen 0.
4576 **-background color (or -bg color)**
4577 Background color. (background color for text can be set separately with
4578 -xrm "nedit*text.background: color").
4580 **-foreground color (or -fg color)**
4581 Foreground color. (foreground color for text can be set separately with -xrm
4582 "nedit*text.foreground: color").
4584 **-xrm resourcestring**
4585 Set the value of an X resource to override a default
4586 value (see "Customizing_NEdit_").
4589 When starting NEdit in server mode, name the server, such that it responds to
4590 requests only when nc is given a corresponding -svrname argument. By naming
4591 servers, you can run several simultaneously, and direct files and commands
4592 specifically to any one.
4595 Loads an additional preferences file on top of the existing defaults saved in
4596 your preferences file. To incorporate macros, language modes, and highlight
4597 patterns and styles written by other users, run NEdit with -import <file>,
4598 then re-save your preference file with Preferences -> Save Defaults.
4601 Prints out the NEdit version information. The -V option is synonymous.
4604 Treats all subsequent arguments as file names, even if they start with a
4605 dash. This is so NEdit can access files that begin with the dash character.
4610 .. This documentation for VMS NEdit usage should only appear in the
4611 .. generated help code, not in any of the printed documentation.
4612 .. Reasoning is that VMS usage is diminishing and there is a desire
4613 .. to not clutter up the printed documentation here.
4615 NEDIT [filespec[,...]]
4617 The following qualifiers are accepted:
4620 Open the file Read Only regardless of the actual file protection.
4623 Don't warn about file creation when a file doesn't exist.
4629 Designate this session as an NEdit server for processing commands from the nc
4630 program. The nc program can be used to interface NEdit to code development
4631 environments, mailers, etc., or just as a quick way to open files from the
4632 shell command line without starting a new NEdit session.
4635 Execute an NEdit action routine. on each file following the /do argument on
4636 the command line. /do is particularly useful from the nc program, where nc
4637 /do can remotely execute commands in an nedit /server session.
4640 Load a file of directions for finding definitions of program subroutines and
4641 data objects. The file must be of the format generated by the Unix ctags
4645 Wrap long lines at the right edge of the window rather than continuing them
4646 past it. (Continuous Wrap mode)
4648 **/autowrap, /noautowrap**
4649 Wrap long lines when the cursor reaches the right edge of the window by
4650 inserting newlines at word boundaries. (Auto Newline Wrap mode)
4652 **/autoindent, /noautoindent**
4653 Maintain a running indent.
4655 **/autosave, /noautosave**
4656 Maintain a backup copy of the file being edited under the name '_filename'.
4659 Default width in characters for an editing window.
4662 Default height in characters for an editing window.
4664 **/font=font (or /fn=font)**
4665 Font for text being edited (Font for menus and dialogs can be set with
4666 /xrm="*fontList:font").
4668 **/display [host]:server[.screen]**
4669 The name of the X server to use. host specifies the machine, server
4670 specifies the display server number, and screen specifies the screen number.
4671 host or screen can be omitted and default to the local machine, and screen 0.
4673 **/geometry=geometry (or /g=geometry)**
4674 The initial size and/or location of editor windows. The argument geometry
4677 [<width>x<height>][+|-][<xoffset>[+|-]<yoffset>]
4679 where <width> and <height> are the desired width and height of the window,
4680 and <xoffset> and <yoffset> are the distance from the edge of the screen to
4681 the window, + for top or left, - for bottom or right.
4683 **/background=color (or /bg=color)**
4685 Background color. (background color for text can be set separately with
4686 /xrm="nedit*text:background color").
4688 **/foreground=color (or /fg=color)**
4689 Foreground color. (foreground color for text can be set separately with
4690 /xrm="nedit*text:foreground color").
4692 **/xrm=resourcestring**
4693 Set the value of an X resource to override a default value
4694 (see Customizing NEdit).
4697 When starting nedit in server mode, name the server, such that it responds to
4698 requests only when nc is given a corresponding -svrname argument. By naming
4699 servers, you can run several simultaneously, and direct files and commands
4700 specifically to any one.
4703 Loads an additional preferences file on top of the existing defaults saved in
4704 your .nedit file. To incorporate macros, language modes, and highlight
4705 patterns and styles written by other users, run nedit with /import=<file>,
4706 then re-save your .nedit file with Preferences -> Save Defaults.
4708 Unix-style command lines (but not file names) are also acceptable:
4710 nedit -rows 20 -wrap file1.c file2.c
4714 nedit /rows=20/wrap file1.c, file2.c",
4717 ----------------------------------------------------------------------
4722 NEdit can be operated on its own, or as a two-part client/server
4723 application. Client/server mode is useful for integrating NEdit with
4724 software development environments, mailers, and other programs; or just as a
4725 quick way to open files from the shell command line without starting a new
4728 To run NEdit in server mode, type:
4732 NEdit can also be started in server mode via the Nedit Client (nc) program
4733 when no servers are available.
4735 The nc program, which is distributed along with NEdit,
4736 sends commands to an nedit server to open files, select lines, or execute
4737 editor actions. It accepts a limited set of the nedit command line options:
4738 -read, -create, -line (or +n), -do, and a list of file names. Listing a file
4739 on the nc command line means, open it if it is not already open and bring the
4740 window to the front. -read and -create affect only newly opened files, but
4741 -line and -do can also be used on files which are already open
4742 (See "NEdit_Command_Line_" for more information).
4744 In typical Unix style, arguments affect the files which follow them on the
4745 command line, for example:
4747 incorrect: nc file.c -line 25
4748 correct: nc -line 25 file.c
4750 -read, -create, and -line affect all of the files which follow them on the
4751 command line. The -do macro is executed only once, on the next file on the
4752 line. -do without a file following it on the command line, executes the
4753 macro on the first available window (presumably when you give a -do command
4754 without a corresponding file or window, you intend it to do something
4755 independent of the window in which it happens to execute).
4757 nc also accepts one command line option of its own, -noask (or -ask), which
4758 instructs it whether to automatically start a server if one is not
4759 available. This is also settable via the X resource, nc.autoStart
4760 (See "X_Resources_" section).
4762 Sometimes it is useful to have more than one NEdit server running, for
4763 example to keep mail and programming work separate. The option, -svrname, to
4764 both nedit and nc, allows you to start, and communicate with, separate named
4765 servers. A named server responds only to requests with the corresponding
4766 -svrname argument. If you use ClearCase and are within a ClearCase view, the
4767 server name will default to the name of the view (based on the value of the
4768 CLEARCASE_ROOT environment variable).
4770 Communication between nc and nedit is through the X display. So as long as X
4771 windows is set up and working properly, nc will work properly as well.
4772 nc uses the DISPLAY environment variable, the machine name and your user name
4773 to find the appropriate server, meaning, if you have several machines sharing
4774 a common file system, nc will not be able to find a server that is running on
4775 a machine with a different host name, even though it may be perfectly
4776 appropriate for editing a given file.
4778 The command which nc uses to start an nedit server is settable via the X
4779 resource nc.serverCommand, by default, "nedit -server".
4780 ----------------------------------------------------------------------
4785 If a system crash, network failure, X server crash, or program error should
4786 happen while you are editing a file, you can still recover most of your
4787 work. NEdit maintains a backup file which it updates periodically (every 8
4788 editing operations or 80 characters typed). This file has the same name
4789 as the file that you are editing, but with the character `~' (tilde) on Unix
4790 or `_' (underscore) on VMS prefixed to the name. To recover a file after a
4791 crash, simply rename the file to remove the tilde or underscore character,
4792 replacing the older version of the file. (Because several of the Unix shells
4793 consider the tilde to be a special character, you may have to prefix the
4794 character with a `\' (backslash) when you move or delete an NEdit backup
4797 Example, to recover the file called "help.c" on Unix type the command:
4801 A minor caveat, is that if the file you were editing was in MS DOS format,
4802 the backup file will be in Unix format, and you will need to open the backup
4803 file in NEdit and change the file format back to MS DOS via the Save As...
4804 dialog (or use the Unix unix2dos command outside of NEdit).
4805 ----------------------------------------------------------------------
4816 .. There is build time versioning information that is handled specially
4817 .. inside help.c for this section. It needs to have a '%s' string
4818 .. made available for it to appear in the on-line help.
4822 .. ======================================================================
4823 .. The policy for credit so far is this:
4825 .. You get "written by" credit if you have contributed significant
4826 .. code or effort to the project.
4828 .. You get a syntax/indent credit if your pattern is compiled into the
4830 .. ======================================================================
4832 NEdit was written by Mark Edel, Joy Kyriakopulos, Christopher Conrad,
4833 Jim Clark, Arnulfo Zepeda-Navratil, Suresh Ravoor, Tony Balinski, Max
4834 Vohlken, Yunliang Yu, Donna Reid, Arne Førlie, Eddy De Greef, Steve
4835 LoBasso, Alexander Mai, Scott Tringali, Thorsten Haude, Steve Haehn,
4838 The regular expression matching routines used in NEdit are adapted (with
4839 permission) from original code written by Henry Spencer at the
4840 University of Toronto.
4842 Syntax highlighting patterns and smart indent macros were contributed by:
4843 Simon T. MacDonald, Maurice Leysens, Matt Majka, Alfred Smeenk,
4844 Alain Fargues, Christopher Conrad, Scott Markinson, Konrad Bernloehr,
4845 Ivan Herman, Patrice Venant, Christian Denat, Philippe Couton,
4846 Max Vohlken, Markus Schwarzenberg, Himanshu Gohel, Steven C. Kapp,
4847 Michael Turomsha, John Fieber, Chris Ross, Nathaniel Gray, Joachim Lous,
4848 Mike Duigou, Seak Teng-Fong, Joor Loohuis, Mark Jones,
4849 and Niek van den Berg.
4851 NEdit sources, executables, additional documentation, and contributed
4852 software are available from the NEdit web site at http://www.nedit.org_.
4854 This program is free software; you can redistribute it and/or
4855 modify it under the terms of the GNU General Public License
4856 as published by the Free Software Foundation; either version 2
4857 of the License, or (at your option) any later version.
4859 This program is distributed in the hope that it will be useful,
4860 but WITHOUT ANY WARRANTY; without even the implied warranty of
4861 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
4862 GNU General Public License in the Help section "Distribution_Policy_"
4864 ----------------------------------------------------------------------
4869 GNU GENERAL PUBLIC LICENSE
4871 Version 2, June 1991
4873 Copyright (C) 1989, 1991 Free Software Foundation, Inc. 675 Mass Ave,
4874 Cambridge, MA 02139, USA. Everyone is permitted to copy and distribute
4875 verbatim copies of this license document, but changing it is not allowed.
4879 The licenses for most software are designed to take away your freedom to
4880 share and change it. By contrast, the GNU General Public License is intended
4881 to guarantee your freedom to share and change free software--to make sure the
4882 software is free for all its users. This General Public License applies to
4883 most of the Free Software Foundation's software and to any other program
4884 whose authors commit to using it. (Some other Free Software Foundation
4885 software is covered by the GNU Library General Public License instead.) You
4886 can apply it to your programs, too.
4888 When we speak of free software, we are referring to freedom, not price. Our
4889 General Public Licenses are designed to make sure that you have the freedom
4890 to distribute copies of free software (and charge for this service if you
4891 wish), that you receive source code or can get it if you want it, that you
4892 can change the software or use pieces of it in new free programs; and that
4893 you know you can do these things.
4895 To protect your rights, we need to make restrictions that forbid anyone to
4896 deny you these rights or to ask you to surrender the rights. These
4897 restrictions translate to certain responsibilities for you if you distribute
4898 copies of the software, or if you modify it.
4900 For example, if you distribute copies of such a program, whether gratis or
4901 for a fee, you must give the recipients all the rights that you have. You
4902 must make sure that they, too, receive or can get the source code. And you
4903 must show them these terms so they know their rights.
4905 We protect your rights with two steps: (1) copyright the software, and (2)
4906 offer you this license which gives you legal permission to copy, distribute
4907 and/or modify the software.
4909 Also, for each author's protection and ours, we want to make certain that
4910 everyone understands that there is no warranty for this free software. If the
4911 software is modified by someone else and passed on, we want its recipients to
4912 know that what they have is not the original, so that any problems introduced
4913 by others will not reflect on the original authors' reputations.
4915 Finally, any free program is threatened constantly by software patents. We
4916 wish to avoid the danger that redistributors of a free program will
4917 individually obtain patent licenses, in effect making the program
4918 proprietary. To prevent this, we have made it clear that any patent must be
4919 licensed for everyone's free use or not licensed at all.
4921 The precise terms and conditions for copying, distribution and modification
4924 GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND
4927 0. This License applies to any program or other work which contains a notice
4928 placed by the copyright holder saying it may be distributed under the terms
4929 of this General Public License. The "Program", below, refers to any such
4930 program or work, and a "work based on the Program" means either the Program
4931 or any derivative work under copyright law: that is to say, a work containing
4932 the Program or a portion of it, either verbatim or with modifications and/or
4933 translated into another language. (Hereinafter, translation is included
4934 without limitation in the term "modification".) Each licensee is addressed as
4937 Activities other than copying, distribution and modification are not covered
4938 by this License; they are outside its scope. The act of running the Program
4939 is not restricted, and the output from the Program is covered only if its
4940 contents constitute a work based on the Program (independent of having been
4941 made by running the Program). Whether that is true depends on what the
4944 1. You may copy and distribute verbatim copies of the Program's source code
4945 as you receive it, in any medium, provided that you conspicuously and
4946 appropriately publish on each copy an appropriate copyright notice and
4947 disclaimer of warranty; keep intact all the notices that refer to this
4948 License and to the absence of any warranty; and give any other recipients of
4949 the Program a copy of this License along with the Program.
4951 You may charge a fee for the physical act of transferring a copy, and you may
4952 at your option offer warranty protection in exchange for a fee.
4954 2. You may modify your copy or copies of the Program or any portion of it,
4955 thus forming a work based on the Program, and copy and distribute such
4956 modifications or work under the terms of Section 1 above, provided that you
4957 also meet all of these conditions:
4959 a) You must cause the modified files to carry prominent notices stating
4960 that you changed the files and the date of any change.
4962 b) You must cause any work that you distribute or publish, that in whole or
4963 in part contains or is derived from the Program or any part thereof, to be
4964 licensed as a whole at no charge to all third parties under the terms of
4967 c) If the modified program normally reads commands interactively when run,
4968 you must cause it, when started running for such interactive use in the
4969 most ordinary way, to print or display an announcement including an
4970 appropriate copyright notice and a notice that there is no warranty (or
4971 else, saying that you provide a warranty) and that users may redistribute
4972 the program under these conditions, and telling the user how to view a copy
4973 of this License. (Exception: if the Program itself is interactive but does
4974 not normally print such an announcement, your work based on the Program is
4975 not required to print an announcement.)
4977 These requirements apply to the modified work as a whole. If identifiable
4978 sections of that work are not derived from the Program, and can be reasonably
4979 considered independent and separate works in themselves, then this License,
4980 and its terms, do not apply to those sections when you distribute them as
4981 separate works. But when you distribute the same sections as part of a whole
4982 which is a work based on the Program, the distribution of the whole must be
4983 on the terms of this License, whose permissions for other licensees extend to
4984 the entire whole, and thus to each and every part regardless of who wrote it.
4986 Thus, it is not the intent of this section to claim rights or contest your
4987 rights to work written entirely by you; rather, the intent is to exercise the
4988 right to control the distribution of derivative or collective works based on
4991 In addition, mere aggregation of another work not based on the Program with
4992 the Program (or with a work based on the Program) on a volume of a storage or
4993 distribution medium does not bring the other work under the scope of this
4996 3. You may copy and distribute the Program (or a work based on it, under
4997 Section 2) in object code or executable form under the terms of Sections 1
4998 and 2 above provided that you also do one of the following:
5000 a) Accompany it with the complete corresponding machine-readable source
5001 code, which must be distributed under the terms of Sections 1 and 2 above
5002 on a medium customarily used for software interchange; or,
5004 b) Accompany it with a written offer, valid for at least three years, to
5005 give any third party, for a charge no more than your cost of physically
5006 performing source distribution, a complete machine-readable copy of the
5007 corresponding source code, to be distributed under the terms of Sections 1
5008 and 2 above on a medium customarily used for software interchange; or,
5010 c) Accompany it with the information you received as to the offer to
5011 distribute corresponding source code. (This alternative is allowed only for
5012 noncommercial distribution and only if you received the program in object
5013 code or executable form with such an offer, in accord with Subsection b
5016 The source code for a work means the preferred form of the work for making
5017 modifications to it. For an executable work, complete source code means all
5018 the source code for all modules it contains, plus any associated interface
5019 definition files, plus the scripts used to control compilation and
5020 installation of the executable. However, as a special exception, the source
5021 code distributed need not include anything that is normally distributed (in
5022 either source or binary form) with the major components (compiler, kernel,
5023 and so on) of the operating system on which the executable runs, unless that
5024 component itself accompanies the executable.
5026 If distribution of executable or object code is made by offering access to
5027 copy from a designated place, then offering equivalent access to copy the
5028 source code from the same place counts as distribution of the source code,
5029 even though third parties are not compelled to copy the source along with the
5032 4. You may not copy, modify, sublicense, or distribute the Program except as
5033 expressly provided under this License. Any attempt otherwise to copy, modify,
5034 sublicense or distribute the Program is void, and will automatically
5035 terminate your rights under this License. However, parties who have received
5036 copies, or rights, from you under this License will not have their licenses
5037 terminated so long as such parties remain in full compliance.
5039 5. You are not required to accept this License, since you have not signed it.
5040 However, nothing else grants you permission to modify or distribute the
5041 Program or its derivative works. These actions are prohibited by law if you
5042 do not accept this License. Therefore, by modifying or distributing the
5043 Program (or any work based on the Program), you indicate your acceptance of
5044 this License to do so, and all its terms and conditions for copying,
5045 distributing or modifying the Program or works based on it.
5047 6. Each time you redistribute the Program (or any work based on the Program),
5048 the recipient automatically receives a license from the original licensor to
5049 copy, distribute or modify the Program subject to these terms and conditions.
5050 You may not impose any further restrictions on the recipients' exercise of
5051 the rights granted herein. You are not responsible for enforcing compliance
5052 by third parties to this License.
5054 7. If, as a consequence of a court judgment or allegation of patent
5055 infringement or for any other reason (not limited to patent issues),
5056 conditions are imposed on you (whether by court order, agreement or
5057 otherwise) that contradict the conditions of this License, they do not excuse
5058 you from the conditions of this License. If you cannot distribute so as to
5059 satisfy simultaneously your obligations under this License and any other
5060 pertinent obligations, then as a consequence you may not distribute the
5061 Program at all. For example, if a patent license would not permit
5062 royalty-free redistribution of the Program by all those who receive copies
5063 directly or indirectly through you, then the only way you could satisfy both
5064 it and this License would be to refrain entirely from distribution of the
5067 If any portion of this section is held invalid or unenforceable under any
5068 particular circumstance, the balance of the section is intended to apply and
5069 the section as a whole is intended to apply in other circumstances.
5071 It is not the purpose of this section to induce you to infringe any patents
5072 or other property right claims or to contest validity of any such claims;
5073 this section has the sole purpose of protecting the integrity of the free
5074 software distribution system, which is implemented by public license
5075 practices. Many people have made generous contributions to the wide range of
5076 software distributed through that system in reliance on consistent
5077 application of that system; it is up to the author/donor to decide if he or
5078 she is willing to distribute software through any other system and a licensee
5079 cannot impose that choice.
5081 This section is intended to make thoroughly clear what is believed to be a
5082 consequence of the rest of this License.
5084 8. If the distribution and/or use of the Program is restricted in certain
5085 countries either by patents or by copyrighted interfaces, the original
5086 copyright holder who places the Program under this License may add an
5087 explicit geographical distribution limitation excluding those countries, so
5088 that distribution is permitted only in or among countries not thus excluded.
5089 In such case, this License incorporates the limitation as if written in the
5090 body of this License.
5092 9. The Free Software Foundation may publish revised and/or new versions of
5093 the General Public License from time to time. Such new versions will be
5094 similar in spirit to the present version, but may differ in detail to address
5095 new problems or concerns.
5097 Each version is given a distinguishing version number. If the Program
5098 specifies a version number of this License which applies to it and "any later
5099 version", you have the option of following the terms and conditions either of
5100 that version or of any later version published by the Free Software
5101 Foundation. If the Program does not specify a version number of this License,
5102 you may choose any version ever published by the Free Software Foundation.
5104 10. If you wish to incorporate parts of the Program into other free programs
5105 whose distribution conditions are different, write to the author to ask for
5106 permission. For software which is copyrighted by the Free Software
5107 Foundation, write to the Free Software Foundation; we sometimes make
5108 exceptions for this. Our decision will be guided by the two goals of
5109 preserving the free status of all derivatives of our free software and of
5110 promoting the sharing and reuse of software generally.
5114 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR
5115 THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE
5116 STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE
5117 PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED,
5118 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
5119 FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND
5120 PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE,
5121 YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
5123 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
5124 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
5125 REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
5126 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
5127 OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO
5128 LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR
5129 THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
5130 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
5131 POSSIBILITY OF SUCH DAMAGES.
5133 END OF TERMS AND CONDITIONS
5134 ----------------------------------------------------------------------
5139 There are two separate mailing lists for nedit users, and one for developers.
5140 Users may post to the developer mailing list to report defects and communicate
5141 with the nedit developers. Remember that nedit is entirely a volunteer
5142 effort, so please ask questions first to the discussion list, and do your
5143 share to answer other users questions as well.
5147 General discussion, questions and answers among NEdit users and developers.
5149 announce@@nedit.org_
5151 A low-volume mailing list for announcing new versions.
5155 Communication among and with NEdit developers.
5156 Developers should also subscribe to the discuss list.
5158 To subscribe, send mail to <majordomo@@nedit.org> with one or more of the
5159 following in the body of the message:
5164 ----------------------------------------------------------------------
5169 3>Solutions to Common Problems
5171 For a much more comprehensive list of common problems and solutions, see the
5172 NEdit FAQ. The latest version of the FAQ can always be found on the NEdit
5175 http://www.nedit.org_.
5177 **P: No files are shown in the "Files" list in the Open... dialog.**
5179 S: When you use the "Filter" field, include the file specification or a
5180 complete directory specification, including the trailing "/" on Unix.
5181 (See Help in the Open... dialog).
5183 **P: Find Again and Replace Again don't continue in the same direction as the original Find or Replace.**
5185 S: Find Again and Replace Again don't use the direction of the original
5186 search. The Shift key controls the direction: Ctrl+G means forward,
5187 Shift+Ctrl+G means backward.
5189 **P: Preferences specified in the Preferences menu don't seem to get saved when I select Save Defaults.**
5191 S: NEdit has two kinds of preferences: 1) per-window preferences, in the
5192 Preferences menu, and 2) default settings for preferences in newly created
5193 windows, in the Default Settings sub-menu of the Preferences menu.
5194 Per-window preferences are not saved by Save Defaults, only Default
5197 **P: Columns and indentation don't line up.**
5199 S: NEdit is using a proportional width font. Set the font to a fixed style
5200 (see Preferences menu).
5202 **P: NEdit performs poorly on very large files.**
5204 S: Turn off Incremental Backup. With Incremental Backup on, NEdit
5205 periodically writes a full copy of the file to disk.
5207 **P: Commands added to the Shell Commands menu (Unix only) don't output anything until they are finished executing.**
5209 S: If the command output is directed to a dialog, or the input is from a
5210 selection, output is collected together and held until the command
5211 completes. De-select both of the options and the output will be shown
5212 incrementally as the command executes.
5214 **P: Dialogs don't automatically get keyboard focus when they pop up.**
5216 S: Most X Window managers allow you to choose between two categories of
5217 keyboard focus models: pointer focus, and explicit focus. Pointer focus
5218 means that as you move the mouse around the screen, the window under the
5219 mouse automatically gets the keyboard focus. NEdit users who use this
5220 focus model should set "Popups Under Pointer" in the Default Settings sub
5221 menu of the preferences menu in NEdit. Users with the explicit focus
5222 model, in some cases, may have problems with certain dialogs, such as Find
5223 and Replace. In MWM this is caused by the mwm resource startupKeyFocus
5224 being set to False (generally a bad choice for explicit focus users).
5225 NCDwm users should use the focus model "click" instead of "explicit",
5226 again, unless you have set it that way to correct specific problems, this
5227 is the appropriate setting for most explicit focus users.
5229 **P: The Backspace key doesn't work, or deletes forward rather than backward.**
5231 S: While this is an X/Motif binding problem, and should be solved outside of
5232 NEdit in the Motif virtual binding layer (or possibly xmodmap or
5233 translations), NEdit provides an out. If you set the resource:
5234 nedit.remapDeleteKey to True, NEdit will forcibly map the delete key to
5235 backspace. The default setting of this resource recently changed, so
5236 users who have been depending on this remapping will now have to set it
5237 explicitly (or fix their bindings).
5239 **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.**
5241 S: On many SunOS systems, you have to set up an nls directory before various
5242 inter-client communication features of Motif will function properly.
5243 There are instructions in README.sun in /pub/v5_0_2/individual/README.sun on
5244 ftp.nedit.org, as well as a tar file containing a complete nls
5245 directory: ftp://ftp.nedit.org/pub/v5_0_2/nls.tar.
5246 README.sun contains directions for setting up an nls directory, which
5247 is required by Motif for handling copy and paste to Motif text fields.
5251 Below is the list of known defects which affect NEdit. The defects your copy
5252 of NEdit will exhibit depend on which system you are running and with which
5253 Motif libraries it was built. Note that there are now Motif 1.2 and/or 2.0
5254 libraries available on ALL supported platforms, and as you can see below
5255 there are far fewer defects in Motif 1.2, so it is in your best interest to
5256 upgrade your system.
5261 Operations between rectangular selections on overlapping lines do nothing.
5264 None. These operations are very complicated and rarely used.
5267 Cut and Paste menu items fail, or possibly crash,
5268 for very large (multi-megabyte) selections.
5271 Use selection copy (middle mouse button click)
5272 for transferring larger quantities of data.
5273 Cut and Paste save the copied text in server
5274 memory, which is usually limited.
5278 Submit bugs through the web at:
5280 http://sf.net/tracker/?func=add&group_id=11005&atid=111005
5282 Please include the first few lines from Help > Version, which identifes
5283 NEdit's version and other system attributes important for diagnosing your
5286 The NEdit developers subscribe to both discuss@@nedit.org and
5287 develop@@nedit.org, either of which may be used for reporting defects. If
5288 you're not sure, or you think the report might be of interest to the general
5289 NEdit user community, send the report to discuss@@nedit.org_. If it's
5290 something obvious and boring, like we misspelled "anemometer" in the on-line
5291 help, send it to develop@@nedit.org_. If you don't want to subscribe to the
5292 Mailing_Lists_, please add a note to your mail about cc'ing you on responses.
5296 .. Hyperlinks for this document ==============================================
5298 .. _discuss@@nedit.org mailto:discuss@@nedit.org
5299 .. _announce@@nedit.org mailto:announce@@nedit.org
5300 .. _develop@@nedit.org mailto:develop@@nedit.org
5301 .. _http://www.nedit.org http://www.nedit.org
5302 .. _ctag_support #ctags
5303 .. _Alternation #alternation
5305 .. =============================================================================
5307 .. Below is what is used to guide the generation of 'C'-Motif menus.
5308 .. Indentation is SIGNIFICANT in the "Menu" directive lines below. It
5309 .. is used to determine under which menu element another item will belong.
5310 .. The number of spaces indented is not significant, but items to be placed
5311 .. in the same menu panel MUST line up at the same indent level.
5312 .. ALL nodes of this menu "tree" should have help name qualifiers.
5313 .. These are used to produce the internal lists used by NEdit help code.
5315 .. By default, the first character of the menu element will be used as a
5316 .. menu mneumonic key. To use another character in the menu element for this
5317 .. purpose, surround the character with underscores (eg. I w_a_nt 'a').
5319 .. The menu title MUST match the one found in the actual help text (sans
5320 .. special mneumonic key character marking). The help text title may include
5321 .. underlines (for spaces) when it is a hyperlink target.
5323 .. The Help-name is used to generate various data structure names. For
5324 .. instance, the 'start' help name will be used to generate the HelpTopic
5325 .. enumeration value HELP_START and the character array htxt_start which
5326 .. holds the actual help text used in the menu dialogs. Consequently, these
5327 .. names need to be unique and contain only the characters that a 'C'
5328 .. compiler can digest.
5330 .. Menu separator lines use a dash (-) character for the Menu Title. They
5331 .. should also have a unique Help-name.
5333 .. A numerical value following the Help-name (separated from the name by
5334 .. a comma and/or spaces) is part of a menu element hiding scheme implemented
5335 .. in buildHelpMenu (found in 'menu.c'). When the number matches the hideIt
5336 .. value found in the procedure, that element will effectively become invisible.
5337 .. This mechanism was created for particular menu features that are not
5338 .. available to all incarnations of NEdit (in this case, the VMS version).
5340 .. A "Help" directive is used for all other text used as NEdit help, but
5341 .. does not show up in the Help menu.
5343 .. Menu Title # Help-name
5344 .. ------------------------------------------------------------
5345 .. Menu: Getting Started # start
5346 .. Menu: Basic Operation # basicOp
5347 .. Menu: Selecting Text # select
5348 .. Menu: Finding and Replacing Text # search
5349 .. Menu: Cut and Paste # clipboard
5350 .. Menu: Using the Mouse # mouse
5351 .. Menu: Keyboard Shortcuts # keyboard
5352 .. Menu: S_h_ifting and Filling # fill
5353 .. Menu: F_i_le Format # format
5355 .. Menu: Features for Programming # features
5356 .. Menu: Programming with NEdit # programmer
5357 .. Menu: Tabs/Emulated Tabs # tabs
5358 .. Menu: Auto/Smart Indent # indent
5359 .. Menu: Syntax Highlighting # syntax
5360 .. Menu: Finding Declarations (ctags) # tags
5361 .. Menu: Calltips # calltips
5363 .. Menu: Regular Expressions # regex
5364 .. Menu: Basic Regular Expression Syntax # basicSyntax
5365 .. Menu: Metacharacters # escapeSequences
5366 .. Menu: Parenthetical Constructs # parenConstructs
5367 .. Menu: Advanced Topics # advancedTopics
5368 .. Menu: Example Regular Expressions # examples
5370 .. Menu: Macro/Shell Extensions # extensions
5371 .. Menu: Shell Commands and Filters # shell, 1
5372 .. Menu: Learn/Replay # learn
5373 .. Menu: Macro Language # macro_lang
5374 .. Menu: M_a_cro Subroutines # macro_subrs
5375 .. Menu: Range Sets # rangeset
5376 .. Menu: Highlighting Information # hiliteInfo
5377 .. Menu: Action Routines # actions
5379 .. Menu: Customizing # customizing
5380 .. Menu: Customizing NEdit # customize
5381 .. Menu: Preferences # preferences
5382 .. Menu: X Resources # resources
5383 .. Menu: Key Binding # binding
5384 .. Menu: Highlighting Patterns # patterns
5385 .. Menu: Smart Indent Macros # smart_indent
5387 .. Menu: NEdit Command Line # command_line
5388 .. Menu: Client/Server Mode # server
5389 .. Menu: Cr_a_sh Recovery # recovery
5390 .. Menu: ---------------------------------- # separator1
5391 .. Menu: Version # version
5392 .. Menu: Distribution Policy # distribution
5393 .. Menu: Mailing _L_ists # mailing_list
5394 .. Menu: Problems/Defects # defects
5395 .. ------------------------------------------------------------
5396 .. Help: Tabs Dialog # tabs_dialog
5397 .. Help: Customize Window Title Dialog # custom_title_dialog