GNOME.org
 

[vinagre] Add Mallard help

commit d1f490fa78d278524d5cf1ca14e54549b9b68038
Author: Ekaterina Gerasimova <kittykat3756 googlemail com>
Date:   Fri Apr 8 14:00:34 2011 +0200

    Add Mallard help

 help/C/bookmarks.page            |   60 +++++++++++++++++++++++++++
 help/C/connect.page              |   53 ++++++++++++++++++++++++
 help/C/getting-started.page.stub |   82 ++++++++++++++++++++++++++++++++++++++
 help/C/index.page                |   16 +++++++
 help/C/preferences.page          |   31 ++++++++++++++
 help/C/using.page.stub           |   35 ++++++++++++++++
 help/Makefile.am                 |    8 ++++
 7 files changed, 285 insertions(+), 0 deletions(-)
---
diff --git a/help/C/bookmarks.page b/help/C/bookmarks.page
new file mode 100755
index 0000000..ca31afb
--- /dev/null
+++ b/help/C/bookmarks.page
@@ -0,0 +1,60 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      xmlns:e="http://projectmallard.org/experimental/";
+      type="guide"
+      id="bookmarks">
+
+  <info>
+    <link type="guide" xref="index"/>
+    <desc>Using bookmarks Vinagre.</desc>
+    <credit type="author">
+      <name>Ekaterina Gerasimova</name>
+      <email>kittykat3756 googlemail com</email>
+    </credit>
+    <license>
+      <p>Creative Commons Share Alike 3.0</p>
+    </license>
+  </info>
+
+<title>Bookmarks</title>
+
+<section id="bookmarks-using">
+  <title>Using bookmarks</title>
+<p>Bookmarks are shortcuts to machines which you access frequently. They are visible in the side panel or in the <gui>Bookmarks</gui> menu.</p>
+<figure>
+  <title>Bookmarks in the side panel</title>
+  <media type="image" mime="image/png" src="figures/vinagre-bookmarks-side-panel.png"/>
+</figure>
+<p>As you hover the mouse over the bookmarks, a tooltip will show you the hostname for the connection. To connect to a machine, just double click on an entry.</p>
+</section>
+
+<section id="bookmarks-add">
+  <title>Create a new bookmark</title>
+<p>To bookmark the currently viewed connection, choose <guiseq><gui>Bookmarks</gui><gui>Add to bookmarks</gui></guiseq> (<keyseq><key>Ctrl</key><key>D</key></keyseq>). The <gui>Bookmarks</gui> dialog is displayed. Enter the name for the connection, and choose any other options you may want to use, then click <gui>Save</gui>.</p>
+<figure>
+  <title>The saving to Bookmarks dialog</title>
+  <media type="image" mime="image/png" src="figures/vinagre-saving-bookmarks.png"/>
+</figure>
+<note>
+  <p>You can use folders to organize your bookmarks. To create a folder, right click on the side panel and choose the option <gui>New folder</gui> in the context menu.</p>
+</note>
+</section>
+
+<section id="bookmarks-edit">
+  <title>Edit bookmark properties</title>
+<p>To edit a bookmark's properties, such as its name and host, right click on the bookmark in the side pane and choose <gui>Edit bookmark</gui> from the context menu.</p>
+<figure>
+  <title>Context menu option to edit a bookmark</title>
+  <media type="image" mime="image/png" src="figures/vinagre-editing-bookmarks.png"/>
+</figure>
+<note>
+  <p>You can also edit a folder in the same way.</p>
+</note>
+</section>
+
+<section id="bookmarks-remove">
+  <title>Remove a bookmark</title>
+<p>To remove a bookmark, right click on the bookmark in the side pane and choose <gui>Remove from bookmarks</gui> from the context menu.</p>
+<note><p>You can also remove a folder in the same way. Note that removing a folder will remove all the bookmarks inside it. A confirmation dialog will be shown.</p></note>
+</section>
+
+</page>
diff --git a/help/C/connect.page b/help/C/connect.page
new file mode 100755
index 0000000..8bbe121
--- /dev/null
+++ b/help/C/connect.page
@@ -0,0 +1,53 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      xmlns:e="http://projectmallard.org/experimental/";
+      type="guide"
+      id="using">
+
+  <info>
+    <link type="guide" xref="index"/>
+    <link type="seealso" xref="bookmarks"/>
+    <desc>Learn about connecting to another computer with Vinagre.</desc>
+    <credit type="author">
+      <name>Ekaterina Gerasimova</name>
+      <email>kittykat3756 googlemail com</email>
+    </credit>
+    <license>
+      <p>Creative Commons Share Alike 3.0</p>
+    </license>
+  </info>
+
+<title>Connecting to other computers</title>
+
+<section id="connect">
+<title>Establishing a connection</title>
+<p>To connect to a remote computer, choose <guiseq><gui>Machine</gui><gui>Connect</gui></guiseq> (<keyseq><key>Ctrl</key><key>N</key></keyseq>). The connection dialog is displayed. Choose the <gui>Protocol</gui> and the <gui>Host</gui> for the connection and click the <gui>Connect</gui> button. You will be presented with some other options, depending on which protocol you have selected.</p>
+<figure>
+  <title>Connect dialog</title>
+  <media type="image" mime="image/png" src="figures/vinagre-connect-dialog.png"/>
+</figure>
+<p>You can also use the <gui>Find</gui> button to browse available computers on the local network.</p>
+<note>
+<p>The availabity of the <gui>Find</gui> button depends on the protocol you have selected. <app>Vinagre</app> relies on <app>Avahi</app> to browse for machines on your local network. Also, note that <app>Vinagre</app> can be compiled without <app>Avahi</app> support. In this case, this button will not be displayed.</p>
+</note>
+<p>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 a username. If you check <gui>Remember this credential</gui>, <app>Vinagre</app> will store the information using <app>GNOME Keyring</app>.</p>
+<figure>
+  <title>Authentication dialog</title>
+  <media type="image" mime="image/png" src="figures/vinagre-auth-needed.png"/>
+</figure>
+<p>If the connection has been used previously, you can also access it through <guiseq><gui>Machine</gui><gui>Recent connections</gui></guiseq></p>
+</section>
+
+<section id="connect-opening-file">
+<title>Opening a remote connection file</title>
+<p>Some hosts distribute remote connection files (generally ending with suffix <file>.vnc</file>) instead of using a host address and port. To open a remote connection file, choose <guiseq><gui>Machine</gui><gui>Open</gui></guiseq> (<keyseq><key>Ctrl</key><key>O</key></keyseq>). The file choser dialog is displayed. Select the file you want to open, then click on the <gui>Open</gui> button.</p>
+<note style="tip">
+<p>You can also double-click on a remote connection file in <app>Nautilus</app> to open it with <app>Vinagre</app>.</p>
+</note>
+</section>
+
+<section id="close">
+<title>Closing a connection</title>
+<p>To close a connection, choose <guiseq><gui>Machine</gui><gui>Close</gui></guiseq>.</p>
+</section>
+
+</page>
diff --git a/help/C/getting-started.page.stub b/help/C/getting-started.page.stub
new file mode 100755
index 0000000..5ce7848
--- /dev/null
+++ b/help/C/getting-started.page.stub
@@ -0,0 +1,82 @@
+<!-- TODO: make topic oriented -->
+
+<page xmlns="http://projectmallard.org/1.0/";
+      xmlns:e="http://projectmallard.org/experimental/";
+      type="guide"
+      id="getting-started">
+<info>
+  <link type="guide" xref="index"/>
+  <title type="sort">3</title>
+    <credit type="author">
+      <name>Ekaterina Gerasimova</name>
+      <email>kittykat3756 googlemail com</email>
+    </credit>
+    <license>
+      <p>Creative Commons Share Alike 3.0</p>
+    </license>
+</info>
+
+<title>Getting started</title>
+
+<section id="getting-started-to-start">
+<title>Starting Vinarge</title>
+<p>You can start <app>Vinagre</app> in the following ways:</p>
+<terms>
+  <item>
+    <title><gui>Applications</gui> menu</title>
+      <p>Choose <guiseq><gui>Remote Desktop Viewer</gui></guiseq></p>
+  </item>
+  <item>
+    <title>Command line</title>
+      <p>Execute the following command: <cmd>vinagre</cmd></p>
+  </item>
+</terms>
+</section>
+
+<section id="getting-started-run-from-cmd-line">
+<title>Starting Vinagre from a command line</title>
+<p>You can run <app>Vinagre</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 <key>Return</key>:</p>
+<cmd>vinagre <var>hostname_or_ip_address</var></cmd>
+<p>For more information on how to run <app>Vinagre</app> from a command line, see the unix manual page for <app>Vinagre</app>.</p>
+</section>
+
+<section id="getting-started-the-window">
+<title>The Vinagre window</title>
+<figure>
+  <title>Vinagre main window</title>
+  <media type="image" mime="image/png" src="figures/vinagre-screenshot.png"/>
+</figure>
+<p>The <app>Vinagre</app> window contains the following elements:</p>
+<terms>
+  <item>
+    <title>Menu bar</title>
+      <p>The menus on the menu bar contain all of the commands you need to work with remote connections in <app>Vinagre</app>.</p>
+  </item>
+  <item>
+    <title>Toolbar</title>
+      <p>The toolbar contains a subset of the most used commands that you can access from the menubar.</p>
+  </item>
+  <item>
+    <title>Display Area</title>
+      <p>The display area contains a list of tabs with the connected machines and its remote desktops.</p>
+  </item>
+  <item>
+    <title>Status Bar</title>
+      <p>The statusbar displays information about current <app>Vinagre</app> activity and contextual information about the menu items.</p>
+  </item>
+  <item>
+    <title>Side Pane</title>
+      <p>The side pane contains a list of bookmarked connections and (if available) a list of auto-discovered network machines.</p>
+  </item>
+</terms>
+</section>
+
+<section id="getting-started-notes">
+<title>Some notes about Vinagre</title>
+<p>As a tool to access other machines, <app>Vinagre</app> behaves slightly different than other <sys>GNOME</sys> applications in its default installation.</p>
+<p><app>Vinagre</app> comes with menu accelerators and keyboard shortcuts disabled by default. This avoids keys being intercepted by <app>Vinagre</app> when you wanted to send those keys to the remote machine.</p>
+<p>For instance, the keyboard shortcut to close a tab is <gui>Ctrl+W</gui>, but that key combination will be sent to the remote machine by default.</p>
+<p>If you want to change this behavior, go to <app>Vinagre</app> preferences in <guiseq><gui>Edit</gui><gui>Preferences</gui></guiseq></p>
+</section>
+
+</page>
diff --git a/help/C/index.page b/help/C/index.page
new file mode 100755
index 0000000..3762613
--- /dev/null
+++ b/help/C/index.page
@@ -0,0 +1,16 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      xmlns:e="http://projectmallard.org/experimental/";
+      type="guide"
+      id="index">
+
+<title>Vinagre Help</title>
+
+<p><app>Vinagre</app> is a remote desktop viewer application for the GNOME desktop which uses Virtual Network Computing (VNC), and possibly other protocols, to remotely control another computer.</p>
+<p><app>Vinagre</app> provides the following features:</p>
+<list>
+  <item><p>connect to several machines at the same time</p></item>
+  <item><p>store recent connections and allows them to be bookmarked</p></item>
+  <item><p>browse local network for machines</p></item>
+</list>
+
+</page>
diff --git a/help/C/preferences.page b/help/C/preferences.page
new file mode 100755
index 0000000..c7976ff
--- /dev/null
+++ b/help/C/preferences.page
@@ -0,0 +1,31 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      xmlns:e="http://projectmallard.org/experimental/";
+      type="guide"
+      id="preferences">
+
+  <info>
+    <link type="guide" xref="index"/>
+    <desc>Configuration options in Vinagre.</desc>
+    <credit type="author">
+      <name>Ekaterina Gerasimova</name>
+      <email>kittykat3756 googlemail com</email>
+    </credit>
+    <license>
+      <p>Creative Commons Share Alike 3.0</p>
+    </license>
+  </info>
+
+<title>Preferences</title>
+<p>To configure <app>Vinagre</app>, choose <guiseq><gui>Edit</gui><gui>Preferences</gui></guiseq>. The <gui>Preferences</gui> dialog contains the following items:</p>
+<terms>
+  <item>
+    <title><gui>Always show tabs</gui></title>
+    <p>Select this option to make the tabs always visible, even when only one connection is active.</p>
+  </item>
+  <item>
+    <title><gui>Allow keyboard shortcuts</gui></title>
+    <p>Select this option to enable keyboard shortcuts, like <gui>Ctrl+D</gui>, and menu accelerators, like <gui>Alt+M</gui>. This means that <app>Vinagre</app> will catch those key combinations, instead of sending them to the remote machine. This option is <gui>disabled</gui> by default because most of the time, you will be working on a remote machine.</p>
+  </item>
+</terms>
+
+</page>
diff --git a/help/C/using.page.stub b/help/C/using.page.stub
new file mode 100644
index 0000000..f92c400
--- /dev/null
+++ b/help/C/using.page.stub
@@ -0,0 +1,35 @@
+<!-- TODO: instructions on how to use Vinagre -->
+
+<page xmlns="http://projectmallard.org/1.0/";
+      xmlns:e="http://projectmallard.org/experimental/";
+      type="guide"
+      id="using">
+
+  <info>
+  <link type="guide" xref="index"/>
+  <title type="sort">4</title>
+    <credit type="author">
+      <name>Ekaterina Gerasimova</name>
+      <email>kittykat3756 googlemail com</email>
+    </credit>
+    <license>
+      <p>Creative Commons Share Alike 3.0</p>
+    </license>
+  </info>
+
+<title>Using Vinagre</title>
+
+<section id="fullscreen">
+<title>To Use Full Screen Mode</title>
+<p>To zoom the Display Area to full screen mode, choose <guiseq><gui>View</gui><gui>Full Screen</gui></guiseq> (<keyseq><key>F11</key></keyseq>) or the corresponding tool bar button.</p>
+<note>
+<p>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.</p>
+</note>
+</section>
+
+<section id="screenshot">
+<title>To Take Screenshot</title>
+<p>To take screenshot of the current remote desktop, choose <guiseq><gui>Machine</gui><gui>Take Screenshot</gui></guiseq> or press the relative button in the toolbar. The <gui>Save Screenshot</gui> dialog is displayed, click the <gui>Save</gui> button to save the screenshot.</p>
+</section>
+
+</page>
diff --git a/help/Makefile.am b/help/Makefile.am
index efc8e53..16e59f1 100644
--- a/help/Makefile.am
+++ b/help/Makefile.am
@@ -1,6 +1,8 @@
 include $(top_srcdir)/build-aux/gnome-doc-utils.make
 dist-hook: doc-dist-hook
 
+DOC_ID = $(PACKAGE_TARNAME)
+
 DOC_FIGURES = \
 	figures/vinagre-screenshot.png	\
 	figures/vinagre-auth-needed.png	\
@@ -8,3 +10,9 @@ DOC_FIGURES = \
 	figures/vinagre-connect-dialog.png	\
 	figures/vinagre-editing-bookmarks.png	\
 	figures/vinagre-saving-bookmarks.png
+
+DOC_PAGES = \
+	bookmarks.page \
+	connect.page \
+	index.page \
+	preferences.page
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]