/configuration-files

Primary LanguageShell

Portable custom configuration files

This repository contains the custom configuration files for various programs (currently including bash and vim) I am using which I think have sharing values.

These files are designed to be as portable as possible, which I am currently using on Debian, Ubuntu and Windows machines.

install.sh is a helper script to list and copy the available files. If run with the option -a, it will copy all available files automatically.

CMD

autoexec.cmd

This provides a customized prompt with colours similar to the Bash prompt shown below, and with user name and host name prepended before the working directory.

Add registry entry HKCU\Software\Microsoft\Command Processor with AutoRun as key, REG_EXPAND_SZ as type, and %HOMEDRIVE%%HOMEPATH%\autoexec.cmd as value to enable the script.

colours.cmd

This is sourced from autoexec.cmd to provide colours

Bash

.bashrc

This is modified from the default .bashrc found on Ubuntu systems, which contains the following features.

Fedora-style prompt

I have changed the style of the prompt from Ubuntu's default user@host:dir$ to Fedora's [user@host dir]$ because I think the latter is more readable.

Prompt colouring

When colouring is enabled, the prompt is coloured according to the effective user of the shell:

  • green if the shell is running as yourself;
  • yellow if the shell is running as another user;
  • red if the shell is running as root, or started as an "administrative user" under Microsoft Windows.

Moreover, to alert the user if the shell is currently accessed over an SSH session, the host name is coloured red and printed bold if SSH related environment variables are found, which reduce the chance of typing commands into the wrong machine. This will not work if sudo clears the environment variables.

Git integration

.bashrc makes use of __git_ps1 to show the current git status on the prompt. If __git_ps1 is not found, it will attempt to load one from ~/.git-prompt.sh. If it is still not found, a stub is defined and git integration is not available.

Chroot prompt

If running inside a Debian chroot, the chroot is prepended into the prompt.

xterm title

The current [user@host dir] is shown on the xterm title.

.bash_aliases

This is sourced from .bashrc to provide useful aliases and shell functions.

.colours

This is sourced from .bashrc to define variables for colour escape sequences.

Fish

`.config/fish/functions/{fish_prompt,prompt_login,prompt_chroot}.fish

The prompt is similar to the bash prompt as describe above, with the difference that $ is replaced by > when running as non-administrator.

Customisation of colours

The prompt above uses some variables which can be used to configure the colours:

  • fish_color_prompt: The prompt colour when running as a normal user. Set to green in config.fish.
  • fish_color_prompt_sudo: The prompt colour when running as another user via sudo. Set to yellow in config.fish.
  • fish_color_prompt_root: The prompt colour when running as root. Set to red in config.fish.
  • fish_color_cwd: The cwd colour when running as a normal user. Set to brblue in config.fish.
  • fish_color_cwd_sudo: The cwd colour when running as another user via sudo. Unset in config.fish.
  • fish_color_cwd_root: The cwd colour when running as another user via root. Unset in config.fish.
  • fish_color_status: The colour to show the status code of the last command. Defaults to red.
  • fish_color_chroot: The colour to show the chroot. Defaults to yellow.
  • fish_color_user: The colour to show the user name. Unset in config.fish.
  • fish_color_host: The colour to show the host name. Unset in config.fish.
  • fish_color_host_root: The colour to show the host name. If not set use fish_color_host. Unset in config.fish.
  • fish_color_host_remote: The colour to show the host name. If not set use fish_color_host. Unset in config.fish.
  • fish_color_host_remote_root: The colour to show the host name. If not set use fish_color_host_remote, fish_color_host_root, fish_color_host in order. Unset in config.fish.

.config/fish/config.fish

This provides some customisations of the prompt

`.config/fish/functions/fish_is_root_user.fish

This overrides the default function to provide better detection for administrator rights on Windows systems.

PowerShell

.config/powershell/profile.ps1

The prompt is similar to the bash prompt as describe above, with the difference that $ or # is replaced by > multipled by the number of nested prompt.

If posh-git is installed, it will be loaded to show git info.

Vim

.vimrc

This loads the example vimrc and set some configuration options which I think is better.

.gvimrc

This loads the example gvimrc and set a prettier font.

Git

.gitignore_global

This file contains a list of backup files and OS-generated files which should be ignored by git. Apply it by git config --global core.excludesfile '~/.gitignore_global'