# &app; Manual V&manrevision;

2002
2003
2004
Sun Microsystems
2000
Eric Baudais
GNOME Documentation Project
&legal; Sun GNOME Documentation Team Sun Microsystems Eric Baudais GNOME Documentation Project

     baudais@okstate.edu

Baris Cicek provided information from earlier revisions of the gedit application. Acknowledgements Ajit George provided information about plugins. Acknowledgements

&app; Manual V&manrevision;
&date;

Sun GNOME Documentation Team

GNOME Documentation Project

gedit Manual V2.6
September 2003

Sun GNOME Documentation Team

GNOME Documentation Project

gedit Manual V2.5
March 2003

Sun GNOME Documentation Team

GNOME Documentation Project

gedit Manual V2.4
January 2003

Sun GNOME Documentation Team

GNOME Documentation Project

gedit Manual V2.3
September 2002

Sun GNOME Documentation Team

GNOME Documentation Project

gedit Manual V2.2
August 2002

Sun GNOME Documentation Team

GNOME Documentation Project

gedit Manual V2.1
June 2002

Sun GNOME Documentation Team

GNOME Documentation Project

gedit Manual V2.0
March 2002

Sun GNOME Documentation Team

GNOME Documentation Project

gedit V1.0
2000

Eric Baudais baudais@okstate.edu

GNOME Documentation Project

This manual describes version &appversion; of &app;.

## Feedback

To report a bug or make a suggestion regarding the &app; application or this manual, follow the directions in the GNOME Feedback Page.

## Introduction

The &app; application enables you to create and edit text files. You can use &app; plugins to perform a variety of tasks related to text-editing from within the &app; window.

## Getting Started

### To Start &app;

You can start &app; in the following ways:

Applications menu

  Choose Accessories Text Editor.

Command line

  Execute the following command: `gedit`

### When You Start &app;

When you start &app;, the following window is displayed:

#### &app; Window

Shows gedit main window.

The &app; window contains the following elements:

Menubar

  The menus on the menubar contain all of the commands you need to work with files in &app;.

Toolbar

  The toolbar contains a subset of the commands that you can access from the menubar.

Display area

  The display area contains the text of the file that you are editing.

Output window

  The output window displays the output returned by the Shell command plugin and the Compare files plugin.

Statusbar

  The statusbar displays information about current &app; activity and contextual information about the menu items. The statusbar also displays the following information:

  - Cursor position: the line number and column number where the cursor is located.

  - Edit mode: If the editor is in insert mode, the statusbar contains the text INS. If the editor is in overwrite mode, the statusbar contains the text OVR. Press the Insert key to change edit mode.

When you right-click in the &app; window, the application displays a popup menu. The popup menu contains the most common text editing commands.

In &app;, you can perform the same action in several ways. For example, you can open a file in the following ways:

UI Component | Action
--- | ---
Window | Drag a file into the &app; window from another application such as a file manager.
Menubar | Choose File Open. If you have recently opened the file, choose File Open Recent.
Toolbar | Click on the Open toolbar button.
Right-click popup menu | Right-click on the file in a file manager window, then choose Open With from the popup menu.
Shortcut keys | Press Ctrl O.

This manual documents functionality from the menubar.

### To Open a File

To open a file, choose File Open to display the Open File dialog. Select the file that you want to open, then click Open. The file is displayed in the &app; window.

You can open multiple files in &app;. The application displays one file at a time in the application window. The application adds a tab for each open file to the window. To display another open file, click on the tab that corresponds to the file. To create a new &app; window for each file that is open, drag the tab corresponding to each file to the desktop background.

You can also use the Documents menu to move between the open files. You can choose Documents Move to New Window to move a document to a new &app; window.

The application records the paths and filenames of the five most recent files that you edited and displays the files as menu items on the File menu. You can also click on the Shows Recent Files menu icon. icon on the toolbar to display the list of recent files.

### To Open Multiple Files from a Command Line

You can run &app; from a command line and open a single file or multiple files. To open multiple files from a command line, type the following command, then press Return:

`gedit file1.txt file2.txt file3.txt`

When the application starts, the files that you specify are displayed in the &app; window.

For more information on how to run &app; from a command line, see &app;1.

## Usage

### To Create a New File

To create a new file, choose File New. The application displays a new file in the &app; window.

### To Save a File

You can save files in the following ways:

- To save changes to an existing file, choose File Save.

- To save a new file or to save an existing file under a new filename, choose File Save As . Enter a name for the file in the Save As dialog, then click Save.

- To save all of the files that are currently open in &app;, choose Documents Save All .

To close all of the files that are currently open in &app;, choose Documents Close All .

### To Edit Text

You can edit the text of a file in the following ways:

- Type new text from the keyboard.

- To copy the selected text to a buffer, choose Edit Copy .

- To delete the selected text from the file and move the selected text to a buffer, choose Edit Cut .

- To permanently delete the selected text from the file, choose Edit Delete .

- To insert the contents of the buffer at the cursor position, choose Edit Paste . You must cut or copy text before you can paste text into the file.

- To select all of the text in a file, choose Edit Select All .

### To Undo or Redo Edits

To undo an edit, choose Edit Undo . To redo an edit, choose Edit Redo . The number of previous edits that you can undo is determined by the Undo limit setting in the tabbed section of the Preferences dialog.

### To Find Text

To search a file for a string, perform the following steps:

1. Choose Search Find to display the Find dialog.

2. Type the string that you want to find, in the Search for field.

   You can include the following escape sequences:

   - `\n`

     Use this escape sequence to specify a new line.

   - `\t`

     Use this escape sequence to specify a tab character.

   - `\r`

     Use this escape sequence to specify a carriage return.

3. Select the Match case option to only find occurrences of the string that match the case of the text that you type.

4. Select the Match entire word only option to only find occurrences of the string that match the entire words of the text that you type.

5. Select the Search backwards option to search backwards to the beginning of the file.

6. Select the Wrap around option to search to one end of the file and then continue the search from the other end of the file.

7. Click Find to search the file for the first occurrence of the string. If &app; finds the string, the application moves the cursor to the string, and selects the string.

8. To find the next occurrence of the string, click Find or choose Search Find Next . To find the previous occurrence of the string, choose Search Find Previous .

9. To finish the search, click Close.

### To Find and Replace Text

To search a file for a string, and replace the string with an alternative string, perform the following steps:

1. Choose Search Replace to display the Replace dialog.

2. Type the string that you want to find, in the Search for field.

   You can include the following escape sequences:

   - `\n`

     Use this escape sequence to specify a new line.

   - `\t`

     Use this escape sequence to specify a tab character.

   - `\r`

     Use this escape sequence to specify a carriage return.

3. Type the string that you want to use to replace the string that you find, in the Replace with field.

4. Select the Match case option to only find occurrences of the string that match the case of the text that you enter.

5. Select the Match entire word only option to only find occurrences of the string that match the entire words of the text that you type.

6. Select the Search backwards option to search backwards to the beginning of the file.

7. Select the Wrap around option to search to one end of the file and then continue the search from the other end of the file.

8. Click Find to search the file for the first occurrence of the string. If &app; finds the string, the application moves the cursor to the string, and selects the string.

9. Click Replace to replace the occurrence of the string with the text in the Replace with field. Click Replace All to replace all occurrences of the string.

10. To find the next occurrence of the string, click Find.

11. To finish the search, click Close.

### To Open a File from a URI

To open a file from a Uniform Resource Identifier (URI), perform the following steps:

1. Choose File Open Location to display the Open Location dialog.

2. Enter the URI of the file that you want to open.

3. Use the Character coding drop-down list to select the appropriate character coding.

4. Click Open.

Alternatively, type `gedit URI` at a command line, where URI is the URI of the file that you want to open, then press Return. Valid types of URI include `http:`, `ftp:`, `file:`, and all of the methods supported by `gnome-vfs`.

The application opens the file located at the URI in read-only mode.

### To Pipe the Output of a Command to a File

You can use &app; to pipe the output of a command to a text file. For example, to pipe the output of an `ls` command to a text file, type `ls | gedit`, then press Return.

The output of the `ls` command is displayed in a new text file in the &app; window.

Alternatively, you can use the Shell command plugin to pipe command output to the current file. For information about how to use the Shell command plugin, see .

### To Position the Cursor on a Specific Line

To position the cursor on a specific line in the current file, perform the following steps:

1. Choose Search Go to Line to display the Go to Line dialog.

2. Type the number of the line that you want to move the cursor to in the Line number field.

3. Click Go to Line. The application moves the cursor to the line number that you specify.

4. To close the Go to Line dialog, click Close.

### To Set the Page Options

To set the page options, choose File Page Setup to display the Page Setup dialog.

The Page Setup dialog enables you to specify the following print options:

#### General Tabbed Section

Print syntax highlighting

  Select this option to print syntax highlighting. For more information about syntax highlighting, see .

Print page headers

  Select this option to include a header on each page that you print. You cannot configure the header.

Line Numbers

  Select the Print line numbers option to include line numbers when you print a file.

  Use the Number every ... lines spin box to specify how often to print the line numbers, for example every 5 lines, every 10 lines, and so on.

Text Wrapping

  Select the Enable text wrapping option to wrap text onto the next line, at a character level, when you print a file. The application counts wrapped lines as one line for line numbering purposes.

  Select the Do not split words over two lines option to wrap text onto the next line, at a word level, when you print a file.

#### Fonts

Body

  Click on this button to select the font to use to print the body text of a file.

Line numbers

  Click on this button to select the font to use to print line numbers.

Headers and footers

  Click on this button to select the font to use to print the headers and footers in a file.

To reset the fonts to the default fonts for printing a file from &app;, click Restore Default Fonts.

### To Print a File

You can use &app; to perform the following print operations:

- Print a file to a printer.

- Print the output of the print command to a file.

If you print to a file, &app; sends the output of the file to a pre-press format file. The most common pre-press formats are PostScript and Portable Document Format (PDF).

To preview the pages that you want to print, choose File Print Preview .

To print the current file to a printer or a file, choose File Print to display the Print dialog.

The Print dialog enables you to specify the following print options:

#### Job Tabbed Section

Print range

  Select one of the following options to determine how many pages to print:

  - All

    Select this option to print all of the pages in the file.

  - Lines

    Select this option to print the specified lines only. Use the From and To spin boxes to specify the line range.

  - Selection

    Select this option to print the selected text only. This option is only available if you select text.

Copies

  Use the Number of copies spin box to specify the number of copies of the file that you want to print.

  If you print multiple copies of the file, select the Collate option to collate the printed copies.

#### Printer Tabbed Section

Printer

  Use this drop-down list to select the printer to which you want to print the file.

Settings

  Use this drop-down list to select the printer settings.

  To configure the printer, click Configure. For example, you can enable or disable duplex printing, or schedule delayed printing, if this functionality is supported by the printer.

Location

  Use this drop-down list to select one of the following print destinations:

  CUPS

    Print the file to a CUPS printer.

    If the selected printer is a CUPS printer, CUPS is the only entry in this drop-down list.

  lpr

    Print the file to a printer.

  File

    Print the file to a PostScript file.

    Click Save As to display a dialog where you specify the name and location of the PostScript file.

  Custom

    Use the specified command to print the file.

    Type the name of the command in the text box. Include all command-line arguments.

State

  This functionality is not supported in this version of &app;.

Type

  This functionality is not supported in this version of &app;.

Comment

  This functionality is not supported in this version of &app;.

#### Paper Tabbed Section

Paper size

  Use this drop-down list to select the size of the paper to which you want to print the file.

Width

  Use this spin box to specify the width of the paper. Use the adjacent drop-down list to change the measurement unit.

Height

  Use this spin box to specify the height of the paper.

Feed orientation

  Use this drop-down list to select the orientation of the paper in the printer.

Page orientation

  Use this drop-down list to select the page orientation.

Layout

  Use this drop-down list to select the page layout. A preview of each layout that you select is displayed in the Preview area.

Paper tray

  Use this drop-down list to select the paper tray.

### To Customize the Toolbar

To display or hide the toolbar, choose View Toolbar . To customize how &app; displays the toolbar, choose View Customize Toolbar , then select one of the following menu items:

- Desktop Default

  Display the default toolbar.

- Icons Only

  Display icons only.

- Text for All Icons

  Display icons, and display text for all icons.

- Text for Important Icons

  Display icons, and display text for the important icons.

To display or hide the output window, choose View Output Window .

### To Set the Syntax Highlighting Mode

To set the syntax highlighting mode, choose View Highlight Mode , then select one of the following menu items:

Normal

  Do not display any syntax highlighting.

Sources

  Display syntax highlighting to edit source code. Use the Sources submenu to select one of the following source code types: Verilog, PHP, SQL, IDL, C, Ada, C++, C#, or Java.

Markup

  Display syntax highlighting to edit markup code. Use the Markup submenu to select one of the following markup code types: HTML, LaTeX, or XML.

Scripts

  Display syntax highlighting to edit script code. Use the Scripts submenu to select one of the following script code types: Python or Perl.

Others

  Display syntax highlighting to edit other types of code. Use the Others submenu to select one of the following code types: MSIL, gettext translation, .desktop, or Diff.

For more information about how to configure syntax highlighting, see .

## Preferences

To configure &app;, choose Edit Preferences . The Preferences dialog contains the following categories:

### Editor

Tabs

  Use the Tabs width spin box to specify the width of the space that &app; inserts when you press the Tab key.

  Select the Insert spaces instead of tabs option to specify that &app; inserts spaces instead of a tab character when you press the Tab key.

Auto Indentation

  Select the Enable auto indentation option to specify that the next line starts at the indentation level of the current line.

File Saving

  Select the Create a backup copy of files before saving option to create a backup copy of a file each time you save the file. The backup copy of the file contains a ~ at the end of the filename.

  Select the Autosave files every ... minutes option to automatically save the current file at regular intervals. Use the spin box to specify how often you want to save the file.

Undo

  Select the Limit to ... actions option to set a limit on the number of editing actions that you can undo. Use the spin box to specify the maximum number of actions that you can undo.

  Select the Unlimited undo option to set no limit on the number of editing actions that you can undo.

### View

Text Wrapping

  Select the Enable text wrapping option to wrap text onto the next line, at a character level, when you reach the text window boundary.

  Select the Do not split words over two lines option to wrap text onto the next line, at a word level, when you reach the text window boundary.

Line Numbers

  Select the Display line numbers option to display line numbers on the left side of the &app; window.

Right Margin

  Select the Display right margin option to display a vertical line that indicates the right margin.

  Use the Right margin at column spin box to specify the location of the vertical line.

### Font & Colors

Font

  Select the Use default theme font option to use the default system font for the text in the &app; text window.

  The Editor font field displays the font that &app; uses to display text. Click on the button to specify the font type, style, and size to use for text.

Colors

  Select the Use default theme colors option to use the default theme colors in the &app; text window.

  Click on the Normal text color color button to display the color selector dialog. Select a color to use to display normal text in the &app; text window.

  Click on the Background color color button to display the color selector dialog. Select a background color for the &app; text window.

  Click on the Selected text color color button to display the color selector dialog. Select a color to use to display selected text.

  Click on the Selection color color button to display the color selector dialog. Select a background color to use to highlight a text selection.

### Syntax Highlighting

Enable syntax highlighting

  Select this option to highlight the syntax of the text that you edit.

Highlight mode

  Use this drop-down list to select a syntax mode to configure.

Elements

  Use this list box to select a syntax element to configure.

Format buttons

  Use the following buttons to change the format of the selected syntax element:

  Button | Format
  --- | ---
  Shows icon for bold format. | Bold
  Shows icon for italic format. | Italic
  Shows icon for underline. | Underline
  Shows icon for strikethrough. | Strikethrough

Foreground

  Select this option to change the font color of the selected syntax element. Click on the color button to display the color selector dialog, then select the font color.

Background

  Select this option to change the background color of the selected syntax element. Click on the color button to display the color selector dialog, then select the background color.

Reset to Default

  Click on this button to reset the foreground color and background color of the selected syntax element to the default values.

### Plugins

For information about how to use the Plugins category of the Preferences dialog, see .

## Working with Plugins

A plugin is a supplementary program that enhances the functionality of an application. The &app; plugins enable you to perform a variety of functions related to text editing from within the &app; window. The following table lists the &app; plugins.

Plugin Name | Purpose
--- | ---
ASCII table | Displays a dialog that contains an ASCII table. You can use the ASCII table to insert characters into a file.
Compare files | Compares two files and displays the differences between the files in the output window. This plugin uses the `diff` command to compare the files.
CVS ChangeLog | Opens the log messages associated with CVS commit commands.
Document Statistics | Counts the number of lines, words, characters with spaces, characters without spaces, and bytes in the current file. The plugin displays the results in a Document Statistics dialog.
Indent lines | Indents the selected lines, or removes the indentation from the selected lines.
Insert Date/Time | Inserts the current date and time into a file.
Shell command | Displays the text output of a shell command in the output window.
Sort | Sorts the selected text.
Spell checker | Checks the spelling in the selected text. You can configure &app; to check the spelling automatically, or you can check the spelling manually, in the specified language.
Tag list | Displays a window that contains a list of common tags. You can use the window to insert a tag into a file.
User name | Inserts the username of the current user into the file.

When you choose Edit Preferences , the Plugins tabbed section displays the following information:

- A table that contains two columns:

  Enabled

    Displays check boxes that you select to load the plugins.

  Plugin

    Displays a list of the plugins that you can use with &app;.

- An About Plugin button: use this button to display a brief description of the selected plugin, including details about the author of the plugin.

- A Configure Plugin button: use this button to open a configuration dialog for the selected plugin, if that plugin is configurable. For example, see and .

When you load a plugin, &app; adds the plugin to the appropriate &app; menu, as described in the following table.

Plugin Name | Added to Menu
--- | ---
ASCII table | View ASCII Table
Compare files | Tools Compare Files
CVS ChangeLog | File Open CVS ChangeLogs
Document Statistics | Tools Document Statistics
Indent lines | Edit Indent Edit Unindent
Insert Date/Time | Edit Insert Date and Time
Shell command | Tools Run Command
Sort | Edit Sort
Spell checker | Tools Check Spelling Tools Autocheck Spelling Tools Set Language
Tag list | View Tag List
User name | Edit Insert User Name

### To Load a &app; Plugin

To load a &app; plugin, perform the following steps:

1. Choose Edit Preferences .

2. Select the Plugins tab.

3. Select the check box next to the name of the plugin that you want to load.

4. Click Close to close the Preferences dialog.

### To Remove a &app; Plugin

A plugin remains loaded when you quit &app;.

To remove a &app; plugin, perform the following steps:

1. Choose Edit Preferences .

2. Select the Plugins tab.

3. Deselect the check box next to the name of the plugin that you want to remove.

4. Click Close to close the Preferences dialog.

### To Use the ASCII Table Plugin

The ASCII table plugin displays a dialog that contains an ASCII table. You can use the ASCII table to insert characters into a file. To use the ASCII table plugin, perform the following steps:

1. Load the ASCII table plugin.

2. Choose View ASCII Table to display the ASCII Table dialog.

3. Scroll through the list to find the character that you require, then select the character with a single click.

4. Click Insert char to insert the character at the cursor position in the current file.

5. When you finish entering ASCII characters, click Close to close the ASCII Table dialog.

### To Use the Compare Files Plugin

The Compare files plugin compares two files and displays the differences between the files in the output window. This plugin uses the `diff` command to compare the files. To use the Compare files plugin, perform the following steps:

1. Load the Compare files plugin.

2. Choose Tools Compare Files . When you choose this option for the first time, you are prompted to confirm the location of the `diff` command. You are not prompted for this location again. See for information about how to change this location later.

   Click OK to display the Compare Files dialog.

3. Specify the files that you want to compare. To specify an open file, select the From document option then select the file from the drop-down list. To specify a closed file, select the From a file on disk option then enter the location of the file in the text box.

4. To ignore changes in the amount of white space, select the Ignore blanks (-b option) option.

5. To use the unified output format, showing three lines of context, select the Use the unified output format (-u option) option.

6. Click Compare to compare the contents of the specified files. The command output is displayed in the output window.

For more information, see diff 1.

#### To Configure the Compare Files Plugin

To change the location of the command that the Compare files plugin uses, perform the following steps:

1. Choose Edit Preferences .

2. Select the Plugins tab.

3. Select the Compare Files plugin.

4. Click Configure Plugin to display the Set program location dialog.

5. Specify the location of the `diff` command in the Location to search for text box.

6. Click OK to close the Set program location dialog.

7. To close the Preferences dialog, click Close.

### To Use the CVS ChangeLog Plugin

The CVS ChangeLog plugin opens the log messages associated with CVS commit commands. This plugin enables you to easily paste text into the commit message from the ChangeLog file. To use the CVS ChangeLog plugin, perform the following steps:

1. Set the environment variable CVSEDITOR to &app;. For example, if you are using the `bash` shell, run the following command at the operating system prompt:

        export CVSEDITOR=&app;

2. Commit a file to CVS in the usual way. A &app; window opens, to enable you to enter the commit message.

3. Load the CVS ChangeLog plugin.

4. Choose File Open CVS ChangeLogs to open all of the ChangeLog files referenced in the commit message. &app; opens each ChangeLog file in a new tab.

5. Copy the ChangeLog entries that you want to add to the commit message from the &app; ChangeLog files.

6. Insert the copied ChangeLog entries in the &app; commit message tab.

7. Save your changes to the commit message, then close all files.

8. Quit &app;.

### To Use the Document Statistics Plugin

The Document Statistics plugin counts the number of lines, words, characters with spaces, characters without spaces, and bytes in the current file. The plugin displays the results in a Document Statistics dialog. To use the Document Statistics plugin, perform the following steps:

1. Load the Document Statistics plugin.

2. Choose Tools Document Statistics to display the Document Statistics dialog. The Document Statistics dialog displays the following information about the file:

   - Number of lines in the current document.

   - Number of words in the current document.

   - Number of characters, including spaces, in the current document.

   - Number of characters, not including spaces, in the current document.

   - Number of bytes in the current document.

3. You can continue to update the &app; file while the Document Statistics dialog is open. To refresh the contents of the Document Statistics dialog, click Update.

4. To close the Document Statistics dialog, click Close.

### To Use the Indent Lines Plugin

The Indent lines plugin indents the selected lines, or removes the indentation from the selected lines. To use the Indent lines plugin, perform the following steps:

1. Load the Indent lines plugin.

2. Select the lines that you want to indent. To indent or unindent a single line, place the cursor anywhere on that line.

3. Choose Edit Indent .

4. To remove the indentation, select the lines and choose Edit Unindent .

### To Use the Insert Date/Time Plugin

The Insert Date/Time plugin inserts the current date and time into a file. To use the Insert Date/Time plugin, perform the following steps:

1. Load the Insert Date/Time plugin.

2. Choose Edit Insert Date and Time .

   If you have not configured the Insert Date/Time plugin to automatically insert the date/time without prompting you for the format, &app; displays the Insert Date and Time dialog. Select the appropriate date/time format from the list. Click Insert to close the Insert Date and Time dialog. &app; inserts the date/time at the cursor position in the current file.

   If you have configured &app; to use one particular date/time format, the Insert Date and Time dialog is not displayed. The date/time is automatically entered at the cursor position in the current file.

   See for information about how to configure the Insert Date/Time plugin.

#### To Configure the Insert Date/Time Plugin

To configure the Insert Date/Time plugin, perform the following steps:

1. Choose Edit Preferences .

2. Select the Plugins tab.

3. Select the Insert Date/Time plugin.

4. Click Configure Plugin to display the Configure insert date/time plugin dialog.

5. Select one of the options, as follows:

   - To specify the date/time format each time you insert the date/time, select the Prompt for a format option.

   - To use the same &app;-provided date/time format each time you insert the date/time, select the Use the selected format option, then select the appropriate format from the list. When you select this option, &app; does not prompt you for the date/time format when you choose Edit Insert Date and Time .

   - To use the same customized date/time format each time you insert the date/time, select the Use custom format option, then enter the appropriate format in the text box. For more information about how to specify a custom format, see strftime 3. When you select this option, &app; does not prompt you for the date/time format when you choose Edit Insert Date and Time .

6. Click OK to close the Configure insert date/time plugin dialog.

7. To close the Preferences dialog, click Close.

### To Use the Shell Command Plugin

The Shell Command plugin enables you to capture the output from a shell command in &app;, by displaying the text output of the shell command in the output window. To use the Shell command plugin, perform the following steps:

1. Load the Shell command plugin.

2. Choose Tools Run Command to display the Run Command dialog.

3. Type the shell command that you want to execute in the Command field.

   You can include the following special characters:

   - `%f`

     Use these special characters to specify the filename of the current active document, including the path.

   - `%n`

     Use these special characters to specify the filename of the current active document, without the path. In this case, &app; looks for the file in the Working directory.

4. Edit the Working directory field if necessary. By default, the Shell command plugin executes the command you specify in the current directory.

5. Select the Show results in Output Window option to display the results of the command in the output window. If you do not select this option, &app; discards the results of the command.

6. Click Run. The Shell command plugin executes the command and inserts the text output into the output window.

7. Use the Shift key to select the text in the output window.

8. Click Copy selected lines to copy the selected text into the buffer.

9. Choose Edit Paste to paste the selected text into the file.

10. Click Close the output window to close the output window.

### To Use the Sort Plugin

The Sort plugin sorts the selected text.

You cannot undo the Sort operation, so you should save the file before performing the sort. To revert to the saved version of the file after the sort operation, choose File Revert .

To use the Sort plugin, perform the following steps:

1. Load the Sort plugin.

2. Choose Edit Sort to display the Sort dialog.

3. To arrange the text in reverse sort order, select the Reverse order option.

4. To delete duplicate lines, select the Remove duplicates option.

5. To ignore case sensitivity, select the Ignore case option.

6. To specify the start position of the sort, use the Start at column spin box.

7. To perform the sort operation, click Sort.

### To Use the Spell Checker Plugin

The Spell checker plugin checks the spelling in the selected text. You can configure &app; to check the spelling automatically, or you can check the spelling manually, in the specified language. The language setting, and the autocheck spelling properties, apply per document. To use the Spell checker plugin, perform the following steps:

1. Load the Spell checker plugin.

2. Choose Tools Set Language to display the Set language dialog. Select the appropriate language from the list. Click OK to close the Set language dialog.

3. To check the spelling automatically, choose Tools Autocheck Spelling . To unset the automatic spell check, choose Tools Autocheck Spelling again. When automatic spell checking is set, an icon is displayed beside the Autocheck Spelling menu item. Automatic spell checking is unset by default, each time &app; starts.

   Unknown spellings are displayed in a different color, and underlined. Right-click on an unknown spelling, then select Spelling Suggestions from the popup menu:

   - To replace the unknown spelling with another spelling in the list, select the replacement spelling from the Spelling Suggestions popup menu.

   - To add the unknown spelling to your personal dictionary, select Spelling Suggestions Add .

   - To ignore all occurrences of the unknown spelling, so that they are no longer flagged as unknown but are not added to your personal dictionary, select Spelling Suggestions Ignore All . The unknown word is ignored in the current &app; session only.

4. To check the spelling manually, choose Tools Check Spelling .

   If there are no spelling errors, an Information dialog displays a message stating that the document does not contain misspelled words. Click OK to close the Information dialog.

   If there are spelling errors, the Check Spelling dialog is displayed:

   - The Misspelled word is displayed at the top of the dialog.

   - A suggested known spelling is displayed in the Change to text box. You can replace this with another known spelling by selecting a spelling from the Suggestions list, or you can enter text directly into the Change to text box.

   - To check the spelling of the text in the Change to text box, click Check Word. If this is a known word, the Suggestions list is replaced with the text `(correct spelling)`. If the word is not known, new entries appear in the Suggestions list.

   - To ignore the current occurrence of the unknown word, click Ignore. To ignore all occurrences of the unknown word, click Ignore All. The unknown word is ignored in the current &app; session only.

   - To change the current occurrence of the unknown word to the text in the Change to text box, click Change. To change all occurrences of the unknown word to the text in the Change to text box, click Change All.

   - To add the unknown word to your personal dictionary, click Add word.

   - To close the Check Spelling dialog, click Close.

### To Use the Tag List Plugin

The Tag List plugin displays a window that contains a list of common tags. You can use the window to insert a tag into a file. To use the Tag List plugin, perform the following steps:

1. Load the Tag List plugin.

2. Choose View Tag List to display the Tag list plugin window.

3. Select the appropriate tag category from the drop-down list. For example, `HTML - Tags`.

4. Scroll through the tag list to find the required tag.

5. To insert a tag at the cursor position in the current file, double-click on the tag in the tag list. You can also insert a tag as follows:

   - To insert a tag in the current file and change the focus from the Tag list plugin window to the editor window, press Return.

   - To insert a tag in the current file and maintain the focus on the Tag list plugin window, press Shift Return.

6. To close the Tag list plugin window, click on the Close Window button in the window frame. Alternatively, press Ctrl W when the focus is on the Tag list plugin window.

### To Use the User Name Plugin

The User name plugin inserts the username of the current user into the file. To use the User name plugin, perform the following steps:

1. Load the User name plugin.

2. Choose Edit Insert User Name to insert your username at the cursor position in the current file.