Skip to content

Commit

Permalink
docs: added more details about login shells in KDE and Debian environ…
Browse files Browse the repository at this point in the history
…ments (#262)

* Addition of Debian Gnome / KDE / Manual Execution of Dorothy in Debian/Ubuntu

* Fixing broken characters.

* Fixing one more broken character.

* Fixed formatting.

* Updated documentation.

* Updated documentation.

* Updated documentation.

* docs: implemented feedback from #262

---------

Co-authored-by: Benjamin Lupton <b@lupton.cc>
  • Loading branch information
octavian-one and balupton authored Dec 20, 2024
1 parent f557548 commit 41a47e7
Showing 1 changed file with 36 additions and 9 deletions.
45 changes: 36 additions & 9 deletions docs/dorothy/dorothy-not-loading.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,43 @@
# What to do if Dorothy is not loading

Installed Dorothy, opened a new terminal, but none of the Dorothy commands are available?
You've installed Dorothy, opened a new terminal, but none of the Dorothy commands are available?

It could be that your terminal application is refusing to operate your shell as a login shell, which is how Dorothy (and many other applications) identify whether they should complete loading themselves. If Dorothy were to load itself on non-login shells then every shell command would also have to load Dorothy which would be be an unnecessary slow down to every shell command! By having Dorothy only load inside login shells, we allow everything to work perfectly.

So what to do when your terminal isn't opening a login shell?

## Ubuntu
## Manual Invocation

In the top menu bar, tap the terminal application title, and open preferences:
You can manually invoke a login shell by executing any of these commands:

- Bash: `bash -l`
- ZSH: `zsh -l`
- Fish: `fish -l`
- Nu: `nu -l`
- Xonsh: `xonsh -l`
- Elvish: elvish doesn't have the concept of login shells, so this does not apply.
- Dash: `dash -l`
- KSH: `ksh -l`

## Gnome Terminal (Ubuntu, Debian, etc.)

Open the `Terminal` application. In the top menu bar, tap the `Terminal` application title, then open `Preferences`:

![Screenshot of the Ubuntu Terminal Menubar](https://github.com/bevry/dorothy/blob/master/docs/assets/login-shell-ubuntu-menubar.png?raw=true)

Navigate to the active profile, select command, and ensure that login shell is enabled:
Navigate to the active profile, select `Command`, and ensure that the login shell preference enabled/checked:

![Screenshot of the Ubuntu Terminal Preferences](https://github.com/bevry/dorothy/blob/master/docs/assets/login-shell-ubuntu-preferences.png?raw=true)

Close the preferences and open a new terminal tab, now Dorothy should be loaded which you can verify by running `dorothy theme` to select a theme.
Close the Preferences and open a new terminal tab.

## Visual Studio Code

1. Open the Visual Studio Code Command Palette (`Ctrl + Shift + P` on Windows, `Command + Shift + P` on macOS).

2. Open `Preferences: User Settings (JSON)` via typing and enter.
1. Open `Preferences: User Settings (JSON)` via typing and enter.

3. Merge the following JSON with your own JSON:
1. Merge the following JSON with your own JSON:

```javascript
{
Expand Down Expand Up @@ -73,6 +86,20 @@ Close the preferences and open a new terminal tab, now Dorothy should be loaded
}
```

4. Save the settings.
1. Save the settings.

1. Use the menu bar `Termina: New Terminal` or the Command Palette `Terminal: Create New Terminal` to open a new terminal.

## Konsole (KDE)

1. Navigate to` Settings``Console`.

1. Click `Profiles`.

1. Set a name for your profile.

1. Click `Default profile`

1. Type one of the [Manual Invocation] commands in the command textbox, e.g. for Bash type `bash -l`.

5. Use the menu bar `Termina: New Terminal` or the Command Palette `Terminal: Create New Terminal` to open a new terminal. It should now start as a login shell, loading Dorothy as expected. Validate this by running a Dorothy command, like `dorothy theme`, to ensure everything is functioning as intended.
1. Close the Preferences and open a new terminal tab.

0 comments on commit 41a47e7

Please sign in to comment.