| |
| |
| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge"> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| |
| |
| |
| |
| <title>Command Structure — Apache Mynewt latest documentation</title> |
| |
| |
| |
| |
| <link rel="shortcut icon" href="../_static/mynewt-logo-only-newt32x32.png"/> |
| |
| |
| |
| |
| <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> |
| |
| |
| <link rel="stylesheet" href="../_static/css/sphinx_theme.css" type="text/css" /> |
| |
| <link rel="stylesheet" href="../_static/css/bootstrap-3.0.3.min.css" type="text/css" /> |
| |
| <link rel="stylesheet" href="../_static/css/v2.css" type="text/css" /> |
| |
| <link rel="stylesheet" href="../_static/css/custom.css" type="text/css" /> |
| |
| <link rel="stylesheet" href="../_static/css/restructuredtext.css" type="text/css" /> |
| |
| |
| |
| |
| <link rel="stylesheet" href="../_static/css/overrides.css" type="text/css" /> |
| <link rel="index" title="Index" |
| href="../genindex.html"/> |
| <link rel="search" title="Search" href="../search.html"/> |
| <link rel="top" title="Apache Mynewt latest documentation" href="../index.html"/> |
| <link rel="up" title="Newt Tool Guide" href="index.html"/> |
| <link rel="next" title="newt build" href="command_list/newt_build.html"/> |
| <link rel="prev" title="Theory of Operations" href="newt_operation.html"/> |
| |
| |
| <script src="../_static/js/modernizr.min.js"></script> |
| |
| |
| <script> |
| (function(i, s, o, g, r, a, m) { |
| i["GoogleAnalyticsObject"] = r; |
| (i[r] = |
| i[r] || |
| function() { |
| (i[r].q = i[r].q || []).push(arguments); |
| }), |
| (i[r].l = 1 * new Date()); |
| (a = s.createElement(o)), (m = s.getElementsByTagName(o)[0]); |
| a.async = 1; |
| a.src = g; |
| m.parentNode.insertBefore(a, m); |
| })(window, document, "script", "//www.google-analytics.com/analytics.js", "ga"); |
| |
| ga("create", "UA-72162311-1", "auto"); |
| ga("send", "pageview"); |
| </script> |
| |
| |
| </head> |
| |
| <body class="not-front page-documentation" role="document" > |
| <div id="wrapper"> |
| <div class="container"> |
| <div id="banner" class="row v2-main-banner"> |
| <a class="logo-cell" href="/"> |
| <img class="logo" src="../_static/img/logo.png"> |
| </a> |
| <div class="tagline-cell"> |
| <h4 class="tagline">An OS to build, deploy and securely manage billions of devices</h4> |
| </div> |
| <div class="news-cell"> |
| <div class="well"> |
| <h4>Latest News:</h4> <a href="/download">Apache Mynewt 1.11.0, Apache NimBLE 1.6.0 </a> released September 7, 2023) |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <header> |
| <nav id="navbar" class="navbar navbar-inverse" role="navigation"> |
| <div class="container"> |
| <!-- Collapsed navigation --> |
| <div class="navbar-header"> |
| <!-- Expander button --> |
| <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse"> |
| <span class="sr-only">Toggle navigation</span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| |
| </div> |
| |
| <!-- Expanded navigation --> |
| <div class="navbar-collapse collapse"> |
| <!-- Main navigation --> |
| <ul class="nav navbar-nav navbar-right"> |
| <li> |
| <a href="/"><i class="fa fa-home" style="font-size: larger;"></i></a> |
| </li> |
| <li class="important"> |
| <a href="/quick-start/">Quick Start</a> |
| </li> |
| <li> |
| <a href="/about/">About</a> |
| </li> |
| <li> |
| <a href="/talks/">Talks</a> |
| </li> |
| <li class="active"> |
| <a href="/documentation/">Documentation</a> |
| </li> |
| <li> |
| <a href="/download/">Download</a> |
| </li> |
| <li> |
| <a href="/community/">Community</a> |
| </li> |
| <li> |
| <a href="/events/">Events</a> |
| </li> |
| </ul> |
| |
| <!-- Search, Navigation and Repo links --> |
| <ul class="nav navbar-nav navbar-right"> |
| |
| </ul> |
| </div> |
| </div> |
| </nav> |
| </header> |
| <!-- STARTS MAIN CONTENT --> |
| <div id="main-content"> |
| |
| |
| |
| |
| |
| |
| <div id="breadcrumb"> |
| <div class="container"> |
| <a href="/documentation/">Docs</a> / |
| |
| <a href="index.html">Newt Tool Guide</a> / |
| |
| Command Structure |
| |
| <div class="sourcelink"> |
| <a href="https://github.com/apache/mynewt-newt/edit/master/docs/newt_ops.rst" class="icon icon-github" |
| rel="nofollow"> Edit on GitHub</a> |
| </div> |
| </div> |
| </div> |
| <!-- STARTS CONTAINER --> |
| <div class="container"> |
| <!-- STARTS .content --> |
| <div id="content" class="row"> |
| |
| <!-- STARTS .container-sidebar --> |
| <div class="container-sidebar col-xs-12 col-sm-3"> |
| <div id="docSidebar" class="sticky-container"> |
| <div role="search" class="sphinx-search"> |
| <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> |
| <input type="text" name="q" placeholder="Search documentation" class="search-documentation" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| <!-- Note: only works when deployed --> |
| <select class="form-control" onchange="if (this.value) window.location.href=this.value"> |
| <option value="/latest" selected> |
| Version: latest |
| </option> |
| <option value="/v1_11_0" > |
| Version: 1.11.0 |
| </option> |
| <option value="/v1_10_0" > |
| Version: 1.10.0 |
| </option> |
| <option value="/v1_9_0" > |
| Version: 1.9.0 |
| </option> |
| <option value="/v1_8_0" selected="selected" > |
| Version: 1.8.0 |
| </option> |
| <option value="/v1_7_0" > |
| Version: 1.7.0 |
| </option> |
| <option value="/v1_6_0" > |
| Version: 1.6.0 |
| </option> |
| <option value="/v1_5_0" > |
| Version: 1.5.0 |
| </option> |
| <option value="/v1_4_0" > |
| Version: 1.4.0 |
| </option> |
| <option value="/v1_3_0/os/introduction" > |
| Version: 1.3.0 |
| </option> |
| <option value="/v1_2_0/os/introduction" > |
| Version: 1.2.0 |
| </option> |
| <option value="/v1_1_0/os/introduction" > |
| Version: 1.1.0 |
| </option> |
| <option value="/v1_0_0/os/introduction" > |
| Version: 1.0.0 |
| </option> |
| <option value="/v0_9_0/os/introduction" > |
| Version: 0.9.0 |
| </option> |
| </select> |
| <div class="region region-sidebar"> |
| <div class="docs-menu"> |
| |
| |
| |
| <ul class="current"> |
| <li class="toctree-l1"><a class="reference internal" href="../index.html">Introduction</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../get_started/index.html">Setup & Get Started</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../concepts.html">Concepts</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../tutorials/tutorials.html">Tutorials</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../external_links.html">Third-party Resources</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../os/os_user_guide.html">OS User Guide</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../network/index.html">BLE User Guide</a></li> |
| <li class="toctree-l1 current"><a class="reference internal" href="index.html">Newt Tool Guide</a><ul class="current"> |
| <li class="toctree-l2"><a class="reference internal" href="newt_operation.html">Theory of Operations</a></li> |
| <li class="toctree-l2 current"><a class="current reference internal" href="#">Command Structure</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="command_list/newt_build.html">newt build</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="command_list/newt_clean.html">newt clean</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="command_list/newt_complete.html">newt complete</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="command_list/newt_create_image.html">newt create-image</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="command_list/newt_debug.html">newt debug</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="command_list/newt_help.html">newt help</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="command_list/newt_info.html">newt info</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="command_list/newt_load.html">newt load</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="command_list/newt_mfg.html">newt mfg</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="command_list/newt_new.html">newt new</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="command_list/newt_pkg.html">newt pkg</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="command_list/newt_resign_image.html">newt resign-image</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="command_list/newt_run.html">newt run</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="command_list/newt_size.html">newt size</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="command_list/newt_target.html">newt target</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="command_list/newt_test.html">newt test</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="command_list/newt_upgrade.html">newt upgrade</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="command_list/newt_vals.html">newt vals</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="command_list/newt_version.html">newt version</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="install/index.html">Install</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../newtmgr/index.html">Newt Manager Guide</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../mynewt_faq/index.html">Mynewt FAQ</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../misc/index.html">Appendix</a></li> |
| </ul> |
| |
| |
| |
| </div> |
| </div> |
| </div> |
| <!-- ENDS STICKY CONTAINER --> |
| </div> |
| <!-- ENDS .container-sidebar --> |
| |
| <div class="col-xs-12 col-sm-9"> |
| |
| <div class="alert alert-warning"> |
| <p> |
| Version 1.8.0 is not the most recent version of the |
| Apache Mynewt documentation. Click <a href="/latest">here</a> to |
| read the latest version. |
| </p> |
| </div> |
| |
| |
| |
| <div class=""> |
| <div class="rst-content"> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <div class="section" id="command-structure"> |
| <h1>Command Structure<a class="headerlink" href="#command-structure" title="Permalink to this headline">¶</a></h1> |
| <div class="toctree-wrapper compound"> |
| </div> |
| <p>Just like verbs are actions in a sentence and adverbs modify verbs, so |
| in the <em>newt</em> tool, commands are actions and flags modify actions. A |
| command can have subcommands. Arguments to commands and subcommands, |
| with appropriate flags, dictate the execution and result of a command.</p> |
| <p>For instance, in the example below, the <em>newt</em> command has the |
| subcommand <code class="docutils literal notranslate"><span class="pre">target</span> <span class="pre">set</span></code> in which the argument ‘my_target1’ is the |
| target whose attribute, <em>app</em>, is set to <code class="docutils literal notranslate"><span class="pre">@apache-mynewt-core/hw/bsp/nrf52dk</span></code></p> |
| <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">newt target set my_target1 app=@apache-mynewt-core/hw/bsp/nrf52dk</span> |
| </pre></div> |
| </div> |
| <p>Global flags work uniformly across <em>newt</em> commands. Consider the flag |
| <code class="docutils literal notranslate"><span class="pre">-v,</span> <span class="pre">--verbose,</span></code> It works both for command and subcommands, to |
| generate verbose output. Likewise, the help flag <code class="docutils literal notranslate"><span class="pre">-h</span></code> or <code class="docutils literal notranslate"><span class="pre">--help,</span></code> |
| to print helpful messsages.</p> |
| <p>A command may additionally take flags specific to it. For example, the |
| <code class="docutils literal notranslate"><span class="pre">-n</span></code> flag instructs <code class="docutils literal notranslate"><span class="pre">newt</span> <span class="pre">debug</span></code> not to start GDB from command line.</p> |
| <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">newt debug <target-name> -n</span> |
| </pre></div> |
| </div> |
| <p>In addition to the documentation in <a class="reference internal" href="index.html"><span class="doc">Newt Tool Guide</span></a>, |
| command-line help is available for each command (and subcommand), |
| through the <code class="docutils literal notranslate"><span class="pre">-h</span></code> or <code class="docutils literal notranslate"><span class="pre">--help</span></code> options.</p> |
| <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">newt target --help</span> |
| <span class="go">Commands to create, delete, configure, and query targets</span> |
| |
| <span class="go">Usage:</span> |
| <span class="go"> newt target [flags]</span> |
| <span class="go"> newt target [command]</span> |
| |
| <span class="go">Available Commands:</span> |
| <span class="go"> amend Add, change, or delete values for multi-value target variables</span> |
| <span class="go"> config View or populate a target's system configuration</span> |
| <span class="go"> copy Copy target</span> |
| <span class="go"> create Create a target</span> |
| <span class="go"> delete Delete target</span> |
| <span class="go"> dep View target's dependency graph</span> |
| <span class="go"> revdep View target's reverse-dependency graph</span> |
| <span class="go"> set Set target configuration variable</span> |
| <span class="go"> show View target configuration variables</span> |
| |
| <span class="go">Global Flags:</span> |
| <span class="go"> -h, --help Help for newt commands</span> |
| <span class="go"> -j, --jobs int Number of concurrent build jobs (default 8)</span> |
| <span class="go"> -l, --loglevel string Log level (default "WARN")</span> |
| <span class="go"> -o, --outfile string Filename to tee output to</span> |
| <span class="go"> -q, --quiet Be quiet; only display error output</span> |
| <span class="go"> -s, --silent Be silent; don't output anything</span> |
| <span class="go"> -v, --verbose Enable verbose output when executing commands</span> |
| |
| <span class="go">Use "newt target [command] --help" for more information about a command.</span> |
| </pre></div> |
| </div> |
| </div> |
| |
| |
| </div> |
| </div> |
| |
| <div class="rst-footer-buttons row" role="navigation" aria-label="footer navigation"> |
| |
| <a href="command_list/newt_build.html" class="btn btn-neutral float-right" title="newt build" accesskey="n">Next: newt build <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="newt_operation.html" class="btn btn-neutral" title="Theory of Operations" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous: Theory of Operations</a> |
| |
| </div> |
| |
| </div> |
| </div> |
| </div> |
| <!-- ENDS CONTENT SECTION --> |
| </div> |
| <!-- ENDS .content --> |
| </div> |
| </div> |
| <footer> |
| <div class="container"> |
| <div class="row"> |
| <div class="col-xs-12"> |
| |
| <p class="copyright">Apache Mynewt is available under Apache License, version 2.0.</p> |
| |
| </div> |
| <div class="col-xs-12"> |
| <div class="logos"> |
| <img src="../_static/img/asf_logo_wide_small.png" alt="Apache" title="Apache"> |
| <small class="footnote"> |
| Apache Mynewt, Mynewt, Apache, the Apache feather logo, and the Apache Mynewt project logo are either |
| registered trademarks or trademarks of the Apache Software Foundation in the United States and other countries. |
| </small> |
| <a href=""> |
| <img src="../_static/img/add_to_slack.png" alt="Slack Icon" title="Join our Slack Community" /> |
| </a> |
| </div> |
| </div> |
| </div> |
| </div> |
| </footer> |
| </div> |
| <!-- ENDS #wrapper --> |
| |
| |
| |
| <script type="text/javascript"> |
| var DOCUMENTATION_OPTIONS = { |
| URL_ROOT:'../', |
| VERSION:'latest', |
| COLLAPSE_INDEX:false, |
| FILE_SUFFIX:'.html', |
| HAS_SOURCE: true, |
| SOURCELINK_SUFFIX: '.txt', |
| LINK_SUFFIX: '.html' |
| }; |
| </script> |
| <script type="text/javascript" src="../_static/jquery.js"></script> |
| <script type="text/javascript" src="../_static/underscore.js"></script> |
| <script type="text/javascript" src="../_static/doctools.js"></script> |
| <script type="text/javascript" src="../_static/js/bootstrap-3.0.3.min.js"></script> |
| <script type="text/javascript" src="../_static/js/affix.js"></script> |
| <script type="text/javascript" src="../_static/js/main.js"></script> |
| |
| |
| |
| </body> |
| </html> |
