/dvs/git/dirty/gitlab-master_av/dw/sdk/tools/recorder/apps/recorder/README-recorder.md

Go to the documentation of this file.

/*
 * Copyright (c) 2019-2020, NVIDIA CORPORATION.  All rights reserved.
 *
 * NVIDIA Corporation and its licensors retain all intellectual property
 * and proprietary rights in and to this software, related documentation
 * and any modifications thereto.  Any use, reproduction, disclosure or
 * distribution of this software and related documentation without an express
 * license agreement from NVIDIA Corporation is strictly prohibited.
 */

@page dwx_recorder_tool Basic Recording Tool

@note This tool is available in both **NVIDIA DriveWorks** and **NVIDIA DRIVE Software** releases.

This tool is available on the x86 Host System, NVIDIA DRIVE<sup>&trade;</sup> OS Linux, and NVIDIA DRIVE<sup>&trade;</sup> OS QNX.

This is a simple recording tool intended to be used as a back-end process
for more advanced recording applications. While it can be used as is, it is encouraged
to use either the @ref dwx_recorder_textui_tool or @ref dwx_gui_recording2_tool.

@section recorder_starting Starting the Recording Application

Run this tool by executing:

    sudo -s
    cd /usr/local/driveworks/tools/capture
    ./recorder <rig-file>

The tool supports the following commands:

| Command                  | Action          |
| ------------------------ | --------------- |
| `s [record_path]<Enter>` | start recording |
| `s /dev/null<Enter>`     | stop recording  |
| `q <Enter>`              | quit            |

If no `record_path` is specified using the start command above, the tool uses the
current working directory as its recording path.

For related information, see:
- @ref dwx_recording_devguide_group
- @ref dwx_config_ref

@section recorder_configuring Configuring the Recorder

See @ref dwx_config_ref