# &application; Manual

&application; is a Remote Desktop Viewer

2007, 2008, 2009
Jonh Wendell (wendell@bani.com.br)
Jonh Wendell

&legal;

Vinicius
Depizzol
vdepizzol@gmail.com
Jonh
Wendell
wendell@bani.com.br
0.3
2009-08-23

Jonh Wendell wendell@bani.com.br

0.2
2008-01-15

Vinicius Depizzol vdepizzol@gmail.com

0.1
2007-12-16

Jaap A. Haitsma jaap@haitsma.org

Jaap A. Haitsma

## Feedback

To report a bug or make a suggestion regarding the &app; application or this manual, please file a bug at GNOME bugzilla page.

## Introduction

The &app; application is a Remote Desktop Viewer for the GNOME desktop that uses Virtual Network Computing (VNC) system (and possibly other protocols) to remotely control another computer.

&app; provides the following features:

- Connect to several machines at the same time.

- Store recently connections and allows to bookmark them.

- Browse local network for machines.

- Provide a GNOME Panel applet to quickly access your bookmarked machines.

- Extensible through its plugin structure.

## Getting Started

### Starting &app;

You can start &app; in the following ways:

Applications menu

  Choose Internet Remote Desktop Viewer.

Command line

  Execute the following command: `vinagre`

### Starting &app; from a command line

You can run &app; from a command line and connect to a single machine or multiple machines. To connect to a machine from a command line, type the following command, then press Return:

`vinagre hostname_or_ip_address`

For more information on how to run &app; from a command line, see the unix manual page for &app;, &app;1.

### The &app; Window

#### &app; window

Shows vinagre 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 remote connections in &app;.

Toolbar

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

Display Area

  The display area contains a list of tabs with the connected machines and its remote desktops.

Statusbar

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

Side Pane

  The side pane contains a list of bookmarked connections and (if available) a list of auto-discovered network machines.

### Some notes about &app;

As a tool to access other machines, &app; behaves slightly different than other GNOME applications in its default installation.

&app; comes with menu accelerators and keyboard shortcuts disabled by default. This avoids keys being intercepted by &app; when you wanted to send those keys to the remote machine.

For instance, the keyboard shortcut to close a tab is Ctrl+W, but that key combination will be sent to the remote machine by default.

If you want to change this behavior, go to &app; preferences in Edit Preferences .

## Using &app;

### To connect to a remote machine

#### Informing a host address

To connect with a remote machine, choose Ctrl N Machine Connect . The Connection Dialog is displayed. Inform the Protocol and the Host of the connection and click the Connect button. You will see a bunch of options depending on what protocol you have selected.

##### Connect dialog

Shows the connect dialog.

You can also use the Find button to browse available machines on local network.

The availabity of the Find button depends on the protocol you have selected. &app; relies on Avahi service to browse for machines in your local network. Also, notice that &app; can be compiled without Avahi support. In this case, this button will not be available.

Some machines may require a secure connection. In this case, an Authentication dialog will be displayed asking for the credentials. The type of credentials depends on the server. It may be a password and an username. If you check Remember this credential, &app; will store the secure information using GNOME Keyring Manager.

##### Authentication dialog

Shows the authentication dialog.

If the connection has been used previously, you can also access it by Machine Recent connections... .

#### Opening a Remote Connection File

Some hosts distribute remote connection files (generally ending with suffix ".vnc") instead of inform Host address and Port. To open a remote connection file, choose Ctrl O Machine Open . The Select File dialog is displayed. Select the file you want to open, then click on the Open button.

You can also double-click on a remote connection file in the Nautilus file manager to open it on the &app; window.

#### Using Bookmarks

You can access your mostly used connections through bookmarks. See the Bookmarks chapter.

### To Use Full Screen Mode

To zoom the Display Area to full screen mode, choose F11 View Full Screen or the corresponding tool bar button.

While in full screen mode, move the mouse to the top center of the screen to show a hidden tool bar, which has buttons to leave full screen mode, close the connection and other options.

### To Close a Connection

To close a connection, choose Machine Close .

### To Take Screenshot

To take screenshot of the current remote desktop, choose Machine Take Screenshot or press the relative button in the toolbar. The Save Screenshot dialog is displayed, click the Save button to save the screenshot.

## Using Bookmarks

### Using Bookmarks

Bookmarks are a resource to keep around machines you access frequently. They are visible at side panel or in the Bookmarks menu.

#### Bookmarks at side panel

Shows bookmarks at side panel.

As you move the mouse around the entries, a tooltip will show you the hostname of the connection. To connect to a machine, just double click on a entry.

### To Create a New Bookmark

To bookmark the currently viewed connection, choose Ctrl D Bookmarks Add to Bookmarks . The Saving to Bookmarks dialog is displayed. Inform the name of the connection and optionally other data, such as the folder and click Save.

#### Saving a bookmark

Shows the Saving to Bookmarks dialog.

You can use folders to organize your bookmarks. To create a folder, right click in the side panel and choose the option New Folder in the context menu, or go to menu Bookmarks New Folder .

### To Edit a Bookmark's Properties

To edit a bookmark's properties, such as it's name and host, choose Edit bookmark from the context menu of the bookmark in the Side Pane. The same dialog as shown above will be displayed.

#### Editing a bookmark

Context menu option to edit a bookmark

You can also edit a folder.

### To Remove a Bookmark

To remove a bookmark, choose Remove from bookmarks from the context menu of the bookmark in the Side Pane.

You can also remove a folder. Notice that removing a folder will remove all its entries. A confirmation dialog will be shown.

## Preferences

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

Always show tabs

  Select this option to make the tabs always visible, even when only one connection is active.

Show menu shortcuts

  By selecting this option, keyboard shortcuts, like Ctrl+D and menu accelerators, like Alt+M to access the Machine menu, will be enabled. This means that &app; will catch those key combinations, instead of sending them to the remote machine. Because most of the time you will be working on the remote machine, this option comes disabled by default.

## About

&app; was written by Jonh Wendell wendell@bani.com.br. To find more information about &app;, please visit the &application; web page.

To report a bug or make a suggestion regarding this application you can file a bug in our bug tracker.

This program is distributed under the terms of the GNU General Public license as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. A copy of this license can be found at the GNU site, or in the file COPYING included with the source code of this program.