From dd477e1422881b99e344e40b9494af86f29992aa Mon Sep 17 00:00:00 2001 From: TorchedSammy Date: Sat, 9 Jul 2022 16:40:05 +0000 Subject: [PATCH] deploy: d5d8c05230c9db27fee0a31fb8acd48b9ef1f7bb --- docs/getting-started/index.html | 26 ++++++++++++++++++++++++-- docs/index.html | 13 +++++++++++-- docs/index.xml | 3 ++- index.xml | 3 ++- 4 files changed, 39 insertions(+), 6 deletions(-) diff --git a/docs/getting-started/index.html b/docs/getting-started/index.html index 32a55e5..1995bfe 100644 --- a/docs/getting-started/index.html +++ b/docs/getting-started/index.html @@ -1,5 +1,27 @@ -Getting Started — Hilbish +Getting Started — Hilbish

Getting Started

\ No newline at end of file +

Getting Started

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.

{{ warning “It is not recommended to set Hilbish as your login shell. That is expected to be a +POSIX compliant shell, which Hilbish is not. At most, there will just be a +few variables missing in your environment” >}}

To do that, simply run chsh -s /usr/bin/hilbish. +Some distros (namely Fedora) might have lchsh instead, which is used like lchsh <user>. +When prompted, you can put the path for Hilbish.

Default with terminal

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.

Run after login shell

Some shells (like zsh) have an rc file, like .zlogin, which is ran when the shell session +is a login shell. In that file, you can run Hilbish. Example:

exec hilbish -S -l
+

This will replace the shell with Hilbish, set $SHELL to Hilbish and launch it as a login shell.

Configuration

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.

Hilbish’s sample configuration is usually located in hilbish.dataDir .. '/.hilbishrc.lua'. +You can print that path via Lua to see what it is: print(hilbish.dataDir .. '/.hilbishrc.lua'). +As an example, it will usually will result in /usr/share/hilbish/.hilbishrc.lua on Linux.

To edit your user configuration, you can copy that file to hilbish.userDir.config .. '/hilbish/init.lua', +which follows XDG on Linux and MacOS, and is located in %APPDATA% on Windows.

As the directory is usually ~/.config on Linux, you can run this command to copy it:
cp /usr/share/hilbish/.hilbishrc.lua ~/.config/hilbish/init.lua

Now you can get to editing it. Since it’s just a Lua file, having basic +knowledge of Lua would help. All of Lua’s standard libraries and functions +from Lua 5.4 are available. Hilbish has some custom and modules that are +available. To see them, you can run the doc command. This also works as +general documentation for other things.

\ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 1eaf7f2..bb5e0ba 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,5 +1,14 @@ -Introduction — Hilbish +Introduction — Hilbish

Introduction

Hello!

\ No newline at end of file +

Introduction

Here lies the documentation for Hilbish, the hyper extensible Lua shell.
Hilbish provides you with a few quality of life features and useful +functions to ensure you can make the shell fully yours.

These features include:

  • Completion and history search menus
  • Hinting and syntax highlighting (scripted by user)

Installation

Steps on installing Hilbish will be at the Install page in the navigation bar +at the top. This also included getting development builds from the GitHub +repository.

\ No newline at end of file diff --git a/docs/index.xml b/docs/index.xml index f348516..1e4558a 100644 --- a/docs/index.xml +++ b/docs/index.xml @@ -1,3 +1,4 @@ Introduction on Hilbishhttps://rosettea.github.io/Hilbish/docs/Recent content in Introduction on HilbishHugo -- gohugo.ioen-usFrequently Asked Questionshttps://rosettea.github.io/Hilbish/docs/faq/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/docs/faq/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 . -Where is the API documentation?Getting Startedhttps://rosettea.github.io/Hilbish/docs/getting-started/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/docs/getting-started/ \ No newline at end of file +Where is the API documentation?Getting Startedhttps://rosettea.github.io/Hilbish/docs/getting-started/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/docs/getting-started/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. \ No newline at end of file diff --git a/index.xml b/index.xml index d12b508..7c0a25f 100644 --- a/index.xml +++ b/index.xml @@ -1,6 +1,7 @@ Hilbishhttps://rosettea.github.io/Hilbish/Recent content on HilbishHugo -- gohugo.ioen-usFrequently Asked Questionshttps://rosettea.github.io/Hilbish/docs/faq/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/docs/faq/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 . -Where is the API documentation?Getting Startedhttps://rosettea.github.io/Hilbish/docs/getting-started/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/docs/getting-started/Installhttps://rosettea.github.io/Hilbish/install/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/install/Github Prebuilt Binaries The easiest and best way to get Hilbish is directly from Github. +Where is the API documentation?Getting Startedhttps://rosettea.github.io/Hilbish/docs/getting-started/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/docs/getting-started/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.Installhttps://rosettea.github.io/Hilbish/install/Mon, 01 Jan 0001 00:00:00 +0000https://rosettea.github.io/Hilbish/install/Github Prebuilt Binaries The easiest and best way to get Hilbish is directly from Github. For official stable releases, check out the latest Github release. Linux Repositories Hilbish is packaged in a few repositories for some distros. Arch Linux (AUR) Hilbish is on the AUR. Setup an AUR helper, and install. Example with yay: yay -S hilbish Or, from master branch: