Nios® II Software Developer Handbook

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

16.1.13. nios2-swexample-create

Usage

nios2-create-swexample [Options]

Options

  • --name: Specify the name of the software project to create.
  • --sopc-dir Specify the SOPC builder directory [deprecated].
  • --sopc-file Specify the SOPC builder file [required].
  • --type: Specify the software design example template type. Required.
  • --list List all valid software design example template types.
  • --app-dir Specify the application directory to create. Default: <sopc-dir>/software_examples/app/<name>
  • --bsp-dir Specify the bsp directory to create. Default: <sopc-dir>/software_examples/bsp/<bsp-type>
  • --no-app Do not generate the create-this-app script
  • --no-bsp Do not generate the create-this-bsp script
  • --elf-name Name of the .elf file to create.
  • --describe Describe the software example type specified and exit.
  • --describeX Verbosely describe the software example type specified and exit.
  • --describeAll Describe all the software example types and exit.
  • --search Search for software example templates in the specified directory. Default: $SOPC_KIT_NIOS2/examples/software.
  • --help Print this message and exit.
  • --silent Do not echo commands.
  • --version Print the version number of nios2-create-swexample and exit.
  • --cpu-name Create the software example using the cpuname specified.
  • --jvm-max-heap-size The maximum memory size to be used for allocations when running this tool. This value is specified as <size><unit> where unit can be m (or M) for multiples of megabytes or g (or G) for multiples of gigabytes. The default value is 512m. [Optional]

Description

This utility creates a template software example for a given SOPC system.