# Command Line Manual

Command Line allows commands to be run from a panel, and includes quick access to a file browser and command history.

2005
Davyd Madeley
2004
Angela Boyle
2002
2003
2004
Sun Microsystems
1998
Oliver Maruhn
1998
Dan Mueth
GNOME Documentation Project

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License (GFDL), Version 1.1 or any later version published by the Free Software Foundation with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. You can find a copy of the GFDL at this link or in the file COPYING-DOCS distributed with this manual.

This manual is part of a collection of GNOME manuals distributed under the GFDL. If you want to distribute this manual separately from the collection, you can do so by adding a copy of the license to the manual, as described in section 6 of the license.

Many of the names used by companies to distinguish their products and services are claimed as trademarks. Where those names appear in any GNOME documentation, and the members of the GNOME Documentation Project are made aware of those trademarks, then the names are in capital letters or initial capital letters.

DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT ARE PROVIDED UNDER THE TERMS OF THE GNU FREE DOCUMENTATION LICENSE WITH THE FURTHER UNDERSTANDING THAT:

1. DOCUMENT IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, WARRANTIES THAT THE DOCUMENT OR MODIFIED VERSION OF THE DOCUMENT IS FREE OF DEFECTS MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE OR NON-INFRINGING. THE ENTIRE RISK AS TO THE QUALITY, ACCURACY, AND PERFORMANCE OF THE DOCUMENT OR MODIFIED VERSION OF THE DOCUMENT IS WITH YOU. SHOULD ANY DOCUMENT OR MODIFIED VERSION PROVE DEFECTIVE IN ANY RESPECT, YOU (NOT THE INITIAL WRITER, AUTHOR OR ANY CONTRIBUTOR) ASSUME THE COST OF ANY NECESSARY SERVICING, REPAIR OR CORRECTION. THIS DISCLAIMER OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS LICENSE. NO USE OF ANY DOCUMENT OR MODIFIED VERSION OF THE DOCUMENT IS AUTHORIZED HEREUNDER EXCEPT UNDER THIS DISCLAIMER; AND

2. UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL THEORY, WHETHER IN TORT (INCLUDING NEGLIGENCE), CONTRACT, OR OTHERWISE, SHALL THE AUTHOR, INITIAL WRITER, ANY CONTRIBUTOR, OR ANY DISTRIBUTOR OF THE DOCUMENT OR MODIFIED VERSION OF THE DOCUMENT, OR ANY SUPPLIER OF ANY OF SUCH PARTIES, BE LIABLE TO ANY PERSON FOR ANY DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES OF ANY CHARACTER INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF GOODWILL, WORK STOPPAGE, COMPUTER FAILURE OR MALFUNCTION, OR ANY AND ALL OTHER DAMAGES OR LOSSES ARISING OUT OF OR RELATING TO USE OF THE DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT, EVEN IF SUCH PARTY SHALL HAVE BEEN INFORMED OF THE POSSIBILITY OF SUCH DAMAGES.

Sun
GNOME Documentation Team
Sun Microsystems
Oliver
Maruhn
GNOME Documentation Project

    oliver@maruhn.com

Dan
Mueth
GNOME Documentation Project

    d-mueth@uchicago.edu

Angela
Boyle
GNOME Documentation Project
Davyd
Madeley
GNOME Project

    davyd@madeley.id.au

Version 2.12
September 2005

Davyd Madeley

Version 2.10
March 2005

Davyd Madeley

Version 2.8
September 2004

Angela Boyle

GNOME Documentation Project

Command Line Applet Manual V2.7
August 2004

Sun Microsystems

GNOME Documentation Project

Command Line Applet Manual V2.6
September 2003

Sun Microsystems

GNOME Documentation Project

Command Line Applet Manual V2.5
August 2003

Sun Microsystems

GNOME Documentation Project

Command Line Applet Manual V2.4
April 2003

Sun Microsystems

GNOME Documentation Project

Command Line Applet Manual V2.3
January 2003

Sun Microsystems

GNOME Documentation Project

Command Line Applet Manual V2.2
August 2002

Sun Microsystems

GNOME Documentation Project

Command Line Applet Manual V2.1
July 2002

Sun Microsystems

GNOME Documentation Project

Command Line Applet Manual V2.0
March 2002

Sun Microsystems

GNOME Documentation Project

Mini-Commander Applet Manual
1998

Oliver Maruhn oliver@maruhn.com

GNOME Documentation Project

Dan Mueth d-mueth@uchicago.edu

GNOME Documentation Project

This manual describes version 2.12 of Command Line.

## Feedback

To report a bug or make a suggestion regarding the Command Line applet or this manual, follow the directions in the GNOME Feedback Page.

## Introduction

### Command Line

Shows Command Line.

The Command Line provides a command line that you can use within any panel on the desktop.

Command Line contains the following interactive elements:

Entry field

  You can enter commands, macros, and programs in the entry field.

Browser button — the bullet

  You can use the Browser button to look through your file system for programs. A solid-circle icon identifies the Browser button.

History button — the down arrow

  You can use the History button to recall previous commands. A down-arrow icon identifies the History button.

### Features

History list of previously executed commands

  You can execute commands directly from the history list display. You can also cycle the history list contents through the entry field to display and then execute a command. A vertical scrollbar appears when more than 20 commands are in the history list. See for more information.

History-based auto completion function

  Command Line uses the history-based auto completion function to complete commands in the entry field. This function compares the contents of the entry field with the history list. If Command Line finds a match then the applet completes the command. See the note in for more information.

User-requestable command completion function

  This command completion function compares character strings in the entry field with commands in the user path. The command completion function is useful if you do not know the exact character sequence or spelling of a command. After you type the first few letters of the command name, press the Tab key. If Command Line recognizes the character sequence as unique, then the applet completes the command name. See for more information.

Macro facility

  The macro facility provides up to 99 shortcut commands. In addition to predefined commands you can create your own commands for use with Command Line. See for more information.

### To Add Command Line to a Panel

To add Command Line to a panel, right-click on the panel, then choose Add to Panel. Select Command Line in the Add to the panel dialog, then click OK.

## Running Commands

### To Run a Command From the Entry Field

To run a command from the entry field, perform the following steps:

1. Type the command in the entry field.

   To instruct Command Line to try to complete the command name, press the Tab key.

2. Type the command-line options, if any, in the entry field.

3. Press Return.

If the command you entered could not be run, the computer will emit a single warning beep and the applet will indicate the command could not be run by showing a question mark (?) before the command. Check that you specified the command correctly. Clicking on the command line will cause the question mark to automatically disappear.

If the auto completion option is selected, Command Line searches for a match in the history list during steps 1 and 2. See for more information.

### History-based auto completion

You can enable or disable this option under the Preferences menu in the General tab under Auto Completion. Select Enable history-based auto completion to instruct Command Line to compare the entry field with the history list, and complete commands when there is a match.

If the auto completion option is selected, Command Line searches for a match in the history list during steps 1 and 2 in . If there is a match in the history list, Command Line completes the command. To accept the command, press Return. If you do not want to accept the command, type more characters in the entry field.

### To Run a Program From Your File System

Click on the Browser button to display the file system, then double-click on the program you want to run.

You can use Command Line to run scripts, execute commands, or run other programs from your file system.

### To Run a Previous Command, Macro, or Program From the History List

You can run a previously executed command, macro, or program from the history list in one of the following ways:

- Click on the History button to display the history list. Click on a history list item to run the command, macro, or program that you require.

- Click on the entry field, then use the keyboard up and down arrows to cycle through the history list. Press Return to run a specific command, macro, or program when the history list item you want is displayed in the entry field.

#### History-based auto completion

You can enable or disable this option under the Preferences menu in the General tab under Auto Completion. Select Enable history-based auto completion to instruct Command Line to compare the entry field with the history list, and complete commands when there is a match.

## Using Shortcuts or Macros

The macro facility provides up to 99 shortcut commands. In addition to predefined commands you can create your own commands for use with Command Line.

### To Run a Macro From the Entry Field

To run a macro that is defined in the Command Line list, type the macro in the entry field, then press Return.

The function also works for macros.

The following list shows some examples of Command Line macros:

`http://` or `www.` | Anything starting with `http://` or `www.` will be treated as a URL and loaded in your web browser.
`ftp://` or `ftp.` | Anything starting `ftp://` or `ftp.` will be treated as a URL and loaded in your default FTP software.
`dictionary:` | Use `dictionary:` to look up a word using GNOME Dictionary.
`google:` | Use `google:` to search for something using the Google search engine.
`av:` | Use `av:` to search for something using the Altavista search engine.
`yahoo:` | Use the `yahoo:` macro to search for things using the Yahoo search engine.
`fm:` | Use `fm:` to search for packages in the Freshmeat package database.

### Customizing Your Macros

#### Configuring Macros

Configuring Macros

This tabbed section contains a list of macros that you can use with Command Line. The list contains the following information:

- A list of UNIX regular expressions in the Pattern column.

  A regular expression is a pattern of characters or numbers that you use to match strings. See the `regex` man page for further information on how to construct a regular expression.

- A list of commands in the Command column.

  A command executes if the corresponding pattern successfully matches the text that you type into the entry field. The macros are commands that can take parameters parsed by the regular expression.

To add a new macro, click on the Add Macro button. To delete a macro, select the macro, then click on the Delete Macro button.

## Customizing the Appearance

### Preferences

Preferences Dialog To configure the appearance of Command Line, right-click on an area of the applet outside the interactive elements, then choose Preferences and select the General tab.

To move Command Line:

  Select Show handle to attach a handle to the edge of the applet. You can use the handle to drag the Command Line display to any location on your desktop.

To add a border:

  Select this option to show a frame around the Command Line.

To change the width:

  Use the Width . . . pixels spin box to specify the applet width.

To adjust the color theme:

  - Select Use default theme colors to use the colors from the default GNOME theme.

  - Click on the Command line foreground button to select a color for the command line text. This button is unavailable if the Use default theme colors check box is selected.

  - Click on the Command line background button to select a color for the entry field background. This button is unavailable if the Use default theme colors check box is selected.