2.1.1. Syntax of the rvdebug command

The syntax for starting RealView Debugger at the command-line is as follows:

rvdebug [{--batch | --cmd}] [--cleanstart] [--install=pathname] [--home[=]pathname] [{--init[=]connection | --target[=]connection}] [{--image[=]pathname | --exec[=]pathname}] [{--inc[=]pathname | --script[=]pathname}] [{--project[=]filename | --no_project}] [{--workdir[=]pathname | --reinitialize_workdir}] [--journal[=]pathname] [--log[=]pathname] [--stdiolog[=]pathname] [{--workspace=pathname | --aws=pathname}] [--no_logo]

Note

You can use -- or - when specifying the command line arguments.

The command line arguments are:

--aws

See the description of --workspace.

--batch

Start a RealView Debugger session in batch mode, that is without any user interaction.

Use this with --script to run a script file containing commands.

Note

If you use --batch without --script, RealView Debugger displays an error message and exits.

--cleanstart

Clears the contents of your home directory, or the home directory specified with --home, to restore the default set of configuration files.

Note

All existing files in the directory are deleted before the new configuration files are created.

--cmd

Start a RealView Debugger session in command line mode, where you can use RealView Debugger CLI commands to carry out debugging tasks. This enables you to interact with the debugger without using the RealView Debugger GUI.

--exec

See the description of --image.

--home

Specifies the complete path to your RealView Debugger home directory used for the debugging session. You can optionally include =, for example --home=homedir. If this argument is not specified, your default login name is used.

The path you specify does not have to exist. For example, you might want to specify a different path if you want to perform any of the tutorials described in the RealView Debugger documentation, or you want to experiment with different Debug Configurations. In this way, your default home directory is preserved.

Note

--home is supported only on Windows.

--inc

See the description of --script.

--image

Specifies the image to be loaded when RealView Debugger runs. You can specify only a single image to load when you start RealView Debugger from the command line. However, after RealView Debugger has started, you can load additional images as required.

The image specification can also include section details and image arguments, and has the format:

--image[=] "image[;sections][;arguments]"

where:

  • image is the image name, and path if required

  • sections is a comma-separated list of sections

  • arguments is a space-separated list of arguments

  • = is optional.

Note

You can optionally use --target to specify a connection when loading an image in this way. If you omit --target, then RealView Debugger does one of the following:

  • Uses an existing connection that is saved in the workspace. If more than one connection is saved, then the first connection that is established is used.

  • Displays a prompt asking if you want to defer the load until a connection is available.

If you choose to defer the load, then RealView Debugger attempts to load the image to the first target you connect to.

--init

See the description of --target.

--install

Specifies an installation directory if this differs from the default installation. This must point to the following directory:

install_directory\RVD\Core\...\platform

On Windows systems, this is then used to define the location of the default RealView Debugger home directory when the debugger runs for the first time.

This overrides the environment variable RVDEBUG_INSTALL, and must be used if RVDEBUG_INSTALL is not set.

--journal

Start a RealView Debugger session with the specified journal file open for writing. You can optionally include =, for example --journal=filename. Can be replaced with -jou or -j.

--log

Start a RealView Debugger session with the specified log file open for writing. You can optionally include =, for example --log=filename. Can be replaced with -l.

--no_logo

Start a RealView Debugger session without displaying the splash screen. You can also use --nologo.

--project

Use this in combination with --workdir. Instructs RealView Debugger to load the specified project template file. Options from the project template are set only if they do not conflict with other options specified on the command line.

Note

This option overrides the RVDS_PROJECT environment variable if it is set.

Use --no_project to prevent the use of a project template specified by the RVDS_PROJECT environment variable if it is set.

--reinitialize_workdir

Use this in combination with --workdir. If --workdir refers to an existing working directory that contains modified project template files, then specify this option to delete the working directory and recreate it with new copies of the original project template files.

--script

Start a RealView Debugger session with the specified script file that contains RealView Debugger commands. You can optionally include =.

Use --script in:

  • Batch mode in association with the --batch setting, to execute the commands contained in the script file and then exit the debugger.

  • Command-line mode in association with the --cmd setting, to execute the commands contained in the script file. If the script file does not force RealView Debugger to exit, then the RealView Debugger displays the CLI prompt ready for you to continue debugging.

  • GUI mode (that is, without --batch and --cmd), to execute the commands contained in the script file during a debugging session. If the script file does not force RealView Debugger to exit, then the RealView Debugger Code window remains open ready for you to continue debugging.

--stdiolog

Start a RealView Debugger session with the specified STDIO log file open for writing. You can optionally include =, for example --stdiolog=filename. Can be replaced with -s.

--target

Specifies the connection to establish when RealView Debugger runs. You can optionally include =, for example --target=connection. This option requires that you specify the connection using the named connection format:

@target@DebugConfiguration

For example, to connect to the Cortex-A8 model of the ISSM Debug Configuration in the Instruction Set System Model (ISSM) Debug Interface, specify @ARM_Cortex-A8@ISSM.

Note

You can specify only a single target connection. However, after RealView Debugger has started, you can make additional connections as required.

--workdir

Use this in combination with --project to specify your working directory to use for that project template. Project templates only require working directories if they include private files, such as RealView Debugger configuration files.

If --workdir is required, then an error message is produced if you try to use --project without --workdir.

Note

This option overrides the RVDS_PROJECT_WORKDIR environment variable if it is set.

--workspace

Specify --workspace[=]pathname to start a RealView Debugger session with the specified workspace. This overrides any workspace specification that was stored when the previous session ended. If the specified workspace file does not exist, you are prompted to create it:

  • Click Yes to create the workspace file and start RealView Debugger.

  • Click No to start RealView Debugger with a default workspace.

See also

Copyright © 2002-2009 ARM Limited. All rights reserved.ARM DUI 0153K
Non-Confidential