internal

internal
	Command Reference

Name

internal — GUI for Freja sampling and report generation

Synopsis

internal [-h, --help] [--version] [--tmpdir TMPDIR] [ -- PROGRAM [ARGUMENT...] ]

Description

internal is a simple graphical user interface for sampling applications and generating reports with Freja.

The same graphical user interface can be used to:

Start an application and sample it, optionally create a report and optionally display the report.
Attach to an already running application, sample it, optionally create a report and optionally display the report, or
Generate a report from an existing sample file, and optionally display the new report.
Display and existing report.

The program allows setting the same parameters as the corresponding command line programs, sample, report and view.

The target application is executed in a new 'xterm' window. After completing the sampling, please close the xterm window.

Options

-h, --help

Print help message.

--version

Print version information.

--tmpdir TMPDIR

Name the directory where all temporary files will be stored.

This directory can alternatively be specified by environment variables THREADSPOTTER_TMPDIR or TMPDIR on Linux or TMP on Windows. The command line option takes precendence over the environment variables.

PROGRAM

Use PROGRAM as the default program to launch.

ARGUMENT...

Use ARGUMENTs as the default arguments when launching a program.

Exit Status

0: Successful program execution.
>0: An error occured.

Environment

RW_LICENSE_FILE: Environment variable pointing to the license file. Should only be used to override default license locations.

BROWSER: Web browser to use to display the report.

Files

$HOME/.threadspotter/license: Directory containing per-user license files. Freja looks for license files here if no system wide license file can be found.