mirror of
https://github.com/Hilbis/Hilbish
synced 2025-07-01 08:42:04 +00:00
deploy: 24b16d30d63e8ee79f6a7efad2a8c1f1b784df5b
This commit is contained in:
sammy-ette
parent
64880939dc
commit
be17ac8402
4
versions/readline-move/404.html
Normal file
4
versions/readline-move/404.html
Normal file
@ -0,0 +1,4 @@
|
||||
<!doctype html><html><head><title>404 Page not found — Hilbish</title><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><meta name=theme-color content="#ff89dd"><meta content="/Hilbish/hilbish-flower.png" property="og:image"><meta property="og:site_name" content="Hilbish"><meta content="404 Page not found — Hilbish" property="og:title"><meta content property="og:description"><meta content name=description><meta name=revisit-after content="2 days"><meta name=keywords content="Lua,Hilbish,Linux,Shell"><meta property="og:locale" content="en_GB"><link rel=canonical href=https://rosettea.github.io/Hilbish/><meta property="og:url" content="https://rosettea.github.io/Hilbish/"><link href=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css rel=stylesheet integrity=sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor crossorigin=anonymous><script src=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js integrity=sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2 crossorigin=anonymous></script>
|
||||
<link rel=stylesheet href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" crossorigin=anonymous referrerpolicy=no-referrer><link rel=stylesheet href=/Hilbish/versions/readline-move/css/syntax.min.eb77978873f3b324603120b558a36c98ad57d6ee7b77928e3bc131bd76c5935a.css integrity="sha256-63eXiHPzsyRgMSC1WKNsmK1X1u57d5KOO8ExvXbFk1o="></link><style>.heading>.heading-link{opacity:0}.heading:hover>.heading-link{visibility:visible;opacity:1;transition:all .1s ease-in}@keyframes highlight{0%{background:0 0}50%{background:#fff2cf}100%{background:0 0}}div:target{animation:highlight 1.2s;animation-timing-function:cubic-bezier(1,-.02,.45,.89)}table{border-width:1px;border-style:solid;border-color:#565c64;border-collapse:collapse;margin-bottom:12px}table td{padding:5px}table tr{border-width:1px}thead{display:none}</style></head><body class="d-flex flex-column min-vh-100" style=overflow-x:hidden><svg xmlns="http://www.w3.org/2000/svg" style="display:none"><symbol id="check-circle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="exclamation-triangle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><header><nav class="navbar navbar-expand-md sticky-top bg-light border-bottom"><div class=container-fluid><a class=navbar-brand href=/Hilbish><img src=/Hilbish/hilbish-logo-and-text.png alt height=48></a>
|
||||
<button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
|
||||
<span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/readline-move/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><main id=main><div><h1><a href=/>Go Home</a></h1></div></main><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea © 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>
|
||||
@ -0,0 +1,28 @@
|
||||
<!doctype html><html><head><title>Improving Hilbish's Branding — Hilbish</title><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><meta name=theme-color content="#ff89dd"><meta content="/Hilbish/hilbish-flower.png" property="og:image"><meta property="og:site_name" content="Hilbish"><meta content="Improving Hilbish's Branding — Hilbish" property="og:title"><meta content="Happy birthday Hilbish! As of last month, Hilbish is now 2 years old. Unfortunately I missed the official date, but I will still make a more focused post on the date (19st).
|
||||
I decided to fix up this website and Hilbish’s logo, so that can be thought of as something for the 2 years milestone?
|
||||
Logo Hilbish’s old logo was.. not that good. It definitely functioned as a logo, but the yellow part of it looked ugly (sorry old logo)." property="og:description"><meta content="Happy birthday Hilbish! As of last month, Hilbish is now 2 years old. Unfortunately I missed the official date, but I will still make a more focused post on the date (19st).
|
||||
I decided to fix up this website and Hilbish’s logo, so that can be thought of as something for the 2 years milestone?
|
||||
Logo Hilbish’s old logo was.. not that good. It definitely functioned as a logo, but the yellow part of it looked ugly (sorry old logo)." name=description><meta name=revisit-after content="2 days"><meta name=keywords content="Lua,Hilbish,Linux,Shell"><meta property="og:locale" content="en_GB"><link rel=canonical href=https://rosettea.github.io/Hilbish/><meta property="og:url" content="https://rosettea.github.io/Hilbish/"><link href=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css rel=stylesheet integrity=sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor crossorigin=anonymous><script src=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js integrity=sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2 crossorigin=anonymous></script>
|
||||
<link rel=stylesheet href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" crossorigin=anonymous referrerpolicy=no-referrer><link rel=stylesheet href=/Hilbish/versions/readline-move/css/syntax.min.eb77978873f3b324603120b558a36c98ad57d6ee7b77928e3bc131bd76c5935a.css integrity="sha256-63eXiHPzsyRgMSC1WKNsmK1X1u57d5KOO8ExvXbFk1o="></link><style>.heading>.heading-link{opacity:0}.heading:hover>.heading-link{visibility:visible;opacity:1;transition:all .1s ease-in}@keyframes highlight{0%{background:0 0}50%{background:#fff2cf}100%{background:0 0}}div:target{animation:highlight 1.2s;animation-timing-function:cubic-bezier(1,-.02,.45,.89)}table{border-width:1px;border-style:solid;border-color:#565c64;border-collapse:collapse;margin-bottom:12px}table td{padding:5px}table tr{border-width:1px}thead{display:none}</style></head><body class="d-flex flex-column min-vh-100" style=overflow-x:hidden><svg xmlns="http://www.w3.org/2000/svg" style="display:none"><symbol id="check-circle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="exclamation-triangle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><header><nav class="navbar navbar-expand-md sticky-top bg-light border-bottom"><div class=container-fluid><a class=navbar-brand href=/Hilbish><img src=/Hilbish/hilbish-logo-and-text.png alt height=48></a>
|
||||
<button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
|
||||
<span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/readline-move/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><main><div class="container mt-2"><h1>Improving Hilbish's Branding</h1><img src='https://avatars1.githubusercontent.com/u/38820196?s=460&u=b9f4efb2375bae6cb30656d790c6e0a2939327c0&v=4' width=48 style=border-radius:100%>
|
||||
<em class=text-muted>by <strong>sammyette</strong><time> // April 13, 2023</time></em><div class=my-4><p>Happy birthday Hilbish! As of last month, Hilbish is now 2 years old.
|
||||
Unfortunately I missed the official date, but I will still make a more
|
||||
focused post on the date (19st).</p><p>I decided to fix up this website and Hilbish’s logo, so that can
|
||||
be thought of as something for the 2 years milestone?</p><h2 id=logo class=heading>Logo
|
||||
<a href=#logo class=heading-link><i class="fas fa-paperclip"></i></a></h2><p>Hilbish’s old logo was.. not that good. It definitely functioned
|
||||
as a logo, but the yellow part of it looked ugly (sorry old logo).</p><img src=https://safe.kashima.moe/4c6e9q484pcy.png width=256><br><p>You would have definitely seen the new logo, since it is currently
|
||||
in use on the navigation bar and footer. Here it is in a bigger view:</p><img src=https://safe.kashima.moe/oy72vpev2yi4.png width=256><br><h2 id=website class=heading>Website
|
||||
<a href=#website class=heading-link><i class="fas fa-paperclip"></i></a></h2><p>Ever since this website was first made, from the release of v2.0, it has
|
||||
been doing it’s job of being a website good enough, but there were a few issues.</p><h2 id=padding class=heading>Padding
|
||||
<a href=#padding class=heading-link><i class="fas fa-paperclip"></i></a></h2><p>Padding is very important! The edges of your screen need space to do nothing,
|
||||
after all. On mobile or screens small enough, there would not be enough space
|
||||
for the auto margin to fill, and since there was no padding besides that,
|
||||
it means things would look a bit cramped. This was simple to fix.</p><p>Here it is before:<br><img src=https://safe.kashima.moe/nupzzalt2oa4.png alt=Before></p><p>and after:<br><img src=https://safe.kashima.moe/r0ox4nazfi0q.png alt=After></p><h2 id=docs-navigation class=heading>Docs Navigation
|
||||
<a href=#docs-navigation class=heading-link><i class="fas fa-paperclip"></i></a></h2><p>On the docs page, the pages are on the left on desktop. Since
|
||||
phones are too small to have this content on the side, it stays at the top.
|
||||
This is a bit counter intuitive since it brings in extra scrolling
|
||||
when navigating to every page for docs and just doesn’t look that good.</p><p>A few months ago I made it collapse with the site wide navigation, but it
|
||||
was not hidden by default. So a few improvements were made:</p><ul><li>Make the doc navigation hidden by default on mobile, just like site wide navigation</li><li>Make doc navigation have the same look as site wide navigation</li></ul><p>Here’s a before:<br><img src=https://safe.kashima.moe/krn0a6qwegdj.png alt></p><p>and after:<br><img src=https://safe.kashima.moe/sk11ighz47yb.png alt></p><p>Looks a lot better now.</p><h2 id=other-changes class=heading>Other Changes
|
||||
<a href=#other-changes class=heading-link><i class="fas fa-paperclip"></i></a></h2><p>If you haven’t noticed, I have made other changes to the website.
|
||||
This includes:</p><ul><li>Borders! Something this simple makes the website look a lot better, especially on mobile.</li><li>More padding and margin everywhere. Home, doc pages, blog post listing.</li></ul></div></div></main><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea © 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>
|
||||
19
versions/readline-move/blog/index.html
Normal file
19
versions/readline-move/blog/index.html
Normal file
@ -0,0 +1,19 @@
|
||||
<!doctype html><html><head><title>Blogs — Hilbish</title><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><meta name=theme-color content="#ff89dd"><meta content="/Hilbish/hilbish-flower.png" property="og:image"><meta property="og:site_name" content="Hilbish"><meta content="Blogs — Hilbish" property="og:title"><meta content property="og:description"><meta content name=description><meta name=revisit-after content="2 days"><meta name=keywords content="Lua,Hilbish,Linux,Shell"><meta property="og:locale" content="en_GB"><link rel=canonical href=https://rosettea.github.io/Hilbish/><meta property="og:url" content="https://rosettea.github.io/Hilbish/"><link href=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css rel=stylesheet integrity=sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor crossorigin=anonymous><script src=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js integrity=sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2 crossorigin=anonymous></script>
|
||||
<link rel=stylesheet href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" crossorigin=anonymous referrerpolicy=no-referrer><link rel=stylesheet href=/Hilbish/versions/readline-move/css/syntax.min.eb77978873f3b324603120b558a36c98ad57d6ee7b77928e3bc131bd76c5935a.css integrity="sha256-63eXiHPzsyRgMSC1WKNsmK1X1u57d5KOO8ExvXbFk1o="></link><style>.heading>.heading-link{opacity:0}.heading:hover>.heading-link{visibility:visible;opacity:1;transition:all .1s ease-in}@keyframes highlight{0%{background:0 0}50%{background:#fff2cf}100%{background:0 0}}div:target{animation:highlight 1.2s;animation-timing-function:cubic-bezier(1,-.02,.45,.89)}table{border-width:1px;border-style:solid;border-color:#565c64;border-collapse:collapse;margin-bottom:12px}table td{padding:5px}table tr{border-width:1px}thead{display:none}</style></head><body class="d-flex flex-column min-vh-100" style=overflow-x:hidden><svg xmlns="http://www.w3.org/2000/svg" style="display:none"><symbol id="check-circle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="exclamation-triangle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><header><nav class="navbar navbar-expand-md sticky-top bg-light border-bottom"><div class=container-fluid><a class=navbar-brand href=/Hilbish><img src=/Hilbish/hilbish-logo-and-text.png alt height=48></a>
|
||||
<button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
|
||||
<span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/readline-move/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/blog/ class="nav-link active">Blog</a></li></ul></div></div></nav></header><main class="mt-4 mb-4"><div class="row row-cols-1 row-cols-md-1 g-4"><div class="col d-flex justify-content-center"><div class=card style=width:56rem><div class=card-body><a href=https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.3-release/><h5 class=card-title>v2.3 Release</h5></a><h6 class='card-subtitle text-muted mb-2'><time>July 20, 2024</time></h6><p class=card-text>The release with full changelogs and prebuilt binaries can be seen at the v2.3.0 tag.
|
||||
Hilbish v2.3 has now been released! This is small feature and bug fix release which took a while to cme ut since I took a long break from programming in general. The next release will be great, so stay tuned for that.
|
||||
Features Pipes (via Lua) Commands can now be piped to each other via the Lua API with the hilbish.</p></div></div></div><div class="col d-flex justify-content-center"><div class=card style=width:56rem><div class=card-body><a href=https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.2-release/><h5 class=card-title>v2.2 Release</h5></a><h6 class='card-subtitle text-muted mb-2'><time>December 25, 2023</time></h6><p class=card-text>The release with full changelogs and prebuilt binaries can be seen at the v2.2.0 tag.
|
||||
Welcome to a very long awaited release of Hilbish, and on Christmas. Just think of it as a long preparing, late Christmas gift. :) This release does not contain a whole lot of changes, but it is a new release with enhancements and bug fixes!
|
||||
Documentation As is a trend, the documentation has been improved by ONE HUNDRED TIMES.</p></div></div></div><div class="col d-flex justify-content-center"><div class=card style=width:56rem><div class=card-body><a href=https://rosettea.github.io/Hilbish/versions/readline-move/blog/improving-this-website/><h5 class=card-title>Improving Hilbish's Branding</h5></a><h6 class='card-subtitle text-muted mb-2'><time>April 13, 2023</time></h6><p class=card-text>Happy birthday Hilbish! As of last month, Hilbish is now 2 years old. Unfortunately I missed the official date, but I will still make a more focused post on the date (19st).
|
||||
I decided to fix up this website and Hilbish’s logo, so that can be thought of as something for the 2 years milestone?
|
||||
Logo Hilbish’s old logo was.. not that good. It definitely functioned as a logo, but the yellow part of it looked ugly (sorry old logo).</p></div></div></div><div class="col d-flex justify-content-center"><div class=card style=width:56rem><div class=card-body><a href=https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.1.2-release/><h5 class=card-title>v2.1.2 Release</h5></a><h6 class='card-subtitle text-muted mb-2'><time>April 10, 2023</time></h6><p class=card-text>The release with full changelogs and prebuilt binaries can be seen at the v2.1.2 tag.
|
||||
This release reverts the April Fool’s code additions in v2.1.1. It is functionally equal to v2.1.0. Nice!
|
||||
A real release will come possibly in a few days or next week, so stay tuned for the good and feature-filled release of v2.2!</p></div></div></div><div class="col d-flex justify-content-center"><div class=card style=width:56rem><div class=card-body><a href=https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.1.1-release/><h5 class=card-title>v2.1.1 Release</h5></a><h6 class='card-subtitle text-muted mb-2'><time>April 1, 2023</time></h6><p class=card-text>The release with full changelogs and prebuilt binaries can be seen at the v2.1.1 tag.
|
||||
Welcome to a fresh new release of Hilbish! Some people (or none) may be awaiting the long coming v2.2 release with lots of features, but I needed to push out this little bug fix (wink) release.
|
||||
Bug Fixes Validation checks for command input When running this version, you may have noticed an odd message that sometimes comes up when running commands.</p></div></div></div><div class="col d-flex justify-content-center"><div class=card style=width:56rem><div class=card-body><a href=https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.1-release/><h5 class=card-title>v2.1 Release</h5></a><h6 class='card-subtitle text-muted mb-2'><time>February 7, 2023</time></h6><p class=card-text>The release with full changelogs and prebuilt binaries can be seen at the v2.1.0 tag.
|
||||
Oh look! A new release of Hilbish! This time is the v2.1 release, with a small amount of features and mainly documentation changes and bug fixes.
|
||||
Documentation There have been a few documentation enhancements for this release. This includes:
|
||||
Adding the return types for all functions that need them Documenting Hilbish types like job objects and timers properly.</p></div></div></div><div class="col d-flex justify-content-center"><div class=card style=width:56rem><div class=card-body><a href=https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.0-release/><h5 class=card-title>Hilbish v2.0 Release</h5></a><h6 class='card-subtitle text-muted mb-2'><time>December 29, 2022</time></h6><p class=card-text>Hilbish v2.0 has been released! Well actually, it was released a week ago, but I only wrote this Hilbish blog after that.
|
||||
This is a big release, coming 9 months after the previous v1.2.0 and featuring over 40+ bug fixes and tons of new features and enhancements, so let’s see what is in this release.
|
||||
Documentation When querying about the problems people have with Hilbish, one of the issues was its poor documentation.</p></div></div></div><div class="col d-flex justify-content-center"><div class=card style=width:56rem><div class=card-body><a href=https://rosettea.github.io/Hilbish/versions/readline-move/install/><h5 class=card-title>Install</h5></a><h6 class='card-subtitle text-muted mb-2'></h6><p class=card-text>Steps on how to install Hilbish on all the OSes and distros supported.</p></div></div></div><div class="col d-flex justify-content-center"><div class=card style=width:56rem><div class=card-body><a href=https://rosettea.github.io/Hilbish/versions/readline-move/blog/welcome/><h5 class=card-title>Welcome to the Hilbish blog</h5></a><h6 class='card-subtitle text-muted mb-2'></h6><p class=card-text>Hello! Welcome to the Hilbish blog. This will mainly contain release announcements and some other things relating to Hilbish (development).</p></div></div></div></div></main><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea © 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>
|
||||
16
versions/readline-move/blog/index.xml
Normal file
16
versions/readline-move/blog/index.xml
Normal file
@ -0,0 +1,16 @@
|
||||
<?xml version="1.0" encoding="utf-8" standalone="yes"?><rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Blogs on Hilbish</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/blog/</link><description>Recent content in Blogs on Hilbish</description><generator>Hugo -- gohugo.io</generator><language>en-us</language><lastBuildDate>Sat, 20 Jul 2024 10:05:17 -0400</lastBuildDate><atom:link href="https://rosettea.github.io/Hilbish/versions/readline-move/blog/index.xml" rel="self" type="application/rss+xml"/><item><title>v2.3 Release</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.3-release/</link><pubDate>Sat, 20 Jul 2024 10:05:17 -0400</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.3-release/</guid><description>The release with full changelogs and prebuilt binaries can be seen at the v2.3.0 tag.
|
||||
Hilbish v2.3 has now been released! This is small feature and bug fix release which took a while to cme ut since I took a long break from programming in general. The next release will be great, so stay tuned for that.
|
||||
Features Pipes (via Lua) Commands can now be piped to each other via the Lua API with the hilbish.</description></item><item><title>v2.2 Release</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.2-release/</link><pubDate>Mon, 25 Dec 2023 23:56:36 -0400</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.2-release/</guid><description>The release with full changelogs and prebuilt binaries can be seen at the v2.2.0 tag.
|
||||
Welcome to a very long awaited release of Hilbish, and on Christmas. Just think of it as a long preparing, late Christmas gift. :) This release does not contain a whole lot of changes, but it is a new release with enhancements and bug fixes!
|
||||
Documentation As is a trend, the documentation has been improved by ONE HUNDRED TIMES.</description></item><item><title>Improving Hilbish's Branding</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/blog/improving-this-website/</link><pubDate>Thu, 13 Apr 2023 22:15:31 -0400</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/blog/improving-this-website/</guid><description>Happy birthday Hilbish! As of last month, Hilbish is now 2 years old. Unfortunately I missed the official date, but I will still make a more focused post on the date (19st).
|
||||
I decided to fix up this website and Hilbish&rsquo;s logo, so that can be thought of as something for the 2 years milestone?
|
||||
Logo Hilbish&rsquo;s old logo was.. not that good. It definitely functioned as a logo, but the yellow part of it looked ugly (sorry old logo).</description></item><item><title>v2.1.2 Release</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.1.2-release/</link><pubDate>Mon, 10 Apr 2023 12:27:41 -0400</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.1.2-release/</guid><description>The release with full changelogs and prebuilt binaries can be seen at the v2.1.2 tag.
|
||||
This release reverts the April Fool&rsquo;s code additions in v2.1.1. It is functionally equal to v2.1.0. Nice!
|
||||
A real release will come possibly in a few days or next week, so stay tuned for the good and feature-filled release of v2.2!</description></item><item><title>v2.1.1 Release</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.1.1-release/</link><pubDate>Sat, 01 Apr 2023 18:15:42 -0400</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.1.1-release/</guid><description>The release with full changelogs and prebuilt binaries can be seen at the v2.1.1 tag.
|
||||
Welcome to a fresh new release of Hilbish! Some people (or none) may be awaiting the long coming v2.2 release with lots of features, but I needed to push out this little bug fix (wink) release.
|
||||
Bug Fixes Validation checks for command input When running this version, you may have noticed an odd message that sometimes comes up when running commands.</description></item><item><title>v2.1 Release</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.1-release/</link><pubDate>Tue, 07 Feb 2023 18:25:38 -0400</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.1-release/</guid><description>The release with full changelogs and prebuilt binaries can be seen at the v2.1.0 tag.
|
||||
Oh look! A new release of Hilbish! This time is the v2.1 release, with a small amount of features and mainly documentation changes and bug fixes.
|
||||
Documentation There have been a few documentation enhancements for this release. This includes:
|
||||
Adding the return types for all functions that need them Documenting Hilbish types like job objects and timers properly.</description></item><item><title>Hilbish v2.0 Release</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.0-release/</link><pubDate>Thu, 29 Dec 2022 01:55:21 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.0-release/</guid><description>Hilbish v2.0 has been released! Well actually, it was released a week ago, but I only wrote this Hilbish blog after that.
|
||||
This is a big release, coming 9 months after the previous v1.2.0 and featuring over 40+ bug fixes and tons of new features and enhancements, so let&rsquo;s see what is in this release.
|
||||
Documentation When querying about the problems people have with Hilbish, one of the issues was its poor documentation.</description></item><item><title>Welcome to the Hilbish blog</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/blog/welcome/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/blog/welcome/</guid><description>Hello! Welcome to the Hilbish blog. This will mainly contain release announcements and some other things relating to Hilbish (development).</description></item></channel></rss>
|
||||
65
versions/readline-move/blog/v2.0-release/index.html
Normal file
65
versions/readline-move/blog/v2.0-release/index.html
Normal file
@ -0,0 +1,65 @@
|
||||
<!doctype html><html><head><title>Hilbish v2.0 Release — Hilbish</title><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><meta name=theme-color content="#ff89dd"><meta content="/Hilbish/hilbish-flower.png" property="og:image"><meta property="og:site_name" content="Hilbish"><meta content="Hilbish v2.0 Release — Hilbish" property="og:title"><meta content="Hilbish v2.0 has been released! Well actually, it was released a week ago, but I only wrote this Hilbish blog after that.
|
||||
This is a big release, coming 9 months after the previous v1.2.0 and featuring over 40+ bug fixes and tons of new features and enhancements, so let’s see what is in this release.
|
||||
Documentation When querying about the problems people have with Hilbish, one of the issues was its poor documentation." property="og:description"><meta content="Hilbish v2.0 has been released! Well actually, it was released a week ago, but I only wrote this Hilbish blog after that.
|
||||
This is a big release, coming 9 months after the previous v1.2.0 and featuring over 40+ bug fixes and tons of new features and enhancements, so let’s see what is in this release.
|
||||
Documentation When querying about the problems people have with Hilbish, one of the issues was its poor documentation." name=description><meta name=revisit-after content="2 days"><meta name=keywords content="Lua,Hilbish,Linux,Shell"><meta property="og:locale" content="en_GB"><link rel=canonical href=https://rosettea.github.io/Hilbish/><meta property="og:url" content="https://rosettea.github.io/Hilbish/"><link href=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css rel=stylesheet integrity=sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor crossorigin=anonymous><script src=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js integrity=sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2 crossorigin=anonymous></script>
|
||||
<link rel=stylesheet href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" crossorigin=anonymous referrerpolicy=no-referrer><link rel=stylesheet href=/Hilbish/versions/readline-move/css/syntax.min.eb77978873f3b324603120b558a36c98ad57d6ee7b77928e3bc131bd76c5935a.css integrity="sha256-63eXiHPzsyRgMSC1WKNsmK1X1u57d5KOO8ExvXbFk1o="></link><style>.heading>.heading-link{opacity:0}.heading:hover>.heading-link{visibility:visible;opacity:1;transition:all .1s ease-in}@keyframes highlight{0%{background:0 0}50%{background:#fff2cf}100%{background:0 0}}div:target{animation:highlight 1.2s;animation-timing-function:cubic-bezier(1,-.02,.45,.89)}table{border-width:1px;border-style:solid;border-color:#565c64;border-collapse:collapse;margin-bottom:12px}table td{padding:5px}table tr{border-width:1px}thead{display:none}</style></head><body class="d-flex flex-column min-vh-100" style=overflow-x:hidden><svg xmlns="http://www.w3.org/2000/svg" style="display:none"><symbol id="check-circle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="exclamation-triangle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><header><nav class="navbar navbar-expand-md sticky-top bg-light border-bottom"><div class=container-fluid><a class=navbar-brand href=/Hilbish><img src=/Hilbish/hilbish-logo-and-text.png alt height=48></a>
|
||||
<button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
|
||||
<span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/readline-move/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><main><div class="container mt-2"><h1>Hilbish v2.0 Release</h1><img src='https://avatars1.githubusercontent.com/u/38820196?s=460&u=b9f4efb2375bae6cb30656d790c6e0a2939327c0&v=4' width=48 style=border-radius:100%>
|
||||
<em class=text-muted>by <strong>sammyette</strong><time> // December 29, 2022</time></em><div class=my-4><p>Hilbish v2.0 has been released!
|
||||
Well actually, it was released a week ago, but I only wrote this
|
||||
Hilbish blog <em>after</em> that.</p><p>This is a <strong>big</strong> release, coming 9 months after the previous v1.2.0 and
|
||||
featuring over 40+ bug fixes and tons of new features and enhancements, so
|
||||
let’s see what is in this release.</p><h2 id=documentation class=heading>Documentation
|
||||
<a href=#documentation class=heading-link><i class="fas fa-paperclip"></i></a></h2><p>When querying about the problems people have with Hilbish, one of the
|
||||
issues was its poor documentation. Hilbish had plain text, autogenerated
|
||||
documentation which only covered the module functions (bait, hilbish,
|
||||
commander, etc.) and did not include the interfaces (<code>hilbish.timers</code>,
|
||||
<code>hilbish.jobs</code> and all that).</p><p>I have tried to improve this by working on documenting all the
|
||||
interfaces (except for some functions of <code>hilbish.runner</code>, that’s hard to do)
|
||||
and made the documentation markdown for use on this website. This means
|
||||
that users can look at documentation here or with the <code>doc</code> command.</p><p>Hopefully this addresses documentation complaints, and if not, please open an issue.</p><h2 id=main-bug-fixes class=heading>Main Bug Fixes
|
||||
<a href=#main-bug-fixes class=heading-link><i class="fas fa-paperclip"></i></a></h2><p>As this is a piece of software with no unit testing that is maintained by me alone,
|
||||
there is gonna be either some bug or something that I overlooked when
|
||||
making a change. I make a lot of mistakes. There’s also the other fact that
|
||||
sometimes there’s just bugs for any other reasosn. Good thing I fixed
|
||||
more than 40 of those bugs in this release!</p><h3 id=readline-bug-fixes class=heading>Readline Bug Fixes
|
||||
<a href=#readline-bug-fixes class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>The pure Go readline library is good in some ways and bad in others.
|
||||
A good portion of the bug fixes are for the readline library, and also
|
||||
related to text input with east asian characters and the like (Korean, Japanese,
|
||||
etc.)</p><p>A few of the fixes (and additions) include:</p><ul><li>Fixing various crashes, including when there is a “stray” newline at the end of text</li><li>Grid completion menu causing spam and duplicate text when there are items longer than
|
||||
the terminal and/or contain Japanese or other characters.</li><li>Cursor positioning with CJK characters</li><li>Adding new keybinds and fixing others</li></ul><h3 id=other-fixes class=heading>Other fixes
|
||||
<a href=#other-fixes class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>There are a lot more fixes, even more than the ones listed here, but these are the main ones:
|
||||
- Don’t put alias expanded command in history (I’ve fixed this 5 times now….)
|
||||
- Handle stdin being nonblocking
|
||||
- Completion related fixes, like showing the full name, completing files with spaces</p><h2 id=breaking-changes class=heading>Breaking changes
|
||||
<a href=#breaking-changes class=heading-link><i class="fas fa-paperclip"></i></a></h2><p>This release is a major version bump not only because there are tons of fixes, but because
|
||||
there are breaking changes. This means that there are some changes done which would
|
||||
cause errors with an old user config (breaking).</p><h3 id=lua-54 class=heading>Lua 5.4
|
||||
<a href=#lua-54 class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>The most important is the use of a new Lua VM library. Previously, Hilbish
|
||||
used gopher-lua, which implements Lua 5.1. This has been changed to
|
||||
<a href=https://github.com/arnodel/golua/ target=_blank rel=noopener>golua</a>
|
||||
, which implements Lua 5.4.</p><p>Moving from 5.1 to 5.4 does have breaking changes even if it doesn’t seem like it,
|
||||
and since these are different Lua implementations, there may be some differences there too.</p><h3 id=userdata class=heading>Userdata
|
||||
<a href=#userdata class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>Previously, objects such as jobs or timers were represented by tables.
|
||||
This has been changed to userdata to make more sense.</p><h3 id=other-changes class=heading>Other changes
|
||||
<a href=#other-changes class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>Runner functions are now required to return a table.
|
||||
It can (at the moment) have 4 variables:</p><ul><li><code>input</code> (user input)</li><li><code>exitCode</code> (exit code)</li><li><code>error</code> (error message)</li><li><code>continue</code> (whether to prompt for more input)
|
||||
User input has been added to the return to account for runners wanting to
|
||||
prompt for continued input, and to add it properly to history. <code>continue</code>
|
||||
got added so that it would be easier for runners to get continued input
|
||||
without having to actually handle it at all.</li></ul><p>The MacOS config paths now match Linux, since it makes more sense for
|
||||
a program like Hilbish.</p><p>The Hilbish greeting is now an <em>opt</em>, and is printed by default.</p><h2 id=feature-additions class=heading>Feature Additions
|
||||
<a href=#feature-additions class=heading-link><i class="fas fa-paperclip"></i></a></h2><p>Besides fixes and changes, this release also includes a good portion of
|
||||
new features! Users can now add handlers for syntax highlighting and
|
||||
inline hinting.</p><p>Some new hooks have been added, like <code>hilbish.cancel</code> and <code>hilbish.init</code>.
|
||||
You can look at all the hooks via the <code>doc hooks</code> command</p><p>Job management functions have also been added. You can now put jobs in the
|
||||
foreground/background and disown them via the expected commands and also
|
||||
via the Lua API.</p><p>The <code>hilbish.timers</code> API interface was also added in this release!</p><h2 id=closing-off class=heading>Closing Off
|
||||
<a href=#closing-off class=heading-link><i class="fas fa-paperclip"></i></a></h2><p>Hilbish has gone from something small and simple for myself to a slightly
|
||||
advanced shell with a decent amount of features, and a few users. It
|
||||
still hasn’t reached levels of other alt shells in regards to literally
|
||||
everything, but the goal is to get there!</p><p>If you want to check the FULL changelog, you can <a href=https://github.com/Rosettea/Hilbish/releases/tag/v2.0.0 target=_blank rel=noopener>do so here.</a>
|
||||
This v2.0 release marks an advancement in Hilbish (and also how long
|
||||
one of my projects hasn’t died) and I hope it can advance even further.</p><p>Thanks for reading, and I’ll be back for the v2.1 release notes, or maybe
|
||||
something else in between.</p></div></div></main><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea © 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>
|
||||
44
versions/readline-move/blog/v2.1-release/index.html
Normal file
44
versions/readline-move/blog/v2.1-release/index.html
Normal file
@ -0,0 +1,44 @@
|
||||
<!doctype html><html><head><title>v2.1 Release — Hilbish</title><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><meta name=theme-color content="#ff89dd"><meta content="/Hilbish/hilbish-flower.png" property="og:image"><meta property="og:site_name" content="Hilbish"><meta content="v2.1 Release — Hilbish" property="og:title"><meta content="The release with full changelogs and prebuilt binaries can be seen at the v2.1.0 tag.
|
||||
Oh look! A new release of Hilbish! This time is the v2.1 release, with a small amount of features and mainly documentation changes and bug fixes.
|
||||
Documentation There have been a few documentation enhancements for this release. This includes:
|
||||
Adding the return types for all functions that need them Documenting Hilbish types like job objects and timers properly." property="og:description"><meta content="The release with full changelogs and prebuilt binaries can be seen at the v2.1.0 tag.
|
||||
Oh look! A new release of Hilbish! This time is the v2.1 release, with a small amount of features and mainly documentation changes and bug fixes.
|
||||
Documentation There have been a few documentation enhancements for this release. This includes:
|
||||
Adding the return types for all functions that need them Documenting Hilbish types like job objects and timers properly." name=description><meta name=revisit-after content="2 days"><meta name=keywords content="Lua,Hilbish,Linux,Shell"><meta property="og:locale" content="en_GB"><link rel=canonical href=https://rosettea.github.io/Hilbish/><meta property="og:url" content="https://rosettea.github.io/Hilbish/"><link href=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css rel=stylesheet integrity=sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor crossorigin=anonymous><script src=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js integrity=sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2 crossorigin=anonymous></script>
|
||||
<link rel=stylesheet href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" crossorigin=anonymous referrerpolicy=no-referrer><link rel=stylesheet href=/Hilbish/versions/readline-move/css/syntax.min.eb77978873f3b324603120b558a36c98ad57d6ee7b77928e3bc131bd76c5935a.css integrity="sha256-63eXiHPzsyRgMSC1WKNsmK1X1u57d5KOO8ExvXbFk1o="></link><style>.heading>.heading-link{opacity:0}.heading:hover>.heading-link{visibility:visible;opacity:1;transition:all .1s ease-in}@keyframes highlight{0%{background:0 0}50%{background:#fff2cf}100%{background:0 0}}div:target{animation:highlight 1.2s;animation-timing-function:cubic-bezier(1,-.02,.45,.89)}table{border-width:1px;border-style:solid;border-color:#565c64;border-collapse:collapse;margin-bottom:12px}table td{padding:5px}table tr{border-width:1px}thead{display:none}</style></head><body class="d-flex flex-column min-vh-100" style=overflow-x:hidden><svg xmlns="http://www.w3.org/2000/svg" style="display:none"><symbol id="check-circle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="exclamation-triangle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><header><nav class="navbar navbar-expand-md sticky-top bg-light border-bottom"><div class=container-fluid><a class=navbar-brand href=/Hilbish><img src=/Hilbish/hilbish-logo-and-text.png alt height=48></a>
|
||||
<button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
|
||||
<span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/readline-move/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><main><div class="container mt-2"><h1>v2.1 Release</h1><img src='https://avatars1.githubusercontent.com/u/38820196?s=460&u=b9f4efb2375bae6cb30656d790c6e0a2939327c0&v=4' width=48 style=border-radius:100%>
|
||||
<em class=text-muted>by <strong>sammyette</strong><time> // February 7, 2023</time></em><div class=my-4><blockquote><p>The release with full changelogs and prebuilt binaries can be
|
||||
seen at the <a href=https://github.com/Rosettea/Hilbish/releases/tag/v2.1.0 target=_blank rel=noopener>v2.1.0</a>
|
||||
tag.</p></blockquote><p>Oh look! A new release of Hilbish! This time is the v2.1 release,
|
||||
with a small amount of features and mainly documentation changes and
|
||||
bug fixes.</p><h2 id=documentation class=heading>Documentation
|
||||
<a href=#documentation class=heading-link><i class="fas fa-paperclip"></i></a></h2><p>There have been a few documentation enhancements for this release.
|
||||
This includes:</p><ul><li>Adding the return types for all functions that need them</li><li>Documenting Hilbish types like job objects and timers properly.
|
||||
They now have a separate heading and listing of properties and methods.</li><li>Fixing outdated documentation</li></ul><h2 id=features class=heading>Features
|
||||
<a href=#features class=heading-link><i class="fas fa-paperclip"></i></a></h2><h3 id=sinks class=heading>Sinks
|
||||
<a href=#sinks class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>A major addition is the new “sink” type for commanders to write
|
||||
their output to. This was the solution to pipes and other shell
|
||||
operators not working with builtins. If you wrote a commander
|
||||
and made it <code>print</code>, use <code>sinks.out:write</code> instead.</p><p>This is also documented at the <a href=./docs/api/commander>commander docs</a>
|
||||
.</p><h3 id=doc-command class=heading><code>doc</code> command
|
||||
<a href=#doc-command class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>Since API documentation has been moved to an API folder and also includes
|
||||
interfaces, a change has been made to get the module name from the
|
||||
passed from the requested page. This means that
|
||||
<code>doc api hilbish hilbish.jobs</code> is now shortened to <code>doc api hilbish.jobs</code></p><h2 id=bug-fixes class=heading>Bug Fixes
|
||||
<a href=#bug-fixes class=heading-link><i class="fas fa-paperclip"></i></a></h2><p>Small release, small amount of bug fixes. Even though, this is the main
|
||||
part of this release.</p><h3 id=completions-and-symlinks class=heading>Completions and Symlinks
|
||||
<a href=#completions-and-symlinks class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>Previously Hilbish completions did not work with symlinks properly.
|
||||
This can be tested in the previous 2.0 release by attempting to
|
||||
path complete to <code>/bin</code>. Since this is (or can be?) a symlink to
|
||||
<code>/usr/bin</code>, it was not marked as a directory and therefore did not
|
||||
automatically add the ending slash. This has been fixed.</p><h3 id=segfaults class=heading>Segfaults
|
||||
<a href=#segfaults class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>I found that when I updated my terminal of choice (<a href=https://github.com/endaaman/tym target=_blank rel=noopener>Tym</a>
|
||||
) for the new
|
||||
daemon feature, Hilbish would sometimes segfault on startup. This is due
|
||||
to it getting a resize event on startup while <code>bait</code> was not initialized
|
||||
yet.</p><h3 id=api-fixes class=heading>API Fixes
|
||||
<a href=#api-fixes class=heading-link><i class="fas fa-paperclip"></i></a></h3><ul><li>The <code>hilbish.which</code> function works with aliases.</li><li><code>hilbish.completion.files</code> and <code>hilbish.completion.bins</code> will no longer
|
||||
cause a panic with all empty arguments passed.</li></ul><h2 id=next-release class=heading>Next Release
|
||||
<a href=#next-release class=heading-link><i class="fas fa-paperclip"></i></a></h2><p>Stay tuned for the v2.2 release, which will have a bigger set of features
|
||||
and maybe some more bug fixes!</p></div></div></main><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea © 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>
|
||||
26
versions/readline-move/blog/v2.1.1-release/index.html
Normal file
26
versions/readline-move/blog/v2.1.1-release/index.html
Normal file
@ -0,0 +1,26 @@
|
||||
<!doctype html><html><head><title>v2.1.1 Release — Hilbish</title><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><meta name=theme-color content="#ff89dd"><meta content="/Hilbish/hilbish-flower.png" property="og:image"><meta property="og:site_name" content="Hilbish"><meta content="v2.1.1 Release — Hilbish" property="og:title"><meta content="The release with full changelogs and prebuilt binaries can be seen at the v2.1.1 tag.
|
||||
Welcome to a fresh new release of Hilbish! Some people (or none) may be awaiting the long coming v2.2 release with lots of features, but I needed to push out this little bug fix (wink) release.
|
||||
Bug Fixes Validation checks for command input When running this version, you may have noticed an odd message that sometimes comes up when running commands." property="og:description"><meta content="The release with full changelogs and prebuilt binaries can be seen at the v2.1.1 tag.
|
||||
Welcome to a fresh new release of Hilbish! Some people (or none) may be awaiting the long coming v2.2 release with lots of features, but I needed to push out this little bug fix (wink) release.
|
||||
Bug Fixes Validation checks for command input When running this version, you may have noticed an odd message that sometimes comes up when running commands." name=description><meta name=revisit-after content="2 days"><meta name=keywords content="Lua,Hilbish,Linux,Shell"><meta property="og:locale" content="en_GB"><link rel=canonical href=https://rosettea.github.io/Hilbish/><meta property="og:url" content="https://rosettea.github.io/Hilbish/"><link href=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css rel=stylesheet integrity=sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor crossorigin=anonymous><script src=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js integrity=sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2 crossorigin=anonymous></script>
|
||||
<link rel=stylesheet href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" crossorigin=anonymous referrerpolicy=no-referrer><link rel=stylesheet href=/Hilbish/versions/readline-move/css/syntax.min.eb77978873f3b324603120b558a36c98ad57d6ee7b77928e3bc131bd76c5935a.css integrity="sha256-63eXiHPzsyRgMSC1WKNsmK1X1u57d5KOO8ExvXbFk1o="></link><style>.heading>.heading-link{opacity:0}.heading:hover>.heading-link{visibility:visible;opacity:1;transition:all .1s ease-in}@keyframes highlight{0%{background:0 0}50%{background:#fff2cf}100%{background:0 0}}div:target{animation:highlight 1.2s;animation-timing-function:cubic-bezier(1,-.02,.45,.89)}table{border-width:1px;border-style:solid;border-color:#565c64;border-collapse:collapse;margin-bottom:12px}table td{padding:5px}table tr{border-width:1px}thead{display:none}</style></head><body class="d-flex flex-column min-vh-100" style=overflow-x:hidden><svg xmlns="http://www.w3.org/2000/svg" style="display:none"><symbol id="check-circle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="exclamation-triangle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><header><nav class="navbar navbar-expand-md sticky-top bg-light border-bottom"><div class=container-fluid><a class=navbar-brand href=/Hilbish><img src=/Hilbish/hilbish-logo-and-text.png alt height=48></a>
|
||||
<button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
|
||||
<span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/readline-move/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><main><div class="container mt-2"><h1>v2.1.1 Release</h1><img src='https://avatars1.githubusercontent.com/u/38820196?s=460&u=b9f4efb2375bae6cb30656d790c6e0a2939327c0&v=4' width=48 style=border-radius:100%>
|
||||
<em class=text-muted>by <strong>sammyette</strong><time> // April 1, 2023</time></em><div class=my-4><blockquote><p>The release with full changelogs and prebuilt binaries can be
|
||||
seen at the <a href=https://github.com/Rosettea/Hilbish/releases/tag/v2.1.1 target=_blank rel=noopener>v2.1.1</a>
|
||||
tag.</p></blockquote><p>Welcome to a fresh new release of Hilbish! Some people (or none) may be awaiting
|
||||
the long coming v2.2 release with lots of features, but I <em>needed</em> to push
|
||||
out this little bug fix (wink) release.</p><h2 id=bug-fixes class=heading>Bug Fixes
|
||||
<a href=#bug-fixes class=heading-link><i class="fas fa-paperclip"></i></a></h2><h3 id=validation-checks-for-command-input class=heading>Validation checks for command input
|
||||
<a href=#validation-checks-for-command-input class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>When running this version, you may have noticed an odd message that sometimes
|
||||
comes up when running commands. This is from the new TMOLI42SH
|
||||
(The Meaning of Life is 42 String Hash) input validation scheme.</p><h3 id=improved-runtime-code class=heading>Improved runtime code
|
||||
<a href=#improved-runtime-code class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>Commands now have a chance of taking exactly 2-3s <del>more</del> less time of running due to
|
||||
improvements in the code for shell runners!!!!!</p><h3 id=validate-lua-code class=heading>Validate lua code
|
||||
<a href=#validate-lua-code class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>Hilbish already threw an error when Lua code was not valid in syntax, but there was the
|
||||
need for an extra validation scheme (called OpTTCLC - Opinion based Turing Test to Check Lua Code)
|
||||
which results in less time wasted running invalid and TERRIBLE Lua code.</p><h2 id=features class=heading>Features
|
||||
<a href=#features class=heading-link><i class="fas fa-paperclip"></i></a></h2><p>There is only 1 new feature in this glorious release.</p><h3 id=fix-your-mistakes-for-the-future class=heading>Fix your mistakes for the future
|
||||
<a href=#fix-your-mistakes-for-the-future class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>If you run a command that does not exist, Hilbish will say goodbye.</p><h2 id=closing class=heading>Closing
|
||||
<a href=#closing class=heading-link><i class="fas fa-paperclip"></i></a></h2><p>Hope you enjoy this new release! It took a lot of effort to create this new version
|
||||
while I was busy doing completely nothing. :)))</p></div></div></main><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea © 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>
|
||||
13
versions/readline-move/blog/v2.1.2-release/index.html
Normal file
13
versions/readline-move/blog/v2.1.2-release/index.html
Normal file
@ -0,0 +1,13 @@
|
||||
<!doctype html><html><head><title>v2.1.2 Release — Hilbish</title><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><meta name=theme-color content="#ff89dd"><meta content="/Hilbish/hilbish-flower.png" property="og:image"><meta property="og:site_name" content="Hilbish"><meta content="v2.1.2 Release — Hilbish" property="og:title"><meta content="The release with full changelogs and prebuilt binaries can be seen at the v2.1.2 tag.
|
||||
This release reverts the April Fool’s code additions in v2.1.1. It is functionally equal to v2.1.0. Nice!
|
||||
A real release will come possibly in a few days or next week, so stay tuned for the good and feature-filled release of v2.2!" property="og:description"><meta content="The release with full changelogs and prebuilt binaries can be seen at the v2.1.2 tag.
|
||||
This release reverts the April Fool’s code additions in v2.1.1. It is functionally equal to v2.1.0. Nice!
|
||||
A real release will come possibly in a few days or next week, so stay tuned for the good and feature-filled release of v2.2!" name=description><meta name=revisit-after content="2 days"><meta name=keywords content="Lua,Hilbish,Linux,Shell"><meta property="og:locale" content="en_GB"><link rel=canonical href=https://rosettea.github.io/Hilbish/><meta property="og:url" content="https://rosettea.github.io/Hilbish/"><link href=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css rel=stylesheet integrity=sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor crossorigin=anonymous><script src=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js integrity=sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2 crossorigin=anonymous></script>
|
||||
<link rel=stylesheet href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" crossorigin=anonymous referrerpolicy=no-referrer><link rel=stylesheet href=/Hilbish/versions/readline-move/css/syntax.min.eb77978873f3b324603120b558a36c98ad57d6ee7b77928e3bc131bd76c5935a.css integrity="sha256-63eXiHPzsyRgMSC1WKNsmK1X1u57d5KOO8ExvXbFk1o="></link><style>.heading>.heading-link{opacity:0}.heading:hover>.heading-link{visibility:visible;opacity:1;transition:all .1s ease-in}@keyframes highlight{0%{background:0 0}50%{background:#fff2cf}100%{background:0 0}}div:target{animation:highlight 1.2s;animation-timing-function:cubic-bezier(1,-.02,.45,.89)}table{border-width:1px;border-style:solid;border-color:#565c64;border-collapse:collapse;margin-bottom:12px}table td{padding:5px}table tr{border-width:1px}thead{display:none}</style></head><body class="d-flex flex-column min-vh-100" style=overflow-x:hidden><svg xmlns="http://www.w3.org/2000/svg" style="display:none"><symbol id="check-circle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="exclamation-triangle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><header><nav class="navbar navbar-expand-md sticky-top bg-light border-bottom"><div class=container-fluid><a class=navbar-brand href=/Hilbish><img src=/Hilbish/hilbish-logo-and-text.png alt height=48></a>
|
||||
<button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
|
||||
<span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/readline-move/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><main><div class="container mt-2"><h1>v2.1.2 Release</h1><img src='https://avatars1.githubusercontent.com/u/38820196?s=460&u=b9f4efb2375bae6cb30656d790c6e0a2939327c0&v=4' width=48 style=border-radius:100%>
|
||||
<em class=text-muted>by <strong>sammyette</strong><time> // April 10, 2023</time></em><div class=my-4><blockquote><p>The release with full changelogs and prebuilt binaries can be
|
||||
seen at the <a href=https://github.com/Rosettea/Hilbish/releases/tag/v2.1.2 target=_blank rel=noopener>v2.1.2</a>
|
||||
tag.</p></blockquote><p>This release reverts the April Fool’s code additions in v2.1.1. It is
|
||||
functionally equal to v2.1.0. Nice!</p><p>A real release will come possibly in a few days or next week, so stay tuned for
|
||||
the good and feature-filled release of v2.2!</p></div></div></main><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea © 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>
|
||||
48
versions/readline-move/blog/v2.2-release/index.html
Normal file
48
versions/readline-move/blog/v2.2-release/index.html
Normal file
@ -0,0 +1,48 @@
|
||||
<!doctype html><html><head><title>v2.2 Release — Hilbish</title><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><meta name=theme-color content="#ff89dd"><meta content="/Hilbish/hilbish-flower.png" property="og:image"><meta property="og:site_name" content="Hilbish"><meta content="v2.2 Release — Hilbish" property="og:title"><meta content="The release with full changelogs and prebuilt binaries can be seen at the v2.2.0 tag.
|
||||
Welcome to a very long awaited release of Hilbish, and on Christmas. Just think of it as a long preparing, late Christmas gift. :) This release does not contain a whole lot of changes, but it is a new release with enhancements and bug fixes!
|
||||
Documentation As is a trend, the documentation has been improved by ONE HUNDRED TIMES." property="og:description"><meta content="The release with full changelogs and prebuilt binaries can be seen at the v2.2.0 tag.
|
||||
Welcome to a very long awaited release of Hilbish, and on Christmas. Just think of it as a long preparing, late Christmas gift. :) This release does not contain a whole lot of changes, but it is a new release with enhancements and bug fixes!
|
||||
Documentation As is a trend, the documentation has been improved by ONE HUNDRED TIMES." name=description><meta name=revisit-after content="2 days"><meta name=keywords content="Lua,Hilbish,Linux,Shell"><meta property="og:locale" content="en_GB"><link rel=canonical href=https://rosettea.github.io/Hilbish/><meta property="og:url" content="https://rosettea.github.io/Hilbish/"><link href=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css rel=stylesheet integrity=sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor crossorigin=anonymous><script src=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js integrity=sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2 crossorigin=anonymous></script>
|
||||
<link rel=stylesheet href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" crossorigin=anonymous referrerpolicy=no-referrer><link rel=stylesheet href=/Hilbish/versions/readline-move/css/syntax.min.eb77978873f3b324603120b558a36c98ad57d6ee7b77928e3bc131bd76c5935a.css integrity="sha256-63eXiHPzsyRgMSC1WKNsmK1X1u57d5KOO8ExvXbFk1o="></link><style>.heading>.heading-link{opacity:0}.heading:hover>.heading-link{visibility:visible;opacity:1;transition:all .1s ease-in}@keyframes highlight{0%{background:0 0}50%{background:#fff2cf}100%{background:0 0}}div:target{animation:highlight 1.2s;animation-timing-function:cubic-bezier(1,-.02,.45,.89)}table{border-width:1px;border-style:solid;border-color:#565c64;border-collapse:collapse;margin-bottom:12px}table td{padding:5px}table tr{border-width:1px}thead{display:none}</style></head><body class="d-flex flex-column min-vh-100" style=overflow-x:hidden><svg xmlns="http://www.w3.org/2000/svg" style="display:none"><symbol id="check-circle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="exclamation-triangle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><header><nav class="navbar navbar-expand-md sticky-top bg-light border-bottom"><div class=container-fluid><a class=navbar-brand href=/Hilbish><img src=/Hilbish/hilbish-logo-and-text.png alt height=48></a>
|
||||
<button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
|
||||
<span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/readline-move/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><main><div class="container mt-2"><h1>v2.2 Release</h1><img src='https://avatars1.githubusercontent.com/u/38820196?s=460&u=b9f4efb2375bae6cb30656d790c6e0a2939327c0&v=4' width=48 style=border-radius:100%>
|
||||
<em class=text-muted>by <strong>sammyette</strong><time> // December 25, 2023</time></em><div class=my-4><blockquote><p>The release with full changelogs and prebuilt binaries can be
|
||||
seen at the <a href=https://github.com/Rosettea/Hilbish/releases/tag/v2.2.0 target=_blank rel=noopener>v2.2.0</a>
|
||||
tag.</p></blockquote><p>Welcome to a very long awaited release of Hilbish, and on Christmas. Just think
|
||||
of it as a long preparing, late Christmas gift. :)
|
||||
This release does not contain a whole lot of changes, but it is a new
|
||||
release with enhancements and bug fixes!</p><h2 id=documentation class=heading>Documentation
|
||||
<a href=#documentation class=heading-link><i class="fas fa-paperclip"></i></a></h2><p>As is a trend, the documentation has been improved by ONE HUNDRED TIMES.
|
||||
Okay, not quite, but they’ve definitely been given an uplift.
|
||||
Everything has been rewritten, new documentation has been added to both
|
||||
the website and the local docs accessible with the <code>doc</code> command.
|
||||
Both the website and local docs are now in sync with each other.</p><p>This means that the <code>doc</code> command has also been improved to consolidate
|
||||
the documentation changes. It looks a lot better, has pagination, etc!</p><p>Speaking of pagination…</p><h2 id=features class=heading>Features
|
||||
<a href=#features class=heading-link><i class="fas fa-paperclip"></i></a></h2><h3 id=greenhouse class=heading>Greenhouse
|
||||
<a href=#greenhouse class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>The first new added feature is the Greenhouse pager! It is a library and
|
||||
command accessible via <code>greenhouse</code>. It will have better integration with
|
||||
Hilbish things, like notifications and can be used as a base for displaying
|
||||
multi-line text output instead of paging to less. The usage of Greenhouse is
|
||||
more efficient and better in Hibish!</p><h3 id=notifications class=heading>Notifications
|
||||
<a href=#notifications class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>Wait… notifications? Yes! All new in the 2.2 release is a generic notification
|
||||
interface for things in Hilbish to alert the user of things going on. Stuff like
|
||||
background jobs finishing, simple alarms, <em>actual messages</em>, whatever you like.</p><h3 id=fuzzy-searching class=heading>Fuzzy Searching
|
||||
<a href=#fuzzy-searching class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>Users can now use fuzzy search for command history and completion search.
|
||||
Enable it with <code>hilbish.opts.fuzzy = true</code>!</p><h4 id=smaller-enhancements class=heading>Smaller Enhancements
|
||||
<a href=#smaller-enhancements class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Did you know of the <code>cdr</code> command? I personally don’t use it, but I’ve made
|
||||
it look slightly better for ease of use. That simple change is adding the indexes
|
||||
next to the directory so you’ll know to type <code>cdr 2</code>.</p><p>Users can now add aliases with numbered substitutions. In shell script,
|
||||
some people have to make functions for certain things that are actually
|
||||
just aliases. A simple example: <code>nix run nixpkgs#package</code> cannot be aliased
|
||||
because if it was aliased to something like <code>run</code> normally there would be a space after.</p><p>Simple fix:</p><div class=highlight><pre tabindex=0 class=chroma><code class=language-lua data-lang=lua><span class=line><span class=ln>1</span><span class=cl><span class=n>hilbish.alias</span><span class=p>(</span><span class=s1>'run'</span><span class=p>,</span> <span class=s1>'nix run nixpkgs#%1'</span><span class=p>)</span>
|
||||
</span></span></code></pre></div><p>Rejoice!</p><h2 id=bug-fixes class=heading>Bug Fixes
|
||||
<a href=#bug-fixes class=heading-link><i class="fas fa-paperclip"></i></a></h2><p>There are a small amount of bug fixes but they’re still fixes!</p><p>In some cases Hilbish will panic if:</p><ul><li>Alias resolution results in something empty</li><li>A user does not return a table in a runner functions
|
||||
These are both fixed.</li></ul><p>An infinite loop has been patched out if someone navigates without
|
||||
having any prior history. Imagine pressing the up key on a fresh Hilbish
|
||||
install and you shell no longer working… that’s gone now.</p><p>Something else that’s gone… is still Windows support, but I added a fix
|
||||
which will make file completion work now. Job management commands work as
|
||||
well now too due to an oversight when changing up the job functions.</p><h2 id=towards-v23 class=heading>Towards v2.3
|
||||
<a href=#towards-v23 class=heading-link><i class="fas fa-paperclip"></i></a></h2><p>For the next release, I’m hoping that it won’t take as long to deliver on
|
||||
what is realistically a small amount of changes. So v2.3 will be coming
|
||||
in a short time with some good changes, promise! See you in the
|
||||
next blog post.</p></div></div></main><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea © 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>
|
||||
34
versions/readline-move/blog/v2.3-release/index.html
Normal file
34
versions/readline-move/blog/v2.3-release/index.html
Normal file
@ -0,0 +1,34 @@
|
||||
<!doctype html><html><head><title>v2.3 Release — Hilbish</title><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><meta name=theme-color content="#ff89dd"><meta content="/Hilbish/hilbish-flower.png" property="og:image"><meta property="og:site_name" content="Hilbish"><meta content="v2.3 Release — Hilbish" property="og:title"><meta content="The release with full changelogs and prebuilt binaries can be seen at the v2.3.0 tag.
|
||||
Hilbish v2.3 has now been released! This is small feature and bug fix release which took a while to cme ut since I took a long break from programming in general. The next release will be great, so stay tuned for that.
|
||||
Features Pipes (via Lua) Commands can now be piped to each other via the Lua API with the hilbish." property="og:description"><meta content="The release with full changelogs and prebuilt binaries can be seen at the v2.3.0 tag.
|
||||
Hilbish v2.3 has now been released! This is small feature and bug fix release which took a while to cme ut since I took a long break from programming in general. The next release will be great, so stay tuned for that.
|
||||
Features Pipes (via Lua) Commands can now be piped to each other via the Lua API with the hilbish." name=description><meta name=revisit-after content="2 days"><meta name=keywords content="Lua,Hilbish,Linux,Shell"><meta property="og:locale" content="en_GB"><link rel=canonical href=https://rosettea.github.io/Hilbish/><meta property="og:url" content="https://rosettea.github.io/Hilbish/"><link href=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css rel=stylesheet integrity=sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor crossorigin=anonymous><script src=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js integrity=sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2 crossorigin=anonymous></script>
|
||||
<link rel=stylesheet href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" crossorigin=anonymous referrerpolicy=no-referrer><link rel=stylesheet href=/Hilbish/versions/readline-move/css/syntax.min.eb77978873f3b324603120b558a36c98ad57d6ee7b77928e3bc131bd76c5935a.css integrity="sha256-63eXiHPzsyRgMSC1WKNsmK1X1u57d5KOO8ExvXbFk1o="></link><style>.heading>.heading-link{opacity:0}.heading:hover>.heading-link{visibility:visible;opacity:1;transition:all .1s ease-in}@keyframes highlight{0%{background:0 0}50%{background:#fff2cf}100%{background:0 0}}div:target{animation:highlight 1.2s;animation-timing-function:cubic-bezier(1,-.02,.45,.89)}table{border-width:1px;border-style:solid;border-color:#565c64;border-collapse:collapse;margin-bottom:12px}table td{padding:5px}table tr{border-width:1px}thead{display:none}</style></head><body class="d-flex flex-column min-vh-100" style=overflow-x:hidden><svg xmlns="http://www.w3.org/2000/svg" style="display:none"><symbol id="check-circle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="exclamation-triangle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><header><nav class="navbar navbar-expand-md sticky-top bg-light border-bottom"><div class=container-fluid><a class=navbar-brand href=/Hilbish><img src=/Hilbish/hilbish-logo-and-text.png alt height=48></a>
|
||||
<button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
|
||||
<span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/readline-move/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><main><div class="container mt-2"><h1>v2.3 Release</h1><img src='https://avatars1.githubusercontent.com/u/38820196?s=460&u=b9f4efb2375bae6cb30656d790c6e0a2939327c0&v=4' width=48 style=border-radius:100%>
|
||||
<em class=text-muted>by <strong>sammyette</strong><time> // July 20, 2024</time></em><div class=my-4><blockquote><p>The release with full changelogs and prebuilt binaries can be
|
||||
seen at the <a href=https://github.com/Rosettea/Hilbish/releases/tag/v2.3.0 target=_blank rel=noopener>v2.3.0</a>
|
||||
tag.</p></blockquote><p>Hilbish v2.3 has now been released! This is small feature and bug fix release
|
||||
which took a while to cme ut since I took a long break from programming in general.
|
||||
The next release will be great, so stay tuned for that.</p><h2 id=features class=heading>Features
|
||||
<a href=#features class=heading-link><i class="fas fa-paperclip"></i></a></h2><h3 id=pipes-via-lua class=heading>Pipes (via Lua)
|
||||
<a href=#pipes-via-lua class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>Commands can now be piped to each other via the Lua API with the <code>hilbish.run</code>
|
||||
function and an <code>fs.pipe</code>.</p><p>Here is a minimal example of the new usage which allows users to now pipe commands
|
||||
directly via Lua functions:</p><div class=highlight><pre tabindex=0 class=chroma><code class=language-lua data-lang=lua><span class=line><span class=ln> 1</span><span class=cl><span class=kd>local</span> <span class=n>fs</span> <span class=o>=</span> <span class=n>require</span> <span class=s1>'fs'</span>
|
||||
</span></span><span class=line><span class=ln> 2</span><span class=cl><span class=kd>local</span> <span class=n>pr</span><span class=p>,</span> <span class=n>pw</span> <span class=o>=</span> <span class=n>fs.pipe</span><span class=p>()</span>
|
||||
</span></span><span class=line><span class=ln> 3</span><span class=cl><span class=n>hilbish.run</span><span class=p>(</span><span class=s1>'ls -l'</span><span class=p>,</span> <span class=p>{</span>
|
||||
</span></span><span class=line><span class=ln> 4</span><span class=cl> <span class=n>stdout</span> <span class=o>=</span> <span class=n>pw</span><span class=p>,</span>
|
||||
</span></span><span class=line><span class=ln> 5</span><span class=cl> <span class=n>stderr</span> <span class=o>=</span> <span class=n>pw</span><span class=p>,</span>
|
||||
</span></span><span class=line><span class=ln> 6</span><span class=cl><span class=p>})</span>
|
||||
</span></span><span class=line><span class=ln> 7</span><span class=cl>
|
||||
</span></span><span class=line><span class=ln> 8</span><span class=cl><span class=n>pw</span><span class=p>:</span><span class=n>close</span><span class=p>()</span>
|
||||
</span></span><span class=line><span class=ln> 9</span><span class=cl>
|
||||
</span></span><span class=line><span class=ln>10</span><span class=cl><span class=n>hilbish.run</span><span class=p>(</span><span class=s1>'wc -l'</span><span class=p>,</span> <span class=p>{</span>
|
||||
</span></span><span class=line><span class=ln>11</span><span class=cl> <span class=n>stdin</span> <span class=o>=</span> <span class=n>pr</span>
|
||||
</span></span><span class=line><span class=ln>12</span><span class=cl><span class=p>})</span>
|
||||
</span></span></code></pre></div><p>This also means it’s easier to make commands output to any stream output,
|
||||
including in commanders.</p><h2 id=bug-fixes class=heading>Bug Fixes
|
||||
<a href=#bug-fixes class=heading-link><i class="fas fa-paperclip"></i></a></h2><ul><li>Commanders can now be cancelled with Ctrl-C, which means if they froze for some reason
|
||||
they can now be exited.</li><li>The shell script interpreter now keeps its environment, and this also fixes the
|
||||
current working directory being wrong with some commands.</li><li>Some greenhouse bugs have been fixed, like randomly appearing when resizing the terminal
|
||||
and some text attributes like color appearing where they weren’t supposed to.</li></ul></div></div></main><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea © 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>
|
||||
6
versions/readline-move/blog/welcome/index.html
Normal file
6
versions/readline-move/blog/welcome/index.html
Normal file
@ -0,0 +1,6 @@
|
||||
<!doctype html><html><head><title>Welcome to the Hilbish blog — Hilbish</title><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><meta name=theme-color content="#ff89dd"><meta content="/Hilbish/hilbish-flower.png" property="og:image"><meta property="og:site_name" content="Hilbish"><meta content="Welcome to the Hilbish blog — Hilbish" property="og:title"><meta content="Hello! Welcome to the Hilbish blog. This will mainly contain release announcements and some other things relating to Hilbish (development)." property="og:description"><meta content="Hello! Welcome to the Hilbish blog. This will mainly contain release announcements and some other things relating to Hilbish (development)." name=description><meta name=revisit-after content="2 days"><meta name=keywords content="Lua,Hilbish,Linux,Shell"><meta property="og:locale" content="en_GB"><link rel=canonical href=https://rosettea.github.io/Hilbish/><meta property="og:url" content="https://rosettea.github.io/Hilbish/"><link href=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css rel=stylesheet integrity=sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor crossorigin=anonymous><script src=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js integrity=sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2 crossorigin=anonymous></script>
|
||||
<link rel=stylesheet href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" crossorigin=anonymous referrerpolicy=no-referrer><link rel=stylesheet href=/Hilbish/versions/readline-move/css/syntax.min.eb77978873f3b324603120b558a36c98ad57d6ee7b77928e3bc131bd76c5935a.css integrity="sha256-63eXiHPzsyRgMSC1WKNsmK1X1u57d5KOO8ExvXbFk1o="></link><style>.heading>.heading-link{opacity:0}.heading:hover>.heading-link{visibility:visible;opacity:1;transition:all .1s ease-in}@keyframes highlight{0%{background:0 0}50%{background:#fff2cf}100%{background:0 0}}div:target{animation:highlight 1.2s;animation-timing-function:cubic-bezier(1,-.02,.45,.89)}table{border-width:1px;border-style:solid;border-color:#565c64;border-collapse:collapse;margin-bottom:12px}table td{padding:5px}table tr{border-width:1px}thead{display:none}</style></head><body class="d-flex flex-column min-vh-100" style=overflow-x:hidden><svg xmlns="http://www.w3.org/2000/svg" style="display:none"><symbol id="check-circle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="exclamation-triangle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><header><nav class="navbar navbar-expand-md sticky-top bg-light border-bottom"><div class=container-fluid><a class=navbar-brand href=/Hilbish><img src=/Hilbish/hilbish-logo-and-text.png alt height=48></a>
|
||||
<button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
|
||||
<span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/readline-move/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><main><div class="container mt-2"><h1>Welcome to the Hilbish blog</h1><img src='https://avatars1.githubusercontent.com/u/38820196?s=460&u=b9f4efb2375bae6cb30656d790c6e0a2939327c0&v=4' width=48 style=border-radius:100%>
|
||||
<em class=text-muted>by <strong>sammyette</strong></em><div class=my-4><p>Hello! Welcome to the Hilbish blog. This will mainly contain release
|
||||
announcements and some other things relating to Hilbish (development).</p></div></div></main><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea © 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>
|
||||
19
versions/readline-move/categories/index.html
Normal file
19
versions/readline-move/categories/index.html
Normal file
@ -0,0 +1,19 @@
|
||||
<!doctype html><html><head><title>Categories — Hilbish</title><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><meta name=theme-color content="#ff89dd"><meta content="/Hilbish/hilbish-flower.png" property="og:image"><meta property="og:site_name" content="Hilbish"><meta content="Categories — Hilbish" property="og:title"><meta content property="og:description"><meta content name=description><meta name=revisit-after content="2 days"><meta name=keywords content="Lua,Hilbish,Linux,Shell"><meta property="og:locale" content="en_GB"><link rel=canonical href=https://rosettea.github.io/Hilbish/><meta property="og:url" content="https://rosettea.github.io/Hilbish/"><link href=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css rel=stylesheet integrity=sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor crossorigin=anonymous><script src=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js integrity=sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2 crossorigin=anonymous></script>
|
||||
<link rel=stylesheet href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" crossorigin=anonymous referrerpolicy=no-referrer><link rel=stylesheet href=/Hilbish/versions/readline-move/css/syntax.min.eb77978873f3b324603120b558a36c98ad57d6ee7b77928e3bc131bd76c5935a.css integrity="sha256-63eXiHPzsyRgMSC1WKNsmK1X1u57d5KOO8ExvXbFk1o="></link><style>.heading>.heading-link{opacity:0}.heading:hover>.heading-link{visibility:visible;opacity:1;transition:all .1s ease-in}@keyframes highlight{0%{background:0 0}50%{background:#fff2cf}100%{background:0 0}}div:target{animation:highlight 1.2s;animation-timing-function:cubic-bezier(1,-.02,.45,.89)}table{border-width:1px;border-style:solid;border-color:#565c64;border-collapse:collapse;margin-bottom:12px}table td{padding:5px}table tr{border-width:1px}thead{display:none}</style></head><body class="d-flex flex-column min-vh-100" style=overflow-x:hidden><svg xmlns="http://www.w3.org/2000/svg" style="display:none"><symbol id="check-circle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="exclamation-triangle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><header><nav class="navbar navbar-expand-md sticky-top bg-light border-bottom"><div class=container-fluid><a class=navbar-brand href=/Hilbish><img src=/Hilbish/hilbish-logo-and-text.png alt height=48></a>
|
||||
<button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
|
||||
<span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/readline-move/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><main class="mt-4 mb-4"><div class="row row-cols-1 row-cols-md-1 g-4"><div class="col d-flex justify-content-center"><div class=card style=width:56rem><div class=card-body><a href=https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.3-release/><h5 class=card-title>v2.3 Release</h5></a><h6 class='card-subtitle text-muted mb-2'><time>July 20, 2024</time></h6><p class=card-text>The release with full changelogs and prebuilt binaries can be seen at the v2.3.0 tag.
|
||||
Hilbish v2.3 has now been released! This is small feature and bug fix release which took a while to cme ut since I took a long break from programming in general. The next release will be great, so stay tuned for that.
|
||||
Features Pipes (via Lua) Commands can now be piped to each other via the Lua API with the hilbish.</p></div></div></div><div class="col d-flex justify-content-center"><div class=card style=width:56rem><div class=card-body><a href=https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.2-release/><h5 class=card-title>v2.2 Release</h5></a><h6 class='card-subtitle text-muted mb-2'><time>December 25, 2023</time></h6><p class=card-text>The release with full changelogs and prebuilt binaries can be seen at the v2.2.0 tag.
|
||||
Welcome to a very long awaited release of Hilbish, and on Christmas. Just think of it as a long preparing, late Christmas gift. :) This release does not contain a whole lot of changes, but it is a new release with enhancements and bug fixes!
|
||||
Documentation As is a trend, the documentation has been improved by ONE HUNDRED TIMES.</p></div></div></div><div class="col d-flex justify-content-center"><div class=card style=width:56rem><div class=card-body><a href=https://rosettea.github.io/Hilbish/versions/readline-move/blog/improving-this-website/><h5 class=card-title>Improving Hilbish's Branding</h5></a><h6 class='card-subtitle text-muted mb-2'><time>April 13, 2023</time></h6><p class=card-text>Happy birthday Hilbish! As of last month, Hilbish is now 2 years old. Unfortunately I missed the official date, but I will still make a more focused post on the date (19st).
|
||||
I decided to fix up this website and Hilbish’s logo, so that can be thought of as something for the 2 years milestone?
|
||||
Logo Hilbish’s old logo was.. not that good. It definitely functioned as a logo, but the yellow part of it looked ugly (sorry old logo).</p></div></div></div><div class="col d-flex justify-content-center"><div class=card style=width:56rem><div class=card-body><a href=https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.1.2-release/><h5 class=card-title>v2.1.2 Release</h5></a><h6 class='card-subtitle text-muted mb-2'><time>April 10, 2023</time></h6><p class=card-text>The release with full changelogs and prebuilt binaries can be seen at the v2.1.2 tag.
|
||||
This release reverts the April Fool’s code additions in v2.1.1. It is functionally equal to v2.1.0. Nice!
|
||||
A real release will come possibly in a few days or next week, so stay tuned for the good and feature-filled release of v2.2!</p></div></div></div><div class="col d-flex justify-content-center"><div class=card style=width:56rem><div class=card-body><a href=https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.1.1-release/><h5 class=card-title>v2.1.1 Release</h5></a><h6 class='card-subtitle text-muted mb-2'><time>April 1, 2023</time></h6><p class=card-text>The release with full changelogs and prebuilt binaries can be seen at the v2.1.1 tag.
|
||||
Welcome to a fresh new release of Hilbish! Some people (or none) may be awaiting the long coming v2.2 release with lots of features, but I needed to push out this little bug fix (wink) release.
|
||||
Bug Fixes Validation checks for command input When running this version, you may have noticed an odd message that sometimes comes up when running commands.</p></div></div></div><div class="col d-flex justify-content-center"><div class=card style=width:56rem><div class=card-body><a href=https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.1-release/><h5 class=card-title>v2.1 Release</h5></a><h6 class='card-subtitle text-muted mb-2'><time>February 7, 2023</time></h6><p class=card-text>The release with full changelogs and prebuilt binaries can be seen at the v2.1.0 tag.
|
||||
Oh look! A new release of Hilbish! This time is the v2.1 release, with a small amount of features and mainly documentation changes and bug fixes.
|
||||
Documentation There have been a few documentation enhancements for this release. This includes:
|
||||
Adding the return types for all functions that need them Documenting Hilbish types like job objects and timers properly.</p></div></div></div><div class="col d-flex justify-content-center"><div class=card style=width:56rem><div class=card-body><a href=https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.0-release/><h5 class=card-title>Hilbish v2.0 Release</h5></a><h6 class='card-subtitle text-muted mb-2'><time>December 29, 2022</time></h6><p class=card-text>Hilbish v2.0 has been released! Well actually, it was released a week ago, but I only wrote this Hilbish blog after that.
|
||||
This is a big release, coming 9 months after the previous v1.2.0 and featuring over 40+ bug fixes and tons of new features and enhancements, so let’s see what is in this release.
|
||||
Documentation When querying about the problems people have with Hilbish, one of the issues was its poor documentation.</p></div></div></div><div class="col d-flex justify-content-center"><div class=card style=width:56rem><div class=card-body><a href=https://rosettea.github.io/Hilbish/versions/readline-move/install/><h5 class=card-title>Install</h5></a><h6 class='card-subtitle text-muted mb-2'></h6><p class=card-text>Steps on how to install Hilbish on all the OSes and distros supported.</p></div></div></div><div class="col d-flex justify-content-center"><div class=card style=width:56rem><div class=card-body><a href=https://rosettea.github.io/Hilbish/versions/readline-move/blog/welcome/><h5 class=card-title>Welcome to the Hilbish blog</h5></a><h6 class='card-subtitle text-muted mb-2'></h6><p class=card-text>Hello! Welcome to the Hilbish blog. This will mainly contain release announcements and some other things relating to Hilbish (development).</p></div></div></div></div></main><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea © 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>
|
||||
1
versions/readline-move/categories/index.xml
Normal file
1
versions/readline-move/categories/index.xml
Normal file
@ -0,0 +1 @@
|
||||
<?xml version="1.0" encoding="utf-8" standalone="yes"?><rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Categories on Hilbish</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/categories/</link><description>Recent content in Categories on Hilbish</description><generator>Hugo -- gohugo.io</generator><language>en-us</language><atom:link href="https://rosettea.github.io/Hilbish/versions/readline-move/categories/index.xml" rel="self" type="application/rss+xml"/></channel></rss>
|
||||
BIN
versions/readline-move/completion.mp4
Normal file
BIN
versions/readline-move/completion.mp4
Normal file
Binary file not shown.
@ -0,0 +1 @@
|
||||
.chroma{display:inline-block;padding:.5em}.bg{background-color:#f7f7f7}.chroma{background-color:#f7f7f7}.chroma .x{}.chroma .err{color:#a61717;background-color:#e3d2d2}.chroma .cl{}.chroma .lntd{vertical-align:top;padding:0;margin:0;border:0}.chroma .lntable{border-spacing:0;padding:0;margin:0;border:0}.chroma .hl{background-color:#f7f7f7}.chroma .lnt{white-space:pre;user-select:none;margin-right:.4em;padding:0 .4em;color:#7f7f7f}.chroma .ln{white-space:pre;user-select:none;margin-right:.4em;padding:0 .4em;color:#7f7f7f}.chroma .line{display:flex}.chroma .k{color:#080;font-weight:700}.chroma .kc{color:#080;font-weight:700}.chroma .kd{color:#080;font-weight:700}.chroma .kn{color:#080;font-weight:700}.chroma .kp{color:#080}.chroma .kr{color:#080;font-weight:700}.chroma .kt{color:#888;font-weight:700}.chroma .n{}.chroma .na{color:#369}.chroma .nb{color:#038}.chroma .bp{}.chroma .nc{color:#b06;font-weight:700}.chroma .no{color:#036;font-weight:700}.chroma .nd{color:#555}.chroma .ni{}.chroma .ne{color:#b06;font-weight:700}.chroma .nf{color:#06b;font-weight:700}.chroma .fm{}.chroma .nl{color:#369;font-style:italic}.chroma .nn{color:#b06;font-weight:700}.chroma .nx{}.chroma .py{color:#369;font-weight:700}.chroma .nt{color:#b06;font-weight:700}.chroma .nv{color:#369}.chroma .vc{color:#369}.chroma .vg{color:#d70}.chroma .vi{color:#33b}.chroma .vm{}.chroma .l{}.chroma .ld{}.chroma .s{color:#d20;background-color:#fff0f0}.chroma .sa{color:#d20;background-color:#fff0f0}.chroma .sb{color:#d20;background-color:#fff0f0}.chroma .sc{color:#d20;background-color:#fff0f0}.chroma .dl{color:#d20;background-color:#fff0f0}.chroma .sd{color:#d20;background-color:#fff0f0}.chroma .s2{color:#d20;background-color:#fff0f0}.chroma .se{color:#04d;background-color:#fff0f0}.chroma .sh{color:#d20;background-color:#fff0f0}.chroma .si{color:#33b;background-color:#fff0f0}.chroma .sx{color:#2b2;background-color:#f0fff0}.chroma .sr{color:#080;background-color:#fff0ff}.chroma .s1{color:#d20;background-color:#fff0f0}.chroma .ss{color:#a60;background-color:#fff0f0}.chroma .m{color:#00d;font-weight:700}.chroma .mb{color:#00d;font-weight:700}.chroma .mf{color:#00d;font-weight:700}.chroma .mh{color:#00d;font-weight:700}.chroma .mi{color:#00d;font-weight:700}.chroma .il{color:#00d;font-weight:700}.chroma .mo{color:#00d;font-weight:700}.chroma .o{}.chroma .ow{color:#080}.chroma .p{}.chroma .c{color:#888}.chroma .ch{color:#888}.chroma .cm{color:#888}.chroma .c1{color:#888}.chroma .cs{color:#c00;background-color:#fff0f0;font-weight:700}.chroma .cp{color:#c00;font-weight:700}.chroma .cpf{color:#c00;font-weight:700}.chroma .g{}.chroma .gd{color:#000;background-color:#fdd}.chroma .ge{font-style:italic}.chroma .gr{color:#a00}.chroma .gh{color:#333}.chroma .gi{color:#000;background-color:#dfd}.chroma .go{color:#888}.chroma .gp{color:#555}.chroma .gs{font-weight:700}.chroma .gu{color:#666}.chroma .gt{color:#a00}.chroma .gl{text-decoration:underline}.chroma .w{color:#bbb}
|
||||
BIN
versions/readline-move/default.png
Normal file
BIN
versions/readline-move/default.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 58 KiB |
48
versions/readline-move/docs/api/bait/index.html
Normal file
48
versions/readline-move/docs/api/bait/index.html
Normal file
@ -0,0 +1,48 @@
|
||||
<!doctype html><html><head><title>Module bait — Hilbish</title><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><meta name=theme-color content="#ff89dd"><meta content="/Hilbish/hilbish-flower.png" property="og:image"><meta property="og:site_name" content="Hilbish"><meta content="Module bait — Hilbish" property="og:title"><meta content="the event emitter" property="og:description"><meta content="the event emitter" name=description><meta name=revisit-after content="2 days"><meta name=keywords content="Lua,Hilbish,Linux,Shell"><meta property="og:locale" content="en_GB"><link rel=canonical href=https://rosettea.github.io/Hilbish/><meta property="og:url" content="https://rosettea.github.io/Hilbish/"><link href=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css rel=stylesheet integrity=sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor crossorigin=anonymous><script src=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js integrity=sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2 crossorigin=anonymous></script>
|
||||
<link rel=stylesheet href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" crossorigin=anonymous referrerpolicy=no-referrer><link rel=stylesheet href=/Hilbish/versions/readline-move/css/syntax.min.eb77978873f3b324603120b558a36c98ad57d6ee7b77928e3bc131bd76c5935a.css integrity="sha256-63eXiHPzsyRgMSC1WKNsmK1X1u57d5KOO8ExvXbFk1o="></link><style>.heading>.heading-link{opacity:0}.heading:hover>.heading-link{visibility:visible;opacity:1;transition:all .1s ease-in}@keyframes highlight{0%{background:0 0}50%{background:#fff2cf}100%{background:0 0}}div:target{animation:highlight 1.2s;animation-timing-function:cubic-bezier(1,-.02,.45,.89)}table{border-width:1px;border-style:solid;border-color:#565c64;border-collapse:collapse;margin-bottom:12px}table td{padding:5px}table tr{border-width:1px}thead{display:none}</style></head><body class="d-flex flex-column min-vh-100" style=overflow-x:hidden><svg xmlns="http://www.w3.org/2000/svg" style="display:none"><symbol id="check-circle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="exclamation-triangle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><header><nav class="navbar navbar-expand-md sticky-top bg-light border-bottom"><div class=container-fluid><a class=navbar-brand href=/Hilbish><img src=/Hilbish/hilbish-logo-and-text.png alt height=48></a>
|
||||
<button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
|
||||
<span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/readline-move/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><style>@media(min-width:768px){.sidenav{width:240px}}</style><div class=row><nav class="navbar-expand-md bg-light sidenav border-end"><div class=container><div class="collapse navbar-collapse" id=navbarSupportedContent><nav class="navbar navbar-expand-md bg-light sidenav col" style=margin-top:-20px><ul class="navbar-nav me-auto mb-2 mb-lg-0 flex-column col mt-4"><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link><strong>Introduction</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/getting-started/ class=nav-link><strong>Getting Started</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/faq/ class=nav-link><strong>Frequently Asked Questions</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/ class=nav-link><strong>Features</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/completions/ class=nav-link>Completions</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/notifications/ class=nav-link>Notification</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/opts/ class=nav-link>Options</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/runner-mode/ class=nav-link>Runner Mode</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/ class=nav-link><strong>Signals</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/command/ class=nav-link>Command</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/hilbish/ class=nav-link>Hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/signal/ class=nav-link>Signal</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/lunacolors/ class=nav-link><strong>Lunacolors</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/ class=nav-link><strong>Vim Mode</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/actions/ class=nav-link>Actions</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/ class=nav-link><strong>Nature</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/dirs/ class=nav-link>Module dirs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/doc/ class=nav-link>Module doc</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/ class=nav-link><strong>API</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/bait/ class=nav-link>Module bait</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/commander/ class=nav-link>Module commander</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/fs/ class=nav-link>Module fs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/ class=nav-link>Module hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.aliases/ class=nav-link>Module hilbish.aliases</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.completion/ class=nav-link>Module hilbish.completion</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.runner/ class=nav-link>Module hilbish.runner</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.userdir/ class=nav-link>Module hilbish.userDir</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/readline/ class=nav-link>Module readline</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/snail/ class=nav-link>Module snail</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/terminal/ class=nav-link>Module terminal</a></li></ul></ul></nav></div></div></nav><container class="col mt-2" style="padding-left: 20px; padding-right: 20px;"><div><h1>Module bait</h1><p><em>the event emitter<br></em></p><h3 id=introduction class=heading>Introduction
|
||||
<a href=#introduction class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>Bait is the event emitter for Hilbish. Much like Node.js and
|
||||
its <code>events</code> system, many actions in Hilbish emit events.
|
||||
Unlike Node.js, Hilbish events are global. So make sure to
|
||||
pick a unique name!</p><p>Usage of the Bait module consists of userstanding
|
||||
event-driven architecture, but it’s pretty simple:
|
||||
If you want to act on a certain event, you can <code>catch</code> it.
|
||||
You can act on events via callback functions.</p><p>Examples of this are in the Hilbish default config!
|
||||
Consider this part of it:</p><div class=highlight><pre tabindex=0 class=chroma><code class=language-lua data-lang=lua><span class=line><span class=ln>1</span><span class=cl><span class=n>bait.catch</span><span class=p>(</span><span class=s1>'command.exit'</span><span class=p>,</span> <span class=kr>function</span><span class=p>(</span><span class=n>code</span><span class=p>)</span>
|
||||
</span></span><span class=line><span class=ln>2</span><span class=cl> <span class=n>running</span> <span class=o>=</span> <span class=kc>false</span>
|
||||
</span></span><span class=line><span class=ln>3</span><span class=cl> <span class=n>doPrompt</span><span class=p>(</span><span class=n>code</span> <span class=o>~=</span> <span class=mi>0</span><span class=p>)</span>
|
||||
</span></span><span class=line><span class=ln>4</span><span class=cl> <span class=n>doNotifyPrompt</span><span class=p>()</span>
|
||||
</span></span><span class=line><span class=ln>5</span><span class=cl><span class=kr>end</span><span class=p>)</span>
|
||||
</span></span></code></pre></div><p>What this does is, whenever the <code>command.exit</code> event is thrown,
|
||||
this function will set the user prompt.</p><h3 id=functions class=heading>Functions
|
||||
<a href=#functions class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><a href=#catch>catch(name, cb)</a></td><td>Catches an event. This function can be used to act on events.</td></tr><tr><td><a href=#catchOnce>catchOnce(name, cb)</a></td><td>Catches an event, but only once. This will remove the hook immediately after it runs for the first time.</td></tr><tr><td><a href=#hooks>hooks(name) -> table</a></td><td>Returns a table of functions that are hooked on an event with the corresponding <code>name</code>.</td></tr><tr><td><a href=#release>release(name, catcher)</a></td><td>Removes the <code>catcher</code> for the event with <code>name</code>.</td></tr><tr><td><a href=#throw>throw(name, …args)</a></td><td>Throws a hook with <code>name</code> with the provided <code>args</code>.</td></tr></tbody></table><hr><div id=catch><h4 class=heading>bait.catch(name, cb)
|
||||
<a href=#catch class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Catches an event. This function can be used to act on events.</p><h5 id=parameters class=heading>Parameters
|
||||
<a href=#parameters class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>string</code> <strong><code>name</code></strong><br>The name of the hook.</p><p><code>function</code> <strong><code>cb</code></strong><br>The function that will be called when the hook is thrown.</p><h5 id=example class=heading>Example
|
||||
<a href=#example class=heading-link><i class="fas fa-paperclip"></i></a></h5><div class=highlight><pre tabindex=0 class=chroma><code class=language-lua data-lang=lua><span class=line><span class=ln>1</span><span class=cl><span class=n>bait.catch</span><span class=p>(</span><span class=s1>'hilbish.exit'</span><span class=p>,</span> <span class=kr>function</span><span class=p>()</span>
|
||||
</span></span><span class=line><span class=ln>2</span><span class=cl> <span class=n>print</span> <span class=s1>'Goodbye Hilbish!'</span>
|
||||
</span></span><span class=line><span class=ln>3</span><span class=cl><span class=kr>end</span><span class=p>)</span>
|
||||
</span></span></code></pre></div></div><hr><div id=catchOnce><h4 class=heading>bait.catchOnce(name, cb)
|
||||
<a href=#catchOnce class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Catches an event, but only once. This will remove the hook immediately after it runs for the first time.</p><h5 id=parameters-1 class=heading>Parameters
|
||||
<a href=#parameters-1 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>string</code> <strong><code>name</code></strong><br>The name of the event</p><p><code>function</code> <strong><code>cb</code></strong><br>The function that will be called when the event is thrown.</p></div><hr><div id=hooks><h4 class=heading>bait.hooks(name) -> table
|
||||
<a href=#hooks class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Returns a table of functions that are hooked on an event with the corresponding <code>name</code>.</p><h5 id=parameters-2 class=heading>Parameters
|
||||
<a href=#parameters-2 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>string</code> <strong><code>name</code></strong><br>The name of the hook</p></div><hr><div id=release><h4 class=heading>bait.release(name, catcher)
|
||||
<a href=#release class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Removes the <code>catcher</code> for the event with <code>name</code>.<br>For this to work, <code>catcher</code> has to be the same function used to catch<br>an event, like one saved to a variable.</p><h5 id=parameters-3 class=heading>Parameters
|
||||
<a href=#parameters-3 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>string</code> <strong><code>name</code></strong><br>Name of the event the hook is on</p><p><code>function</code> <strong><code>catcher</code></strong><br>Hook function to remove</p><h5 id=example-1 class=heading>Example
|
||||
<a href=#example-1 class=heading-link><i class="fas fa-paperclip"></i></a></h5><div class=highlight><pre tabindex=0 class=chroma><code class=language-lua data-lang=lua><span class=line><span class=ln>1</span><span class=cl><span class=kd>local</span> <span class=n>hookCallback</span> <span class=o>=</span> <span class=kr>function</span><span class=p>()</span> <span class=n>print</span> <span class=s1>'hi'</span> <span class=kr>end</span>
|
||||
</span></span><span class=line><span class=ln>2</span><span class=cl>
|
||||
</span></span><span class=line><span class=ln>3</span><span class=cl><span class=n>bait.catch</span><span class=p>(</span><span class=s1>'event'</span><span class=p>,</span> <span class=n>hookCallback</span><span class=p>)</span>
|
||||
</span></span><span class=line><span class=ln>4</span><span class=cl>
|
||||
</span></span><span class=line><span class=ln>5</span><span class=cl><span class=c1>-- a little while later....</span>
|
||||
</span></span><span class=line><span class=ln>6</span><span class=cl><span class=n>bait.release</span><span class=p>(</span><span class=s1>'event'</span><span class=p>,</span> <span class=n>hookCallback</span><span class=p>)</span>
|
||||
</span></span><span class=line><span class=ln>7</span><span class=cl><span class=c1>-- and now hookCallback will no longer be ran for the event.</span>
|
||||
</span></span></code></pre></div></div><hr><div id=throw><h4 class=heading>bait.throw(name, ...args)
|
||||
<a href=#throw class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Throws a hook with <code>name</code> with the provided <code>args</code>.</p><h5 id=parameters-4 class=heading>Parameters
|
||||
<a href=#parameters-4 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>string</code> <strong><code>name</code></strong><br>The name of the hook.</p><p><code>any</code> <strong><code>args</code></strong> (This type is variadic. You can pass an infinite amount of parameters with this type.)<br>The arguments to pass to the hook.</p><h5 id=example-2 class=heading>Example
|
||||
<a href=#example-2 class=heading-link><i class="fas fa-paperclip"></i></a></h5><div class=highlight><pre tabindex=0 class=chroma><code class=language-lua data-lang=lua><span class=line><span class=ln>1</span><span class=cl><span class=n>bait.throw</span><span class=p>(</span><span class=s1>'greeting'</span><span class=p>,</span> <span class=s1>'world'</span><span class=p>)</span>
|
||||
</span></span><span class=line><span class=ln>2</span><span class=cl>
|
||||
</span></span><span class=line><span class=ln>3</span><span class=cl><span class=c1>-- This can then be listened to via</span>
|
||||
</span></span><span class=line><span class=ln>4</span><span class=cl><span class=n>bait.catch</span><span class=p>(</span><span class=s1>'gretting'</span><span class=p>,</span> <span class=kr>function</span><span class=p>(</span><span class=n>greetTo</span><span class=p>)</span>
|
||||
</span></span><span class=line><span class=ln>5</span><span class=cl> <span class=n>print</span><span class=p>(</span><span class=s1>'Hello '</span> <span class=o>..</span> <span class=n>greetTo</span><span class=p>)</span>
|
||||
</span></span><span class=line><span class=ln>6</span><span class=cl><span class=kr>end</span><span class=p>)</span>
|
||||
</span></span></code></pre></div></div></div><div class="footer mt-auto"><p class="card-small text-muted">Want to help improve this page? <a href=https://github.com/Rosettea/Hilbish/issues/new/choose>Create an issue.</a></p></div></container></div><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea © 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>
|
||||
38
versions/readline-move/docs/api/commander/index.html
Normal file
38
versions/readline-move/docs/api/commander/index.html
Normal file
@ -0,0 +1,38 @@
|
||||
<!doctype html><html><head><title>Module commander — Hilbish</title><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><meta name=theme-color content="#ff89dd"><meta content="/Hilbish/hilbish-flower.png" property="og:image"><meta property="og:site_name" content="Hilbish"><meta content="Module commander — Hilbish" property="og:title"><meta content="library for custom commands" property="og:description"><meta content="library for custom commands" name=description><meta name=revisit-after content="2 days"><meta name=keywords content="Lua,Hilbish,Linux,Shell"><meta property="og:locale" content="en_GB"><link rel=canonical href=https://rosettea.github.io/Hilbish/><meta property="og:url" content="https://rosettea.github.io/Hilbish/"><link href=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css rel=stylesheet integrity=sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor crossorigin=anonymous><script src=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js integrity=sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2 crossorigin=anonymous></script>
|
||||
<link rel=stylesheet href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" crossorigin=anonymous referrerpolicy=no-referrer><link rel=stylesheet href=/Hilbish/versions/readline-move/css/syntax.min.eb77978873f3b324603120b558a36c98ad57d6ee7b77928e3bc131bd76c5935a.css integrity="sha256-63eXiHPzsyRgMSC1WKNsmK1X1u57d5KOO8ExvXbFk1o="></link><style>.heading>.heading-link{opacity:0}.heading:hover>.heading-link{visibility:visible;opacity:1;transition:all .1s ease-in}@keyframes highlight{0%{background:0 0}50%{background:#fff2cf}100%{background:0 0}}div:target{animation:highlight 1.2s;animation-timing-function:cubic-bezier(1,-.02,.45,.89)}table{border-width:1px;border-style:solid;border-color:#565c64;border-collapse:collapse;margin-bottom:12px}table td{padding:5px}table tr{border-width:1px}thead{display:none}</style></head><body class="d-flex flex-column min-vh-100" style=overflow-x:hidden><svg xmlns="http://www.w3.org/2000/svg" style="display:none"><symbol id="check-circle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="exclamation-triangle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><header><nav class="navbar navbar-expand-md sticky-top bg-light border-bottom"><div class=container-fluid><a class=navbar-brand href=/Hilbish><img src=/Hilbish/hilbish-logo-and-text.png alt height=48></a>
|
||||
<button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
|
||||
<span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/readline-move/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><style>@media(min-width:768px){.sidenav{width:240px}}</style><div class=row><nav class="navbar-expand-md bg-light sidenav border-end"><div class=container><div class="collapse navbar-collapse" id=navbarSupportedContent><nav class="navbar navbar-expand-md bg-light sidenav col" style=margin-top:-20px><ul class="navbar-nav me-auto mb-2 mb-lg-0 flex-column col mt-4"><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link><strong>Introduction</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/getting-started/ class=nav-link><strong>Getting Started</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/faq/ class=nav-link><strong>Frequently Asked Questions</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/ class=nav-link><strong>Features</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/completions/ class=nav-link>Completions</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/notifications/ class=nav-link>Notification</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/opts/ class=nav-link>Options</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/runner-mode/ class=nav-link>Runner Mode</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/ class=nav-link><strong>Signals</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/command/ class=nav-link>Command</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/hilbish/ class=nav-link>Hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/signal/ class=nav-link>Signal</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/lunacolors/ class=nav-link><strong>Lunacolors</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/ class=nav-link><strong>Vim Mode</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/actions/ class=nav-link>Actions</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/ class=nav-link><strong>Nature</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/dirs/ class=nav-link>Module dirs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/doc/ class=nav-link>Module doc</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/ class=nav-link><strong>API</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/bait/ class=nav-link>Module bait</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/commander/ class=nav-link>Module commander</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/fs/ class=nav-link>Module fs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/ class=nav-link>Module hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.aliases/ class=nav-link>Module hilbish.aliases</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.completion/ class=nav-link>Module hilbish.completion</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.runner/ class=nav-link>Module hilbish.runner</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.userdir/ class=nav-link>Module hilbish.userDir</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/readline/ class=nav-link>Module readline</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/snail/ class=nav-link>Module snail</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/terminal/ class=nav-link>Module terminal</a></li></ul></ul></nav></div></div></nav><container class="col mt-2" style="padding-left: 20px; padding-right: 20px;"><div><h1>Module commander</h1><p><em>library for custom commands<br></em></p><h3 id=introduction class=heading>Introduction
|
||||
<a href=#introduction class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>Commander is the library which handles Hilbish commands. This makes
|
||||
the user able to add Lua-written commands to their shell without making
|
||||
a separate script in a bin folder. Instead, you may simply use the Commander
|
||||
library in your Hilbish config.</p><div class=highlight><pre tabindex=0 class=chroma><code class=language-lua data-lang=lua><span class=line><span class=ln>1</span><span class=cl><span class=kd>local</span> <span class=n>commander</span> <span class=o>=</span> <span class=n>require</span> <span class=s1>'commander'</span>
|
||||
</span></span><span class=line><span class=ln>2</span><span class=cl>
|
||||
</span></span><span class=line><span class=ln>3</span><span class=cl><span class=n>commander.register</span><span class=p>(</span><span class=s1>'hello'</span><span class=p>,</span> <span class=kr>function</span><span class=p>(</span><span class=n>args</span><span class=p>,</span> <span class=n>sinks</span><span class=p>)</span>
|
||||
</span></span><span class=line><span class=ln>4</span><span class=cl> <span class=n>sinks.out</span><span class=p>:</span><span class=n>writeln</span> <span class=s1>'Hello world!'</span>
|
||||
</span></span><span class=line><span class=ln>5</span><span class=cl><span class=kr>end</span><span class=p>)</span>
|
||||
</span></span></code></pre></div><p>In this example, a command with the name of <code>hello</code> is created
|
||||
that will print <code>Hello world!</code> to output. One question you may
|
||||
have is: What is the <code>sinks</code> parameter?</p><p>The <code>sinks</code> parameter is a table with 3 keys: <code>input</code>, <code>out</code>, and <code>err</code>.
|
||||
There is an <code>in</code> alias to <code>input</code>, but it requires using the string accessor syntax (<code>sinks['in']</code>)
|
||||
as <code>in</code> is also a Lua keyword, so <code>input</code> is preferred for use.
|
||||
All of them are a <a href=/Hilbish/docs/api/hilbish/#sink style=text-decoration:none>Sink</a>.
|
||||
In the future, <code>sinks.in</code> will be removed.</p><ul><li><code>in</code> is the standard input.
|
||||
You may use the read functions on this sink to get input from the user.</li><li><code>out</code> is standard output.
|
||||
This is usually where command output should go.</li><li><code>err</code> is standard error.
|
||||
This sink is for writing errors, as the name would suggest.</li></ul><h3 id=functions class=heading>Functions
|
||||
<a href=#functions class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><a href=#deregister>deregister(name)</a></td><td>Removes the named command. Note that this will only remove Commander-registered commands.</td></tr><tr><td><a href=#register>register(name, cb)</a></td><td>Adds a new command with the given <code>name</code>. When Hilbish has to run a command with a name,</td></tr><tr><td><a href=#registry>registry() -> table</a></td><td>Returns all registered commanders. Returns a list of tables with the following keys:</td></tr></tbody></table><hr><div id=deregister><h4 class=heading>commander.deregister(name)
|
||||
<a href=#deregister class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Removes the named command. Note that this will only remove Commander-registered commands.</p><h5 id=parameters class=heading>Parameters
|
||||
<a href=#parameters class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>string</code> <strong><code>name</code></strong><br>Name of the command to remove.</p></div><hr><div id=register><h4 class=heading>commander.register(name, cb)
|
||||
<a href=#register class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Adds a new command with the given <code>name</code>. When Hilbish has to run a command with a name,<br>it will run the function providing the arguments and sinks.</p><h5 id=parameters-1 class=heading>Parameters
|
||||
<a href=#parameters-1 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>string</code> <strong><code>name</code></strong><br>Name of the command</p><p><code>function</code> <strong><code>cb</code></strong><br>Callback to handle command invocation</p><h5 id=example class=heading>Example
|
||||
<a href=#example class=heading-link><i class="fas fa-paperclip"></i></a></h5><div class=highlight><pre tabindex=0 class=chroma><code class=language-lua data-lang=lua><span class=line><span class=ln>1</span><span class=cl><span class=c1>-- When you run the command `hello` in the shell, it will print `Hello world`.</span>
|
||||
</span></span><span class=line><span class=ln>2</span><span class=cl><span class=c1>-- If you run it with, for example, `hello Hilbish`, it will print 'Hello Hilbish'</span>
|
||||
</span></span><span class=line><span class=ln>3</span><span class=cl><span class=n>commander.register</span><span class=p>(</span><span class=s1>'hello'</span><span class=p>,</span> <span class=kr>function</span><span class=p>(</span><span class=n>args</span><span class=p>,</span> <span class=n>sinks</span><span class=p>)</span>
|
||||
</span></span><span class=line><span class=ln>4</span><span class=cl> <span class=kd>local</span> <span class=n>name</span> <span class=o>=</span> <span class=s1>'world'</span>
|
||||
</span></span><span class=line><span class=ln>5</span><span class=cl> <span class=kr>if</span> <span class=o>#</span><span class=n>args</span> <span class=o>></span> <span class=mi>0</span> <span class=kr>then</span> <span class=n>name</span> <span class=o>=</span> <span class=n>args</span><span class=p>[</span><span class=mi>1</span><span class=p>]</span> <span class=kr>end</span>
|
||||
</span></span><span class=line><span class=ln>6</span><span class=cl>
|
||||
</span></span><span class=line><span class=ln>7</span><span class=cl> <span class=n>sinks.out</span><span class=p>:</span><span class=n>writeln</span><span class=p>(</span><span class=s1>'Hello '</span> <span class=o>..</span> <span class=n>name</span><span class=p>)</span>
|
||||
</span></span><span class=line><span class=ln>8</span><span class=cl><span class=kr>end</span><span class=p>)</span>
|
||||
</span></span></code></pre></div></div><hr><div id=registry><h4 class=heading>commander.registry() -> table
|
||||
<a href=#registry class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Returns all registered commanders. Returns a list of tables with the following keys:</p><ul><li><code>exec</code>: The function used to run the commander. Commanders require args and sinks to be passed.</li></ul><h5 id=parameters-2 class=heading>Parameters
|
||||
<a href=#parameters-2 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div></div><div class="footer mt-auto"><p class="card-small text-muted">Want to help improve this page? <a href=https://github.com/Rosettea/Hilbish/issues/new/choose>Create an issue.</a></p></div></container></div><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea © 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>
|
||||
62
versions/readline-move/docs/api/fs/index.html
Normal file
62
versions/readline-move/docs/api/fs/index.html
Normal file
@ -0,0 +1,62 @@
|
||||
<!doctype html><html><head><title>Module fs — Hilbish</title><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><meta name=theme-color content="#ff89dd"><meta content="/Hilbish/hilbish-flower.png" property="og:image"><meta property="og:site_name" content="Hilbish"><meta content="Module fs — Hilbish" property="og:title"><meta content="filesystem interaction and functionality library" property="og:description"><meta content="filesystem interaction and functionality library" name=description><meta name=revisit-after content="2 days"><meta name=keywords content="Lua,Hilbish,Linux,Shell"><meta property="og:locale" content="en_GB"><link rel=canonical href=https://rosettea.github.io/Hilbish/><meta property="og:url" content="https://rosettea.github.io/Hilbish/"><link href=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css rel=stylesheet integrity=sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor crossorigin=anonymous><script src=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js integrity=sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2 crossorigin=anonymous></script>
|
||||
<link rel=stylesheet href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" crossorigin=anonymous referrerpolicy=no-referrer><link rel=stylesheet href=/Hilbish/versions/readline-move/css/syntax.min.eb77978873f3b324603120b558a36c98ad57d6ee7b77928e3bc131bd76c5935a.css integrity="sha256-63eXiHPzsyRgMSC1WKNsmK1X1u57d5KOO8ExvXbFk1o="></link><style>.heading>.heading-link{opacity:0}.heading:hover>.heading-link{visibility:visible;opacity:1;transition:all .1s ease-in}@keyframes highlight{0%{background:0 0}50%{background:#fff2cf}100%{background:0 0}}div:target{animation:highlight 1.2s;animation-timing-function:cubic-bezier(1,-.02,.45,.89)}table{border-width:1px;border-style:solid;border-color:#565c64;border-collapse:collapse;margin-bottom:12px}table td{padding:5px}table tr{border-width:1px}thead{display:none}</style></head><body class="d-flex flex-column min-vh-100" style=overflow-x:hidden><svg xmlns="http://www.w3.org/2000/svg" style="display:none"><symbol id="check-circle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="exclamation-triangle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><header><nav class="navbar navbar-expand-md sticky-top bg-light border-bottom"><div class=container-fluid><a class=navbar-brand href=/Hilbish><img src=/Hilbish/hilbish-logo-and-text.png alt height=48></a>
|
||||
<button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
|
||||
<span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/readline-move/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><style>@media(min-width:768px){.sidenav{width:240px}}</style><div class=row><nav class="navbar-expand-md bg-light sidenav border-end"><div class=container><div class="collapse navbar-collapse" id=navbarSupportedContent><nav class="navbar navbar-expand-md bg-light sidenav col" style=margin-top:-20px><ul class="navbar-nav me-auto mb-2 mb-lg-0 flex-column col mt-4"><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link><strong>Introduction</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/getting-started/ class=nav-link><strong>Getting Started</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/faq/ class=nav-link><strong>Frequently Asked Questions</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/ class=nav-link><strong>Features</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/completions/ class=nav-link>Completions</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/notifications/ class=nav-link>Notification</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/opts/ class=nav-link>Options</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/runner-mode/ class=nav-link>Runner Mode</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/ class=nav-link><strong>Signals</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/command/ class=nav-link>Command</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/hilbish/ class=nav-link>Hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/signal/ class=nav-link>Signal</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/lunacolors/ class=nav-link><strong>Lunacolors</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/ class=nav-link><strong>Vim Mode</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/actions/ class=nav-link>Actions</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/ class=nav-link><strong>Nature</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/dirs/ class=nav-link>Module dirs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/doc/ class=nav-link>Module doc</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/ class=nav-link><strong>API</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/bait/ class=nav-link>Module bait</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/commander/ class=nav-link>Module commander</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/fs/ class=nav-link>Module fs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/ class=nav-link>Module hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.aliases/ class=nav-link>Module hilbish.aliases</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.completion/ class=nav-link>Module hilbish.completion</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.runner/ class=nav-link>Module hilbish.runner</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.userdir/ class=nav-link>Module hilbish.userDir</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/readline/ class=nav-link>Module readline</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/snail/ class=nav-link>Module snail</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/terminal/ class=nav-link>Module terminal</a></li></ul></ul></nav></div></div></nav><container class="col mt-2" style="padding-left: 20px; padding-right: 20px;"><div><h1>Module fs</h1><p><em>filesystem interaction and functionality library<br></em></p><h3 id=introduction class=heading>Introduction
|
||||
<a href=#introduction class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>The fs module provides filesystem functions to Hilbish. While Lua’s standard
|
||||
library has some I/O functions, they’re missing a lot of the basics. The <code>fs</code>
|
||||
library offers more functions and will work on any operating system Hilbish does.</p><h3 id=functions class=heading>Functions
|
||||
<a href=#functions class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><a href=#abs>abs(path) -> string</a></td><td>Returns an absolute version of the <code>path</code>.</td></tr><tr><td><a href=#basename>basename(path) -> string</a></td><td>Returns the “basename,” or the last part of the provided <code>path</code>. If path is empty,</td></tr><tr><td><a href=#cd>cd(dir)</a></td><td>Changes Hilbish’s directory to <code>dir</code>.</td></tr><tr><td><a href=#dir>dir(path) -> string</a></td><td>Returns the directory part of <code>path</code>. If a file path like</td></tr><tr><td><a href=#glob>glob(pattern) -> matches (table)</a></td><td>Match all files based on the provided <code>pattern</code>.</td></tr><tr><td><a href=#join>join(…path) -> string</a></td><td>Takes any list of paths and joins them based on the operating system’s path separator.</td></tr><tr><td><a href=#mkdir>mkdir(name, recursive)</a></td><td>Creates a new directory with the provided <code>name</code>.</td></tr><tr><td><a href=#pipe>fpipe() -> File, File</a></td><td>Returns a pair of connected files, also known as a pipe.</td></tr><tr><td><a href=#readdir>readdir(path) -> table[string]</a></td><td>Returns a list of all files and directories in the provided path.</td></tr><tr><td><a href=#stat>stat(path) -> {}</a></td><td>Returns the information about a given <code>path</code>.</td></tr></tbody></table><h3 id=static-module-fields class=heading>Static module fields
|
||||
<a href=#static-module-fields class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>pathSep</td><td>The operating system’s path separator.</td></tr></tbody></table><hr><div id=abs><h4 class=heading>fs.abs(path) -> string
|
||||
<a href=#abs class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Returns an absolute version of the <code>path</code>.<br>This can be used to resolve short paths like <code>..</code> to <code>/home/user</code>.</p><h5 id=parameters class=heading>Parameters
|
||||
<a href=#parameters class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>string</code> <strong><code>path</code></strong></p></div><hr><div id=basename><h4 class=heading>fs.basename(path) -> string
|
||||
<a href=#basename class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Returns the “basename,” or the last part of the provided <code>path</code>. If path is empty,<br><code>.</code> will be returned.</p><h5 id=parameters-1 class=heading>Parameters
|
||||
<a href=#parameters-1 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>string</code> <strong><code>path</code></strong><br>Path to get the base name of.</p></div><hr><div id=cd><h4 class=heading>fs.cd(dir)
|
||||
<a href=#cd class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Changes Hilbish’s directory to <code>dir</code>.</p><h5 id=parameters-2 class=heading>Parameters
|
||||
<a href=#parameters-2 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>string</code> <strong><code>dir</code></strong><br>Path to change directory to.</p></div><hr><div id=dir><h4 class=heading>fs.dir(path) -> string
|
||||
<a href=#dir class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Returns the directory part of <code>path</code>. If a file path like<br><code>~/Documents/doc.txt</code> then this function will return <code>~/Documents</code>.</p><h5 id=parameters-3 class=heading>Parameters
|
||||
<a href=#parameters-3 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>string</code> <strong><code>path</code></strong><br>Path to get the directory for.</p></div><hr><div id=glob><h4 class=heading>fs.glob(pattern) -> matches (table)
|
||||
<a href=#glob class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Match all files based on the provided <code>pattern</code>.<br>For the syntax’ refer to Go’s filepath.Match function: <a href=https://pkg.go.dev/path/filepath#Match target=_blank rel=noopener>https://pkg.go.dev/path/filepath#Match</a></p><h5 id=parameters-4 class=heading>Parameters
|
||||
<a href=#parameters-4 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>string</code> <strong><code>pattern</code></strong><br>Pattern to compare files with.</p><h5 id=example class=heading>Example
|
||||
<a href=#example class=heading-link><i class="fas fa-paperclip"></i></a></h5><div class=highlight><pre tabindex=0 class=chroma><code class=language-lua data-lang=lua><span class=line><span class=ln> 1</span><span class=cl><span class=cm>--[[
|
||||
</span></span></span><span class=line><span class=ln> 2</span><span class=cl><span class=cm> Within a folder that contains the following files:
|
||||
</span></span></span><span class=line><span class=ln> 3</span><span class=cl><span class=cm> a.txt
|
||||
</span></span></span><span class=line><span class=ln> 4</span><span class=cl><span class=cm> init.lua
|
||||
</span></span></span><span class=line><span class=ln> 5</span><span class=cl><span class=cm> code.lua
|
||||
</span></span></span><span class=line><span class=ln> 6</span><span class=cl><span class=cm> doc.pdf
|
||||
</span></span></span><span class=line><span class=ln> 7</span><span class=cl><span class=cm>]]</span><span class=c1>--</span>
|
||||
</span></span><span class=line><span class=ln> 8</span><span class=cl><span class=kd>local</span> <span class=n>matches</span> <span class=o>=</span> <span class=n>fs.glob</span> <span class=s1>'./*.lua'</span>
|
||||
</span></span><span class=line><span class=ln> 9</span><span class=cl><span class=n>print</span><span class=p>(</span><span class=n>matches</span><span class=p>)</span>
|
||||
</span></span><span class=line><span class=ln>10</span><span class=cl><span class=c1>-- -> {'init.lua', 'code.lua'}</span>
|
||||
</span></span></code></pre></div></div><hr><div id=join><h4 class=heading>fs.join(...path) -> string
|
||||
<a href=#join class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Takes any list of paths and joins them based on the operating system’s path separator.</p><h5 id=parameters-5 class=heading>Parameters
|
||||
<a href=#parameters-5 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>string</code> <strong><code>path</code></strong> (This type is variadic. You can pass an infinite amount of parameters with this type.)<br>Paths to join together</p><h5 id=example-1 class=heading>Example
|
||||
<a href=#example-1 class=heading-link><i class="fas fa-paperclip"></i></a></h5><div class=highlight><pre tabindex=0 class=chroma><code class=language-lua data-lang=lua><span class=line><span class=ln>1</span><span class=cl><span class=c1>-- This prints the directory for Hilbish's config!</span>
|
||||
</span></span><span class=line><span class=ln>2</span><span class=cl><span class=n>print</span><span class=p>(</span><span class=n>fs.join</span><span class=p>(</span><span class=n>hilbish.userDir</span><span class=p>.</span><span class=n>config</span><span class=p>,</span> <span class=s1>'hilbish'</span><span class=p>))</span>
|
||||
</span></span><span class=line><span class=ln>3</span><span class=cl><span class=c1>-- -> '/home/user/.config/hilbish' on Linux</span>
|
||||
</span></span></code></pre></div></div><hr><div id=mkdir><h4 class=heading>fs.mkdir(name, recursive)
|
||||
<a href=#mkdir class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Creates a new directory with the provided <code>name</code>.<br>With <code>recursive</code>, mkdir will create parent directories.</p><h5 id=parameters-6 class=heading>Parameters
|
||||
<a href=#parameters-6 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>string</code> <strong><code>name</code></strong><br>Name of the directory</p><p><code>boolean</code> <strong><code>recursive</code></strong><br>Whether to create parent directories for the provided name</p><h5 id=example-2 class=heading>Example
|
||||
<a href=#example-2 class=heading-link><i class="fas fa-paperclip"></i></a></h5><div class=highlight><pre tabindex=0 class=chroma><code class=language-lua data-lang=lua><span class=line><span class=ln>1</span><span class=cl><span class=c1>-- This will create the directory foo, then create the directory bar in the</span>
|
||||
</span></span><span class=line><span class=ln>2</span><span class=cl><span class=c1>-- foo directory. If recursive is false in this case, it will fail.</span>
|
||||
</span></span><span class=line><span class=ln>3</span><span class=cl><span class=n>fs.mkdir</span><span class=p>(</span><span class=s1>'./foo/bar'</span><span class=p>,</span> <span class=kc>true</span><span class=p>)</span>
|
||||
</span></span></code></pre></div></div><hr><div id=pipe><h4 class=heading>fs.fpipe() -> File, File
|
||||
<a href=#pipe class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Returns a pair of connected files, also known as a pipe.<br>The type returned is a Lua file, same as returned from <code>io</code> functions.</p><h5 id=parameters-7 class=heading>Parameters
|
||||
<a href=#parameters-7 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=readdir><h4 class=heading>fs.readdir(path) -> table[string]
|
||||
<a href=#readdir class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Returns a list of all files and directories in the provided path.</p><h5 id=parameters-8 class=heading>Parameters
|
||||
<a href=#parameters-8 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>string</code> <strong><code>dir</code></strong></p></div><hr><div id=stat><h4 class=heading>fs.stat(path) -> {}
|
||||
<a href=#stat class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Returns the information about a given <code>path</code>.<br>The returned table contains the following values:<br>name (string) - Name of the path<br>size (number) - Size of the path in bytes<br>mode (string) - Unix permission mode in an octal format string (with leading 0)<br>isDir (boolean) - If the path is a directory</p><h5 id=parameters-9 class=heading>Parameters
|
||||
<a href=#parameters-9 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>string</code> <strong><code>path</code></strong></p><h5 id=example-3 class=heading>Example
|
||||
<a href=#example-3 class=heading-link><i class="fas fa-paperclip"></i></a></h5><div class=highlight><pre tabindex=0 class=chroma><code class=language-lua data-lang=lua><span class=line><span class=ln> 1</span><span class=cl><span class=kd>local</span> <span class=n>inspect</span> <span class=o>=</span> <span class=n>require</span> <span class=s1>'inspect'</span>
|
||||
</span></span><span class=line><span class=ln> 2</span><span class=cl>
|
||||
</span></span><span class=line><span class=ln> 3</span><span class=cl><span class=kd>local</span> <span class=n>stat</span> <span class=o>=</span> <span class=n>fs.stat</span> <span class=s1>'~'</span>
|
||||
</span></span><span class=line><span class=ln> 4</span><span class=cl><span class=n>print</span><span class=p>(</span><span class=n>inspect</span><span class=p>(</span><span class=n>stat</span><span class=p>))</span>
|
||||
</span></span><span class=line><span class=ln> 5</span><span class=cl><span class=cm>--[[
|
||||
</span></span></span><span class=line><span class=ln> 6</span><span class=cl><span class=cm>Would print the following:
|
||||
</span></span></span><span class=line><span class=ln> 7</span><span class=cl><span class=cm>{
|
||||
</span></span></span><span class=line><span class=ln> 8</span><span class=cl><span class=cm> isDir = true,
|
||||
</span></span></span><span class=line><span class=ln> 9</span><span class=cl><span class=cm> mode = "0755",
|
||||
</span></span></span><span class=line><span class=ln>10</span><span class=cl><span class=cm> name = "username",
|
||||
</span></span></span><span class=line><span class=ln>11</span><span class=cl><span class=cm> size = 12288
|
||||
</span></span></span><span class=line><span class=ln>12</span><span class=cl><span class=cm>}
|
||||
</span></span></span><span class=line><span class=ln>13</span><span class=cl><span class=cm>]]</span><span class=c1>--</span>
|
||||
</span></span></code></pre></div></div></div><div class="footer mt-auto"><p class="card-small text-muted">Want to help improve this page? <a href=https://github.com/Rosettea/Hilbish/issues/new/choose>Create an issue.</a></p></div></container></div><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea © 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>
|
||||
@ -0,0 +1,21 @@
|
||||
<!doctype html><html><head><title>Module hilbish.aliases — Hilbish</title><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><meta name=theme-color content="#ff89dd"><meta content="/Hilbish/hilbish-flower.png" property="og:image"><meta property="og:site_name" content="Hilbish"><meta content="Module hilbish.aliases — Hilbish" property="og:title"><meta content="command aliasing" property="og:description"><meta content="command aliasing" name=description><meta name=revisit-after content="2 days"><meta name=keywords content="Lua,Hilbish,Linux,Shell"><meta property="og:locale" content="en_GB"><link rel=canonical href=https://rosettea.github.io/Hilbish/><meta property="og:url" content="https://rosettea.github.io/Hilbish/"><link href=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css rel=stylesheet integrity=sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor crossorigin=anonymous><script src=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js integrity=sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2 crossorigin=anonymous></script>
|
||||
<link rel=stylesheet href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" crossorigin=anonymous referrerpolicy=no-referrer><link rel=stylesheet href=/Hilbish/versions/readline-move/css/syntax.min.eb77978873f3b324603120b558a36c98ad57d6ee7b77928e3bc131bd76c5935a.css integrity="sha256-63eXiHPzsyRgMSC1WKNsmK1X1u57d5KOO8ExvXbFk1o="></link><style>.heading>.heading-link{opacity:0}.heading:hover>.heading-link{visibility:visible;opacity:1;transition:all .1s ease-in}@keyframes highlight{0%{background:0 0}50%{background:#fff2cf}100%{background:0 0}}div:target{animation:highlight 1.2s;animation-timing-function:cubic-bezier(1,-.02,.45,.89)}table{border-width:1px;border-style:solid;border-color:#565c64;border-collapse:collapse;margin-bottom:12px}table td{padding:5px}table tr{border-width:1px}thead{display:none}</style></head><body class="d-flex flex-column min-vh-100" style=overflow-x:hidden><svg xmlns="http://www.w3.org/2000/svg" style="display:none"><symbol id="check-circle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="exclamation-triangle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><header><nav class="navbar navbar-expand-md sticky-top bg-light border-bottom"><div class=container-fluid><a class=navbar-brand href=/Hilbish><img src=/Hilbish/hilbish-logo-and-text.png alt height=48></a>
|
||||
<button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
|
||||
<span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/readline-move/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><style>@media(min-width:768px){.sidenav{width:240px}}</style><div class=row><nav class="navbar-expand-md bg-light sidenav border-end"><div class=container><div class="collapse navbar-collapse" id=navbarSupportedContent><nav class="navbar navbar-expand-md bg-light sidenav col" style=margin-top:-20px><ul class="navbar-nav me-auto mb-2 mb-lg-0 flex-column col mt-4"><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link><strong>Introduction</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/getting-started/ class=nav-link><strong>Getting Started</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/faq/ class=nav-link><strong>Frequently Asked Questions</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/ class=nav-link><strong>Features</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/completions/ class=nav-link>Completions</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/notifications/ class=nav-link>Notification</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/opts/ class=nav-link>Options</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/runner-mode/ class=nav-link>Runner Mode</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/ class=nav-link><strong>Signals</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/command/ class=nav-link>Command</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/hilbish/ class=nav-link>Hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/signal/ class=nav-link>Signal</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/lunacolors/ class=nav-link><strong>Lunacolors</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/ class=nav-link><strong>Vim Mode</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/actions/ class=nav-link>Actions</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/ class=nav-link><strong>Nature</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/dirs/ class=nav-link>Module dirs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/doc/ class=nav-link>Module doc</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/ class=nav-link><strong>API</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/bait/ class=nav-link>Module bait</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/commander/ class=nav-link>Module commander</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/fs/ class=nav-link>Module fs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/ class=nav-link>Module hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.aliases/ class=nav-link>Module hilbish.aliases</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.completion/ class=nav-link>Module hilbish.completion</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.runner/ class=nav-link>Module hilbish.runner</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.userdir/ class=nav-link>Module hilbish.userDir</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/readline/ class=nav-link>Module readline</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/snail/ class=nav-link>Module snail</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/terminal/ class=nav-link>Module terminal</a></li></ul></ul></nav></div></div></nav><container class="col mt-2" style="padding-left: 20px; padding-right: 20px;"><div><h1>Module hilbish.aliases</h1><p><em>command aliasing<br></em></p><h3 id=introduction class=heading>Introduction
|
||||
<a href=#introduction class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>The alias interface deals with all command aliases in Hilbish.</p><h3 id=functions class=heading>Functions
|
||||
<a href=#functions class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><a href=#aliases.add>add(alias, cmd)</a></td><td>This is an alias (ha) for the <a href=../#alias>hilbish.alias</a>
|
||||
function.</td></tr><tr><td><a href=#aliases.delete>delete(name)</a></td><td>Removes an alias.</td></tr><tr><td><a href=#aliases.list>list() -> table[string, string]</a></td><td>Get a table of all aliases, with string keys as the alias and the value as the command.</td></tr><tr><td><a href=#aliases.resolve>resolve(alias) -> string?</a></td><td>Resolves an alias to its original command. Will thrown an error if the alias doesn’t exist.</td></tr></tbody></table><hr><div id=aliases.add><h4 class=heading>hilbish.aliases.add(alias, cmd)
|
||||
<a href=#aliases.add class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>This is an alias (ha) for the <a href=../#alias>hilbish.alias</a>
|
||||
function.</p><h5 id=parameters class=heading>Parameters
|
||||
<a href=#parameters class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=aliases.delete><h4 class=heading>hilbish.aliases.delete(name)
|
||||
<a href=#aliases.delete class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Removes an alias.</p><h5 id=parameters-1 class=heading>Parameters
|
||||
<a href=#parameters-1 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>string</code> <strong><code>name</code></strong></p></div><hr><div id=aliases.list><h4 class=heading>hilbish.aliases.list() -> table[string, string]
|
||||
<a href=#aliases.list class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Get a table of all aliases, with string keys as the alias and the value as the command.</p><h5 id=parameters-2 class=heading>Parameters
|
||||
<a href=#parameters-2 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p><h5 id=example class=heading>Example
|
||||
<a href=#example class=heading-link><i class="fas fa-paperclip"></i></a></h5><div class=highlight><pre tabindex=0 class=chroma><code class=language-lua data-lang=lua><span class=line><span class=ln>1</span><span class=cl><span class=n>hilbish.aliases</span><span class=p>.</span><span class=n>add</span><span class=p>(</span><span class=s1>'hi'</span><span class=p>,</span> <span class=s1>'echo hi'</span><span class=p>)</span>
|
||||
</span></span><span class=line><span class=ln>2</span><span class=cl>
|
||||
</span></span><span class=line><span class=ln>3</span><span class=cl><span class=kd>local</span> <span class=n>aliases</span> <span class=o>=</span> <span class=n>hilbish.aliases</span><span class=p>.</span><span class=n>list</span><span class=p>()</span>
|
||||
</span></span><span class=line><span class=ln>4</span><span class=cl><span class=c1>-- -> {hi = 'echo hi'}</span>
|
||||
</span></span></code></pre></div></div><hr><div id=aliases.resolve><h4 class=heading>hilbish.aliases.resolve(alias) -> string?
|
||||
<a href=#aliases.resolve class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Resolves an alias to its original command. Will thrown an error if the alias doesn’t exist.</p><h5 id=parameters-3 class=heading>Parameters
|
||||
<a href=#parameters-3 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>string</code> <strong><code>alias</code></strong></p></div></div><div class="footer mt-auto"><p class="card-small text-muted">Want to help improve this page? <a href=https://github.com/Rosettea/Hilbish/issues/new/choose>Create an issue.</a></p></div></container></div><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea © 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>
|
||||
@ -0,0 +1,41 @@
|
||||
<!doctype html><html><head><title>Module hilbish.completion — Hilbish</title><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><meta name=theme-color content="#ff89dd"><meta content="/Hilbish/hilbish-flower.png" property="og:image"><meta property="og:site_name" content="Hilbish"><meta content="Module hilbish.completion — Hilbish" property="og:title"><meta content="tab completions" property="og:description"><meta content="tab completions" name=description><meta name=revisit-after content="2 days"><meta name=keywords content="Lua,Hilbish,Linux,Shell"><meta property="og:locale" content="en_GB"><link rel=canonical href=https://rosettea.github.io/Hilbish/><meta property="og:url" content="https://rosettea.github.io/Hilbish/"><link href=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css rel=stylesheet integrity=sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor crossorigin=anonymous><script src=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js integrity=sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2 crossorigin=anonymous></script>
|
||||
<link rel=stylesheet href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" crossorigin=anonymous referrerpolicy=no-referrer><link rel=stylesheet href=/Hilbish/versions/readline-move/css/syntax.min.eb77978873f3b324603120b558a36c98ad57d6ee7b77928e3bc131bd76c5935a.css integrity="sha256-63eXiHPzsyRgMSC1WKNsmK1X1u57d5KOO8ExvXbFk1o="></link><style>.heading>.heading-link{opacity:0}.heading:hover>.heading-link{visibility:visible;opacity:1;transition:all .1s ease-in}@keyframes highlight{0%{background:0 0}50%{background:#fff2cf}100%{background:0 0}}div:target{animation:highlight 1.2s;animation-timing-function:cubic-bezier(1,-.02,.45,.89)}table{border-width:1px;border-style:solid;border-color:#565c64;border-collapse:collapse;margin-bottom:12px}table td{padding:5px}table tr{border-width:1px}thead{display:none}</style></head><body class="d-flex flex-column min-vh-100" style=overflow-x:hidden><svg xmlns="http://www.w3.org/2000/svg" style="display:none"><symbol id="check-circle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="exclamation-triangle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><header><nav class="navbar navbar-expand-md sticky-top bg-light border-bottom"><div class=container-fluid><a class=navbar-brand href=/Hilbish><img src=/Hilbish/hilbish-logo-and-text.png alt height=48></a>
|
||||
<button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
|
||||
<span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/readline-move/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><style>@media(min-width:768px){.sidenav{width:240px}}</style><div class=row><nav class="navbar-expand-md bg-light sidenav border-end"><div class=container><div class="collapse navbar-collapse" id=navbarSupportedContent><nav class="navbar navbar-expand-md bg-light sidenav col" style=margin-top:-20px><ul class="navbar-nav me-auto mb-2 mb-lg-0 flex-column col mt-4"><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link><strong>Introduction</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/getting-started/ class=nav-link><strong>Getting Started</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/faq/ class=nav-link><strong>Frequently Asked Questions</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/ class=nav-link><strong>Features</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/completions/ class=nav-link>Completions</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/notifications/ class=nav-link>Notification</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/opts/ class=nav-link>Options</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/runner-mode/ class=nav-link>Runner Mode</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/ class=nav-link><strong>Signals</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/command/ class=nav-link>Command</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/hilbish/ class=nav-link>Hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/signal/ class=nav-link>Signal</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/lunacolors/ class=nav-link><strong>Lunacolors</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/ class=nav-link><strong>Vim Mode</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/actions/ class=nav-link>Actions</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/ class=nav-link><strong>Nature</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/dirs/ class=nav-link>Module dirs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/doc/ class=nav-link>Module doc</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/ class=nav-link><strong>API</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/bait/ class=nav-link>Module bait</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/commander/ class=nav-link>Module commander</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/fs/ class=nav-link>Module fs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/ class=nav-link>Module hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.aliases/ class=nav-link>Module hilbish.aliases</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.completion/ class=nav-link>Module hilbish.completion</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.runner/ class=nav-link>Module hilbish.runner</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.userdir/ class=nav-link>Module hilbish.userDir</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/readline/ class=nav-link>Module readline</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/snail/ class=nav-link>Module snail</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/terminal/ class=nav-link>Module terminal</a></li></ul></ul></nav></div></div></nav><container class="col mt-2" style="padding-left: 20px; padding-right: 20px;"><div><h1>Module hilbish.completion</h1><p><em>tab completions<br></em></p><h3 id=introduction class=heading>Introduction
|
||||
<a href=#introduction class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>The completions interface deals with tab completions.</p><h3 id=functions class=heading>Functions
|
||||
<a href=#functions class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><a href=#completion.bins>bins(query, ctx, fields) -> entries (table), prefix (string)</a></td><td>Return binaries/executables based on the provided parameters.</td></tr><tr><td><a href=#completion.call>call(name, query, ctx, fields) -> completionGroups (table), prefix (string)</a></td><td>Calls a completer function. This is mainly used to call a command completer, which will have a <code>name</code></td></tr><tr><td><a href=#completion.files>files(query, ctx, fields) -> entries (table), prefix (string)</a></td><td>Returns file matches based on the provided parameters.</td></tr><tr><td><a href=#completion.handler>handler(line, pos)</a></td><td>This function contains the general completion handler for Hilbish. This function handles</td></tr></tbody></table><hr><div id=completion.bins><h4 class=heading>hilbish.completion.bins(query, ctx, fields) -> entries (table), prefix (string)
|
||||
<a href=#completion.bins class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Return binaries/executables based on the provided parameters.<br>This function is meant to be used as a helper in a command completion handler.</p><h5 id=parameters class=heading>Parameters
|
||||
<a href=#parameters class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>string</code> <strong><code>query</code></strong></p><p><code>string</code> <strong><code>ctx</code></strong></p><p><code>table</code> <strong><code>fields</code></strong></p><h5 id=example class=heading>Example
|
||||
<a href=#example class=heading-link><i class="fas fa-paperclip"></i></a></h5><div class=highlight><pre tabindex=0 class=chroma><code class=language-lua data-lang=lua><span class=line><span class=ln> 1</span><span class=cl><span class=c1>-- an extremely simple completer for sudo.</span>
|
||||
</span></span><span class=line><span class=ln> 2</span><span class=cl><span class=n>hilbish.complete</span><span class=p>(</span><span class=s1>'command.sudo'</span><span class=p>,</span> <span class=kr>function</span><span class=p>(</span><span class=n>query</span><span class=p>,</span> <span class=n>ctx</span><span class=p>,</span> <span class=n>fields</span><span class=p>)</span>
|
||||
</span></span><span class=line><span class=ln> 3</span><span class=cl> <span class=n>table.remove</span><span class=p>(</span><span class=n>fields</span><span class=p>,</span> <span class=mi>1</span><span class=p>)</span>
|
||||
</span></span><span class=line><span class=ln> 4</span><span class=cl> <span class=kr>if</span> <span class=o>#</span><span class=n>fields</span><span class=p>[</span><span class=mi>1</span><span class=p>]</span> <span class=kr>then</span>
|
||||
</span></span><span class=line><span class=ln> 5</span><span class=cl> <span class=c1>-- return commands because sudo runs a command as root..!</span>
|
||||
</span></span><span class=line><span class=ln> 6</span><span class=cl>
|
||||
</span></span><span class=line><span class=ln> 7</span><span class=cl> <span class=kd>local</span> <span class=n>entries</span><span class=p>,</span> <span class=n>pfx</span> <span class=o>=</span> <span class=n>hilbish.completion</span><span class=p>.</span><span class=n>bins</span><span class=p>(</span><span class=n>query</span><span class=p>,</span> <span class=n>ctx</span><span class=p>,</span> <span class=n>fields</span><span class=p>)</span>
|
||||
</span></span><span class=line><span class=ln> 8</span><span class=cl> <span class=kr>return</span> <span class=p>{</span>
|
||||
</span></span><span class=line><span class=ln> 9</span><span class=cl> <span class=n>type</span> <span class=o>=</span> <span class=s1>'grid'</span><span class=p>,</span>
|
||||
</span></span><span class=line><span class=ln>10</span><span class=cl> <span class=n>items</span> <span class=o>=</span> <span class=n>entries</span>
|
||||
</span></span><span class=line><span class=ln>11</span><span class=cl> <span class=p>},</span> <span class=n>pfx</span>
|
||||
</span></span><span class=line><span class=ln>12</span><span class=cl> <span class=kr>end</span>
|
||||
</span></span><span class=line><span class=ln>13</span><span class=cl>
|
||||
</span></span><span class=line><span class=ln>14</span><span class=cl> <span class=c1>-- ... else suggest files or anything else ..</span>
|
||||
</span></span><span class=line><span class=ln>15</span><span class=cl><span class=kr>end</span><span class=p>)</span>
|
||||
</span></span></code></pre></div></div><hr><div id=completion.call><h4 class=heading>hilbish.completion.call(name, query, ctx, fields) -> completionGroups (table), prefix (string)
|
||||
<a href=#completion.call class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Calls a completer function. This is mainly used to call a command completer, which will have a <code>name</code><br>in the form of <code>command.name</code>, example: <code>command.git</code>.<br>You can check the Completions doc or <code>doc completions</code> for info on the <code>completionGroups</code> return value.</p><h5 id=parameters-1 class=heading>Parameters
|
||||
<a href=#parameters-1 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>string</code> <strong><code>name</code></strong></p><p><code>string</code> <strong><code>query</code></strong></p><p><code>string</code> <strong><code>ctx</code></strong></p><p><code>table</code> <strong><code>fields</code></strong></p></div><hr><div id=completion.files><h4 class=heading>hilbish.completion.files(query, ctx, fields) -> entries (table), prefix (string)
|
||||
<a href=#completion.files class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Returns file matches based on the provided parameters.<br>This function is meant to be used as a helper in a command completion handler.</p><h5 id=parameters-2 class=heading>Parameters
|
||||
<a href=#parameters-2 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>string</code> <strong><code>query</code></strong></p><p><code>string</code> <strong><code>ctx</code></strong></p><p><code>table</code> <strong><code>fields</code></strong></p></div><hr><div id=completion.handler><h4 class=heading>hilbish.completion.handler(line, pos)
|
||||
<a href=#completion.handler class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>This function contains the general completion handler for Hilbish. This function handles<br>completion of everything, which includes calling other command handlers, binaries, and files.<br>This function can be overriden to supply a custom handler. Note that alias resolution is required to be done in this function.</p><h5 id=parameters-3 class=heading>Parameters
|
||||
<a href=#parameters-3 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>string</code> <strong><code>line</code></strong><br>The current Hilbish command line</p><p><code>number</code> <strong><code>pos</code></strong><br>Numerical position of the cursor</p><h5 id=example-1 class=heading>Example
|
||||
<a href=#example-1 class=heading-link><i class="fas fa-paperclip"></i></a></h5><div class=highlight><pre tabindex=0 class=chroma><code class=language-lua data-lang=lua><span class=line><span class=ln> 1</span><span class=cl><span class=c1>-- stripped down version of the default implementation</span>
|
||||
</span></span><span class=line><span class=ln> 2</span><span class=cl><span class=kr>function</span> <span class=nc>hilbish</span><span class=p>.</span><span class=nc>completion</span><span class=p>.</span><span class=nf>handler</span><span class=p>(</span><span class=n>line</span><span class=p>,</span> <span class=n>pos</span><span class=p>)</span>
|
||||
</span></span><span class=line><span class=ln> 3</span><span class=cl> <span class=kd>local</span> <span class=n>query</span> <span class=o>=</span> <span class=n>fields</span><span class=p>[</span><span class=o>#</span><span class=n>fields</span><span class=p>]</span>
|
||||
</span></span><span class=line><span class=ln> 4</span><span class=cl>
|
||||
</span></span><span class=line><span class=ln> 5</span><span class=cl> <span class=kr>if</span> <span class=o>#</span><span class=n>fields</span> <span class=o>==</span> <span class=mi>1</span> <span class=kr>then</span>
|
||||
</span></span><span class=line><span class=ln> 6</span><span class=cl> <span class=c1>-- call bins handler here</span>
|
||||
</span></span><span class=line><span class=ln> 7</span><span class=cl> <span class=kr>else</span>
|
||||
</span></span><span class=line><span class=ln> 8</span><span class=cl> <span class=c1>-- call command completer or files completer here</span>
|
||||
</span></span><span class=line><span class=ln> 9</span><span class=cl> <span class=kr>end</span>
|
||||
</span></span><span class=line><span class=ln>10</span><span class=cl><span class=kr>end</span>
|
||||
</span></span></code></pre></div></div></div><div class="footer mt-auto"><p class="card-small text-muted">Want to help improve this page? <a href=https://github.com/Rosettea/Hilbish/issues/new/choose>Create an issue.</a></p></div></container></div><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea © 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>
|
||||
@ -0,0 +1,33 @@
|
||||
<!doctype html><html><head><title>Module hilbish.runner — Hilbish</title><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><meta name=theme-color content="#ff89dd"><meta content="/Hilbish/hilbish-flower.png" property="og:image"><meta property="og:site_name" content="Hilbish"><meta content="Module hilbish.runner — Hilbish" property="og:title"><meta content="interactive command runner customization" property="og:description"><meta content="interactive command runner customization" name=description><meta name=revisit-after content="2 days"><meta name=keywords content="Lua,Hilbish,Linux,Shell"><meta property="og:locale" content="en_GB"><link rel=canonical href=https://rosettea.github.io/Hilbish/><meta property="og:url" content="https://rosettea.github.io/Hilbish/"><link href=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css rel=stylesheet integrity=sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor crossorigin=anonymous><script src=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js integrity=sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2 crossorigin=anonymous></script>
|
||||
<link rel=stylesheet href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" crossorigin=anonymous referrerpolicy=no-referrer><link rel=stylesheet href=/Hilbish/versions/readline-move/css/syntax.min.eb77978873f3b324603120b558a36c98ad57d6ee7b77928e3bc131bd76c5935a.css integrity="sha256-63eXiHPzsyRgMSC1WKNsmK1X1u57d5KOO8ExvXbFk1o="></link><style>.heading>.heading-link{opacity:0}.heading:hover>.heading-link{visibility:visible;opacity:1;transition:all .1s ease-in}@keyframes highlight{0%{background:0 0}50%{background:#fff2cf}100%{background:0 0}}div:target{animation:highlight 1.2s;animation-timing-function:cubic-bezier(1,-.02,.45,.89)}table{border-width:1px;border-style:solid;border-color:#565c64;border-collapse:collapse;margin-bottom:12px}table td{padding:5px}table tr{border-width:1px}thead{display:none}</style></head><body class="d-flex flex-column min-vh-100" style=overflow-x:hidden><svg xmlns="http://www.w3.org/2000/svg" style="display:none"><symbol id="check-circle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="exclamation-triangle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><header><nav class="navbar navbar-expand-md sticky-top bg-light border-bottom"><div class=container-fluid><a class=navbar-brand href=/Hilbish><img src=/Hilbish/hilbish-logo-and-text.png alt height=48></a>
|
||||
<button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
|
||||
<span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/readline-move/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><style>@media(min-width:768px){.sidenav{width:240px}}</style><div class=row><nav class="navbar-expand-md bg-light sidenav border-end"><div class=container><div class="collapse navbar-collapse" id=navbarSupportedContent><nav class="navbar navbar-expand-md bg-light sidenav col" style=margin-top:-20px><ul class="navbar-nav me-auto mb-2 mb-lg-0 flex-column col mt-4"><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link><strong>Introduction</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/getting-started/ class=nav-link><strong>Getting Started</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/faq/ class=nav-link><strong>Frequently Asked Questions</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/ class=nav-link><strong>Features</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/completions/ class=nav-link>Completions</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/notifications/ class=nav-link>Notification</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/opts/ class=nav-link>Options</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/runner-mode/ class=nav-link>Runner Mode</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/ class=nav-link><strong>Signals</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/command/ class=nav-link>Command</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/hilbish/ class=nav-link>Hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/signal/ class=nav-link>Signal</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/lunacolors/ class=nav-link><strong>Lunacolors</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/ class=nav-link><strong>Vim Mode</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/actions/ class=nav-link>Actions</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/ class=nav-link><strong>Nature</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/dirs/ class=nav-link>Module dirs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/doc/ class=nav-link>Module doc</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/ class=nav-link><strong>API</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/bait/ class=nav-link>Module bait</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/commander/ class=nav-link>Module commander</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/fs/ class=nav-link>Module fs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/ class=nav-link>Module hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.aliases/ class=nav-link>Module hilbish.aliases</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.completion/ class=nav-link>Module hilbish.completion</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.runner/ class=nav-link>Module hilbish.runner</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.userdir/ class=nav-link>Module hilbish.userDir</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/readline/ class=nav-link>Module readline</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/snail/ class=nav-link>Module snail</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/terminal/ class=nav-link>Module terminal</a></li></ul></ul></nav></div></div></nav><container class="col mt-2" style="padding-left: 20px; padding-right: 20px;"><div><h1>Module hilbish.runner</h1><p><em>interactive command runner customization<br></em></p><h3 id=introduction class=heading>Introduction
|
||||
<a href=#introduction class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>The runner interface contains functions that allow the user to change
|
||||
how Hilbish interprets interactive input.
|
||||
Users can add and change the default runner for interactive input to any
|
||||
language or script of their choosing. A good example is using it to
|
||||
write command in Fennel.</p><p>Runners are functions that evaluate user input. The default runners in
|
||||
Hilbish can run shell script and Lua code.</p><p>A runner is passed the input and has to return a table with these values.
|
||||
All are not required, only the useful ones the runner needs to return.
|
||||
(So if there isn’t an error, just omit <code>err</code>.)</p><ul><li><code>exitCode</code> (number): Exit code of the command</li><li><code>input</code> (string): The text input of the user. This is used by Hilbish to append extra input, in case
|
||||
more is requested.</li><li><code>err</code> (string): A string that represents an error from the runner.
|
||||
This should only be set when, for example, there is a syntax error.
|
||||
It can be set to a few special values for Hilbish to throw the right
|
||||
hooks and have a better looking message.<ul><li><code>\<command>: not-found</code> will throw a <code>command.not-found</code> hook
|
||||
based on what <code>\<command></code> is.</li><li><code>\<command>: not-executable</code> will throw a <code>command.not-executable</code> hook.</li></ul></li><li><code>continue</code> (boolean): Whether Hilbish should prompt the user for no input</li><li><code>newline</code> (boolean): Whether a newline should be added at the end of <code>input</code>.</li></ul><p>Here is a simple example of a fennel runner. It falls back to
|
||||
shell script if fennel eval has an error.</p><div class=highlight><pre tabindex=0 class=chroma><code class=language-lua data-lang=lua><span class=line><span class=ln> 1</span><span class=cl><span class=kd>local</span> <span class=n>fennel</span> <span class=o>=</span> <span class=n>require</span> <span class=s1>'fennel'</span>
|
||||
</span></span><span class=line><span class=ln> 2</span><span class=cl>
|
||||
</span></span><span class=line><span class=ln> 3</span><span class=cl><span class=n>hilbish.runnerMode</span><span class=p>(</span><span class=kr>function</span><span class=p>(</span><span class=n>input</span><span class=p>)</span>
|
||||
</span></span><span class=line><span class=ln> 4</span><span class=cl> <span class=kd>local</span> <span class=n>ok</span> <span class=o>=</span> <span class=n>pcall</span><span class=p>(</span><span class=n>fennel.eval</span><span class=p>,</span> <span class=n>input</span><span class=p>)</span>
|
||||
</span></span><span class=line><span class=ln> 5</span><span class=cl> <span class=kr>if</span> <span class=n>ok</span> <span class=kr>then</span>
|
||||
</span></span><span class=line><span class=ln> 6</span><span class=cl> <span class=kr>return</span> <span class=p>{</span>
|
||||
</span></span><span class=line><span class=ln> 7</span><span class=cl> <span class=n>input</span> <span class=o>=</span> <span class=n>input</span>
|
||||
</span></span><span class=line><span class=ln> 8</span><span class=cl> <span class=p>}</span>
|
||||
</span></span><span class=line><span class=ln> 9</span><span class=cl> <span class=kr>end</span>
|
||||
</span></span><span class=line><span class=ln>10</span><span class=cl>
|
||||
</span></span><span class=line><span class=ln>11</span><span class=cl> <span class=kr>return</span> <span class=n>hilbish.runner</span><span class=p>.</span><span class=n>sh</span><span class=p>(</span><span class=n>input</span><span class=p>)</span>
|
||||
</span></span><span class=line><span class=ln>12</span><span class=cl><span class=kr>end</span><span class=p>)</span>
|
||||
</span></span></code></pre></div><h3 id=functions class=heading>Functions
|
||||
<a href=#functions class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><a href=#runner.lua>lua(cmd)</a></td><td>Evaluates <code>cmd</code> as Lua input. This is the same as using <code>dofile</code></td></tr></tbody></table><hr><div id=runner.lua><h4 class=heading>hilbish.runner.lua(cmd)
|
||||
<a href=#runner.lua class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Evaluates <code>cmd</code> as Lua input. This is the same as using <code>dofile</code><br>or <code>load</code>, but is appropriated for the runner interface.</p><h5 id=parameters class=heading>Parameters
|
||||
<a href=#parameters class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>string</code> <strong><code>cmd</code></strong></p></div></div><div class="footer mt-auto"><p class="card-small text-muted">Want to help improve this page? <a href=https://github.com/Rosettea/Hilbish/issues/new/choose>Create an issue.</a></p></div></container></div><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea © 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>
|
||||
@ -0,0 +1,8 @@
|
||||
<!doctype html><html><head><title>Module hilbish.userDir — Hilbish</title><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><meta name=theme-color content="#ff89dd"><meta content="/Hilbish/hilbish-flower.png" property="og:image"><meta property="og:site_name" content="Hilbish"><meta content="Module hilbish.userDir — Hilbish" property="og:title"><meta content="user-related directories" property="og:description"><meta content="user-related directories" name=description><meta name=revisit-after content="2 days"><meta name=keywords content="Lua,Hilbish,Linux,Shell"><meta property="og:locale" content="en_GB"><link rel=canonical href=https://rosettea.github.io/Hilbish/><meta property="og:url" content="https://rosettea.github.io/Hilbish/"><link href=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css rel=stylesheet integrity=sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor crossorigin=anonymous><script src=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js integrity=sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2 crossorigin=anonymous></script>
|
||||
<link rel=stylesheet href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" crossorigin=anonymous referrerpolicy=no-referrer><link rel=stylesheet href=/Hilbish/versions/readline-move/css/syntax.min.eb77978873f3b324603120b558a36c98ad57d6ee7b77928e3bc131bd76c5935a.css integrity="sha256-63eXiHPzsyRgMSC1WKNsmK1X1u57d5KOO8ExvXbFk1o="></link><style>.heading>.heading-link{opacity:0}.heading:hover>.heading-link{visibility:visible;opacity:1;transition:all .1s ease-in}@keyframes highlight{0%{background:0 0}50%{background:#fff2cf}100%{background:0 0}}div:target{animation:highlight 1.2s;animation-timing-function:cubic-bezier(1,-.02,.45,.89)}table{border-width:1px;border-style:solid;border-color:#565c64;border-collapse:collapse;margin-bottom:12px}table td{padding:5px}table tr{border-width:1px}thead{display:none}</style></head><body class="d-flex flex-column min-vh-100" style=overflow-x:hidden><svg xmlns="http://www.w3.org/2000/svg" style="display:none"><symbol id="check-circle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="exclamation-triangle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><header><nav class="navbar navbar-expand-md sticky-top bg-light border-bottom"><div class=container-fluid><a class=navbar-brand href=/Hilbish><img src=/Hilbish/hilbish-logo-and-text.png alt height=48></a>
|
||||
<button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
|
||||
<span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/readline-move/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><style>@media(min-width:768px){.sidenav{width:240px}}</style><div class=row><nav class="navbar-expand-md bg-light sidenav border-end"><div class=container><div class="collapse navbar-collapse" id=navbarSupportedContent><nav class="navbar navbar-expand-md bg-light sidenav col" style=margin-top:-20px><ul class="navbar-nav me-auto mb-2 mb-lg-0 flex-column col mt-4"><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link><strong>Introduction</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/getting-started/ class=nav-link><strong>Getting Started</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/faq/ class=nav-link><strong>Frequently Asked Questions</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/ class=nav-link><strong>Features</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/completions/ class=nav-link>Completions</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/notifications/ class=nav-link>Notification</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/opts/ class=nav-link>Options</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/runner-mode/ class=nav-link>Runner Mode</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/ class=nav-link><strong>Signals</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/command/ class=nav-link>Command</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/hilbish/ class=nav-link>Hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/signal/ class=nav-link>Signal</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/lunacolors/ class=nav-link><strong>Lunacolors</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/ class=nav-link><strong>Vim Mode</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/actions/ class=nav-link>Actions</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/ class=nav-link><strong>Nature</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/dirs/ class=nav-link>Module dirs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/doc/ class=nav-link>Module doc</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/ class=nav-link><strong>API</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/bait/ class=nav-link>Module bait</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/commander/ class=nav-link>Module commander</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/fs/ class=nav-link>Module fs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/ class=nav-link>Module hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.aliases/ class=nav-link>Module hilbish.aliases</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.completion/ class=nav-link>Module hilbish.completion</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.runner/ class=nav-link>Module hilbish.runner</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.userdir/ class=nav-link>Module hilbish.userDir</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/readline/ class=nav-link>Module readline</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/snail/ class=nav-link>Module snail</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/terminal/ class=nav-link>Module terminal</a></li></ul></ul></nav></div></div></nav><container class="col mt-2" style="padding-left: 20px; padding-right: 20px;"><div><h1>Module hilbish.userDir</h1><p><em>user-related directories<br></em></p><h3 id=introduction class=heading>Introduction
|
||||
<a href=#introduction class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>This interface just contains properties to know about certain user directories.
|
||||
It is equivalent to XDG on Linux and gets the user’s preferred directories
|
||||
for configs and data.</p><h3 id=static-module-fields class=heading>Static module fields
|
||||
<a href=#static-module-fields class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>config</td><td>The user’s config directory</td></tr><tr><td>data</td><td>The user’s directory for program data</td></tr></tbody></table></div><div class="footer mt-auto"><p class="card-small text-muted">Want to help improve this page? <a href=https://github.com/Rosettea/Hilbish/issues/new/choose>Create an issue.</a></p></div></container></div><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea © 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>
|
||||
122
versions/readline-move/docs/api/hilbish/index.html
Normal file
122
versions/readline-move/docs/api/hilbish/index.html
Normal file
@ -0,0 +1,122 @@
|
||||
<!doctype html><html><head><title>Module hilbish — Hilbish</title><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><meta name=theme-color content="#ff89dd"><meta content="/Hilbish/hilbish-flower.png" property="og:image"><meta property="og:site_name" content="Hilbish"><meta content="Module hilbish — Hilbish" property="og:title"><meta content="the core Hilbish API" property="og:description"><meta content="the core Hilbish API" name=description><meta name=revisit-after content="2 days"><meta name=keywords content="Lua,Hilbish,Linux,Shell"><meta property="og:locale" content="en_GB"><link rel=canonical href=https://rosettea.github.io/Hilbish/><meta property="og:url" content="https://rosettea.github.io/Hilbish/"><link href=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css rel=stylesheet integrity=sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor crossorigin=anonymous><script src=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js integrity=sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2 crossorigin=anonymous></script>
|
||||
<link rel=stylesheet href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" crossorigin=anonymous referrerpolicy=no-referrer><link rel=stylesheet href=/Hilbish/versions/readline-move/css/syntax.min.eb77978873f3b324603120b558a36c98ad57d6ee7b77928e3bc131bd76c5935a.css integrity="sha256-63eXiHPzsyRgMSC1WKNsmK1X1u57d5KOO8ExvXbFk1o="></link><style>.heading>.heading-link{opacity:0}.heading:hover>.heading-link{visibility:visible;opacity:1;transition:all .1s ease-in}@keyframes highlight{0%{background:0 0}50%{background:#fff2cf}100%{background:0 0}}div:target{animation:highlight 1.2s;animation-timing-function:cubic-bezier(1,-.02,.45,.89)}table{border-width:1px;border-style:solid;border-color:#565c64;border-collapse:collapse;margin-bottom:12px}table td{padding:5px}table tr{border-width:1px}thead{display:none}</style></head><body class="d-flex flex-column min-vh-100" style=overflow-x:hidden><svg xmlns="http://www.w3.org/2000/svg" style="display:none"><symbol id="check-circle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="exclamation-triangle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><header><nav class="navbar navbar-expand-md sticky-top bg-light border-bottom"><div class=container-fluid><a class=navbar-brand href=/Hilbish><img src=/Hilbish/hilbish-logo-and-text.png alt height=48></a>
|
||||
<button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
|
||||
<span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/readline-move/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><style>@media(min-width:768px){.sidenav{width:240px}}</style><div class=row><nav class="navbar-expand-md bg-light sidenav border-end"><div class=container><div class="collapse navbar-collapse" id=navbarSupportedContent><nav class="navbar navbar-expand-md bg-light sidenav col" style=margin-top:-20px><ul class="navbar-nav me-auto mb-2 mb-lg-0 flex-column col mt-4"><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link><strong>Introduction</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/getting-started/ class=nav-link><strong>Getting Started</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/faq/ class=nav-link><strong>Frequently Asked Questions</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/ class=nav-link><strong>Features</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/completions/ class=nav-link>Completions</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/notifications/ class=nav-link>Notification</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/opts/ class=nav-link>Options</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/runner-mode/ class=nav-link>Runner Mode</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/ class=nav-link><strong>Signals</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/command/ class=nav-link>Command</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/hilbish/ class=nav-link>Hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/signal/ class=nav-link>Signal</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/lunacolors/ class=nav-link><strong>Lunacolors</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/ class=nav-link><strong>Vim Mode</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/actions/ class=nav-link>Actions</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/ class=nav-link><strong>Nature</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/dirs/ class=nav-link>Module dirs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/doc/ class=nav-link>Module doc</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/ class=nav-link><strong>API</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/bait/ class=nav-link>Module bait</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/commander/ class=nav-link>Module commander</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/fs/ class=nav-link>Module fs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/ class=nav-link>Module hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.aliases/ class=nav-link>Module hilbish.aliases</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.completion/ class=nav-link>Module hilbish.completion</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.runner/ class=nav-link>Module hilbish.runner</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.userdir/ class=nav-link>Module hilbish.userDir</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/readline/ class=nav-link>Module readline</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/snail/ class=nav-link>Module snail</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/terminal/ class=nav-link>Module terminal</a></li></ul></ul></nav></div></div></nav><container class="col mt-2" style="padding-left: 20px; padding-right: 20px;"><div><h1>Module hilbish</h1><p><em>the core Hilbish API<br></em></p><h3 id=introduction class=heading>Introduction
|
||||
<a href=#introduction class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>The Hilbish module includes the core API, containing
|
||||
interfaces and functions which directly relate to shell functionality.</p><h3 id=functions class=heading>Functions
|
||||
<a href=#functions class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><a href=#alias>alias(cmd, orig)</a></td><td>Sets an alias, with a name of <code>cmd</code> to another command.</td></tr><tr><td><a href=#appendPath>appendPath(dir)</a></td><td>Appends the provided dir to the command path (<code>$PATH</code>)</td></tr><tr><td><a href=#complete>complete(scope, cb)</a></td><td>Registers a completion handler for the specified scope.</td></tr><tr><td><a href=#cwd>cwd() -> string</a></td><td>Returns the current directory of the shell.</td></tr><tr><td><a href=#exec>exec(cmd)</a></td><td>Replaces the currently running Hilbish instance with the supplied command.</td></tr><tr><td><a href=#goro>goro(fn)</a></td><td>Puts <code>fn</code> in a Goroutine.</td></tr><tr><td><a href=#highlighter>highlighter(line)</a></td><td>Line highlighter handler.</td></tr><tr><td><a href=#hinter>hinter(line, pos)</a></td><td>The command line hint handler. It gets called on every key insert to</td></tr><tr><td><a href=#inputMode>inputMode(mode)</a></td><td>Sets the input mode for Hilbish’s line reader.</td></tr><tr><td><a href=#interval>interval(cb, time) -> @Timer</a></td><td>Runs the <code>cb</code> function every specified amount of <code>time</code>.</td></tr><tr><td><a href=#multiprompt>multiprompt(str)</a></td><td>Changes the text prompt when Hilbish asks for more input.</td></tr><tr><td><a href=#prependPath>prependPath(dir)</a></td><td>Prepends <code>dir</code> to $PATH.</td></tr><tr><td><a href=#prompt>prompt(str, typ)</a></td><td>Changes the shell prompt to the provided string.</td></tr><tr><td><a href=#read>read(prompt) -> input (string)</a></td><td>Read input from the user, using Hilbish’s line editor/input reader.</td></tr><tr><td><a href=#timeout>timeout(cb, time) -> @Timer</a></td><td>Executed the <code>cb</code> function after a period of <code>time</code>.</td></tr><tr><td><a href=#which>which(name) -> string</a></td><td>Checks if <code>name</code> is a valid command.</td></tr></tbody></table><h3 id=static-module-fields class=heading>Static module fields
|
||||
<a href=#static-module-fields class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>ver</td><td>The version of Hilbish</td></tr><tr><td>goVersion</td><td>The version of Go that Hilbish was compiled with</td></tr><tr><td>user</td><td>Username of the user</td></tr><tr><td>host</td><td>Hostname of the machine</td></tr><tr><td>dataDir</td><td>Directory for Hilbish data files, including the docs and default modules</td></tr><tr><td>interactive</td><td>Is Hilbish in an interactive shell?</td></tr><tr><td>login</td><td>Is Hilbish the login shell?</td></tr><tr><td>vimMode</td><td>Current Vim input mode of Hilbish (will be nil if not in Vim input mode)</td></tr><tr><td>exitCode</td><td>Exit code of the last executed command</td></tr></tbody></table><hr><div id=alias><h4 class=heading>hilbish.alias(cmd, orig)
|
||||
<a href=#alias class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Sets an alias, with a name of <code>cmd</code> to another command.</p><h5 id=parameters class=heading>Parameters
|
||||
<a href=#parameters class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>string</code> <strong><code>cmd</code></strong><br>Name of the alias</p><p><code>string</code> <strong><code>orig</code></strong><br>Command that will be aliased</p><h5 id=example class=heading>Example
|
||||
<a href=#example class=heading-link><i class="fas fa-paperclip"></i></a></h5><div class=highlight><pre tabindex=0 class=chroma><code class=language-lua data-lang=lua><span class=line><span class=ln>1</span><span class=cl><span class=c1>-- With this, "ga file" will turn into "git add file"</span>
|
||||
</span></span><span class=line><span class=ln>2</span><span class=cl><span class=n>hilbish.alias</span><span class=p>(</span><span class=s1>'ga'</span><span class=p>,</span> <span class=s1>'git add'</span><span class=p>)</span>
|
||||
</span></span><span class=line><span class=ln>3</span><span class=cl>
|
||||
</span></span><span class=line><span class=ln>4</span><span class=cl><span class=c1>-- Numbered substitutions are supported here!</span>
|
||||
</span></span><span class=line><span class=ln>5</span><span class=cl><span class=n>hilbish.alias</span><span class=p>(</span><span class=s1>'dircount'</span><span class=p>,</span> <span class=s1>'ls %1 | wc -l'</span><span class=p>)</span>
|
||||
</span></span><span class=line><span class=ln>6</span><span class=cl><span class=c1>-- "dircount ~" would count how many files are in ~ (home directory).</span>
|
||||
</span></span></code></pre></div></div><hr><div id=appendPath><h4 class=heading>hilbish.appendPath(dir)
|
||||
<a href=#appendPath class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Appends the provided dir to the command path (<code>$PATH</code>)</p><h5 id=parameters-1 class=heading>Parameters
|
||||
<a href=#parameters-1 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>string|table</code> <strong><code>dir</code></strong><br>Directory (or directories) to append to path</p><h5 id=example-1 class=heading>Example
|
||||
<a href=#example-1 class=heading-link><i class="fas fa-paperclip"></i></a></h5><div class=highlight><pre tabindex=0 class=chroma><code class=language-lua data-lang=lua><span class=line><span class=ln>1</span><span class=cl><span class=n>hilbish.appendPath</span> <span class=s1>'~/go/bin'</span>
|
||||
</span></span><span class=line><span class=ln>2</span><span class=cl><span class=c1>-- Will add ~/go/bin to the command path.</span>
|
||||
</span></span><span class=line><span class=ln>3</span><span class=cl>
|
||||
</span></span><span class=line><span class=ln>4</span><span class=cl><span class=c1>-- Or do multiple:</span>
|
||||
</span></span><span class=line><span class=ln>5</span><span class=cl><span class=n>hilbish.appendPath</span> <span class=p>{</span>
|
||||
</span></span><span class=line><span class=ln>6</span><span class=cl> <span class=s1>'~/go/bin'</span><span class=p>,</span>
|
||||
</span></span><span class=line><span class=ln>7</span><span class=cl> <span class=s1>'~/.local/bin'</span>
|
||||
</span></span><span class=line><span class=ln>8</span><span class=cl><span class=p>}</span>
|
||||
</span></span></code></pre></div></div><hr><div id=complete><h4 class=heading>hilbish.complete(scope, cb)
|
||||
<a href=#complete class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Registers a completion handler for the specified scope.<br>A <code>scope</code> is expected to be <code>command.<cmd></code>,<br>replacing <cmd>with the name of the command (for example <code>command.git</code>).<br>The documentation for completions, under Features/Completions or <code>doc completions</code><br>provides more details.</p><h5 id=parameters-2 class=heading>Parameters
|
||||
<a href=#parameters-2 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>string</code> <strong><code>scope</code></strong></p><p><code>function</code> <strong><code>cb</code></strong></p><h5 id=example-2 class=heading>Example
|
||||
<a href=#example-2 class=heading-link><i class="fas fa-paperclip"></i></a></h5><div class=highlight><pre tabindex=0 class=chroma><code class=language-lua data-lang=lua><span class=line><span class=ln> 1</span><span class=cl><span class=c1>-- This is a very simple example. Read the full doc for completions for details.</span>
|
||||
</span></span><span class=line><span class=ln> 2</span><span class=cl><span class=n>hilbish.complete</span><span class=p>(</span><span class=s1>'command.sudo'</span><span class=p>,</span> <span class=kr>function</span><span class=p>(</span><span class=n>query</span><span class=p>,</span> <span class=n>ctx</span><span class=p>,</span> <span class=n>fields</span><span class=p>)</span>
|
||||
</span></span><span class=line><span class=ln> 3</span><span class=cl> <span class=kr>if</span> <span class=o>#</span><span class=n>fields</span> <span class=o>==</span> <span class=mi>0</span> <span class=kr>then</span>
|
||||
</span></span><span class=line><span class=ln> 4</span><span class=cl> <span class=c1>-- complete for commands</span>
|
||||
</span></span><span class=line><span class=ln> 5</span><span class=cl> <span class=kd>local</span> <span class=n>comps</span><span class=p>,</span> <span class=n>pfx</span> <span class=o>=</span> <span class=n>hilbish.completion</span><span class=p>.</span><span class=n>bins</span><span class=p>(</span><span class=n>query</span><span class=p>,</span> <span class=n>ctx</span><span class=p>,</span> <span class=n>fields</span><span class=p>)</span>
|
||||
</span></span><span class=line><span class=ln> 6</span><span class=cl> <span class=kd>local</span> <span class=n>compGroup</span> <span class=o>=</span> <span class=p>{</span>
|
||||
</span></span><span class=line><span class=ln> 7</span><span class=cl> <span class=n>items</span> <span class=o>=</span> <span class=n>comps</span><span class=p>,</span> <span class=c1>-- our list of items to complete</span>
|
||||
</span></span><span class=line><span class=ln> 8</span><span class=cl> <span class=n>type</span> <span class=o>=</span> <span class=s1>'grid'</span> <span class=c1>-- what our completions will look like.</span>
|
||||
</span></span><span class=line><span class=ln> 9</span><span class=cl> <span class=p>}</span>
|
||||
</span></span><span class=line><span class=ln>10</span><span class=cl>
|
||||
</span></span><span class=line><span class=ln>11</span><span class=cl> <span class=kr>return</span> <span class=p>{</span><span class=n>compGroup</span><span class=p>},</span> <span class=n>pfx</span>
|
||||
</span></span><span class=line><span class=ln>12</span><span class=cl> <span class=kr>end</span>
|
||||
</span></span><span class=line><span class=ln>13</span><span class=cl>
|
||||
</span></span><span class=line><span class=ln>14</span><span class=cl> <span class=c1>-- otherwise just be boring and return files</span>
|
||||
</span></span><span class=line><span class=ln>15</span><span class=cl>
|
||||
</span></span><span class=line><span class=ln>16</span><span class=cl> <span class=kd>local</span> <span class=n>comps</span><span class=p>,</span> <span class=n>pfx</span> <span class=o>=</span> <span class=n>hilbish.completion</span><span class=p>.</span><span class=n>files</span><span class=p>(</span><span class=n>query</span><span class=p>,</span> <span class=n>ctx</span><span class=p>,</span> <span class=n>fields</span><span class=p>)</span>
|
||||
</span></span><span class=line><span class=ln>17</span><span class=cl> <span class=kd>local</span> <span class=n>compGroup</span> <span class=o>=</span> <span class=p>{</span>
|
||||
</span></span><span class=line><span class=ln>18</span><span class=cl> <span class=n>items</span> <span class=o>=</span> <span class=n>comps</span><span class=p>,</span>
|
||||
</span></span><span class=line><span class=ln>19</span><span class=cl> <span class=n>type</span> <span class=o>=</span> <span class=s1>'grid'</span>
|
||||
</span></span><span class=line><span class=ln>20</span><span class=cl> <span class=p>}</span>
|
||||
</span></span><span class=line><span class=ln>21</span><span class=cl>
|
||||
</span></span><span class=line><span class=ln>22</span><span class=cl> <span class=kr>return</span> <span class=p>{</span><span class=n>compGroup</span><span class=p>},</span> <span class=n>pfx</span>
|
||||
</span></span><span class=line><span class=ln>23</span><span class=cl><span class=kr>end</span><span class=p>)</span>
|
||||
</span></span></code></pre></div></div><hr><div id=cwd><h4 class=heading>hilbish.cwd() -> string
|
||||
<a href=#cwd class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Returns the current directory of the shell.</p><h5 id=parameters-3 class=heading>Parameters
|
||||
<a href=#parameters-3 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=exec><h4 class=heading>hilbish.exec(cmd)
|
||||
<a href=#exec class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Replaces the currently running Hilbish instance with the supplied command.<br>This can be used to do an in-place restart.</p><h5 id=parameters-4 class=heading>Parameters
|
||||
<a href=#parameters-4 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>string</code> <strong><code>cmd</code></strong></p></div><hr><div id=goro><h4 class=heading>hilbish.goro(fn)
|
||||
<a href=#goro class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Puts <code>fn</code> in a Goroutine.<br>This can be used to run any function in another thread at the same time as other Lua code.<br><strong>NOTE: THIS FUNCTION MAY CRASH HILBISH IF OUTSIDE VARIABLES ARE ACCESSED.</strong><br><strong>This is a limitation of the Lua runtime.</strong></p><h5 id=parameters-5 class=heading>Parameters
|
||||
<a href=#parameters-5 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>function</code> <strong><code>fn</code></strong></p></div><hr><div id=highlighter><h4 class=heading>hilbish.highlighter(line)
|
||||
<a href=#highlighter class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Line highlighter handler.<br>This is mainly for syntax highlighting, but in reality could set the input<br>of the prompt to <em>display</em> anything. The callback is passed the current line<br>and is expected to return a line that will be used as the input display.<br>Note that to set a highlighter, one has to override this function.</p><h5 id=parameters-6 class=heading>Parameters
|
||||
<a href=#parameters-6 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>string</code> <strong><code>line</code></strong></p><h5 id=example-3 class=heading>Example
|
||||
<a href=#example-3 class=heading-link><i class="fas fa-paperclip"></i></a></h5><div class=highlight><pre tabindex=0 class=chroma><code class=language-lua data-lang=lua><span class=line><span class=ln>1</span><span class=cl><span class=c1>--This code will highlight all double quoted strings in green.</span>
|
||||
</span></span><span class=line><span class=ln>2</span><span class=cl><span class=kr>function</span> <span class=nc>hilbish</span><span class=p>.</span><span class=nf>highlighter</span><span class=p>(</span><span class=n>line</span><span class=p>)</span>
|
||||
</span></span><span class=line><span class=ln>3</span><span class=cl> <span class=kr>return</span> <span class=n>line</span><span class=p>:</span><span class=n>gsub</span><span class=p>(</span><span class=s1>'"%w+"'</span><span class=p>,</span> <span class=kr>function</span><span class=p>(</span><span class=n>c</span><span class=p>)</span> <span class=kr>return</span> <span class=n>lunacolors.green</span><span class=p>(</span><span class=n>c</span><span class=p>)</span> <span class=kr>end</span><span class=p>)</span>
|
||||
</span></span><span class=line><span class=ln>4</span><span class=cl><span class=kr>end</span>
|
||||
</span></span></code></pre></div></div><hr><div id=hinter><h4 class=heading>hilbish.hinter(line, pos)
|
||||
<a href=#hinter class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>The command line hint handler. It gets called on every key insert to<br>determine what text to use as an inline hint. It is passed the current<br>line and cursor position. It is expected to return a string which is used<br>as the text for the hint. This is by default a shim. To set hints,<br>override this function with your custom handler.</p><h5 id=parameters-7 class=heading>Parameters
|
||||
<a href=#parameters-7 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>string</code> <strong><code>line</code></strong></p><p><code>number</code> <strong><code>pos</code></strong><br>Position of cursor in line. Usually equals string.len(line)</p><h5 id=example-4 class=heading>Example
|
||||
<a href=#example-4 class=heading-link><i class="fas fa-paperclip"></i></a></h5><div class=highlight><pre tabindex=0 class=chroma><code class=language-lua data-lang=lua><span class=line><span class=ln>1</span><span class=cl><span class=c1>-- this will display "hi" after the cursor in a dimmed color.</span>
|
||||
</span></span><span class=line><span class=ln>2</span><span class=cl><span class=kr>function</span> <span class=nc>hilbish</span><span class=p>.</span><span class=nf>hinter</span><span class=p>(</span><span class=n>line</span><span class=p>,</span> <span class=n>pos</span><span class=p>)</span>
|
||||
</span></span><span class=line><span class=ln>3</span><span class=cl> <span class=kr>return</span> <span class=s1>'hi'</span>
|
||||
</span></span><span class=line><span class=ln>4</span><span class=cl><span class=kr>end</span>
|
||||
</span></span></code></pre></div></div><hr><div id=inputMode><h4 class=heading>hilbish.inputMode(mode)
|
||||
<a href=#inputMode class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Sets the input mode for Hilbish’s line reader.<br><code>emacs</code> is the default. Setting it to <code>vim</code> changes behavior of input to be<br>Vim-like with modes and Vim keybinds.</p><h5 id=parameters-8 class=heading>Parameters
|
||||
<a href=#parameters-8 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>string</code> <strong><code>mode</code></strong><br>Can be set to either <code>emacs</code> or <code>vim</code></p></div><hr><div id=interval><h4 class=heading>hilbish.interval(cb, time) -> <a href=/Hilbish/docs/api/hilbish/hilbish.timers/#timer style=text-decoration:none id=lol>Timer</a>
|
||||
<a href=#interval class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Runs the <code>cb</code> function every specified amount of <code>time</code>.<br>This creates a timer that ticking immediately.</p><h5 id=parameters-9 class=heading>Parameters
|
||||
<a href=#parameters-9 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>function</code> <strong><code>cb</code></strong></p><p><code>number</code> <strong><code>time</code></strong><br>Time in milliseconds.</p></div><hr><div id=multiprompt><h4 class=heading>hilbish.multiprompt(str)
|
||||
<a href=#multiprompt class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Changes the text prompt when Hilbish asks for more input.<br>This will show up when text is incomplete, like a missing quote</p><h5 id=parameters-10 class=heading>Parameters
|
||||
<a href=#parameters-10 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>string</code> <strong><code>str</code></strong></p><h5 id=example-5 class=heading>Example
|
||||
<a href=#example-5 class=heading-link><i class="fas fa-paperclip"></i></a></h5><div class=highlight><pre tabindex=0 class=chroma><code class=language-lua data-lang=lua><span class=line><span class=ln> 1</span><span class=cl><span class=cm>--[[
|
||||
</span></span></span><span class=line><span class=ln> 2</span><span class=cl><span class=cm>imagine this is your text input:
|
||||
</span></span></span><span class=line><span class=ln> 3</span><span class=cl><span class=cm>user ~ ∆ echo "hey
|
||||
</span></span></span><span class=line><span class=ln> 4</span><span class=cl><span class=cm>
|
||||
</span></span></span><span class=line><span class=ln> 5</span><span class=cl><span class=cm>but there's a missing quote! hilbish will now prompt you so the terminal
|
||||
</span></span></span><span class=line><span class=ln> 6</span><span class=cl><span class=cm>will look like:
|
||||
</span></span></span><span class=line><span class=ln> 7</span><span class=cl><span class=cm>user ~ ∆ echo "hey
|
||||
</span></span></span><span class=line><span class=ln> 8</span><span class=cl><span class=cm>--> ...!"
|
||||
</span></span></span><span class=line><span class=ln> 9</span><span class=cl><span class=cm>
|
||||
</span></span></span><span class=line><span class=ln>10</span><span class=cl><span class=cm>so then you get
|
||||
</span></span></span><span class=line><span class=ln>11</span><span class=cl><span class=cm>user ~ ∆ echo "hey
|
||||
</span></span></span><span class=line><span class=ln>12</span><span class=cl><span class=cm>--> ...!"
|
||||
</span></span></span><span class=line><span class=ln>13</span><span class=cl><span class=cm>hey ...!
|
||||
</span></span></span><span class=line><span class=ln>14</span><span class=cl><span class=cm>]]</span><span class=c1>--</span>
|
||||
</span></span><span class=line><span class=ln>15</span><span class=cl><span class=n>hilbish.multiprompt</span> <span class=s1>'-->'</span>
|
||||
</span></span></code></pre></div></div><hr><div id=prependPath><h4 class=heading>hilbish.prependPath(dir)
|
||||
<a href=#prependPath class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Prepends <code>dir</code> to $PATH.</p><h5 id=parameters-11 class=heading>Parameters
|
||||
<a href=#parameters-11 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>string</code> <strong><code>dir</code></strong></p></div><hr><div id=prompt><h4 class=heading>hilbish.prompt(str, typ)
|
||||
<a href=#prompt class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Changes the shell prompt to the provided string.<br>There are a few verbs that can be used in the prompt text.<br>These will be formatted and replaced with the appropriate values.<br><code>%d</code> - Current working directory<br><code>%u</code> - Name of current user<br><code>%h</code> - Hostname of device</p><h5 id=parameters-12 class=heading>Parameters
|
||||
<a href=#parameters-12 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>string</code> <strong><code>str</code></strong></p><p><code>string</code> <strong><code>typ?</code></strong><br>Type of prompt, being left or right. Left by default.</p><h5 id=example-6 class=heading>Example
|
||||
<a href=#example-6 class=heading-link><i class="fas fa-paperclip"></i></a></h5><div class=highlight><pre tabindex=0 class=chroma><code class=language-lua data-lang=lua><span class=line><span class=ln>1</span><span class=cl><span class=c1>-- the default hilbish prompt without color</span>
|
||||
</span></span><span class=line><span class=ln>2</span><span class=cl><span class=n>hilbish.prompt</span> <span class=s1>'%u %d ∆'</span>
|
||||
</span></span><span class=line><span class=ln>3</span><span class=cl><span class=c1>-- or something of old:</span>
|
||||
</span></span><span class=line><span class=ln>4</span><span class=cl><span class=n>hilbish.prompt</span> <span class=s1>'%u@%h :%d $'</span>
|
||||
</span></span><span class=line><span class=ln>5</span><span class=cl><span class=c1>-- prompt: user@hostname: ~/directory $</span>
|
||||
</span></span></code></pre></div></div><hr><div id=read><h4 class=heading>hilbish.read(prompt) -> input (string)
|
||||
<a href=#read class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Read input from the user, using Hilbish’s line editor/input reader.<br>This is a separate instance from the one Hilbish actually uses.<br>Returns <code>input</code>, will be nil if Ctrl-D is pressed, or an error occurs.</p><h5 id=parameters-13 class=heading>Parameters
|
||||
<a href=#parameters-13 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>string</code> <strong><code>prompt?</code></strong><br>Text to print before input, can be empty.</p></div><hr><div id=timeout><h4 class=heading>hilbish.timeout(cb, time) -> <a href=/Hilbish/docs/api/hilbish/hilbish.timers/#timer style=text-decoration:none id=lol>Timer</a>
|
||||
<a href=#timeout class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Executed the <code>cb</code> function after a period of <code>time</code>.<br>This creates a Timer that starts ticking immediately.</p><h5 id=parameters-14 class=heading>Parameters
|
||||
<a href=#parameters-14 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>function</code> <strong><code>cb</code></strong></p><p><code>number</code> <strong><code>time</code></strong><br>Time to run in milliseconds.</p></div><hr><div id=which><h4 class=heading>hilbish.which(name) -> string
|
||||
<a href=#which class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Checks if <code>name</code> is a valid command.<br>Will return the path of the binary, or a basename if it’s a commander.</p><h5 id=parameters-15 class=heading>Parameters
|
||||
<a href=#parameters-15 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>string</code> <strong><code>name</code></strong></p></div><h3 id=types class=heading>Types
|
||||
<a href=#types class=heading-link><i class="fas fa-paperclip"></i></a></h3><hr><h3 id=sink class=heading>Sink
|
||||
<a href=#sink class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>A sink is a structure that has input and/or output to/from a desination.</p><h4 id=methods class=heading>Methods
|
||||
<a href=#methods class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=autoflushauto class=heading>autoFlush(auto)
|
||||
<a href=#autoflushauto class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>Sets/toggles the option of automatically flushing output.
|
||||
A call with no argument will toggle the value.</p><h5 id=flush class=heading>flush()
|
||||
<a href=#flush class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>Flush writes all buffered input to the sink.</p><h5 id=read---string class=heading>read() -> string
|
||||
<a href=#read---string class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>Reads a liine of input from the sink.</p><h5 id=readall---string class=heading>readAll() -> string
|
||||
<a href=#readall---string class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>Reads all input from the sink.</p><h5 id=writestr class=heading>write(str)
|
||||
<a href=#writestr class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>Writes data to a sink.</p><h5 id=writelnstr class=heading>writeln(str)
|
||||
<a href=#writelnstr class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>Writes data to a sink with a newline at the end.</p></div><div class="footer mt-auto"><p class="card-small text-muted">Want to help improve this page? <a href=https://github.com/Rosettea/Hilbish/issues/new/choose>Create an issue.</a></p></div></container></div><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea © 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>
|
||||
6
versions/readline-move/docs/api/hilbish/index.xml
Normal file
6
versions/readline-move/docs/api/hilbish/index.xml
Normal file
@ -0,0 +1,6 @@
|
||||
<?xml version="1.0" encoding="utf-8" standalone="yes"?><rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Module hilbish on Hilbish</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/</link><description>Recent content in Module hilbish on Hilbish</description><generator>Hugo -- gohugo.io</generator><language>en-us</language><atom:link href="https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/index.xml" rel="self" type="application/rss+xml"/><item><title>Module hilbish.aliases</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.aliases/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.aliases/</guid><description>Introduction The alias interface deals with all command aliases in Hilbish.
|
||||
Functions add(alias, cmd) This is an alias (ha) for the hilbish.alias function. delete(name) Removes an alias. list() -&gt; table[string, string] Get a table of all aliases, with string keys as the alias and the value as the command. resolve(alias) -&gt; string? Resolves an alias to its original command. Will thrown an error if the alias doesn&rsquo;t exist. hilbish.aliases.add(alias, cmd) This is an alias (ha) for the hilbish.</description></item><item><title>Module hilbish.completion</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.completion/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.completion/</guid><description>Introduction The completions interface deals with tab completions.
|
||||
Functions bins(query, ctx, fields) -&gt; entries (table), prefix (string) Return binaries/executables based on the provided parameters. call(name, query, ctx, fields) -&gt; completionGroups (table), prefix (string) Calls a completer function. This is mainly used to call a command completer, which will have a name files(query, ctx, fields) -&gt; entries (table), prefix (string) Returns file matches based on the provided parameters. handler(line, pos) This function contains the general completion handler for Hilbish.</description></item><item><title>Module hilbish.runner</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.runner/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.runner/</guid><description>Introduction The runner interface contains functions that allow the user to change how Hilbish interprets interactive input. Users can add and change the default runner for interactive input to any language or script of their choosing. A good example is using it to write command in Fennel.
|
||||
Runners are functions that evaluate user input. The default runners in Hilbish can run shell script and Lua code.
|
||||
A runner is passed the input and has to return a table with these values.</description></item><item><title>Module hilbish.userDir</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.userdir/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.userdir/</guid><description> Introduction This interface just contains properties to know about certain user directories. It is equivalent to XDG on Linux and gets the user&rsquo;s preferred directories for configs and data.
|
||||
Static module fields config The user&rsquo;s config directory data The user&rsquo;s directory for program data</description></item></channel></rss>
|
||||
5
versions/readline-move/docs/api/index.html
Normal file
5
versions/readline-move/docs/api/index.html
Normal file
@ -0,0 +1,5 @@
|
||||
<!doctype html><html><head><title>API — Hilbish</title><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><meta name=theme-color content="#ff89dd"><meta content="/Hilbish/hilbish-flower.png" property="og:image"><meta property="og:site_name" content="Hilbish"><meta content="API — Hilbish" property="og:title"><meta content="Welcome to the API documentation for Hilbish. This documents Lua functions provided by Hilbish." property="og:description"><meta content="Welcome to the API documentation for Hilbish. This documents Lua functions provided by Hilbish." name=description><meta name=revisit-after content="2 days"><meta name=keywords content="Lua,Hilbish,Linux,Shell"><meta property="og:locale" content="en_GB"><link rel=canonical href=https://rosettea.github.io/Hilbish/><meta property="og:url" content="https://rosettea.github.io/Hilbish/"><link href=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css rel=stylesheet integrity=sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor crossorigin=anonymous><script src=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js integrity=sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2 crossorigin=anonymous></script>
|
||||
<link rel=stylesheet href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" crossorigin=anonymous referrerpolicy=no-referrer><link rel=stylesheet href=/Hilbish/versions/readline-move/css/syntax.min.eb77978873f3b324603120b558a36c98ad57d6ee7b77928e3bc131bd76c5935a.css integrity="sha256-63eXiHPzsyRgMSC1WKNsmK1X1u57d5KOO8ExvXbFk1o="></link><style>.heading>.heading-link{opacity:0}.heading:hover>.heading-link{visibility:visible;opacity:1;transition:all .1s ease-in}@keyframes highlight{0%{background:0 0}50%{background:#fff2cf}100%{background:0 0}}div:target{animation:highlight 1.2s;animation-timing-function:cubic-bezier(1,-.02,.45,.89)}table{border-width:1px;border-style:solid;border-color:#565c64;border-collapse:collapse;margin-bottom:12px}table td{padding:5px}table tr{border-width:1px}thead{display:none}</style></head><body class="d-flex flex-column min-vh-100" style=overflow-x:hidden><svg xmlns="http://www.w3.org/2000/svg" style="display:none"><symbol id="check-circle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="exclamation-triangle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><header><nav class="navbar navbar-expand-md sticky-top bg-light border-bottom"><div class=container-fluid><a class=navbar-brand href=/Hilbish><img src=/Hilbish/hilbish-logo-and-text.png alt height=48></a>
|
||||
<button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
|
||||
<span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/readline-move/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><style>@media(min-width:768px){.sidenav{width:240px}}</style><div class=row><nav class="navbar-expand-md bg-light sidenav border-end"><div class=container><div class="collapse navbar-collapse" id=navbarSupportedContent><nav class="navbar navbar-expand-md bg-light sidenav col" style=margin-top:-20px><ul class="navbar-nav me-auto mb-2 mb-lg-0 flex-column col mt-4"><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link><strong>Introduction</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/getting-started/ class=nav-link><strong>Getting Started</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/faq/ class=nav-link><strong>Frequently Asked Questions</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/ class=nav-link><strong>Features</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/completions/ class=nav-link>Completions</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/notifications/ class=nav-link>Notification</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/opts/ class=nav-link>Options</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/runner-mode/ class=nav-link>Runner Mode</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/ class=nav-link><strong>Signals</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/command/ class=nav-link>Command</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/hilbish/ class=nav-link>Hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/signal/ class=nav-link>Signal</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/lunacolors/ class=nav-link><strong>Lunacolors</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/ class=nav-link><strong>Vim Mode</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/actions/ class=nav-link>Actions</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/ class=nav-link><strong>Nature</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/dirs/ class=nav-link>Module dirs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/doc/ class=nav-link>Module doc</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/ class=nav-link><strong>API</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/bait/ class=nav-link>Module bait</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/commander/ class=nav-link>Module commander</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/fs/ class=nav-link>Module fs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/ class=nav-link>Module hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.aliases/ class=nav-link>Module hilbish.aliases</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.completion/ class=nav-link>Module hilbish.completion</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.runner/ class=nav-link>Module hilbish.runner</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.userdir/ class=nav-link>Module hilbish.userDir</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/readline/ class=nav-link>Module readline</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/snail/ class=nav-link>Module snail</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/terminal/ class=nav-link>Module terminal</a></li></ul></ul></nav></div></div></nav><container class="col mt-2" style="padding-left: 20px; padding-right: 20px;"><div><h1>API</h1><p><em></em></p><p>Welcome to the API documentation for Hilbish. This documents Lua functions
|
||||
provided by Hilbish.</p></div><div class="footer mt-auto"><p class="card-small text-muted">Want to help improve this page? <a href=https://github.com/Rosettea/Hilbish/issues/new/choose>Create an issue.</a></p></div></container></div><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea © 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>
|
||||
12
versions/readline-move/docs/api/index.xml
Normal file
12
versions/readline-move/docs/api/index.xml
Normal file
@ -0,0 +1,12 @@
|
||||
<?xml version="1.0" encoding="utf-8" standalone="yes"?><rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>API on Hilbish</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/</link><description>Recent content in API on Hilbish</description><generator>Hugo -- gohugo.io</generator><language>en-us</language><atom:link href="https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/index.xml" rel="self" type="application/rss+xml"/><item><title>Module bait</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/bait/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/bait/</guid><description>Introduction Bait is the event emitter for Hilbish. Much like Node.js and its events system, many actions in Hilbish emit events. Unlike Node.js, Hilbish events are global. So make sure to pick a unique name!
|
||||
Usage of the Bait module consists of userstanding event-driven architecture, but it&rsquo;s pretty simple: If you want to act on a certain event, you can catch it. You can act on events via callback functions.</description></item><item><title>Module commander</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/commander/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/commander/</guid><description>Introduction Commander is the library which handles Hilbish commands. This makes the user able to add Lua-written commands to their shell without making a separate script in a bin folder. Instead, you may simply use the Commander library in your Hilbish config.
|
||||
1local commander = require &#39;commander&#39; 2 3commander.register(&#39;hello&#39;, function(args, sinks) 4 sinks.out:writeln &#39;Hello world!&#39; 5end) In this example, a command with the name of hello is created that will print Hello world!</description></item><item><title>Module fs</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/fs/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/fs/</guid><description>Introduction The fs module provides filesystem functions to Hilbish. While Lua&rsquo;s standard library has some I/O functions, they&rsquo;re missing a lot of the basics. The fs library offers more functions and will work on any operating system Hilbish does.
|
||||
Functions abs(path) -&gt; string Returns an absolute version of the path. basename(path) -&gt; string Returns the &ldquo;basename,&rdquo; or the last part of the provided path. If path is empty, cd(dir) Changes Hilbish&rsquo;s directory to dir.</description></item><item><title>Module readline</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/readline/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/readline/</guid><description>Introduction This package is designed to be run independently from murex and at some point it will be separated into it&rsquo;s own git repository (at a stage when I am confident that murex will no longer be the primary driver for features, bugs or other code changes)
|
||||
Package terminal provides support functions for dealing with terminals, as commonly found on UNIX systems.
|
||||
Putting a terminal into raw mode is the most common requirement:</description></item><item><title>Module snail</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/snail/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/snail/</guid><description>Introduction The snail library houses Hilbish&rsquo;s Lua wrapper of its shell script interpreter. It&rsquo;s not very useful other than running shell scripts, which can be done with other Hilbish functions.
|
||||
Functions new() -&gt; @Snail Creates a new Snail instance. snail.new() -> Snail Creates a new Snail instance.
|
||||
Parameters This function has no parameters.
|
||||
Types Snail A Snail is a shell script interpreter instance.
|
||||
Methods dir(path) Changes the directory of the snail instance.</description></item><item><title>Module terminal</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/terminal/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/terminal/</guid><description>Introduction The terminal library is a simple and lower level library for certain terminal interactions.
|
||||
Functions restoreState() Restores the last saved state of the terminal saveState() Saves the current state of the terminal. setRaw() Puts the terminal into raw mode. size() Gets the dimensions of the terminal. Returns a table with width and height terminal.restoreState() Restores the last saved state of the terminal
|
||||
Parameters This function has no parameters.</description></item></channel></rss>
|
||||
20
versions/readline-move/docs/api/readline/index.html
Normal file
20
versions/readline-move/docs/api/readline/index.html
Normal file
@ -0,0 +1,20 @@
|
||||
<!doctype html><html><head><title>Module readline — Hilbish</title><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><meta name=theme-color content="#ff89dd"><meta content="/Hilbish/hilbish-flower.png" property="og:image"><meta property="og:site_name" content="Hilbish"><meta content="Module readline — Hilbish" property="og:title"><meta content="Package readline is a pure-Go re-imagining of the UNIX readline API" property="og:description"><meta content="Package readline is a pure-Go re-imagining of the UNIX readline API" name=description><meta name=revisit-after content="2 days"><meta name=keywords content="Lua,Hilbish,Linux,Shell"><meta property="og:locale" content="en_GB"><link rel=canonical href=https://rosettea.github.io/Hilbish/><meta property="og:url" content="https://rosettea.github.io/Hilbish/"><link href=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css rel=stylesheet integrity=sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor crossorigin=anonymous><script src=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js integrity=sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2 crossorigin=anonymous></script>
|
||||
<link rel=stylesheet href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" crossorigin=anonymous referrerpolicy=no-referrer><link rel=stylesheet href=/Hilbish/versions/readline-move/css/syntax.min.eb77978873f3b324603120b558a36c98ad57d6ee7b77928e3bc131bd76c5935a.css integrity="sha256-63eXiHPzsyRgMSC1WKNsmK1X1u57d5KOO8ExvXbFk1o="></link><style>.heading>.heading-link{opacity:0}.heading:hover>.heading-link{visibility:visible;opacity:1;transition:all .1s ease-in}@keyframes highlight{0%{background:0 0}50%{background:#fff2cf}100%{background:0 0}}div:target{animation:highlight 1.2s;animation-timing-function:cubic-bezier(1,-.02,.45,.89)}table{border-width:1px;border-style:solid;border-color:#565c64;border-collapse:collapse;margin-bottom:12px}table td{padding:5px}table tr{border-width:1px}thead{display:none}</style></head><body class="d-flex flex-column min-vh-100" style=overflow-x:hidden><svg xmlns="http://www.w3.org/2000/svg" style="display:none"><symbol id="check-circle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="exclamation-triangle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><header><nav class="navbar navbar-expand-md sticky-top bg-light border-bottom"><div class=container-fluid><a class=navbar-brand href=/Hilbish><img src=/Hilbish/hilbish-logo-and-text.png alt height=48></a>
|
||||
<button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
|
||||
<span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/readline-move/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><style>@media(min-width:768px){.sidenav{width:240px}}</style><div class=row><nav class="navbar-expand-md bg-light sidenav border-end"><div class=container><div class="collapse navbar-collapse" id=navbarSupportedContent><nav class="navbar navbar-expand-md bg-light sidenav col" style=margin-top:-20px><ul class="navbar-nav me-auto mb-2 mb-lg-0 flex-column col mt-4"><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link><strong>Introduction</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/getting-started/ class=nav-link><strong>Getting Started</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/faq/ class=nav-link><strong>Frequently Asked Questions</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/ class=nav-link><strong>Features</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/completions/ class=nav-link>Completions</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/notifications/ class=nav-link>Notification</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/opts/ class=nav-link>Options</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/runner-mode/ class=nav-link>Runner Mode</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/ class=nav-link><strong>Signals</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/command/ class=nav-link>Command</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/hilbish/ class=nav-link>Hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/signal/ class=nav-link>Signal</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/lunacolors/ class=nav-link><strong>Lunacolors</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/ class=nav-link><strong>Vim Mode</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/actions/ class=nav-link>Actions</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/ class=nav-link><strong>Nature</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/dirs/ class=nav-link>Module dirs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/doc/ class=nav-link>Module doc</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/ class=nav-link><strong>API</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/bait/ class=nav-link>Module bait</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/commander/ class=nav-link>Module commander</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/fs/ class=nav-link>Module fs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/ class=nav-link>Module hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.aliases/ class=nav-link>Module hilbish.aliases</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.completion/ class=nav-link>Module hilbish.completion</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.runner/ class=nav-link>Module hilbish.runner</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.userdir/ class=nav-link>Module hilbish.userDir</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/readline/ class=nav-link>Module readline</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/snail/ class=nav-link>Module snail</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/terminal/ class=nav-link>Module terminal</a></li></ul></ul></nav></div></div></nav><container class="col mt-2" style="padding-left: 20px; padding-right: 20px;"><div><h1>Module readline</h1><p><em>Package readline is a pure-Go re-imagining of the UNIX readline API<br></em></p><h3 id=introduction class=heading>Introduction
|
||||
<a href=#introduction class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>This package is designed to be run independently from murex and at some
|
||||
point it will be separated into it’s own git repository (at a stage when I
|
||||
am confident that murex will no longer be the primary driver for features,
|
||||
bugs or other code changes)</p><p>Package terminal provides support functions for dealing with terminals, as
|
||||
commonly found on UNIX systems.</p><p>Putting a terminal into raw mode is the most common requirement:</p><pre><code>oldState, err := terminal.MakeRaw(0)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
defer terminal.Restore(0, oldState)
|
||||
</code></pre><p>Package terminal provides support functions for dealing with terminals, as
|
||||
commonly found on UNIX systems.</p><p>Putting a terminal into raw mode is the most common requirement:</p><pre><code>oldState, err := terminal.MakeRaw(0)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
defer terminal.Restore(0, oldState)
|
||||
</code></pre></div><div class="footer mt-auto"><p class="card-small text-muted">Want to help improve this page? <a href=https://github.com/Rosettea/Hilbish/issues/new/choose>Create an issue.</a></p></div></container></div><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea © 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>
|
||||
17
versions/readline-move/docs/api/snail/index.html
Normal file
17
versions/readline-move/docs/api/snail/index.html
Normal file
@ -0,0 +1,17 @@
|
||||
<!doctype html><html><head><title>Module snail — Hilbish</title><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><meta name=theme-color content="#ff89dd"><meta content="/Hilbish/hilbish-flower.png" property="og:image"><meta property="og:site_name" content="Hilbish"><meta content="Module snail — Hilbish" property="og:title"><meta content="shell script interpreter library" property="og:description"><meta content="shell script interpreter library" name=description><meta name=revisit-after content="2 days"><meta name=keywords content="Lua,Hilbish,Linux,Shell"><meta property="og:locale" content="en_GB"><link rel=canonical href=https://rosettea.github.io/Hilbish/><meta property="og:url" content="https://rosettea.github.io/Hilbish/"><link href=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css rel=stylesheet integrity=sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor crossorigin=anonymous><script src=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js integrity=sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2 crossorigin=anonymous></script>
|
||||
<link rel=stylesheet href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" crossorigin=anonymous referrerpolicy=no-referrer><link rel=stylesheet href=/Hilbish/versions/readline-move/css/syntax.min.eb77978873f3b324603120b558a36c98ad57d6ee7b77928e3bc131bd76c5935a.css integrity="sha256-63eXiHPzsyRgMSC1WKNsmK1X1u57d5KOO8ExvXbFk1o="></link><style>.heading>.heading-link{opacity:0}.heading:hover>.heading-link{visibility:visible;opacity:1;transition:all .1s ease-in}@keyframes highlight{0%{background:0 0}50%{background:#fff2cf}100%{background:0 0}}div:target{animation:highlight 1.2s;animation-timing-function:cubic-bezier(1,-.02,.45,.89)}table{border-width:1px;border-style:solid;border-color:#565c64;border-collapse:collapse;margin-bottom:12px}table td{padding:5px}table tr{border-width:1px}thead{display:none}</style></head><body class="d-flex flex-column min-vh-100" style=overflow-x:hidden><svg xmlns="http://www.w3.org/2000/svg" style="display:none"><symbol id="check-circle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="exclamation-triangle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><header><nav class="navbar navbar-expand-md sticky-top bg-light border-bottom"><div class=container-fluid><a class=navbar-brand href=/Hilbish><img src=/Hilbish/hilbish-logo-and-text.png alt height=48></a>
|
||||
<button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
|
||||
<span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/readline-move/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><style>@media(min-width:768px){.sidenav{width:240px}}</style><div class=row><nav class="navbar-expand-md bg-light sidenav border-end"><div class=container><div class="collapse navbar-collapse" id=navbarSupportedContent><nav class="navbar navbar-expand-md bg-light sidenav col" style=margin-top:-20px><ul class="navbar-nav me-auto mb-2 mb-lg-0 flex-column col mt-4"><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link><strong>Introduction</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/getting-started/ class=nav-link><strong>Getting Started</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/faq/ class=nav-link><strong>Frequently Asked Questions</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/ class=nav-link><strong>Features</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/completions/ class=nav-link>Completions</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/notifications/ class=nav-link>Notification</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/opts/ class=nav-link>Options</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/runner-mode/ class=nav-link>Runner Mode</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/ class=nav-link><strong>Signals</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/command/ class=nav-link>Command</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/hilbish/ class=nav-link>Hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/signal/ class=nav-link>Signal</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/lunacolors/ class=nav-link><strong>Lunacolors</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/ class=nav-link><strong>Vim Mode</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/actions/ class=nav-link>Actions</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/ class=nav-link><strong>Nature</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/dirs/ class=nav-link>Module dirs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/doc/ class=nav-link>Module doc</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/ class=nav-link><strong>API</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/bait/ class=nav-link>Module bait</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/commander/ class=nav-link>Module commander</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/fs/ class=nav-link>Module fs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/ class=nav-link>Module hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.aliases/ class=nav-link>Module hilbish.aliases</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.completion/ class=nav-link>Module hilbish.completion</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.runner/ class=nav-link>Module hilbish.runner</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.userdir/ class=nav-link>Module hilbish.userDir</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/readline/ class=nav-link>Module readline</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/snail/ class=nav-link>Module snail</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/terminal/ class=nav-link>Module terminal</a></li></ul></ul></nav></div></div></nav><container class="col mt-2" style="padding-left: 20px; padding-right: 20px;"><div><h1>Module snail</h1><p><em>shell script interpreter library<br></em></p><h3 id=introduction class=heading>Introduction
|
||||
<a href=#introduction class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>The snail library houses Hilbish’s Lua wrapper of its shell script interpreter.
|
||||
It’s not very useful other than running shell scripts, which can be done with other
|
||||
Hilbish functions.</p><h3 id=functions class=heading>Functions
|
||||
<a href=#functions class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><a href=#new>new() -> @Snail</a></td><td>Creates a new Snail instance.</td></tr></tbody></table><hr><div id=new><h4 class=heading>snail.new() -> <a href=/Hilbish/docs/api/snail/#snail style=text-decoration:none id=lol>Snail</a>
|
||||
<a href=#new class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Creates a new Snail instance.</p><h5 id=parameters class=heading>Parameters
|
||||
<a href=#parameters class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><h3 id=types class=heading>Types
|
||||
<a href=#types class=heading-link><i class="fas fa-paperclip"></i></a></h3><hr><h3 id=snail class=heading>Snail
|
||||
<a href=#snail class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>A Snail is a shell script interpreter instance.</p><h4 id=methods class=heading>Methods
|
||||
<a href=#methods class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=dirpath class=heading>dir(path)
|
||||
<a href=#dirpath class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>Changes the directory of the snail instance.
|
||||
The interpreter keeps its set directory even when the Hilbish process changes
|
||||
directory, so this should be called on the <code>hilbish.cd</code> hook.</p><h5 id=runcommand-streams class=heading>run(command, streams)
|
||||
<a href=#runcommand-streams class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>Runs a shell command. Works the same as <code>hilbish.run</code>, but only accepts a table of streams.</p></div><div class="footer mt-auto"><p class="card-small text-muted">Want to help improve this page? <a href=https://github.com/Rosettea/Hilbish/issues/new/choose>Create an issue.</a></p></div></container></div><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea © 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>
|
||||
14
versions/readline-move/docs/api/terminal/index.html
Normal file
14
versions/readline-move/docs/api/terminal/index.html
Normal file
@ -0,0 +1,14 @@
|
||||
<!doctype html><html><head><title>Module terminal — Hilbish</title><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><meta name=theme-color content="#ff89dd"><meta content="/Hilbish/hilbish-flower.png" property="og:image"><meta property="og:site_name" content="Hilbish"><meta content="Module terminal — Hilbish" property="og:title"><meta content="low level terminal library" property="og:description"><meta content="low level terminal library" name=description><meta name=revisit-after content="2 days"><meta name=keywords content="Lua,Hilbish,Linux,Shell"><meta property="og:locale" content="en_GB"><link rel=canonical href=https://rosettea.github.io/Hilbish/><meta property="og:url" content="https://rosettea.github.io/Hilbish/"><link href=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css rel=stylesheet integrity=sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor crossorigin=anonymous><script src=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js integrity=sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2 crossorigin=anonymous></script>
|
||||
<link rel=stylesheet href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" crossorigin=anonymous referrerpolicy=no-referrer><link rel=stylesheet href=/Hilbish/versions/readline-move/css/syntax.min.eb77978873f3b324603120b558a36c98ad57d6ee7b77928e3bc131bd76c5935a.css integrity="sha256-63eXiHPzsyRgMSC1WKNsmK1X1u57d5KOO8ExvXbFk1o="></link><style>.heading>.heading-link{opacity:0}.heading:hover>.heading-link{visibility:visible;opacity:1;transition:all .1s ease-in}@keyframes highlight{0%{background:0 0}50%{background:#fff2cf}100%{background:0 0}}div:target{animation:highlight 1.2s;animation-timing-function:cubic-bezier(1,-.02,.45,.89)}table{border-width:1px;border-style:solid;border-color:#565c64;border-collapse:collapse;margin-bottom:12px}table td{padding:5px}table tr{border-width:1px}thead{display:none}</style></head><body class="d-flex flex-column min-vh-100" style=overflow-x:hidden><svg xmlns="http://www.w3.org/2000/svg" style="display:none"><symbol id="check-circle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="exclamation-triangle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><header><nav class="navbar navbar-expand-md sticky-top bg-light border-bottom"><div class=container-fluid><a class=navbar-brand href=/Hilbish><img src=/Hilbish/hilbish-logo-and-text.png alt height=48></a>
|
||||
<button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
|
||||
<span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/readline-move/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><style>@media(min-width:768px){.sidenav{width:240px}}</style><div class=row><nav class="navbar-expand-md bg-light sidenav border-end"><div class=container><div class="collapse navbar-collapse" id=navbarSupportedContent><nav class="navbar navbar-expand-md bg-light sidenav col" style=margin-top:-20px><ul class="navbar-nav me-auto mb-2 mb-lg-0 flex-column col mt-4"><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link><strong>Introduction</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/getting-started/ class=nav-link><strong>Getting Started</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/faq/ class=nav-link><strong>Frequently Asked Questions</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/ class=nav-link><strong>Features</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/completions/ class=nav-link>Completions</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/notifications/ class=nav-link>Notification</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/opts/ class=nav-link>Options</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/runner-mode/ class=nav-link>Runner Mode</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/ class=nav-link><strong>Signals</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/command/ class=nav-link>Command</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/hilbish/ class=nav-link>Hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/signal/ class=nav-link>Signal</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/lunacolors/ class=nav-link><strong>Lunacolors</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/ class=nav-link><strong>Vim Mode</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/actions/ class=nav-link>Actions</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/ class=nav-link><strong>Nature</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/dirs/ class=nav-link>Module dirs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/doc/ class=nav-link>Module doc</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/ class=nav-link><strong>API</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/bait/ class=nav-link>Module bait</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/commander/ class=nav-link>Module commander</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/fs/ class=nav-link>Module fs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/ class=nav-link>Module hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.aliases/ class=nav-link>Module hilbish.aliases</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.completion/ class=nav-link>Module hilbish.completion</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.runner/ class=nav-link>Module hilbish.runner</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.userdir/ class=nav-link>Module hilbish.userDir</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/readline/ class=nav-link>Module readline</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/snail/ class=nav-link>Module snail</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/terminal/ class=nav-link>Module terminal</a></li></ul></ul></nav></div></div></nav><container class="col mt-2" style="padding-left: 20px; padding-right: 20px;"><div><h1>Module terminal</h1><p><em>low level terminal library<br></em></p><h3 id=introduction class=heading>Introduction
|
||||
<a href=#introduction class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>The terminal library is a simple and lower level library for certain terminal interactions.</p><h3 id=functions class=heading>Functions
|
||||
<a href=#functions class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><a href=#restoreState>restoreState()</a></td><td>Restores the last saved state of the terminal</td></tr><tr><td><a href=#saveState>saveState()</a></td><td>Saves the current state of the terminal.</td></tr><tr><td><a href=#setRaw>setRaw()</a></td><td>Puts the terminal into raw mode.</td></tr><tr><td><a href=#size>size()</a></td><td>Gets the dimensions of the terminal. Returns a table with <code>width</code> and <code>height</code></td></tr></tbody></table><hr><div id=restoreState><h4 class=heading>terminal.restoreState()
|
||||
<a href=#restoreState class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Restores the last saved state of the terminal</p><h5 id=parameters class=heading>Parameters
|
||||
<a href=#parameters class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=saveState><h4 class=heading>terminal.saveState()
|
||||
<a href=#saveState class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Saves the current state of the terminal.</p><h5 id=parameters-1 class=heading>Parameters
|
||||
<a href=#parameters-1 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=setRaw><h4 class=heading>terminal.setRaw()
|
||||
<a href=#setRaw class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Puts the terminal into raw mode.</p><h5 id=parameters-2 class=heading>Parameters
|
||||
<a href=#parameters-2 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div><hr><div id=size><h4 class=heading>terminal.size()
|
||||
<a href=#size class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Gets the dimensions of the terminal. Returns a table with <code>width</code> and <code>height</code><br>NOTE: The size refers to the amount of columns and rows of text that can fit in the terminal.</p><h5 id=parameters-3 class=heading>Parameters
|
||||
<a href=#parameters-3 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This function has no parameters.</p></div></div><div class="footer mt-auto"><p class="card-small text-muted">Want to help improve this page? <a href=https://github.com/Rosettea/Hilbish/issues/new/choose>Create an issue.</a></p></div></container></div><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea © 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>
|
||||
72
versions/readline-move/docs/completions/index.html
Normal file
72
versions/readline-move/docs/completions/index.html
Normal file
@ -0,0 +1,72 @@
|
||||
<!doctype html><html><head><title>Completions — Hilbish</title><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><meta name=theme-color content="#ff89dd"><meta content="/Hilbish/hilbish-flower.png" property="og:image"><meta property="og:site_name" content="Hilbish"><meta content="Completions — Hilbish" property="og:title"><meta content="Tab completion for commands." property="og:description"><meta content="Tab completion for commands." name=description><meta name=revisit-after content="2 days"><meta name=keywords content="Lua,Hilbish,Linux,Shell"><meta property="og:locale" content="en_GB"><link rel=canonical href=https://rosettea.github.io/Hilbish/><meta property="og:url" content="https://rosettea.github.io/Hilbish/"><link href=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css rel=stylesheet integrity=sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor crossorigin=anonymous><script src=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js integrity=sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2 crossorigin=anonymous></script>
|
||||
<link rel=stylesheet href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" crossorigin=anonymous referrerpolicy=no-referrer><link rel=stylesheet href=/Hilbish/versions/readline-move/css/syntax.min.eb77978873f3b324603120b558a36c98ad57d6ee7b77928e3bc131bd76c5935a.css integrity="sha256-63eXiHPzsyRgMSC1WKNsmK1X1u57d5KOO8ExvXbFk1o="></link><style>.heading>.heading-link{opacity:0}.heading:hover>.heading-link{visibility:visible;opacity:1;transition:all .1s ease-in}@keyframes highlight{0%{background:0 0}50%{background:#fff2cf}100%{background:0 0}}div:target{animation:highlight 1.2s;animation-timing-function:cubic-bezier(1,-.02,.45,.89)}table{border-width:1px;border-style:solid;border-color:#565c64;border-collapse:collapse;margin-bottom:12px}table td{padding:5px}table tr{border-width:1px}thead{display:none}</style></head><body class="d-flex flex-column min-vh-100" style=overflow-x:hidden><svg xmlns="http://www.w3.org/2000/svg" style="display:none"><symbol id="check-circle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="exclamation-triangle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><header><nav class="navbar navbar-expand-md sticky-top bg-light border-bottom"><div class=container-fluid><a class=navbar-brand href=/Hilbish><img src=/Hilbish/hilbish-logo-and-text.png alt height=48></a>
|
||||
<button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
|
||||
<span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/readline-move/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><style>@media(min-width:768px){.sidenav{width:240px}}</style><div class=row><nav class="navbar-expand-md bg-light sidenav border-end"><div class=container><div class="collapse navbar-collapse" id=navbarSupportedContent><nav class="navbar navbar-expand-md bg-light sidenav col" style=margin-top:-20px><ul class="navbar-nav me-auto mb-2 mb-lg-0 flex-column col mt-4"><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link><strong>Introduction</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/getting-started/ class=nav-link><strong>Getting Started</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/faq/ class=nav-link><strong>Frequently Asked Questions</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/ class=nav-link><strong>Features</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/completions/ class=nav-link>Completions</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/notifications/ class=nav-link>Notification</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/opts/ class=nav-link>Options</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/runner-mode/ class=nav-link>Runner Mode</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/ class=nav-link><strong>Signals</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/command/ class=nav-link>Command</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/hilbish/ class=nav-link>Hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/signal/ class=nav-link>Signal</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/lunacolors/ class=nav-link><strong>Lunacolors</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/ class=nav-link><strong>Vim Mode</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/actions/ class=nav-link>Actions</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/ class=nav-link><strong>Nature</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/dirs/ class=nav-link>Module dirs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/doc/ class=nav-link>Module doc</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/ class=nav-link><strong>API</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/bait/ class=nav-link>Module bait</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/commander/ class=nav-link>Module commander</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/fs/ class=nav-link>Module fs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/ class=nav-link>Module hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.aliases/ class=nav-link>Module hilbish.aliases</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.completion/ class=nav-link>Module hilbish.completion</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.runner/ class=nav-link>Module hilbish.runner</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.userdir/ class=nav-link>Module hilbish.userDir</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/readline/ class=nav-link>Module readline</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/snail/ class=nav-link>Module snail</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/terminal/ class=nav-link>Module terminal</a></li></ul></ul></nav></div></div></nav><container class="col mt-2" style="padding-left: 20px; padding-right: 20px;"><div><h1>Completions</h1><p><em>Tab completion for commands.<br></em></p><p>Completions for commands can be created with the <a href=../api/hilbish#complete><code>hilbish.complete</code></a>
|
||||
function. See the link for how to use it.</p><p>To create completions for a command is simple.
|
||||
The callback will be passed 3 parameters:</p><ul><li><code>query</code> (string): The text that the user is currently trying to complete.
|
||||
This should be used to match entries.</li><li><code>ctx</code> (string): Contains the entire line. Use this if
|
||||
more text is needed to be parsed for context.</li><li><code>fields</code> (string): The <code>ctx</code> split up by spaces.</li></ul><p>In most cases, the completer just uses <code>fields</code> to check the amount
|
||||
and <code>query</code> on what to match entries on.</p><p>In order to return your results, it has to go within a “completion group.”
|
||||
Then you return a table of completion groups and a prefix. The prefix will
|
||||
usually just be the <code>query</code>.</p><p>Hilbish allows one to mix completion menus of different types, so
|
||||
a grid menu and a list menu can be used and complete and display at the same time.
|
||||
A completion group is a table with these keys:</p><ul><li><code>type</code> (string): type of completion menu, either <code>grid</code> or <code>list</code>.</li><li><code>items</code> (table): a list of items.</li></ul><p>The requirements of the <code>items</code> table is different based on the
|
||||
<code>type</code>. If it is a <code>grid</code>, it can simply be a table of strings.</p><p>Otherwise if it is a <code>list</code> then each entry can
|
||||
either be a string or a table.
|
||||
Example:</p><div class=highlight><pre tabindex=0 class=chroma><code class=language-lua data-lang=lua><span class=line><span class=ln> 1</span><span class=cl><span class=kd>local</span> <span class=n>cg</span> <span class=o>=</span> <span class=p>{</span>
|
||||
</span></span><span class=line><span class=ln> 2</span><span class=cl> <span class=n>items</span> <span class=o>=</span> <span class=p>{</span>
|
||||
</span></span><span class=line><span class=ln> 3</span><span class=cl> <span class=s1>'list item 1'</span><span class=p>,</span>
|
||||
</span></span><span class=line><span class=ln> 4</span><span class=cl> <span class=p>[</span><span class=s1>'--command-flag-here'</span><span class=p>]</span> <span class=o>=</span> <span class=p>{</span><span class=s1>'this does a thing'</span><span class=p>,</span> <span class=s1>'--the-flag-alias'</span><span class=p>}</span>
|
||||
</span></span><span class=line><span class=ln> 5</span><span class=cl> <span class=p>},</span>
|
||||
</span></span><span class=line><span class=ln> 6</span><span class=cl> <span class=n>type</span> <span class=o>=</span> <span class=s1>'list'</span>
|
||||
</span></span><span class=line><span class=ln> 7</span><span class=cl><span class=p>}</span>
|
||||
</span></span><span class=line><span class=ln> 8</span><span class=cl><span class=kd>local</span> <span class=n>cg2</span> <span class=o>=</span> <span class=p>{</span>
|
||||
</span></span><span class=line><span class=ln> 9</span><span class=cl> <span class=n>items</span> <span class=o>=</span> <span class=p>{</span><span class=s1>'just'</span><span class=p>,</span> <span class=s1>'a bunch'</span><span class=p>,</span> <span class=s1>'of items'</span><span class=p>,</span> <span class=s1>'here'</span><span class=p>,</span> <span class=s1>'hehe'</span><span class=p>},</span>
|
||||
</span></span><span class=line><span class=ln>10</span><span class=cl> <span class=n>type</span> <span class=o>=</span> <span class=s1>'grid'</span>
|
||||
</span></span><span class=line><span class=ln>11</span><span class=cl><span class=p>}</span>
|
||||
</span></span><span class=line><span class=ln>12</span><span class=cl>
|
||||
</span></span><span class=line><span class=ln>13</span><span class=cl><span class=kr>return</span> <span class=p>{</span><span class=n>cg</span><span class=p>,</span> <span class=n>cg2</span><span class=p>},</span> <span class=n>prefix</span>
|
||||
</span></span></code></pre></div><p>Which looks like this:<br><video src=https://safe.saya.moe/t4CiLK6dgPbD.mp4 style=height:auto;max-width:100% controls>
|
||||
There's a video missing here...
|
||||
Well here is the URL: https://safe.saya.moe/t4CiLK6dgPbD.mp4</video></p><h2 id=completion-group-types class=heading>Completion Group Types
|
||||
<a href=#completion-group-types class=heading-link><i class="fas fa-paperclip"></i></a></h2><h4 id=grid class=heading>grid
|
||||
<a href=#grid class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Grid is the simplest completion group type. All items are strings and when
|
||||
completion is done is displayed in a grid based on size.</p><p>Example:</p><div class=highlight><pre tabindex=0 class=chroma><code class=language-lua data-lang=lua><span class=line><span class=ln>1</span><span class=cl><span class=p>{</span>
|
||||
</span></span><span class=line><span class=ln>2</span><span class=cl> <span class=n>items</span> <span class=o>=</span> <span class=p>{</span><span class=s1>'just'</span><span class=p>,</span> <span class=s1>'a bunch'</span><span class=p>,</span> <span class=s1>'of items'</span><span class=p>,</span> <span class=s1>'here'</span><span class=p>,</span> <span class=s1>'hehe'</span><span class=p>},</span>
|
||||
</span></span><span class=line><span class=ln>3</span><span class=cl> <span class=n>type</span> <span class=o>=</span> <span class=s1>'grid'</span>
|
||||
</span></span><span class=line><span class=ln>4</span><span class=cl><span class=p>}</span>
|
||||
</span></span></code></pre></div><h4 id=list class=heading>list
|
||||
<a href=#list class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>The list completion group type displays in a list. A list item can either be a string, or a table for additional display options.
|
||||
A completion alias can be specified either as the <code>2nd</code> entry in the options table
|
||||
or te <code>alias</code> key.</p><p>A description can optionally be displayed for a list item, which is either the <code>1st</code>
|
||||
entry or the <code>description</code> key.</p><p>Lastly, list entries can be styled. This is done with the <code>display</code> key. If this is present, this
|
||||
overrides what the completion item <em>looks</em> like.</p><p>Example:</p><div class=highlight><pre tabindex=0 class=chroma><code class=language-lua data-lang=lua><span class=line><span class=ln> 1</span><span class=cl><span class=p>{</span>
|
||||
</span></span><span class=line><span class=ln> 2</span><span class=cl> <span class=n>items</span> <span class=o>=</span> <span class=p>{</span>
|
||||
</span></span><span class=line><span class=ln> 3</span><span class=cl> <span class=p>[</span><span class=s1>'--flag'</span><span class=p>]</span> <span class=o>=</span> <span class=p>{</span>
|
||||
</span></span><span class=line><span class=ln> 4</span><span class=cl> <span class=n>description</span> <span class=o>=</span> <span class=s1>'this flag nukes the bri ish'</span><span class=p>,</span>
|
||||
</span></span><span class=line><span class=ln> 5</span><span class=cl> <span class=n>alias</span> <span class=o>=</span> <span class=s1>'--bye-bri-ish'</span><span class=p>,</span>
|
||||
</span></span><span class=line><span class=ln> 6</span><span class=cl> <span class=n>display</span> <span class=o>=</span> <span class=n>lunacolors.format</span><span class=p>(</span><span class=s1>'--{blue}fl{red}ag'</span><span class=p>)</span>
|
||||
</span></span><span class=line><span class=ln> 7</span><span class=cl> <span class=p>},</span>
|
||||
</span></span><span class=line><span class=ln> 8</span><span class=cl> <span class=p>[</span><span class=s1>'--flag2'</span><span class=p>]</span> <span class=o>=</span> <span class=p>{</span>
|
||||
</span></span><span class=line><span class=ln> 9</span><span class=cl> <span class=s1>'make pizza'</span><span class=p>,</span> <span class=c1>-- description</span>
|
||||
</span></span><span class=line><span class=ln>10</span><span class=cl> <span class=s1>'--pizzuh'</span><span class=p>,</span> <span class=c1>-- alias</span>
|
||||
</span></span><span class=line><span class=ln>11</span><span class=cl> <span class=n>display</span> <span class=o>=</span> <span class=n>lunacolors.yellow</span> <span class=s1>'--pizzuh'</span>
|
||||
</span></span><span class=line><span class=ln>12</span><span class=cl> <span class=p>},</span>
|
||||
</span></span><span class=line><span class=ln>13</span><span class=cl> <span class=s1>'--flag3'</span>
|
||||
</span></span><span class=line><span class=ln>14</span><span class=cl> <span class=p>},</span>
|
||||
</span></span><span class=line><span class=ln>15</span><span class=cl> <span class=n>type</span> <span class=o>=</span> <span class=s1>'list'</span>
|
||||
</span></span><span class=line><span class=ln>16</span><span class=cl><span class=p>}</span>
|
||||
</span></span></code></pre></div><h2 id=completion-handler class=heading>Completion Handler
|
||||
<a href=#completion-handler class=heading-link><i class="fas fa-paperclip"></i></a></h2><p>Like most parts of Hilbish, it’s made to be extensible and
|
||||
customizable. The default handler for completions in general can
|
||||
be overwritten to provide more advanced completions if needed.
|
||||
This usually doesn’t need to be done though, unless you know
|
||||
what you’re doing.</p><p>The default completion handler provides 3 things:
|
||||
binaries (with a plain name requested to complete, those in
|
||||
$PATH), files, or command completions. It will try to run a handler
|
||||
for the command or fallback to file completions.</p><p>To overwrite it, just assign a function to <code>hilbish.completion.handler</code> like so:</p><div class=highlight><pre tabindex=0 class=chroma><code class=language-lua data-lang=lua><span class=line><span class=ln>1</span><span class=cl><span class=c1>-- line is the entire line as a string</span>
|
||||
</span></span><span class=line><span class=ln>2</span><span class=cl><span class=c1>-- pos is the position of the cursor.</span>
|
||||
</span></span><span class=line><span class=ln>3</span><span class=cl><span class=kr>function</span> <span class=nc>hilbish</span><span class=p>.</span><span class=nc>completion</span><span class=p>.</span><span class=nf>handler</span><span class=p>(</span><span class=n>line</span><span class=p>,</span> <span class=n>pos</span><span class=p>)</span>
|
||||
</span></span><span class=line><span class=ln>4</span><span class=cl> <span class=c1>-- do things</span>
|
||||
</span></span><span class=line><span class=ln>5</span><span class=cl><span class=kr>end</span>
|
||||
</span></span></code></pre></div></div><div class="footer mt-auto"><p class="card-small text-muted">Want to help improve this page? <a href=https://github.com/Rosettea/Hilbish/issues/new/choose>Create an issue.</a></p></div></container></div><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea © 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>
|
||||
21
versions/readline-move/docs/faq/index.html
Normal file
21
versions/readline-move/docs/faq/index.html
Normal file
@ -0,0 +1,21 @@
|
||||
<!doctype html><html><head><title>Frequently Asked Questions — Hilbish</title><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><meta name=theme-color content="#ff89dd"><meta content="/Hilbish/hilbish-flower.png" property="og:image"><meta property="og:site_name" content="Hilbish"><meta content="Frequently Asked Questions — Hilbish" property="og:title"><meta content="Is Hilbish POSIX compliant? No, it is not. POSIX compliance is a non-goal. Perhaps in the future, someone would be able to write a native plugin to support shell scripting (which would be against it’s main goal, but ….)
|
||||
Windows Support? It compiles for Windows (CI ensures it does), but otherwise it is not directly supported. If you’d like to improve this situation, checkout the discussion .
|
||||
Why? Hilbish emerged from the desire of a Lua configured shell." property="og:description"><meta content="Is Hilbish POSIX compliant? No, it is not. POSIX compliance is a non-goal. Perhaps in the future, someone would be able to write a native plugin to support shell scripting (which would be against it’s main goal, but ….)
|
||||
Windows Support? It compiles for Windows (CI ensures it does), but otherwise it is not directly supported. If you’d like to improve this situation, checkout the discussion .
|
||||
Why? Hilbish emerged from the desire of a Lua configured shell." name=description><meta name=revisit-after content="2 days"><meta name=keywords content="Lua,Hilbish,Linux,Shell"><meta property="og:locale" content="en_GB"><link rel=canonical href=https://rosettea.github.io/Hilbish/><meta property="og:url" content="https://rosettea.github.io/Hilbish/"><link href=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css rel=stylesheet integrity=sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor crossorigin=anonymous><script src=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js integrity=sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2 crossorigin=anonymous></script>
|
||||
<link rel=stylesheet href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" crossorigin=anonymous referrerpolicy=no-referrer><link rel=stylesheet href=/Hilbish/versions/readline-move/css/syntax.min.eb77978873f3b324603120b558a36c98ad57d6ee7b77928e3bc131bd76c5935a.css integrity="sha256-63eXiHPzsyRgMSC1WKNsmK1X1u57d5KOO8ExvXbFk1o="></link><style>.heading>.heading-link{opacity:0}.heading:hover>.heading-link{visibility:visible;opacity:1;transition:all .1s ease-in}@keyframes highlight{0%{background:0 0}50%{background:#fff2cf}100%{background:0 0}}div:target{animation:highlight 1.2s;animation-timing-function:cubic-bezier(1,-.02,.45,.89)}table{border-width:1px;border-style:solid;border-color:#565c64;border-collapse:collapse;margin-bottom:12px}table td{padding:5px}table tr{border-width:1px}thead{display:none}</style></head><body class="d-flex flex-column min-vh-100" style=overflow-x:hidden><svg xmlns="http://www.w3.org/2000/svg" style="display:none"><symbol id="check-circle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="exclamation-triangle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><header><nav class="navbar navbar-expand-md sticky-top bg-light border-bottom"><div class=container-fluid><a class=navbar-brand href=/Hilbish><img src=/Hilbish/hilbish-logo-and-text.png alt height=48></a>
|
||||
<button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
|
||||
<span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/readline-move/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><style>@media(min-width:768px){.sidenav{width:240px}}</style><div class=row><nav class="navbar-expand-md bg-light sidenav border-end"><div class=container><div class="collapse navbar-collapse" id=navbarSupportedContent><nav class="navbar navbar-expand-md bg-light sidenav col" style=margin-top:-20px><ul class="navbar-nav me-auto mb-2 mb-lg-0 flex-column col mt-4"><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link><strong>Introduction</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/getting-started/ class=nav-link><strong>Getting Started</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/faq/ class=nav-link><strong>Frequently Asked Questions</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/ class=nav-link><strong>Features</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/completions/ class=nav-link>Completions</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/notifications/ class=nav-link>Notification</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/opts/ class=nav-link>Options</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/runner-mode/ class=nav-link>Runner Mode</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/ class=nav-link><strong>Signals</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/command/ class=nav-link>Command</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/hilbish/ class=nav-link>Hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/signal/ class=nav-link>Signal</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/lunacolors/ class=nav-link><strong>Lunacolors</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/ class=nav-link><strong>Vim Mode</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/actions/ class=nav-link>Actions</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/ class=nav-link><strong>Nature</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/dirs/ class=nav-link>Module dirs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/doc/ class=nav-link>Module doc</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/ class=nav-link><strong>API</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/bait/ class=nav-link>Module bait</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/commander/ class=nav-link>Module commander</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/fs/ class=nav-link>Module fs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/ class=nav-link>Module hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.aliases/ class=nav-link>Module hilbish.aliases</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.completion/ class=nav-link>Module hilbish.completion</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.runner/ class=nav-link>Module hilbish.runner</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.userdir/ class=nav-link>Module hilbish.userDir</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/readline/ class=nav-link>Module readline</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/snail/ class=nav-link>Module snail</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/terminal/ class=nav-link>Module terminal</a></li></ul></ul></nav></div></div></nav><container class="col mt-2" style="padding-left: 20px; padding-right: 20px;"><div><h1>Frequently Asked Questions</h1><p><em>Last updated Dec 26, 2023<br></em></p><h2 id=is-hilbish-posix-compliant class=heading>Is Hilbish POSIX compliant?
|
||||
<a href=#is-hilbish-posix-compliant class=heading-link><i class="fas fa-paperclip"></i></a></h2><p>No, it is not. POSIX compliance is a non-goal. Perhaps in the future,
|
||||
someone would be able to write a native plugin to support shell scripting
|
||||
(which would be against it’s main goal, but ….)</p><h2 id=windows-support class=heading>Windows Support?
|
||||
<a href=#windows-support class=heading-link><i class="fas fa-paperclip"></i></a></h2><p>It compiles for Windows (CI ensures it does), but otherwise it is not
|
||||
directly supported. If you’d like to improve this situation,
|
||||
checkout <a href=https://github.com/Rosettea/Hilbish/discussions/165 target=_blank rel=noopener>the discussion</a>
|
||||
.</p><h2 id=why class=heading>Why?
|
||||
<a href=#why class=heading-link><i class="fas fa-paperclip"></i></a></h2><p>Hilbish emerged from the desire of a Lua configured shell.
|
||||
It was the initial reason that it was created, but now it’s more:
|
||||
to be hyper extensible, simpler and more user friendly.</p><h2 id=does-it-have-autocompletion-or-tab-completion class=heading>Does it have “autocompletion” or “tab completion”
|
||||
<a href=#does-it-have-autocompletion-or-tab-completion class=heading-link><i class="fas fa-paperclip"></i></a></h2><p>Of course! This is a modern shell. Hilbish provides a way for users
|
||||
to write tab completion for any command and/or the whole shell.
|
||||
Inline hinting and syntax highlighting are also available.</p></div><div class="footer mt-auto"><p class="card-small text-muted">Want to help improve this page? <a href=https://github.com/Rosettea/Hilbish/issues/new/choose>Create an issue.</a></p></div></container></div><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea © 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>
|
||||
7
versions/readline-move/docs/features/index.html
Normal file
7
versions/readline-move/docs/features/index.html
Normal file
@ -0,0 +1,7 @@
|
||||
<!doctype html><html><head><title>Features — Hilbish</title><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><meta name=theme-color content="#ff89dd"><meta content="/Hilbish/hilbish-flower.png" property="og:image"><meta property="og:site_name" content="Hilbish"><meta content="Features — Hilbish" property="og:title"><meta content="Hilbish has a wide range of features to enhance the user’s experience new ones are always being added. If there is something missing here or something you would like to see, please start a discussion or comment on any existing ones which match your request." property="og:description"><meta content="Hilbish has a wide range of features to enhance the user’s experience new ones are always being added. If there is something missing here or something you would like to see, please start a discussion or comment on any existing ones which match your request." name=description><meta name=revisit-after content="2 days"><meta name=keywords content="Lua,Hilbish,Linux,Shell"><meta property="og:locale" content="en_GB"><link rel=canonical href=https://rosettea.github.io/Hilbish/><meta property="og:url" content="https://rosettea.github.io/Hilbish/"><link href=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css rel=stylesheet integrity=sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor crossorigin=anonymous><script src=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js integrity=sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2 crossorigin=anonymous></script>
|
||||
<link rel=stylesheet href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" crossorigin=anonymous referrerpolicy=no-referrer><link rel=stylesheet href=/Hilbish/versions/readline-move/css/syntax.min.eb77978873f3b324603120b558a36c98ad57d6ee7b77928e3bc131bd76c5935a.css integrity="sha256-63eXiHPzsyRgMSC1WKNsmK1X1u57d5KOO8ExvXbFk1o="></link><style>.heading>.heading-link{opacity:0}.heading:hover>.heading-link{visibility:visible;opacity:1;transition:all .1s ease-in}@keyframes highlight{0%{background:0 0}50%{background:#fff2cf}100%{background:0 0}}div:target{animation:highlight 1.2s;animation-timing-function:cubic-bezier(1,-.02,.45,.89)}table{border-width:1px;border-style:solid;border-color:#565c64;border-collapse:collapse;margin-bottom:12px}table td{padding:5px}table tr{border-width:1px}thead{display:none}</style></head><body class="d-flex flex-column min-vh-100" style=overflow-x:hidden><svg xmlns="http://www.w3.org/2000/svg" style="display:none"><symbol id="check-circle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="exclamation-triangle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><header><nav class="navbar navbar-expand-md sticky-top bg-light border-bottom"><div class=container-fluid><a class=navbar-brand href=/Hilbish><img src=/Hilbish/hilbish-logo-and-text.png alt height=48></a>
|
||||
<button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
|
||||
<span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/readline-move/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><style>@media(min-width:768px){.sidenav{width:240px}}</style><div class=row><nav class="navbar-expand-md bg-light sidenav border-end"><div class=container><div class="collapse navbar-collapse" id=navbarSupportedContent><nav class="navbar navbar-expand-md bg-light sidenav col" style=margin-top:-20px><ul class="navbar-nav me-auto mb-2 mb-lg-0 flex-column col mt-4"><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link><strong>Introduction</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/getting-started/ class=nav-link><strong>Getting Started</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/faq/ class=nav-link><strong>Frequently Asked Questions</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/ class=nav-link><strong>Features</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/completions/ class=nav-link>Completions</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/notifications/ class=nav-link>Notification</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/opts/ class=nav-link>Options</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/runner-mode/ class=nav-link>Runner Mode</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/ class=nav-link><strong>Signals</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/command/ class=nav-link>Command</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/hilbish/ class=nav-link>Hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/signal/ class=nav-link>Signal</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/lunacolors/ class=nav-link><strong>Lunacolors</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/ class=nav-link><strong>Vim Mode</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/actions/ class=nav-link>Actions</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/ class=nav-link><strong>Nature</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/dirs/ class=nav-link>Module dirs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/doc/ class=nav-link>Module doc</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/ class=nav-link><strong>API</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/bait/ class=nav-link>Module bait</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/commander/ class=nav-link>Module commander</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/fs/ class=nav-link>Module fs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/ class=nav-link>Module hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.aliases/ class=nav-link>Module hilbish.aliases</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.completion/ class=nav-link>Module hilbish.completion</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.runner/ class=nav-link>Module hilbish.runner</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.userdir/ class=nav-link>Module hilbish.userDir</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/readline/ class=nav-link>Module readline</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/snail/ class=nav-link>Module snail</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/terminal/ class=nav-link>Module terminal</a></li></ul></ul></nav></div></div></nav><container class="col mt-2" style="padding-left: 20px; padding-right: 20px;"><div><h1>Features</h1><p><em>Last updated Dec 26, 2023<br></em></p><p>Hilbish has a wide range of features to enhance the user’s experience
|
||||
new ones are always being added. If there is something missing here or
|
||||
something you would like to see, please <a href=https://github.com/Rosettea/Hilbish/discussions target=_blank rel=noopener>start a discussion</a>
|
||||
or comment on any existing ones which match your request.</p></div><div class="footer mt-auto"><p class="card-small text-muted">Want to help improve this page? <a href=https://github.com/Rosettea/Hilbish/issues/new/choose>Create an issue.</a></p></div></container></div><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea © 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>
|
||||
6
versions/readline-move/docs/features/index.xml
Normal file
6
versions/readline-move/docs/features/index.xml
Normal file
@ -0,0 +1,6 @@
|
||||
<?xml version="1.0" encoding="utf-8" standalone="yes"?><rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Features on Hilbish</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/features/</link><description>Recent content in Features on Hilbish</description><generator>Hugo -- gohugo.io</generator><language>en-us</language><atom:link href="https://rosettea.github.io/Hilbish/versions/readline-move/docs/features/index.xml" rel="self" type="application/rss+xml"/><item><title>Notification</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/features/notifications/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/features/notifications/</guid><description>Hilbish features a simple notification system which can be used by other plugins and parts of the shell to notify the user of various actions. This is used via the hilbish.message interface.
|
||||
A message is defined as a table with the following properties:
|
||||
icon: A unicode/emoji icon for the notification. title: The title of the message text: Message text/body channel: The source of the message. This should be a unique and easily readable text identifier.</description></item><item><title>Options</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/features/opts/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/features/opts/</guid><description>Opts are simple toggle or value options a user can set in Hilbish. As toggles, there are things like autocd or history saving. As values, there is the motd which the user can either change to a custom string or disable.
|
||||
Opts are accessed from the hilbish.opts table. Here they can either be read or modified
|
||||
autocd Value: boolean Default: false The autocd opt makes it so that lone directories attempted to be executed are instead set as the shell&rsquo;s directory.</description></item><item><title>Runner Mode</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/features/runner-mode/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/features/runner-mode/</guid><description>Hilbish allows you to change how interactive text can be interpreted. This is mainly due to the fact that the default method Hilbish uses is that it runs Lua first and then falls back to shell script.
|
||||
In some cases, someone might want to switch to just shell script to avoid it while interactive but still have a Lua config, or go full Lua to use Hilbish as a REPL. This also allows users to add alternative languages like Fennel as the interactive script runner.</description></item></channel></rss>
|
||||
@ -0,0 +1,15 @@
|
||||
<!doctype html><html><head><title>Notification — Hilbish</title><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><meta name=theme-color content="#ff89dd"><meta content="/Hilbish/hilbish-flower.png" property="og:image"><meta property="og:site_name" content="Hilbish"><meta content="Notification — Hilbish" property="og:title"><meta content="Get notified of shell actions." property="og:description"><meta content="Get notified of shell actions." name=description><meta name=revisit-after content="2 days"><meta name=keywords content="Lua,Hilbish,Linux,Shell"><meta property="og:locale" content="en_GB"><link rel=canonical href=https://rosettea.github.io/Hilbish/><meta property="og:url" content="https://rosettea.github.io/Hilbish/"><link href=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css rel=stylesheet integrity=sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor crossorigin=anonymous><script src=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js integrity=sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2 crossorigin=anonymous></script>
|
||||
<link rel=stylesheet href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" crossorigin=anonymous referrerpolicy=no-referrer><link rel=stylesheet href=/Hilbish/versions/readline-move/css/syntax.min.eb77978873f3b324603120b558a36c98ad57d6ee7b77928e3bc131bd76c5935a.css integrity="sha256-63eXiHPzsyRgMSC1WKNsmK1X1u57d5KOO8ExvXbFk1o="></link><style>.heading>.heading-link{opacity:0}.heading:hover>.heading-link{visibility:visible;opacity:1;transition:all .1s ease-in}@keyframes highlight{0%{background:0 0}50%{background:#fff2cf}100%{background:0 0}}div:target{animation:highlight 1.2s;animation-timing-function:cubic-bezier(1,-.02,.45,.89)}table{border-width:1px;border-style:solid;border-color:#565c64;border-collapse:collapse;margin-bottom:12px}table td{padding:5px}table tr{border-width:1px}thead{display:none}</style></head><body class="d-flex flex-column min-vh-100" style=overflow-x:hidden><svg xmlns="http://www.w3.org/2000/svg" style="display:none"><symbol id="check-circle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="exclamation-triangle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><header><nav class="navbar navbar-expand-md sticky-top bg-light border-bottom"><div class=container-fluid><a class=navbar-brand href=/Hilbish><img src=/Hilbish/hilbish-logo-and-text.png alt height=48></a>
|
||||
<button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
|
||||
<span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/readline-move/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><style>@media(min-width:768px){.sidenav{width:240px}}</style><div class=row><nav class="navbar-expand-md bg-light sidenav border-end"><div class=container><div class="collapse navbar-collapse" id=navbarSupportedContent><nav class="navbar navbar-expand-md bg-light sidenav col" style=margin-top:-20px><ul class="navbar-nav me-auto mb-2 mb-lg-0 flex-column col mt-4"><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link><strong>Introduction</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/getting-started/ class=nav-link><strong>Getting Started</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/faq/ class=nav-link><strong>Frequently Asked Questions</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/ class=nav-link><strong>Features</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/completions/ class=nav-link>Completions</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/notifications/ class=nav-link>Notification</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/opts/ class=nav-link>Options</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/runner-mode/ class=nav-link>Runner Mode</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/ class=nav-link><strong>Signals</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/command/ class=nav-link>Command</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/hilbish/ class=nav-link>Hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/signal/ class=nav-link>Signal</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/lunacolors/ class=nav-link><strong>Lunacolors</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/ class=nav-link><strong>Vim Mode</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/actions/ class=nav-link>Actions</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/ class=nav-link><strong>Nature</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/dirs/ class=nav-link>Module dirs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/doc/ class=nav-link>Module doc</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/ class=nav-link><strong>API</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/bait/ class=nav-link>Module bait</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/commander/ class=nav-link>Module commander</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/fs/ class=nav-link>Module fs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/ class=nav-link>Module hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.aliases/ class=nav-link>Module hilbish.aliases</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.completion/ class=nav-link>Module hilbish.completion</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.runner/ class=nav-link>Module hilbish.runner</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.userdir/ class=nav-link>Module hilbish.userDir</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/readline/ class=nav-link>Module readline</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/snail/ class=nav-link>Module snail</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/terminal/ class=nav-link>Module terminal</a></li></ul></ul></nav></div></div></nav><container class="col mt-2" style="padding-left: 20px; padding-right: 20px;"><div><h1>Notification</h1><p><em>Last updated Dec 26, 2023<br>Get notified of shell actions.<br></em></p><p>Hilbish features a simple notification system which can be
|
||||
used by other plugins and parts of the shell to notify the user
|
||||
of various actions. This is used via the <code>hilbish.message</code> interface.</p><p>A <code>message</code> is defined as a table with the following properties:</p><ul><li><code>icon</code>: A unicode/emoji icon for the notification.</li><li><code>title</code>: The title of the message</li><li><code>text</code>: Message text/body</li><li><code>channel</code>: The source of the message. This should be a
|
||||
unique and easily readable text identifier.</li><li><code>summary</code>: A short summary of the notification and message.
|
||||
If this is not present and you are using this to display messages,
|
||||
you should take part of the <code>text</code> instead.</li></ul><p>The <code>hilbish.message</code> interface provides the following functions:</p><ul><li><code>send(message)</code>: Sends a message and emits the <code>hilbish.notification</code>
|
||||
signal. DO NOT emit the <code>hilbish.notification</code> signal directly, or
|
||||
the message will not be stored by the message handler.</li><li><code>read(idx)</code>: Marks message at <code>idx</code> as read.</li><li><code>delete(idx)</code>: Removes message at <code>idx</code>.</li><li><code>readAll()</code>: Marks all messages as read.</li><li><code>clear()</code>: Deletes all messages.</li></ul><p>There are a few simple use cases of this notification/messaging system.
|
||||
It could also be used as some “inter-shell” messaging system (???) but
|
||||
is intended to display to users.</p><p>An example is notifying users of completed jobs/commands ran in the background.
|
||||
Any Hilbish-native command (think the upcoming Greenhouse pager) can display
|
||||
it.</p></div><div class="footer mt-auto"><p class="card-small text-muted">Want to help improve this page? <a href=https://github.com/Rosettea/Hilbish/issues/new/choose>Create an issue.</a></p></div></container></div><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea © 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>
|
||||
43
versions/readline-move/docs/features/opts/index.html
Normal file
43
versions/readline-move/docs/features/opts/index.html
Normal file
@ -0,0 +1,43 @@
|
||||
<!doctype html><html><head><title>Options — Hilbish</title><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><meta name=theme-color content="#ff89dd"><meta content="/Hilbish/hilbish-flower.png" property="og:image"><meta property="og:site_name" content="Hilbish"><meta content="Options — Hilbish" property="og:title"><meta content="Simple customizable options." property="og:description"><meta content="Simple customizable options." name=description><meta name=revisit-after content="2 days"><meta name=keywords content="Lua,Hilbish,Linux,Shell"><meta property="og:locale" content="en_GB"><link rel=canonical href=https://rosettea.github.io/Hilbish/><meta property="og:url" content="https://rosettea.github.io/Hilbish/"><link href=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css rel=stylesheet integrity=sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor crossorigin=anonymous><script src=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js integrity=sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2 crossorigin=anonymous></script>
|
||||
<link rel=stylesheet href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" crossorigin=anonymous referrerpolicy=no-referrer><link rel=stylesheet href=/Hilbish/versions/readline-move/css/syntax.min.eb77978873f3b324603120b558a36c98ad57d6ee7b77928e3bc131bd76c5935a.css integrity="sha256-63eXiHPzsyRgMSC1WKNsmK1X1u57d5KOO8ExvXbFk1o="></link><style>.heading>.heading-link{opacity:0}.heading:hover>.heading-link{visibility:visible;opacity:1;transition:all .1s ease-in}@keyframes highlight{0%{background:0 0}50%{background:#fff2cf}100%{background:0 0}}div:target{animation:highlight 1.2s;animation-timing-function:cubic-bezier(1,-.02,.45,.89)}table{border-width:1px;border-style:solid;border-color:#565c64;border-collapse:collapse;margin-bottom:12px}table td{padding:5px}table tr{border-width:1px}thead{display:none}</style></head><body class="d-flex flex-column min-vh-100" style=overflow-x:hidden><svg xmlns="http://www.w3.org/2000/svg" style="display:none"><symbol id="check-circle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="exclamation-triangle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><header><nav class="navbar navbar-expand-md sticky-top bg-light border-bottom"><div class=container-fluid><a class=navbar-brand href=/Hilbish><img src=/Hilbish/hilbish-logo-and-text.png alt height=48></a>
|
||||
<button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
|
||||
<span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/readline-move/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><style>@media(min-width:768px){.sidenav{width:240px}}</style><div class=row><nav class="navbar-expand-md bg-light sidenav border-end"><div class=container><div class="collapse navbar-collapse" id=navbarSupportedContent><nav class="navbar navbar-expand-md bg-light sidenav col" style=margin-top:-20px><ul class="navbar-nav me-auto mb-2 mb-lg-0 flex-column col mt-4"><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link><strong>Introduction</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/getting-started/ class=nav-link><strong>Getting Started</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/faq/ class=nav-link><strong>Frequently Asked Questions</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/ class=nav-link><strong>Features</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/completions/ class=nav-link>Completions</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/notifications/ class=nav-link>Notification</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/opts/ class=nav-link>Options</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/runner-mode/ class=nav-link>Runner Mode</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/ class=nav-link><strong>Signals</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/command/ class=nav-link>Command</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/hilbish/ class=nav-link>Hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/signal/ class=nav-link>Signal</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/lunacolors/ class=nav-link><strong>Lunacolors</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/ class=nav-link><strong>Vim Mode</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/actions/ class=nav-link>Actions</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/ class=nav-link><strong>Nature</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/dirs/ class=nav-link>Module dirs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/doc/ class=nav-link>Module doc</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/ class=nav-link><strong>API</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/bait/ class=nav-link>Module bait</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/commander/ class=nav-link>Module commander</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/fs/ class=nav-link>Module fs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/ class=nav-link>Module hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.aliases/ class=nav-link>Module hilbish.aliases</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.completion/ class=nav-link>Module hilbish.completion</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.runner/ class=nav-link>Module hilbish.runner</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.userdir/ class=nav-link>Module hilbish.userDir</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/readline/ class=nav-link>Module readline</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/snail/ class=nav-link>Module snail</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/terminal/ class=nav-link>Module terminal</a></li></ul></ul></nav></div></div></nav><container class="col mt-2" style="padding-left: 20px; padding-right: 20px;"><div><h1>Options</h1><p><em>Simple customizable options.<br></em></p><p>Opts are simple toggle or value options a user can set in Hilbish.
|
||||
As toggles, there are things like <code>autocd</code> or history saving. As values,
|
||||
there is the <code>motd</code> which the user can either change to a custom string or disable.</p><p>Opts are accessed from the <code>hilbish.opts</code> table. Here they can either
|
||||
be read or modified</p><h4 id=autocd class=heading><code>autocd</code>
|
||||
<a href=#autocd class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=value-boolean class=heading>Value: <code>boolean</code>
|
||||
<a href=#value-boolean class=heading-link><i class="fas fa-paperclip"></i></a></h5><h5 id=default-false class=heading>Default: <code>false</code>
|
||||
<a href=#default-false class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>The autocd opt makes it so that lone directories attempted to be executed are
|
||||
instead set as the shell’s directory.</p><p>Example:</p><div class=highlight><pre tabindex=0 class=chroma><code class=language-fallback data-lang=fallback><span class=line><span class=ln>1</span><span class=cl>~/Directory
|
||||
</span></span><span class=line><span class=ln>2</span><span class=cl>∆ ~
|
||||
</span></span><span class=line><span class=ln>3</span><span class=cl>~
|
||||
</span></span><span class=line><span class=ln>4</span><span class=cl>∆ Downloads
|
||||
</span></span><span class=line><span class=ln>5</span><span class=cl>~/Downloads
|
||||
</span></span><span class=line><span class=ln>6</span><span class=cl>∆ ../Documents
|
||||
</span></span><span class=line><span class=ln>7</span><span class=cl>~/Documents
|
||||
</span></span><span class=line><span class=ln>8</span><span class=cl>∆
|
||||
</span></span></code></pre></div><hr><h4 id=history class=heading><code>history</code>
|
||||
<a href=#history class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=value-boolean-1 class=heading>Value: <code>boolean</code>
|
||||
<a href=#value-boolean-1 class=heading-link><i class="fas fa-paperclip"></i></a></h5><h5 id=default-true class=heading>Default: <code>true</code>
|
||||
<a href=#default-true class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>Sets whether command history will be saved or not.</p><hr><h4 id=greeting class=heading><code>greeting</code>
|
||||
<a href=#greeting class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=value-boolean-or-string class=heading>Value: <code>boolean</code> or <code>string</code>
|
||||
<a href=#value-boolean-or-string class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>The greeting is the message that Hilbish shows on startup
|
||||
(the one which says Welcome to Hilbish).</p><p>This can be set to either true/false to enable/disable or a custom greeting string.</p><hr><h4 id=motd class=heading><code>motd</code>
|
||||
<a href=#motd class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=value-boolean-2 class=heading>Value: <code>boolean</code>
|
||||
<a href=#value-boolean-2 class=heading-link><i class="fas fa-paperclip"></i></a></h5><h5 id=default-true-1 class=heading>Default: <code>true</code>
|
||||
<a href=#default-true-1 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>The message of the day shows the current major.minor version and
|
||||
includes a small range of things added in the current release.</p><p>This can be set to <code>false</code> to disable the message.</p><hr><h4 id=fuzzy class=heading><code>fuzzy</code>
|
||||
<a href=#fuzzy class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=value-boolean-3 class=heading>Value: <code>boolean</code>
|
||||
<a href=#value-boolean-3 class=heading-link><i class="fas fa-paperclip"></i></a></h5><h5 id=default-false-1 class=heading>Default: <code>false</code>
|
||||
<a href=#default-false-1 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>Toggles the functionality of fuzzy history searching, usable
|
||||
via the menu in Ctrl-R. Fuzzy searching is an approximate searching
|
||||
method, which means results that match <em>closest</em> will be shown instead
|
||||
of an exact match.</p><hr><h4 id=notifyjobfinish class=heading><code>notifyJobFinish</code>
|
||||
<a href=#notifyjobfinish class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=value-boolean-4 class=heading>Value: <code>boolean</code>
|
||||
<a href=#value-boolean-4 class=heading-link><i class="fas fa-paperclip"></i></a></h5><h5 id=default-true-2 class=heading>Default: <code>true</code>
|
||||
<a href=#default-true-2 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>If this is enabled, when a background job is finished,
|
||||
a <a href=../notifications>notification</a>
|
||||
will be sent.</p><h4 id=processorskiplist class=heading><code>processorSkipList</code>
|
||||
<a href=#processorskiplist class=heading-link><i class="fas fa-paperclip"></i></a></h4><h5 id=value-table class=heading>Value: <code>table</code>
|
||||
<a href=#value-table class=heading-link><i class="fas fa-paperclip"></i></a></h5><h5 id=default- class=heading>Default: <code>{}</code>
|
||||
<a href=#default- class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>A table listing the names of command processors to skip.</p></div><div class="footer mt-auto"><p class="card-small text-muted">Want to help improve this page? <a href=https://github.com/Rosettea/Hilbish/issues/new/choose>Create an issue.</a></p></div></container></div><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea © 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>
|
||||
24
versions/readline-move/docs/features/runner-mode/index.html
Normal file
24
versions/readline-move/docs/features/runner-mode/index.html
Normal file
@ -0,0 +1,24 @@
|
||||
<!doctype html><html><head><title>Runner Mode — Hilbish</title><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><meta name=theme-color content="#ff89dd"><meta content="/Hilbish/hilbish-flower.png" property="og:image"><meta property="og:site_name" content="Hilbish"><meta content="Runner Mode — Hilbish" property="og:title"><meta content="Customize the interactive script/command runner." property="og:description"><meta content="Customize the interactive script/command runner." name=description><meta name=revisit-after content="2 days"><meta name=keywords content="Lua,Hilbish,Linux,Shell"><meta property="og:locale" content="en_GB"><link rel=canonical href=https://rosettea.github.io/Hilbish/><meta property="og:url" content="https://rosettea.github.io/Hilbish/"><link href=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css rel=stylesheet integrity=sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor crossorigin=anonymous><script src=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js integrity=sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2 crossorigin=anonymous></script>
|
||||
<link rel=stylesheet href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" crossorigin=anonymous referrerpolicy=no-referrer><link rel=stylesheet href=/Hilbish/versions/readline-move/css/syntax.min.eb77978873f3b324603120b558a36c98ad57d6ee7b77928e3bc131bd76c5935a.css integrity="sha256-63eXiHPzsyRgMSC1WKNsmK1X1u57d5KOO8ExvXbFk1o="></link><style>.heading>.heading-link{opacity:0}.heading:hover>.heading-link{visibility:visible;opacity:1;transition:all .1s ease-in}@keyframes highlight{0%{background:0 0}50%{background:#fff2cf}100%{background:0 0}}div:target{animation:highlight 1.2s;animation-timing-function:cubic-bezier(1,-.02,.45,.89)}table{border-width:1px;border-style:solid;border-color:#565c64;border-collapse:collapse;margin-bottom:12px}table td{padding:5px}table tr{border-width:1px}thead{display:none}</style></head><body class="d-flex flex-column min-vh-100" style=overflow-x:hidden><svg xmlns="http://www.w3.org/2000/svg" style="display:none"><symbol id="check-circle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="exclamation-triangle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><header><nav class="navbar navbar-expand-md sticky-top bg-light border-bottom"><div class=container-fluid><a class=navbar-brand href=/Hilbish><img src=/Hilbish/hilbish-logo-and-text.png alt height=48></a>
|
||||
<button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
|
||||
<span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/readline-move/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><style>@media(min-width:768px){.sidenav{width:240px}}</style><div class=row><nav class="navbar-expand-md bg-light sidenav border-end"><div class=container><div class="collapse navbar-collapse" id=navbarSupportedContent><nav class="navbar navbar-expand-md bg-light sidenav col" style=margin-top:-20px><ul class="navbar-nav me-auto mb-2 mb-lg-0 flex-column col mt-4"><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link><strong>Introduction</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/getting-started/ class=nav-link><strong>Getting Started</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/faq/ class=nav-link><strong>Frequently Asked Questions</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/ class=nav-link><strong>Features</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/completions/ class=nav-link>Completions</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/notifications/ class=nav-link>Notification</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/opts/ class=nav-link>Options</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/runner-mode/ class=nav-link>Runner Mode</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/ class=nav-link><strong>Signals</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/command/ class=nav-link>Command</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/hilbish/ class=nav-link>Hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/signal/ class=nav-link>Signal</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/lunacolors/ class=nav-link><strong>Lunacolors</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/ class=nav-link><strong>Vim Mode</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/actions/ class=nav-link>Actions</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/ class=nav-link><strong>Nature</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/dirs/ class=nav-link>Module dirs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/doc/ class=nav-link>Module doc</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/ class=nav-link><strong>API</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/bait/ class=nav-link>Module bait</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/commander/ class=nav-link>Module commander</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/fs/ class=nav-link>Module fs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/ class=nav-link>Module hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.aliases/ class=nav-link>Module hilbish.aliases</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.completion/ class=nav-link>Module hilbish.completion</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.runner/ class=nav-link>Module hilbish.runner</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.userdir/ class=nav-link>Module hilbish.userDir</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/readline/ class=nav-link>Module readline</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/snail/ class=nav-link>Module snail</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/terminal/ class=nav-link>Module terminal</a></li></ul></ul></nav></div></div></nav><container class="col mt-2" style="padding-left: 20px; padding-right: 20px;"><div><h1>Runner Mode</h1><p><em>Last updated Dec 26, 2023<br>Customize the interactive script/command runner.<br></em></p><p>Hilbish allows you to change how interactive text can be interpreted.
|
||||
This is mainly due to the fact that the default method Hilbish uses
|
||||
is that it runs Lua first and then falls back to shell script.</p><p>In some cases, someone might want to switch to just shell script to avoid
|
||||
it while interactive but still have a Lua config, or go full Lua to use
|
||||
Hilbish as a REPL. This also allows users to add alternative languages like
|
||||
Fennel as the interactive script runner.</p><p>Runner mode can also be used to handle specific kinds of input before
|
||||
evaluating like normal, which is how <a href=https://github.com/TorchedSammy/Link.hsh target=_blank rel=noopener>Link.hsh</a>
|
||||
handles links.</p><p>The “runner mode” of Hilbish is customizable via <code>hilbish.runnerMode</code>,
|
||||
which determines how Hilbish will run user input. By default, this is
|
||||
set to <code>hybrid</code> which is the previously mentioned behaviour of running Lua
|
||||
first then going to shell script. If you want the reverse order, you can
|
||||
set it to <code>hybridRev</code> and for isolated modes there is <code>sh</code> and <code>lua</code>
|
||||
respectively.</p><p>You can also set it to a function, which will be called everytime Hilbish
|
||||
needs to run interactive input. For more detail, see the <a href=../../api/hilbish/hilbish.runner>API documentation</a></p><p>The <code>hilbish.runner</code> interface is an alternative to using <code>hilbish.runnerMode</code>
|
||||
and also provides the shell script and Lua runner functions that Hilbish itself uses.</p><h3 id=functions class=heading>Functions
|
||||
<a href=#functions class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>These are the “low level” functions for the <code>hilbish.runner</code> interface.</p><ul><li>setMode(mode) > The same as <code>hilbish.runnerMode</code></li><li>sh(input) -> table > Runs <code>input</code> in Hilbish’s sh interpreter</li><li>lua(input) -> table > Evals <code>input</code> as Lua code</li></ul><p>These functions should be preferred over the previous ones.</p><ul><li>setCurrent(mode) > The same as <code>setMode</code>, but works with runners managed
|
||||
via the functions below.</li><li>add(name, runner) > Adds a runner to a table of available runners. The <code>runner</code>
|
||||
argument is either a function or a table with a run callback.</li><li>set(name, runner) > The same as <code>add</code> but requires passing a table and
|
||||
overwrites if the <code>name</code>d runner already exists.</li><li>get(name) > runner > Gets a runner by name. It is a table with at least a
|
||||
run function, to run input.</li><li>exec(cmd, runnerName) > Runs <code>cmd</code> with a runner. If <code>runnerName</code> isn’t passed,
|
||||
the current runner mode is used.</li></ul></div><div class="footer mt-auto"><p class="card-small text-muted">Want to help improve this page? <a href=https://github.com/Rosettea/Hilbish/issues/new/choose>Create an issue.</a></p></div></container></div><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea © 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>
|
||||
53
versions/readline-move/docs/getting-started/index.html
Normal file
53
versions/readline-move/docs/getting-started/index.html
Normal file
@ -0,0 +1,53 @@
|
||||
<!doctype html><html><head><title>Getting Started — Hilbish</title><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><meta name=theme-color content="#ff89dd"><meta content="/Hilbish/hilbish-flower.png" property="og:image"><meta property="og:site_name" content="Hilbish"><meta content="Getting Started — Hilbish" property="og:title"><meta content="To start Hilbish, open a terminal. If Hilbish has been installed and is not the default shell, you can simply run hilbish to start it. This will launch a normal interactive session. To exit, you can either run the exit command or hit Ctrl+D.
|
||||
Setting as Default Login shell There are a few ways to make Hilbish your default shell. A simple way is to make it your user/login shell." property="og:description"><meta content="To start Hilbish, open a terminal. If Hilbish has been installed and is not the default shell, you can simply run hilbish to start it. This will launch a normal interactive session. To exit, you can either run the exit command or hit Ctrl+D.
|
||||
Setting as Default Login shell There are a few ways to make Hilbish your default shell. A simple way is to make it your user/login shell." name=description><meta name=revisit-after content="2 days"><meta name=keywords content="Lua,Hilbish,Linux,Shell"><meta property="og:locale" content="en_GB"><link rel=canonical href=https://rosettea.github.io/Hilbish/><meta property="og:url" content="https://rosettea.github.io/Hilbish/"><link href=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css rel=stylesheet integrity=sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor crossorigin=anonymous><script src=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js integrity=sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2 crossorigin=anonymous></script>
|
||||
<link rel=stylesheet href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" crossorigin=anonymous referrerpolicy=no-referrer><link rel=stylesheet href=/Hilbish/versions/readline-move/css/syntax.min.eb77978873f3b324603120b558a36c98ad57d6ee7b77928e3bc131bd76c5935a.css integrity="sha256-63eXiHPzsyRgMSC1WKNsmK1X1u57d5KOO8ExvXbFk1o="></link><style>.heading>.heading-link{opacity:0}.heading:hover>.heading-link{visibility:visible;opacity:1;transition:all .1s ease-in}@keyframes highlight{0%{background:0 0}50%{background:#fff2cf}100%{background:0 0}}div:target{animation:highlight 1.2s;animation-timing-function:cubic-bezier(1,-.02,.45,.89)}table{border-width:1px;border-style:solid;border-color:#565c64;border-collapse:collapse;margin-bottom:12px}table td{padding:5px}table tr{border-width:1px}thead{display:none}</style></head><body class="d-flex flex-column min-vh-100" style=overflow-x:hidden><svg xmlns="http://www.w3.org/2000/svg" style="display:none"><symbol id="check-circle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="exclamation-triangle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><header><nav class="navbar navbar-expand-md sticky-top bg-light border-bottom"><div class=container-fluid><a class=navbar-brand href=/Hilbish><img src=/Hilbish/hilbish-logo-and-text.png alt height=48></a>
|
||||
<button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
|
||||
<span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/readline-move/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><style>@media(min-width:768px){.sidenav{width:240px}}</style><div class=row><nav class="navbar-expand-md bg-light sidenav border-end"><div class=container><div class="collapse navbar-collapse" id=navbarSupportedContent><nav class="navbar navbar-expand-md bg-light sidenav col" style=margin-top:-20px><ul class="navbar-nav me-auto mb-2 mb-lg-0 flex-column col mt-4"><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link><strong>Introduction</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/getting-started/ class=nav-link><strong>Getting Started</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/faq/ class=nav-link><strong>Frequently Asked Questions</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/ class=nav-link><strong>Features</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/completions/ class=nav-link>Completions</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/notifications/ class=nav-link>Notification</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/opts/ class=nav-link>Options</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/runner-mode/ class=nav-link>Runner Mode</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/ class=nav-link><strong>Signals</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/command/ class=nav-link>Command</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/hilbish/ class=nav-link>Hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/signal/ class=nav-link>Signal</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/lunacolors/ class=nav-link><strong>Lunacolors</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/ class=nav-link><strong>Vim Mode</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/actions/ class=nav-link>Actions</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/ class=nav-link><strong>Nature</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/dirs/ class=nav-link>Module dirs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/doc/ class=nav-link>Module doc</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/ class=nav-link><strong>API</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/bait/ class=nav-link>Module bait</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/commander/ class=nav-link>Module commander</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/fs/ class=nav-link>Module fs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/ class=nav-link>Module hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.aliases/ class=nav-link>Module hilbish.aliases</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.completion/ class=nav-link>Module hilbish.completion</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.runner/ class=nav-link>Module hilbish.runner</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.userdir/ class=nav-link>Module hilbish.userDir</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/readline/ class=nav-link>Module readline</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/snail/ class=nav-link>Module snail</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/terminal/ class=nav-link>Module terminal</a></li></ul></ul></nav></div></div></nav><container class="col mt-2" style="padding-left: 20px; padding-right: 20px;"><div><h1>Getting Started</h1><p><em>Last updated Dec 26, 2023<br></em></p><p>To start Hilbish, open a terminal. If Hilbish has been installed and is not the
|
||||
default shell, you can simply run <code>hilbish</code> to start it. This will launch
|
||||
a normal interactive session.
|
||||
To exit, you can either run the <code>exit</code> command or hit Ctrl+D.</p><h2 id=setting-as-default class=heading>Setting as Default
|
||||
<a href=#setting-as-default class=heading-link><i class="fas fa-paperclip"></i></a></h2><h3 id=login-shell class=heading>Login shell
|
||||
<a href=#login-shell class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>There are a few ways to make Hilbish your default shell. A simple way is
|
||||
to make it your user/login shell.</p><div class="alert alert-warning d-flex align-items-center" role=alert><svg class="bi flex-shrink-0 me-2" width="24" height="24" role="img" aria-label="Warning:"><use xlink:href="#exclamation-triangle-fill"/></svg><div>It is not recommended to set Hilbish as your login shell. That
|
||||
is expected to be a POSIX compliant shell, which Hilbish is not. Though if
|
||||
you still decide to do it, there will just be a few variables missing in
|
||||
your environment</div></div><p>To do that, simply run <code>chsh -s /usr/bin/hilbish</code>.
|
||||
Some distros (namely Fedora) might have <code>lchsh</code> instead, which is used like <code>lchsh <user></code>.
|
||||
When prompted, you can put the path for Hilbish.</p><h3 id=default-with-terminal class=heading>Default with terminal
|
||||
<a href=#default-with-terminal class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>The simpler way is to set the default shell for your terminal. The way of
|
||||
doing this depends on how your terminal settings are configured.</p><h3 id=run-after-login-shell class=heading>Run after login shell
|
||||
<a href=#run-after-login-shell class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>Some shells (like zsh) have an rc file, like <code>.zlogin</code>, which is ran when the shell session
|
||||
is a login shell. In that file, you can run Hilbish. Example:</p><div class=highlight><pre tabindex=0 class=chroma><code class=language-fallback data-lang=fallback><span class=line><span class=ln>1</span><span class=cl>exec hilbish -S -l
|
||||
</span></span></code></pre></div><p>This will replace the shell with Hilbish, set $SHELL to Hilbish and launch it as a login shell.</p><h2 id=configuration class=heading>Configuration
|
||||
<a href=#configuration class=heading-link><i class="fas fa-paperclip"></i></a></h2><p>Once installation and setup has been done, you can then configure Hilbish.
|
||||
It is configured and scripted via Lua, so the config file is a Lua file.
|
||||
You can use any pure Lua library to do whatever you want.</p><p>Hilbish’s sample configuration is usually located in <code>hilbish.dataDir .. '/.hilbishrc.lua'</code>.
|
||||
You can print that path via Lua to see what it is: <code>print(hilbish.dataDir .. '/.hilbishrc.lua')</code>.
|
||||
As an example, it will usually will result in <code>/usr/share/hilbish/.hilbishrc.lua</code> on Linux.</p><p>To edit your user configuration, you can copy that file to <code>hilbish.userDir.config .. '/hilbish/init.lua'</code>,
|
||||
which follows XDG on Linux and MacOS, and is located in %APPDATA% on Windows.</p><p>As the directory is usually <code>~/.config</code> on Linux, you can run this command to copy it:<br><code>cp /usr/share/hilbish/.hilbishrc.lua ~/.config/hilbish/init.lua</code></p><p>Now we can get to customization!</p><p>If we closely examine a small snippet of the default config:</p><div class=highlight><pre tabindex=0 class=chroma><code class=language-lua data-lang=lua><span class=line><span class=ln> 1</span><span class=cl><span class=c1>-- Default Hilbish config</span>
|
||||
</span></span><span class=line><span class=ln> 2</span><span class=cl><span class=c1>-- .. with some omitted code .. --</span>
|
||||
</span></span><span class=line><span class=ln> 3</span><span class=cl>
|
||||
</span></span><span class=line><span class=ln> 4</span><span class=cl><span class=kd>local</span> <span class=kr>function</span> <span class=nf>doPrompt</span><span class=p>(</span><span class=n>fail</span><span class=p>)</span>
|
||||
</span></span><span class=line><span class=ln> 5</span><span class=cl> <span class=n>hilbish.prompt</span><span class=p>(</span><span class=n>lunacolors.format</span><span class=p>(</span>
|
||||
</span></span><span class=line><span class=ln> 6</span><span class=cl> <span class=s1>'{blue}%u {cyan}%d '</span> <span class=o>..</span> <span class=p>(</span><span class=n>fail</span> <span class=ow>and</span> <span class=s1>'{red}'</span> <span class=ow>or</span> <span class=s1>'{green}'</span><span class=p>)</span> <span class=o>..</span> <span class=s1>'∆ '</span>
|
||||
</span></span><span class=line><span class=ln> 7</span><span class=cl> <span class=p>))</span>
|
||||
</span></span><span class=line><span class=ln> 8</span><span class=cl><span class=kr>end</span>
|
||||
</span></span><span class=line><span class=ln> 9</span><span class=cl>
|
||||
</span></span><span class=line><span class=ln>10</span><span class=cl><span class=n>doPrompt</span><span class=p>()</span>
|
||||
</span></span><span class=line><span class=ln>11</span><span class=cl>
|
||||
</span></span><span class=line><span class=ln>12</span><span class=cl><span class=n>bait.catch</span><span class=p>(</span><span class=s1>'command.exit'</span><span class=p>,</span> <span class=kr>function</span><span class=p>(</span><span class=n>code</span><span class=p>)</span>
|
||||
</span></span><span class=line><span class=ln>13</span><span class=cl> <span class=n>doPrompt</span><span class=p>(</span><span class=n>code</span> <span class=o>~=</span> <span class=mi>0</span><span class=p>)</span>
|
||||
</span></span><span class=line><span class=ln>14</span><span class=cl><span class=kr>end</span><span class=p>)</span>
|
||||
</span></span></code></pre></div><p>We see a whopping <strong>three</strong> Hilbish libraries being used in this part of code.
|
||||
First is of course, named after the shell itself, <a href=../api/hilbish><code>hilbish</code></a>
|
||||
. This is kind of a
|
||||
“catch-all” namespace for functions that directly related to shell functionality/settings.</p><p>And as we can see, the <a href=../api/hilbish/#prompt>hilbish.prompt</a>
|
||||
function is used
|
||||
to change our prompt. Change our prompt to what, exactly?</p><p>The doc for the function states that the verbs <code>%u</code> and <code>%d</code>are used for username and current directory
|
||||
of the shell, respectively.</p><p>We wrap this in the <a href=../lunacolors><code>lunacolors.format</code></a>
|
||||
function, to give
|
||||
our prompt some nice color.</p><p>But you might have also noticed that this is in the <code>doPrompt</code> function, which is called once,
|
||||
and then used again in a <a href=../api/bait>bait</a>
|
||||
hook. Specifically, the <code>command.exit</code> hook,
|
||||
which is called after a command exits, so when it finishes running.</p></div><div class="footer mt-auto"><p class="card-small text-muted">Want to help improve this page? <a href=https://github.com/Rosettea/Hilbish/issues/new/choose>Create an issue.</a></p></div></container></div><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea © 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>
|
||||
47
versions/readline-move/docs/hooks/command/index.html
Normal file
47
versions/readline-move/docs/hooks/command/index.html
Normal file
@ -0,0 +1,47 @@
|
||||
<!doctype html><html><head><title>Command — Hilbish</title><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><meta name=theme-color content="#ff89dd"><meta content="/Hilbish/hilbish-flower.png" property="og:image"><meta property="og:site_name" content="Hilbish"><meta content="Command — Hilbish" property="og:title"><meta content="command.preexec Thrown right before a command is executed.
|
||||
Variables string input
|
||||
The raw string that the user typed. This will include the text without changes applied to it (argument substitution, alias expansion, etc.)
|
||||
string cmdStr
|
||||
The command that will be directly executed by the current runner.
|
||||
command.exit Thrown after the user’s ran command is finished.
|
||||
Variables number code
|
||||
The exit code of what was executed.
|
||||
string cmdStr
|
||||
The command or code that was executed" property="og:description"><meta content="command.preexec Thrown right before a command is executed.
|
||||
Variables string input
|
||||
The raw string that the user typed. This will include the text without changes applied to it (argument substitution, alias expansion, etc.)
|
||||
string cmdStr
|
||||
The command that will be directly executed by the current runner.
|
||||
command.exit Thrown after the user’s ran command is finished.
|
||||
Variables number code
|
||||
The exit code of what was executed.
|
||||
string cmdStr
|
||||
The command or code that was executed" name=description><meta name=revisit-after content="2 days"><meta name=keywords content="Lua,Hilbish,Linux,Shell"><meta property="og:locale" content="en_GB"><link rel=canonical href=https://rosettea.github.io/Hilbish/><meta property="og:url" content="https://rosettea.github.io/Hilbish/"><link href=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css rel=stylesheet integrity=sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor crossorigin=anonymous><script src=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js integrity=sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2 crossorigin=anonymous></script>
|
||||
<link rel=stylesheet href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" crossorigin=anonymous referrerpolicy=no-referrer><link rel=stylesheet href=/Hilbish/versions/readline-move/css/syntax.min.eb77978873f3b324603120b558a36c98ad57d6ee7b77928e3bc131bd76c5935a.css integrity="sha256-63eXiHPzsyRgMSC1WKNsmK1X1u57d5KOO8ExvXbFk1o="></link><style>.heading>.heading-link{opacity:0}.heading:hover>.heading-link{visibility:visible;opacity:1;transition:all .1s ease-in}@keyframes highlight{0%{background:0 0}50%{background:#fff2cf}100%{background:0 0}}div:target{animation:highlight 1.2s;animation-timing-function:cubic-bezier(1,-.02,.45,.89)}table{border-width:1px;border-style:solid;border-color:#565c64;border-collapse:collapse;margin-bottom:12px}table td{padding:5px}table tr{border-width:1px}thead{display:none}</style></head><body class="d-flex flex-column min-vh-100" style=overflow-x:hidden><svg xmlns="http://www.w3.org/2000/svg" style="display:none"><symbol id="check-circle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="exclamation-triangle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><header><nav class="navbar navbar-expand-md sticky-top bg-light border-bottom"><div class=container-fluid><a class=navbar-brand href=/Hilbish><img src=/Hilbish/hilbish-logo-and-text.png alt height=48></a>
|
||||
<button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
|
||||
<span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/readline-move/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><style>@media(min-width:768px){.sidenav{width:240px}}</style><div class=row><nav class="navbar-expand-md bg-light sidenav border-end"><div class=container><div class="collapse navbar-collapse" id=navbarSupportedContent><nav class="navbar navbar-expand-md bg-light sidenav col" style=margin-top:-20px><ul class="navbar-nav me-auto mb-2 mb-lg-0 flex-column col mt-4"><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link><strong>Introduction</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/getting-started/ class=nav-link><strong>Getting Started</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/faq/ class=nav-link><strong>Frequently Asked Questions</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/ class=nav-link><strong>Features</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/completions/ class=nav-link>Completions</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/notifications/ class=nav-link>Notification</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/opts/ class=nav-link>Options</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/runner-mode/ class=nav-link>Runner Mode</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/ class=nav-link><strong>Signals</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/command/ class=nav-link>Command</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/hilbish/ class=nav-link>Hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/signal/ class=nav-link>Signal</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/lunacolors/ class=nav-link><strong>Lunacolors</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/ class=nav-link><strong>Vim Mode</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/actions/ class=nav-link>Actions</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/ class=nav-link><strong>Nature</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/dirs/ class=nav-link>Module dirs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/doc/ class=nav-link>Module doc</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/ class=nav-link><strong>API</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/bait/ class=nav-link>Module bait</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/commander/ class=nav-link>Module commander</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/fs/ class=nav-link>Module fs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/ class=nav-link>Module hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.aliases/ class=nav-link>Module hilbish.aliases</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.completion/ class=nav-link>Module hilbish.completion</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.runner/ class=nav-link>Module hilbish.runner</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.userdir/ class=nav-link>Module hilbish.userDir</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/readline/ class=nav-link>Module readline</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/snail/ class=nav-link>Module snail</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/terminal/ class=nav-link>Module terminal</a></li></ul></ul></nav></div></div></nav><container class="col mt-2" style="padding-left: 20px; padding-right: 20px;"><div><h1>Command</h1><p><em></em></p><h3 id=commandpreexec class=heading>command.preexec
|
||||
<a href=#commandpreexec class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>Thrown right before a command is executed.</p><h5 id=variables class=heading>Variables
|
||||
<a href=#variables class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>string</code> <strong><code>input</code></strong><br>The raw string that the user typed. This will include the text
|
||||
without changes applied to it (argument substitution, alias expansion,
|
||||
etc.)</p><p><code>string</code> <strong><code>cmdStr</code></strong><br>The command that will be directly executed by the current runner.</p><hr><h3 id=commandexit class=heading>command.exit
|
||||
<a href=#commandexit class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>Thrown after the user’s ran command is finished.</p><h5 id=variables-1 class=heading>Variables
|
||||
<a href=#variables-1 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>number</code> <strong><code>code</code></strong><br>The exit code of what was executed.</p><p><code>string</code> <strong><code>cmdStr</code></strong><br>The command or code that was executed</p><hr><h3 id=commandnot-found class=heading>command.not-found
|
||||
<a href=#commandnot-found class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>Thrown if the command attempted to execute was not found.
|
||||
This can be used to customize the text printed when a command is not found.
|
||||
Example:</p><div class=highlight><pre tabindex=0 class=chroma><code class=language-lua data-lang=lua><span class=line><span class=ln> 1</span><span class=cl><span class=kd>local</span> <span class=n>bait</span> <span class=o>=</span> <span class=n>require</span> <span class=s1>'bait'</span>
|
||||
</span></span><span class=line><span class=ln> 2</span><span class=cl><span class=c1>-- Remove any present handlers on `command.not-found`</span>
|
||||
</span></span><span class=line><span class=ln> 3</span><span class=cl>
|
||||
</span></span><span class=line><span class=ln> 4</span><span class=cl><span class=kd>local</span> <span class=n>notFoundHooks</span> <span class=o>=</span> <span class=n>bait.hooks</span> <span class=s1>'command.not-found'</span>
|
||||
</span></span><span class=line><span class=ln> 5</span><span class=cl><span class=kr>for</span> <span class=n>_</span><span class=p>,</span> <span class=n>hook</span> <span class=kr>in</span> <span class=n>ipairs</span><span class=p>(</span><span class=n>notFoundHooks</span><span class=p>)</span> <span class=kr>do</span>
|
||||
</span></span><span class=line><span class=ln> 6</span><span class=cl> <span class=n>bait.release</span><span class=p>(</span><span class=s1>'command.not-found'</span><span class=p>,</span> <span class=n>hook</span><span class=p>)</span>
|
||||
</span></span><span class=line><span class=ln> 7</span><span class=cl><span class=kr>end</span>
|
||||
</span></span><span class=line><span class=ln> 8</span><span class=cl>
|
||||
</span></span><span class=line><span class=ln> 9</span><span class=cl><span class=c1>-- then assign custom</span>
|
||||
</span></span><span class=line><span class=ln>10</span><span class=cl><span class=n>bait.catch</span><span class=p>(</span><span class=s1>'command.not-found'</span><span class=p>,</span> <span class=kr>function</span><span class=p>(</span><span class=n>cmd</span><span class=p>)</span>
|
||||
</span></span><span class=line><span class=ln>11</span><span class=cl> <span class=n>print</span><span class=p>(</span><span class=n>string.format</span><span class=p>(</span><span class=s1>'The command "%s" was not found.'</span><span class=p>,</span> <span class=n>cmd</span><span class=p>))</span>
|
||||
</span></span><span class=line><span class=ln>12</span><span class=cl><span class=kr>end</span><span class=p>)</span>
|
||||
</span></span></code></pre></div><h5 id=variables-2 class=heading>Variables
|
||||
<a href=#variables-2 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>string</code> <strong><code>cmdStr</code></strong><br>The name of the command.</p><hr><h3 id=commandnot-executable class=heading>command.not-executable
|
||||
<a href=#commandnot-executable class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>Thrown when the user attempts to run a file that is not executable
|
||||
(like a text file, or Unix binary without +x permission).</p><h5 id=variables-3 class=heading>Variables
|
||||
<a href=#variables-3 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>string</code> <strong><code>cmdStr</code></strong><br>The name of the command.</p></div><div class="footer mt-auto"><p class="card-small text-muted">Want to help improve this page? <a href=https://github.com/Rosettea/Hilbish/issues/new/choose>Create an issue.</a></p></div></container></div><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea © 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>
|
||||
32
versions/readline-move/docs/hooks/hilbish/index.html
Normal file
32
versions/readline-move/docs/hooks/hilbish/index.html
Normal file
@ -0,0 +1,32 @@
|
||||
<!doctype html><html><head><title>Hilbish — Hilbish</title><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><meta name=theme-color content="#ff89dd"><meta content="/Hilbish/hilbish-flower.png" property="og:image"><meta property="og:site_name" content="Hilbish"><meta content="Hilbish — Hilbish" property="og:title"><meta content="hilbish.exit Sent when Hilbish is going to exit.
|
||||
Variables This signal returns no variables.
|
||||
hilbish.vimMode Sent when the Vim mode of Hilbish is changed (like from insert to normal mode). This can be used to change the prompt and notify based on Vim mode.
|
||||
Variables string modeName
|
||||
The mode that has been set. Can be these values: insert, normal, delete or replace
|
||||
hilbish.cancel Sent when the user cancels their command input with Ctrl-C" property="og:description"><meta content="hilbish.exit Sent when Hilbish is going to exit.
|
||||
Variables This signal returns no variables.
|
||||
hilbish.vimMode Sent when the Vim mode of Hilbish is changed (like from insert to normal mode). This can be used to change the prompt and notify based on Vim mode.
|
||||
Variables string modeName
|
||||
The mode that has been set. Can be these values: insert, normal, delete or replace
|
||||
hilbish.cancel Sent when the user cancels their command input with Ctrl-C" name=description><meta name=revisit-after content="2 days"><meta name=keywords content="Lua,Hilbish,Linux,Shell"><meta property="og:locale" content="en_GB"><link rel=canonical href=https://rosettea.github.io/Hilbish/><meta property="og:url" content="https://rosettea.github.io/Hilbish/"><link href=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css rel=stylesheet integrity=sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor crossorigin=anonymous><script src=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js integrity=sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2 crossorigin=anonymous></script>
|
||||
<link rel=stylesheet href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" crossorigin=anonymous referrerpolicy=no-referrer><link rel=stylesheet href=/Hilbish/versions/readline-move/css/syntax.min.eb77978873f3b324603120b558a36c98ad57d6ee7b77928e3bc131bd76c5935a.css integrity="sha256-63eXiHPzsyRgMSC1WKNsmK1X1u57d5KOO8ExvXbFk1o="></link><style>.heading>.heading-link{opacity:0}.heading:hover>.heading-link{visibility:visible;opacity:1;transition:all .1s ease-in}@keyframes highlight{0%{background:0 0}50%{background:#fff2cf}100%{background:0 0}}div:target{animation:highlight 1.2s;animation-timing-function:cubic-bezier(1,-.02,.45,.89)}table{border-width:1px;border-style:solid;border-color:#565c64;border-collapse:collapse;margin-bottom:12px}table td{padding:5px}table tr{border-width:1px}thead{display:none}</style></head><body class="d-flex flex-column min-vh-100" style=overflow-x:hidden><svg xmlns="http://www.w3.org/2000/svg" style="display:none"><symbol id="check-circle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="exclamation-triangle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><header><nav class="navbar navbar-expand-md sticky-top bg-light border-bottom"><div class=container-fluid><a class=navbar-brand href=/Hilbish><img src=/Hilbish/hilbish-logo-and-text.png alt height=48></a>
|
||||
<button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
|
||||
<span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/readline-move/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><style>@media(min-width:768px){.sidenav{width:240px}}</style><div class=row><nav class="navbar-expand-md bg-light sidenav border-end"><div class=container><div class="collapse navbar-collapse" id=navbarSupportedContent><nav class="navbar navbar-expand-md bg-light sidenav col" style=margin-top:-20px><ul class="navbar-nav me-auto mb-2 mb-lg-0 flex-column col mt-4"><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link><strong>Introduction</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/getting-started/ class=nav-link><strong>Getting Started</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/faq/ class=nav-link><strong>Frequently Asked Questions</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/ class=nav-link><strong>Features</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/completions/ class=nav-link>Completions</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/notifications/ class=nav-link>Notification</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/opts/ class=nav-link>Options</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/runner-mode/ class=nav-link>Runner Mode</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/ class=nav-link><strong>Signals</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/command/ class=nav-link>Command</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/hilbish/ class=nav-link>Hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/signal/ class=nav-link>Signal</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/lunacolors/ class=nav-link><strong>Lunacolors</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/ class=nav-link><strong>Vim Mode</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/actions/ class=nav-link>Actions</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/ class=nav-link><strong>Nature</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/dirs/ class=nav-link>Module dirs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/doc/ class=nav-link>Module doc</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/ class=nav-link><strong>API</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/bait/ class=nav-link>Module bait</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/commander/ class=nav-link>Module commander</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/fs/ class=nav-link>Module fs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/ class=nav-link>Module hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.aliases/ class=nav-link>Module hilbish.aliases</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.completion/ class=nav-link>Module hilbish.completion</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.runner/ class=nav-link>Module hilbish.runner</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.userdir/ class=nav-link>Module hilbish.userDir</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/readline/ class=nav-link>Module readline</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/snail/ class=nav-link>Module snail</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/terminal/ class=nav-link>Module terminal</a></li></ul></ul></nav></div></div></nav><container class="col mt-2" style="padding-left: 20px; padding-right: 20px;"><div><h1>Hilbish</h1><p><em></em></p><h3 id=hilbishexit class=heading>hilbish.exit
|
||||
<a href=#hilbishexit class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>Sent when Hilbish is going to exit.</p><h5 id=variables class=heading>Variables
|
||||
<a href=#variables class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This signal returns no variables.</p><hr><h3 id=hilbishvimmode class=heading>hilbish.vimMode
|
||||
<a href=#hilbishvimmode class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>Sent when the Vim mode of Hilbish is changed (like from insert to normal mode).
|
||||
This can be used to change the prompt and notify based on Vim mode.</p><h5 id=variables-1 class=heading>Variables
|
||||
<a href=#variables-1 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>string</code> <strong><code>modeName</code></strong><br>The mode that has been set.
|
||||
Can be these values: <code>insert</code>, <code>normal</code>, <code>delete</code> or <code>replace</code></p><hr><h3 id=hilbishcancel class=heading>hilbish.cancel
|
||||
<a href=#hilbishcancel class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>Sent when the user cancels their command input with Ctrl-C</p><h5 id=variables-2 class=heading>Variables
|
||||
<a href=#variables-2 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This signal returns no variables.</p><hr><h3 id=hilbishnotification class=heading>hilbish.notification
|
||||
<a href=#hilbishnotification class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>Thrown when a <a href=../../features/notifications>notification</a>
|
||||
is sent.</p><h5 id=variables-3 class=heading>Variables
|
||||
<a href=#variables-3 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>table</code> <strong><code>notification</code></strong><br>The notification. The properties are defined in the link above.</p><hr><h3 id=hilbishcd class=heading>hilbish.cd
|
||||
<a href=#hilbishcd class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>Sent when the current directory of the shell is changed (via interactive means.)
|
||||
If you are implementing a custom command that changes the directory of the shell,
|
||||
you must throw this hook manually for correctness.</p><h5 id=variables-4 class=heading>Variables
|
||||
<a href=#variables-4 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>string</code> <strong><code>path</code></strong><br>Absolute path of the directory that was changed to.</p><p><code>string</code> <strong><code>oldPath</code></strong><br>Absolute path of the directory Hilbish <em>was</em> in.</p><hr><h3 id=hilbishvimaction class=heading>hilbish.vimAction
|
||||
<a href=#hilbishvimaction class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>Sent when the user does a “vim action,” being something like yanking or pasting text.
|
||||
See <code>doc vim-mode actions</code> for more info.</p><h5 id=variables-5 class=heading>Variables
|
||||
<a href=#variables-5 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>string</code> <strong><code>actionName</code></strong><br>Absolute path of the directory that was changed to.</p><p><code>table</code> <strong><code>args</code></strong><br>Table of args relating to the Vim action.</p><hr></div><div class="footer mt-auto"><p class="card-small text-muted">Want to help improve this page? <a href=https://github.com/Rosettea/Hilbish/issues/new/choose>Create an issue.</a></p></div></container></div><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea © 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>
|
||||
6
versions/readline-move/docs/hooks/index.html
Normal file
6
versions/readline-move/docs/hooks/index.html
Normal file
@ -0,0 +1,6 @@
|
||||
<!doctype html><html><head><title>Signals — Hilbish</title><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><meta name=theme-color content="#ff89dd"><meta content="/Hilbish/hilbish-flower.png" property="og:image"><meta property="og:site_name" content="Hilbish"><meta content="Signals — Hilbish" property="og:title"><meta content="Signals are global events emitted with the Bait module. For more detail on how to use these signals, you may check the Bait page." property="og:description"><meta content="Signals are global events emitted with the Bait module. For more detail on how to use these signals, you may check the Bait page." name=description><meta name=revisit-after content="2 days"><meta name=keywords content="Lua,Hilbish,Linux,Shell"><meta property="og:locale" content="en_GB"><link rel=canonical href=https://rosettea.github.io/Hilbish/><meta property="og:url" content="https://rosettea.github.io/Hilbish/"><link href=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css rel=stylesheet integrity=sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor crossorigin=anonymous><script src=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js integrity=sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2 crossorigin=anonymous></script>
|
||||
<link rel=stylesheet href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" crossorigin=anonymous referrerpolicy=no-referrer><link rel=stylesheet href=/Hilbish/versions/readline-move/css/syntax.min.eb77978873f3b324603120b558a36c98ad57d6ee7b77928e3bc131bd76c5935a.css integrity="sha256-63eXiHPzsyRgMSC1WKNsmK1X1u57d5KOO8ExvXbFk1o="></link><style>.heading>.heading-link{opacity:0}.heading:hover>.heading-link{visibility:visible;opacity:1;transition:all .1s ease-in}@keyframes highlight{0%{background:0 0}50%{background:#fff2cf}100%{background:0 0}}div:target{animation:highlight 1.2s;animation-timing-function:cubic-bezier(1,-.02,.45,.89)}table{border-width:1px;border-style:solid;border-color:#565c64;border-collapse:collapse;margin-bottom:12px}table td{padding:5px}table tr{border-width:1px}thead{display:none}</style></head><body class="d-flex flex-column min-vh-100" style=overflow-x:hidden><svg xmlns="http://www.w3.org/2000/svg" style="display:none"><symbol id="check-circle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="exclamation-triangle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><header><nav class="navbar navbar-expand-md sticky-top bg-light border-bottom"><div class=container-fluid><a class=navbar-brand href=/Hilbish><img src=/Hilbish/hilbish-logo-and-text.png alt height=48></a>
|
||||
<button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
|
||||
<span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/readline-move/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><style>@media(min-width:768px){.sidenav{width:240px}}</style><div class=row><nav class="navbar-expand-md bg-light sidenav border-end"><div class=container><div class="collapse navbar-collapse" id=navbarSupportedContent><nav class="navbar navbar-expand-md bg-light sidenav col" style=margin-top:-20px><ul class="navbar-nav me-auto mb-2 mb-lg-0 flex-column col mt-4"><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link><strong>Introduction</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/getting-started/ class=nav-link><strong>Getting Started</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/faq/ class=nav-link><strong>Frequently Asked Questions</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/ class=nav-link><strong>Features</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/completions/ class=nav-link>Completions</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/notifications/ class=nav-link>Notification</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/opts/ class=nav-link>Options</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/runner-mode/ class=nav-link>Runner Mode</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/ class=nav-link><strong>Signals</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/command/ class=nav-link>Command</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/hilbish/ class=nav-link>Hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/signal/ class=nav-link>Signal</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/lunacolors/ class=nav-link><strong>Lunacolors</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/ class=nav-link><strong>Vim Mode</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/actions/ class=nav-link>Actions</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/ class=nav-link><strong>Nature</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/dirs/ class=nav-link>Module dirs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/doc/ class=nav-link>Module doc</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/ class=nav-link><strong>API</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/bait/ class=nav-link>Module bait</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/commander/ class=nav-link>Module commander</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/fs/ class=nav-link>Module fs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/ class=nav-link>Module hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.aliases/ class=nav-link>Module hilbish.aliases</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.completion/ class=nav-link>Module hilbish.completion</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.runner/ class=nav-link>Module hilbish.runner</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.userdir/ class=nav-link>Module hilbish.userDir</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/readline/ class=nav-link>Module readline</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/snail/ class=nav-link>Module snail</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/terminal/ class=nav-link>Module terminal</a></li></ul></ul></nav></div></div></nav><container class="col mt-2" style="padding-left: 20px; padding-right: 20px;"><div><h1>Signals</h1><p><em></em></p><p>Signals are global events emitted with the <a href=../api/bait>Bait</a>
|
||||
module.
|
||||
For more detail on how to use these signals, you may check the Bait page.</p></div><div class="footer mt-auto"><p class="card-small text-muted">Want to help improve this page? <a href=https://github.com/Rosettea/Hilbish/issues/new/choose>Create an issue.</a></p></div></container></div><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea © 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>
|
||||
24
versions/readline-move/docs/hooks/index.xml
Normal file
24
versions/readline-move/docs/hooks/index.xml
Normal file
@ -0,0 +1,24 @@
|
||||
<?xml version="1.0" encoding="utf-8" standalone="yes"?><rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Signals on Hilbish</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/hooks/</link><description>Recent content in Signals on Hilbish</description><generator>Hugo -- gohugo.io</generator><language>en-us</language><atom:link href="https://rosettea.github.io/Hilbish/versions/readline-move/docs/hooks/index.xml" rel="self" type="application/rss+xml"/><item><title/><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/hooks/job/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/hooks/job/</guid><description>Note: job refers to a job object. You can check doc jobs for more detail.
|
||||
job.start -&gt; job &gt; Thrown when a new background job starts.
|
||||
job.done -&gt; job &gt; Thrown when a background jobs exits.</description></item><item><title>Command</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/hooks/command/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/hooks/command/</guid><description>command.preexec Thrown right before a command is executed.
|
||||
Variables string input
|
||||
The raw string that the user typed. This will include the text without changes applied to it (argument substitution, alias expansion, etc.)
|
||||
string cmdStr
|
||||
The command that will be directly executed by the current runner.
|
||||
command.exit Thrown after the user&rsquo;s ran command is finished.
|
||||
Variables number code
|
||||
The exit code of what was executed.
|
||||
string cmdStr
|
||||
The command or code that was executed</description></item><item><title>Hilbish</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/hooks/hilbish/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/hooks/hilbish/</guid><description>hilbish.exit Sent when Hilbish is going to exit.
|
||||
Variables This signal returns no variables.
|
||||
hilbish.vimMode Sent when the Vim mode of Hilbish is changed (like from insert to normal mode). This can be used to change the prompt and notify based on Vim mode.
|
||||
Variables string modeName
|
||||
The mode that has been set. Can be these values: insert, normal, delete or replace
|
||||
hilbish.cancel Sent when the user cancels their command input with Ctrl-C</description></item><item><title>Signal</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/hooks/signal/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/hooks/signal/</guid><description>signal.sigint Thrown when Hilbish receive the SIGINT signal, aka when Ctrl-C is pressed.
|
||||
Variables This signal returns no variables.
|
||||
signal.resize Thrown when the terminal is resized.
|
||||
Variables This signal returns no variables.
|
||||
signal.sigusr1 Thrown when SIGUSR1 is sent to Hilbish.
|
||||
Variables This signal returns no variables.
|
||||
signal.sigusr2 Thrown when SIGUSR2 is sent to Hilbish.
|
||||
Variables This signal returns no variables.</description></item></channel></rss>
|
||||
10
versions/readline-move/docs/hooks/job/index.html
Normal file
10
versions/readline-move/docs/hooks/job/index.html
Normal file
@ -0,0 +1,10 @@
|
||||
<!doctype html><html><head><title>— Hilbish</title><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><meta name=theme-color content="#ff89dd"><meta content="/Hilbish/hilbish-flower.png" property="og:image"><meta property="og:site_name" content="Hilbish"><meta content=" — Hilbish" property="og:title"><meta content="Note: job refers to a job object. You can check doc jobs for more detail.
|
||||
job.start -> job > Thrown when a new background job starts.
|
||||
job.done -> job > Thrown when a background jobs exits." property="og:description"><meta content="Note: job refers to a job object. You can check doc jobs for more detail.
|
||||
job.start -> job > Thrown when a new background job starts.
|
||||
job.done -> job > Thrown when a background jobs exits." name=description><meta name=revisit-after content="2 days"><meta name=keywords content="Lua,Hilbish,Linux,Shell"><meta property="og:locale" content="en_GB"><link rel=canonical href=https://rosettea.github.io/Hilbish/><meta property="og:url" content="https://rosettea.github.io/Hilbish/"><link href=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css rel=stylesheet integrity=sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor crossorigin=anonymous><script src=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js integrity=sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2 crossorigin=anonymous></script>
|
||||
<link rel=stylesheet href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" crossorigin=anonymous referrerpolicy=no-referrer><link rel=stylesheet href=/Hilbish/versions/readline-move/css/syntax.min.eb77978873f3b324603120b558a36c98ad57d6ee7b77928e3bc131bd76c5935a.css integrity="sha256-63eXiHPzsyRgMSC1WKNsmK1X1u57d5KOO8ExvXbFk1o="></link><style>.heading>.heading-link{opacity:0}.heading:hover>.heading-link{visibility:visible;opacity:1;transition:all .1s ease-in}@keyframes highlight{0%{background:0 0}50%{background:#fff2cf}100%{background:0 0}}div:target{animation:highlight 1.2s;animation-timing-function:cubic-bezier(1,-.02,.45,.89)}table{border-width:1px;border-style:solid;border-color:#565c64;border-collapse:collapse;margin-bottom:12px}table td{padding:5px}table tr{border-width:1px}thead{display:none}</style></head><body class="d-flex flex-column min-vh-100" style=overflow-x:hidden><svg xmlns="http://www.w3.org/2000/svg" style="display:none"><symbol id="check-circle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="exclamation-triangle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><header><nav class="navbar navbar-expand-md sticky-top bg-light border-bottom"><div class=container-fluid><a class=navbar-brand href=/Hilbish><img src=/Hilbish/hilbish-logo-and-text.png alt height=48></a>
|
||||
<button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
|
||||
<span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/readline-move/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><main><div class="container mt-2"><h1></h1><img src='https://avatars1.githubusercontent.com/u/38820196?s=460&u=b9f4efb2375bae6cb30656d790c6e0a2939327c0&v=4' width=48 style=border-radius:100%>
|
||||
<em class=text-muted>by <strong>sammyette</strong></em><div class=my-4><p>Note: <code>job</code> refers to a job object. You can check <code>doc jobs</code> for more
|
||||
detail.</p><ul><li><p><code>job.start</code> -> job > Thrown when a new background job starts.</p></li><li><p><code>job.done</code> -> job > Thrown when a background jobs exits.</p></li></ul></div></div></main><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea © 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>
|
||||
27
versions/readline-move/docs/hooks/signal/index.html
Normal file
27
versions/readline-move/docs/hooks/signal/index.html
Normal file
@ -0,0 +1,27 @@
|
||||
<!doctype html><html><head><title>Signal — Hilbish</title><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><meta name=theme-color content="#ff89dd"><meta content="/Hilbish/hilbish-flower.png" property="og:image"><meta property="og:site_name" content="Hilbish"><meta content="Signal — Hilbish" property="og:title"><meta content="signal.sigint Thrown when Hilbish receive the SIGINT signal, aka when Ctrl-C is pressed.
|
||||
Variables This signal returns no variables.
|
||||
signal.resize Thrown when the terminal is resized.
|
||||
Variables This signal returns no variables.
|
||||
signal.sigusr1 Thrown when SIGUSR1 is sent to Hilbish.
|
||||
Variables This signal returns no variables.
|
||||
signal.sigusr2 Thrown when SIGUSR2 is sent to Hilbish.
|
||||
Variables This signal returns no variables." property="og:description"><meta content="signal.sigint Thrown when Hilbish receive the SIGINT signal, aka when Ctrl-C is pressed.
|
||||
Variables This signal returns no variables.
|
||||
signal.resize Thrown when the terminal is resized.
|
||||
Variables This signal returns no variables.
|
||||
signal.sigusr1 Thrown when SIGUSR1 is sent to Hilbish.
|
||||
Variables This signal returns no variables.
|
||||
signal.sigusr2 Thrown when SIGUSR2 is sent to Hilbish.
|
||||
Variables This signal returns no variables." name=description><meta name=revisit-after content="2 days"><meta name=keywords content="Lua,Hilbish,Linux,Shell"><meta property="og:locale" content="en_GB"><link rel=canonical href=https://rosettea.github.io/Hilbish/><meta property="og:url" content="https://rosettea.github.io/Hilbish/"><link href=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css rel=stylesheet integrity=sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor crossorigin=anonymous><script src=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js integrity=sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2 crossorigin=anonymous></script>
|
||||
<link rel=stylesheet href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" crossorigin=anonymous referrerpolicy=no-referrer><link rel=stylesheet href=/Hilbish/versions/readline-move/css/syntax.min.eb77978873f3b324603120b558a36c98ad57d6ee7b77928e3bc131bd76c5935a.css integrity="sha256-63eXiHPzsyRgMSC1WKNsmK1X1u57d5KOO8ExvXbFk1o="></link><style>.heading>.heading-link{opacity:0}.heading:hover>.heading-link{visibility:visible;opacity:1;transition:all .1s ease-in}@keyframes highlight{0%{background:0 0}50%{background:#fff2cf}100%{background:0 0}}div:target{animation:highlight 1.2s;animation-timing-function:cubic-bezier(1,-.02,.45,.89)}table{border-width:1px;border-style:solid;border-color:#565c64;border-collapse:collapse;margin-bottom:12px}table td{padding:5px}table tr{border-width:1px}thead{display:none}</style></head><body class="d-flex flex-column min-vh-100" style=overflow-x:hidden><svg xmlns="http://www.w3.org/2000/svg" style="display:none"><symbol id="check-circle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="exclamation-triangle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><header><nav class="navbar navbar-expand-md sticky-top bg-light border-bottom"><div class=container-fluid><a class=navbar-brand href=/Hilbish><img src=/Hilbish/hilbish-logo-and-text.png alt height=48></a>
|
||||
<button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
|
||||
<span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/readline-move/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><style>@media(min-width:768px){.sidenav{width:240px}}</style><div class=row><nav class="navbar-expand-md bg-light sidenav border-end"><div class=container><div class="collapse navbar-collapse" id=navbarSupportedContent><nav class="navbar navbar-expand-md bg-light sidenav col" style=margin-top:-20px><ul class="navbar-nav me-auto mb-2 mb-lg-0 flex-column col mt-4"><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link><strong>Introduction</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/getting-started/ class=nav-link><strong>Getting Started</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/faq/ class=nav-link><strong>Frequently Asked Questions</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/ class=nav-link><strong>Features</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/completions/ class=nav-link>Completions</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/notifications/ class=nav-link>Notification</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/opts/ class=nav-link>Options</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/runner-mode/ class=nav-link>Runner Mode</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/ class=nav-link><strong>Signals</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/command/ class=nav-link>Command</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/hilbish/ class=nav-link>Hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/signal/ class=nav-link>Signal</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/lunacolors/ class=nav-link><strong>Lunacolors</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/ class=nav-link><strong>Vim Mode</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/actions/ class=nav-link>Actions</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/ class=nav-link><strong>Nature</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/dirs/ class=nav-link>Module dirs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/doc/ class=nav-link>Module doc</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/ class=nav-link><strong>API</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/bait/ class=nav-link>Module bait</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/commander/ class=nav-link>Module commander</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/fs/ class=nav-link>Module fs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/ class=nav-link>Module hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.aliases/ class=nav-link>Module hilbish.aliases</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.completion/ class=nav-link>Module hilbish.completion</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.runner/ class=nav-link>Module hilbish.runner</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.userdir/ class=nav-link>Module hilbish.userDir</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/readline/ class=nav-link>Module readline</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/snail/ class=nav-link>Module snail</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/terminal/ class=nav-link>Module terminal</a></li></ul></ul></nav></div></div></nav><container class="col mt-2" style="padding-left: 20px; padding-right: 20px;"><div><h1>Signal</h1><p><em></em></p><h3 id=signalsigint class=heading>signal.sigint
|
||||
<a href=#signalsigint class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>Thrown when Hilbish receive the SIGINT signal,
|
||||
aka when Ctrl-C is pressed.</p><h5 id=variables class=heading>Variables
|
||||
<a href=#variables class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This signal returns no variables.</p><hr><h3 id=signalresize class=heading>signal.resize
|
||||
<a href=#signalresize class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>Thrown when the terminal is resized.</p><h5 id=variables-1 class=heading>Variables
|
||||
<a href=#variables-1 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This signal returns no variables.</p><hr><h3 id=signalsigusr1 class=heading>signal.sigusr1
|
||||
<a href=#signalsigusr1 class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>Thrown when SIGUSR1 is sent to Hilbish.</p><h5 id=variables-2 class=heading>Variables
|
||||
<a href=#variables-2 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This signal returns no variables.</p><hr><h3 id=signalsigusr2 class=heading>signal.sigusr2
|
||||
<a href=#signalsigusr2 class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>Thrown when SIGUSR2 is sent to Hilbish.</p><h5 id=variables-3 class=heading>Variables
|
||||
<a href=#variables-3 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p>This signal returns no variables.</p></div><div class="footer mt-auto"><p class="card-small text-muted">Want to help improve this page? <a href=https://github.com/Rosettea/Hilbish/issues/new/choose>Create an issue.</a></p></div></container></div><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea © 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>
|
||||
9
versions/readline-move/docs/index.html
Normal file
9
versions/readline-move/docs/index.html
Normal file
@ -0,0 +1,9 @@
|
||||
<!doctype html><html><head><title>Introduction — Hilbish</title><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><meta name=theme-color content="#ff89dd"><meta content="/Hilbish/hilbish-flower.png" property="og:image"><meta property="og:site_name" content="Hilbish"><meta content="Introduction — Hilbish" property="og:title"><meta content="Hilbish is a hyper-extensible shell mainly intended for interactive use. To enhance the interactive experience, Hilbish comes with a wide range of features and sane defaults, including a nice looking prompt, advanced completion menus and history search.
|
||||
Here documents some of the features of Hilbish and the Lua API." property="og:description"><meta content="Hilbish is a hyper-extensible shell mainly intended for interactive use. To enhance the interactive experience, Hilbish comes with a wide range of features and sane defaults, including a nice looking prompt, advanced completion menus and history search.
|
||||
Here documents some of the features of Hilbish and the Lua API." name=description><meta name=revisit-after content="2 days"><meta name=keywords content="Lua,Hilbish,Linux,Shell"><meta property="og:locale" content="en_GB"><link rel=canonical href=https://rosettea.github.io/Hilbish/><meta property="og:url" content="https://rosettea.github.io/Hilbish/"><link href=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css rel=stylesheet integrity=sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor crossorigin=anonymous><script src=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js integrity=sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2 crossorigin=anonymous></script>
|
||||
<link rel=stylesheet href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" crossorigin=anonymous referrerpolicy=no-referrer><link rel=stylesheet href=/Hilbish/versions/readline-move/css/syntax.min.eb77978873f3b324603120b558a36c98ad57d6ee7b77928e3bc131bd76c5935a.css integrity="sha256-63eXiHPzsyRgMSC1WKNsmK1X1u57d5KOO8ExvXbFk1o="></link><style>.heading>.heading-link{opacity:0}.heading:hover>.heading-link{visibility:visible;opacity:1;transition:all .1s ease-in}@keyframes highlight{0%{background:0 0}50%{background:#fff2cf}100%{background:0 0}}div:target{animation:highlight 1.2s;animation-timing-function:cubic-bezier(1,-.02,.45,.89)}table{border-width:1px;border-style:solid;border-color:#565c64;border-collapse:collapse;margin-bottom:12px}table td{padding:5px}table tr{border-width:1px}thead{display:none}</style></head><body class="d-flex flex-column min-vh-100" style=overflow-x:hidden><svg xmlns="http://www.w3.org/2000/svg" style="display:none"><symbol id="check-circle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="exclamation-triangle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><header><nav class="navbar navbar-expand-md sticky-top bg-light border-bottom"><div class=container-fluid><a class=navbar-brand href=/Hilbish><img src=/Hilbish/hilbish-logo-and-text.png alt height=48></a>
|
||||
<button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
|
||||
<span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/readline-move/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class="nav-link active">Docs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><style>@media(min-width:768px){.sidenav{width:240px}}</style><div class=row><nav class="navbar-expand-md bg-light sidenav border-end"><div class=container><div class="collapse navbar-collapse" id=navbarSupportedContent><nav class="navbar navbar-expand-md bg-light sidenav col" style=margin-top:-20px><ul class="navbar-nav me-auto mb-2 mb-lg-0 flex-column col mt-4"><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link><strong>Introduction</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/getting-started/ class=nav-link><strong>Getting Started</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/faq/ class=nav-link><strong>Frequently Asked Questions</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/ class=nav-link><strong>Features</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/completions/ class=nav-link>Completions</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/notifications/ class=nav-link>Notification</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/opts/ class=nav-link>Options</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/runner-mode/ class=nav-link>Runner Mode</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/ class=nav-link><strong>Signals</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/command/ class=nav-link>Command</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/hilbish/ class=nav-link>Hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/signal/ class=nav-link>Signal</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/lunacolors/ class=nav-link><strong>Lunacolors</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/ class=nav-link><strong>Vim Mode</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/actions/ class=nav-link>Actions</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/ class=nav-link><strong>Nature</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/dirs/ class=nav-link>Module dirs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/doc/ class=nav-link>Module doc</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/ class=nav-link><strong>API</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/bait/ class=nav-link>Module bait</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/commander/ class=nav-link>Module commander</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/fs/ class=nav-link>Module fs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/ class=nav-link>Module hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.aliases/ class=nav-link>Module hilbish.aliases</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.completion/ class=nav-link>Module hilbish.completion</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.runner/ class=nav-link>Module hilbish.runner</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.userdir/ class=nav-link>Module hilbish.userDir</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/readline/ class=nav-link>Module readline</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/snail/ class=nav-link>Module snail</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/terminal/ class=nav-link>Module terminal</a></li></ul></ul></nav></div></div></nav><container class="col mt-2" style="padding-left: 20px; padding-right: 20px;"><div><h1>Introduction</h1><p><em>Last updated Dec 26, 2023<br></em></p><p>Hilbish is a hyper-extensible shell mainly intended for interactive use.
|
||||
To enhance the interactive experience, Hilbish comes with a wide range
|
||||
of features and sane defaults, including a nice looking prompt,
|
||||
advanced completion menus and history search.</p><p>Here documents some of the features of Hilbish and the Lua API.</p></div><div class="footer mt-auto"><p class="card-small text-muted">Want to help improve this page? <a href=https://github.com/Rosettea/Hilbish/issues/new/choose>Create an issue.</a></p></div></container></div><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea © 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>
|
||||
11
versions/readline-move/docs/index.xml
Normal file
11
versions/readline-move/docs/index.xml
Normal file
@ -0,0 +1,11 @@
|
||||
<?xml version="1.0" encoding="utf-8" standalone="yes"?><rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Introduction on Hilbish</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/</link><description>Recent content in Introduction on Hilbish</description><generator>Hugo -- gohugo.io</generator><language>en-us</language><atom:link href="https://rosettea.github.io/Hilbish/versions/readline-move/docs/index.xml" rel="self" type="application/rss+xml"/><item><title>Lunacolors</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/lunacolors/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/lunacolors/</guid><description>Lunacolors is an ANSI color/styling library for Lua. It is included by default in standard Hilbish distributions to provide easy styling for things like prompts and text.
|
||||
For simple usage, a single color or style is enough. For example, you can just use lunacolors.blue 'Hello world' and that&rsquo;ll return blue text which you can print. This includes styles like bold, underline, etc.
|
||||
In other usage, you may want to use a format string instead of having multiple nested functions for different styles.</description></item><item><title>Frequently Asked Questions</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/faq/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/faq/</guid><description>Is Hilbish POSIX compliant? No, it is not. POSIX compliance is a non-goal. Perhaps in the future, someone would be able to write a native plugin to support shell scripting (which would be against it&rsquo;s main goal, but &hellip;.)
|
||||
Windows Support? It compiles for Windows (CI ensures it does), but otherwise it is not directly supported. If you&rsquo;d like to improve this situation, checkout the discussion .
|
||||
Why? Hilbish emerged from the desire of a Lua configured shell.</description></item><item><title>Getting Started</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/getting-started/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/getting-started/</guid><description>To start Hilbish, open a terminal. If Hilbish has been installed and is not the default shell, you can simply run hilbish to start it. This will launch a normal interactive session. To exit, you can either run the exit command or hit Ctrl+D.
|
||||
Setting as Default Login shell There are a few ways to make Hilbish your default shell. A simple way is to make it your user/login shell.</description></item><item><title/><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/jobs/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/jobs/</guid><description>(This has mainly been replaced by hilbish.jobs ).
|
||||
Hilbish has pretty standard job control. It&rsquo;s missing one or two things, but works well. One thing which is different from other shells (besides Hilbish) itself is the API for jobs, and of course it&rsquo;s in Lua. You can add jobs, stop and delete (disown) them and even get output.
|
||||
Job Interface The job interface refers to hilbish.jobs.
|
||||
Functions (Note that in the list here, they&rsquo;re called from hilbish.</description></item><item><title/><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/timers/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/timers/</guid><description>This has been moved to the hilbish.timers API doc (accessible by doc api hilbish.timers)</description></item><item><title>Completions</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/completions/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/completions/</guid><description>Completions for commands can be created with the hilbish.complete function. See the link for how to use it.
|
||||
To create completions for a command is simple. The callback will be passed 3 parameters:
|
||||
query (string): The text that the user is currently trying to complete. This should be used to match entries. ctx (string): Contains the entire line. Use this if more text is needed to be parsed for context. fields (string): The ctx split up by spaces.</description></item></channel></rss>
|
||||
33
versions/readline-move/docs/jobs/index.html
Normal file
33
versions/readline-move/docs/jobs/index.html
Normal file
@ -0,0 +1,33 @@
|
||||
<!doctype html><html><head><title>— Hilbish</title><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><meta name=theme-color content="#ff89dd"><meta content="/Hilbish/hilbish-flower.png" property="og:image"><meta property="og:site_name" content="Hilbish"><meta content=" — Hilbish" property="og:title"><meta content="(This has mainly been replaced by hilbish.jobs ).
|
||||
Hilbish has pretty standard job control. It’s missing one or two things, but works well. One thing which is different from other shells (besides Hilbish) itself is the API for jobs, and of course it’s in Lua. You can add jobs, stop and delete (disown) them and even get output.
|
||||
Job Interface The job interface refers to hilbish.jobs.
|
||||
Functions (Note that in the list here, they’re called from hilbish." property="og:description"><meta content="(This has mainly been replaced by hilbish.jobs ).
|
||||
Hilbish has pretty standard job control. It’s missing one or two things, but works well. One thing which is different from other shells (besides Hilbish) itself is the API for jobs, and of course it’s in Lua. You can add jobs, stop and delete (disown) them and even get output.
|
||||
Job Interface The job interface refers to hilbish.jobs.
|
||||
Functions (Note that in the list here, they’re called from hilbish." name=description><meta name=revisit-after content="2 days"><meta name=keywords content="Lua,Hilbish,Linux,Shell"><meta property="og:locale" content="en_GB"><link rel=canonical href=https://rosettea.github.io/Hilbish/><meta property="og:url" content="https://rosettea.github.io/Hilbish/"><link href=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css rel=stylesheet integrity=sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor crossorigin=anonymous><script src=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js integrity=sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2 crossorigin=anonymous></script>
|
||||
<link rel=stylesheet href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" crossorigin=anonymous referrerpolicy=no-referrer><link rel=stylesheet href=/Hilbish/versions/readline-move/css/syntax.min.eb77978873f3b324603120b558a36c98ad57d6ee7b77928e3bc131bd76c5935a.css integrity="sha256-63eXiHPzsyRgMSC1WKNsmK1X1u57d5KOO8ExvXbFk1o="></link><style>.heading>.heading-link{opacity:0}.heading:hover>.heading-link{visibility:visible;opacity:1;transition:all .1s ease-in}@keyframes highlight{0%{background:0 0}50%{background:#fff2cf}100%{background:0 0}}div:target{animation:highlight 1.2s;animation-timing-function:cubic-bezier(1,-.02,.45,.89)}table{border-width:1px;border-style:solid;border-color:#565c64;border-collapse:collapse;margin-bottom:12px}table td{padding:5px}table tr{border-width:1px}thead{display:none}</style></head><body class="d-flex flex-column min-vh-100" style=overflow-x:hidden><svg xmlns="http://www.w3.org/2000/svg" style="display:none"><symbol id="check-circle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="exclamation-triangle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><header><nav class="navbar navbar-expand-md sticky-top bg-light border-bottom"><div class=container-fluid><a class=navbar-brand href=/Hilbish><img src=/Hilbish/hilbish-logo-and-text.png alt height=48></a>
|
||||
<button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
|
||||
<span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/readline-move/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><main><div class="container mt-2"><h1></h1><img src='https://avatars1.githubusercontent.com/u/38820196?s=460&u=b9f4efb2375bae6cb30656d790c6e0a2939327c0&v=4' width=48 style=border-radius:100%>
|
||||
<em class=text-muted>by <strong>sammyette</strong></em><div class=my-4><p>(This has mainly been replaced by <a href=../api/hilbish.jobs>hilbish.jobs</a>
|
||||
).</p><p>Hilbish has pretty standard job control. It’s missing one or two things,
|
||||
but works well. One thing which is different from other shells
|
||||
(besides Hilbish) itself is the API for jobs, and of course it’s in Lua.
|
||||
You can add jobs, stop and delete (disown) them and even get output.</p><h2 id=job-interface class=heading>Job Interface
|
||||
<a href=#job-interface class=heading-link><i class="fas fa-paperclip"></i></a></h2><p>The job interface refers to <code>hilbish.jobs</code>.</p><h3 id=functions class=heading>Functions
|
||||
<a href=#functions class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>(Note that in the list here, they’re called from <code>hilbish.jobs</code>, so
|
||||
a listing of <code>foo</code> would mean <code>hilbish.jobs.foo</code>)</p><ul><li><code>all()</code> -> {jobs}: Returns a table of all jobs.</li><li><code>last()</code> -> job: Returns the last added job.</li><li><code>get(id)</code> -> job: Get a job by its ID.</li><li><code>add(cmdstr, args, execPath)</code> -> job: Adds a new job to the job table.
|
||||
Note that this does not run the command; You have to start it manually.
|
||||
<code>cmdstr</code> is the user’s input for the job, <code>args</code> is a table of arguments
|
||||
for the command. It includes arg0 (don’t set it as entry 0 in the table)
|
||||
and <code>execPath</code> is an absolute path for the command executable.</li><li><code>disown(id)</code>: Removes a job by ID from the job table.</li></ul><h2 id=job-object class=heading>Job Object
|
||||
<a href=#job-object class=heading-link><i class="fas fa-paperclip"></i></a></h2><p>A job object is a piece of <code>userdata</code>. All the functions of a job require
|
||||
you to call them with a colon, since they are <em>methods</em> for the job object.
|
||||
Example: hilbish.jobs.last():foreground()
|
||||
Which will foreground the last job.</p><p>You can still have a job object for a disowned job,
|
||||
it just won’t be <em>working</em> anywhere. :^)</p><h3 id=properties class=heading>Properties
|
||||
<a href=#properties class=heading-link><i class="fas fa-paperclip"></i></a></h3><ul><li><code>cmd</code>: command string</li><li><code>running</code>: boolean whether the job is running</li><li><code>id</code>: unique id for the job</li><li><code>pid</code>: process id for the job</li><li><code>exitCode</code>: exit code of the job
|
||||
In ordinary cases you’d prefer to use the <code>id</code> instead of <code>pid</code>.
|
||||
The <code>id</code> is unique to Hilbish and is how you get jobs with the
|
||||
<code>hilbish.jobs</code> interface. It may also not describe the job entirely.</li></ul><h3 id=functions-1 class=heading>Functions
|
||||
<a href=#functions-1 class=heading-link><i class="fas fa-paperclip"></i></a></h3><ul><li><code>stop()</code>: Stops the job.</li><li><code>start()</code>: Starts the job.</li><li><code>foreground()</code>: Set the job as the current running foreground process, or
|
||||
run it in the foreground after it has been suspended.</li><li><code>background()</code>: Run the job in the background after it has been suspended.</li></ul></div></div></main><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea © 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>
|
||||
19
versions/readline-move/docs/lunacolors/index.html
Normal file
19
versions/readline-move/docs/lunacolors/index.html
Normal file
@ -0,0 +1,19 @@
|
||||
<!doctype html><html><head><title>Lunacolors — Hilbish</title><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><meta name=theme-color content="#ff89dd"><meta content="/Hilbish/hilbish-flower.png" property="og:image"><meta property="og:site_name" content="Hilbish"><meta content="Lunacolors — Hilbish" property="og:title"><meta content="Lunacolors is an ANSI color/styling library for Lua. It is included by default in standard Hilbish distributions to provide easy styling for things like prompts and text.
|
||||
For simple usage, a single color or style is enough. For example, you can just use lunacolors.blue 'Hello world' and that’ll return blue text which you can print. This includes styles like bold, underline, etc.
|
||||
In other usage, you may want to use a format string instead of having multiple nested functions for different styles." property="og:description"><meta content="Lunacolors is an ANSI color/styling library for Lua. It is included by default in standard Hilbish distributions to provide easy styling for things like prompts and text.
|
||||
For simple usage, a single color or style is enough. For example, you can just use lunacolors.blue 'Hello world' and that’ll return blue text which you can print. This includes styles like bold, underline, etc.
|
||||
In other usage, you may want to use a format string instead of having multiple nested functions for different styles." name=description><meta name=revisit-after content="2 days"><meta name=keywords content="Lua,Hilbish,Linux,Shell"><meta property="og:locale" content="en_GB"><link rel=canonical href=https://rosettea.github.io/Hilbish/><meta property="og:url" content="https://rosettea.github.io/Hilbish/"><link href=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css rel=stylesheet integrity=sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor crossorigin=anonymous><script src=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js integrity=sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2 crossorigin=anonymous></script>
|
||||
<link rel=stylesheet href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" crossorigin=anonymous referrerpolicy=no-referrer><link rel=stylesheet href=/Hilbish/versions/readline-move/css/syntax.min.eb77978873f3b324603120b558a36c98ad57d6ee7b77928e3bc131bd76c5935a.css integrity="sha256-63eXiHPzsyRgMSC1WKNsmK1X1u57d5KOO8ExvXbFk1o="></link><style>.heading>.heading-link{opacity:0}.heading:hover>.heading-link{visibility:visible;opacity:1;transition:all .1s ease-in}@keyframes highlight{0%{background:0 0}50%{background:#fff2cf}100%{background:0 0}}div:target{animation:highlight 1.2s;animation-timing-function:cubic-bezier(1,-.02,.45,.89)}table{border-width:1px;border-style:solid;border-color:#565c64;border-collapse:collapse;margin-bottom:12px}table td{padding:5px}table tr{border-width:1px}thead{display:none}</style></head><body class="d-flex flex-column min-vh-100" style=overflow-x:hidden><svg xmlns="http://www.w3.org/2000/svg" style="display:none"><symbol id="check-circle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="exclamation-triangle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><header><nav class="navbar navbar-expand-md sticky-top bg-light border-bottom"><div class=container-fluid><a class=navbar-brand href=/Hilbish><img src=/Hilbish/hilbish-logo-and-text.png alt height=48></a>
|
||||
<button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
|
||||
<span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/readline-move/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><style>@media(min-width:768px){.sidenav{width:240px}}</style><div class=row><nav class="navbar-expand-md bg-light sidenav border-end"><div class=container><div class="collapse navbar-collapse" id=navbarSupportedContent><nav class="navbar navbar-expand-md bg-light sidenav col" style=margin-top:-20px><ul class="navbar-nav me-auto mb-2 mb-lg-0 flex-column col mt-4"><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link><strong>Introduction</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/getting-started/ class=nav-link><strong>Getting Started</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/faq/ class=nav-link><strong>Frequently Asked Questions</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/ class=nav-link><strong>Features</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/completions/ class=nav-link>Completions</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/notifications/ class=nav-link>Notification</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/opts/ class=nav-link>Options</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/runner-mode/ class=nav-link>Runner Mode</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/ class=nav-link><strong>Signals</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/command/ class=nav-link>Command</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/hilbish/ class=nav-link>Hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/signal/ class=nav-link>Signal</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/lunacolors/ class=nav-link><strong>Lunacolors</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/ class=nav-link><strong>Vim Mode</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/actions/ class=nav-link>Actions</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/ class=nav-link><strong>Nature</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/dirs/ class=nav-link>Module dirs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/doc/ class=nav-link>Module doc</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/ class=nav-link><strong>API</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/bait/ class=nav-link>Module bait</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/commander/ class=nav-link>Module commander</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/fs/ class=nav-link>Module fs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/ class=nav-link>Module hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.aliases/ class=nav-link>Module hilbish.aliases</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.completion/ class=nav-link>Module hilbish.completion</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.runner/ class=nav-link>Module hilbish.runner</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.userdir/ class=nav-link>Module hilbish.userDir</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/readline/ class=nav-link>Module readline</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/snail/ class=nav-link>Module snail</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/terminal/ class=nav-link>Module terminal</a></li></ul></ul></nav></div></div></nav><container class="col mt-2" style="padding-left: 20px; padding-right: 20px;"><div><h1>Lunacolors</h1><p><em></em></p><p>Lunacolors is an ANSI color/styling library for Lua. It is included
|
||||
by default in standard Hilbish distributions to provide easy styling
|
||||
for things like prompts and text.</p><p>For simple usage, a single color or style is enough. For example,
|
||||
you can just use <code>lunacolors.blue 'Hello world'</code> and that’ll return
|
||||
blue text which you can print. This includes styles like bold,
|
||||
underline, etc.</p><p>In other usage, you may want to use a format string instead of having
|
||||
multiple nested functions for different styles. This is where the format
|
||||
function comes in. You can used named keywords to style a section of text.</p><p>The list of arguments are:<br>Colors:</p><ul><li>black</li><li>red</li><li>green</li><li>yellow</li><li>blue</li><li>magenta</li><li>cyan</li><li>white</li></ul><p>Styles:</p><ul><li>reset</li><li>bold</li><li>dim</li><li>italic</li><li>underline</li><li>invert</li></ul><p>For the colors, there are background and bright variants. Background color
|
||||
variants have a <code>Bg</code> suffix, while bright variants use the <code>bright</code> prefix.
|
||||
These can also be combined. Note that appropriate camel casing must be applied.
|
||||
For example, bright blue would be written as <code>brightBlue</code>, a cyan background as
|
||||
<code>cyanBg</code>, and combining them would result in <code>brightBlueBg</code>.</p></div><div class="footer mt-auto"><p class="card-small text-muted">Want to help improve this page? <a href=https://github.com/Rosettea/Hilbish/issues/new/choose>Create an issue.</a></p></div></container></div><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea © 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>
|
||||
18
versions/readline-move/docs/nature/dirs/index.html
Normal file
18
versions/readline-move/docs/nature/dirs/index.html
Normal file
@ -0,0 +1,18 @@
|
||||
<!doctype html><html><head><title>Module dirs — Hilbish</title><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><meta name=theme-color content="#ff89dd"><meta content="/Hilbish/hilbish-flower.png" property="og:image"><meta property="og:site_name" content="Hilbish"><meta content="Module dirs — Hilbish" property="og:title"><meta content="internal directory management" property="og:description"><meta content="internal directory management" name=description><meta name=revisit-after content="2 days"><meta name=keywords content="Lua,Hilbish,Linux,Shell"><meta property="og:locale" content="en_GB"><link rel=canonical href=https://rosettea.github.io/Hilbish/><meta property="og:url" content="https://rosettea.github.io/Hilbish/"><link href=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css rel=stylesheet integrity=sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor crossorigin=anonymous><script src=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js integrity=sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2 crossorigin=anonymous></script>
|
||||
<link rel=stylesheet href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" crossorigin=anonymous referrerpolicy=no-referrer><link rel=stylesheet href=/Hilbish/versions/readline-move/css/syntax.min.eb77978873f3b324603120b558a36c98ad57d6ee7b77928e3bc131bd76c5935a.css integrity="sha256-63eXiHPzsyRgMSC1WKNsmK1X1u57d5KOO8ExvXbFk1o="></link><style>.heading>.heading-link{opacity:0}.heading:hover>.heading-link{visibility:visible;opacity:1;transition:all .1s ease-in}@keyframes highlight{0%{background:0 0}50%{background:#fff2cf}100%{background:0 0}}div:target{animation:highlight 1.2s;animation-timing-function:cubic-bezier(1,-.02,.45,.89)}table{border-width:1px;border-style:solid;border-color:#565c64;border-collapse:collapse;margin-bottom:12px}table td{padding:5px}table tr{border-width:1px}thead{display:none}</style></head><body class="d-flex flex-column min-vh-100" style=overflow-x:hidden><svg xmlns="http://www.w3.org/2000/svg" style="display:none"><symbol id="check-circle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="exclamation-triangle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><header><nav class="navbar navbar-expand-md sticky-top bg-light border-bottom"><div class=container-fluid><a class=navbar-brand href=/Hilbish><img src=/Hilbish/hilbish-logo-and-text.png alt height=48></a>
|
||||
<button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
|
||||
<span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/readline-move/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><style>@media(min-width:768px){.sidenav{width:240px}}</style><div class=row><nav class="navbar-expand-md bg-light sidenav border-end"><div class=container><div class="collapse navbar-collapse" id=navbarSupportedContent><nav class="navbar navbar-expand-md bg-light sidenav col" style=margin-top:-20px><ul class="navbar-nav me-auto mb-2 mb-lg-0 flex-column col mt-4"><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link><strong>Introduction</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/getting-started/ class=nav-link><strong>Getting Started</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/faq/ class=nav-link><strong>Frequently Asked Questions</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/ class=nav-link><strong>Features</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/completions/ class=nav-link>Completions</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/notifications/ class=nav-link>Notification</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/opts/ class=nav-link>Options</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/runner-mode/ class=nav-link>Runner Mode</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/ class=nav-link><strong>Signals</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/command/ class=nav-link>Command</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/hilbish/ class=nav-link>Hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/signal/ class=nav-link>Signal</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/lunacolors/ class=nav-link><strong>Lunacolors</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/ class=nav-link><strong>Vim Mode</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/actions/ class=nav-link>Actions</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/ class=nav-link><strong>Nature</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/dirs/ class=nav-link>Module dirs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/doc/ class=nav-link>Module doc</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/ class=nav-link><strong>API</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/bait/ class=nav-link>Module bait</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/commander/ class=nav-link>Module commander</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/fs/ class=nav-link>Module fs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/ class=nav-link>Module hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.aliases/ class=nav-link>Module hilbish.aliases</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.completion/ class=nav-link>Module hilbish.completion</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.runner/ class=nav-link>Module hilbish.runner</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.userdir/ class=nav-link>Module hilbish.userDir</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/readline/ class=nav-link>Module readline</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/snail/ class=nav-link>Module snail</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/terminal/ class=nav-link>Module terminal</a></li></ul></ul></nav></div></div></nav><container class="col mt-2" style="padding-left: 20px; padding-right: 20px;"><div><h1>Module dirs</h1><p><em>internal directory management<br></em></p><h3 id=introduction class=heading>Introduction
|
||||
<a href=#introduction class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>The dirs module defines a small set of functions to store and manage
|
||||
directories.</p><h3 id=functions class=heading>Functions
|
||||
<a href=#functions class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><a href=#setOld>setOld(d)</a></td><td>Sets the old directory string.</td></tr><tr><td><a href=#recent>recent(idx)</a></td><td>Get entry from recent directories list based on index.</td></tr><tr><td><a href=#push>push(dir)</a></td><td>Add <code>dir</code> to the recent directories list.</td></tr><tr><td><a href=#pop>pop(num)</a></td><td>Remove the specified amount of dirs from the recent directories list.</td></tr><tr><td><a href=#peak>peak(num)</a></td><td>Look at <code>num</code> amount of recent directories, starting from the latest.</td></tr></tbody></table><hr><div id=peak><h4 class=heading>dirs.peak(num)
|
||||
<a href=#peak class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Look at <code>num</code> amount of recent directories, starting from the latest.
|
||||
This returns a table of recent directories, up to the <code>num</code> amount.</p><h5 id=parameters class=heading>Parameters
|
||||
<a href=#parameters class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>num</code> <strong><code>number</code></strong></p></div><hr><div id=pop><h4 class=heading>dirs.pop(num)
|
||||
<a href=#pop class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Remove the specified amount of dirs from the recent directories list.</p><h5 id=parameters-1 class=heading>Parameters
|
||||
<a href=#parameters-1 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>num</code> <strong><code>number</code></strong></p></div><hr><div id=push><h4 class=heading>dirs.push(dir)
|
||||
<a href=#push class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Add <code>dir</code> to the recent directories list.</p><h5 id=parameters-2 class=heading>Parameters
|
||||
<a href=#parameters-2 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>dir</code> <strong><code>string</code></strong></p></div><hr><div id=recent><h4 class=heading>dirs.recent(idx)
|
||||
<a href=#recent class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Get entry from recent directories list based on index.</p><h5 id=parameters-3 class=heading>Parameters
|
||||
<a href=#parameters-3 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>idx</code> <strong><code>number</code></strong></p></div><hr><div id=setOld><h4 class=heading>dirs.setOld(d)
|
||||
<a href=#setOld class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Sets the old directory string.</p><h5 id=parameters-4 class=heading>Parameters
|
||||
<a href=#parameters-4 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>d</code> <strong><code>string</code></strong></p></div></div><div class="footer mt-auto"><p class="card-small text-muted">Want to help improve this page? <a href=https://github.com/Rosettea/Hilbish/issues/new/choose>Create an issue.</a></p></div></container></div><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea © 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>
|
||||
18
versions/readline-move/docs/nature/doc/index.html
Normal file
18
versions/readline-move/docs/nature/doc/index.html
Normal file
@ -0,0 +1,18 @@
|
||||
<!doctype html><html><head><title>Module doc — Hilbish</title><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><meta name=theme-color content="#ff89dd"><meta content="/Hilbish/hilbish-flower.png" property="og:image"><meta property="og:site_name" content="Hilbish"><meta content="Module doc — Hilbish" property="og:title"><meta content="command-line doc rendering" property="og:description"><meta content="command-line doc rendering" name=description><meta name=revisit-after content="2 days"><meta name=keywords content="Lua,Hilbish,Linux,Shell"><meta property="og:locale" content="en_GB"><link rel=canonical href=https://rosettea.github.io/Hilbish/><meta property="og:url" content="https://rosettea.github.io/Hilbish/"><link href=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css rel=stylesheet integrity=sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor crossorigin=anonymous><script src=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js integrity=sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2 crossorigin=anonymous></script>
|
||||
<link rel=stylesheet href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" crossorigin=anonymous referrerpolicy=no-referrer><link rel=stylesheet href=/Hilbish/versions/readline-move/css/syntax.min.eb77978873f3b324603120b558a36c98ad57d6ee7b77928e3bc131bd76c5935a.css integrity="sha256-63eXiHPzsyRgMSC1WKNsmK1X1u57d5KOO8ExvXbFk1o="></link><style>.heading>.heading-link{opacity:0}.heading:hover>.heading-link{visibility:visible;opacity:1;transition:all .1s ease-in}@keyframes highlight{0%{background:0 0}50%{background:#fff2cf}100%{background:0 0}}div:target{animation:highlight 1.2s;animation-timing-function:cubic-bezier(1,-.02,.45,.89)}table{border-width:1px;border-style:solid;border-color:#565c64;border-collapse:collapse;margin-bottom:12px}table td{padding:5px}table tr{border-width:1px}thead{display:none}</style></head><body class="d-flex flex-column min-vh-100" style=overflow-x:hidden><svg xmlns="http://www.w3.org/2000/svg" style="display:none"><symbol id="check-circle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="exclamation-triangle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><header><nav class="navbar navbar-expand-md sticky-top bg-light border-bottom"><div class=container-fluid><a class=navbar-brand href=/Hilbish><img src=/Hilbish/hilbish-logo-and-text.png alt height=48></a>
|
||||
<button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
|
||||
<span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/readline-move/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><style>@media(min-width:768px){.sidenav{width:240px}}</style><div class=row><nav class="navbar-expand-md bg-light sidenav border-end"><div class=container><div class="collapse navbar-collapse" id=navbarSupportedContent><nav class="navbar navbar-expand-md bg-light sidenav col" style=margin-top:-20px><ul class="navbar-nav me-auto mb-2 mb-lg-0 flex-column col mt-4"><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link><strong>Introduction</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/getting-started/ class=nav-link><strong>Getting Started</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/faq/ class=nav-link><strong>Frequently Asked Questions</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/ class=nav-link><strong>Features</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/completions/ class=nav-link>Completions</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/notifications/ class=nav-link>Notification</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/opts/ class=nav-link>Options</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/runner-mode/ class=nav-link>Runner Mode</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/ class=nav-link><strong>Signals</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/command/ class=nav-link>Command</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/hilbish/ class=nav-link>Hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/signal/ class=nav-link>Signal</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/lunacolors/ class=nav-link><strong>Lunacolors</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/ class=nav-link><strong>Vim Mode</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/actions/ class=nav-link>Actions</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/ class=nav-link><strong>Nature</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/dirs/ class=nav-link>Module dirs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/doc/ class=nav-link>Module doc</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/ class=nav-link><strong>API</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/bait/ class=nav-link>Module bait</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/commander/ class=nav-link>Module commander</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/fs/ class=nav-link>Module fs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/ class=nav-link>Module hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.aliases/ class=nav-link>Module hilbish.aliases</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.completion/ class=nav-link>Module hilbish.completion</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.runner/ class=nav-link>Module hilbish.runner</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.userdir/ class=nav-link>Module hilbish.userDir</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/readline/ class=nav-link>Module readline</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/snail/ class=nav-link>Module snail</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/terminal/ class=nav-link>Module terminal</a></li></ul></ul></nav></div></div></nav><container class="col mt-2" style="padding-left: 20px; padding-right: 20px;"><div><h1>Module doc</h1><p><em>command-line doc rendering<br></em></p><h3 id=introduction class=heading>Introduction
|
||||
<a href=#introduction class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>The doc module contains a small set of functions
|
||||
used by the Greenhouse pager to render parts of the documentation pages.
|
||||
This is only documented for the sake of it. It’s only intended use
|
||||
is by the Greenhouse pager.</p><h3 id=functions class=heading>Functions
|
||||
<a href=#functions class=heading-link><i class="fas fa-paperclip"></i></a></h3><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><a href=#renderInfoBlock>renderInfoBlock(type, text)</a></td><td>Renders an info block. An info block is a block of text with</td></tr><tr><td><a href=#renderCodeBlock>renderCodeBlock(text)</a></td><td>Assembles and renders a code block. This returns</td></tr><tr><td><a href=#highlight>highlight(text)</a></td><td>Performs basic Lua code highlighting.</td></tr></tbody></table><hr><div id=highlight><h4 class=heading>doc.highlight(text)
|
||||
<a href=#highlight class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Performs basic Lua code highlighting.</p><h5 id=parameters class=heading>Parameters
|
||||
<a href=#parameters class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>text</code> <strong><code>string</code></strong><br>Code/text to do highlighting on.</p></div><hr><div id=renderCodeBlock><h4 class=heading>doc.renderCodeBlock(text)
|
||||
<a href=#renderCodeBlock class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Assembles and renders a code block. This returns
|
||||
the supplied text based on the number of command line columns,
|
||||
and styles it to resemble a code block.</p><h5 id=parameters-1 class=heading>Parameters
|
||||
<a href=#parameters-1 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>text</code> <strong><code>string</code></strong></p></div><hr><div id=renderInfoBlock><h4 class=heading>doc.renderInfoBlock(type, text)
|
||||
<a href=#renderInfoBlock class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Renders an info block. An info block is a block of text with
|
||||
an icon and styled text block.</p><h5 id=parameters-2 class=heading>Parameters
|
||||
<a href=#parameters-2 class=heading-link><i class="fas fa-paperclip"></i></a></h5><p><code>type</code> <strong><code>string</code></strong><br>Type of info block. The only one specially styled is the <code>warning</code>.</p><p><code>text</code> <strong><code>string</code></strong></p></div></div><div class="footer mt-auto"><p class="card-small text-muted">Want to help improve this page? <a href=https://github.com/Rosettea/Hilbish/issues/new/choose>Create an issue.</a></p></div></container></div><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea © 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>
|
||||
15
versions/readline-move/docs/nature/index.html
Normal file
15
versions/readline-move/docs/nature/index.html
Normal file
@ -0,0 +1,15 @@
|
||||
<!doctype html><html><head><title>Nature — Hilbish</title><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><meta name=theme-color content="#ff89dd"><meta content="/Hilbish/hilbish-flower.png" property="og:image"><meta property="og:site_name" content="Hilbish"><meta content="Nature — Hilbish" property="og:title"><meta content="A bit after creation, we have the outside nature. Little plants, seeds, growing to their final phase: a full plant. A lot of Hilbish itself is written in Go, but there are parts made in Lua, being most builtins (doc, cd, cdr), completions, and other things.
|
||||
Hilbish’s Lua core module is called nature. It runs after Hilbish’s Go core does.
|
||||
Nature Modules Currently, nature provides 1 intended public module: nature.dirs. It is a simple API for managing recent directories and old current working directory." property="og:description"><meta content="A bit after creation, we have the outside nature. Little plants, seeds, growing to their final phase: a full plant. A lot of Hilbish itself is written in Go, but there are parts made in Lua, being most builtins (doc, cd, cdr), completions, and other things.
|
||||
Hilbish’s Lua core module is called nature. It runs after Hilbish’s Go core does.
|
||||
Nature Modules Currently, nature provides 1 intended public module: nature.dirs. It is a simple API for managing recent directories and old current working directory." name=description><meta name=revisit-after content="2 days"><meta name=keywords content="Lua,Hilbish,Linux,Shell"><meta property="og:locale" content="en_GB"><link rel=canonical href=https://rosettea.github.io/Hilbish/><meta property="og:url" content="https://rosettea.github.io/Hilbish/"><link href=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css rel=stylesheet integrity=sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor crossorigin=anonymous><script src=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js integrity=sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2 crossorigin=anonymous></script>
|
||||
<link rel=stylesheet href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" crossorigin=anonymous referrerpolicy=no-referrer><link rel=stylesheet href=/Hilbish/versions/readline-move/css/syntax.min.eb77978873f3b324603120b558a36c98ad57d6ee7b77928e3bc131bd76c5935a.css integrity="sha256-63eXiHPzsyRgMSC1WKNsmK1X1u57d5KOO8ExvXbFk1o="></link><style>.heading>.heading-link{opacity:0}.heading:hover>.heading-link{visibility:visible;opacity:1;transition:all .1s ease-in}@keyframes highlight{0%{background:0 0}50%{background:#fff2cf}100%{background:0 0}}div:target{animation:highlight 1.2s;animation-timing-function:cubic-bezier(1,-.02,.45,.89)}table{border-width:1px;border-style:solid;border-color:#565c64;border-collapse:collapse;margin-bottom:12px}table td{padding:5px}table tr{border-width:1px}thead{display:none}</style></head><body class="d-flex flex-column min-vh-100" style=overflow-x:hidden><svg xmlns="http://www.w3.org/2000/svg" style="display:none"><symbol id="check-circle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="exclamation-triangle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><header><nav class="navbar navbar-expand-md sticky-top bg-light border-bottom"><div class=container-fluid><a class=navbar-brand href=/Hilbish><img src=/Hilbish/hilbish-logo-and-text.png alt height=48></a>
|
||||
<button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
|
||||
<span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/readline-move/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><style>@media(min-width:768px){.sidenav{width:240px}}</style><div class=row><nav class="navbar-expand-md bg-light sidenav border-end"><div class=container><div class="collapse navbar-collapse" id=navbarSupportedContent><nav class="navbar navbar-expand-md bg-light sidenav col" style=margin-top:-20px><ul class="navbar-nav me-auto mb-2 mb-lg-0 flex-column col mt-4"><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link><strong>Introduction</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/getting-started/ class=nav-link><strong>Getting Started</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/faq/ class=nav-link><strong>Frequently Asked Questions</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/ class=nav-link><strong>Features</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/completions/ class=nav-link>Completions</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/notifications/ class=nav-link>Notification</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/opts/ class=nav-link>Options</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/runner-mode/ class=nav-link>Runner Mode</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/ class=nav-link><strong>Signals</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/command/ class=nav-link>Command</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/hilbish/ class=nav-link>Hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/signal/ class=nav-link>Signal</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/lunacolors/ class=nav-link><strong>Lunacolors</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/ class=nav-link><strong>Vim Mode</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/actions/ class=nav-link>Actions</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/ class=nav-link><strong>Nature</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/dirs/ class=nav-link>Module dirs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/doc/ class=nav-link>Module doc</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/ class=nav-link><strong>API</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/bait/ class=nav-link>Module bait</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/commander/ class=nav-link>Module commander</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/fs/ class=nav-link>Module fs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/ class=nav-link>Module hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.aliases/ class=nav-link>Module hilbish.aliases</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.completion/ class=nav-link>Module hilbish.completion</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.runner/ class=nav-link>Module hilbish.runner</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.userdir/ class=nav-link>Module hilbish.userDir</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/readline/ class=nav-link>Module readline</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/snail/ class=nav-link>Module snail</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/terminal/ class=nav-link>Module terminal</a></li></ul></ul></nav></div></div></nav><container class="col mt-2" style="padding-left: 20px; padding-right: 20px;"><div><h1>Nature</h1><p><em></em></p><p>A bit after creation, we have the outside nature. Little plants, seeds,
|
||||
growing to their final phase: a full plant. A lot of Hilbish itself is
|
||||
written in Go, but there are parts made in Lua, being most builtins
|
||||
(<code>doc</code>, <code>cd</code>, cdr), completions, and other things.</p><p>Hilbish’s Lua core module is called <code>nature</code>.
|
||||
It runs after Hilbish’s Go core does.</p><h2 id=nature-modules class=heading>Nature Modules
|
||||
<a href=#nature-modules class=heading-link><i class="fas fa-paperclip"></i></a></h2><p>Currently, <code>nature</code> provides 1 intended public module: <code>nature.dirs</code>.
|
||||
It is a simple API for managing recent directories and old
|
||||
current working directory.</p></div><div class="footer mt-auto"><p class="card-small text-muted">Want to help improve this page? <a href=https://github.com/Rosettea/Hilbish/issues/new/choose>Create an issue.</a></p></div></container></div><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea © 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>
|
||||
3
versions/readline-move/docs/nature/index.xml
Normal file
3
versions/readline-move/docs/nature/index.xml
Normal file
@ -0,0 +1,3 @@
|
||||
<?xml version="1.0" encoding="utf-8" standalone="yes"?><rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Nature on Hilbish</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/nature/</link><description>Recent content in Nature on Hilbish</description><generator>Hugo -- gohugo.io</generator><language>en-us</language><atom:link href="https://rosettea.github.io/Hilbish/versions/readline-move/docs/nature/index.xml" rel="self" type="application/rss+xml"/><item><title>Module dirs</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/nature/dirs/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/nature/dirs/</guid><description>Introduction The dirs module defines a small set of functions to store and manage directories.
|
||||
Functions setOld(d) Sets the old directory string. recent(idx) Get entry from recent directories list based on index. push(dir) Add dir to the recent directories list. pop(num) Remove the specified amount of dirs from the recent directories list. peak(num) Look at num amount of recent directories, starting from the latest. dirs.peak(num) Look at num amount of recent directories, starting from the latest.</description></item><item><title>Module doc</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/nature/doc/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/nature/doc/</guid><description>Introduction The doc module contains a small set of functions used by the Greenhouse pager to render parts of the documentation pages. This is only documented for the sake of it. It&rsquo;s only intended use is by the Greenhouse pager.
|
||||
Functions renderInfoBlock(type, text) Renders an info block. An info block is a block of text with renderCodeBlock(text) Assembles and renders a code block. This returns highlight(text) Performs basic Lua code highlighting.</description></item></channel></rss>
|
||||
5
versions/readline-move/docs/timers/index.html
Normal file
5
versions/readline-move/docs/timers/index.html
Normal file
@ -0,0 +1,5 @@
|
||||
<!doctype html><html><head><title>— Hilbish</title><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><meta name=theme-color content="#ff89dd"><meta content="/Hilbish/hilbish-flower.png" property="og:image"><meta property="og:site_name" content="Hilbish"><meta content=" — Hilbish" property="og:title"><meta content="This has been moved to the hilbish.timers API doc (accessible by doc api hilbish.timers)" property="og:description"><meta content="This has been moved to the hilbish.timers API doc (accessible by doc api hilbish.timers)" name=description><meta name=revisit-after content="2 days"><meta name=keywords content="Lua,Hilbish,Linux,Shell"><meta property="og:locale" content="en_GB"><link rel=canonical href=https://rosettea.github.io/Hilbish/><meta property="og:url" content="https://rosettea.github.io/Hilbish/"><link href=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css rel=stylesheet integrity=sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor crossorigin=anonymous><script src=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js integrity=sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2 crossorigin=anonymous></script>
|
||||
<link rel=stylesheet href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" crossorigin=anonymous referrerpolicy=no-referrer><link rel=stylesheet href=/Hilbish/versions/readline-move/css/syntax.min.eb77978873f3b324603120b558a36c98ad57d6ee7b77928e3bc131bd76c5935a.css integrity="sha256-63eXiHPzsyRgMSC1WKNsmK1X1u57d5KOO8ExvXbFk1o="></link><style>.heading>.heading-link{opacity:0}.heading:hover>.heading-link{visibility:visible;opacity:1;transition:all .1s ease-in}@keyframes highlight{0%{background:0 0}50%{background:#fff2cf}100%{background:0 0}}div:target{animation:highlight 1.2s;animation-timing-function:cubic-bezier(1,-.02,.45,.89)}table{border-width:1px;border-style:solid;border-color:#565c64;border-collapse:collapse;margin-bottom:12px}table td{padding:5px}table tr{border-width:1px}thead{display:none}</style></head><body class="d-flex flex-column min-vh-100" style=overflow-x:hidden><svg xmlns="http://www.w3.org/2000/svg" style="display:none"><symbol id="check-circle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="exclamation-triangle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><header><nav class="navbar navbar-expand-md sticky-top bg-light border-bottom"><div class=container-fluid><a class=navbar-brand href=/Hilbish><img src=/Hilbish/hilbish-logo-and-text.png alt height=48></a>
|
||||
<button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
|
||||
<span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/readline-move/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><main><div class="container mt-2"><h1></h1><img src='https://avatars1.githubusercontent.com/u/38820196?s=460&u=b9f4efb2375bae6cb30656d790c6e0a2939327c0&v=4' width=48 style=border-radius:100%>
|
||||
<em class=text-muted>by <strong>sammyette</strong></em><div class=my-4><p>This has been moved to the <code>hilbish.timers</code> API doc (accessible by <code>doc api hilbish.timers</code>)</p></div></div></main><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea © 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>
|
||||
15
versions/readline-move/docs/vim-mode/actions/index.html
Normal file
15
versions/readline-move/docs/vim-mode/actions/index.html
Normal file
@ -0,0 +1,15 @@
|
||||
<!doctype html><html><head><title>Actions — Hilbish</title><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><meta name=theme-color content="#ff89dd"><meta content="/Hilbish/hilbish-flower.png" property="og:image"><meta property="og:site_name" content="Hilbish"><meta content="Actions — Hilbish" property="og:title"><meta content="Vim actions are essentially just when a user uses a Vim keybind. Things like yanking and pasting are Vim actions. This is not an “offical Vim thing,” just a Hilbish thing.
|
||||
The hilbish.vimAction hook is thrown whenever a Vim action occurs. It passes 2 arguments: the action name, and an array (table) of args relating to it.
|
||||
Here is documentation for what the table of args will hold for an appropriate Vim action." property="og:description"><meta content="Vim actions are essentially just when a user uses a Vim keybind. Things like yanking and pasting are Vim actions. This is not an “offical Vim thing,” just a Hilbish thing.
|
||||
The hilbish.vimAction hook is thrown whenever a Vim action occurs. It passes 2 arguments: the action name, and an array (table) of args relating to it.
|
||||
Here is documentation for what the table of args will hold for an appropriate Vim action." name=description><meta name=revisit-after content="2 days"><meta name=keywords content="Lua,Hilbish,Linux,Shell"><meta property="og:locale" content="en_GB"><link rel=canonical href=https://rosettea.github.io/Hilbish/><meta property="og:url" content="https://rosettea.github.io/Hilbish/"><link href=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css rel=stylesheet integrity=sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor crossorigin=anonymous><script src=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js integrity=sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2 crossorigin=anonymous></script>
|
||||
<link rel=stylesheet href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" crossorigin=anonymous referrerpolicy=no-referrer><link rel=stylesheet href=/Hilbish/versions/readline-move/css/syntax.min.eb77978873f3b324603120b558a36c98ad57d6ee7b77928e3bc131bd76c5935a.css integrity="sha256-63eXiHPzsyRgMSC1WKNsmK1X1u57d5KOO8ExvXbFk1o="></link><style>.heading>.heading-link{opacity:0}.heading:hover>.heading-link{visibility:visible;opacity:1;transition:all .1s ease-in}@keyframes highlight{0%{background:0 0}50%{background:#fff2cf}100%{background:0 0}}div:target{animation:highlight 1.2s;animation-timing-function:cubic-bezier(1,-.02,.45,.89)}table{border-width:1px;border-style:solid;border-color:#565c64;border-collapse:collapse;margin-bottom:12px}table td{padding:5px}table tr{border-width:1px}thead{display:none}</style></head><body class="d-flex flex-column min-vh-100" style=overflow-x:hidden><svg xmlns="http://www.w3.org/2000/svg" style="display:none"><symbol id="check-circle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="exclamation-triangle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><header><nav class="navbar navbar-expand-md sticky-top bg-light border-bottom"><div class=container-fluid><a class=navbar-brand href=/Hilbish><img src=/Hilbish/hilbish-logo-and-text.png alt height=48></a>
|
||||
<button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
|
||||
<span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/readline-move/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><style>@media(min-width:768px){.sidenav{width:240px}}</style><div class=row><nav class="navbar-expand-md bg-light sidenav border-end"><div class=container><div class="collapse navbar-collapse" id=navbarSupportedContent><nav class="navbar navbar-expand-md bg-light sidenav col" style=margin-top:-20px><ul class="navbar-nav me-auto mb-2 mb-lg-0 flex-column col mt-4"><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link><strong>Introduction</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/getting-started/ class=nav-link><strong>Getting Started</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/faq/ class=nav-link><strong>Frequently Asked Questions</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/ class=nav-link><strong>Features</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/completions/ class=nav-link>Completions</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/notifications/ class=nav-link>Notification</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/opts/ class=nav-link>Options</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/runner-mode/ class=nav-link>Runner Mode</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/ class=nav-link><strong>Signals</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/command/ class=nav-link>Command</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/hilbish/ class=nav-link>Hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/signal/ class=nav-link>Signal</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/lunacolors/ class=nav-link><strong>Lunacolors</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/ class=nav-link><strong>Vim Mode</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/actions/ class=nav-link>Actions</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/ class=nav-link><strong>Nature</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/dirs/ class=nav-link>Module dirs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/doc/ class=nav-link>Module doc</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/ class=nav-link><strong>API</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/bait/ class=nav-link>Module bait</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/commander/ class=nav-link>Module commander</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/fs/ class=nav-link>Module fs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/ class=nav-link>Module hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.aliases/ class=nav-link>Module hilbish.aliases</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.completion/ class=nav-link>Module hilbish.completion</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.runner/ class=nav-link>Module hilbish.runner</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.userdir/ class=nav-link>Module hilbish.userDir</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/readline/ class=nav-link>Module readline</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/snail/ class=nav-link>Module snail</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/terminal/ class=nav-link>Module terminal</a></li></ul></ul></nav></div></div></nav><container class="col mt-2" style="padding-left: 20px; padding-right: 20px;"><div><h1>Actions</h1><p><em></em></p><p>Vim actions are essentially just when a user uses a Vim keybind.
|
||||
Things like yanking and pasting are Vim actions.
|
||||
This is not an “offical Vim thing,” just a Hilbish thing.</p><p>The <code>hilbish.vimAction</code> hook is thrown whenever a Vim action occurs.
|
||||
It passes 2 arguments: the action name, and an array (table) of args
|
||||
relating to it.</p><p>Here is documentation for what the table of args will hold for an
|
||||
appropriate Vim action.</p><ul><li><p><code>yank</code>: register, yankedText
|
||||
The first argument for the yank action is the register yankedText goes to.</p></li><li><p><code>paste</code>: register, pastedText
|
||||
The first argument for the paste action is the register pastedText is taken from.</p></li></ul></div><div class="footer mt-auto"><p class="card-small text-muted">Want to help improve this page? <a href=https://github.com/Rosettea/Hilbish/issues/new/choose>Create an issue.</a></p></div></container></div><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea © 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>
|
||||
7
versions/readline-move/docs/vim-mode/index.html
Normal file
7
versions/readline-move/docs/vim-mode/index.html
Normal file
@ -0,0 +1,7 @@
|
||||
<!doctype html><html><head><title>Vim Mode — Hilbish</title><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><meta name=theme-color content="#ff89dd"><meta content="/Hilbish/hilbish-flower.png" property="og:image"><meta property="og:site_name" content="Hilbish"><meta content="Vim Mode — Hilbish" property="og:title"><meta content="Hilbish has a Vim binding input mode accessible for use. It can be enabled with the hilbish.inputMode function (check doc hilbish).
|
||||
This is documentation for everything relating to it." property="og:description"><meta content="Hilbish has a Vim binding input mode accessible for use. It can be enabled with the hilbish.inputMode function (check doc hilbish).
|
||||
This is documentation for everything relating to it." name=description><meta name=revisit-after content="2 days"><meta name=keywords content="Lua,Hilbish,Linux,Shell"><meta property="og:locale" content="en_GB"><link rel=canonical href=https://rosettea.github.io/Hilbish/><meta property="og:url" content="https://rosettea.github.io/Hilbish/"><link href=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css rel=stylesheet integrity=sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor crossorigin=anonymous><script src=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js integrity=sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2 crossorigin=anonymous></script>
|
||||
<link rel=stylesheet href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" crossorigin=anonymous referrerpolicy=no-referrer><link rel=stylesheet href=/Hilbish/versions/readline-move/css/syntax.min.eb77978873f3b324603120b558a36c98ad57d6ee7b77928e3bc131bd76c5935a.css integrity="sha256-63eXiHPzsyRgMSC1WKNsmK1X1u57d5KOO8ExvXbFk1o="></link><style>.heading>.heading-link{opacity:0}.heading:hover>.heading-link{visibility:visible;opacity:1;transition:all .1s ease-in}@keyframes highlight{0%{background:0 0}50%{background:#fff2cf}100%{background:0 0}}div:target{animation:highlight 1.2s;animation-timing-function:cubic-bezier(1,-.02,.45,.89)}table{border-width:1px;border-style:solid;border-color:#565c64;border-collapse:collapse;margin-bottom:12px}table td{padding:5px}table tr{border-width:1px}thead{display:none}</style></head><body class="d-flex flex-column min-vh-100" style=overflow-x:hidden><svg xmlns="http://www.w3.org/2000/svg" style="display:none"><symbol id="check-circle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="exclamation-triangle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><header><nav class="navbar navbar-expand-md sticky-top bg-light border-bottom"><div class=container-fluid><a class=navbar-brand href=/Hilbish><img src=/Hilbish/hilbish-logo-and-text.png alt height=48></a>
|
||||
<button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
|
||||
<span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/readline-move/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><style>@media(min-width:768px){.sidenav{width:240px}}</style><div class=row><nav class="navbar-expand-md bg-light sidenav border-end"><div class=container><div class="collapse navbar-collapse" id=navbarSupportedContent><nav class="navbar navbar-expand-md bg-light sidenav col" style=margin-top:-20px><ul class="navbar-nav me-auto mb-2 mb-lg-0 flex-column col mt-4"><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link><strong>Introduction</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/getting-started/ class=nav-link><strong>Getting Started</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/faq/ class=nav-link><strong>Frequently Asked Questions</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/ class=nav-link><strong>Features</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/completions/ class=nav-link>Completions</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/notifications/ class=nav-link>Notification</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/opts/ class=nav-link>Options</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/features/runner-mode/ class=nav-link>Runner Mode</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/ class=nav-link><strong>Signals</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/command/ class=nav-link>Command</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/hilbish/ class=nav-link>Hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/hooks/signal/ class=nav-link>Signal</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/lunacolors/ class=nav-link><strong>Lunacolors</strong></a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/ class=nav-link><strong>Vim Mode</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/vim-mode/actions/ class=nav-link>Actions</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/ class=nav-link><strong>Nature</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/dirs/ class=nav-link>Module dirs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/nature/doc/ class=nav-link>Module doc</a></li></ul><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/ class=nav-link><strong>API</strong></a></li><ul style=list-style:none><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/bait/ class=nav-link>Module bait</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/commander/ class=nav-link>Module commander</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/fs/ class=nav-link>Module fs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/ class=nav-link>Module hilbish</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.aliases/ class=nav-link>Module hilbish.aliases</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.completion/ class=nav-link>Module hilbish.completion</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.runner/ class=nav-link>Module hilbish.runner</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.userdir/ class=nav-link>Module hilbish.userDir</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/readline/ class=nav-link>Module readline</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/snail/ class=nav-link>Module snail</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/api/terminal/ class=nav-link>Module terminal</a></li></ul></ul></nav></div></div></nav><container class="col mt-2" style="padding-left: 20px; padding-right: 20px;"><div><h1>Vim Mode</h1><p><em></em></p><p>Hilbish has a Vim binding input mode accessible for use.
|
||||
It can be enabled with the <code>hilbish.inputMode</code> function (check <code>doc hilbish</code>).</p><p>This is documentation for everything relating to it.</p></div><div class="footer mt-auto"><p class="card-small text-muted">Want to help improve this page? <a href=https://github.com/Rosettea/Hilbish/issues/new/choose>Create an issue.</a></p></div></container></div><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea © 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>
|
||||
3
versions/readline-move/docs/vim-mode/index.xml
Normal file
3
versions/readline-move/docs/vim-mode/index.xml
Normal file
@ -0,0 +1,3 @@
|
||||
<?xml version="1.0" encoding="utf-8" standalone="yes"?><rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Vim Mode on Hilbish</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/vim-mode/</link><description>Recent content in Vim Mode on Hilbish</description><generator>Hugo -- gohugo.io</generator><language>en-us</language><atom:link href="https://rosettea.github.io/Hilbish/versions/readline-move/docs/vim-mode/index.xml" rel="self" type="application/rss+xml"/><item><title>Actions</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/vim-mode/actions/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/vim-mode/actions/</guid><description>Vim actions are essentially just when a user uses a Vim keybind. Things like yanking and pasting are Vim actions. This is not an &ldquo;offical Vim thing,&rdquo; just a Hilbish thing.
|
||||
The hilbish.vimAction hook is thrown whenever a Vim action occurs. It passes 2 arguments: the action name, and an array (table) of args relating to it.
|
||||
Here is documentation for what the table of args will hold for an appropriate Vim action.</description></item></channel></rss>
|
||||
BIN
versions/readline-move/hilbish-flower.png
Normal file
BIN
versions/readline-move/hilbish-flower.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 45 KiB |
BIN
versions/readline-move/hilbish-logo-and-text.png
Normal file
BIN
versions/readline-move/hilbish-logo-and-text.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 78 KiB |
18
versions/readline-move/index.html
Normal file
18
versions/readline-move/index.html
Normal file
@ -0,0 +1,18 @@
|
||||
<!doctype html><html><head><meta name=generator content="Hugo 0.111.3"><title>Hilbish</title><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><meta name=theme-color content="#ff89dd"><meta content="/Hilbish/hilbish-flower.png" property="og:image"><meta property="og:site_name" content="Hilbish"><meta content="Hilbish" property="og:title"><meta content="Something Unique. Hilbish is the new interactive shell for Lua fans. Extensible, scriptable, configurable: All in Lua." property="og:description"><meta content="Something Unique. Hilbish is the new interactive shell for Lua fans. Extensible, scriptable, configurable: All in Lua." name=description><meta name=revisit-after content="2 days"><meta name=keywords content="Lua,Hilbish,Linux,Shell"><meta property="og:locale" content="en_GB"><link rel=canonical href=https://rosettea.github.io/Hilbish/><meta property="og:url" content="https://rosettea.github.io/Hilbish/"><link href=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css rel=stylesheet integrity=sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor crossorigin=anonymous><script src=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js integrity=sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2 crossorigin=anonymous></script>
|
||||
<link rel=stylesheet href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" crossorigin=anonymous referrerpolicy=no-referrer><link rel=stylesheet href=/Hilbish/versions/readline-move/css/syntax.min.eb77978873f3b324603120b558a36c98ad57d6ee7b77928e3bc131bd76c5935a.css integrity="sha256-63eXiHPzsyRgMSC1WKNsmK1X1u57d5KOO8ExvXbFk1o="></link><style>.heading>.heading-link{opacity:0}.heading:hover>.heading-link{visibility:visible;opacity:1;transition:all .1s ease-in}@keyframes highlight{0%{background:0 0}50%{background:#fff2cf}100%{background:0 0}}div:target{animation:highlight 1.2s;animation-timing-function:cubic-bezier(1,-.02,.45,.89)}table{border-width:1px;border-style:solid;border-color:#565c64;border-collapse:collapse;margin-bottom:12px}table td{padding:5px}table tr{border-width:1px}thead{display:none}</style></head><body class="d-flex flex-column min-vh-100" style=overflow-x:hidden><svg xmlns="http://www.w3.org/2000/svg" style="display:none"><symbol id="check-circle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="exclamation-triangle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><header><nav class="navbar navbar-expand-md sticky-top bg-light border-bottom"><div class=container-fluid><a class=navbar-brand href=/Hilbish><img src=/Hilbish/hilbish-logo-and-text.png alt height=48></a>
|
||||
<button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
|
||||
<span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/readline-move/ class="nav-link active">Home</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><div><main style=padding-left:20px;padding-right:20px;padding-top:15px;max-width:84em;margin:auto><div class=text-center><h1 class=fw-light>Something Unique.</h1><p><strong>🌺 Hilbish</strong> is the new Moon-powered interactive shell for Lua fans!<br>Extensible, scriptable, configurable: All in Lua. ✨</p><a href=install class="btn btn-primary">Install</a>
|
||||
<a href=https://github.com/Rosettea/Hilbish class="btn btn-secondary" target=_blank>GitHub</a></div><hr><div class="row row-cols-1 row-cols-md-2 g-4"><div class=col><div class=card><div class=card-body><h5 class=card-title>Simple and Easy Scripting</h5><p class=card-text>Hilbish is configured and scripted in the
|
||||
Lua programming language. This removes all the old, ugly things
|
||||
about Shell script and introduces everything good about Lua,
|
||||
including other languages (Fennel, Lua derivatives).</p></div></div></div><div class=col><div class=card><div class=card-body><h5 class=card-title>History and Completion Menus</h5><p class=card-text>Hilbish provides the user with proper menus
|
||||
for completions and history usage. Want to see your previous commands?
|
||||
Hit Ctrl-R.</p></div></div></div><div class=col><div class=card><div class=card-body><h5 class=card-title>Tons of Features, and More to Come</h5><p class=card-text>Hilbish offers a bunch of features to make your
|
||||
interactive shell experience rich. Things like syntax highlighting
|
||||
and hinting available via the Lua API.</p></div></div></div><div class=col><div class=card><div class=card-body><h5 class=card-title>Customizable and Extensible via an accessible Lua API</h5><p class=card-text>Want to change the language used for interactive input?
|
||||
Or maybe monitor and notify for the output of background jobs?
|
||||
Have a real-time updating prompt? All this can be done in Hilbish!</p></div></div></div></div><hr><h1 class=fw-light>Why not just Lua?</h1><p>Hilbish is your interactive shell as well as a just a Lua interpreter
|
||||
and enhanced REPL.<br></p><ul class=list-group><li class=list-group-item><i class="fa-solid fa-battery-full"></i> Batteries included Lua runtime that's also your user shell!</li><li class=list-group-item><i class="fa-solid fa-network-wired"></i> Provides cross-platform and OS agnostic APIs to ensure your Lua code works everywhere Hilbish does, as expected.</li></ul><hr><h1 class=fw-light>Try It Today!</h1><p>Hilbish is known to run on the 3 major platforms (Windows, MacOS, Linux)
|
||||
but likely builds on other Unixes! Windows doesn't work as well as it should,
|
||||
so if you're a Windows user,
|
||||
<a href=https://github.com/Rosettea/Hilbish/discussions/165>say something</a>!<ul class=list-group><li class=list-group-item><i class="fa-solid fa-cloud-arrow-down"></i> <a href=/Hilbish/install style=text-decoration:none><strong>Download</strong></a> the binary</li><li class=list-group-item><i class="fa-solid fa-screwdriver-wrench"></i> <a href=https://github.com/Rosettea/Hilbish#manual-build style=text-decoration:none><strong>Build</strong></a> from source</li></ul></p></main></div><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea © 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>
|
||||
76
versions/readline-move/index.xml
Normal file
76
versions/readline-move/index.xml
Normal file
@ -0,0 +1,76 @@
|
||||
<?xml version="1.0" encoding="utf-8" standalone="yes"?><rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Hilbish</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/</link><description>Recent content on Hilbish</description><generator>Hugo -- gohugo.io</generator><language>en-us</language><atom:link href="https://rosettea.github.io/Hilbish/versions/readline-move/index.xml" rel="self" type="application/rss+xml"/><item><title>Actions</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/vim-mode/actions/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/vim-mode/actions/</guid><description>Vim actions are essentially just when a user uses a Vim keybind. Things like yanking and pasting are Vim actions. This is not an &ldquo;offical Vim thing,&rdquo; just a Hilbish thing.
|
||||
The hilbish.vimAction hook is thrown whenever a Vim action occurs. It passes 2 arguments: the action name, and an array (table) of args relating to it.
|
||||
Here is documentation for what the table of args will hold for an appropriate Vim action.</description></item><item><title>Lunacolors</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/lunacolors/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/lunacolors/</guid><description>Lunacolors is an ANSI color/styling library for Lua. It is included by default in standard Hilbish distributions to provide easy styling for things like prompts and text.
|
||||
For simple usage, a single color or style is enough. For example, you can just use lunacolors.blue 'Hello world' and that&rsquo;ll return blue text which you can print. This includes styles like bold, underline, etc.
|
||||
In other usage, you may want to use a format string instead of having multiple nested functions for different styles.</description></item><item><title>Frequently Asked Questions</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/faq/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/faq/</guid><description>Is Hilbish POSIX compliant? No, it is not. POSIX compliance is a non-goal. Perhaps in the future, someone would be able to write a native plugin to support shell scripting (which would be against it&rsquo;s main goal, but &hellip;.)
|
||||
Windows Support? It compiles for Windows (CI ensures it does), but otherwise it is not directly supported. If you&rsquo;d like to improve this situation, checkout the discussion .
|
||||
Why? Hilbish emerged from the desire of a Lua configured shell.</description></item><item><title>Getting Started</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/getting-started/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/getting-started/</guid><description>To start Hilbish, open a terminal. If Hilbish has been installed and is not the default shell, you can simply run hilbish to start it. This will launch a normal interactive session. To exit, you can either run the exit command or hit Ctrl+D.
|
||||
Setting as Default Login shell There are a few ways to make Hilbish your default shell. A simple way is to make it your user/login shell.</description></item><item><title>v2.3 Release</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.3-release/</link><pubDate>Sat, 20 Jul 2024 10:05:17 -0400</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.3-release/</guid><description>The release with full changelogs and prebuilt binaries can be seen at the v2.3.0 tag.
|
||||
Hilbish v2.3 has now been released! This is small feature and bug fix release which took a while to cme ut since I took a long break from programming in general. The next release will be great, so stay tuned for that.
|
||||
Features Pipes (via Lua) Commands can now be piped to each other via the Lua API with the hilbish.</description></item><item><title>v2.2 Release</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.2-release/</link><pubDate>Mon, 25 Dec 2023 23:56:36 -0400</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.2-release/</guid><description>The release with full changelogs and prebuilt binaries can be seen at the v2.2.0 tag.
|
||||
Welcome to a very long awaited release of Hilbish, and on Christmas. Just think of it as a long preparing, late Christmas gift. :) This release does not contain a whole lot of changes, but it is a new release with enhancements and bug fixes!
|
||||
Documentation As is a trend, the documentation has been improved by ONE HUNDRED TIMES.</description></item><item><title>Improving Hilbish's Branding</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/blog/improving-this-website/</link><pubDate>Thu, 13 Apr 2023 22:15:31 -0400</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/blog/improving-this-website/</guid><description>Happy birthday Hilbish! As of last month, Hilbish is now 2 years old. Unfortunately I missed the official date, but I will still make a more focused post on the date (19st).
|
||||
I decided to fix up this website and Hilbish&rsquo;s logo, so that can be thought of as something for the 2 years milestone?
|
||||
Logo Hilbish&rsquo;s old logo was.. not that good. It definitely functioned as a logo, but the yellow part of it looked ugly (sorry old logo).</description></item><item><title>v2.1.2 Release</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.1.2-release/</link><pubDate>Mon, 10 Apr 2023 12:27:41 -0400</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.1.2-release/</guid><description>The release with full changelogs and prebuilt binaries can be seen at the v2.1.2 tag.
|
||||
This release reverts the April Fool&rsquo;s code additions in v2.1.1. It is functionally equal to v2.1.0. Nice!
|
||||
A real release will come possibly in a few days or next week, so stay tuned for the good and feature-filled release of v2.2!</description></item><item><title>v2.1.1 Release</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.1.1-release/</link><pubDate>Sat, 01 Apr 2023 18:15:42 -0400</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.1.1-release/</guid><description>The release with full changelogs and prebuilt binaries can be seen at the v2.1.1 tag.
|
||||
Welcome to a fresh new release of Hilbish! Some people (or none) may be awaiting the long coming v2.2 release with lots of features, but I needed to push out this little bug fix (wink) release.
|
||||
Bug Fixes Validation checks for command input When running this version, you may have noticed an odd message that sometimes comes up when running commands.</description></item><item><title>v2.1 Release</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.1-release/</link><pubDate>Tue, 07 Feb 2023 18:25:38 -0400</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.1-release/</guid><description>The release with full changelogs and prebuilt binaries can be seen at the v2.1.0 tag.
|
||||
Oh look! A new release of Hilbish! This time is the v2.1 release, with a small amount of features and mainly documentation changes and bug fixes.
|
||||
Documentation There have been a few documentation enhancements for this release. This includes:
|
||||
Adding the return types for all functions that need them Documenting Hilbish types like job objects and timers properly.</description></item><item><title>Hilbish v2.0 Release</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.0-release/</link><pubDate>Thu, 29 Dec 2022 01:55:21 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.0-release/</guid><description>Hilbish v2.0 has been released! Well actually, it was released a week ago, but I only wrote this Hilbish blog after that.
|
||||
This is a big release, coming 9 months after the previous v1.2.0 and featuring over 40+ bug fixes and tons of new features and enhancements, so let&rsquo;s see what is in this release.
|
||||
Documentation When querying about the problems people have with Hilbish, one of the issues was its poor documentation.</description></item><item><title/><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/hooks/job/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/hooks/job/</guid><description>Note: job refers to a job object. You can check doc jobs for more detail.
|
||||
job.start -&gt; job &gt; Thrown when a new background job starts.
|
||||
job.done -&gt; job &gt; Thrown when a background jobs exits.</description></item><item><title/><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/jobs/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/jobs/</guid><description>(This has mainly been replaced by hilbish.jobs ).
|
||||
Hilbish has pretty standard job control. It&rsquo;s missing one or two things, but works well. One thing which is different from other shells (besides Hilbish) itself is the API for jobs, and of course it&rsquo;s in Lua. You can add jobs, stop and delete (disown) them and even get output.
|
||||
Job Interface The job interface refers to hilbish.jobs.
|
||||
Functions (Note that in the list here, they&rsquo;re called from hilbish.</description></item><item><title/><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/timers/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/timers/</guid><description>This has been moved to the hilbish.timers API doc (accessible by doc api hilbish.timers)</description></item><item><title>Command</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/hooks/command/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/hooks/command/</guid><description>command.preexec Thrown right before a command is executed.
|
||||
Variables string input
|
||||
The raw string that the user typed. This will include the text without changes applied to it (argument substitution, alias expansion, etc.)
|
||||
string cmdStr
|
||||
The command that will be directly executed by the current runner.
|
||||
command.exit Thrown after the user&rsquo;s ran command is finished.
|
||||
Variables number code
|
||||
The exit code of what was executed.
|
||||
string cmdStr
|
||||
The command or code that was executed</description></item><item><title>Completions</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/completions/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/completions/</guid><description>Completions for commands can be created with the hilbish.complete function. See the link for how to use it.
|
||||
To create completions for a command is simple. The callback will be passed 3 parameters:
|
||||
query (string): The text that the user is currently trying to complete. This should be used to match entries. ctx (string): Contains the entire line. Use this if more text is needed to be parsed for context. fields (string): The ctx split up by spaces.</description></item><item><title>Hilbish</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/hooks/hilbish/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/hooks/hilbish/</guid><description>hilbish.exit Sent when Hilbish is going to exit.
|
||||
Variables This signal returns no variables.
|
||||
hilbish.vimMode Sent when the Vim mode of Hilbish is changed (like from insert to normal mode). This can be used to change the prompt and notify based on Vim mode.
|
||||
Variables string modeName
|
||||
The mode that has been set. Can be these values: insert, normal, delete or replace
|
||||
hilbish.cancel Sent when the user cancels their command input with Ctrl-C</description></item><item><title>Install</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/install/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/install/</guid><description>Official Binaries The best way to get Hilbish is to get a build directly from GitHub. At any time, there are 2 versions of Hilbish recommended for download: the latest stable release, and development builds from the master branch.
|
||||
You can download both at any time, but note that the development builds may have breaking changes.
|
||||
For the latest stable release, check here: https://github.com/Rosettea/Hilbish/releases/latest For a development build: https://nightly.link/Rosettea/Hilbish/workflows/build/master Compiling To read the steps for compiling Hilbish, head over to the GitHub repository.</description></item><item><title>Module bait</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/bait/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/bait/</guid><description>Introduction Bait is the event emitter for Hilbish. Much like Node.js and its events system, many actions in Hilbish emit events. Unlike Node.js, Hilbish events are global. So make sure to pick a unique name!
|
||||
Usage of the Bait module consists of userstanding event-driven architecture, but it&rsquo;s pretty simple: If you want to act on a certain event, you can catch it. You can act on events via callback functions.</description></item><item><title>Module commander</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/commander/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/commander/</guid><description>Introduction Commander is the library which handles Hilbish commands. This makes the user able to add Lua-written commands to their shell without making a separate script in a bin folder. Instead, you may simply use the Commander library in your Hilbish config.
|
||||
1local commander = require &#39;commander&#39; 2 3commander.register(&#39;hello&#39;, function(args, sinks) 4 sinks.out:writeln &#39;Hello world!&#39; 5end) In this example, a command with the name of hello is created that will print Hello world!</description></item><item><title>Module dirs</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/nature/dirs/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/nature/dirs/</guid><description>Introduction The dirs module defines a small set of functions to store and manage directories.
|
||||
Functions setOld(d) Sets the old directory string. recent(idx) Get entry from recent directories list based on index. push(dir) Add dir to the recent directories list. pop(num) Remove the specified amount of dirs from the recent directories list. peak(num) Look at num amount of recent directories, starting from the latest. dirs.peak(num) Look at num amount of recent directories, starting from the latest.</description></item><item><title>Module doc</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/nature/doc/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/nature/doc/</guid><description>Introduction The doc module contains a small set of functions used by the Greenhouse pager to render parts of the documentation pages. This is only documented for the sake of it. It&rsquo;s only intended use is by the Greenhouse pager.
|
||||
Functions renderInfoBlock(type, text) Renders an info block. An info block is a block of text with renderCodeBlock(text) Assembles and renders a code block. This returns highlight(text) Performs basic Lua code highlighting.</description></item><item><title>Module fs</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/fs/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/fs/</guid><description>Introduction The fs module provides filesystem functions to Hilbish. While Lua&rsquo;s standard library has some I/O functions, they&rsquo;re missing a lot of the basics. The fs library offers more functions and will work on any operating system Hilbish does.
|
||||
Functions abs(path) -&gt; string Returns an absolute version of the path. basename(path) -&gt; string Returns the &ldquo;basename,&rdquo; or the last part of the provided path. If path is empty, cd(dir) Changes Hilbish&rsquo;s directory to dir.</description></item><item><title>Module hilbish.aliases</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.aliases/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.aliases/</guid><description>Introduction The alias interface deals with all command aliases in Hilbish.
|
||||
Functions add(alias, cmd) This is an alias (ha) for the hilbish.alias function. delete(name) Removes an alias. list() -&gt; table[string, string] Get a table of all aliases, with string keys as the alias and the value as the command. resolve(alias) -&gt; string? Resolves an alias to its original command. Will thrown an error if the alias doesn&rsquo;t exist. hilbish.aliases.add(alias, cmd) This is an alias (ha) for the hilbish.</description></item><item><title>Module hilbish.completion</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.completion/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.completion/</guid><description>Introduction The completions interface deals with tab completions.
|
||||
Functions bins(query, ctx, fields) -&gt; entries (table), prefix (string) Return binaries/executables based on the provided parameters. call(name, query, ctx, fields) -&gt; completionGroups (table), prefix (string) Calls a completer function. This is mainly used to call a command completer, which will have a name files(query, ctx, fields) -&gt; entries (table), prefix (string) Returns file matches based on the provided parameters. handler(line, pos) This function contains the general completion handler for Hilbish.</description></item><item><title>Module hilbish.runner</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.runner/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.runner/</guid><description>Introduction The runner interface contains functions that allow the user to change how Hilbish interprets interactive input. Users can add and change the default runner for interactive input to any language or script of their choosing. A good example is using it to write command in Fennel.
|
||||
Runners are functions that evaluate user input. The default runners in Hilbish can run shell script and Lua code.
|
||||
A runner is passed the input and has to return a table with these values.</description></item><item><title>Module hilbish.userDir</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.userdir/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/hilbish/hilbish.userdir/</guid><description> Introduction This interface just contains properties to know about certain user directories. It is equivalent to XDG on Linux and gets the user&rsquo;s preferred directories for configs and data.
|
||||
Static module fields config The user&rsquo;s config directory data The user&rsquo;s directory for program data</description></item><item><title>Module readline</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/readline/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/readline/</guid><description>Introduction This package is designed to be run independently from murex and at some point it will be separated into it&rsquo;s own git repository (at a stage when I am confident that murex will no longer be the primary driver for features, bugs or other code changes)
|
||||
Package terminal provides support functions for dealing with terminals, as commonly found on UNIX systems.
|
||||
Putting a terminal into raw mode is the most common requirement:</description></item><item><title>Module snail</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/snail/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/snail/</guid><description>Introduction The snail library houses Hilbish&rsquo;s Lua wrapper of its shell script interpreter. It&rsquo;s not very useful other than running shell scripts, which can be done with other Hilbish functions.
|
||||
Functions new() -&gt; @Snail Creates a new Snail instance. snail.new() -> Snail Creates a new Snail instance.
|
||||
Parameters This function has no parameters.
|
||||
Types Snail A Snail is a shell script interpreter instance.
|
||||
Methods dir(path) Changes the directory of the snail instance.</description></item><item><title>Module terminal</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/terminal/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/api/terminal/</guid><description>Introduction The terminal library is a simple and lower level library for certain terminal interactions.
|
||||
Functions restoreState() Restores the last saved state of the terminal saveState() Saves the current state of the terminal. setRaw() Puts the terminal into raw mode. size() Gets the dimensions of the terminal. Returns a table with width and height terminal.restoreState() Restores the last saved state of the terminal
|
||||
Parameters This function has no parameters.</description></item><item><title>Notification</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/features/notifications/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/features/notifications/</guid><description>Hilbish features a simple notification system which can be used by other plugins and parts of the shell to notify the user of various actions. This is used via the hilbish.message interface.
|
||||
A message is defined as a table with the following properties:
|
||||
icon: A unicode/emoji icon for the notification. title: The title of the message text: Message text/body channel: The source of the message. This should be a unique and easily readable text identifier.</description></item><item><title>Options</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/features/opts/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/features/opts/</guid><description>Opts are simple toggle or value options a user can set in Hilbish. As toggles, there are things like autocd or history saving. As values, there is the motd which the user can either change to a custom string or disable.
|
||||
Opts are accessed from the hilbish.opts table. Here they can either be read or modified
|
||||
autocd Value: boolean Default: false The autocd opt makes it so that lone directories attempted to be executed are instead set as the shell&rsquo;s directory.</description></item><item><title>Runner Mode</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/features/runner-mode/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/features/runner-mode/</guid><description>Hilbish allows you to change how interactive text can be interpreted. This is mainly due to the fact that the default method Hilbish uses is that it runs Lua first and then falls back to shell script.
|
||||
In some cases, someone might want to switch to just shell script to avoid it while interactive but still have a Lua config, or go full Lua to use Hilbish as a REPL. This also allows users to add alternative languages like Fennel as the interactive script runner.</description></item><item><title>Signal</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/docs/hooks/signal/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/docs/hooks/signal/</guid><description>signal.sigint Thrown when Hilbish receive the SIGINT signal, aka when Ctrl-C is pressed.
|
||||
Variables This signal returns no variables.
|
||||
signal.resize Thrown when the terminal is resized.
|
||||
Variables This signal returns no variables.
|
||||
signal.sigusr1 Thrown when SIGUSR1 is sent to Hilbish.
|
||||
Variables This signal returns no variables.
|
||||
signal.sigusr2 Thrown when SIGUSR2 is sent to Hilbish.
|
||||
Variables This signal returns no variables.</description></item><item><title>Welcome to the Hilbish blog</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/blog/welcome/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/readline-move/blog/welcome/</guid><description>Hello! Welcome to the Hilbish blog. This will mainly contain release announcements and some other things relating to Hilbish (development).</description></item></channel></rss>
|
||||
23
versions/readline-move/install/index.html
Normal file
23
versions/readline-move/install/index.html
Normal file
@ -0,0 +1,23 @@
|
||||
<!doctype html><html><head><title>Install — Hilbish</title><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><meta name=theme-color content="#ff89dd"><meta content="/Hilbish/hilbish-flower.png" property="og:image"><meta property="og:site_name" content="Hilbish"><meta content="Install — Hilbish" property="og:title"><meta content="Steps on how to install Hilbish on all the OSes and distros supported." property="og:description"><meta content="Steps on how to install Hilbish on all the OSes and distros supported." name=description><meta name=revisit-after content="2 days"><meta name=keywords content="Lua,Hilbish,Linux,Shell"><meta property="og:locale" content="en_GB"><link rel=canonical href=https://rosettea.github.io/Hilbish/><meta property="og:url" content="https://rosettea.github.io/Hilbish/"><link href=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css rel=stylesheet integrity=sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor crossorigin=anonymous><script src=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js integrity=sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2 crossorigin=anonymous></script>
|
||||
<link rel=stylesheet href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" crossorigin=anonymous referrerpolicy=no-referrer><link rel=stylesheet href=/Hilbish/versions/readline-move/css/syntax.min.eb77978873f3b324603120b558a36c98ad57d6ee7b77928e3bc131bd76c5935a.css integrity="sha256-63eXiHPzsyRgMSC1WKNsmK1X1u57d5KOO8ExvXbFk1o="></link><style>.heading>.heading-link{opacity:0}.heading:hover>.heading-link{visibility:visible;opacity:1;transition:all .1s ease-in}@keyframes highlight{0%{background:0 0}50%{background:#fff2cf}100%{background:0 0}}div:target{animation:highlight 1.2s;animation-timing-function:cubic-bezier(1,-.02,.45,.89)}table{border-width:1px;border-style:solid;border-color:#565c64;border-collapse:collapse;margin-bottom:12px}table td{padding:5px}table tr{border-width:1px}thead{display:none}</style></head><body class="d-flex flex-column min-vh-100" style=overflow-x:hidden><svg xmlns="http://www.w3.org/2000/svg" style="display:none"><symbol id="check-circle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="exclamation-triangle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><header><nav class="navbar navbar-expand-md sticky-top bg-light border-bottom"><div class=container-fluid><a class=navbar-brand href=/Hilbish><img src=/Hilbish/hilbish-logo-and-text.png alt height=48></a>
|
||||
<button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
|
||||
<span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/readline-move/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/install/ class="nav-link active">Install</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><main><div class="container mt-2"><h3 id=official-binaries class=heading>Official Binaries
|
||||
<a href=#official-binaries class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>The best way to get Hilbish is to get a build directly from GitHub.
|
||||
At any time, there are 2 versions of Hilbish recommended for download:
|
||||
the latest stable release, and development builds from the master branch.</p><p>You can download both at any time, but note that the development builds may
|
||||
have breaking changes.</p><p>For the latest <strong>stable release</strong>, check here: <a href=https://github.com/Rosettea/Hilbish/releases/latest target=_blank rel=noopener>https://github.com/Rosettea/Hilbish/releases/latest</a><br>For a <strong>development build</strong>: <a href=https://nightly.link/Rosettea/Hilbish/workflows/build/master target=_blank rel=noopener>https://nightly.link/Rosettea/Hilbish/workflows/build/master</a></p><h3 id=compiling class=heading>Compiling
|
||||
<a href=#compiling class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>To read the steps for compiling Hilbish, head over to the <a href=https://github.com/Rosettea/Hilbish#build target=_blank rel=noopener>GitHub repository.</a></p><h3 id=package-repositories class=heading>Package Repositories
|
||||
<a href=#package-repositories class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>Methods of installing Hilbish for your Linux distro.</p><h4 id=fedora-copr class=heading>Fedora (COPR)
|
||||
<a href=#fedora-copr class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>An official COPR is offered to install Hilbish easily on Fedora.
|
||||
Enable the repo:</p><div class=highlight><pre tabindex=0 class=chroma><code class=language-fallback data-lang=fallback><span class=line><span class=ln>1</span><span class=cl>sudo dnf copr enable sammyette/Hilbish
|
||||
</span></span></code></pre></div><p>And install Hilbish:</p><div class=highlight><pre tabindex=0 class=chroma><code class=language-fallback data-lang=fallback><span class=line><span class=ln>1</span><span class=cl>sudo dnf install hilbish
|
||||
</span></span></code></pre></div><p>Or for the latest development build from master:</p><div class=highlight><pre tabindex=0 class=chroma><code class=language-fallback data-lang=fallback><span class=line><span class=ln>1</span><span class=cl>sudo dnf install hilbish-git
|
||||
</span></span></code></pre></div><h4 id=arch-linux-aur class=heading>Arch Linux (AUR)
|
||||
<a href=#arch-linux-aur class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Hilbish is on the AUR. Setup an AUR helper, and install.
|
||||
Example with yay:</p><div class=highlight><pre tabindex=0 class=chroma><code class=language-fallback data-lang=fallback><span class=line><span class=ln>1</span><span class=cl>yay -S hilbish
|
||||
</span></span></code></pre></div><p>Or, from master branch:</p><div class=highlight><pre tabindex=0 class=chroma><code class=language-fallback data-lang=fallback><span class=line><span class=ln>1</span><span class=cl>yay -S hilbish-git
|
||||
</span></span></code></pre></div><h4 id=alpine-linux class=heading>Alpine Linux
|
||||
<a href=#alpine-linux class=heading-link><i class="fas fa-paperclip"></i></a></h4><p>Hilbish is currentlty in the testing/edge repository for Alpine.
|
||||
Follow the steps <a href=https://wiki.alpinelinux.org/wiki/Enable_Community_Repository target=_blank rel=noopener>here</a>
|
||||
(Using testing repositories) and install:</p><div class=highlight><pre tabindex=0 class=chroma><code class=language-fallback data-lang=fallback><span class=line><span class=ln>1</span><span class=cl>apk add hilbish
|
||||
</span></span></code></pre></div></div></main><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea © 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>
|
||||
BIN
versions/readline-move/pillprompt.png
Normal file
BIN
versions/readline-move/pillprompt.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 20 KiB |
1
versions/readline-move/sitemap.xml
Normal file
1
versions/readline-move/sitemap.xml
Normal file
File diff suppressed because one or more lines are too long
BIN
versions/readline-move/tab.png
Normal file
BIN
versions/readline-move/tab.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 18 KiB |
19
versions/readline-move/tags/index.html
Normal file
19
versions/readline-move/tags/index.html
Normal file
@ -0,0 +1,19 @@
|
||||
<!doctype html><html><head><title>Tags — Hilbish</title><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no"><meta name=theme-color content="#ff89dd"><meta content="/Hilbish/hilbish-flower.png" property="og:image"><meta property="og:site_name" content="Hilbish"><meta content="Tags — Hilbish" property="og:title"><meta content property="og:description"><meta content name=description><meta name=revisit-after content="2 days"><meta name=keywords content="Lua,Hilbish,Linux,Shell"><meta property="og:locale" content="en_GB"><link rel=canonical href=https://rosettea.github.io/Hilbish/><meta property="og:url" content="https://rosettea.github.io/Hilbish/"><link href=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/css/bootstrap.min.css rel=stylesheet integrity=sha384-0evHe/X+R7YkIZDRvuzKMRqM+OrBnVFBL6DOitfPri4tjfHxaWutUpFmBp4vmVor crossorigin=anonymous><script src=https://cdn.jsdelivr.net/npm/bootstrap@5.2.0-beta1/dist/js/bootstrap.bundle.min.js integrity=sha384-pprn3073KE6tl6bjs2QrFaJGz5/SUsLqktiwsUTF55Jfv3qYSDhgCecCxMW52nD2 crossorigin=anonymous></script>
|
||||
<link rel=stylesheet href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css integrity="sha512-KfkfwYDsLkIlwQp6LFnl8zNdLGxu9YAA1QvwINks4PhcElQSvqcyVLLD9aMhXd13uQjoXtEKNosOWaZqXgel0g==" crossorigin=anonymous referrerpolicy=no-referrer><link rel=stylesheet href=/Hilbish/versions/readline-move/css/syntax.min.eb77978873f3b324603120b558a36c98ad57d6ee7b77928e3bc131bd76c5935a.css integrity="sha256-63eXiHPzsyRgMSC1WKNsmK1X1u57d5KOO8ExvXbFk1o="></link><style>.heading>.heading-link{opacity:0}.heading:hover>.heading-link{visibility:visible;opacity:1;transition:all .1s ease-in}@keyframes highlight{0%{background:0 0}50%{background:#fff2cf}100%{background:0 0}}div:target{animation:highlight 1.2s;animation-timing-function:cubic-bezier(1,-.02,.45,.89)}table{border-width:1px;border-style:solid;border-color:#565c64;border-collapse:collapse;margin-bottom:12px}table td{padding:5px}table tr{border-width:1px}thead{display:none}</style></head><body class="d-flex flex-column min-vh-100" style=overflow-x:hidden><svg xmlns="http://www.w3.org/2000/svg" style="display:none"><symbol id="check-circle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M16 8A8 8 0 110 8a8 8 0 0116 0zm-3.97-3.03a.75.75.0 00-1.08.022L7.477 9.417 5.384 7.323a.75.75.0 00-1.06 1.06L6.97 11.03a.75.75.0 001.079-.02l3.992-4.99a.75.75.0 00-.01-1.05z"/></symbol><symbol id="info-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8 16A8 8 0 108 0a8 8 0 000 16zm.93-9.412-1 4.705c-.07.34.029.533.304.533.194.0.487-.07.686-.246l-.088.416c-.287.346-.92.598-1.465.598-.703.0-1.002-.422-.808-1.319l.738-3.468c.064-.293.006-.399-.287-.47l-.451-.081.082-.381 2.29-.287zM8 5.5a1 1 0 110-2 1 1 0 010 2z"/></symbol><symbol id="exclamation-triangle-fill" fill="currentcolor" viewBox="0 0 16 16"><path d="M8.982 1.566a1.13 1.13.0 00-1.96.0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889.0 1.438-.99.98-1.767L8.982 1.566zM8 5c.535.0.954.462.9.995l-.35 3.507a.552.552.0 01-1.1.0L7.1 5.995A.905.905.0 018 5zm.002 6a1 1 0 110 2 1 1 0 010-2z"/></symbol></svg><header><nav class="navbar navbar-expand-md sticky-top bg-light border-bottom"><div class=container-fluid><a class=navbar-brand href=/Hilbish><img src=/Hilbish/hilbish-logo-and-text.png alt height=48></a>
|
||||
<button class=navbar-toggler type=button data-bs-toggle=collapse data-bs-target=#navbarSupportedContent aria-controls=navbarSupportedContent aria-expanded=false aria-label="Toggle navigation">
|
||||
<span class=navbar-toggler-icon></span></button><div class="collapse navbar-collapse" id=navbarSupportedContent><ul class="navbar-nav me-auto mb-2 mb-lg-0"><li class=nav-item><a href=/Hilbish/versions/readline-move/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/readline-move/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><main class="mt-4 mb-4"><div class="row row-cols-1 row-cols-md-1 g-4"><div class="col d-flex justify-content-center"><div class=card style=width:56rem><div class=card-body><a href=https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.3-release/><h5 class=card-title>v2.3 Release</h5></a><h6 class='card-subtitle text-muted mb-2'><time>July 20, 2024</time></h6><p class=card-text>The release with full changelogs and prebuilt binaries can be seen at the v2.3.0 tag.
|
||||
Hilbish v2.3 has now been released! This is small feature and bug fix release which took a while to cme ut since I took a long break from programming in general. The next release will be great, so stay tuned for that.
|
||||
Features Pipes (via Lua) Commands can now be piped to each other via the Lua API with the hilbish.</p></div></div></div><div class="col d-flex justify-content-center"><div class=card style=width:56rem><div class=card-body><a href=https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.2-release/><h5 class=card-title>v2.2 Release</h5></a><h6 class='card-subtitle text-muted mb-2'><time>December 25, 2023</time></h6><p class=card-text>The release with full changelogs and prebuilt binaries can be seen at the v2.2.0 tag.
|
||||
Welcome to a very long awaited release of Hilbish, and on Christmas. Just think of it as a long preparing, late Christmas gift. :) This release does not contain a whole lot of changes, but it is a new release with enhancements and bug fixes!
|
||||
Documentation As is a trend, the documentation has been improved by ONE HUNDRED TIMES.</p></div></div></div><div class="col d-flex justify-content-center"><div class=card style=width:56rem><div class=card-body><a href=https://rosettea.github.io/Hilbish/versions/readline-move/blog/improving-this-website/><h5 class=card-title>Improving Hilbish's Branding</h5></a><h6 class='card-subtitle text-muted mb-2'><time>April 13, 2023</time></h6><p class=card-text>Happy birthday Hilbish! As of last month, Hilbish is now 2 years old. Unfortunately I missed the official date, but I will still make a more focused post on the date (19st).
|
||||
I decided to fix up this website and Hilbish’s logo, so that can be thought of as something for the 2 years milestone?
|
||||
Logo Hilbish’s old logo was.. not that good. It definitely functioned as a logo, but the yellow part of it looked ugly (sorry old logo).</p></div></div></div><div class="col d-flex justify-content-center"><div class=card style=width:56rem><div class=card-body><a href=https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.1.2-release/><h5 class=card-title>v2.1.2 Release</h5></a><h6 class='card-subtitle text-muted mb-2'><time>April 10, 2023</time></h6><p class=card-text>The release with full changelogs and prebuilt binaries can be seen at the v2.1.2 tag.
|
||||
This release reverts the April Fool’s code additions in v2.1.1. It is functionally equal to v2.1.0. Nice!
|
||||
A real release will come possibly in a few days or next week, so stay tuned for the good and feature-filled release of v2.2!</p></div></div></div><div class="col d-flex justify-content-center"><div class=card style=width:56rem><div class=card-body><a href=https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.1.1-release/><h5 class=card-title>v2.1.1 Release</h5></a><h6 class='card-subtitle text-muted mb-2'><time>April 1, 2023</time></h6><p class=card-text>The release with full changelogs and prebuilt binaries can be seen at the v2.1.1 tag.
|
||||
Welcome to a fresh new release of Hilbish! Some people (or none) may be awaiting the long coming v2.2 release with lots of features, but I needed to push out this little bug fix (wink) release.
|
||||
Bug Fixes Validation checks for command input When running this version, you may have noticed an odd message that sometimes comes up when running commands.</p></div></div></div><div class="col d-flex justify-content-center"><div class=card style=width:56rem><div class=card-body><a href=https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.1-release/><h5 class=card-title>v2.1 Release</h5></a><h6 class='card-subtitle text-muted mb-2'><time>February 7, 2023</time></h6><p class=card-text>The release with full changelogs and prebuilt binaries can be seen at the v2.1.0 tag.
|
||||
Oh look! A new release of Hilbish! This time is the v2.1 release, with a small amount of features and mainly documentation changes and bug fixes.
|
||||
Documentation There have been a few documentation enhancements for this release. This includes:
|
||||
Adding the return types for all functions that need them Documenting Hilbish types like job objects and timers properly.</p></div></div></div><div class="col d-flex justify-content-center"><div class=card style=width:56rem><div class=card-body><a href=https://rosettea.github.io/Hilbish/versions/readline-move/blog/v2.0-release/><h5 class=card-title>Hilbish v2.0 Release</h5></a><h6 class='card-subtitle text-muted mb-2'><time>December 29, 2022</time></h6><p class=card-text>Hilbish v2.0 has been released! Well actually, it was released a week ago, but I only wrote this Hilbish blog after that.
|
||||
This is a big release, coming 9 months after the previous v1.2.0 and featuring over 40+ bug fixes and tons of new features and enhancements, so let’s see what is in this release.
|
||||
Documentation When querying about the problems people have with Hilbish, one of the issues was its poor documentation.</p></div></div></div><div class="col d-flex justify-content-center"><div class=card style=width:56rem><div class=card-body><a href=https://rosettea.github.io/Hilbish/versions/readline-move/install/><h5 class=card-title>Install</h5></a><h6 class='card-subtitle text-muted mb-2'></h6><p class=card-text>Steps on how to install Hilbish on all the OSes and distros supported.</p></div></div></div><div class="col d-flex justify-content-center"><div class=card style=width:56rem><div class=card-body><a href=https://rosettea.github.io/Hilbish/versions/readline-move/blog/welcome/><h5 class=card-title>Welcome to the Hilbish blog</h5></a><h6 class='card-subtitle text-muted mb-2'></h6><p class=card-text>Hello! Welcome to the Hilbish blog. This will mainly contain release announcements and some other things relating to Hilbish (development).</p></div></div></div></div></main><footer class="footer mt-auto mt-auto py-3 bg-light row border-top"><div class="col mb-3"></div><div class="col mb-3"><a href=/Hilbish class="d-flex align-items-center mb-3 link-dark text-decoration-none"><img src=/Hilbish/hilbish-logo-and-text.png alt height=48 class="d-inline-block align-text-top" style=margin-left:-20px></a><ul class="nav flex-column"><li class="nav-item mb-2"><a href=/Hilbish class="nav-link p-0 text-muted">Home</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs/faq class="nav-link p-0 text-muted">FAQ</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish class="nav-link p-0 text-muted">Source</a></li><li class="nav-item mb-2"><a href=https://github.com/Rosettea/Hilbish/releases class="nav-link p-0 text-muted">Releases</a></li><li class="nav-item mb-2"><a href=/Hilbish/docs class="nav-link p-0 text-muted">Documentation</a></li></ul></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"></div><div class="col mb-3"><p class="text-muted mt-4">Rosettea © 2022-2023<br>Made with <i class="fa-solid fa-heart" style=color:#f6345b></i></p></div><div class="col mb-3"></div></footer></body></html>
|
||||
1
versions/readline-move/tags/index.xml
Normal file
1
versions/readline-move/tags/index.xml
Normal file
@ -0,0 +1 @@
|
||||
<?xml version="1.0" encoding="utf-8" standalone="yes"?><rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Tags on Hilbish</title><link>https://rosettea.github.io/Hilbish/versions/readline-move/tags/</link><description>Recent content in Tags on Hilbish</description><generator>Hugo -- gohugo.io</generator><language>en-us</language><atom:link href="https://rosettea.github.io/Hilbish/versions/readline-move/tags/index.xml" rel="self" type="application/rss+xml"/></channel></rss>
|
||||
BIN
versions/readline-move/terminal.png
Normal file
BIN
versions/readline-move/terminal.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 99 KiB |
Loading…
x
Reference in New Issue
Block a user