mirror of
https://github.com/Hilbis/Hilbish
synced 2025-05-06 04:13:24 +00:00
53 lines
6.5 KiB
HTML
53 lines
6.5 KiB
HTML
<!doctype html>
|
||
<html class="bg-stone-50 dark:bg-neutral-950 text-black dark:text-white"><head><meta content="width=device-width, initial-scale=1.0" name="viewport"><link href="/tailwind.css" rel="stylesheet"><title>Hilbish</title><meta content="#ff89dd" name="theme-color"><meta content="./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><nav class="flex sticky 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-6" src="/hilbish-flower.png"><span class="self-center text-2xl">Hilbish</span></a></div></div></nav><div class="flex flex-col"><div class="block sm:hidden h-10 sticky top-12 flex py-2 px-4 border-b border-b-zinc-300 w-full gap-2 backdrop-blur-sm bg-zinc-300/50 z-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-black"><path d="M120-240v-80h240v80H120Zm0-200v-80h480v80H120Zm0-200v-80h720v80H120Z"/></svg></tag></label><span>Options</span></div><div class="grid sm:flex"><input class="peer hidden" id="sidebar-toggle" type="checkbox"><div class="border-r border-r-zinc-300 col-start-1 row-start-1 sticky top-22 sm:top-12 h-full sm:h-svh bg-neutral-200 basis-3/5 transition-transform duration-300 -translate-x-full sm:translate-x-0 peer-checked:translate-x-0 z-30"><div class="p-4 -mb-4 overflow-y-auto h-full"><h2 class="text-xl font-semibold mb-4">Sidebar</h2><ul><li class="mb-2">Lunacolors</li><li class="mb-2">Introduction</li><li class="mb-2">Completions</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Options</li><li class="mb-2">Features</li><li class="mb-2">Runner Mode</li><li class="mb-2">Notification</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Command</li><li class="mb-2">Hilbish</li><li class="mb-2">Vim Mode</li><li class="mb-2">Actions</li><li class="mb-2">Module bait</li><li class="mb-2">Module terminal</li><li class="mb-2">API</li><li class="mb-2">Module fs</li><li class="mb-2">Module commander</li><li class="mb-2">Module snail</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module dirs</li><li class="mb-2">Nature</li><li class="mb-2">Module doc</li></ul></div></div><main class="col-start-1 row-start-1 transition-all duration-300 peer-checked:filter peer-checked:blur-sm peer-checked:bg-black/30 px-4 pt-2"><h1>Options</h1><Tag xmlns="namespace"><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>
|
||
<h3><code>autocd</code></h3>
|
||
<h4>Value: <code>boolean</code></h4>
|
||
<h4>Default: <code>false</code></h4>
|
||
<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>
|
||
<pre><code><span>~/Directory
|
||
</span><span>∆ ~
|
||
</span><span>~
|
||
</span><span>∆ Downloads
|
||
</span><span>~/Downloads
|
||
</span><span>∆ ../Documents
|
||
</span><span>~/Documents
|
||
</span><span>∆
|
||
</span></code></pre>
|
||
<hr>
|
||
<h3><code>history</code></h3>
|
||
<h4>Value: <code>boolean</code></h4>
|
||
<h4>Default: <code>true</code></h4>
|
||
<p>Sets whether command history will be saved or not.</p>
|
||
<hr>
|
||
<h3><code>greeting</code></h3>
|
||
<h4>Value: <code>boolean</code> or <code>string</code></h4>
|
||
<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>
|
||
<h3><code>motd</code></h3>
|
||
<h4>Value: <code>boolean</code></h4>
|
||
<h4>Default: <code>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.</p>
|
||
<p>This can be set to <code>false</code> to disable the message.</p>
|
||
<hr>
|
||
<h3><code>fuzzy</code></h3>
|
||
<h4>Value: <code>boolean</code></h4>
|
||
<h4>Default: <code>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 <em>closest</em> will be shown instead
|
||
of an exact match.</p>
|
||
<hr>
|
||
<h3><code>notifyJobFinish</code></h3>
|
||
<h4>Value: <code>boolean</code></h4>
|
||
<h4>Default: <code>true</code></h4>
|
||
<p>If this is enabled, when a background job is finished,
|
||
a <a href="../notifications" rel="noopener noreferrer">notification</a> will be sent.</p></Tag></main></div></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="/"><img class="h-24" src="/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"><span class="text-pink-300 text-light">GitHub</span></a></div></footer></body></html> |