This commit is contained in:
2026-05-23 22:25:21 +02:00
parent bd1d2f3522
commit 844d3ca7c3
63 changed files with 3311 additions and 34 deletions
@@ -0,0 +1,51 @@
> Important Keybinds
the most important keybind to know is *SUPER+K*
this will open a searchable menu with all of your keybinds.
whenever SUPER is noted in your keybinds, that's the button generally found between ctrl and alt, on most keyboards it will have a windows logo, on macOS keyboards it'll be the option key.
However, you don't want to be referencing this menu all the time, so here's the keybinds you should learn first:
[^SUPER+SPACE]:
this opens your app runner, it's also set up to find files within your home directory automatically and can find settings for you.
[^SUPER+Y]:
this opens an installer for software. doing this while holding shift allows you to instead install packages from the Arch User Repository.
it is recommended to use the normal package installer unless the package is either not available or broken, in which case, use the AUR.
[^SUPER+1-9]:
using SUPER + the number keys allows you to switch between workspaces. holding shift while doing this allows you to take your active window with you.
[^SUPER+Left Mouse Button]:
this will allow you to drag and re-organize windows
[^SUPER+Right Mouse Button]:
this will allow you to drag to re-size windows
[^SUPER+Q]:
this quits the current window, like pressing the X on a desktop environment window
[^SUPER+Z]:
this opens the power menu, allowing you to log out, reboot or turn off your computer
[^SUPER+E]:
this opens your file browser
[^SUPER+B]:
this opens firefox
[^SUPER+ENTER]:
this opens your terminal
[^SUPER+H]:
this opens a menu that gives you short info on common commands, pressing enter or double-clicking a command will open the manual page for that command.
holding shift will instead open this menu!
[^SUPER+K]:
as mentioned before, this will give you a full overview of all keys.
@@ -0,0 +1,120 @@
> Using SDG-OS Functions
## Install TUIs
the process is the same for using Pacman repositories or using the AUR.
Please always prefer using the pacman repositories if possible, only use the AUR if needed.
step 1: either open a terminal and type the alias `pacgui` or `aurgui`, or use the keybind *SUPER+Y* for pacman or *SUPER+SHIFT+Y* for the AUR
step 2: search for your package
step 3: if you wish to install multiple packages, press tab after highlighting each package
step 4: press enter and provide your password
your software will now be installed alongside all of its dependencies
## TLDR TUI
you can call this using either the *SUPER+H* bind or the alias `tldrtui` in the terminal
you can use a mouse to interact with this interface or use the arrow keys, you can type to search.
pressing enter or double-clicking an entry will open the man page for that entry
pressing q on the manpage will bring you back to the main menu.
to exit, press *SUPER+Q* to quit the terminal
## help TUI
you can call this using the *SUPER+SHIFT+H* bind or the alias `helptui` in the terminal
you can use the arrow keys or the mouse to navigate and type to search.
enter refreshes the menu
to exit, press *SUPER+Q*
## mango config editor
to start, either press *SUPER+M* or run `mangoconf` in the terminal.
this will provide you with a menu listing the configuration files in ~/.config/mango
on the right side, it will show you a preview of the file.
once you've found the file you want to edit, press enter to open it in micro.
in micro, you can use ctrl+s to save and ctrl+q to quit
then, you can reload the mango config with *SUPER+R*
## project selector
the project selector uses a state file in your ~/.config directory to determine which directory to scan.
this directory must be inside home, and is set to ~/projects by default
to change this, run the following:
`echo "my-projects/subdir-if-needed" > ~/.config/projectdir.state`
this example would make the project selector scan /home/UserName/my-projects/subdir-if-needed
the project selector finds git repositories, so it will only display projects that are a git repository. it is recommended you keep your projects in git repo's.
for configs, you can place them inside a git repo and symlink them using the ln command or using stow.
with git repositories inside your projects directory, you can now use the project selector to access them.
you can open the project selector with the bind *SUPER+SHIFT+TAB* or the terminal alias `git-projects`
on the left, you'll see the full paths to all found git repositories.
on the right, you'll see a listing of the files in the git repository as well as the readme.
pressing enter on the repository will open the repository in code-OSS, which will then allow you to work on the repository without clutter.
this also allows you to then use the code-OSS GUI to do git pull, push and sync.
## layout switcher
you can open the layout switcher with the bind *SUPER+W*
you can then tab through the layouts using the arrow keys and press enter on your desired one.
this will only affect your current view on the active monitor and will be reset when the config is reloaded.
if you've accidentally messed up your layout, pressing *SUPER+R* will force it back to dwindle.
## documentation menu
you can open this menu using the alias `documentation` in the terminal or the bind *SUPER+shift+M*
this menu will allow you to quickly open both various documentation sites in firefox as well as custom-built searchable quick reference menu's
## tips
tips are shown automatically when you start your first terminal session, they are also shown when you run the command `tipme`
you can also get a tip in your notifications by pressing the bind *SUPER+0*
@@ -0,0 +1,22 @@
> Accessing the settings menu
the Dank Material Shell Settings will be where you configure most of your basic things.
there is a custom bind for this: *SUPER+S*
you can also access it from multiple places in the top bar, the app launcher (*SUPER+SPACE*) and the control center (*SUPER+ESCAPE*)
the settings menu is divided into the following sections:
personalization - here you'll find theming, typography, animations, sounds, time, weather and wallpapers
dank bar - here you'll find basic bar settings
workspaces and widgets - here you'll find more complex configurations for both desktop widgets and items in the bar
dock and launcher - here you'll find configurations for the app launcher as well as the toggleable dock.
keyboard shortcuts - gives you a graphical menu to add your own keybinds
displays - gives you graphical display configuration
network - manage your network connections and VPNs
system - this contains audio, clipboard and multiplexer settings
power and security - this contains your lock screen and power/sleep settings
plugins - install DMS plugins to extend functionality
take the time to browse through these and try some stuff.
@@ -0,0 +1,105 @@
> Other Menus
DMS and SDG-OS have a variety of menus, here's an overview of them and how you can access them
## runner
the runner can be accessed using the keybind *SUPER+SPACE*
it can also be accessed by clicking the button on the top left of the bar, a button for this can also be turned on in the dock.
by default, the button will be in apps mode, the keybind will be in "all" mode.
in apps mode, the runner menu will allow you to launch applications
in search mode, the runner will allow you to search through your /home directory
under plugins, you can select settings, you can also do this by starting your search with "?"
this will allow you to search through DMS settings.
## Keybinds
this can be accessed with *SUPER+K*
the keybinds menu gives you a searchable overview of the keybinds configured in ~/.config/mango/binds.conf
## clipboard History
this can be accessed with *SUPER+V* or from a widget on your bar.
you can see your clipboard history from here and load any of those elements back to your clipboard
## process list
this can be accessed with *SUPER+X* or from various widgets on your bar.
this menu acts as a "Task Manager", allowing you to view, search and kill processes, monitor performance and monitor disk usage.
this is also a good place to find information about your system, such as what kernel you're running, what your hostname is and what CPU/GPU you have.
## dash
the dash can be accessed through various bar widgets and contains an overview with calendar and metrics, a media player, wallpaper selector, weather and access to your settigns.
## notifications
notifications can be accessed with *SUPER+SHIFT+N*, from the notifications widget or from the control center
this will show you a notification history as well as current notifications, allows you to toggle do not disturb and allows you to configure notification settings.
## control center
this can be accessed with *SUPER+ESCAPE* or from the bar widget and gives you quick access to common settings like wifi, bluetooth, audio, theming, the settings menu and power controls.
## power menu
this can be accessed from a bar widget or *SUPER+Z* and allows you to reboot, shut down or sleep your PC.
## notepad
this can be toggled with *SUPER+N* or a bar widget, and is a simple space to keep quick notes.
## command help
this can be spawned with *SUPER+H* and gives you a searchable list of basic commands with their TLDR overviews
selecting a command shows the full manual page, pressing q in the manual page brings you back to the main menu
## full help
this menu! spawned with *SUPER+SHIFT+H*
## package installer
spawned with *SUPER+Y*, this menu allows you to search the pacman repository, read details and install packages.
## AUR installer
spawned with *SUPER+SHIFT+Y*, this menu allows you to search the Arch User Repository, read details and install packages.
## Mango Config TUI
spawned with *SUPER+M*, this menu gives you a list of your mango configuration files with a preview, selecting an item will open it in the micro text editor.
## layout switcher
spawned with *SUPER+W*, this menu allows you to switch between mangoWM layouts
## documentation
spawned with *SUPER+SHIFT+M*, this menu gives you quick access to relevant documentation
## Project selector
spawned with *SUPER+SHIFT+TAB*, this menu gives you quick access to working on any git projects in your ~/projects directory