1
<!-- -*- indent-tabs-mode: nil -*- -->
3
<title>Tools and Utilities</title>
6
<para>This section describes some of the tools and utilities in the GNOME Desktop.</para>
9
<section id="tools-run-app">
10
<title>Running Applications</title>
11
<!-- preserve id for backwards compatibility: 2.12 -->
12
<anchor id="gospanel-23"/>
14
<primary>Run Application dialog, using</primary>
16
<para>The <guilabel>Run Application</guilabel> dialog gives you access to the command
17
line. When you run a command in the <guilabel>Run Application</guilabel> dialog,
18
you cannot receive output from the command.</para>
19
<para>To run a command from the command line perform the following steps:</para>
22
<para>Display the <guilabel>Run Application</guilabel> dialog. You
23
can display the <guilabel>Run Application</guilabel> dialog in any of the
26
<varlistentry><term>From a panel</term>
27
<listitem><para>You can add the <application>Run Application</application> object to any panel. See <xref linkend="panels-addobject"/>. Click on the <guibutton>Run</guibutton> button to open the <guilabel>Run Application</guilabel> dialog.</para></listitem></varlistentry>
28
<varlistentry><term>Using shortcut keys</term>
29
<listitem><para>Press <keycombo><keycap>Alt</keycap><keycap>F2</keycap></keycombo>. You can change the shortcut keys that display the <guilabel>Run Application</guilabel> dialog
30
in the <link linkend="prefs-keyboard-shortcuts"><application>Keyboard Shortcuts</application> preference tool</link>.</para></listitem></varlistentry>
33
<para>The <guilabel>Run Application</guilabel> dialog is displayed.</para>
36
<para>Enter the command that you want to run in the blank field. </para>
37
<para>Alternatively, to choose a command that you ran previously, click the
38
down arrow button beside the command field, then choose the command to run.</para>
39
<para>Alternatively, select the <guilabel>Show list of known applications</guilabel> option to display a list of available applications.</para>
40
<para>You can also use the <guibutton>Run with file</guibutton> button to
41
choose a file to append to the command line. For example, you can enter <application>emacs</application> as the command, then choose a file to edit.</para>
42
<para>Select the <guilabel>Run in terminal</guilabel> option to run the application
43
or command in a terminal window. Choose this option for an application or
44
command that does not create a window in which to run.</para>
47
<para>Click on the <guibutton>Run</guibutton> button on the <guilabel>Run Application</guilabel> dialog. </para>
52
<section id="tools-screenshot">
53
<title>Taking Screenshots</title>
54
<!-- preserve id for backwards compatibility: 2.12 -->
55
<anchor id="goseditmainmenu-53"/>
57
<primary>screenshots, taking</primary>
59
<para>You can take a screenshot in any of the following ways:</para>
62
<para>From any panel</para>
63
<para>You can add a <guibutton>Take Screenshot</guibutton> button to any panel. For instructions on how to do this, see <xref linkend="panels-addobject"/>. Click on the <guibutton>Take Screenshot</guibutton> button to take
64
a screenshot of the entire screen.</para>
67
<para>Use shortcut keys</para>
68
<para>To take a screenshot, use the following shortcut keys:</para>
69
<informaltable frame="topbot">
70
<tgroup cols="2" colsep="0" rowsep="0">
71
<colspec colname="colspec0" colwidth="35.67*"/>
72
<colspec colname="colspec1" colwidth="64.33*"/>
76
<para>Default Shortcut Keys</para>
85
<entry colname="colspec0" valign="top">
87
<keycap>Print Screen</keycap>
90
<entry colname="colspec1" valign="top">
91
<para>Takes a screenshot of the entire
96
<entry colname="colspec0" valign="top">
97
<para><keycombo><keycap>Alt</keycap><keycap>Print Screen</keycap></keycombo></para>
99
<entry colname="colspec1" valign="top">
100
<para>Takes a screenshot of the window to which the mouse points.</para>
106
<para>You can use the <link linkend="prefs-keyboard-shortcuts"><application>Keyboard Shortcuts</application> preference
107
tool</link> to modify the default shortcut keys.</para>
110
<para>From the Menubar</para>
111
<para>Choose <menuchoice><guimenu>Applications</guimenu><guimenuitem>Accessories</guimenuitem><guimenuitem>Take Screenshot</guimenuitem></menuchoice>.</para>
114
<para>From the Terminal</para>
115
<para>You can use the <command>gnome-panel-screenshot</command> command to
116
take a screenshot. The <command>gnome-panel-screenshot</command> command takes
117
a screenshot of the entire screen, and displays the <guilabel>Save Screenshot</guilabel> dialog. Use the <guilabel>Save Screenshot</guilabel> dialog to
118
save the screenshot.</para>
119
<para>You can also use options on the <command>gnome-panel-screenshot</command>
120
command as follows: </para>
121
<informaltable frame="topbot">
122
<tgroup cols="2" colsep="0" rowsep="0">
123
<colspec colname="colspec0" colwidth="35.67*"/>
124
<colspec colname="colspec1" colwidth="64.33*"/>
131
<para>Function</para>
137
<entry colname="colspec0" valign="top">
139
<command>--window</command>
142
<entry colname="colspec1" valign="top">
143
<para>Takes a screenshot of the window
144
that has focus.</para>
148
<entry colname="colspec0" valign="top">
150
<command>--delay=<replaceable>seconds</replaceable></command>
153
<entry colname="colspec1" valign="top">
154
<para>Takes a screenshot after the specified number of seconds, and displays the <guilabel>Save Screenshot</guilabel> dialog. Use the <guilabel>Save Screenshot</guilabel>
155
dialog to save the screenshot.</para>
159
<entry colname="colspec0" valign="top">
161
<command>--help</command>
164
<entry colname="colspec1" valign="top">
165
<para>Displays the options for the
175
<para>When you take a screenshot, the <guilabel>Save Screenshot</guilabel> dialog opens. To save the screenshot as an image file, enter the filename for the screenshot and choose a location from the drop-down list.</para>
178
<!-- ============= Yelp ============================= -->
180
<title>Yelp Help Browser</title>
182
<primary>Yelp</primary>
184
<!-- ============= Introduction ============================== -->
186
<section id="yelp-introduction">
187
<title>Introduction</title>
189
<para>The <application>Yelp Help Browser</application> application allows you to view documentation
190
regarding GNOME and other components through a variety of formats. These
191
formats include docbook files, HTML help pages, man pages and info pages
192
(support for man pages and info pages may optionally be compiled in).
193
Despite the different formats supported, Yelp does its best to provide a
194
unified look and feel regardless of the original document format.</para>
196
<para><application>Yelp Help Browser</application> is internationalised, meaning that it has support
197
to view documents in different languages. The documents must be localised
198
or translated for each language and installed properly for Yelp Help
199
Browser to be able to view them.</para>
202
<!-- ============= Getting Started ================================ -->
204
<section id="yelp-getting-started">
205
<title>Starting Yelp</title>
208
<title>To Start <application>Yelp Help Browser</application></title>
210
<para>You can start <application>Yelp Help Browser</application> in the following ways:</para>
214
<term><guimenu>System</guimenu> Menu</term>
217
<para>Choose <application>Help</application></para>
222
<term>Command Line</term>
225
<para>Execute the following command:
226
<command>yelp</command></para>
229
</variablelist></para>
233
<title>Interface</title>
235
<para>When you start <application>Yelp Help Browser</application>, you will see the following
236
window appear.</para>
238
<para><figure id="fig-yelp-window">
239
<title><application>Yelp Help Browser</application> Window</title>
243
<imagedata fileref="figures/yelp_window.png" />
246
</figure><application>Yelp Help Browser</application> contains the following elements in <xref
247
linkend="fig-yelp-window" /></para>
251
<term><interface>Menubar</interface></term>
256
<term><guimenu>File</guimenu></term>
259
<para>Use this menu to Open a New Window, view the About
260
this Document page, Print the current document, or Close
266
<term><guimenu>Edit</guimenu></term>
269
<para>Use this menu to Copy, Select all, Find..., or to
270
set your Preferences.</para>
275
<term><guimenu>Go</guimenu></term>
278
<para>Use this menu to navigate Back, Forward, to the Help
279
Topics page. When viewing a DocBook document, use this
280
menu to navigate to the Next Section, Previous Section or
281
to the Contents.</para>
286
<term><guimenu>Bookmarks</guimenu></term>
289
<para>Use this menu to Add Bookmark(s), or Edit
295
<term><guimenu>Help</guimenu></term>
298
<para>View information about Yelp Help Browser and
299
contributors to the project through the
300
<guimenuitem>About</guimenuitem> menuitem. Open this
301
document with the <guimenuitem>Contents</guimenuitem>
302
menuitem or by pressing <keycap>F1</keycap>.</para>
305
</variablelist></para>
310
<term><interface>Toolbar</interface></term>
315
<term><guibutton>Back</guibutton></term>
318
<para>Use this button to navigate back in your document
324
<term><guibutton>Forward</guibutton></term>
327
<para>Use this button to navigate forward in your document
333
<term><guibutton>Help Topics</guibutton></term>
336
<para>Use this button to return to the main table of
337
contents (shown in <xref
338
linkend="fig-yelp-window" />)</para>
341
</variablelist></para>
345
<varlistentry id="yelp-browser-pane" xreflabel="Yelp Browser Pane">
346
<term><interface>Browser Pane</interface></term>
349
<para>The browser pane is where you will be presented with the
350
table of contents or the documentation. Use the table of contents
351
to navigate to the documentation you need.</para>
358
<!--===================== Usage ========================-->
360
<section id="yelp-usage">
361
<title>Using Yelp</title>
364
<title>Open a Document</title>
366
<para>To open a document in <application>Yelp Help Browser</application>, use the Table of Contents
367
to navigate to the desired document</para>
369
<para>Alternatively, you may view a particular document by invoking Yelp
370
Help Browser from the command line. Please see <xref
371
linkend="yelp-advanced-cmdline" />.</para>
375
<title>Open a New Window</title>
377
<para>To open a new window:</para>
381
<para>Click <menuchoice>
382
<guimenu>File</guimenu>
384
<guimenuitem>New Window</guimenuitem>
389
<para>Use the key combination
390
<keycap>Ctrl</keycap>+<keycap>N</keycap></para>
392
</itemizedlist></para>
396
<title>About This Document</title>
398
<para>To view information about the currently open document:</para>
402
<para>Click <menuchoice>
403
<guimenu>File</guimenu>
405
<guimenuitem>About This Document</guimenuitem>
408
</itemizedlist><note>
409
<para>This option is only available for DocBook documentation. Legal
410
notices and documentation contributors are usually listed in this
416
<title>Print a Page</title>
418
<para>To print any page that you are able to view in <application>Yelp Help Browser</application>:</para>
422
<para>Click <menuchoice>
423
<guimenu>File</guimenu>
425
<guimenuitem>Print this Page</guimenuitem>
428
</itemizedlist></para>
432
<title>Print a Document</title>
434
<para>To print an entire document:</para>
438
<para>Click <menuchoice>
439
<guimenu>File</guimenu>
441
<guimenuitem>Print this Document</guimenuitem>
444
</itemizedlist><note>
445
<para>This option is only available for DocBook
446
documentation.</para>
451
<title>Close a Window</title>
453
<para>To close a window in <application>Yelp Help Browser</application>, do the following:</para>
457
<para>Click <menuchoice>
458
<guimenu>File</guimenu>
460
<guimenuitem>Close Window</guimenuitem>
465
<para>Use the key combination
466
<keycap>Ctrl</keycap>+<keycap>W</keycap></para>
468
</itemizedlist></para>
472
<title>Set Preferences</title>
474
<para>To set your preferences in <application>Yelp Help Browser</application>:</para>
478
<para>Click <menuchoice>
479
<guimenu>Edit</guimenu>
481
<guimenuitem>Preferences</guimenuitem>
484
</itemizedlist>A window will appear that looks like <xref
485
linkend="yelp-preferences" />:</para>
487
<para><figure id="yelp-preferences">
488
<title><application>Yelp Help Browser</application> Preferences Window</title>
492
<imagedata fileref="figures/yelp_preferences.png" />
495
</figure>The options that are available in this dialog have the
496
following functions:</para>
500
<term><guilabel>Use system fonts</guilabel></term>
503
<para>Check this option to display documentation using the
504
default fonts used by the GNOME Desktop.</para>
506
<para>To choose your own fonts to display documentation, uncheck
507
this option and click on the buttons next to the text
508
<guilabel>Variable Width</guilabel> or <guilabel>Fixed
509
Width</guilabel>.</para>
513
<term><guilabel>Variable Width</guilabel></term>
516
<para>This is the font to use when a static or fixed
517
width font is not required. The majority of text will be
523
<term><guilabel>Fixed Width</guilabel></term>
526
<para>This is the font to use when all text characters
527
need to be of the same size. This font is usually used
528
to indicate commands, program blocks, or other text that
529
falls under these categories.</para>
532
</variablelist></para>
537
<term><guilabel>Browse with caret</guilabel></term>
540
<para>Click this option if you would like see a caret or cursor
541
in the <xref linkend="yelp-browser-pane" />. This allows you to
542
browse the document more easily by showing where the cursor is
543
located in the document.</para>
546
</variablelist></para>
550
<title>Go Back in Document History</title>
552
<para>To go back in the document history:</para>
556
<para>Click <menuchoice>
557
<guimenu>Go</guimenu>
559
<guimenuitem>Back</guimenuitem>
564
<para>Use the key combination
565
<keycap>Alt</keycap>+<keycap>Left</keycap></para>
569
<para>Use the <guibutton>Back</guibutton> button in the
570
<interface>Toolbar</interface></para>
572
</itemizedlist></para>
576
<title>Go Forward in Document History</title>
578
<para>To go forward in the document history:</para>
582
<para>Click <menuchoice>
583
<guimenu>Go</guimenu>
585
<guimenuitem>Forward</guimenuitem>
590
<para>Use the key combination
591
<keycap>Alt</keycap>+<keycap>Right</keycap></para>
595
<para>Use the <guibutton>Forward</guibutton> button in the
596
<interface>Toolbar</interface></para>
598
</itemizedlist></para>
602
<title>Go to Help Topics</title>
604
<para>To go to the Help Topics:</para>
608
<para>Click <menuchoice>
609
<guimenu>Go</guimenu>
611
<guimenuitem>Help Topics</guimenuitem>
616
<para>Use the key combination
617
<keycap>Alt</keycap>+<keycap>Home</keycap></para>
621
<para>Use the <guibutton>Help Topics</guibutton> button in the
622
<interface>Toolbar</interface></para>
624
</itemizedlist></para>
628
<title>Go to Previous Section</title>
630
<para>To go to the previous section:</para>
634
<para>Click <menuchoice>
635
<guimenu>Go</guimenu>
637
<guimenuitem>Previous Section</guimenuitem>
642
<para>Use the key combination
643
<keycap>Alt</keycap>+<keycap>Up</keycap></para>
645
</itemizedlist><note>
646
<para>This option is only available in DocBook formatted
652
<title>Go to Next Section</title>
654
<para>To go to the next section:</para>
658
<para>Click <menuchoice>
659
<guimenu>Go</guimenu>
661
<guimenuitem>Next Section</guimenuitem>
666
<para>Use the key combination
667
<keycap>Alt</keycap>+<keycap>Down</keycap></para>
669
</itemizedlist><note>
670
<para>This option is only available in DocBook formatted
676
<title>Go to Contents</title>
678
<para>To go to the contents for a document:</para>
682
<para>Click <menuchoice>
683
<guimenu>Go</guimenu>
685
<guimenuitem>Contents</guimenuitem>
688
</itemizedlist><note>
689
<para>This option is only available in DocBook formatted
695
<title>Add a Bookmark</title>
697
<para>To add a bookmark for a particular document:</para>
701
<para>Click <menuchoice>
702
<guimenu>Bookmarks</guimenu>
704
<guimenuitem>Add Bookmark</guimenuitem>
709
<para>Use the key combination
710
<keycap>Ctrl</keycap>+<keycap>D</keycap></para>
712
</itemizedlist>A window will appear that looks like <xref
713
linkend="yelp-add-bookmark" />.</para>
715
<para><figure id="yelp-add-bookmark">
716
<title>Add Bookmark Window</title>
720
<imagedata fileref="figures/yelp_add_bookmark.png" />
723
</figure>Enter your desired bookmark title in to the
724
<guilabel>Title</guilabel> text entry field. Then click
725
<guibutton>Add</guibutton> to add the bookmark, or click
726
<guibutton>Cancel</guibutton> to cancel the request.</para>
730
<title>Edit Bookmarks</title>
732
<para>To edit your collection of bookmarkst:</para>
736
<para>Click <menuchoice>
737
<guimenu>Bookmarks</guimenu>
739
<guimenuitem>Edit Bookmarks...</guimenuitem>
744
<para>Use the key combination
745
<keycap>Ctrl</keycap>+<keycap>B</keycap></para>
747
</itemizedlist>A window will appear that looks like <xref
748
linkend="yelp-edit-bookmarks" />.</para>
750
<para><figure id="yelp-edit-bookmarks">
751
<title>Edit Bookmarks Window</title>
755
<imagedata fileref="figures/yelp_edit_bookmarks.png" />
758
</figure>You can manage your bookmarks using this window in the
759
following ways:</para>
763
<term><guibutton>Open</guibutton></term>
766
<para>Use this button to open the selected bookmark in a new
772
<term><guibutton>Rename</guibutton></term>
775
<para>Use this button to rename the title of your
781
<term><guibutton>Remove</guibutton></term>
784
<para>Use this button to delete the bookmark from your
788
</variablelist>Once you are finished managing your bookmarks, click
789
the <guibutton>Close</guibutton> button to exit the <interface>Edit
790
Bookmarks Window</interface>.</para>
794
<title>Get Help</title>
796
<para>To get help using <application>Yelp Help Browser</application> (and see this
801
<para>Click <menuchoice>
802
<guimenu>Help</guimenu>
804
<guimenuitem>Contents</guimenuitem>
807
</itemizedlist></para>
811
<!--=============== Advanced Features ====================-->
813
<section id="yelp-advanced">
814
<title>Advanced Features</title>
816
<section id="yelp-advanced-cmdline"
817
xreflabel="Using the Command Line to Open Documents">
818
<title>Using the Command Line to Open Documents</title>
820
<para>Yelp Help Browser supports opening documents from the command
821
line. There are a number of URIs (Uniform Resource Identifiers) that can
822
be used. These include:</para>
826
<term><option>file:</option></term>
829
<para>Use this URI when you want to access a file with
830
yelp, for example:</para>
832
<screen><userinput>yelp file:///usr/share/gnome/help/gcalctool/C/gcalctool.xml</userinput></screen>
838
<term><option>ghelp:</option> or
839
<option>gnome-help:</option></term>
842
<para>Use this URI when you want to access GNOME help documents,
843
which are typically written in DocBook format.</para>
845
<screen><userinput>yelp ghelp:gcalctool</userinput></screen>
847
<para>If you want to open the help document at a particular section,
848
append a question mark to the end of the URI, followed by the section id.</para>
850
<screen><userinput>yelp ghelp:user-guide?yelp-advanced-cmdline</userinput></screen>
855
<term><option>man:</option></term>
858
<para>Use this URI when you want to access a particular man
859
page. You can append the section of the man page you would like
860
to view if there are multiple man pages with the same
861
name. The section number should be enclosed in parenthesis and
862
therefore it may be necessary to escape the argument so that the
863
shell does not interpret the parenthesis.</para>
865
<screen><userinput>yelp man:gcalctool</userinput></screen>
869
<screen><userinput>yelp 'man:intro(1)'</userinput>
870
<userinput>yelp 'man:intro(2)'</userinput></screen>
875
<term><option>info:</option></term>
878
<para>Use this URI when you want to access a particular GNU info
881
<screen><userinput>yelp info:make</userinput></screen>
888
<title>Refreshing Content on Demand</title>
890
<para><application>Yelp Help Browser</application> supports the
891
<keycombo><keycap>Ctrl</keycap><keycap>R</keycap></keycombo> shortcut keys, which will reload the DocBook
892
document that is currently open. This allows developers to view changes
893
to documents as they are made.</para>
897
<section id="yelp-moreinfo">
898
<title>More Information</title>
900
<para>This section details some of the helper applications which
901
<application>Yelp Help Browser</application> uses, and provides resources where you can get more information
902
about <application>Yelp Help Browser</application>.</para>
905
<title>Scrollkeeper</title>
907
<para><application>Yelp Help Browser</application> uses scrollkeeper to generate the table of
908
contents for DocBook and HTML documentation, and also keep track of
909
translations for each document.</para>
913
<title>GNOME Documentation Utilites</title>
915
<para>The documentation distributed with GNOME uses this set of
916
utilities for a variety of things:</para>
920
<para>Ease translation of documents to different languages.</para>
924
<para>Provide a set of tools to help package and install
925
documentation into the correct location and register the
926
documentation with scrollkeeper.</para>
930
<para>Perform conversion from DocBook format to a format suitable
933
</itemizedlist><application>Yelp Help Browser</application> relies on <ulink url="ghelp:gnome-doc-xslt">GNOME XSLT
934
Stylesheets</ulink> to perform conversion from DocBook to HTML. <ulink url="ghelp:gnome-doc-make">GNOME Documentation
935
Build Utilities</ulink> are relied upon by application authors to install and register documentation within the help system.</para>
939
<title>Mailing List</title>
941
<para>For further information on <application>Yelp Help Browser</application> please subscribe to
942
the mailing list, <ulink type="http" url="http://mail.gnome.org/mailman/listinfo/gnome-doc-devel-list">gnome-doc-devel-list@gnome.org</ulink>.</para>
946
<section id="yelp-joininggdp">
947
<title>Joining the GNOME Documentation Project</title>
949
<para>If you are interesting in helping produce and update documentation
950
for the GNOME project, please visit the following link: <ulink
951
url="http://live.gnome.org/DocumentationProject">http://live.gnome.org/DocumentationProject</ulink></para>
added
removed
gnome2-user-guide/C/gostools.xml
