|
| 1 | +<!doctype html> |
| 2 | +<html lang="en"> |
| 3 | +<head> |
| 4 | +<meta charset="utf-8"> |
| 5 | +<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1"> |
| 6 | +<meta name="generator" content="pdoc3 0.11.6"> |
| 7 | +<title>linux_plus_plus.apps API documentation</title> |
| 8 | +<meta name="description" content="Contains all the code for all the applications in the terminal."> |
| 9 | +<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin> |
| 10 | +<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin> |
| 11 | +<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin> |
| 12 | +<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source > summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible;min-width:max-content}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin:1em 0}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style> |
| 13 | +<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style> |
| 14 | +<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style> |
| 15 | +<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script> |
| 16 | +<script>window.addEventListener('DOMContentLoaded', () => { |
| 17 | +hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']}); |
| 18 | +hljs.highlightAll(); |
| 19 | +/* Collapse source docstrings */ |
| 20 | +setTimeout(() => { |
| 21 | +[...document.querySelectorAll('.hljs.language-python > .hljs-string')] |
| 22 | +.filter(el => el.innerHTML.length > 200 && ['"""', "'''"].includes(el.innerHTML.substring(0, 3))) |
| 23 | +.forEach(el => { |
| 24 | +let d = document.createElement('details'); |
| 25 | +d.classList.add('hljs-string'); |
| 26 | +d.innerHTML = '<summary>"""</summary>' + el.innerHTML.substring(3); |
| 27 | +el.replaceWith(d); |
| 28 | +}); |
| 29 | +}, 100); |
| 30 | +})</script> |
| 31 | +<link rel="preconnect" href="https://fonts.googleapis.com"> |
| 32 | +<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin> |
| 33 | +<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700;800&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet"> |
| 34 | +<script src="https://cdn.tailwindcss.com"></script> |
| 35 | +<script> |
| 36 | +tailwind.config = { |
| 37 | +darkMode: 'class', |
| 38 | +theme: { |
| 39 | +extend: { |
| 40 | +fontFamily: { |
| 41 | +sans: ['Inter', 'system-ui', 'sans-serif'], |
| 42 | +mono: ['JetBrains Mono', 'monospace'] |
| 43 | +} |
| 44 | +} |
| 45 | +} |
| 46 | +} |
| 47 | +</script> |
| 48 | +<script src="https://unpkg.com/lucide@latest"></script> |
| 49 | +<script> |
| 50 | +document.documentElement.classList.add('dark'); |
| 51 | +</script> |
| 52 | +<style> |
| 53 | +/* 1. Scrollbar - Zinc Style */ |
| 54 | +::-webkit-scrollbar { width: 8px; height: 8px; } |
| 55 | +::-webkit-scrollbar-track { background: #09090b; } |
| 56 | +::-webkit-scrollbar-thumb { background: #27272a; border-radius: 4px; } |
| 57 | +::-webkit-scrollbar-thumb:hover { background: #3f3f46; } |
| 58 | +/* 2. Global Resets - Unified Zinc Palette */ |
| 59 | +:root { |
| 60 | +--bg: #09090b !important; |
| 61 | +--text: #f4f4f5 !important; |
| 62 | +--accent: #3b82f6 !important; |
| 63 | +} |
| 64 | +html, body { |
| 65 | +background-color: #09090b !important; |
| 66 | +color: #f4f4f5 !important; |
| 67 | +font-family: 'Inter', system-ui, sans-serif !important; |
| 68 | +overflow-x: clip; |
| 69 | +scroll-behavior: smooth; |
| 70 | +} |
| 71 | +/* 3. Sidebar - Layout & Anti-Warping */ |
| 72 | +#sidebar { |
| 73 | +width: 280px !important; |
| 74 | +min-width: 280px !important; |
| 75 | +max-width: 280px !important; |
| 76 | +flex: 0 0 280px !important; |
| 77 | +background-color: #0c0c0e !important; |
| 78 | +border-right: 1px solid #18181b !important; |
| 79 | +padding: 2.5rem 1.5rem !important; |
| 80 | +box-shadow: none !important; |
| 81 | +} |
| 82 | +#sidebar h1, #sidebar h2, #sidebar h3 { |
| 83 | +color: #fafafa !important; |
| 84 | +font-size: 0.875rem !important; |
| 85 | +font-weight: 600 !important; |
| 86 | +letter-spacing: -0.01em !important; |
| 87 | +border-bottom: none !important; |
| 88 | +margin-top: 1.5rem !important; |
| 89 | +margin-bottom: 0.75rem !important; |
| 90 | +padding: 0 !important; |
| 91 | +} |
| 92 | +#sidebar h1 { font-size: 1rem !important; margin-left: 0.5rem !important; } |
| 93 | +#sidebar ul { margin: 0 !important; padding: 0 !important; border: none !important; } |
| 94 | +#sidebar li { margin: 0 !important; padding: 0 !important; border: none !important; } |
| 95 | +#sidebar a { |
| 96 | +display: block !important; |
| 97 | +color: #a1a1aa !important; |
| 98 | +text-decoration: none !important; |
| 99 | +margin-bottom: 0.25rem !important; |
| 100 | +padding: 0.4rem 0.75rem !important; |
| 101 | +border-radius: 0.5rem !important; |
| 102 | +font-size: 0.875rem !important; |
| 103 | +transition: all 0.2s ease !important; |
| 104 | +white-space: normal !important; |
| 105 | +overflow-wrap: anywhere !important; |
| 106 | +word-break: break-word !important; |
| 107 | +line-height: 1.4 !important; |
| 108 | +} |
| 109 | +#sidebar a:hover { |
| 110 | +background-color: #18181b !important; |
| 111 | +color: #3b82f6 !important; |
| 112 | +} |
| 113 | +#sidebar code { |
| 114 | +padding: 0; |
| 115 | +margin: 0; |
| 116 | +} |
| 117 | +/* 4. Main Content - Balanced Spacing */ |
| 118 | +#content { |
| 119 | +flex: 1 !important; |
| 120 | +min-width: 0 !important; |
| 121 | +padding: 3rem 4rem !important; |
| 122 | +max-width: 64rem !important; |
| 123 | +margin: 0 auto !important; |
| 124 | +border-left: none !important; |
| 125 | +} |
| 126 | +/* Main Top Title */ |
| 127 | +#content h1.title { |
| 128 | +font-size: 2.5rem !important; |
| 129 | +font-weight: 800 !important; |
| 130 | +letter-spacing: -0.04em !important; |
| 131 | +color: #ffffff !important; |
| 132 | +margin-bottom: 2rem !important; |
| 133 | +} |
| 134 | +/* Standard internal H1 tags generated by markdown */ |
| 135 | +#content h1:not(.title) { |
| 136 | +font-size: 1.75rem !important; |
| 137 | +font-weight: 700 !important; |
| 138 | +color: #f4f4f5 !important; |
| 139 | +margin-top: 2.5rem !important; |
| 140 | +margin-bottom: 1.25rem !important; |
| 141 | +letter-spacing: -0.02em !important; |
| 142 | +} |
| 143 | +/* Standard internal H2 tags */ |
| 144 | +#content h2 { |
| 145 | +font-size: 1.35rem !important; |
| 146 | +font-weight: 600 !important; |
| 147 | +color: #f4f4f5 !important; |
| 148 | +margin-top: 2.5rem !important; |
| 149 | +margin-bottom: 1rem !important; |
| 150 | +} |
| 151 | +#content h2.section-title { |
| 152 | +font-size: 1.25rem !important; |
| 153 | +border-bottom: 1px solid #18181b !important; |
| 154 | +padding-bottom: 0.75rem !important; |
| 155 | +margin-top: 3.5rem !important; |
| 156 | +margin-bottom: 1.5rem !important; |
| 157 | +} |
| 158 | +/* 5. Signatures (dt) - Code Container */ |
| 159 | +dt { |
| 160 | +background-color: #111113 !important; |
| 161 | +border: 1px solid #27272a !important; |
| 162 | +border-radius: 0.75rem !important; |
| 163 | +padding: 1rem 1.25rem !important; |
| 164 | +margin-top: 1.5rem !important; |
| 165 | +margin-bottom: 1rem !important; |
| 166 | +font-family: 'JetBrains Mono', monospace !important; |
| 167 | +font-size: 0.875rem !important; |
| 168 | +color: #e4e4e7 !important; |
| 169 | +line-height: 1.6 !important; |
| 170 | +overflow-x: auto !important; |
| 171 | +white-space: pre-wrap !important; |
| 172 | +} |
| 173 | +dt .name { |
| 174 | +color: #60a5fa !important; |
| 175 | +font-weight: 600 !important; |
| 176 | +background: transparent !important; |
| 177 | +} |
| 178 | +/* 6. Code Blocks & Preformatted Text */ |
| 179 | +#content pre { |
| 180 | +background-color: #0a0a0a !important; |
| 181 | +border: 1px solid rgba(255, 255, 255, 0.1) !important; |
| 182 | +border-radius: 0.75rem !important; |
| 183 | +padding: 1.25rem !important; |
| 184 | +margin-top: 1rem !important; |
| 185 | +margin-bottom: 1.5rem !important; |
| 186 | +color: #d4d4d8 !important; |
| 187 | +overflow-x: auto !important; |
| 188 | +} |
| 189 | +#content pre code { |
| 190 | +background-color: transparent !important; |
| 191 | +border: none !important; |
| 192 | +padding: 0 !important; |
| 193 | +color: inherit !important; |
| 194 | +font-size: inherit !important; |
| 195 | +} |
| 196 | +/* 7. Typography, Paragraphs & Lists */ |
| 197 | +#content p, |
| 198 | +.desc { |
| 199 | +color: #d4d4d8 !important; /* Brighter body text */ |
| 200 | +line-height: 1.75 !important; /* Better line gaping */ |
| 201 | +margin-bottom: 1.25rem !important; /* Space between paragraphs */ |
| 202 | +font-size: 1rem !important; |
| 203 | +} |
| 204 | +/* Restore List Styling in Main Content */ |
| 205 | +#content ul { |
| 206 | +list-style-type: disc !important; |
| 207 | +padding-left: 1.5rem !important; |
| 208 | +margin-bottom: 1.5rem !important; |
| 209 | +color: #d4d4d8 !important; |
| 210 | +} |
| 211 | +#content li { |
| 212 | +margin-bottom: 0.5rem !important; |
| 213 | +line-height: 1.6 !important; |
| 214 | +} |
| 215 | +/* Inline Code Styling */ |
| 216 | +#content p code, #content li code, .desc code { |
| 217 | +background-color: #18181b !important; /* Zinc-900 */ |
| 218 | +border: 1px solid #27272a !important; |
| 219 | +padding: 0.2rem 0.4rem !important; |
| 220 | +border-radius: 0.375rem !important; |
| 221 | +color: #f4f4f5 !important; /* Zinc-100 */ |
| 222 | +font-size: 0.9em !important; |
| 223 | +} |
| 224 | +/* 8. Links & Visibility Fixes */ |
| 225 | +#content a { |
| 226 | +color: #60a5fa !important; |
| 227 | +text-decoration: none !important; |
| 228 | +} |
| 229 | +#content a:hover { |
| 230 | +color: #93c5fd !important; |
| 231 | +} |
| 232 | +:target { |
| 233 | +background-color: rgba(59, 130, 246, 0.15) !important; |
| 234 | +color: inherit !important; |
| 235 | +} |
| 236 | +#content code.name, |
| 237 | +#content code.name a, |
| 238 | +#content .name, |
| 239 | +#content .name a { |
| 240 | +color: #60a5fa !important; |
| 241 | +text-decoration: none !important; |
| 242 | +} |
| 243 | +#content code.name a:hover, |
| 244 | +#content .name a:hover { |
| 245 | +color: #93c5fd !important; |
| 246 | +} |
| 247 | +#content code { |
| 248 | +color: #e4e4e7 !important; |
| 249 | +} |
| 250 | +</style> |
| 251 | +</head> |
| 252 | +<body> |
| 253 | +<main> |
| 254 | +<article id="content"> |
| 255 | +<header> |
| 256 | +<h1 class="title">Module <code>linux_plus_plus.apps</code></h1> |
| 257 | +</header> |
| 258 | +<section id="section-intro"> |
| 259 | +<p>Contains all the code for all the applications in the terminal.</p> |
| 260 | +</section> |
| 261 | +<section> |
| 262 | +<h2 class="section-title" id="header-submodules">Sub-modules</h2> |
| 263 | +<dl> |
| 264 | +<dt><code class="name"><a title="linux_plus_plus.apps.ftp_client" href="ftp_client.html">linux_plus_plus.apps.ftp_client</a></code></dt> |
| 265 | +<dd> |
| 266 | +<div class="desc"></div> |
| 267 | +</dd> |
| 268 | +<dt><code class="name"><a title="linux_plus_plus.apps.pkg_manager" href="pkg_manager.html">linux_plus_plus.apps.pkg_manager</a></code></dt> |
| 269 | +<dd> |
| 270 | +<div class="desc"></div> |
| 271 | +</dd> |
| 272 | +<dt><code class="name"><a title="linux_plus_plus.apps.script_runner" href="script_runner.html">linux_plus_plus.apps.script_runner</a></code></dt> |
| 273 | +<dd> |
| 274 | +<div class="desc"></div> |
| 275 | +</dd> |
| 276 | +<dt><code class="name"><a title="linux_plus_plus.apps.ssh_client" href="ssh_client.html">linux_plus_plus.apps.ssh_client</a></code></dt> |
| 277 | +<dd> |
| 278 | +<div class="desc"></div> |
| 279 | +</dd> |
| 280 | +<dt><code class="name"><a title="linux_plus_plus.apps.ssh_daemon" href="ssh_daemon.html">linux_plus_plus.apps.ssh_daemon</a></code></dt> |
| 281 | +<dd> |
| 282 | +<div class="desc"></div> |
| 283 | +</dd> |
| 284 | +<dt><code class="name"><a title="linux_plus_plus.apps.system_info" href="system_info.html">linux_plus_plus.apps.system_info</a></code></dt> |
| 285 | +<dd> |
| 286 | +<div class="desc"></div> |
| 287 | +</dd> |
| 288 | +<dt><code class="name"><a title="linux_plus_plus.apps.text_editor" href="text_editor.html">linux_plus_plus.apps.text_editor</a></code></dt> |
| 289 | +<dd> |
| 290 | +<div class="desc"></div> |
| 291 | +</dd> |
| 292 | +</dl> |
| 293 | +</section> |
| 294 | +<section> |
| 295 | +</section> |
| 296 | +<section> |
| 297 | +</section> |
| 298 | +<section> |
| 299 | +</section> |
| 300 | +</article> |
| 301 | +<nav id="sidebar"> |
| 302 | +<div class="toc"> |
| 303 | +<ul></ul> |
| 304 | +</div> |
| 305 | +<ul id="index"> |
| 306 | +<li><h3>Super-module</h3> |
| 307 | +<ul> |
| 308 | +<li><code><a title="linux_plus_plus" href="../index.html">linux_plus_plus</a></code></li> |
| 309 | +</ul> |
| 310 | +</li> |
| 311 | +<li><h3><a href="#header-submodules">Sub-modules</a></h3> |
| 312 | +<ul> |
| 313 | +<li><code><a title="linux_plus_plus.apps.ftp_client" href="ftp_client.html">linux_plus_plus.apps.ftp_client</a></code></li> |
| 314 | +<li><code><a title="linux_plus_plus.apps.pkg_manager" href="pkg_manager.html">linux_plus_plus.apps.pkg_manager</a></code></li> |
| 315 | +<li><code><a title="linux_plus_plus.apps.script_runner" href="script_runner.html">linux_plus_plus.apps.script_runner</a></code></li> |
| 316 | +<li><code><a title="linux_plus_plus.apps.ssh_client" href="ssh_client.html">linux_plus_plus.apps.ssh_client</a></code></li> |
| 317 | +<li><code><a title="linux_plus_plus.apps.ssh_daemon" href="ssh_daemon.html">linux_plus_plus.apps.ssh_daemon</a></code></li> |
| 318 | +<li><code><a title="linux_plus_plus.apps.system_info" href="system_info.html">linux_plus_plus.apps.system_info</a></code></li> |
| 319 | +<li><code><a title="linux_plus_plus.apps.text_editor" href="text_editor.html">linux_plus_plus.apps.text_editor</a></code></li> |
| 320 | +</ul> |
| 321 | +</li> |
| 322 | +</ul> |
| 323 | +</nav> |
| 324 | +</main> |
| 325 | +<footer id="footer"> |
| 326 | +<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.6</a>.</p> |
| 327 | +</footer> |
| 328 | +</body> |
| 329 | +</html> |
0 commit comments