steamos-dump-info

Gather SteamOS system information

TLDR

View SteamOS system information

$ sudo steamos-dump-info

-o, --output
Specifies the path and filename for the output compressed archive. If not provided, a default name is used in the current directory.

-d, --directory
Specifies a directory where uncompressed diagnostic files will be placed, rather than creating a single archive. Implies --no-compress.

-s, --section

    Dumps only the specified section of information. This option can be used multiple times to include multiple specific sections.

-L, --list-sections
    Lists all available sections that can be individually dumped using the --section option.

--no-compress
    Prevents the utility from compressing the output. Instead, it creates a directory containing all diagnostic files.

-V, --version
    Displays the version information of the steamos-dump-info utility.

-v, --verbose
    Enables verbose output, providing more detailed information about the collection process.

-q, --quiet
    Suppresses most output during the collection process, showing only critical messages.

-h, --help
    Displays a brief help message and exits, listing available options.

DESCRIPTION

steamos-dump-info is a vital command-line utility designed for Valve's SteamOS, particularly prominent on the Steam Deck. Its primary function is to gather a comprehensive snapshot of the system's state, including hardware specifications, software versions, system configurations, and various logs. This information is meticulously collected and typically packaged into a single compressed archive (e.g., a .zip or .tar.gz file). The command is indispensable for troubleshooting system issues, diagnosing bugs, and providing detailed information to technical support teams. It automates the often tedious process of manually collecting numerous diagnostic files from different locations, ensuring that all relevant data points are included for effective problem resolution. The output typically contains details from the kernel, systemd journal, Steam client logs, Xorg logs, hardware enumeration, network configurations, and more.

CAVEATS

steamos-dump-info collects extensive system information, which may include sensitive data like user names, system paths, and log entries. Users should exercise caution when sharing the generated dump files and only provide them to trusted parties, such as official Valve support.
The generated archive can be quite large, especially if a full system dump is performed on a system with extensive log history. Ensure sufficient disk space is available.
Some sections may require elevated privileges (sudo) to access and collect information.

<B>OUTPUT CONTENT AND FORMAT</B>

The typical output of steamos-dump-info is a compressed archive (e.g., .zip or .tar.gz) containing a directory structure with various files. These files are categorized, often including: system logs (/var/log, journalctl output), hardware information (lspci, lsusb, /proc entries), network configuration, Steam client logs, Xorg logs, and system configuration files. The specific contents can vary based on the detected system state and the sections chosen.

<B>USAGE FOR TROUBLESHOOTING</B>

When users encounter issues on SteamOS (especially Steam Deck), Valve's support often requests a steamos-dump-info archive. The common procedure involves running the command, often saving the output to the home directory or a USB drive, and then uploading the resulting file to a bug tracker or attaching it to a support ticket. This enables Valve engineers and support staff to analyze the system's condition at the time of the issue, greatly aiding in diagnosis and resolution.

HISTORY

The steamos-dump-info utility has been an integral part of Valve's SteamOS distribution since its early iterations, evolving alongside the operating system. Its development was driven by the need for an efficient and standardized method to collect diagnostic data from user systems, crucial for bug reporting and technical support. With the advent and widespread adoption of the Steam Deck, steamos-dump-info has become even more critical, serving as the primary tool recommended by Valve for users to generate system logs when encountering issues. Its design reflects Valve's commitment to improving the user experience by streamlining the support process.