Learning Objectives

#

After completing this section, you will be able to:

• Use the help feature of the kernel shell
• Configure and customize a kernel shell session

The VxWorks kernel shell provides developers with a powerful interface for debugging, development, and system control. This guide covers how to access help and configure your shell environment.

Kernel Shell Help Command

#

The kernel shell includes a comprehensive help system. If you forget commands or need guidance, use the help command:

Additional Help Topics

#

Use the following commands for specialized help:

• dbgHelp – Debugger help information
• edrHelp – ED&R (Error Detection & Reporting) help
• ioHelp – I/O utilities help
• nfsHelp – NFS-related commands help
• netHelp – Networking help
• rtpHelp – Real-time process help
• spyHelp – Task histogrammer help
• timexHelp – Execution timer help

Kernel Shell Configuration

#

The kernel shell is not included by default in a VIP project. This keeps the initial project lightweight. You can add the shell either via the GUI or CLI, depending on your workflow.

GUI Method

#

1. Open the Kernel Configuration for your VIP project:

2. Switch to Bundle View:

3. Filter and locate the standalone shell bundle:

Type BUNDLE_STANDALONE_SHELL in the filter box.

4. Right-click and select Add, then rebuild the VIP to apply the bundle.

CLI Method

#

1. Open the VxWorks Development Shell for your VIP project:

2. Add the standalone shell bundle with the following command:

vxprj vip bundle add BUNDLE_STANDALONE_SHELL

3. Verify that the bundle has been added:

vxprj vip bundle list

4. View all available bundles:

vxprj vip bundle list all

Kernel Shell Session Configuration

#

Configuration variables control various shell session parameters. They can be updated statically or dynamically:

• INTERPRETER – Selects the shell interpreter: C (default) or command
• LINE_EDIT_MODE – Sets line editing: vi (default) or Emacs
• LINE_LENGTH – Sets shell line length (default 256 characters)

Updating Configuration Variables

#

• With the C interpreter, use the shConfig() function
• With the command interpreter, use the set config command

Proper configuration allows you to optimize your shell session for development and debugging.