~ubuntu-branches/ubuntu/oneiric/valkyrie/oneiric

« back to all changes in this revision

Viewing changes to doc/options_dialog.html

  • Committer: Bazaar Package Importer
  • Author(s): Hai Zaar
  • Date: 2009-05-06 14:48:00 UTC
  • Revision ID: james.westby@ubuntu.com-20090506144800-vw617m4d4qa2pam3
Tags: upstream-1.4.0
Import upstream version 1.4.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<html>
 
2
<head>
 
3
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
 
4
<title>3.�Options Dialog</title>
 
5
<link rel="stylesheet" href="valkyrie.css" type="text/css">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
 
7
<link rel="home" href="index.html" title="Valkyrie Documentation">
 
8
<link rel="up" href="manual.html" title="Valkyrie User Manual">
 
9
<link rel="previous" href="mainwindow.status_msg.html" title="2.6.�Status Messages">
 
10
<link rel="next" href="options_valgrind.html" title="3.2.�Valgrind Options Page">
 
11
</head>
 
12
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
13
<div><table class="nav" width="100%" cellspacing="3" cellpadding="3" border="0" summary="Navigation header"><tr>
 
14
<td width="22px" align="center" valign="middle"><a accesskey="p" href="mainwindow.status_msg.html"><img src="images/prev.png" width="18" height="21" border="0" alt="Prev"></a></td>
 
15
<td width="25px" align="center" valign="middle"><a accesskey="u" href="manual.html"><img src="images/up.png" width="21" height="18" border="0" alt="Up"></a></td>
 
16
<td width="31px" align="center" valign="middle"><a accesskey="h" href="index.html"><img src="images/home.png" width="27" height="20" border="0" alt="Up"></a></td>
 
17
<th align="center" valign="middle">Valkyrie User Manual</th>
 
18
<td width="22px" align="center" valign="middle"><a accesskey="n" href="options_valgrind.html"><img src="images/next.png" width="18" height="21" border="0" alt="Next"></a></td>
 
19
</tr></table></div>
 
20
<div class="chapter" lang="en">
 
21
<div class="titlepage">
 
22
<div><div><h2 class="title">
 
23
<a name="options_dialog"></a>3.�Options Dialog</h2></div></div>
 
24
<div></div>
 
25
</div>
 
26
<div class="toc">
 
27
<p><b>Table of Contents</b></p>
 
28
<dl>
 
29
<dt><span class="sect1"><a href="options_dialog.html#valkyrie">3.1. Valkyrie Options Page</a></span></dt>
 
30
<dt><span class="sect1"><a href="options_valgrind.html">3.2. Valgrind Options Page</a></span></dt>
 
31
<dd><dl>
 
32
<dt><span class="sect2"><a href="options_valgrind.html#core_tab">3.2.1. Core Tab</a></span></dt>
 
33
<dt><span class="sect2"><a href="options_valgrind.html#error_tab">3.2.2. Error Reporting Tab</a></span></dt>
 
34
<dt><span class="sect2"><a href="options_valgrind.html#supps_tab">3.2.3. Suppressions Tab</a></span></dt>
 
35
</dl></dd>
 
36
<dt><span class="sect1"><a href="tool-opts.html">3.3. Tool Options Pages</a></span></dt>
 
37
</dl>
 
38
</div>
 
39
<p>The Options dialog has a separate "pane" for Valkyrie and
 
40
Valgrind, as well as for each (supported) Valgrind tool.
 
41
Any flag or option which can be set on the command line is available
 
42
for modification via this dialog.  In addition, Valkyrie has a
 
43
number of preference options that can only be set via this dialog.
 
44
</p>
 
45
<p>On first-time startup, all options are set to their installation
 
46
defaults.  These can be changed via both the GUI and the command-line.
 
47
</p>
 
48
<div class="glosslist"><dl>
 
49
<dt>
 
50
<a name="opt_defaults"></a><span><b class="command">Defaults:</b></span>
 
51
</dt>
 
52
<dd><p>Sets all the options on the current page to the
 
53
    installation defaults.</p></dd>
 
54
<dt>
 
55
<a name="opt_reset"></a><span><b class="command">Reset:</b></span>
 
56
</dt>
 
57
<dd><p>Discards any changes to the current page.</p></dd>
 
58
<dt>
 
59
<a name="opt_apply"></a><span><b class="command">Apply:</b></span>
 
60
</dt>
 
61
<dd><p>Checks the current page's changes are valid, and
 
62
    uses them for the current session only.</p></dd>
 
63
<dt>
 
64
<a name="opt_ok"></a><span><b class="command">Ok:</b></span>
 
65
</dt>
 
66
<dd><p>Calls <span><b class="command">Apply</b></span> and closes the options window.</p></dd>
 
67
<dt>
 
68
<a name="opt_save"></a><span><b class="command">Save:</b></span>
 
69
</dt>
 
70
<dd><p>Checks current page's changes are valid, uses them
 
71
    for the current session, and then saves the changes in
 
72
    <span class="emphasis"><em>ALL</em></span> pages for future sessions too.</p></dd>
 
73
</dl></div>
 
74
<p>Note: Starting valkyrie with command-line options does not save
 
75
these option values to disk.  You must explicitly select
 
76
<span><b class="command">Save</b></span> to do this.</p>
 
77
<div class="sect1" lang="en">
 
78
<div class="titlepage">
 
79
<div><div><h2 class="title" style="clear: both">
 
80
<a name="valkyrie"></a>3.1.�Valkyrie Options Page</h2></div></div>
 
81
<div></div>
 
82
</div>
 
83
<div class="glosslist"><dl>
 
84
<dt>
 
85
<a name="tool_tips"></a><span><b class="command">Show tooltips:</b></span>
 
86
</dt>
 
87
<dd><p>Whether tooltips should be shown when the mouse 
 
88
    pointer hovers over a widget.<br>
 
89
    Applied application-wide.</p></dd>
 
90
<dt>
 
91
<a name="tool_label"></a><span><b class="command">Show toolbar text labels:</b></span>
 
92
</dt>
 
93
<dd><p>Whether text labels should be shown next to buttons.
 
94
    <br>Applied application-wide.</p></dd>
 
95
<dt>
 
96
<a name="palette"></a><span><b class="command">Use valkyrie`s palette:</b></span>
 
97
</dt>
 
98
<dd><p>Whether Valkyrie should use your default window palette 
 
99
    (aka "theme") or use her own.<br>
 
100
    Applied application-wide.</p></dd>
 
101
<dt>
 
102
<a name="browser"></a><span><b class="command">Browser:</b></span>
 
103
</dt>
 
104
<dd><p>This determines the default browser to use on
 
105
    clicking an external link.  If this option is empty (default),
 
106
    or fails to launch, a working browser is looked for in the
 
107
    environment variable $BROWSER.  If that also fails, some well
 
108
    known browsers are tried.  If a '-remote' command is given,
 
109
    the "%s" string is replaced with the targed url.<br>
 
110
    Example: "mozilla -remote openUrl(%s,new-tab)".</p></dd>
 
111
<dt>
 
112
<a name="log_dir"></a><span><b class="command">Log Dir:</b></span>
 
113
</dt>
 
114
<dd><p>This determines the default directory for the user to save
 
115
    their log files.<br>
 
116
    Note: When running, Valkyrie generates temporary log files. These
 
117
    are stored under /tmp/valkyrie_logs (this can be changed when building Valkyrie).<br>
 
118
    Example: "./".<br>
 
119
    Example: "/home/myself/valkyrie_logs".</p></dd>
 
120
<dt>
 
121
<a name="working_dir"></a><span><b class="command">Working Dir:</b></span>
 
122
</dt>
 
123
<dd><p>This determines the working directory under which valgrind runs
 
124
    (and therefore also the program being run by Valgrind). This does
 
125
    not change the current working directory of Valkyrie itself, but the
 
126
    that of the program being run.<br>
 
127
    Example: "./".<br>
 
128
    Example: "/home/myself/valkyrie_working_dir".</p></dd>
 
129
<dt>
 
130
<a name="user_font_general"></a><span><b class="command">General Font:</b></span>
 
131
</dt>
 
132
<dd><p>This is the general application font.
 
133
    If the 'Using system default' checkbox is enabled, Valkyrie will use
 
134
    your default system font.  If it is disabled, you can click "Choose"
 
135
    to bring up a font dialog to allow you to select an alternative font.<br>
 
136
    Applied application-wide, except for the main display of the
 
137
    tools.</p></dd>
 
138
<dt>
 
139
<a name="user_font_tool"></a><span><b class="command">Tool Font:</b></span>
 
140
</dt>
 
141
<dd><p>This font is used for the main display of the tools,
 
142
    for example the treeview of memcheck.  Clicking "Choose" will bring
 
143
    up a font dialog to allow you to select an alternative font.<br>
 
144
    Applied to all tools.</p></dd>
 
145
<dt>
 
146
<a name="src_lines"></a><span><b class="command">Extra lines shown above/below the target 
 
147
               line:</b></span>
 
148
</dt>
 
149
<dd><p>Memcheck-specific.  This value specifies the number of 
 
150
    source code lines to be shown above and below the target source line when 
 
151
    displaying errors in Memcheck ToolView.<br>
 
152
    Note that changing this value will not take effect until the next
 
153
    run.</p></dd>
 
154
<dt>
 
155
<a name="src_editor"></a><span><b class="command">Source editor:</b></span>
 
156
</dt>
 
157
<dd><p>Specify the 
 
158
    <tt class="computeroutput">/path/to/your/favourite/editor</tt>.
 
159
    In Memcheck, the editor is launched when a stack frame is
 
160
    double-clicked within Memcheck ToolView.  A replacement string
 
161
    "%n" is defined, which will be replaced with the target line number,
 
162
    when available, to open up the editor on that line number.<br>
 
163
    Example: "emacs +%n" =&gt; "emacs +21 /path/to/srcfile".</p></dd>
 
164
<dt>
 
165
<a name="binary"></a><span><b class="command">Binary:</b></span>
 
166
</dt>
 
167
<dd><p>Change the name of the executable to run to 
 
168
    <span class="emphasis"><em>/path/to/your/executable</em></span>.  If you started Valkyrie on 
 
169
    the command line with <tt class="computeroutput">valkyrie /path/to/exe</tt> 
 
170
    then <span class="emphasis"><em>/path/to/exe</em></span> is stored here.</p></dd>
 
171
<dt>
 
172
<a name="bin_flags"></a><span><b class="command">Binary flags:</b></span>
 
173
</dt>
 
174
<dd><p>Change the flags relevant to your executable. If you 
 
175
    started Valkyrie on the command line with <tt class="computeroutput">valkyrie 
 
176
    /path/to/your/exe --your-flags</tt> then 
 
177
    <span class="emphasis"><em>--your-flags</em></span> is stored here.</p></dd>
 
178
<dt>
 
179
<a name="valgrind"></a><span><b class="command">Valgrind:</b></span>
 
180
</dt>
 
181
<dd><p>This is the <span class="emphasis"><em>/path/to/valgrind</em></span>.
 
182
    You may change this to point to a different Valgrind executable.</p></dd>
 
183
</dl></div>
 
184
</div>
 
185
</div>
 
186
<div>
 
187
<br><table class="nav" width="100%" cellspacing="3" cellpadding="2" border="0" summary="Navigation footer">
 
188
<tr>
 
189
<td rowspan="2" width="40%" align="left">
 
190
<a accesskey="p" href="mainwindow.status_msg.html">&lt;&lt;�2.6.�Status Messages</a>�</td>
 
191
<td width="20%" align="center"><a accesskey="u" href="manual.html">Up</a></td>
 
192
<td rowspan="2" width="40%" align="right">�<a accesskey="n" href="options_valgrind.html">3.2.�Valgrind Options Page�&gt;&gt;</a>
 
193
</td>
 
194
</tr>
 
195
<tr><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td></tr>
 
196
</table>
 
197
</div>
 
198
</body>
 
199
</html>