Sophie: player-doc-3.0.2-5.fc14 noarch

player-doc-3.0.2-5.fc14.noarch.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
   "http://www.w3.org/TR/html4/strict.dtd">

<html>
<!-- $Id: header.html 8799 2010-06-28 04:12:42Z jpgr87 $ -->

<HEAD>


<meta HTTP-EQUIV="Content-Type" CONTENT="text/html;CHARSET=utf-8">
<meta name="keywords" content="stage, robot, simulation, player, player/stage">
<link href="doxygen.css" rel="stylesheet" type="text/css">

<style type="text/css">

.floatright { float: right; margin: 0 0 1em 1em; }

body {
  font-family: sans-serif;
  #font-family: Geneva, Verdana, Helvetica, Arial, sans-serif;
  background-color: #FFF;
  color:#000;
}


a:link { 
	color: #A00;
}

a:visited { 
	color: #800;
}

a { text-decoration: none; }
a:hover { text-decoration: underline; }


.timestamp { text-align:right; background-color: #DDD; font-size:75%;}

h1 { 
  font-size:160%; 
}

h2 {
  font-size:110%;
  #color: #FFF;
  #background-color: #666;
  #padding:3px;
}

h3 { text-align:left; }

img {
  border: 0;
}

ul.menu { 
    position:relative;
    left:-2.5em;
    margin-bottom:0px;
    margin-top:0px;
}

ul.menu1 { 
    position:relative;
    left:-2.1em;
    margin-bottom:0px;
    margin-top:0px;
}

li.menu { 
    list-style-type: none;
    position:relative;
    #left:-0.5em;
}


#sidebar { position: absolute; left:0px; padding:2em; top:0em; width:12em;}

#content { position: absolute; left:12em; top:0em; padding-left:3em; padding-right:3em; padding-bottom:2em; margin-top:1em; margin-right:2em; }

div.box { background-color:#EEE; border: 1px solid #000; padding: 0.5ex 0.4em 0.5ex 0.6em; margin:1em;  }
div.title { font-weight:bold; background-color:#eee; margin-bottom:2px;}

div.topbar { position: absolute; top:0px; left:9em; margin:1em; }

</style>

<TITLE>Player Manual</TITLE>

</HEAD>

<body>

<div id="sidebar"> 

<h2 style="text-align:center;">
<a href="index.html">
<img width=140 src="http://playerstage.sourceforge.net/images/player_button_v3.png" alt="Player logo"><br></a>
</h2>



<div class="box">
<div class=title>Player</div>

<ul class=menu>
<li class=menu><a href="index.html">Frontpage</a>
<li class=menu><a href="modules.html">Contents</a>
</ul>
</div>

<div class="box">
<div class=title>User</div>

<ul class=menu>
<li class=menu><a href="install.html">Installation</a>
<li class=menu><a href="start.html">Quick start</a>
<li class=menu><a href="supported_hardware.html">Supported&nbsp;devices</a>
<li class=menu><a href="group__tutorials.html">Tutorials</a>
<li class=menu><a href="group__utils.html">Utilities</a>
<li class=menu><a href="group__clientlibs.html">Client&nbsp;libraries</a>
<li class=menu><a href="http://playerstage.sourceforge.net/wiki/Basic_FAQ">FAQ</a>
<li class=menu><a href="help.html">Help</a>

</ul>
</div>

<div class=box>
<div class="title">Developer</div>
<ul class=menu>
<li class=menu><a href="architecture.html">Architecture</a>
<li class=menu><a href="group__libplayercore.html">libplayercore</a>
<ul class=menu1>
<li class=menu><a href="group__interfaces.html">interfaces</a></li>
</ul>
<li class=menu><a href="group__libplayerdrivers.html">libplayerdrivers</a>
<ul class=menu1>
<li class=menu><a href="group__drivers.html">drivers</a></li>
</ul>
<li class=menu><a href="group__libplayercommon.html">libplayercommon</a>
<li class=menu><a href="group__libplayerutils.html">libplayerutils</a>
<li class=menu><a href="group__libplayersd.html">libplayersd</a>
<li class=menu><a href="group__libplayertcp.html">libplayertcp</a>
<li class=menu><a href="group__libplayerxdr.html">libplayerxdr</a>
<li class=menu><a href="todo.html">TODO</a>
</ul>
</div>

<div class=box>
<!-- <a href="http://sourceforge.net"><img border=0 src="http://sourceforge.net/sflogo.php?group_id=42445&type=1"></a> -->
<div class="title">Online</div>
<a href="http://playerstage.sourceforge.net">Homepage</a><br>
<a href="http://sourceforge.net/project/showfiles.php?group_id=42445">Download</a><br>
<a href="http://sourceforge.net/projects/playerstage">Project</a><br>
<a href="http://sourceforge.net/tracker/?group_id=42445">Bugs</a><br>
<a href="http://sourceforge.net/mail/?group_id=42445">Help</a>
</div>


</div>

<div id="content" >
<!-- Generated by Doxygen 1.7.1 -->
<div class="header">
  <div class="headertitle">
<h1>playervcr<br/>
<small>
[<a class="el" href="group__utils.html">Player utilities</a>]</small>
</h1>  </div>
</div>
<div class="contents">

<p>Remote control of data logging and playback.  
<a href="#_details">More...</a></p>
<table class="memberdecls">
</table>
<p>Remote control of data logging and playback. </p>
<dl class="user"><dt><b>Synopsis</b></dt><dd></dd></dl>
<p>playervcr is a GUI client that provides VCR-like control over the recording and playback of logfiles. It does this via the <a class="el" href="group__interface__log.html">log</a> interface of the <a class="el" href="group__driver__writelog.html">writelog</a> and <a class="el" href="group__driver__readlog.html">readlog</a> drivers, respectively.</p>
<p>playervcr requires GTK.</p>
<dl class="user"><dt><b>Usage</b></dt><dd></dd></dl>
<p>playervcr is installed alongside player in $prefix/bin, so if player is in your PATH, then playervcr should also be. Command-line usage is: </p>
<div class="fragment"><pre class="fragment">
$ playervcr [-h &lt;host&gt;] [-p &lt;port&gt;] [-i &lt;index&gt;]
</pre></div><p> Where the options are:</p>
<ul>
<li>-h &lt;host&gt; : connect to Player on this host (default: localhost)</li>
<li>-p &lt;port&gt; : connect to Player at this port (default: 6665)</li>
<li>-i &lt;index&gt; : connect to the <a class="el" href="group__interface__log.html">log</a> device with this index</li>
</ul>
<p>To use playervcr, you must create a <a class="el" href="group__interface__log.html">log</a> device, such as "log:0", in your configuration file. Look at the docs for the <a class="el" href="group__driver__writelog.html">writelog</a> and <a class="el" href="group__driver__readlog.html">readlog</a> drivers for examples.</p>
<p>When playervcr starts, a single window containing a few self-explanatory buttons will pop up. The buttons will differ depending on whether the underlying driver reads from or writes to the log. When reading data, you can rewind, start, and stop; when writing data, you can start and stop.</p>
<dl class="user"><dt><b>Screenshots</b></dt><dd></dd></dl>
<div align="center">
<img src="playervcr-writelog.jpg" alt="playervcr-writelog.jpg"/>
<p><strong>Screenshot of playervcr controlling a writelog device</strong></p></div>
<div align="center">
<img src="playervcr-readlog.jpg" alt="playervcr-readlog.jpg"/>
<p><strong>Screenshot of playervcr controlling a readlog device</strong></p></div>
 <dl class="author"><dt><b>Author:</b></dt><dd>Brian Gerkey </dd></dl>
</div>
<!-- render the modification time of the source file -->


<div class="timestamp">
<hr>

<table style="width:100%;">
<tr>
<td style="text-align:left;">
Last updated 12 September 2005 21:38:45
<!--
<td style="text-align:right;">
<a href="http://validator.w3.org/check/referer"><img style="vertical-align:middle;border:0;width:88px;height:31px"
          src="http://www.w3.org/Icons/valid-html401"
          alt="Valid HTML 4.01!"></a>

 <a href="http://jigsaw.w3.org/css-validator/">
  <img style="vertical-align:middle;border:0;width:88px;height:31px"
       src="http://jigsaw.w3.org/css-validator/images/vcss"
       alt="Valid CSS!">
 </a>
-->
</tr>
</table>
</div>


</tr>
</table>

</BODY>
</HTML>