Nios® II Software Developer Handbook

ID 683525
Date 8/28/2023
Public
Document Table of Contents

16.1.7. nios2-bsp-query-settings

Usage

nios2-bsp-query-settings [--cmd <tcl command>] 
 [--debug] [--extended-help] [--get <name>] 
 [--get-all] [--help] 
 [--librarian-factory-path <directory>] 
 [--librarian-path <directory>] [--log <filename>]
 [--script <filename>] --settings <filename> 
 [--show-descriptions] [--show-names] [--silent] 
 [--verbose] [--version]

Options

  • --cmd <tcl command>: Run the specified Tcl command. Multiple --cmd options are allowed.
  • --debug: Output debug, exception traces, verbose, and default information about the command's operation to stdout.
  • --extended-help: Displays full information about this command and its options.
  • --get <name>: Display the value of the setting called <name>. Multiple --get options are allowed. Each value appears on its own line in the order the --get options are specified. Mutually exclusive with the --get-all option.
  • --get-all: Display the value of all BSP settings in order sorted by option name. Each option appears on its own line. Mutually exclusive with the --get option.
  • --help: Displays basic information about this command and its options.
  • --librarian-factory-path <directory>: Comma-separated librarian search path. Use $ for default factory search path.
  • --librarian-path <directory>: Comma-separated librarian search path. Use $ for default search path.
  • --log <filename>: Create a debug log and write to specified file. Also logs debug information to stdout.
  • --script <filename>: Run the specified Tcl script with optional arguments. Multiple --script options are allowed.
  • --settings <filename>: File name of an existing BSP settings file to query settings from.
  • --show-descriptions: Displays the description of each option after the value.
  • --show-names: Displays the name of each option before the value.
  • --silent: Suppress information about the command's operation normally sent to stdout.
  • --verbose: Output verbose, and default information about the command's operation to stdout.
  • --version: Displays the version of this command and exits with a zero exit status.

Description

The nios2-bsp-query-settings command provides information from a .bsp file. The path to an existing .bsp file is a mandatory command-line option. The command does not modify the settings file. Only requested information is displayed on stdout; no informational messages are displayed.

If no command-line arguments are specified, this command returns an exit value of 1 and sends a help message to stderr.

Note:

For more information about this command, use the --extended-help option to display comprehensive usage information.