Note: This tutorial assumes that you have completed the previous tutorials: 安装和配置ROS环境.

Please ask about problems and questions regarding this tutorial on answers.ros.org. Don't forget to include in your question the link to this page, the versions of your OS & ROS, and also add appropriate tags.

ROS文件系统导览

Description: 本教程介绍ROS文件系统的概念，包括如何使用roscd、rosls和rospack命令行工具。

Tutorial Level: BEGINNER

Next Tutorial: 创建ROS软件包

Contents

预备工作
ROS文件系统中的基本概念
文件系统工具
回顾

预备工作

本教程中我们将会用到ros-tutorials程序包，请先安装：

$ sudo apt-get install ros-<distro>-ros-tutorials

将 <distro> 替换成你所安装的版本（比如Jade、Indigo、hydro、groovy、fuerte等）。

ROS文件系统中的基本概念

Packages: Package是ROS系统中最底层最基本的组织，里面存放各种文件:库、工具、可执行文件等.
Manifest: 一个package描述xml文件，定义package之间的依赖关系.
Stacks: package的集合，比package这个概念高一级别
Stack Manifest: 作用类似package manifest文件，但是它是针对stack的.

在文件系统中很容易识别package和stack:

package是一个包含 manifest.xml 文件的目录.
stack是一个包含 stack.xml 文件的目录.

文件系统工具

ROS中大量代码分散在众多的packages和stacks之中. 命令工具ls 和 cd已不能满足检索要求。因此ROS提供了一套自己的命令工具来完成与这些命令相似的工作.

使用rospack和rosstack

rospack 和 rosstack 命令都包含于 rospack package中. 两个命令用于获取packages 和stacks的信息. 教程中我们只提及命令的find的参数,作用是返回相应package或者stack的目录路径.

用法:

$ rospack find [package_name]
$ rosstack find [stack_name]

例子:

$ rospack find roscpp

得到结果:

YOUR_INSTALL_PATH/stacks/ros_comm/clients/cpp/roscpp

举例，如果在Ubuntu下使用编译好的软件包安装了ROS Electric版本，将会得到如下结果:

/opt/ros/electric/stacks/ros_comm/clients/cpp/roscpp

使用roscd

roscd 包含于 rosbash package中. 该命令用于改变当前目录到指定的package或者stack的目录(cd).

用法:

$ roscd [locationname[/subdir]]

例子:

$ roscd roscpp

为了验证我们已经切换到了roscpp package 目录. 我们使用unix的命令查看一下pwd:

$ pwd

得到结果:

YOUR_INSTALL_PATH/stacks/ros_comm/clients/cpp/roscpp

现在可以看到结果YOUR_INSTALL_PATH/stacks/ros_comm/clients/cpp/roscpp 和先前rospack find 得到的是一样的.

命令 roscd及其它的ROS命令仅适用于环境变量$ROS_PACKAGE_PATH中存在的目录路径. 使用下面的命令查看环境变量$ROS_PACKAGE_PATH:

$ echo $ROS_PACKAGE_PATH

如果还没有编辑过 $ROS_PACKAGE_PATH 应该显示结果如下:

```
YOUR_INSTALL_PATH/stacks
```

$ROS_PACKAGE_PATH可以添加任意目录路径，目录路径之间 ':' 分开。

子目录

roscd 也能够直接进入一个 package 或 stack的子目录中.

例如:

$ roscd roscpp/include
$ pwd

得到结果:

YOUR_INSTALL_PATH/stacks/ros_comm/clients/cpp/roscpp/include

roscd的特殊用法

有几个roscd 的特殊用法.

roscd 不带任何参数

不带参数时roscd 直接进入环境变量 $ROS_ROOT 定义的目录. 例如:

$ roscd 
$ pwd

得到结果:

```
 YOUR_INSTALL_PATH/ros
```

这个目录就是环境变量 $ROS_ROOT定义的. 例如:

$ echo $ROS_ROOT

得到结果:

```
YOUR_INSTALL_PATH/ros
```

roscd log

roscd log 命令切换到ROS储存日志文件的目录。注意如果从未运行过任何ROS程序，命令会返回目录不存在的错误。

例如:

$ roscd log

使用 rosls

rosls 包含于rosbash package中. 作用是列出指定的package或stack中的文件及目录.

用法:

$ rosls [locationname[/subdir]]

例子:

$ rosls roscpp_tutorials

得到结果:

add_two_ints_client         listener                      listener_with_userdata  srv
add_two_ints_server         listener_async_spin           Makefile                srv_gen
add_two_ints_server_class   listener_class                manifest.xml            talker
anonymous_listener          listener_multiple             node_handle_namespaces  time_api
babbler                     listener_single_message       notify_connect          timers
bin                         listener_threaded_spin        parameters
CMakeLists.txt              listener_unreliable           ROS_NOBUILD
custom_callback_processing  listener_with_tracked_object  src

Tab Completion

在键盘输入ROS命令及目录文件名时，使用tab键可以自动补齐剩余的命令字符。例如:

$ roscd roscpp_tut<<< now push the TAB key >>>

按下 TAB 键后, 命令行会自动补齐.

```
$ roscd roscpp_tutorials/
```

如果存在有歧义的package时，可以连续按下tab键将会切换显示所有相关的ROS package名称。

例如:

$ roscd tur<<< now push the TAB key >>>

按下 TAB 键后, 命令行会如下显示:

```
$ roscd turtle
```

但是，例子中有多个packages 开头包含字符 turtle.

试着再次按下 TAB 键. 这会切换显示所有的以字符 turtle 开头的ROS packages。

  turtle_actionlib/  turtlesim/         turtle_tf/

得到结果：

```
$ roscd turtle
```

现在 turtle 后面输入 s ，然后按下 TAB

$ roscd turtles<<< now push the TAB key >>>

因为只有一个package 以字符 turtles开头,所以得到结果如下:

```
$ roscd turtlesim/
```

回顾

ROS 工具命令有个固定的命名格式:

rospack = ros + pack(age)
rosstack = ros + stack
roscd = ros + cd
rosls = ros + ls

Contents

预备工作
文件系统概念简介
文件系统工具
复习

预备工作

本教程中我们将会用到ros-tutorials程序包。如果你之前安装的ROS不是完整桌面版（Desktop-Full），请先：

$ sudo apt-get install ros-<distro>-ros-tutorials

将<distro>替换成你安装的ROS发行版简称（比如kinetic或noetic等）。

文件系统概念简介

软件包（Packages）：包是ROS代码的软件组织单元，每个软件包都可以包含程序库、可执行文件、脚本或其他构件。
Manifests (package.xml)： 清单（Manifest）是对软件包的描述。它用于定义软件包之间的依赖关系，并记录有关软件包的元信息，如版本、维护者、许可证等。

Show Hide note about stacks note about stacks

Note: rosbuild的用户也许会考虑功能包集（stack）去哪了。事实上，为了简化代码量且更好的支持兼容各发行版的功能包，功能包集的概念已经在 catkin 中被移除。在 catkin 中，你可以定义元包来集成相似的包，并实现将多个包驻留在单个 VCS 库。这两个特征可替换功能包集的功能。

文件系统工具

程序代码散落在许多ROS包中。使用Linux内置命令行工具（如ls和cd）来进行查找和导航可能非常繁琐，因此ROS提供了专门的命令工具来简化这些操作。

使用rospack

rospack允许你获取软件包的有关信息。在本教程中，我们只涉及到find参数选项，该选项可以返回软件包的所在路径。

用法：

$ rospack find [package_name]

比如：

$ rospack find roscpp

将会输出：

```
YOUR_INSTALL_PATH/share/roscpp
```

如果你是在Ubuntu操作系统上通过apt安装的ROS，你看到的应该是：

```
/opt/ros/<distro>/share/roscpp
```

使用roscd

roscd是rosbash命令集的一部分，它允许你直接切换目录（cd）到某个软件包或者软件包集当中。

用法：

$ roscd [locationname[/subdir]]

要想验证是否能切换到roscpp包的位置，请运行以下示例：

$ roscd roscpp

现在让我们使用Unix命令pwd输出工作目录：

$ pwd

你应该会看到：

```
YOUR_INSTALL_PATH/share/roscpp
```

你可以看到YOUR_INSTALL_PATH/share/roscpp和之前使用rospack find输出的路径是一样的。

注意，就像ROS中的其它工具一样，roscd只能切换到那些路径已经包含在ROS_PACKAGE_PATH环境变量中的软件包。要查看 ROS_PACKAGE_PATH中包含的路径，可以输入：

$ echo $ROS_PACKAGE_PATH

你的ROS_PACKAGE_PATH环境变量应该包含那些保存有ROS软件包的路径，并且每个路径之间用冒号（:）分隔开来。一个典型的ROS_PACKAGE_PATH环境变量如下：

```
/opt/ros/<distro>/base/install/share
```

跟其他环境变量路径类似，你可以在ROS_PACKAGE_PATH中添加更多的目录，每条路径使用冒号（:）分隔。

子目录

roscd也可以切换到一个软件包或软件包集的子目录中。

执行：

$ roscd roscpp/cmake
$ pwd

应该会看到：

```
YOUR_INSTALL_PATH/share/roscpp/cmake
```

roscd log

roscd log将带您进入存储ROS日志文件的目录。需要注意的是，如果你没有执行过任何ROS程序，系统会报错说该目录不存在。

如果你已经运行过ROS程序，那么可以尝试：

$ roscd log

使用 rosls

rosls 是rosbash命令集的一部分，它允许你直接按软件包的名称执行 ls 命令（而不必输入绝对路径）。

用法：

$ rosls [locationname[/subdir]]

示例：

$ rosls roscpp_tutorials

应输出：

```
cmake launch package.xml  srv
```

Tab补全

总是输入完整的软件包名称感觉比较繁琐。在之前的例子中，roscpp tutorials是个相当长的名称。幸运的是，一些ROS工具支持TAB补全的功能。

试着开始输入：

$ roscd roscpp_tut<<<按TAB键>>>

当按TAB键后，命令行应该会自动补充剩余部分：

$ roscd roscpp_tutorials/

这是因为roscpp_tutorials是目前唯一一个名称以roscpp_tut开头的ROS软件包。

现在试着输入：

$ roscd tur<<<按TAB键>>>

当按TAB键后，命令应该会尽可能地自动补充完整：

$ roscd turtle

然而，在这种情况下有许多软件包都以turtle开头。当再次按TAB键后会列出所有以turtle开头的ROS软件包：

turtle_actionlib/  turtlesim/         turtle_tf/

这时在命令行中你仍然只输入了：

$ roscd turtle

现在在turtle后面输入s然后按TAB键：

$ roscd turtles<<<按TAB键>>>

因为只有一个软件包的名称以turtles开头，所以你应该会看到：

$ roscd turtlesim/

如果要查看当前安装的所有软件包的列表，你也可以利用TAB补全：

$ rosls <<<双击TAB键>>>

复习

你也许已经注意到了ROS命令工具的的命名方式：

rospack = ros + pack(age)
roscd = ros + cd
rosls = ros + ls

这种命名模式在许多ROS命令工具中都会用到。

到此你已经了解了ROS的文件系统结构，接下来开始创建ROS软件包吧。

ROS 2 Documentation

Wiki

Page

User

ROS文件系统导览

预备工作

ROS文件系统中的基本概念

文件系统工具

使用rospack和rosstack

使用roscd

子目录

roscd的特殊用法

roscd 不带任何参数

roscd log

使用 rosls

Tab Completion

回顾

预备工作

文件系统概念简介

文件系统工具

使用rospack

使用roscd

子目录

roscd log

使用 rosls

Tab补全

复习