vinagre r137 - in trunk/help: . C C/figures
- From: jwendell svn gnome org
- To: svn-commits-list gnome org
- Subject: vinagre r137 - in trunk/help: . C C/figures
- Date: Fri, 18 Jan 2008 12:12:50 +0000 (GMT)
Author: jwendell
Date: Fri Jan 18 12:12:50 2008
New Revision: 137
URL: http://svn.gnome.org/viewvc/vinagre?rev=137&view=rev
Log:
2008-01-18 Jonh Wendell <jwendell gnome org>
* Documentation finished, thanks to Vinicius Depizzol and GHOP. Closes #503806.
Modified:
trunk/help/C/figures/vinagre-screenshot.png
trunk/help/C/vinagre.xml
trunk/help/Changelog
Modified: trunk/help/C/figures/vinagre-screenshot.png
==============================================================================
Binary files. No diff available.
Modified: trunk/help/C/vinagre.xml
==============================================================================
--- trunk/help/C/vinagre.xml (original)
+++ trunk/help/C/vinagre.xml Fri Jan 18 12:12:50 2008
@@ -29,7 +29,7 @@
</para>
</abstract>
<copyright>
- <year>2007</year>
+ <year>2007, 2008</year>
<holder>Jonh Wendell (wendell bani com br)</holder>
</copyright>
@@ -55,10 +55,10 @@
any of this. -->
<authorgroup>
- <author role="maintainer">
- <firstname>Jonh</firstname>
- <surname>Wendell</surname>
- <email>wendell bani com br</email>
+ <author>
+ <firstname>Vinicius</firstname>
+ <surname>Depizzol</surname>
+ <email>vdepizzol gmail com</email>
</author>
<!-- This is appropriate place for other contributors: translators,
@@ -77,6 +77,15 @@
<revhistory>
<revision>
+ <revnumber>0.2</revnumber>
+ <date>2008-01-15</date>
+ <revdescription>
+ <para role="author">Vinicius Depizzol
+ <email>vdepizzol gmail com</email>
+ </para>
+ </revdescription>
+ </revision>
+ <revision>
<revnumber>0.1</revnumber>
<date>2007-12-16</date>
<revdescription>
@@ -104,7 +113,7 @@
<primary>&application;</primary>
</indexterm>
<indexterm zone="index">
- <primary>vinagre</primary>
+ <primary>remote desktop</primary>
</indexterm>
<!-- ============= Document Body ============================= -->
@@ -120,54 +129,222 @@
<tertiary>vinagre</tertiary>
</indexterm>
- <para>
- &app; is remote desktop viewer for the <systemitem>GNOME desktop</systemitem>
- </para>
+ <para>The &app; application is a Remote Desktop Viewer for the <systemitem>GNOME desktop</systemitem> that uses Virtual Network Computing (VNC) system to remotely control another computer.</para>
+ <para><application>&app;</application> provides the following features:</para>
+ <itemizedlist>
+ <listitem>
+ <para>Connect to several machines at the same time.</para>
+ </listitem>
+ <listitem>
+ <para>Store recently connections and allows to bookmark them.</para>
+ </listitem>
+ <listitem>
+ <para>Browse local network for VNC Servers.</para>
+ </listitem>
+ </itemizedlist>
</section>
-<section id="using">
- <title>Usage</title>
- <para>
- Describe usage overhere
- </para>
-
- <figure>
- <title>&app; screenshot</title>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="figures/vinagre-screenshot.png" format="PNG"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- </figure>
-
+<!-- ============= Getting Started =========================== -->
+<section id="getting-started">
+ <title>Getting Started</title>
+
+<!-- ============= To Start vinagre ========================== -->
+
+ <section id="to-start">
+ <title>Starting &app;</title>
+ <para>You can start <application>&app;</application> in the following ways:</para>
+ <variablelist>
+ <varlistentry>
+ <term><guimenu>Applications</guimenu> menu</term>
+ <listitem>
+ <para>Choose <menuchoice><guisubmenu>Internet</guisubmenu><guimenuitem>Remote Desktop Viewer</guimenuitem></menuchoice>. </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Command line</term>
+ <listitem>
+ <para>Execute the following command: <command>vinagre</command></para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </section>
+
+ <section id="the-window">
+ <title>The &app; Window</title>
+ <figure id="vinagre-window">
+ <title>&app; window</title>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="figures/vinagre-screenshot.png" format="PNG"/>
+ </imageobject>
+ <textobject> <phrase>Shows vinagre main window.</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ </figure>
+
+ <para>The <application>&app;</application> window contains the following
+ elements:</para>
+
+ <variablelist>
+ <varlistentry>
+ <term>Menubar</term>
+ <listitem>
+ <para>The menus on the menubar contain all of the commands you need to work with remote connections in <application>&app;</application>.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Toolbar</term>
+ <listitem>
+ <para>The toolbar contains a subset of the most used commands that you can access from the menubar.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Display Area</term>
+ <listitem>
+ <para>The display area contains a list of tabs with the connected machines and its remote desktops.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Statusbar</term>
+ <listitem>
+ <para>The statusbar displays information about current <application>&app;</application> activity and contextual information about the menu items.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Side Pane</term>
+ <listitem>
+ <para>The side pane contains a list of bookmarked connections.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </section>
- <para>
- Describe usage here
- </para>
</section>
-<section id="preferences">
- <title>Preferences</title>
-
- <para>
- Describe preferences overhere
- </para>
-
+<section id="using">
+ <title>Using &app;</title>
+
+ <section id="connect">
+ <title>To connect with a remote machine</title>
+
+ <section id="connect-informing-data">
+ <title>Informing Host address</title>
+ <para>To connect with a remote machine, choose
+ <menuchoice>
+ <guimenu>Machine</guimenu>
+ <guimenuitem>Connect</guimenuitem>
+ <shortcut><keycombo><keycap>Ctrl</keycap><keycap>N</keycap></keycombo></shortcut>
+ </menuchoice>. The <guilabel>Connection Dialog</guilabel> is displayed.
+ Inform the <guilabel>Host</guilabel> and the <guilabel>Port</guilabel> of
+ the connection and click the <guibutton>Connect</guibutton> button. You can
+ also use the <guibutton>Find</guibutton> button to browse available machines on local network.
+ </para>
+ <note>
+ <para>
+ Some machines may require a secure connection. In this case, a
+ <guilabel>Password</guilabel> dialog will be displayed asking for the connection password.
+ If you check <guilabel>Remember this password</guilabel>, <application>&app;</application> will store
+ the secure information using <application>GNOME Keyring Manager</application>.
+ </para>
+ </note>
+ <para>
+ If the connection has been used previously, you can also access it by
+ <menuchoice>
+ <guimenu>Machine</guimenu>
+ <guimenu>Recent connections...</guimenu>
+ </menuchoice>.
+ </para>
+ </section>
+
+ <section id="connect-opening-file">
+ <title>Opening a Remote Connection File</title>
+ <para>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
+ <menuchoice>
+ <guimenu>Machine</guimenu>
+ <guimenuitem>Open</guimenuitem>
+ <shortcut><keycombo><keycap>Ctrl</keycap><keycap>O</keycap></keycombo></shortcut>
+ </menuchoice>. The <guilabel>Select File</guilabel> dialog is displayed.
+ Select the file you want to open, then click on the <guibutton>Open</guibutton> button.
+ </para>
+
+ <tip>
+ <para>You can also double-click on a remote connection file in the <application>Nautilus</application>
+ file manager to open it on the <application>&app;</application> window.
+ </para>
+ </tip>
+ </section>
+ </section>
+
+ <section id="bookmark-add">
+ <title>To Create a New Bookmark</title>
+ <para>To bookmark the currently viewed connection, choose
+ <menuchoice>
+ <guimenu>Bookmarks</guimenu>
+ <guimenuitem>Add to Bookmarks</guimenuitem>
+ <shortcut><keycombo><keycap>Ctrl</keycap><keycap>D</keycap></keycombo></shortcut>
+ </menuchoice>. The <guilabel>Saving to Bookmarks</guilabel> dialog is displayed.
+ Inform the name of the connection and click <guibutton>Ok</guibutton>.
+ </para>
+ </section>
+
+ <section id="bookmark-remove">
+ <title>To Remove a Bookmark</title>
+ <para>
+ To remove a bookmark, choose <guimenuitem>Remove</guimenuitem> from the context menu
+ of the bookmark in the Side Pane.
+ </para>
+ </section>
+
+ <section id="bookmark-edit">
+ <title>To Edit a Bookmark's Properties</title>
+ <para>
+ To edit a bookmark's properties, such as it's name and host, choose <guimenuitem>Edit</guimenuitem>
+ from the context menu of the bookmark in the Side Pane.
+ </para>
+ </section>
+
+ <section id="fullscreen">
+ <title>To Use Full Screen Mode</title>
+ <para>To zoom the Display Area to full screen mode, choose
+ <menuchoice>
+ <guimenu>View</guimenu>
+ <guimenuitem>Full Screen</guimenuitem>
+ <shortcut><keycap>F11</keycap></shortcut>
+ </menuchoice>. To exit full screen mode, press <keycap>F11</keycap>
+ or <keycombo><keycap>Ctrl</keycap><keycap>Alt</keycap></keycombo>.
+ </para>
+ </section>
+
+ <section id="close">
+ <title>To Close a Connection</title>
+ <para>To close a connection, choose
+ <menuchoice>
+ <guimenu>Machine</guimenu>
+ <guimenuitem>Close</guimenuitem>
+ </menuchoice>.
+ </para>
+ </section>
+
+ <section id="screenshot">
+ <title>To Take Screenshot</title>
+ <para>To take screenshot of the current remote desktop, choose
+ <menuchoice>
+ <guimenu>Machine</guimenu>
+ <guimenu>Take Screenshot</guimenu>
+ </menuchoice> or press the relative button in the toolbar. The
+ <guilabel>Save Screenshot</guilabel> dialog is displayed, click the
+ <guibutton>Save</guibutton> button to save the screenshot.
+ </para>
+ </section>
</section>
-
-<section id="faq">
- <title>Frequently Asked Questions</title>
- <para>
- Describe FAQ overhere
- </para>
-</section>
-
<section id="about">
<title>About</title>
<para>
Modified: trunk/help/Changelog
==============================================================================
--- trunk/help/Changelog (original)
+++ trunk/help/Changelog Fri Jan 18 12:12:50 2008
@@ -1,3 +1,7 @@
+2008-01-18 Jonh Wendell <jwendell gnome org>
+
+ * Documentation finished, thanks to Vinicius Depizzol and GHOP. Closes #503806.
+
2008-01-15 Jonh Wendell <jwendell gnome org>
* Added Changelog
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
