NuttShell (NSH)

The NuttShell is a very complete shell system to be used in NuttX, similar to bash and other similar options. It supports a rich set of included commands, scripting and the ability to run your own applications as “builtin” (part of the same NuttX binary). NSH is implemented as an application where most of the functionality is part of the library called nshlib.

As such, NSH is completely optional and can be disabled so that NuttX directly starts a given task instead of the main nsh application.

Contents

• Overview
  • Console/NSH Front End
  • Command Overview
  • Conditional Command Execution
  • Looping
  • Built-In Variables
  • Current Working Directory
  • Environment Variables
  • NSH Start-Up Script
• Commands
  • test Evaluate Expression
  • addroute Add a Routing Table Entry
  • arp Access the ARP table
  • base64dec Base64 Decode
  • base64enc Base64 Encode
  • basename Extract Base File/Directory Name
  • break Terminate a Loop
  • cat Concatenate Files
  • cd Change Current Working Directory
  • cmp Compare Files
  • cp Copy Files
  • date Show or set the date and time
  • dd Copy and Convert Files
  • delroute Delete a Routing Table Entry
  • df Show Volume Status
  • dirname Extract Path to a File/Directory
  • dmesg Dump Buffered SYSLOG Output
  • echo Echo Strings and Variables
  • env Show Environment Variables
  • exec Execute User Code
  • exit Exit NSH
  • export Set an Environment Variable
  • free Show Memory Manager Status
  • get Get File Via TFTP
  • help Show Usage Command Usage
  • hexdump Hexadecimal Dump of File or Device
  • ifconfig Manage Network Configuration
  • ifdown Take a network down
  • ifup Bring a network up
  • insmod Install an OS module
  • irqinfo Show Interrupt Status
  • critmon Show Critical Monitor Status
  • kill Send a signal to a task
  • losetup Setup/teardown the Loop Device
  • ln Link to a File or Directory
  • ls List Directory Contents
  • lsmod Show information about installed OS modules
  • md5 Calculate MD5
  • mb, mh, and mw Access Memory
  • ps Show Current Tasks and Threads
  • mkdir Create a Directory
  • mkfatfs Create a FAT File System
  • mkfifo Create a FIFO
  • mkrd Create a RAMDISK
  • mount Mount a File System
  • mv Rename a File
  • nfsmount Mount an NFS file system
  • nslookup Lookup a network address
  • passwd Change a User’s Password
  • pmconfig Manage Power Management Subsystem
  • poweroff Shut the system down
  • put Send File Via TFTP
  • pwd Show Current Working Directory
  • readlink Show target of a link
  • reboot Reboot the system
  • rm Remove a File
  • rmdir Remove a Directory
  • rmmod Remove on OS Module
  • route Show routing table
  • rptun Start/Stop the OpenAMP RPC Tunnel
  • set Set a Variable
  • sh Execute an NSH Script
  • shutdown Shut the system down
  • sleep Wait for Seconds
  • telnetd Time Start the Telnet Daemon
  • time Time execution of another command
  • truncate Set the Size of a File
  • umount Unmount a File System
  • uname Print system information
  • unset Unset an Environment Variable
  • urldecode URL Decode
  • urlencode URL Encode
  • useradd Add a New User
  • userdel Delete a user
  • usleep Wait for Microseconds
  • wget Get File Via HTTP
  • xd Hexadecimal Dump of Memory
  • Built-In Commands
  • ping and ping6 Check Network Peer
• Configuration Settings
  • Command Dependencies on Configuration Settings
  • Built-In Command Dependencies on Configuration Settings
  • NSH-Specific Configuration Settings
  • Common Problems
• The NSH Library and NSH Initialization
  • NSH Initialization sequence
  • nsh_initialize()
• NSH Commands
  • Adding New NSH Commands
• NSH “Built-In” Applications
  • Built-In Applications
  • Synchronous Built-In Applications
• Customizing NSH Initialization
  • NuttShell Start up Scripts
• Shell Login
  • Enabling Shell Logins
  • Verification of Credentials
  • Password Files
  • Creating a Password File for a ROMFS File System
• Running Applications from NSH