/ docs / manual / search.html
search.html
  1  <!doctype html>
  2  <html class="no-js" lang="en">
  3    <head><meta charset="utf-8"/>
  4      <meta name="viewport" content="width=device-width,initial-scale=1"/>
  5      <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="#" />
  6  
  7      <meta name="generator" content="sphinx-5.3.0, furo 2022.09.29.dev1"/><title>Search - Reticulum Network Stack 1.0.0 documentation</title><link rel="stylesheet" type="text/css" href="_static/pygments.css" />
  8      <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=189ec851f9bb375a2509b67be1f64f0cf212b702" />
  9      <link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
 10      <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
 11      <link rel="stylesheet" type="text/css" href="_static/custom.css" />
 12      
 13      
 14  
 15  
 16  <style>
 17    body {
 18      --color-code-background: #f8f8f8;
 19    --color-code-foreground: black;
 20    
 21    }
 22    @media not print {
 23      body[data-theme="dark"] {
 24        --color-code-background: #202020;
 25    --color-code-foreground: #d0d0d0;
 26    --color-background-primary: #202b38;
 27    --color-background-secondary: #161f27;
 28    --color-foreground-primary: #dbdbdb;
 29    --color-foreground-secondary: #a9b1ba;
 30    --color-brand-primary: #41adff;
 31    --color-background-hover: #161f27;
 32    --color-api-name: #ffbe85;
 33    --color-api-pre-name: #efae75;
 34    
 35      }
 36      @media (prefers-color-scheme: dark) {
 37        body:not([data-theme="light"]) {
 38          --color-code-background: #202020;
 39    --color-code-foreground: #d0d0d0;
 40    --color-background-primary: #202b38;
 41    --color-background-secondary: #161f27;
 42    --color-foreground-primary: #dbdbdb;
 43    --color-foreground-secondary: #a9b1ba;
 44    --color-brand-primary: #41adff;
 45    --color-background-hover: #161f27;
 46    --color-api-name: #ffbe85;
 47    --color-api-pre-name: #efae75;
 48    
 49        }
 50      }
 51    }
 52  </style></head>
 53    <body>
 54      
 55      <script>
 56        document.body.dataset.theme = localStorage.getItem("theme") || "auto";
 57      </script>
 58      
 59  
 60  <svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
 61    <symbol id="svg-toc" viewBox="0 0 24 24">
 62      <title>Contents</title>
 63      <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
 64        <path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
 65      </svg>
 66    </symbol>
 67    <symbol id="svg-menu" viewBox="0 0 24 24">
 68      <title>Menu</title>
 69      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 70        stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
 71        <line x1="3" y1="12" x2="21" y2="12"></line>
 72        <line x1="3" y1="6" x2="21" y2="6"></line>
 73        <line x1="3" y1="18" x2="21" y2="18"></line>
 74      </svg>
 75    </symbol>
 76    <symbol id="svg-arrow-right" viewBox="0 0 24 24">
 77      <title>Expand</title>
 78      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 79        stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
 80        <polyline points="9 18 15 12 9 6"></polyline>
 81      </svg>
 82    </symbol>
 83    <symbol id="svg-sun" viewBox="0 0 24 24">
 84      <title>Light mode</title>
 85      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
 86        stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
 87        <circle cx="12" cy="12" r="5"></circle>
 88        <line x1="12" y1="1" x2="12" y2="3"></line>
 89        <line x1="12" y1="21" x2="12" y2="23"></line>
 90        <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
 91        <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
 92        <line x1="1" y1="12" x2="3" y2="12"></line>
 93        <line x1="21" y1="12" x2="23" y2="12"></line>
 94        <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
 95        <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
 96      </svg>
 97    </symbol>
 98    <symbol id="svg-moon" viewBox="0 0 24 24">
 99      <title>Dark mode</title>
100      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
101        stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
102        <path stroke="none" d="M0 0h24v24H0z" fill="none" />
103        <path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
104      </svg>
105    </symbol>
106    <symbol id="svg-sun-half" viewBox="0 0 24 24">
107      <title>Auto light/dark mode</title>
108      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
109        stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
110        <path stroke="none" d="M0 0h24v24H0z" fill="none"/>
111        <circle cx="12" cy="12" r="9" />
112        <path d="M13 12h5" />
113        <path d="M13 15h4" />
114        <path d="M13 18h1" />
115        <path d="M13 9h4" />
116        <path d="M13 6h1" />
117      </svg>
118    </symbol>
119  </svg>
120  
121  <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
122  <input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
123  <label class="overlay sidebar-overlay" for="__navigation">
124    <div class="visually-hidden">Hide navigation sidebar</div>
125  </label>
126  <label class="overlay toc-overlay" for="__toc">
127    <div class="visually-hidden">Hide table of contents sidebar</div>
128  </label>
129  
130  
131  
132  <div class="page">
133    <header class="mobile-header">
134      <div class="header-left">
135        <label class="nav-overlay-icon" for="__navigation">
136          <div class="visually-hidden">Toggle site navigation sidebar</div>
137          <i class="icon"><svg><use href="#svg-menu"></use></svg></i>
138        </label>
139      </div>
140      <div class="header-center">
141        <a href="index.html"><div class="brand">Reticulum Network Stack 1.0.0 documentation</div></a>
142      </div>
143      <div class="header-right">
144        <div class="theme-toggle-container theme-toggle-header">
145          <button class="theme-toggle">
146            <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
147            <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
148            <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
149            <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
150          </button>
151        </div>
152        <label class="toc-overlay-icon toc-header-icon no-toc" for="__toc">
153          <div class="visually-hidden">Toggle table of contents sidebar</div>
154          <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
155        </label>
156      </div>
157    </header>
158    <aside class="sidebar-drawer">
159      <div class="sidebar-container">
160        
161        <div class="sidebar-sticky"><a class="sidebar-brand centered" href="index.html">
162    
163    <div class="sidebar-logo-container">
164      <img class="sidebar-logo" src="_static/rns_logo_512.png" alt="Logo"/>
165    </div>
166    
167    <span class="sidebar-brand-text">Reticulum Network Stack 1.0.0 documentation</span>
168    
169  </a><form class="sidebar-search-container" method="get" action="#" role="search">
170    <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
171    <input type="hidden" name="check_keywords" value="yes">
172    <input type="hidden" name="area" value="default">
173  </form>
174  <div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
175    <ul>
176  <li class="toctree-l1"><a class="reference internal" href="whatis.html">What is Reticulum?</a></li>
177  <li class="toctree-l1"><a class="reference internal" href="gettingstartedfast.html">Getting Started Fast</a></li>
178  <li class="toctree-l1"><a class="reference internal" href="using.html">Using Reticulum on Your System</a></li>
179  <li class="toctree-l1"><a class="reference internal" href="understanding.html">Understanding Reticulum</a></li>
180  <li class="toctree-l1"><a class="reference internal" href="hardware.html">Communications Hardware</a></li>
181  <li class="toctree-l1"><a class="reference internal" href="interfaces.html">Configuring Interfaces</a></li>
182  <li class="toctree-l1"><a class="reference internal" href="networks.html">Building Networks</a></li>
183  <li class="toctree-l1"><a class="reference internal" href="examples.html">Code Examples</a></li>
184  <li class="toctree-l1"><a class="reference internal" href="support.html">Support Reticulum</a></li>
185  </ul>
186  <ul>
187  <li class="toctree-l1"><a class="reference internal" href="reference.html">API Reference</a></li>
188  </ul>
189  
190  </div>
191  </div>
192  
193        </div>
194        
195      </div>
196    </aside>
197    <div class="main">
198      <div class="content">
199        <div class="article-container">
200          <a href="#" class="back-to-top muted-link">
201            <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
202              <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
203            </svg>
204            <span>Back to top</span>
205          </a>
206          <div class="content-icon-container">
207            <div class="theme-toggle-container theme-toggle-content">
208              <button class="theme-toggle">
209                <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
210                <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
211                <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
212                <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
213              </button>
214            </div>
215            <label class="toc-overlay-icon toc-content-icon no-toc" for="__toc">
216              <div class="visually-hidden">Toggle table of contents sidebar</div>
217              <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
218            </label>
219          </div>
220          <article role="main">
221            
222  <noscript>
223  <div class="admonition error">
224    <p class="admonition-title">Error</p>
225    <p>
226      Please activate JavaScript to enable the search functionality.
227    </p>
228  </div>
229  </noscript>
230  
231  <div id="search-results"></div>
232  
233          </article>
234        </div>
235        <footer>
236          
237          <div class="related-pages">
238            
239            
240          </div>
241          <div class="bottom-of-page">
242            <div class="left-details">
243              <div class="copyright">
244                  Copyright &#169; 2023, Mark Qvist
245              </div>
246              Generated with <a href="https://www.sphinx-doc.org/">Sphinx</a> and 
247              <a href="https://github.com/pradyunsg/furo">Furo</a>
248              
249            </div>
250            <div class="right-details">
251              <div class="icons">
252                
253              </div>
254            </div>
255          </div>
256          
257        </footer>
258      </div>
259      <aside class="toc-drawer no-toc">
260        
261        
262        
263      </aside>
264    </div>
265  </div><script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
266      <script src="_static/jquery.js"></script>
267      <script src="_static/underscore.js"></script>
268      <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
269      <script src="_static/doctools.js"></script>
270      <script src="_static/sphinx_highlight.js"></script>
271      <script src="_static/scripts/furo.js"></script>
272      <script src="_static/clipboard.min.js"></script>
273      <script src="_static/copybutton.js"></script>
274      
275  <script src="_static/searchtools.js"></script>
276  <script src="_static/language_data.js"></script>
277  <script src="searchindex.js"></script></body>
278  </html>