| <!-- |
| 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>NuttX Diagnostic Tool (Nxdiag) — NuttX latest documentation</title> |
| <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> |
| <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" /> |
| <link rel="stylesheet" href="../../_static/copybutton.css" type="text/css" /> |
| <link rel="stylesheet" href="../../_static/tabs.css" type="text/css" /> |
| <link rel="stylesheet" href="../../_static/custom.css" type="text/css" /> |
| <link rel="shortcut icon" href="../../_static/favicon.ico"/> |
| <!--[if lt IE 9]> |
| <script src="../../_static/js/html5shiv.min.js"></script> |
| <![endif]--> |
| |
| <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="Configuration Settings" href="config.html" /> |
| <link rel="prev" title="Shell Login" href="../nsh/login.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> |
| |
| </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="../nsh/index.html">NuttShell (NSH)</a></li> |
| <li class="toctree-l2 current"><a class="current reference internal" href="#">NuttX Diagnostic Tool (Nxdiag)</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="#usage">Usage</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="config.html">Configuration Settings</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../wapi/index.html">WAPI (Wireless API)</a></li> |
| </ul> |
| </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> |
| </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">NuttX Diagnostic Tool (Nxdiag)</li> |
| <li class="wy-breadcrumbs-aside"> |
| <a href="../../_sources/applications/nxdiag/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="nuttx-diagnostic-tool-nxdiag"> |
| <h1>NuttX Diagnostic Tool (Nxdiag)<a class="headerlink" href="#nuttx-diagnostic-tool-nxdiag" title="Permalink to this heading"></a></h1> |
| <p>The NuttX Diagnostic Tool (Nxdiag) is a command line tool that can be used to gather information about the NuttX and host systems. |
| It also can be used to run a tests to verify that the vendor’s tools are properly installed and configured.</p> |
| <p>Its primary purpose is to gather information that can be used to debug problems and ease the process of reporting bugs for uninexperienced users.</p> |
| <p>This tool uses a Python script (<code class="docutils literal notranslate"><span class="pre">apps/tools/host_sysinfo.py</span></code>) to gather information about the host system during build and a C |
| program to gather information about the NuttX system and display all available information. For more information about the python |
| script, check the command line options and code comments of <code class="docutils literal notranslate"><span class="pre">host_sysinfo.py</span></code>.</p> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>Nxdiag requires Python 3.6 or later. On Linux distributions, the <code class="docutils literal notranslate"><span class="pre">distro</span></code> Python module is |
| recommended as it provides more accurate information about the host system.</p> |
| </div> |
| </section> |
| <section id="usage"> |
| <h1>Usage<a class="headerlink" href="#usage" title="Permalink to this heading"></a></h1> |
| <p>This page shows <code class="docutils literal notranslate"><span class="pre">nxdiag</span></code> options. Note that some options are only available if the |
| respective configuration options are enabled (see <a class="reference internal" href="config.html#nxdiagcmddependencies"><span class="std std-ref">cmdtable</span></a>). |
| For a complete list of <code class="docutils literal notranslate"><span class="pre">nxdiag</span></code> options available to the system, just run <code class="docutils literal notranslate"><span class="pre">nxdiag</span></code>:</p> |
| <div class="highlight-none notranslate"><div class="highlight"><pre><span></span>Usage: nxdiag [options] |
| Options: |
| -h Show this message |
| -n, --nuttx Output the NuttX operational system information. |
| -f, --flags Output the NuttX compilation and linker flags used. |
| -c, --config Output the NuttX configuration options used. |
| -o, --host-os Output the host system operational system information. |
| -p, --host-path Output the host PATH environment variable. |
| -k, --host-packages Output the host installed system packages. |
| -m, --host-modules Output the host installed Python modules. |
| -v, --vendor-specific Output vendor specific information. |
| --all Output all available information. |
| </pre></div> |
| </div> |
| <p>An example output can be observed <a class="reference external" href="https://pastebin.com/HSw1EvhR">here</a>.</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="config.html">Configuration Settings</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="config.html#option-dependencies-on-configuration-settings">Option Dependencies on Configuration Settings</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="config.html#nxdiag-specific-configuration-settings">Nxdiag-Specific Configuration Settings</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </section> |
| |
| |
| </div> |
| </div> |
| <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> |
| <a href="../nsh/login.html" class="btn btn-neutral float-left" title="Shell Login" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
| <a href="config.html" class="btn btn-neutral float-right" title="Configuration Settings" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> |
| </div> |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p>© Copyright 2020, The Apache Software Foundation.</p> |
| </div> |
| |
| |
| |
| </footer> |
| </div> |
| </div> |
| </section> |
| </div> |
| <script> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| </body> |
| </html> |
