~robot3d-team/robot3d/trunk

.\"Created with GNOME Manpages Editor Wizard

.\"http://sourceforge.net/projects/gmanedit2

.TH robot3d 1 "November 24, 2010" "" "Robot3D"

 

.SH NAME

robot3d \- application to simulate modular or swarm robots

 

.SH SYNOPSIS

.B robot3d

.RI [ options ]

.br

 

.SH DESCRIPTION

This manual page explains the

.B robot3d

application. This application is built on top of Delta3D, a game engine. The shortcut robot3d is actually a script that runs "GameStart Robot3D". It first checks if a YARP server is running. This is a prerequisite to interface the Robot3D simulator with so-called YARP components. It then actually starts the simulator in the $HOME/.robot3d directory and creates this directory if it does not exist. Install zenity to get nice formatted messages in gnome.

.PP

\fBRobot3D\fP is a modular robot simulator. The simulator contains many robots that can each individually be controlled over a so-called YARP interface. This interface provides a way to query individual robots, sensors, actuators, and objects, as well as the entire Robot3D simulator. By default TCP is used, which enables running the Robot3D simulator on a  machine different from the machine that runs the individual controllers for the robots. A selected set of controllers will become available over time, but they are maintained separately from the Robot3D simulator.

 

.SH OPTIONS

.B

.IP --debug

This option requires gdb to be installed on your system. It runs the simulator within gdb. Use this option to backtrace segmentation faults.

.B

.IP --memcheck

This option requires valgrind to be installed on your system. It runs the simulator with valgrind. Use this option to check for memory leakage. It can also help to track segmentation faults in the case of corrupted iterators.

 

.SH "SEE ALSO"

http://www.replicators.eu, http://www.robotcognition.eu, http://www.delta3d.org, http://www.symbrion.eu