Document bash files in system/

Signed-off-by: Severin Kaderli <severin.kaderli@gmail.com>

.gitlab-ci.yml

@@ -15,5 +15,6 @@ Lint:
     - shellcheck ./system/.keyleds
     - shellcheck ./system/.xinitrc
     - shellcheck ./system/.xprofile
+    - shellcheck ./system/.xsetup
     - shellcheck ./install.sh
     - shellcheck ./post-install.sh

install.sh

@@ -50,6 +50,7 @@ LINKED_FILES_HOME=(
     ".xinitrc"
     ".xprofile"
     ".Xresources"
+    ".xsetup"
     "bin"
     "dconf"
 )

system/.aliases

@@ -1,20 +1,32 @@
 #!/bin/bash
+# 
+# SCRIPT NAME:
+# .aliases
 #
-# Author: Severin Kaderli <severin.kaderli@gmail.com>
+# AUTHOR:
+# Severin Kaderli <severin.kaderli@gmail.com>
+#
+# DESCRIPTION:
+# This script is used to define aliases for commands.
+#
+# USAGE:
+# This script is sourced by .bashrc
 
-# Shortcut for clear because I sometimes type the DOS command instead
+# Alias for clear because I sometimes type the DOS command instead
 alias cls="clear"
 
-# Use exa as ls replacement
+# Alias for using exa as ls replacement
 alias ls="exa -al"
 alias ll="exa -al"
 
-# Use ripgrep as grep replacement
+# Alias for using ripgrep as grep replacement
 alias grep="rg -n"
 
-# cd shortcut to get to my Projects folder
+# Alias to get to my Projects folder
 alias pj="cd ~/Projects"
 
+# Alias for opening my code editor
 alias e="code"
 
+# Alias for starting Guild Wars 2 using bumblebee and wine
 alias gw2="primusrun wine64 ~/.wine/drive_c/Program\ Files/Guild\ Wars\ 2/Gw2-64.exe -dx9single -autologin -mapLoadinfo"

system/.bash_logout

@@ -1,8 +1,18 @@
 #!/bin/bash
-# ~/.bash_logout: executed by bash(1) when login shell exits.
+# 
-
+# SCRIPT NAME:
-# when leaving the console clear the screen to increase privacy
+# .bash_logout
+#
+# AUTHOR:
+# Severin Kaderli <severin.kaderli@gmail.com>
+#
+# DESCRIPTION:
+# This script is executed when the login shell exits.
+#
+# USAGE:
+# This script is automatically executed when the login shell exits.
 
+# Clear console output
 if [ "$SHLVL" = 1 ]; then
     [ -x /usr/bin/clear_console ] && /usr/bin/clear_console -q
 fi

system/.bash_profile

@@ -1,12 +1,20 @@
 #!/bin/bash
+# 
+# SCRIPT NAME:
+# .bash_profile
 #
-# Author: Severin Kaderli <severin.kaderli@gmail.com>
+# AUTHOR:
-# We just source .bashrc so we don't need to manage two files.
+# Severin Kaderli <severin.kaderli@gmail.com>
+#
+# DESCRIPTION:
+# This script is called when you start a login shell.
+#
+# USAGE:
+# This script is automatically executed when you start a login shell.
 if [[ -f "${HOME}/.bashrc" ]]; then
     . "${HOME}/.bashrc"
 fi
 
-# Setting keyboard colors
 if [[ -f "${HOME}/.keyleds" ]]; then
     . "${HOME}/.keyleds"
 fi

system/.bashrc

@@ -1,4 +1,16 @@
 #!/bin/bash
+# 
+# SCRIPT NAME:
+# .bashrc
+#
+# AUTHOR:
+# Severin Kaderli <severin.kaderli@gmail.com>
+#
+# DESCRIPTION:
+# This script is called when you start a new shell.
+#
+# USAGE:
+# This script is automatically executed when you start a new shell.
 
 # Bash configuration
 shopt -s histappend

system/.env

@@ -1,7 +1,18 @@
 #!/bin/bash
+# 
+# SCRIPT NAME:
+# .env
+#
+# AUTHOR:
+# Severin Kaderli <severin.kaderli@gmail.com>
+#
+# DESCRIPTION:
+# This file contains declarations of environment variables.
+#
+# USAGE:
+# This script is sourced by .bashrc
 . "${HOME}/bin/utils.sh"
 
-
 # Bash
 export HISTCONTROL=ignoreboth
 export HISTSIZE=1000

system/.keyleds

@@ -1,6 +1,17 @@
 #!/bin/bash
+# 
+# SCRIPT NAME:
+# .keyleds
 #
-# Author: Severin Kaderli <severin.kaderli@gmail.com>
+# AUTHOR:
+# Severin Kaderli <severin.kaderli@gmail.com>
+#
+# DESCRIPTION:
+# This file contains configurations for my keyboard backlight.
+#
+# USAGE:
+# This script is sourced by .bash_profile
+
 # Key groups
 g810-led -g keys FF4500
 g810-led -g fkeys FF00FF

system/.xinitrc

@@ -1,19 +1,15 @@
 #!/bin/bash
-# Disable screen saver
+# 
-xset s off
+# SCRIPT NAME:
-xset -dpms
+# .xinitrc
-xset s noblank
+#
-
+# AUTHOR:
-# Set keyboard layout
+# Severin Kaderli <severin.kaderli@gmail.com>
-setxkbmap -model pc105 -layout ch
+#
-
+# DESCRIPTION:
-# Start ibus
+# This is the startup script when you start the x-server.
-ibus-daemon -drx
+#
-
+# USAGE:
-
+# This script is executed when you start the x-server.
-. "${HOME}/bin/resolution.sh"
+. "${HOME}/.xsetup"
-xrandr --setprovideroutputsource modesetting NVIDIA -0
-xrandr --auto
-
-# Start i3
 i3

system/.xprofile

@@ -1,15 +1,17 @@
 #!/bin/bash
-# Disable screen saver
+# 
-xset s off
+# SCRIPT NAME:
-xset -dpms
+# .xprofile
-xset s noblank
+#
-
+# AUTHOR:
-# Set keyboard layout
+# Severin Kaderli <severin.kaderli@gmail.com>
-setxkbmap -model pc105 -layout ch
+#
-
+# DESCRIPTION:
-# Start ibus
+# This is the startup script when LightDM starts. Currently it sources .xsetup
-ibus-daemon -drx
+# and .bash_profile so it's almost the same as if you start the x-server
-
+# manually.
-if [[ -f "${HOME}/.bash_profile" ]]; then
+#
-	. "${HOME}/.bash_profile"
+# USAGE:
-fi
+# This script is executed when LightDM starts.
+. "${HOME}/.xsetup"
+. "${HOME}/.bash_profile"

system/.xsetup

@@ -0,0 +1,25 @@
+#!/bin/bash
+# 
+# SCRIPT NAME:
+# .xsetup
+#
+# AUTHOR:
+# Severin Kaderli <severin.kaderli@gmail.com>
+#
+# DESCRIPTION:
+# This file setups things that should by started by the x-server like the
+# ibus-daemon and the keyboard layout.
+#
+# USAGE:
+# This script is sourced by both .xinitrc and .xprofile
+xset s off
+xset -dpms
+xset s noblank
+
+# Set keyboard layout
+setxkbmap -model pc105 -layout ch
+
+# Start ibus
+ibus-daemon -drx
+
+. "${HOME}/bin/resolution.sh"