main amadaluzia/webfetch / docs / USING.md

You've decided you want to use webfetch? This document should help you create a template for it. If you do not understand how you would even begin creating a template, feel free to read the following resources:

What variables can I use in my templates?

There are quite a few, some admittedly redundant ones as well.

.OS

The operating system running webfetch.

Example: NixOS 26.05 (Yarara)

.Hostname

The hostname of the system running webfetch.

Example: napoleon

.Username

The username of the user running webfetch.

Example: artur

.KernelRelease

The release of the kernel you are using.

Example: 6.18.26

.KernelName

The name of the kernel you are using.

Example: Linux

.MachineArch

The architecture of your current machine.

Example: x86_64

.Shell

The shell you have set for your user.

Example: /bin/bash

.Uptime

The systems total uptime.

Example: 67 days, 6 hours, 7 minutes, 0 seconds

.Terminal

The terminal set for your user.

This may be removed in the future.

Example: alacritty

.MemTotal

The total amount of memory you have, in kilobytes.

Example: 24529152

.MemFree

The amount of free memory you have, in kilobytes.

Example: 6063104

.MemAvailable

The amount of available memory you have, in kilobytes.

Example: 18333340

.DesktopInfo

The name of the desktop environment and display server you are using.

Example: KDE Plasma (Wayland)

.Locale

Your systems locale.

Example: en_US

I imagine you added functions too, right?

There are a few functions I added specifically for math. Go templates surprisingly do not actually have the ability to do math. I don't need to go into much detail for these functions.