/usr/share/doc/valkyrie/html/introduction.html is in valkyrie 2.0.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 | <html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>1. Introduction</title>
<link rel="stylesheet" href="valkyrie.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
<link rel="home" href="index.html" title="Valkyrie Documentation">
<link rel="up" href="manual.html" title="Valkyrie User Manual">
<link rel="previous" href="manual.html" title="Valkyrie User Manual">
<link rel="next" href="intro.why_valkyrie.html" title="1.2. Why Valkyrie is thusly named">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<div><table class="nav" width="100%" cellspacing="3" cellpadding="3" border="0" summary="Navigation header"><tr>
<td width="22px" align="center" valign="middle"><a accesskey="p" href="manual.html"><img src="images/prev.png" width="18" height="21" border="0" alt="Prev"></a></td>
<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>
<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>
<th align="center" valign="middle">Valkyrie User Manual</th>
<td width="22px" align="center" valign="middle"><a accesskey="n" href="intro.why_valkyrie.html"><img src="images/next.png" width="18" height="21" border="0" alt="Next"></a></td>
</tr></table></div>
<div class="chapter" lang="en">
<div class="titlepage">
<div><div><h2 class="title">
<a name="introduction"></a>1. Introduction</h2></div></div>
<div></div>
</div>
<div class="toc">
<p><b>Table of Contents</b></p>
<dl>
<dt><span class="sect1"><a href="introduction.html#overview">1.1. An Overview of Valkyrie</a></span></dt>
<dt><span class="sect1"><a href="intro.why_valkyrie.html">1.2. Why Valkyrie is thusly named</a></span></dt>
</dl>
</div>
<div class="sect1" lang="en">
<div class="titlepage">
<div><div><h2 class="title" style="clear: both">
<a name="overview"></a>1.1. An Overview of Valkyrie</h2></div></div>
<div></div>
</div>
<p>Valkyrie is a graphical front-end to the Valgrind suite of tools for
debugging and profiling Linux executables. The current version supports
Valgrind from version 3.3.0. Currently, the only supported Valgrind tool
is Memcheck.</p>
<p>Valkyrie uses the Qt widget library, and should run on most reasonably
recent Linux setups. The only sine qua non is that you must have:</p>
<div class="itemizedlist"><ul type="bullet">
<li style="list-style-type: disc"><p>Qt v.3.2.0 or higher (but not Qt v.4 as yet),
and</p></li>
<li style="list-style-type: disc"><p>Valgrind v.3.3.0 or higher.</p></li>
</ul></div>
<p>Valkyrie also contains a program <span><b class="command">vk_logmerge</b></span>.
Given multiple log files (in xml format) generated by multiple runs on
a parallel machine, or multiple log files generated by sequential runs
on a single-processor machine, for the same binary,
<span><b class="command">vk_logmerge</b></span> merges the log files together, summing
the counts of duplicates, and outputs the result to a single file.
As input, <span><b class="command">vk_logmerge</b></span> expects the log-files
to-be-merged and/or a file containing the list of log-files to-be-merged,
with each entry on a separate line.
Log files can be merged from within Valkyrie, or you can use it in
non-gui mode by invoking it thusly:</p>
<pre class="programlisting">
vk_logmerge -f <log-file-list> [-o <output-file>]
</pre>
<pre class="programlisting">
vk_logmerge log1.xml log2.xml [-o <output-file>]
</pre>
<p>Issue the command:</p>
<pre class="programlisting">
valkyrie -h | --help
</pre>
<p>to see a list of command-line flags.</p>
<p>Valkyrie can be started with flags on the command-line.
Below are some examples of common usage.</p>
<div class="itemizedlist"><ul type="disc">
<li>
<p><tt class="computeroutput">valkyrie --view-log=log.xml</tt></p>
<p>will start up the graphical user interface, with
<span class="emphasis"><em>log-file-to-view</em></span> in the process of being loaded.</p>
</li>
<li>
<p><tt class="computeroutput">valkyrie --merge=tomerge.loglst</tt></p>
<p>will start up the user interface, with <span class="emphasis"><em>log-file-list</em></span>
in the process of being merged.</p>
</li>
<li>
<p><tt class="computeroutput">valkyrie /bin/ls -lF</tt></p>
<p>will start up the user interface. This command differs from the
above two in that Valgrind is being called to run the executable
<span class="emphasis"><em>ls</em></span>. Currently only Memcheck is supported, so
this is the tool used on the executable.</p>
</li>
<li>
<p>You can give many of the Valgrind flag(s) on the command line:</p>
<p><tt class="computeroutput">valkyrie --smc-check=none --pointercheck=yes /bin/ls -lF</tt></p>
<p>Some options are currently disabled, however, as Valgrind presets these
options when producing XML output, which Valkyrie requires. Valkyrie
also disables options that would interfere with the gathering of Valgrind's
output, such as logging options.</p>
</li>
</ul></div>
<p>See the <a href="options_dialog.html">Options Dialog</a> pages for more information
on setting and saving the various flags, options and preferences.</p>
<p>Below is an example screenshot of the result of running
<tt class="computeroutput">valkyrie xclock</tt>
</p>
<p>An error is opened up for scrutiny. If the file in which
the error occurred has read and/or write permissions, and Valgrind was able
to determine the <span class="emphasis"><em>/path/to/the/file</em></span>, an icon will be
displayed. If you have write permission on the file, the icon will show a
pencil; otherwise it will not. Double-clicking on this icon will launch an
editor with the file loaded at the line where the error occurred.</p>
<p>If you do not have read and/or write permissions on the file, the error
will still be displayed, but you will not be able to launch an editor.</p>
<div class="mediaobject">
<a name="screenshot-1"></a><img src="images/screenshot_1.png" alt="An Open Error">
</div>
<p>Just as when running a client program directly under Valgrind,
the client program retains input/output with the terminal in which
Valkyrie was started. You could, for example, run ssh under Valkryie:<br>
<tt class="computeroutput">valkyrie ssh hostname</tt><br>
and all input/output should pass through transparently.
Any output from Valkyrie (for example if an error occured) is
prefixed by "===valkyrie:pid===".</p>
</div>
</div>
<div>
<br><table class="nav" width="100%" cellspacing="3" cellpadding="2" border="0" summary="Navigation footer">
<tr>
<td rowspan="2" width="40%" align="left">
<a accesskey="p" href="manual.html"><< Valkyrie User Manual</a> </td>
<td width="20%" align="center"><a accesskey="u" href="manual.html">Up</a></td>
<td rowspan="2" width="40%" align="right"> <a accesskey="n" href="intro.why_valkyrie.html">1.2. Why Valkyrie is thusly named >></a>
</td>
</tr>
<tr><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td></tr>
</table>
</div>
</body>
</html>
|