<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>roslocate: locate source-control repositories — rosinstall 0.6 documentation</title>
<link rel="stylesheet" href="_static/haiku.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/print.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '0.6',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/theme_extras.js"></script>
<link rel="top" title="rosinstall 0.6 documentation" href="index.html" />
<link rel="next" title="rosco: checkout source code for ROS resources" href="rosco.html" />
<link rel="prev" title="rosws: A tool for managing source code workspaces" href="rosws.html" />
</head>
<body>
<div class="header"><h1 class="heading"><a href="index.html">
<span>rosinstall 0.6 documentation</span></a></h1>
<h2 class="heading"><span>roslocate: locate source-control repositories</span></h2>
</div>
<div class="topnav">
<p>
«  <a href="rosws.html">rosws: A tool for managing source code workspaces</a>
  ::  
<a class="uplink" href="index.html">Contents</a>
  ::  
<a href="rosco.html">rosco: checkout source code for ROS resources</a>  »
</p>
</div>
<div class="content">
<div class="section" id="roslocate-locate-source-control-repositories">
<h1><a class="toc-backref" href="#id2">roslocate: locate source-control repositories</a><a class="headerlink" href="#roslocate-locate-source-control-repositories" title="Permalink to this headline">¶</a></h1>
<p><tt class="docutils literal"><span class="pre">roslocate</span></tt> is a tool for finding version-control and other
information about a ROS package or stack. The main use is to locate
the source-control repository of a resource, though it can also
provide additional metadata about that resource.</p>
<p>The roslocate script was suggested in <a class="reference internal" href="#rep115">[REP115]</a>.</p>
<div class="contents topic" id="contents">
<p class="topic-title first">Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#roslocate-locate-source-control-repositories" id="id2">roslocate: locate source-control repositories</a><ul>
<li><a class="reference internal" href="#usage" id="id3">Usage</a><ul>
<li><a class="reference internal" href="#describe" id="id4">describe</a></li>
<li><a class="reference internal" href="#info" id="id5">info</a></li>
<li><a class="reference internal" href="#repo" id="id6">repo</a></li>
<li><a class="reference internal" href="#uri" id="id7">uri</a></li>
<li><a class="reference internal" href="#vcs" id="id8">vcs</a></li>
<li><a class="reference internal" href="#www" id="id9">www</a></li>
<li><a class="reference internal" href="#distro-distro-name" id="id10">–distro=DISTRO_NAME</a></li>
<li><a class="reference internal" href="#dev" id="id11">–dev</a></li>
</ul>
</li>
<li><a class="reference internal" href="#indexer" id="id12">Indexer</a></li>
<li><a class="reference internal" href="#see-also" id="id13">See also</a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="usage">
<h2><a class="toc-backref" href="#id3">Usage</a><a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
<div class="highlight-python"><pre>roslocate
info Get rosinstall info of resource
vcs Get name of source control system
type Package or stack
uri Get source control URI of resource
www Get web page of resource
repo Get repository name of resource
describe Get description of resource</pre>
</div>
<p><tt class="docutils literal"><span class="pre">roslocate</span></tt> has a command-based API. Each of the commands is described below.</p>
<div class="section" id="describe">
<h3><a class="toc-backref" href="#id4">describe</a><a class="headerlink" href="#describe" title="Permalink to this headline">¶</a></h3>
<p><tt class="docutils literal"><span class="pre">roslocate</span> <span class="pre">describe</span></tt> summarizes information about a ROS package or
stack.</p>
<p>Example:</p>
<div class="highlight-python"><pre>$ roslocate describe rosinstall
Type: package
Stack: ros_release
Description: rosinstall is a tool to check out ROS source code (or
any source code, really) from multiple version control
repositories and updating these checkouts. Given a *.rosinstall
file that specifies where to get code, rosinstall will check out a
working copy for you. We recommend the use of rosinstall when
checking out development versions of ROS source code. This package
is where the code lives, however it is not expected for users to
checkout and use this package directly. It is expected that users
use the version available through pypi.python.org.
URL: http://ros.org/wiki/rosinstall</pre>
</div>
</div>
<div class="section" id="info">
<h3><a class="toc-backref" href="#id5">info</a><a class="headerlink" href="#info" title="Permalink to this headline">¶</a></h3>
<p>Prints the rosinstall entry for the resource.</p>
<p>Example:</p>
<div class="highlight-python"><pre>$ roslocate info common
- hg:
local-name: common
meta:
repo-name: wg-kforge
uri: https://kforge.ros.org/common/common
version: default</pre>
</div>
</div>
<div class="section" id="repo">
<h3><a class="toc-backref" href="#id6">repo</a><a class="headerlink" href="#repo" title="Permalink to this headline">¶</a></h3>
<p>Prints the name of the repository the resource is stored in. This
repository name is for display purposes only – it cannot be used as
input to source control tools.</p>
<p>Example:</p>
<div class="highlight-python"><pre>$ roslocate repo cram_pl
tum-ros-pkg</pre>
</div>
</div>
<div class="section" id="uri">
<h3><a class="toc-backref" href="#id7">uri</a><a class="headerlink" href="#uri" title="Permalink to this headline">¶</a></h3>
<p>Prints the source control URI of a resource. This is mainly intended
as input to other programs via shell backtick or pipe.</p>
<p>Example:</p>
<div class="highlight-python"><pre>$ roslocate uri rospy
https://code.ros.org/svn/ros/stacks/ros_comm/trunk/clients/rospy</pre>
</div>
</div>
<div class="section" id="vcs">
<h3><a class="toc-backref" href="#id8">vcs</a><a class="headerlink" href="#vcs" title="Permalink to this headline">¶</a></h3>
<p>Prints the type of version control system used for the resource.
Possible values include <tt class="docutils literal"><span class="pre">svn</span></tt>, <tt class="docutils literal"><span class="pre">hg</span></tt>, <tt class="docutils literal"><span class="pre">git</span></tt>, and <tt class="docutils literal"><span class="pre">bzr</span></tt>.</p>
<p>Example:</p>
<div class="highlight-python"><pre>$ roslocate vcs common
hg</pre>
</div>
</div>
<div class="section" id="www">
<h3><a class="toc-backref" href="#id9">www</a><a class="headerlink" href="#www" title="Permalink to this headline">¶</a></h3>
<p>Prints the website of a resource.</p>
<p>Example:</p>
<div class="highlight-python"><pre>$ roslocate www rospy
http://ros.org/wiki/rospy</pre>
</div>
</div>
<div class="section" id="distro-distro-name">
<h3><a class="toc-backref" href="#id10">–distro=DISTRO_NAME</a><a class="headerlink" href="#distro-distro-name" title="Permalink to this headline">¶</a></h3>
<p>If the <tt class="docutils literal"><span class="pre">--distro=DISTRO_NAME</span></tt> option is combined with a roslocate
command, the information returned will be based on a particular
distribution release of a resource.</p>
<p>Example:</p>
<div class="highlight-python"><pre>$ roslocate info rospy
- svn:
local-name: rospy
uri: https://code.ros.org/svn/ros/stacks/ros_comm/trunk/clients/rospy
$ roslocate info rospy --distro=diamondback
- svn:
local-name: ros_comm
uri: https://code.ros.org/svn/ros/stacks/ros_comm/tags/ros_comm-1.4.7</pre>
</div>
</div>
<div class="section" id="dev">
<h3><a class="toc-backref" href="#id11">–dev</a><a class="headerlink" href="#dev" title="Permalink to this headline">¶</a></h3>
<p>If the <tt class="docutils literal"><span class="pre">--dev</span></tt> option is combined with a roslocate command, the
information returned will be based on the development branch of the
resource (e.g. <tt class="docutils literal"><span class="pre">trunk</span></tt>), if possible. It should be used in
combination with the <tt class="docutils literal"><span class="pre">--distro=DISTRO_NAME</span></tt> option as development
trees are indexed based on a particular ROS distribution.</p>
<p>The <tt class="docutils literal"><span class="pre">-dev</span></tt> option generally only affects source control information,
like URIs and rosinstall entries. Other information, like resource
descriptions, are not guaranteed to be development-branch specific.</p>
<p>Example:</p>
<div class="highlight-python"><pre>$ roslocate info rospy --distro=electric
- svn:
local-name: ros_comm
uri: https://code.ros.org/svn/ros/stacks/ros_comm/tags/ros_comm-1.6.0
$ roslocate info rospy --distro=electric --dev
- svn:
local-name: ros_comm
uri: https://code.ros.org/svn/ros/stacks/ros_comm/trunk</pre>
</div>
</div>
</div>
<div class="section" id="indexer">
<h2><a class="toc-backref" href="#id12">Indexer</a><a class="headerlink" href="#indexer" title="Permalink to this headline">¶</a></h2>
<p><tt class="docutils literal"><span class="pre">roslocate</span></tt> is a command-line interface for accessing information
produced by the ROS.org indexing system, which crawls the known public
repositories of ROS-compatible software.</p>
<p>The process for getting a repository added to this index is described
<a class="reference external" href="http://www.ros.org/wiki/Get%20Involved#Create_Your_Own_.2A-ros-pkg_Repository">on the “Get Involved” ROS.org page</a>.
The indexer files themselves are stored in the <tt class="docutils literal"><span class="pre">rosdoc_rosorg</span></tt>
package, which can be <a class="reference external" href="https://code.ros.org/svn/ros/stacks/rosorg/trunk/rosdoc_rosorg/>_`.">browsed online</a>.
Of particular interest is the <tt class="docutils literal"><span class="pre">repos.list</span></tt> file as well as the
individual rosinstall file in the <tt class="docutils literal"><span class="pre">repos</span></tt> directory.</p>
</div>
<div class="section" id="see-also">
<h2><a class="toc-backref" href="#id13">See also</a><a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
<table class="docutils citation" frame="void" id="rep115" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id1">[REP115]</a></td><td>rosco and roslocate tools for rosinstall
(<a class="reference external" href="http://www.ros.org/reps/rep-0115.html">http://www.ros.org/reps/rep-0115.html</a>)</td></tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="bottomnav">
<p>
«  <a href="rosws.html">rosws: A tool for managing source code workspaces</a>
  ::  
<a class="uplink" href="index.html">Contents</a>
  ::  
<a href="rosco.html">rosco: checkout source code for ROS resources</a>  »
</p>
</div>
<div class="footer">
© Copyright 2011, Willow Garage.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>
