sammyette/Hilbish
2
2
Fork 0
mirror of https://github.com/Hilbis/Hilbish synced 2025-07-01 08:42:04 +00:00
Code Issues Releases Wiki Activity
Hilbish/versions/new-website/docs/features/opts/index.html

23 lines
13 KiB
HTML
Raw Blame History

<!doctype html>
<html class="bg-stone-50 dark:bg-neutral-900 text-black dark:text-white"><head><meta content="width=device-width, initial-scale=1.0" name="viewport"><link href="https://rosettea.github.io/Hilbish/versions/new-website/tailwind.css" rel="stylesheet"><title>Hilbish</title><meta content="#ff89dd" name="theme-color"><meta content="https://rosettea.github.io/Hilbish/versions/new-website/hilbish-flower.png" property="og:image"><meta content="Hilbish" property="og:title"><meta content="Hilbish" property="og:site_name"><meta content="website" property="og:type"><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 content="Lua,Shell,Hilbish,Linux,zsh,bash" name="keywords"><meta content="https://rosettea.github.io/Hilbish/versions/new-website" property="og:url"></head><body class="h-screen flex flex-col"><nav class="bg-stone-100/80 dark:bg-neutral-950/80 flex justify-around sticky items-center top-0 w-full z-50 border-b border-b-zinc-300 backdrop-blur-md h-12"><div class="flex my-auto px-2"><div><a class="flex items-center gap-1" href="/"><img class="h-8" src="https://rosettea.github.io/Hilbish/versions/new-website/hilbish-flower.png"><span class="self-center text-3xl font-medium">Hilbish</span></a></div></div><div class="flex gap-3"><a href="https://rosettea.github.io/Hilbish/versions/new-website/install"><span class="inline-flex text-light dark:text-pink-300 dark:hover:text-pink-200 text-pink-600 hover:text-pink-500 hover:underline">Install</span></a><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs"><span class="inline-flex text-light dark:text-pink-300 dark:hover:text-pink-200 text-pink-600 hover:text-pink-500 hover:underline">Docs</span></a><a href="https://rosettea.github.io/Hilbish/versions/new-website/blog"><span class="inline-flex text-light dark:text-pink-300 dark:hover:text-pink-200 text-pink-600 hover:text-pink-500 hover:underline">Blog</span></a></div></nav><div class="flex-1 flex flex-col overflow-hidden"><div class="sm:hidden h-10 flex py-2 px-4 border-b border-b-zinc-300 w-full gap-2 backdrop-blur-sm bg-zinc-300/50 dark:bg-zinc-800/50"><label class="cursor-pointer" for="sidebar-toggle"><tag><svg xmlns="http://www.w3.org/2000/svg" height="24px" viewBox="0 -960 960 960" width="24px" class="fill-white"><path d="M120-240v-80h240v80H120Zm0-200v-80h480v80H120Zm0-200v-80h720v80H120Z"/></svg></tag></label><span class="font-bold">Options</span></div><div class="flex-1 sm:flex grid overflow-hidden"><input class="peer hidden" id="sidebar-toggle" type="checkbox"><div class="overflow-y-scroll p-4 sm:border-r sm:border-r-zinc-300 col-start-1 row-start-1 bg-neutral-100 dark:bg-neutral-950 basis-2/10 transition-transform duration-300 -translate-x-full peer-checked:translate-x-0 sm:translate-x-0 z-30"><ul class="text-lg flex flex-col gap-2"><li class="font-bold"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs">Introduction</a></li><li class="font-bold"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/getting-started">Getting Started</a></li><li class="font-bold"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/faq">Frequently Asked Questions</a></li><li class="font-bold"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/features">Features</a></li><ul class="pl-4"><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/completions">Completions</a></li><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/features/notifications">Notification</a></li><li class="mb-2 text-pink-400"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/features/opts"> -&gt; Options</a></li><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/features/runner-mode">Runner Mode</a></li></ul><li class="font-bold"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/hooks">Signals</a></li><ul class="pl-4"><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/hooks/command">Command</a></li><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/hooks/hilbish">Hilbish</a></li><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/hooks/signal">Signal</a></li></ul><li class="font-bold"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/lunacolors">Lunacolors</a></li><li class="font-bold"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/api">API</a></li><ul class="pl-4"><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/api/bait">Module bait</a></li><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/api/commander">Module commander</a></li><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/api/fs">Module fs</a></li><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/api/hilbish">Module hilbish</a></li><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/api/readline">Module readline</a></li><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/api/snail">Module snail</a></li><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/api/terminal">Module terminal</a></li><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/api/yarn">Module yarn</a></li></ul><li class="font-bold"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/nature">Nature</a></li><ul class="pl-4"><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/nature/dirs">Module dirs</a></li><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/nature/doc">Module doc</a></li></ul><li class="font-bold"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/vim-mode">Vim Mode</a></li><ul class="pl-4"><li class="mb-2"><a href="https://rosettea.github.io/Hilbish/versions/new-website/docs/vim-mode/actions">Actions</a></li></ul></ul></div><main class="flex-1 flex justify-center basis-7/7 col-start-1 row-start-1 transition-all duration-300 peer-checked:filter peer-checked:blur-sm peer-checked:bg-black/30"><div class="flex-1 flex flex-col overflow-y-auto"><div class="flex-1 w-3/4 self-center p-8"><h1 class="my-3 font-bold text-4xl">Options</h1><i>Simple customizable options.</i><p>Opts are simple toggle or value options a user can set in Hilbish.
As toggles, there are things like <code class="text-violet-600 dark:text-violet-400">autocd</code> or history saving. As values,
there is the <code class="text-violet-600 dark:text-violet-400">motd</code> which the user can either change to a custom string or disable.<br> <br>Opts are accessed from the <code class="text-violet-600 dark:text-violet-400">hilbish.opts</code> table. Here they can either
be read or modified.</p><h3 class="my-1 text-neutral-800 dark:text-neutral-300 font-bold text-2xl" id="autocd"><code class="text-violet-600 dark:text-violet-400">autocd</code></h3><h4 class="my-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl" id="Value:-boolean">Value: <code class="text-violet-600 dark:text-violet-400">boolean</code></h4><h4 class="my-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl" id="Default:-false">Default: <code class="text-violet-600 dark:text-violet-400">false</code></h4><p>The autocd opt makes it so that lone directories attempted to be executed are
instead set as the shell&#39;s directory.</p><p>Example:</p><pre><code data-lang="text">~/Directory
∆ ~
~
∆ Downloads
~/Downloads
∆ ../Documents
~/Documents
∆
</code></pre><div><hr class="my-4"></div><h3 class="my-1 text-neutral-800 dark:text-neutral-300 font-bold text-2xl" id="history"><code class="text-violet-600 dark:text-violet-400">history</code></h3><h4 class="my-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Value: <code class="text-violet-600 dark:text-violet-400">boolean</code></h4><h4 class="my-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl" id="Default:-true">Default: <code class="text-violet-600 dark:text-violet-400">true</code></h4><p>Sets whether command history will be saved or not.</p><div><hr class="my-4"></div><h3 class="my-1 text-neutral-800 dark:text-neutral-300 font-bold text-2xl" id="greeting"><code class="text-violet-600 dark:text-violet-400">greeting</code></h3><h4 class="my-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl" id="Value:-boolean-or-string">Value: <code class="text-violet-600 dark:text-violet-400">boolean</code> or <code class="text-violet-600 dark:text-violet-400">string</code></h4><p>The greeting is the message that Hilbish shows on startup
(the one which says Welcome to Hilbish).<br>This can be set to either true/false to enable/disable or a custom greeting string.</p><div><hr class="my-4"></div><h3 class="my-1 text-neutral-800 dark:text-neutral-300 font-bold text-2xl" id="motd"><code class="text-violet-600 dark:text-violet-400">motd</code></h3><h4 class="my-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Value: <code class="text-violet-600 dark:text-violet-400">boolean</code></h4><h4 class="my-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Default: <code class="text-violet-600 dark:text-violet-400">true</code></h4><p>The message of the day shows the current major.minor version and
includes a small range of things added in the current release.<br> <br>This can be set to <code class="text-violet-600 dark:text-violet-400">false</code> to disable the message.</p><div><hr class="my-4"></div><h3 class="my-1 text-neutral-800 dark:text-neutral-300 font-bold text-2xl" id="fuzzy"><code class="text-violet-600 dark:text-violet-400">fuzzy</code></h3><h4 class="my-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Value: <code class="text-violet-600 dark:text-violet-400">boolean</code></h4><h4 class="my-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Default: <code class="text-violet-600 dark:text-violet-400">false</code></h4><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 <strong>closest</strong> will be shown instead
of an exact match.</p><div><hr class="my-4"></div><h3 class="my-1 text-neutral-800 dark:text-neutral-300 font-bold text-2xl" id="notifyJobFinish"><code class="text-violet-600 dark:text-violet-400">notifyJobFinish</code></h3><h4 class="my-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Value: <code class="text-violet-600 dark:text-violet-400">boolean</code></h4><h4 class="my-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl">Default: <code class="text-violet-600 dark:text-violet-400">true</code></h4><p>If this is enabled, when a background job is finished,
a <a href="../notifications">notification</a> will be sent.</p><div><hr class="my-4"></div><h3 class="my-1 text-neutral-800 dark:text-neutral-300 font-bold text-2xl" id="processorSkipList"><code class="text-violet-600 dark:text-violet-400">processorSkipList</code></h3><h4 class="my-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl" id="Value:-table">Value: <code class="text-violet-600 dark:text-violet-400">table</code></h4><h4 class="my-1 text-neutral-800 dark:text-neutral-300 font-bold text-xl" id="Default:-{}">Default: <code class="text-violet-600 dark:text-violet-400">{}</code></h4><p>A table listing the names of command processors to skip.</p></div><footer class="py-4 px-6 flex flex-row justify-around border-t border-t-zinc-300"><div class="flex flex-col"><a class="flex items-center gap-1" href="https://rosettea.github.io/Hilbish/versions/new-website"><img class="h-24" src="https://rosettea.github.io/Hilbish/versions/new-website/hilbish-flower.png"><span class="self-center text-6xl">Hilbish</span></a><span class="text-xl">The Moon-powered shell!</span><span class="text-light text-neutral-500">MIT License, copyright sammyette 2025</span></div><div class="flex flex-col"><a href="https://github.com/Rosettea/Hilbish" target="_blank"><span class="inline-flex text-light dark:text-pink-300 dark:hover:text-pink-200 text-pink-600 hover:text-pink-500 hover:underline"><tag><svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" class="size-6">
<path stroke-linecap="round" stroke-linejoin="round" d="M13.5 6H5.25A2.25 2.25 0 0 0 3 8.25v10.5A2.25 2.25 0 0 0 5.25 21h10.5A2.25 2.25 0 0 0 18 18.75V10.5m-10.5 6L21 3m0 0h-5.25M21 3v5.25" />
</svg>
</tag>GitHub</span></a></div></footer></div></main></div></div></body></html>
Reference in New Issue View Git Blame Copy Permalink