-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
166 changed files
with
27,460 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,255 @@ | ||
|
|
||
|
|
||
| <!DOCTYPE html> | ||
| <html class="writer-html4" lang="en" > | ||
| <head> | ||
| <meta charset="utf-8"> | ||
|
|
||
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> | ||
|
|
||
| <title>Command Line Interface — ESGF Errata Service 2.1 documentation</title> | ||
|
|
||
|
|
||
|
|
||
| <link rel="stylesheet" href="static/css/theme.css" type="text/css" /> | ||
| <link rel="stylesheet" href="static/pygments.css" type="text/css" /> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| <!--[if lt IE 9]> | ||
| <script src="static/js/html5shiv.min.js"></script> | ||
| <![endif]--> | ||
|
|
||
|
|
||
| <script type="text/javascript" id="documentation_options" data-url_root="./" src="static/documentation_options.js"></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/language_data.js"></script> | ||
|
|
||
| <script type="text/javascript" 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="Installation" href="installation.html" /> | ||
| <link rel="prev" title="Close an issue" href="close.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" alt="Documentation Home"> ESGF Errata Service | ||
|
|
||
|
|
||
|
|
||
| </a> | ||
|
|
||
|
|
||
|
|
||
|
|
||
| <div class="version"> | ||
| 2.1 | ||
| </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" /> | ||
| <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="main navigation"> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| <ul class="current"> | ||
| <li class="toctree-l1"><a class="reference internal" href="searchUI.html">Look up an issue</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="lookup.html">Track a version</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="viewer.html">Issue Viewer</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="login.html">Log in to the Errata Service</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="create.html">Create an issue</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="update.html">Update an issue</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="close.html">Close an issue</a></li> | ||
| <li class="toctree-l1 current"><a class="current reference internal" href="#">Command Line Interface</a><ul> | ||
| <li class="toctree-l2"><a class="reference internal" href="installation.html">Installation</a></li> | ||
| <li class="toctree-l2"><a class="reference internal" href="configuration.html">Configuration</a></li> | ||
| <li class="toctree-l2"><a class="reference internal" href="usage.html">Generic usage</a></li> | ||
| <li class="toctree-l2"><a class="reference internal" href="create_cli.html">Create an issue (CLI)</a></li> | ||
| <li class="toctree-l2"><a class="reference internal" href="update_cli.html">Update an issue (CLI)</a></li> | ||
| <li class="toctree-l2"><a class="reference internal" href="close_cli.html">Close an issue (CLI)</a></li> | ||
| <li class="toctree-l2"><a class="reference internal" href="retrieve_cli.html">Retrieve an issue</a></li> | ||
| </ul> | ||
| </li> | ||
| <li class="toctree-l1"><a class="reference internal" href="api.html">Application Programming Interface</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="faq.html">Frequently asked questions</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="credits.html">Credits</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="log.html">Changelog</a></li> | ||
| </ul> | ||
|
|
||
|
|
||
|
|
||
| </div> | ||
|
|
||
| </div> | ||
| </nav> | ||
|
|
||
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
|
|
||
|
|
||
| <nav class="wy-nav-top" aria-label="top navigation"> | ||
|
|
||
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| <a href="index.html">ESGF Errata Service</a> | ||
|
|
||
| </nav> | ||
|
|
||
|
|
||
| <div class="wy-nav-content"> | ||
|
|
||
| <div class="rst-content"> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| <div role="navigation" aria-label="breadcrumbs navigation"> | ||
|
|
||
| <ul class="wy-breadcrumbs"> | ||
|
|
||
| <li><a href="index.html" class="icon icon-home"></a> »</li> | ||
|
|
||
| <li>Command Line Interface</li> | ||
|
|
||
|
|
||
| <li class="wy-breadcrumbs-aside"> | ||
|
|
||
|
|
||
| <a href="sources/client.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"> | ||
|
|
||
| <div class="section" id="command-line-interface"> | ||
| <span id="client"></span><h1>Command Line Interface<a class="headerlink" href="#command-line-interface" title="Permalink to this headline">¶</a></h1> | ||
| <p>The ESGF errata client, called <code class="docutils literal notranslate"><span class="pre">esgissue</span></code> is a piece of software that enables the interaction with the errata service. | ||
| Like the web forms, it can be used to easily create, update, close and retrieve issues. The client is basically aimed to be used by publishing teams, data providers and managers | ||
| that are notified of the existence of an issue regarding one or many datasets/files.</p> | ||
| <p>This lightweight CLI relies on <code class="docutils literal notranslate"><span class="pre">.json</span></code> and <code class="docutils literal notranslate"><span class="pre">.txt</span></code> file records. This enables the data provider, in charge of ESGF issues, to efficiently manage one or several issues remotely and locally.</p> | ||
| <div class="admonition note"> | ||
| <p class="first admonition-title">Note</p> | ||
| <p class="last"><a class="reference external" href="https://www.youtube.com/channel/UCFVy0HC9cnGbIKc6UsDIHDA/playlists">Some screencasts are available on YouTube</a> to learn about the Errata CLI usage.</p> | ||
| </div> | ||
| <div class="toctree-wrapper compound"> | ||
| <ul> | ||
| <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="configuration.html">Configuration</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="usage.html">Generic usage</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="create_cli.html">Create an issue (CLI)</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="update_cli.html">Update an issue (CLI)</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="close_cli.html">Close an issue (CLI)</a></li> | ||
| <li class="toctree-l1"><a class="reference internal" href="retrieve_cli.html">Retrieve an issue</a></li> | ||
| </ul> | ||
| </div> | ||
| </div> | ||
|
|
||
|
|
||
| </div> | ||
|
|
||
| </div> | ||
| <footer> | ||
|
|
||
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> | ||
|
|
||
| <a href="installation.html" class="btn btn-neutral float-right" title="Installation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> | ||
|
|
||
|
|
||
| <a href="close.html" class="btn btn-neutral float-left" title="Close an issue" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> | ||
|
|
||
| </div> | ||
|
|
||
|
|
||
| <hr/> | ||
|
|
||
| <div role="contentinfo"> | ||
| <p> | ||
|
|
||
| © Copyright 2016, Atef BEN NASSER, Guillaume LEVAVASSEUR | ||
|
|
||
| </p> | ||
| </div> | ||
|
|
||
|
|
||
|
|
||
| Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a | ||
|
|
||
| <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> | ||
|
|
||
| provided by <a href="https://readthedocs.org">Read the Docs</a>. | ||
|
|
||
| </footer> | ||
|
|
||
| </div> | ||
| </div> | ||
|
|
||
| </section> | ||
|
|
||
| </div> | ||
|
|
||
|
|
||
| <script type="text/javascript"> | ||
| jQuery(function () { | ||
| SphinxRtdTheme.Navigation.enable(true); | ||
| }); | ||
| </script> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| </body> | ||
| </html> |
Oops, something went wrong.