t
$XConsortium: xedit.man,v 1.23 94/04/17 20:43:39 matt Exp $
Copyright (c) 1994 X Consortium

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Except as contained in this notice, the name of the X Consortium shall
not be used in advertising or otherwise to promote the sale, use or
other dealings in this Software without prior written authorization
from the X Consortium.

$XFree86: xc/programs/xedit/xedit.man,v 1.18 2002/10/12 16:06:48 herrb Exp $

xedit - simple text editor for X xedit [ -toolkitoption .\|.\|. ] [ filename .\|.\|. ] Xedit provides a window consisting of the following four areas: A set of commands that allow you to exit xedit, save the file, or load a new file into the edit window. Displays xedit messages. In addition, this window can be also used as a scratch pad. Displays the name of the file currently being edited, and whether this file is Read-Write or Read Only. Displays the text of the file that you are editing or creating. Xedit accepts all of the standard X Toolkit command line options (see X (__miscmansuffix__)). The order of the command line options is not important.

8 filename Specifies the file(s) that are to be loaded during start-up. This is the file which will be edited. If a file is not specified, xedit lets you load files or create new files after it has started up.

The Athena Text widget is used for the three sections of this application that allow text input. The characters typed will go to the Text widget that has the input focus, or the Text widget that the pointer cursor is currently over.

The following keystroke combinations are defined:

Ctrl-a Beginning Of Line

Meta-b Backward Word

Ctrl-b Backward Character

Meta-f Forward Word

Ctrl-d Delete Next Character

Meta-i Insert File

Ctrl-e End Of Line

Meta-k Kill To End Of Paragraph

Ctrl-f Forward Character

Meta-q Form Paragraph

Ctrl-g Keyboard Reset

Meta-v Previous Page

Ctrl-h Delete Previous Character

Meta-y Insert Current Selection

Ctrl-j Newline And Indent

Meta-z Scroll One Line Down

Ctrl-k Kill To End Of Line

Meta-d Delete Next Word

Ctrl-l Redraw Display

Meta-D Kill Word

Ctrl-m Newline

Meta-h Delete Previous Word

Ctrl-n Next Line

Meta-H Backward Kill Word

Ctrl-o Newline And Backup

Meta-< Beginning Of File

Ctrl-p Previous Line

Meta-> End Of File

Ctrl-r Search/Replace Backward

Meta-] Forward Paragraph

Ctrl-s Search/Replace Forward

Meta-[ Backward Paragraph

Ctrl-t Transpose Characters

Ctrl-u [number] Multiply by 4 or number

Meta-Delete Delete Previous Word

Ctrl-v Next Page

Meta-Shift Delete Kill Previous Word

Ctrl-w Kill Selection

Meta-Backspace Delete Previous Word

Ctrl-y Unkill

Meta-Shift Backspace Kill Previous Word

Ctrl-z Scroll One Line Up

Meta-z Scroll One Line Down

Ctrl-_ Undo

Escape Line Edit Mode

In addition, the pointer may be used to cut and paste text:

Button 1 Down Start Selection

Button 1 Motion Adjust Selection

Button 1 Up End Selection (cut)

Button 2 Down Insert Current Selection (paste)

Button 3 Down Extend Current Selection

Button 3 Motion Adjust Selection

Button 3 Up End Selection (cut)

Line edit mode enables several shortcut commands for searching and replacing text in a xedit buffer. Line edit mode commands have the format:

 [line-number[,line-number]]command[parameters]

Line number may be specified as:

8 . The current text line.

8 $ The last line of the file.

8 number The literal line number.

8 - or ^ The previous line. Equivalent to -1.

8 -number or ^number The current line minus number.

8 + The next line. Equivalent to +1.

8 +number The current line plus number.

8 , or % From the first to the last line. Equivalent to 1,$.

8 ; From the current to the last line. Equivalent to .,$.

Command may be specified as:

8 s Substitute text in the specified lines.

8 /re/ Search forward for the regular expression pattern re.

8 ?re? Search backward for the regular expression pattern re.

Parameters may be specified as:

8 /re/ Works as a parameter to i or as a command.

8 /re/text/ Search forward for re and substitute by text.

Options may follow or be parameters, known values are:

8 i Case insensitive search.

8 g Global match when replacing text. Unless specified, only the nth, that defaults to 1, match will be replaced.

8 c Confirm before replacing text.

8 number Replace only the occurrence referenced by number.

Commands accept some variations, examples:

 /pattern/i
 i/pattern/
 i/pattern

Search forward for pattern.

 ,sc/pattern/text
 ,sc/pattern/text/
 ,s/pattern/text/c

Search the entire buffer and ask confirmation to replace pattern with text.

 ,s/pattern/text/number

Replace the match number in the text line. If not specified, defaults to the first occurrence.

When searching for text, type <Return> to go to the next match. When interactively replacing text, type y or Y to accept the change, and n or N to ignore it and go to the next match.

Quits the current editing session. If any changes have not been saved, xedit displays a warning message, allowing the user to save them. If file backups are enabled (see RESOURCES, below) xedit stores a copy of the original, unedited file in <prefix>file<suffix>, then overwrites the file with the contents of the edit window. The filename is retrieved from the Text widget directly to the right of the Load button. Loads the file named in the text widget immediately to the right of the this button and displays it in the Edit window. For xedit the available resources are:

8 tagsName (Class TagsName) Specifies the name of the tags file to search when loading a new file. Default value is tags.

8 loadTags (Class LoadTags) Boolean value to enable or disabling searching for tags files. Default is True.

8 enableBackups (Class EnableBackups) Specifies that, when edits made to an existing file are saved, xedit is to copy the original version of that file to <prefix>file<suffix> before it saves the changes. The default value for this resource is ``on,'' stating that backups should be created.

8 backupNamePrefix (Class BackupNamePrefix) Specifies a string that is to be prepended to the backup filename. The default is that no string shall be prepended.

8 backupNameSuffix (Class BackupNameSuffix) Specifies a string that is to be appended to the backup filename. The default is to use ``~'' as the suffix.

8 positionFormat (Class Format) Specifies a format string used to display the cursor position. This string uses printf(__libmansuffix__) like notation, where %l prints the line number, %c prints the column number, %p prints the insert position offset, and %s prints the current file size. It is also allowed to specify field sizes, with the notation %-?[0-9]+ . The default format string is ``L%l'', which shows the character ``L'' followed by the line number.

8 hints (Class Hints) Specifies a list of strings, separated by new lines, that will be displayed in the bc_label window.

8 hintsInterval (Class Interval) Specifies the interval in seconds, which the hint string in the bc_label window will be changed.

8 changedBitmap (Class Bitmap) Specifies the name of the Bitmap that will be displayed in the fileMenu, when the file being edited is changed.

8 autoReplace (Class Replace) This resource is useful to automatically correct common misspelling errors, but can also be used to create simple macros. The format is {non-blanks}{blanks}[{string}]. Fields are separated by newlines. Example of use: \"

nto not\\n\\
/macro some long string with \\\\\\n newlines \\\\\\n

\"

Will automatically replace the word nto by not, and /macro by some long string with newlines when you type that words.

8 ispell.dictionaries (Class ispell.Dictionary) Specifies a list of dictionary names, separated by spaces, available to the ispell program. The default value is "american americamed+ english".

8 ispell.dictionary (Class ispell.Dictionary) Specifies the default dictionary to use.

8 ispell*<DICTIONARY>.wordChars (Class ispell*Chars) Specifies a set of characters that can be part of a legal word. The <DICTIONARY> field is one of the dictionaries specified in the dictionaries resource.

8 ispell.ispellCommand (Class ispell.CommandLine) The path to the ispell program, and possibly, additional arguments. You don't need to specify the ``-w'' option, neither the ``-a'' option. Refer to the ispell(__appmansuffix__) manpage for more information on ispell options.

8 ispell.formatting (Class ispell.TextFormat) Specifies which text formatting to use while spell checking the file. The available formats are text and html.

8 ispell*text.skipLines (Class ispell*text.Skip) Lines starting with one of the characters in this string will not be spell checked. This resource is only used in text mode.

8 ispell.terseMode (Class ispell.Terse) When enabled, runs ispell in terse mode, not asking user interaction for words generated through compound formation (when using the ispell ``-C'' option), or words generated through affix removal. The default value is False.

8 ispell.lookCommand (Class ispell.CommandLine) The path to the program to search for alternate words, and possibly, additional arguments. The default program used is /usr/bin/egrep.

8 ispell.wordsFile (Class ispell.Words) The path to the file[s] to search for alternate words. The default file is /usr/share/dict/words.

8 ispell.guessLabel (Class ispell.Status) String displayed in the ispell status bar when ispell returns a guess list of one or more words. The default value is Guess.

8 ispell.missLabel (Class ispell.Status) String displayed in the ispell status bar when ispell returns a list of one or more words to match a misspelled one. The default value is Miss.

8 ispell.rootLabel (Class ispell.Status) String displayed in the ispell status bar when the word is not in the dictionary, but it can be formed through a root one. The default value is Root:, and is followed by a space and the root word.

8 ispell.noneLabel (Class ispell.Status) String displayed in the ispell status bar when there is no near misses. The default value is None.

8 ispell.compoundLabel (Class ispell.Status) String displayed in the ispell status bar when the word being checked is formed by concatenation of two words. The default value is Compound.

8 ispell.okLabel (Class ispell.Status) String displayed in the ispell status bar when the checked word is in the dictionary. This string is only displayed when using the check button in the xedit ispell interface. The default value is Ok.

8 ispell.eofLabel (Class ispell.Status) The string displayed in the ispell status bar when the end of the file is reached. The default value is End Of File.

8 ispell.repeatLabel (Class ispell.Status) The string displayed in the ispell status bar when two identical words are found together in the file. The default value is Repeat.

8 ispell.lookLabel (Class ispell.Status) The string displayed in the ispell status bar after displaying the results of the Look command. If no results are found, the value of the ispell.noneLabel resource is shown.

8 ispell.workingLabel (Class ispell.Status) The string displayed in the ispell status bar while xedit is communicating with ispell. The default value is ....

In order to specify resources, it is useful to know the hierarchy of the widgets which compose xedit. In the notation below, indentation indicates hierarchical structure. The widget class name is given first, followed by the widget instance name.

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

20 DISPLAY to get the default host and display number.

20 XENVIRONMENT to get the name of a resource file that overrides the global resources stored in the RESOURCE_MANAGER property.

20 __apploaddir__/Xedit specifies required resources

X (__miscmansuffix__), xrdb (__appmansuffix__), "Athena Widget Set" Xedit is not a replacement to Emacs. Chris D. Peterson, MIT X Consortium

Paulo Cesar Pereira de Andrade, The XFree86 Project