Hilbish/versions/doc-opts/docs/opts/index.html

29 lines
7.7 KiB
HTML

<!doctype html><html><head><title>Opts — 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="Opts — Hilbish" property="og:title"><meta content="Opts are simple settings and switches to control certain Hilbish behavior. This ranges from things like the greeting messages on bootup to &ldquo;autocd&rdquo; functionality.
They can be changed via a simple assign (like hilbish.opts.namehere = true).
Available Opts autocd The autocd opt (default false) makes it so that if a lone path is ran, Hilbish will change directory to that path.
Example:
sammy ~ ∆ hilbish.opts.autocd = true sammy ~ ∆ ~/Downloads sammy ~/Downloads ∆ history This opt controls if Hilbish will store commands in history." property="og:description"><meta content="Opts are simple settings and switches to control certain Hilbish behavior. This ranges from things like the greeting messages on bootup to &ldquo;autocd&rdquo; functionality.
They can be changed via a simple assign (like hilbish.opts.namehere = true).
Available Opts autocd The autocd opt (default false) makes it so that if a lone path is ran, Hilbish will change directory to that path.
Example:
sammy ~ ∆ hilbish.opts.autocd = true sammy ~ ∆ ~/Downloads sammy ~/Downloads ∆ history This opt controls if Hilbish will store commands in history." 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><style>.heading>.heading-link{opacity:0}.heading:hover>.heading-link{visibility:visible;opacity:1;transition:all .1s ease-in}</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/doc-opts/ class=nav-link>Home</a></li><li class=nav-item><a href=/Hilbish/versions/doc-opts/install/ class=nav-link>Install</a></li><li class=nav-item><a href=/Hilbish/versions/doc-opts/docs/ class=nav-link>Docs</a></li><li class=nav-item><a href=/Hilbish/versions/doc-opts/blog/ class=nav-link>Blog</a></li></ul></div></div></nav></header><main><div class="container mt-2"><h1>Opts</h1><img src='https://avatars1.githubusercontent.com/u/38820196?s=460&amp;u=b9f4efb2375bae6cb30656d790c6e0a2939327c0&amp;v=4' width=48 style=border-radius:100%>
<em class=text-muted>by <strong>sammyette</strong><time> // April 14, 2023</time></em><div class=my-4><p>Opts are simple settings and switches to control certain Hilbish behavior.
This ranges from things like the greeting messages on bootup to &ldquo;autocd&rdquo;
functionality.</p><p>They can be changed via a simple assign (like <code>hilbish.opts.namehere = true</code>).</p><h2 id=available-opts class=heading>Available Opts
<a href=#available-opts class=heading-link><i class="fas fa-paperclip"></i></a></h2><h3 id=autocd class=heading><code>autocd</code>
<a href=#autocd class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>The <code>autocd</code> opt (default false) makes it so that if a lone path is
ran, Hilbish will change directory to that path.</p><p>Example:</p><pre tabindex=0><code>sammy ~ ∆ hilbish.opts.autocd = true
sammy ~ ∆ ~/Downloads
sammy ~/Downloads ∆
</code></pre><h3 id=history class=heading><code>history</code>
<a href=#history class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>This opt controls if Hilbish will store commands in history. It
is default true.</p><h3 id=greeting class=heading><code>greeting</code>
<a href=#greeting class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>The <code>greeting</code> is exactly as the name says: a greeting message on Hilbish
startup. It can be set to any value, and when Hilbish finishes initalizing
will print that text. The <code>greeting</code> will be passed to Lunacolors for
formatting.</p><h3 id=motd class=heading><code>motd</code>
<a href=#motd class=heading-link><i class="fas fa-paperclip"></i></a></h3><p>The <code>motd</code> is a message to summarize the current running version. It can be
set as a boolean (true or false).</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 &copy; 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>