| <!-- |
| Documentation/_templates/layout.html |
| |
| Licensed to the Apache Software Foundation (ASF) under one or more |
| contributor license agreements. See the NOTICE file distributed with |
| this work for additional information regarding copyright ownership. The |
| ASF licenses this file to you under the Apache License, Version 2.0 (the |
| "License"); you may not use this file except in compliance with the |
| License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
| WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the |
| License for the specific language governing permissions and limitations |
| under the License. |
| --> |
| |
| |
| |
| <!DOCTYPE html> |
| <html class="writer-html5" lang="en"> |
| <head> |
| <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" /> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <title>NuttShell (NSH) — NuttX latest documentation</title> |
| <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" /> |
| <link rel="stylesheet" type="text/css" href="../../_static/css/theme.css" /> |
| <link rel="stylesheet" type="text/css" href="../../_static/copybutton.css" /> |
| <link rel="stylesheet" type="text/css" href="../../_static/custom.css" /> |
| |
| |
| <link rel="shortcut icon" href="../../_static/favicon.ico"/> |
| <script src="../../_static/jquery.js"></script> |
| <script src="../../_static/_sphinx_javascript_frameworks_compat.js"></script> |
| <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script> |
| <script src="../../_static/doctools.js"></script> |
| <script src="../../_static/sphinx_highlight.js"></script> |
| <script src="../../_static/clipboard.min.js"></script> |
| <script src="../../_static/copybutton.js"></script> |
| <script src="../../_static/js/theme.js"></script> |
| <link rel="index" title="Index" href="../../genindex.html" /> |
| <link rel="search" title="Search" href="../../search.html" /> |
| <link rel="next" title="Overview" href="nsh.html" /> |
| <link rel="prev" title="xmlrpc XML RPC library" href="../netutils/xmlrpc/index.html" /> |
| </head> |
| |
| <body class="wy-body-for-nav"> |
| <div class="wy-grid-for-nav"> |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search" > |
| |
| <a href="../../index.html" class="icon icon-home"> NuttX |
| |
| |
| |
| </a> |
| |
| <!-- this version selector is quite ugly, should be probably replaced by something |
| more modern --> |
| |
| <div class="version-selector"> |
| <select onchange="javascript:location.href = this.value;"> |
| |
| <option value="../../../latest" selected="selected">latest</option> |
| |
| <option value="../../../10.0.0" >10.0.0</option> |
| |
| <option value="../../../10.0.1" >10.0.1</option> |
| |
| <option value="../../../10.1.0" >10.1.0</option> |
| |
| <option value="../../../10.2.0" >10.2.0</option> |
| |
| <option value="../../../10.3.0" >10.3.0</option> |
| |
| <option value="../../../11.0.0" >11.0.0</option> |
| |
| <option value="../../../12.0.0" >12.0.0</option> |
| |
| <option value="../../../12.1.0" >12.1.0</option> |
| |
| <option value="../../../12.2.0" >12.2.0</option> |
| |
| <option value="../../../12.2.1" >12.2.1</option> |
| |
| <option value="../../../12.3.0" >12.3.0</option> |
| |
| <option value="../../../12.4.0" >12.4.0</option> |
| |
| <option value="../../../12.5.0" >12.5.0</option> |
| |
| <option value="../../../12.5.1" >12.5.1</option> |
| |
| <option value="../../../12.6.0" >12.6.0</option> |
| |
| <option value="../../../12.7.0" >12.7.0</option> |
| |
| <option value="../../../12.8.0" >12.8.0</option> |
| |
| <option value="../../../12.9.0" >12.9.0</option> |
| |
| <option value="../../../12.10.0" >12.10.0</option> |
| |
| <option value="../../../12.11.0" >12.11.0</option> |
| |
| </select> |
| </div> |
| |
| |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| |
| </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> |
| <p class="caption" role="heading"><span class="caption-text">Table of Contents</span></p> |
| <ul class="current"> |
| <li class="toctree-l1"><a class="reference internal" href="../../index.html">Home</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../introduction/index.html">Introduction</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../quickstart/index.html">Getting Started</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../contributing/index.html">Contributing</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../introduction/inviolables.html">The Inviolable Principles of NuttX</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../platforms/index.html">Supported Platforms</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../components/index.html">OS Components</a></li> |
| <li class="toctree-l1 current"><a class="reference internal" href="../index.html">Applications</a><ul class="current"> |
| <li class="toctree-l2"><a class="reference internal" href="../audioutils/index.html">Audio Utility libraries</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../boot/index.html">Bootloader Utilities</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../benchmarks/index.html">Benchmark Applications</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../canutils/index.html">CAN Utilities</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../crypto/index.html">Cryptography Library Support</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../fsutils/index.html">File System Utilities</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../games/index.html">Games</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../graphics/index.html">Graphics Support</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../industry/index.html">Industrial Applications</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../inertial/index.html">Inertial Libraries Support</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../interpreters/index.html">Interpreters</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../logging/index.html">Logging Utilities</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../lte/index.html">LTE Libraries and NSH Add-Ons</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../math/index.html">Math Library Support</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../mlearing/index.html">Machine Learning Support</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../netutils/index.html">Network Utilities</a></li> |
| <li class="toctree-l2 current"><a class="current reference internal" href="#">NuttShell (NSH)</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="nsh.html">Overview</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="commands.html">Commands</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="config.html">Configuration Settings</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="customizing.html">The NSH Library and NSH Initialization</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="customizing.html#nsh-commands">NSH Commands</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="builtin.html">NSH “Built-In” Applications</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="installation.html">Customizing NSH Initialization</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="login.html">Shell Login</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="running_apps.html">Running Applications from NSH</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../sdr/index.html">Software Define Radio Libraries</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../system/index.html">System Libraries and NSH Add-Ons</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../testing/index.html">Testing</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../tools/index.html">Host Side Tools</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../wireless/index.html">Wireless Libraries and NSH Add-Ons</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../examples/index.html">Examples</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../../implementation/index.html">Implementation Details</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../reference/index.html">API Reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../guides/index.html">Guides</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../logos/index.html">NuttX Logos</a></li> |
| </ul> |
| |
| </div> |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="../../index.html">NuttX</a> |
| </nav> |
| |
| <div class="wy-nav-content"> |
| <div class="rst-content"> |
| <div role="navigation" aria-label="Page navigation"> |
| <ul class="wy-breadcrumbs"> |
| <li><a href="../../index.html" class="icon icon-home" aria-label="Home"></a></li> |
| <li class="breadcrumb-item"><a href="../index.html">Applications</a></li> |
| <li class="breadcrumb-item active">NuttShell (NSH)</li> |
| <li class="wy-breadcrumbs-aside"> |
| <a href="../../_sources/applications/nsh/index.rst.txt" rel="nofollow"> View page source</a> |
| </li> |
| </ul> |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <section id="nuttshell-nsh"> |
| <h1>NuttShell (NSH)<a class="headerlink" href="#nuttshell-nsh" title="Permalink to this heading"></a></h1> |
| <p>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 <cite>nshlib</cite>.</p> |
| <p>As such, NSH is completely optional and can be disabled so that NuttX directly |
| starts a given task instead of the main <code class="docutils literal notranslate"><span class="pre">nsh</span></code> application.</p> |
| <div class="toctree-wrapper compound"> |
| <p class="caption" role="heading"><span class="caption-text">Contents</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="nsh.html">Overview</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="nsh.html#console-nsh-front-end">Console/NSH Front End</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="nsh.html#command-overview">Command Overview</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="nsh.html#conditional-command-execution">Conditional Command Execution</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="nsh.html#looping">Looping</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="nsh.html#built-in-variables">Built-In Variables</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="nsh.html#current-working-directory">Current Working Directory</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="nsh.html#environment-variables">Environment Variables</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="commands.html">Commands</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#test-evaluate-expression"><code class="docutils literal notranslate"><span class="pre">test</span></code> Evaluate Expression</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#addroute-add-a-routing-table-entry"><code class="docutils literal notranslate"><span class="pre">addroute</span></code> Add a Routing Table Entry</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#arp-access-the-arp-table"><code class="docutils literal notranslate"><span class="pre">arp</span></code> Access the ARP table</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#base64dec-base64-decode"><code class="docutils literal notranslate"><span class="pre">base64dec</span></code> Base64 Decode</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#base64enc-base64-encode"><code class="docutils literal notranslate"><span class="pre">base64enc</span></code> Base64 Encode</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#basename-extract-base-file-directory-name"><code class="docutils literal notranslate"><span class="pre">basename</span></code> Extract Base File/Directory Name</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#break-terminate-a-loop"><code class="docutils literal notranslate"><span class="pre">break</span></code> Terminate a Loop</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#cat-concatenate-files"><code class="docutils literal notranslate"><span class="pre">cat</span></code> Concatenate Files</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#cd-change-current-working-directory"><code class="docutils literal notranslate"><span class="pre">cd</span></code> Change Current Working Directory</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#cmp-compare-files"><code class="docutils literal notranslate"><span class="pre">cmp</span></code> Compare Files</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#cp-copy-files"><code class="docutils literal notranslate"><span class="pre">cp</span></code> Copy Files</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#date-show-or-set-the-date-and-time"><code class="docutils literal notranslate"><span class="pre">date</span></code> Show or set the date and time</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#dd-copy-and-convert-files"><code class="docutils literal notranslate"><span class="pre">dd</span></code> Copy and Convert Files</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#delroute-delete-a-routing-table-entry"><code class="docutils literal notranslate"><span class="pre">delroute</span></code> Delete a Routing Table Entry</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#df-show-volume-status"><code class="docutils literal notranslate"><span class="pre">df</span></code> Show Volume Status</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#dirname-extract-path-to-a-file-directory"><code class="docutils literal notranslate"><span class="pre">dirname</span></code> Extract Path to a File/Directory</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#dmesg-dump-buffered-syslog-output"><code class="docutils literal notranslate"><span class="pre">dmesg</span></code> Dump Buffered SYSLOG Output</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#echo-echo-strings-and-variables"><code class="docutils literal notranslate"><span class="pre">echo</span></code> Echo Strings and Variables</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#env-show-environment-variables"><code class="docutils literal notranslate"><span class="pre">env</span></code> Show Environment Variables</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#exec-execute-user-code"><code class="docutils literal notranslate"><span class="pre">exec</span></code> Execute User Code</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#exit-exit-nsh"><code class="docutils literal notranslate"><span class="pre">exit</span></code> Exit NSH</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#export-set-an-environment-variable"><code class="docutils literal notranslate"><span class="pre">export</span></code> Set an Environment Variable</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#expr-evaluate-expressions"><code class="docutils literal notranslate"><span class="pre">expr</span></code> Evaluate expressions</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#free-show-memory-manager-status"><code class="docutils literal notranslate"><span class="pre">free</span></code> Show Memory Manager Status</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#get-get-file-via-tftp"><code class="docutils literal notranslate"><span class="pre">get</span></code> Get File Via TFTP</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#help-show-usage-command-usage"><code class="docutils literal notranslate"><span class="pre">help</span></code> Show Usage Command Usage</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#hexdump-hexadecimal-dump-of-file-or-device"><code class="docutils literal notranslate"><span class="pre">hexdump</span></code> Hexadecimal Dump of File or Device</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#ifconfig-manage-network-configuration"><code class="docutils literal notranslate"><span class="pre">ifconfig</span></code> Manage Network Configuration</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#ifdown-take-a-network-down"><code class="docutils literal notranslate"><span class="pre">ifdown</span></code> Take a network down</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#ifup-bring-a-network-up"><code class="docutils literal notranslate"><span class="pre">ifup</span></code> Bring a network up</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#insmod-install-an-os-module"><code class="docutils literal notranslate"><span class="pre">insmod</span></code> Install an OS module</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#irqinfo-show-interrupt-status"><code class="docutils literal notranslate"><span class="pre">irqinfo</span></code> Show Interrupt Status</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#critmon-show-critical-monitor-status"><code class="docutils literal notranslate"><span class="pre">critmon</span></code> Show Critical Monitor Status</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#kill-send-a-signal-to-a-task"><code class="docutils literal notranslate"><span class="pre">kill</span></code> Send a signal to a task</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#losetup-setup-teardown-the-loop-device"><code class="docutils literal notranslate"><span class="pre">losetup</span></code> Setup/teardown the Loop Device</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#ln-link-to-a-file-or-directory"><code class="docutils literal notranslate"><span class="pre">ln</span></code> Link to a File or Directory</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#ls-list-directory-contents"><code class="docutils literal notranslate"><span class="pre">ls</span></code> List Directory Contents</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#lsmod-show-information-about-installed-os-modules"><code class="docutils literal notranslate"><span class="pre">lsmod</span></code> Show information about installed OS modules</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#md5-calculate-md5"><code class="docutils literal notranslate"><span class="pre">md5</span></code> Calculate MD5</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#mb-mh-and-mw-access-memory"><code class="docutils literal notranslate"><span class="pre">mb</span></code>, <code class="docutils literal notranslate"><span class="pre">mh</span></code>, <code class="docutils literal notranslate"><span class="pre">and</span></code> <code class="docutils literal notranslate"><span class="pre">mw</span></code> Access Memory</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#ps-show-current-tasks-and-threads"><code class="docutils literal notranslate"><span class="pre">ps</span></code> Show Current Tasks and Threads</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#mkdir-create-a-directory"><code class="docutils literal notranslate"><span class="pre">mkdir</span></code> Create a Directory</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#mkfatfs-create-a-fat-file-system"><code class="docutils literal notranslate"><span class="pre">mkfatfs</span></code> Create a FAT File System</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#mkfifo-create-a-fifo"><code class="docutils literal notranslate"><span class="pre">mkfifo</span></code> Create a FIFO</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#mkrd-create-a-ramdisk"><code class="docutils literal notranslate"><span class="pre">mkrd</span></code> Create a RAMDISK</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#mount-mount-a-file-system"><code class="docutils literal notranslate"><span class="pre">mount</span></code> Mount a File System</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#mv-rename-a-file"><code class="docutils literal notranslate"><span class="pre">mv</span></code> Rename a File</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#nfsmount-mount-an-nfs-file-system"><code class="docutils literal notranslate"><span class="pre">nfsmount</span></code> Mount an NFS file system</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#nslookup-lookup-a-network-address"><code class="docutils literal notranslate"><span class="pre">nslookup</span></code> Lookup a network address</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#passwd-change-a-user-s-password"><code class="docutils literal notranslate"><span class="pre">passwd</span></code> Change a User’s Password</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#pmconfig-manage-power-management-subsystem"><code class="docutils literal notranslate"><span class="pre">pmconfig</span></code> Manage Power Management Subsystem</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#poweroff-shut-the-system-down"><code class="docutils literal notranslate"><span class="pre">poweroff</span></code> Shut the system down</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#put-send-file-via-tftp"><code class="docutils literal notranslate"><span class="pre">put</span></code> Send File Via TFTP</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#pwd-show-current-working-directory"><code class="docutils literal notranslate"><span class="pre">pwd</span></code> Show Current Working Directory</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#readlink-show-target-of-a-link"><code class="docutils literal notranslate"><span class="pre">readlink</span></code> Show target of a link</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#reboot-reboot-the-system"><code class="docutils literal notranslate"><span class="pre">reboot</span></code> Reboot the system</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#rm-remove-a-file"><code class="docutils literal notranslate"><span class="pre">rm</span></code> Remove a File</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#rmdir-remove-a-directory"><code class="docutils literal notranslate"><span class="pre">rmdir</span></code> Remove a Directory</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#rmmod-remove-on-os-module"><code class="docutils literal notranslate"><span class="pre">rmmod</span></code> Remove on OS Module</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#route-show-routing-table"><code class="docutils literal notranslate"><span class="pre">route</span></code> Show routing table</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#rptun-start-stop-the-openamp-rpc-tunnel"><code class="docutils literal notranslate"><span class="pre">rptun</span></code> Start/Stop the OpenAMP RPC Tunnel</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#set-set-a-variable"><code class="docutils literal notranslate"><span class="pre">set</span></code> Set a Variable</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#sh-execute-an-nsh-script"><code class="docutils literal notranslate"><span class="pre">sh</span></code> Execute an NSH Script</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#shutdown-shut-the-system-down"><code class="docutils literal notranslate"><span class="pre">shutdown</span></code> Shut the system down</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#sleep-wait-for-seconds"><code class="docutils literal notranslate"><span class="pre">sleep</span></code> Wait for Seconds</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#telnetd-time-start-the-telnet-daemon"><code class="docutils literal notranslate"><span class="pre">telnetd</span></code> Time Start the Telnet Daemon</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#time-time-execution-of-another-command"><code class="docutils literal notranslate"><span class="pre">time</span></code> Time execution of another command</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#truncate-set-the-size-of-a-file"><code class="docutils literal notranslate"><span class="pre">truncate</span></code> Set the Size of a File</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#umount-unmount-a-file-system"><code class="docutils literal notranslate"><span class="pre">umount</span></code> Unmount a File System</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#uname-print-system-information"><code class="docutils literal notranslate"><span class="pre">uname</span></code> Print system information</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#unset-unset-an-environment-variable"><code class="docutils literal notranslate"><span class="pre">unset</span></code> Unset an Environment Variable</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#uptime-show-how-long-the-system-has-been-running"><code class="docutils literal notranslate"><span class="pre">uptime</span></code> Show how long the system has been running</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#urldecode-url-decode"><code class="docutils literal notranslate"><span class="pre">urldecode</span></code> URL Decode</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#urlencode-url-encode"><code class="docutils literal notranslate"><span class="pre">urlencode</span></code> URL Encode</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#useradd-add-a-new-user"><code class="docutils literal notranslate"><span class="pre">useradd</span></code> Add a New User</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#userdel-delete-a-user"><code class="docutils literal notranslate"><span class="pre">userdel</span></code> Delete a user</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#usleep-wait-for-microseconds"><code class="docutils literal notranslate"><span class="pre">usleep</span></code> Wait for Microseconds</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#wget-get-file-via-http"><code class="docutils literal notranslate"><span class="pre">wget</span></code> Get File Via HTTP</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#xd-hexadecimal-dump-of-memory"><code class="docutils literal notranslate"><span class="pre">xd</span></code> Hexadecimal Dump of Memory</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#built-in-commands">Built-In Commands</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="commands.html#ping-and-ping6-check-network-peer"><code class="docutils literal notranslate"><span class="pre">ping</span></code> and <code class="docutils literal notranslate"><span class="pre">ping6</span></code> Check Network Peer</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="config.html">Configuration Settings</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="config.html#command-dependencies-on-configuration-settings">Command Dependencies on Configuration Settings</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="config.html#built-in-command-dependencies-on-configuration-settings">Built-In Command Dependencies on Configuration Settings</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="config.html#nsh-specific-configuration-settings">NSH-Specific Configuration Settings</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="config.html#common-problems">Common Problems</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="customizing.html">The NSH Library and NSH Initialization</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="customizing.html#nsh-initialization-sequence">NSH Initialization sequence</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="customizing.html#nsh-initialize"><code class="docutils literal notranslate"><span class="pre">nsh_initialize()</span></code></a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="customizing.html#nsh-commands">NSH Commands</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="customizing.html#adding-new-nsh-commands">Adding New NSH Commands</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="builtin.html">NSH “Built-In” Applications</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="builtin.html#built-in-applications">Built-In Applications</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="builtin.html#synchronous-built-in-applications">Synchronous Built-In Applications</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="installation.html">Customizing NSH Initialization</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="login.html">Shell Login</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="login.html#enabling-shell-logins">Enabling Shell Logins</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="login.html#verification-of-credentials">Verification of Credentials</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="login.html#password-files">Password Files</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="login.html#creating-a-password-file-for-a-romfs-file-system">Creating a Password File for a ROMFS File System</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="running_apps.html">Running Applications from NSH</a></li> |
| </ul> |
| </div> |
| </section> |
| |
| |
| </div> |
| </div> |
| <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> |
| <a href="../netutils/xmlrpc/index.html" class="btn btn-neutral float-left" title="xmlrpc XML RPC library" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
| <a href="nsh.html" class="btn btn-neutral float-right" title="Overview" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> |
| </div> |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p>© Copyright 2023, The Apache Software Foundation.</p> |
| </div> |
| |
| |
| |
| </footer> |
| </div> |
| </div> |
| </section> |
| </div> |
| <script> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| </body> |
| </html> |
