phundrak/dotfiles

Fork 0

Lucien Cartier-Tilet 73c629afc4

continuous-integration/drone/push Build is passing

Details

[Misc] Move files to XDG user dirs

2022-06-07 19:45:58 +02:00

26 KiB

Raw Blame History

Fish config

Presentation
Fish from within Emacs
Global variables
Tramp remote access
Regular fish shell appearance
Setting up external tools
- Starship configuration
- Loading zoxide
Abbreviations
- System monitoring
- System management (packages and services)
  - Package management
  - Service management
- Development
  - CMake
  - Docker
  - Text editors
  - Compilation
  - Git
- LaTeX
- Some security measures
- Typos
- Misc
  - Media
  - Sudo
  - History
  - Compression
  - exa
  - Network Management
  - NordVPN
  - Wget
Last thing before we’re done

Presentation

The file present in ~/.config/fish/config.fish is the configuration file for the fish shell. It contains custom functions, environment variables and abbreviations.

Just in case, we might need sometimes to declare the fish function fish_title as true, so let’s do so.

function fish_title
    true
end

Fish from within Emacs

I sometimes call fish from within emacs, with M-x ansi-term. In this case, the variable TERM needs to have the value eterm-color.

if test -n "$EMACS"
    set -x TERM eterm-color
end

Global variables

In order to keep some other code clean, I set the $BROWSER variable so I don’t have to call my web browser directly but rather with this variable.

set -gx BROWSER firefox

Sometimes, software will rely on SUDO_ASKPASS to get a GUI from which it can get the sudo password. So, let’s declare it.

set -gx SUDO_ASKPASS ~/.local/bin/askpass

In general, I prefer using bat to less, although the former relies on the latter, but bat provides nice wrapping around less, including syntax highlighting. Let’s set the manpager to bat then:

set -x MANPAGER "sh -c 'col -bx | bat -l man -p'"

XMODIFIERS is set to nothing as to not impede Emacs’ inputs.

set -x XMODIFIERS

Let’s start the Gnome keyring daemon. It will return a variable which must be set.

if test -n "$DESKTOP_SESSION"
    set -x (gnome-keyring-daemon --start | string split "=")
end

XDG user directories

There’s a couple of XDG user directories that are not set, let’s fix that.

set -x XDG_CACHE_HOME  $HOME/.cache
set -x XDG_CONFIG_HOME $HOME/.config
set -x XDG_DATA_HOME   $HOME/.local/share
set -x XDG_STATE_HOME  $HOME/.local/state

Now, let's clean the $HOME directory. Be aware it will require quite a few lines.

set -x HISTFILE "$XDG_STATE_HOME"/bash/history
set -x _Z_DATA "$XDG_DATA_HOME"/z
set -x XAUTHORITY "$XDG_RUNTIME_DIR"/Xauthority
set -x WINEPREFIX "$XDG_DATA_HOME"/wine
set -x TEXMFVAR "$XDG_CACHE_HOME"/texlive/texmf-var
set -x RUSTUP_HOME "$XDG_DATA_HOME"/rustup
set -x BUNDLE_USER_CONFIG "$XDG_CONFIG_HOME"/bundle
set -x BUNDLE_USER_CACHE "$XDG_CACHE_HOME"/bundle
set -x BUNDLE_USER_PLUGIN "$XDG_DATA_HOME"/bundle
set -x PYLINTHOME "$XDG_CACHE_HOME"/pylint
set -x PYENV_ROOT "$XDG_DATA_HOME"/pyenv
set -x PASSWORD_STORE_DIR "$XDG_DATA_HOME"/pass
set -x PARALLEL_HOME "$XDG_CONFIG_HOME"/parallel
set -x _JAVA_OPTIONS -Djava.util.prefs.userRoot="$XDG_CONFIG_HOME"/java
set -x NVM_DIR "$XDG_DATA_HOME"/nvm
set -x CUDA_CACHE_PATH "$XDG_CACHE_HOME"/nv
set -x __GL_SHADER_DISK_CACHE_PATH "$XDG_CACHE_HOME"/nv
set -x NUGET_PACKAGES "$XDG_CACHE_HOME"/NuGetPackages
set -x NPM_CONFIG_USERCONFIG "$XDG_CONFIG_HOME"/npm/npmrc
set -x TERMINFO "$XDG_DATA_HOME"/terminfo
set -x TERMINFO_DIRS "$XDG_DATA_HOME"/terminfo:/usr/share/terminfo
set -x MPLAYER_HOME "$XDG_CONFIG_HOME"/mplayer
set -x ICEAUTHORITY "$XDG_CACHE_HOME"/ICEauthority
set -x LESSHISTFILE "$XDG_CACHE_HOME"/less/history
set -x GTK2_RC_FILES "$XDG_CONFIG_HOME"/gtk-2.0/gtkrc
set -x GOPATH "$XDG_DATA_HOME"/go
set -x GNUPGHOME "$XDG_DATA_HOME"/gnupg
set -x GEM_HOME "$XDG_DATA_HOME"/gem
set -x GEM_SPEC_CACHE "$XDG_CACHE_HOME"/gem
set -x DOCKER_CONFIG "$XDG_CONFIG_HOME"/docker
set -x CARGO_HOME "$XDG_DATA_HOME"/cargo

Development

Now, let’s declare our editor of choice, EmacsClient; not Emacs itself since it will most often be just quick edits, nothing too heavy, if it is called from the EDITOR variable (from Git, for example), or from the VISUAL variable.

set -gx EDITOR emacsclient -c
set -gx VISUAL emacsclient -c

We also need to set the path to the Dart SDK.

set -gx DART_SDK /opt/dart-sdk/bin

And we also need to specify where the Android SDK it located.

set -gx ANDROID_HOME $HOME/Android/Sdk

Still related to Dart and Flutter development,

set -gx CHROME_EXECUTABLE /usr/bin/chromium

Next, we have two variables from Deno, the Node.js destroyer. Its base directory will be set in my XDG config directory, and its binaries will be located in my local binaries directory (see below).

set -gx DENO_DIR $HOME/.config/deno
set -gx DENO_INSTALL_ROOT $HOME/.local/bin/deno

Finally, some development packages require the PKG_CONFIG_PATH to be set, so let’s do so.

set -gx PKG_CONFIG_PATH /usr/local/lib/pkgconfig/ $PKG_CONFIG_PATH

`$PATH`

A variable available with the fish shell is fish_user_paths which lists custom paths to binaries specified by the user. Using this variable ensures they are included in the $PATH variable only once without the need to set it directly. For instance, my PATH variable needs Rust’s Cargo’s binaries, Go’s binaries, my own executables, and some more.

additional path	what it leads to
$HOME/.local/bin	Custom executables, see /phundrak/dotfiles/src/commit/914bfdb3b64a175d1192083b2faa1e3bc2e351b9/org/config/bin.org
$GOPATH/bin	Go binaries and executables
$CARGO_HOME/bin	Rust binaries and executables
$GEM_HOME/ruby/3.0.0/bin	Ruby 3.0 binaries and executables
$GEM_HOME/ruby/2.6.0/bin	Ruby 2.6 binaries and executables
$HOME/.cabal/bin	Haskel binaries
/usr/lib/xfce-polkit	Path to XFCE’s PolKit

$HOME/.local/bin \
$GOPATH/bin \
$CARGO_HOME/bin \
$GEM_HOME/ruby/3.0.0/bin \
$GEM_HOME/ruby/2.6.0/bin \
$HOME/.cabal/bin \
/usr/lib/xfce-polkit

So, let’s set our user paths:

set -g fish_user_paths \
<<generate-extra-paths()>>

Tramp remote access

When accessing from a remote machine our computer from Emacs, tramp needs a precise shell appearance: a simple $ followed by a space after which to put the commands it needs to execute, and nothing else. Due to this, let’s deactivate and redefine some of the functions defining the appearance of fish.

if test "$TERM" = "dumb"
    function fish_prompt
        echo "\$ "
    end
    function fish_right_prompt; end
    function fish_greeting; end
    function fish_title; end
end

Regular fish shell appearance

Now, there is only one function I modify when it comes to the appearance of fish when I’m the one using it: the fish_greeting function. I use it to display the output of a utility I wrote.

function fish_greeting
    which pumo-system-info 2&> /dev/null && pumo-system-info
end

For my fish prompt, I use starship, a shell-agnostic prompt. Let’s load it:

starship init fish | source

Setting up external tools

Starship configuration

As mentioned above, starship is a shell-agnostic prompt, written in Rust and which can be configured separately from the shell. I decided to configure it here though, since fish is the only shell I use which is compatible with starship.

First I’ll modify the default format variable, removing the modules I don’t need.

format = """
$username\
$hostname\
$shlvl\
$singularity\
$kubernetes\
$directory\
$vcsh\
$git_branch\
$git_commit\
$git_state\
$git_metrics\
$git_status\
$hg_branch\
$docker_context\
$package\
$cmake\
$dart\
$deno\
$lua\
$nodejs\
$python\
$rlang\
$rust\
$scala\
$zig\
$memory_usage\
$env_var\
$custom\
$cmd_duration\
$line_break\
$jobs\
$battery\
$time\
$status\
$shell\
$character"""

I want starship to be able to detect Lisp files, be it CommonLisp or EmacsLisp. Unfortunately, it seems nerd-font doesn’t have any symbol for either language, so I’m just using a lambda character.

[custom.lisp]
extensions = ["lisp", "el"]
symbol = "λ "
style = "bold green"

Finally, let’s disable all modules I don’t need.

[cobol]
disable = true
[dotnet]
disable = true
[elixir]
disable = true
[elm]
disable = true
[erlang]
disable = true
[golang]
disable = true
[helm]
disable = true
[java]
disable = true
[julia]
disable = true
[kotlin]
disable = true
[nim]
disable = true
[ocaml]
disable = true
[perl]
disable = true
[php]
disable = true
[pulumi]
disable = true
[purescript]
disable = true
[red]
disable = true
[ruby]
disable = true
[swift]
disable = true
[terraform]
disable = true
[vlang]
disable = true
[vagrant]
disable = true
[nix_shell]
disable = true
[conda]
disable = true
[aws]
disable = true
[gcloud]
disable = true
[openstack]
disable = true
[crystal]
disable = true

Loading `zoxide`

zoxide is a smarter cd command, accessible through z. It can be loaded like so:

zoxide init fish | source

Abbreviations

Abbreviations are a great way to keep correctly track of which commands are run in the shell without polluting the history of the shell with obscure commands. When typing an abbreviation, fish will replace it with replace it with its expanded equivalent. Below are some of the abbreviations I use. Be aware some of them that invoke GUI programs can be invoked through devour which will make the terminal disappear while the program runs, and once the GUI program exists the terminal window will come back.

System monitoring

Here I have some abbreviations which are quite useful when performing some system monitoring. With df, we can get an overview of our filesystem usage, while with diskspace we get some more precise information. meminfo is a call to free with sane defaults, and similar to meminfo, we also have gpumeminfo so we can get a quick look at the memory-related logs of our X session. I also declared cpuinfo an alias of lscpu in order to keep consistent with meminfo. pscpu gives us information on what the CPU is running right now, and pscpu10 limits that to the top 10 threads. Similarly, psmem gives us information on the memory usage of the current threads, and psmem10 only the ten most important threads in terms of memory usage.

abbreviation	command
df	df -H
diskspace	sudo df -h \| grep -E "sd\|lv\|Size"
du	du -ch
meminfo	free -m -l -t
gpumeminfo	grep -i –color memory /var/log/Xorg.0.log
cpuinfo	lscpu
pscpu	ps auxf \| sort -nr -k 3
pscpu10	ps auxf \| sort -nr -k 3 \| head -10
psmem	ps auxf \| sort -nr -k 4
psmem10	ps auxf \| sort -nr -k 4 \| head -10

<<generate-abbr(table=mgmt-abbr)>>

System management (packages and services)

I added some of these abbreviations due to how often I have to write the whole thing.

Package management

The first command is remove which removes a package from my system, as well as its dependencies no longer needed. p. pacman's or paru's. This is why I simply type purge. And if I want to simply seach among the pacman repos, I can type search. Otherwise, if I want to include AUR results, I’ll use paru.

abbreviation	command
remove	sudo pacman -Rsc
purge	paru -Sc

<<generate-abbr(table=pm-abbr)>>

Service management

I don’t have the muscle memory of systemctl. So instead, I simply type c when I want to do something user service related. And if I want to manipulate system services, I can instead type a simple capital S.

abbreviation	command
s	systemctl
suser	systemctl –user

<<generate-abbr(table=service-abbr)>>

Development

A good amount of these commands are development related, especially when it comes to compilation or Docker.

CMake

I have the following abbreviations so I can quickly run CMake and create a configuration for debug or release profiles.

abbreviation	command
cdebug	cmake -DCMAKE_BUILD_TYPE=Debug
crelease	cmake -DCMAKE_BUILD_TYPE=Release