Documentation/devtools/maemo5

(→Categories)
(reformat tables)
Line 1: Line 1:
-
These tools are available in the official maemo 5 Fremantle tools repository at repository.maemo.org. Some of them may have already been available unofficially, but these versions are tested for functionality.
+
These tools are available in the official Maemo 5 Fremantle tools repository at repository.maemo.org. Some of them may have already been available unofficially, but these versions are tested for functionality.
You can propose new tools by filing an enhancement request in Bugzilla.
You can propose new tools by filing an enhancement request in Bugzilla.
-
Installation instructions are available [[#Installation | below]].
+
Installation instructions are available [[#Installation|below]].
-
 
+
== Categories ==
== Categories ==
Line 10: Line 9:
The tools are arranged into different categories so that you can easily see what tools are available for specific kinds of tasks. The same tool can be present in multiple categories.
The tools are arranged into different categories so that you can easily see what tools are available for specific kinds of tasks. The same tool can be present in multiple categories.
-
=== Code Analiza ===
+
=== Code Analyser ===
-
{| style="width:75%" border="1" cellpadding="2"
+
 
-
|-style="background:white"
+
{| class="wikitable"
-
|[[Documentation/devtools/maemo5/doxygen | doxygen]] || a source code documentation generator tool
+
|-
-
|-style="background:white"
+
! Tool !! Description
-
| [[Documentation/devtools/maemo5/gtk-doc | gtk-doc]] || an API documentation generator
+
|-
 +
| [[Documentation/devtools/maemo5/doxygen|doxygen]] || a source code documentation generator tool
 +
|-
 +
| [[Documentation/devtools/maemo5/gtk-doc|gtk-doc]] || an API documentation generator
|}
|}
 +
=== Debugging ===
=== Debugging ===
-
{| style="width:75%" border="1" cellpadding="2"
+
 
-
|-style="background:white"
+
{| class="wikitable"
-
| [[Documentation/devtools/maemo5/crash-reporter | crash-reporter]] || user-friendly graphical user interface for [[Documentation/devtools/maemo5/sp-rich-core | sp-rich-core]]
+
|-
-
|-style="background:white"
+
! Tool !! Description
-
|[[Documentation/devtools/maemo5/gdb | gdb]] || GDB is the GNU debugger
+
|-
-
|-style="background:white"
+
| [[Documentation/devtools/maemo5/crash-reporter|crash-reporter]] || user-friendly graphical user interface for [[Documentation/devtools/maemo5/sp-rich-core|sp-rich-core]]
-
| [[Documentation/devtools/maemo5/functracer | functracer]] || an allocation backtrace tool
+
|-
-
|-style="background:white"
+
| [[Documentation/devtools/maemo5/gdb|gdb]] || GDB is the GNU debugger
-
|[[Documentation/devtools/maemo5/functracer-postproc | functracer-postproc]] || a post-processing tool for functracer output data
+
|-
-
|-style="background:white"
+
| [[Documentation/devtools/maemo5/functracer|functracer]] || an allocation backtrace tool
-
| [[Documentation/devtools/maemo5/latrace | latrace]] || display a program's dynamic library calls
+
|-
-
|-style="background:white"
+
| [[Documentation/devtools/maemo5/functracer-postproc|functracer-postproc]] || a post-processing tool for functracer output data
-
|[[Documentation/devtools/maemo5/ltrace | ltrace]] || a library call tracer
+
|-
-
|-style="background:white"
+
| [[Documentation/devtools/maemo5/latrace|latrace]] || display a program's dynamic library calls
-
| [[Documentation/devtools/maemo5/maemo-debug-scripts | maemo-debug-scripts]] || a set of scripts to help with debugging tasks
+
|-
-
|-style="background:white"
+
| [[Documentation/devtools/maemo5/ltrace|ltrace]] || a library call tracer
-
|[[Documentation/devtools/maemo5/sp-error-visualizer | sp-error-visualizer]] || displays log messages as banners
+
|-
-
|-style="background:white"
+
| [[Documentation/devtools/maemo5/maemo-debug-scripts|maemo-debug-scripts]] || a set of scripts to help with debugging tasks
-
| [[Documentation/devtools/maemo5/sp-rich-core | sp-rich-core]] || a core dump data saver
+
|-
-
|-style="background:white"
+
| [[Documentation/devtools/maemo5/sp-error-visualizer|sp-error-visualizer]] || displays log messages as banners
-
| [[Documentation/devtools/maemo5/sp-rich-core-postproc | sp-rich-core-postproc]] || contains rich-core-extract to examine *.rcore.lzo files created by sp-rich-core
+
|-
-
|-style="background:white"
+
| [[Documentation/devtools/maemo5/sp-rich-core|sp-rich-core]] || a core dump data saver
-
|[[Documentation/devtools/maemo5/sp-response-time | sp-response-time]] || a library for monitoring UI response times
+
|-
-
|-style="background:white"
+
| [[Documentation/devtools/maemo5/sp-rich-core-postproc|sp-rich-core-postproc]] || contains rich-core-extract to examine *.rcore.lzo files created by sp-rich-core
-
|[[Documentation/devtools/maemo5/sp-startup-time | sp-startup-time]] || a library for calculating application startup times
+
|-
-
|-style="background:white"
+
| [[Documentation/devtools/maemo5/sp-response-time|sp-response-time]] || a library for monitoring UI response times
-
| [[Documentation/devtools/maemo5/strace | strace]] || a system call tracer
+
|-
-
|-style="background:white"
+
| [[Documentation/devtools/maemo5/sp-startup-time|sp-startup-time]] || a library for calculating application startup times
-
|[[Documentation/devtools/maemo5/syslog | syslog]] || a log message collecting service
+
|-
-
|-style="background:white"
+
| [[Documentation/devtools/maemo5/strace|strace]] || a system call tracer
-
| [[Documentation/devtools/maemo5/valgrind | valgrind]] || a suite of tools for debugging and profiling programs
+
|-
-
|-style="background:white"
+
| [[Documentation/devtools/maemo5/syslog|syslog]] || a log message collecting service
-
|[[Documentation/devtools/maemo5/x11-utils | x11-utils]] || a collection of X Window System debugging tools; xev, xwininfo, xprop, xlsatoms and xlsclients.
+
|-
 +
| [[Documentation/devtools/maemo5/valgrind|valgrind]] || a suite of tools for debugging and profiling programs
 +
|-
 +
| [[Documentation/devtools/maemo5/x11-utils|x11-utils]] || a collection of X Window System debugging tools; xev, xwininfo, xprop, xlsatoms and xlsclients.
|}
|}
=== Miscellaneous ===
=== Miscellaneous ===
-
{| style="width:75%" border="1" cellpadding="2"
+
 
-
|-style="background:white"
+
{| class="wikitable"
-
|[[Documentation/devtools/maemo5/less | less]] || a text file viewer/pager
+
|-
-
|-style="background:white"
+
! Tool !! Description
-
| [[Documentation/devtools/maemo5/osso-xterm | osso-xterm]] || a terminal emulator
+
|-
-
|-style="background:white"
+
| [[Documentation/devtools/maemo5/less|less]] || a text file viewer/pager
-
|[[Documentation/devtools/maemo5/man-db | man-db]] || manual page infrastructure
+
|-
-
|-style="background:white"
+
| [[Documentation/devtools/maemo5/osso-xterm|osso-xterm]] || a terminal emulator
-
| [[Documentation/devtools/maemo5/screen | screen]] || provides access to detachable console sessions
+
|-
 +
| [[Documentation/devtools/maemo5/man-db|man-db]] || manual page infrastructure
 +
|-
 +
| [[Documentation/devtools/maemo5/screen|screen]] || provides access to detachable console sessions
|}
|}
 +
=== Editors ===
=== Editors ===
-
{| style="width:75%" border="1" cellpadding="2"
+
 
-
|-style="background:white"
+
{| class="wikitable"
-
|[[Documentation/devtools/maemo5/nano | nano]] || a friendly text editor
+
|-
-
|-style="background:white"
+
! Tool !! Description
-
| [[Documentation/devtools/maemo5/vi | vi]] || a text editor
+
|-
 +
| [[Documentation/devtools/maemo5/nano|nano]] || a friendly text editor
 +
|-
 +
| [[Documentation/devtools/maemo5/vi|vi]] || a text editor
|}
|}
 +
=== Graphics ===
=== Graphics ===
-
{| style="width:75%" border="1" cellpadding="2"
+
 
-
|-style="background:white"
+
{| class="wikitable"
-
|[[Documentation/devtools/maemo5/screenshot-tool | screenshot-tool]] || a command line utility to take screenshots
+
|-
-
|-style="background:white"
+
! Tool !! Description
-
| [[Documentation/devtools/maemo5/xresponse | xresponse]] || measures the time taken to update the screen after user action
+
|-
-
|-style="background:white"
+
| [[Documentation/devtools/maemo5/screenshot-tool|screenshot-tool]] || a command line utility to take screenshots
-
|[[Documentation/devtools/maemo5/xresponse-visualize | xresponse-visualize]] || scripts for visualizing xresponse logs
+
|-
 +
| [[Documentation/devtools/maemo5/xresponse|xresponse]] || measures the time taken to update the screen after user action
 +
|-
 +
| [[Documentation/devtools/maemo5/xresponse-visualize|xresponse-visualize]] || scripts for visualizing xresponse logs
|}
|}
 +
=== Networking ===
=== Networking ===
-
{| style="width:75%" border="1" cellpadding="2"
+
 
-
|-style="background:white"
+
{| class="wikitable"
-
|[[Documentation/devtools/maemo5/iputils | iputils]] || a collection of TCP/IP related utilities
+
|-
-
|-style="background:white"
+
! Tool !! Description
-
| [[Documentation/devtools/maemo5/netcat | netcat]] || a utility to read and write data across network connections
+
|-
-
|-style="background:white"
+
| [[Documentation/devtools/maemo5/iputils|iputils]] || a collection of TCP/IP related utilities
-
|[[Documentation/devtools/maemo5/tcpdump | tcpdump]] || a network traffic capturing utility
+
|-
-
|-style="background:white"
+
| [[Documentation/devtools/maemo5/netcat|netcat]] || a utility to read and write data across network connections
-
| [[Documentation/devtools/maemo5/traceroute | traceroute]] || print the route packets take to a network host
+
|-
-
|-style="background:white"
+
| [[Documentation/devtools/maemo5/tcpdump|tcpdump]] || a network traffic capturing utility
-
|[[Documentation/devtools/maemo5/wget | wget]] || a utility to non-interactively download files from the Web
+
|-
 +
| [[Documentation/devtools/maemo5/traceroute|traceroute]] || print the route packets take to a network host
 +
|-
 +
| [[Documentation/devtools/maemo5/wget|wget]] || a utility to non-interactively download files from the Web
|}
|}
 +
=== Performance ===
=== Performance ===
-
{| style="width:75%" border="1" cellpadding="2"
+
 
-
|-style="background:white"
+
{| class="wikitable"
-
|[[Documentation/devtools/maemo5/oprofile | oprofile]] || a low overhead system wide profiler
+
|-
-
|-style="background:white"
+
! Tool !! Description
-
| [[Documentation/devtools/maemo5/oprofileui | oprofileui]] || a user interface to oprofile
+
|-
-
|-style="background:white"
+
|[[Documentation/devtools/maemo5/oprofile|oprofile]] || a low overhead system wide profiler
-
|[[Documentation/devtools/maemo5/sp-startup-time | sp-startup-time]] || a library for calculating application startup times
+
|-
-
|-style="background:white"
+
| [[Documentation/devtools/maemo5/oprofileui|oprofileui]] || a user interface to oprofile
-
|[[Documentation/devtools/maemo5/valgrind | valgrind]] || a suite of tools for debugging and profiling programs
+
|-
-
|-style="background:white"
+
| [[Documentation/devtools/maemo5/sp-startup-time|sp-startup-time]] || a library for calculating application startup times
-
| [[Documentation/devtools/maemo5/xresponse | xresponse]] || measures the time taken to update the screen after user action
+
|-
-
|-style="background:white"
+
| [[Documentation/devtools/maemo5/valgrind|valgrind]] || a suite of tools for debugging and profiling programs
-
|[[Documentation/devtools/maemo5/xresponse-visualize | xresponse-visualize]] || scripts for visualizing xresponse logs
+
|-
 +
| [[Documentation/devtools/maemo5/xresponse|xresponse]] || measures the time taken to update the screen after user action
 +
|-
 +
| [[Documentation/devtools/maemo5/xresponse-visualize|xresponse-visualize]] || scripts for visualizing xresponse logs
|}
|}
=== Resource Usage ===
=== Resource Usage ===
-
{| style="width:75%" border="1" cellpadding="2"
+
 
-
|-style="background:white"
+
{| class="wikitable"
-
|[[Documentation/devtools/maemo5/functracer | functracer]] || an allocation backtrace tool
+
|-
-
|-style="background:white"
+
! Tool !! Description
-
| [[Documentation/devtools/maemo5/functracer-postproc | functracer-postproc]] || a post-processing tool for functracer output data
+
|-
-
|-style="background:white"
+
| [[Documentation/devtools/maemo5/functracer|functracer]] || an allocation backtrace tool
-
|[[Documentation/devtools/maemo5/htop | htop]] || an interactive process viewer
+
|-
-
|-style="background:white"
+
| [[Documentation/devtools/maemo5/functracer-postproc|functracer-postproc]] || a post-processing tool for functracer output data
-
| [[Documentation/devtools/maemo5/sp-endurance | sp-endurance]] || tools to collect system endurance related information
+
|-
-
|-style="background:white"
+
| [[Documentation/devtools/maemo5/htop|htop]] || an interactive process viewer
-
|[[Documentation/devtools/maemo5/sp-endurance-postproc | sp-endurance-postproc]] || postprocessing scripts to parse and generate a report from endurance measurement data
+
|-
-
|-style="background:white"
+
| [[Documentation/devtools/maemo5/sp-endurance|sp-endurance]] || tools to collect system endurance related information
-
| [[Documentation/devtools/maemo5/sp-memusage | sp-memusage]] || a collection of memory usage monitoring tools and scripts
+
|-
-
|-style="background:white"
+
| [[Documentation/devtools/maemo5/sp-endurance-postproc|sp-endurance-postproc]] || postprocessing scripts to parse and generate a report from endurance measurement data
-
|[[Documentation/devtools/maemo5/sp-smaps-measure | sp-smaps-measure]] || utilities for taking snapshots of smaps memory information
+
|-
-
|-style="background:white"
+
| [[Documentation/devtools/maemo5/sp-memusage|sp-memusage]] || a collection of memory usage monitoring tools and scripts
-
| [[Documentation/devtools/maemo5/sp-smaps-visualize | sp-smaps-visualize]] || utilities for analyzing smaps memory information
+
|-
-
|-style="background:white"
+
| [[Documentation/devtools/maemo5/sp-smaps-measure|sp-smaps-measure]] || utilities for taking snapshots of smaps memory information
-
|[[Documentation/devtools/maemo5/sysstat | sysstat]] || tools for collecting and reporting system activity information
+
|-
-
|-style="background:white"
+
| [[Documentation/devtools/maemo5/sp-smaps-visualize|sp-smaps-visualize]] || utilities for analyzing smaps memory information
-
| [[Documentation/devtools/maemo5/valgrind | valgrind]] || a suite of tools for debugging and profiling programs
+
|-
-
|-style="background:white"
+
| [[Documentation/devtools/maemo5/sysstat|sysstat]] || tools for collecting and reporting system activity information
-
|[[Documentation/devtools/maemo5/xrestop | xrestop]] || shows X clients' X resource usage
+
|-
 +
| [[Documentation/devtools/maemo5/valgrind|valgrind]] || a suite of tools for debugging and profiling programs
 +
|-
 +
| [[Documentation/devtools/maemo5/xrestop|xrestop]] || shows X clients' X resource usage
|}
|}
 +
=== Test Automation ===
=== Test Automation ===
-
{| style="width:75%" border="1" cellpadding="2"
+
 
-
|-style="background:white"
+
{| class="wikitable"
-
|[[Documentation/devtools/maemo5/check | check]] || a unit test framework for C
+
|-
-
|-style="background:white"
+
! Tool !! Description
-
| [[Documentation/devtools/maemo5/sp-stress | sp-stress]] || tools to create artificial system load
+
|-
-
|-style="background:white"
+
| [[Documentation/devtools/maemo5/check|check]] || a unit test framework for C
-
|[[Documentation/devtools/maemo5/xnee | xnee]] || automate user actions under X11
+
|-
-
|-style="background:white"
+
| [[Documentation/devtools/maemo5/sp-stress|sp-stress]] || tools to create artificial system load
-
| [[Documentation/devtools/maemo5/xresponse | xresponse]] || measures the time taken to update the screen after user action
+
|-
 +
| [[Documentation/devtools/maemo5/xnee|xnee]] || automate user actions under X11
 +
|-
 +
| [[Documentation/devtools/maemo5/xresponse|xresponse]] || measures the time taken to update the screen after user action
|}
|}
 +
=== Wireless Tools ===
=== Wireless Tools ===
-
{| style="width:75%" border="1" cellpadding="2"
+
 
-
|-style="background:white"
+
{| class="wikitable"
-
|[[Documentation/devtools/maemo5/bluez-hcidump | bluez-hcidump]] || a tool to monitor Bluetooth activity
+
|-
-
|-style="background:white"
+
! Tool !! Description
-
| [[Documentation/devtools/maemo5/wireless-tools | wireless-tools]] || tools for manipulating Linux Wireless Extensions
+
|-
 +
| [[Documentation/devtools/maemo5/bluez-hcidump|bluez-hcidump]] || a tool to monitor Bluetooth activity
 +
|-
 +
| [[Documentation/devtools/maemo5/wireless-tools|wireless-tools]] || tools for manipulating Linux Wireless Extensions
|}
|}

Revision as of 10:09, 25 June 2010

These tools are available in the official Maemo 5 Fremantle tools repository at repository.maemo.org. Some of them may have already been available unofficially, but these versions are tested for functionality.

You can propose new tools by filing an enhancement request in Bugzilla.

Installation instructions are available below.

Contents

Categories

The tools are arranged into different categories so that you can easily see what tools are available for specific kinds of tasks. The same tool can be present in multiple categories.

Code Analyser

Tool Description
doxygen a source code documentation generator tool
gtk-doc an API documentation generator

Debugging

Tool Description
crash-reporter user-friendly graphical user interface for sp-rich-core
gdb GDB is the GNU debugger
functracer an allocation backtrace tool
functracer-postproc a post-processing tool for functracer output data
latrace display a program's dynamic library calls
ltrace a library call tracer
maemo-debug-scripts a set of scripts to help with debugging tasks
sp-error-visualizer displays log messages as banners
sp-rich-core a core dump data saver
sp-rich-core-postproc contains rich-core-extract to examine *.rcore.lzo files created by sp-rich-core
sp-response-time a library for monitoring UI response times
sp-startup-time a library for calculating application startup times
strace a system call tracer
syslog a log message collecting service
valgrind a suite of tools for debugging and profiling programs
x11-utils a collection of X Window System debugging tools; xev, xwininfo, xprop, xlsatoms and xlsclients.

Miscellaneous

Tool Description
less a text file viewer/pager
osso-xterm a terminal emulator
man-db manual page infrastructure
screen provides access to detachable console sessions

Editors

Tool Description
nano a friendly text editor
vi a text editor

Graphics

Tool Description
screenshot-tool a command line utility to take screenshots
xresponse measures the time taken to update the screen after user action
xresponse-visualize scripts for visualizing xresponse logs

Networking

Tool Description
iputils a collection of TCP/IP related utilities
netcat a utility to read and write data across network connections
tcpdump a network traffic capturing utility
traceroute print the route packets take to a network host
wget a utility to non-interactively download files from the Web

Performance

Tool Description
oprofile a low overhead system wide profiler
oprofileui a user interface to oprofile
sp-startup-time a library for calculating application startup times
valgrind a suite of tools for debugging and profiling programs
xresponse measures the time taken to update the screen after user action
xresponse-visualize scripts for visualizing xresponse logs

Resource Usage

Tool Description
functracer an allocation backtrace tool
functracer-postproc a post-processing tool for functracer output data
htop an interactive process viewer
sp-endurance tools to collect system endurance related information
sp-endurance-postproc postprocessing scripts to parse and generate a report from endurance measurement data
sp-memusage a collection of memory usage monitoring tools and scripts
sp-smaps-measure utilities for taking snapshots of smaps memory information
sp-smaps-visualize utilities for analyzing smaps memory information
sysstat tools for collecting and reporting system activity information
valgrind a suite of tools for debugging and profiling programs
xrestop shows X clients' X resource usage

Test Automation

Tool Description
check a unit test framework for C
sp-stress tools to create artificial system load
xnee automate user actions under X11
xresponse measures the time taken to update the screen after user action

Wireless Tools

Tool Description
bluez-hcidump a tool to monitor Bluetooth activity
wireless-tools tools for manipulating Linux Wireless Extensions

Installation

These tools can be installed in the device by activating the Fremantle tools repository in the Application manager. The tools are command line utilities, so they will not add applications to the application manager list of downloadable applications. This also means that the tools need to be installed from the X terminal as root. Developers can also install them in Scratchbox using the command line interface.

To activate the tools repository with the Application Manager, open this single-click install file, or manually create a new catalogue like this:

  1. Navigate to the application menu in the Application Manager (tap the title bar)
  2. Select ‘Application catalogs’
  3. Select ‘New’
  4. Enter a catalog name of ‘fremantle tools’
  5. Enter a web address of http://repository.maemo.org
  6. Enter a distribution of ‘fremantle/tools’
  7. Enter components of ‘free non-free’
  8. Make sure that ‘Disabled:’ is left unchecked
  9. Select ‘Save’

If you prefer to edit configuration files yourself instead of using the Application manager, add these lines to your /etc/apt/sources.list 

# fremantle tools
deb http://repository.maemo.org fremantle/tools free non-free
# fremantle tools sources
deb-src http://repository.maemo.org fremantle/tools free non-free


To install a binary package in Scratchbox: 

$ fakeroot apt-get install <bin pkg name>

To install a binary package to the device (as root): 

$ apt-get install <bin pkg name>

To install a source package in Scratchbox or to the device: 

$ apt-get source <src pkg name>
Retrieved from "http://wiki.maemo.org/Documentation/devtools/maemo5"