@fredlackey/devutils 0.0.1 → 0.0.2

package/src/installs/lsb-release.md

@@ -0,0 +1,814 @@
+# Installing lsb-release
+
+## Overview
+
+The `lsb-release` utility provides information about the Linux Standard Base (LSB) and distribution-specific information. It is a simple command-line tool that displays details about your Linux distribution, including:
+
+- **Distributor ID**: The name of the distribution (e.g., Ubuntu, Debian, Raspbian)
+- **Description**: A human-readable description of the distribution
+- **Release**: The release version number
+- **Codename**: The development codename (e.g., jammy, bookworm)
+
+The Linux Standard Base was a standardization effort led by the Linux Foundation to promote compatibility across Linux distributions. While the LSB standard itself was discontinued in 2015 and is no longer actively maintained, the `lsb_release` command remains widely used for identifying Linux distributions in scripts, automation tools, and system administration tasks.
+
+**Important Note**: The `lsb-release` utility is Linux-specific and is not available on macOS or Windows. On these platforms, alternative commands provide similar system information. This documentation covers installation on Linux platforms and documents the alternatives for non-Linux platforms.
+
+## Dependencies
+
+### macOS (Homebrew)
+- **Required:** None (lsb-release is not available on macOS)
+- **Optional:** None
+- **Auto-installed:** None
+- **Note:** macOS is not a Linux distribution and does not support LSB. Use `sw_vers` for macOS version information instead.
+
+### Ubuntu (APT/Snap)
+- **Required:** None (APT package manager is pre-installed on Ubuntu)
+- **Optional:** None
+- **Auto-installed:** None
+
+### Raspberry Pi OS (APT/Snap)
+- **Required:** None (APT package manager is pre-installed on Raspberry Pi OS)
+- **Optional:** None
+- **Auto-installed:** None
+
+### Amazon Linux (DNF/YUM)
+- **Required:** None (lsb-release is not available on Amazon Linux)
+- **Optional:** None
+- **Auto-installed:** None
+- **Note:** Amazon Linux 2023 does not ship with `lsb_release` and does not include the `system-lsb-core` package. Use `/etc/os-release` for distribution information instead.
+
+### Windows (Chocolatey/winget)
+- **Required:** None (lsb-release is not available on Windows)
+- **Optional:** None
+- **Auto-installed:** None
+- **Note:** Windows is not a Linux distribution and does not support LSB.
+
+### Git Bash (Manual/Portable)
+- **Required:** None (lsb-release is not available in Git Bash)
+- **Optional:** None
+- **Auto-installed:** None
+- **Note:** Git Bash runs on Windows and does not support Linux-specific utilities like lsb-release.
+
+## Prerequisites
+
+Before installing lsb-release on supported platforms, ensure:
+
+1. **Internet connectivity** - Required to download packages
+2. **Administrative privileges** - Required for system-wide installation (sudo on Linux)
+3. **Terminal access** - Required to run installation commands
+4. **Linux operating system** - lsb-release is only available on Linux distributions
+
+## Platform-Specific Installation
+
+### macOS (Homebrew)
+
+#### Platform Support Status
+
+**lsb-release is NOT available on macOS.**
+
+macOS is not a Linux distribution and does not implement the Linux Standard Base. The `lsb_release` command does not exist on macOS, and there is no Homebrew formula to install it.
+
+#### Alternative: Using sw_vers
+
+macOS provides the `sw_vers` command for obtaining system version information. This command is pre-installed on all macOS systems and requires no additional installation.
+
+Run the following command to display macOS version information:
+
+```bash
+sw_vers
+```
+
+Expected output (version numbers may vary):
+
+```
+ProductName:            macOS
+ProductVersion:         14.2.1
+BuildVersion:           23C71
+```
+
+**Additional commands for macOS system information:**
+
+```bash
+# Get just the macOS version number
+sw_vers -productVersion
+
+# Get detailed system information
+system_profiler SPSoftwareDataType
+
+# Get kernel information
+uname -a
+```
+
+#### Verification
+
+Verify that `sw_vers` is available (it should be pre-installed):
+
+```bash
+which sw_vers
+```
+
+Expected output:
+
+```
+/usr/bin/sw_vers
+```
+
+---
+
+### Ubuntu/Debian (APT)
+
+#### Prerequisites
+
+- Ubuntu 20.04 LTS or later, or Debian 11 (Bullseye) or later
+- sudo privileges
+- Internet connectivity
+
+On most Ubuntu and Debian installations, `lsb-release` is pre-installed. However, some minimal installations or container images may not include it.
+
+#### Installation Steps
+
+Run the following commands to install lsb-release:
+
+```bash
+sudo DEBIAN_FRONTEND=noninteractive apt-get update -y
+sudo DEBIAN_FRONTEND=noninteractive apt-get install -y lsb-release
+```
+
+The `DEBIAN_FRONTEND=noninteractive` environment variable ensures no interactive prompts appear during installation, making this suitable for scripts and automation.
+
+#### Verification
+
+Confirm the installation succeeded:
+
+```bash
+lsb_release --version
+```
+
+Expected output (version numbers may vary):
+
+```
+lsb_release 11.1.0ubuntu4
+```
+
+Display all distribution information:
+
+```bash
+lsb_release -a
+```
+
+Expected output for Ubuntu (version numbers may vary):
+
+```
+No LSB modules are available.
+Distributor ID: Ubuntu
+Description:    Ubuntu 24.04 LTS
+Release:        24.04
+Codename:       noble
+```
+
+**Note**: The "No LSB modules are available" message is normal and does not indicate an error. It simply means that the full LSB compliance packages are not installed, which is typical and does not affect the functionality of `lsb_release`.
+
+Verify the installation location:
+
+```bash
+which lsb_release
+```
+
+Expected output:
+
+```
+/usr/bin/lsb_release
+```
+
+#### Troubleshooting
+
+**Problem**: `lsb_release: command not found`
+
+**Solution**: The package is not installed. Install it:
+
+```bash
+sudo DEBIAN_FRONTEND=noninteractive apt-get update -y
+sudo DEBIAN_FRONTEND=noninteractive apt-get install -y lsb-release
+```
+
+**Problem**: `E: Unable to locate package lsb-release`
+
+**Solution**: Update your package lists first:
+
+```bash
+sudo DEBIAN_FRONTEND=noninteractive apt-get update -y
+sudo DEBIAN_FRONTEND=noninteractive apt-get install -y lsb-release
+```
+
+**Problem**: Using `lsb-release` instead of `lsb_release` in commands
+
+**Solution**: The package name uses a hyphen (`lsb-release`), but the command uses an underscore (`lsb_release`). Use the underscore when running the command:
+
+```bash
+# Correct command syntax
+lsb_release -a
+
+# Incorrect (this will fail)
+# lsb-release -a
+```
+
+**Problem**: Permission denied errors
+
+**Solution**: Ensure you are using sudo for installation:
+
+```bash
+sudo DEBIAN_FRONTEND=noninteractive apt-get install -y lsb-release
+```
+
+Note that running `lsb_release` itself does not require sudo.
+
+---
+
+### Raspberry Pi OS (APT)
+
+#### Prerequisites
+
+- Raspberry Pi OS (Bookworm or Bullseye recommended)
+- Raspberry Pi 3B+ or later (any model supported by Raspberry Pi OS)
+- sudo privileges
+- Internet connectivity
+
+Raspberry Pi OS is based on Debian, so `lsb-release` installation follows the same method. On most Raspberry Pi OS installations, `lsb-release` is pre-installed by default.
+
+#### Installation Steps
+
+First, verify your architecture:
+
+```bash
+uname -m
+```
+
+- `aarch64` = 64-bit ARM
+- `armv7l` = 32-bit ARM
+
+Install lsb-release using APT (the command is identical for both architectures):
+
+```bash
+sudo DEBIAN_FRONTEND=noninteractive apt-get update -y
+sudo DEBIAN_FRONTEND=noninteractive apt-get install -y lsb-release
+```
+
+#### Verification
+
+Confirm the installation succeeded:
+
+```bash
+lsb_release --version
+```
+
+Expected output (version numbers may vary):
+
+```
+lsb_release 12.0
+```
+
+Display all distribution information:
+
+```bash
+lsb_release -a
+```
+
+Expected output for Raspberry Pi OS (version numbers may vary):
+
+```
+No LSB modules are available.
+Distributor ID: Raspbian
+Description:    Raspbian GNU/Linux 12 (bookworm)
+Release:        12
+Codename:       bookworm
+```
+
+**Note for 64-bit Raspberry Pi OS**: On 64-bit installations, the Distributor ID may show "Debian" instead of "Raspbian":
+
+```
+No LSB modules are available.
+Distributor ID: Debian
+Description:    Debian GNU/Linux 12 (bookworm)
+Release:        12
+Codename:       bookworm
+```
+
+Verify the installation location:
+
+```bash
+which lsb_release
+```
+
+Expected output:
+
+```
+/usr/bin/lsb_release
+```
+
+#### Troubleshooting
+
+**Problem**: Installation is slow
+
+**Solution**: Raspberry Pi SD cards can be slow. Use a high-quality SD card (Class 10 or A1/A2 rated) or boot from USB/SSD for better performance.
+
+**Problem**: `E: Unable to fetch some archives`
+
+**Solution**: Network connectivity issues. Check your internet connection and retry:
+
+```bash
+sudo DEBIAN_FRONTEND=noninteractive apt-get update -y
+sudo DEBIAN_FRONTEND=noninteractive apt-get install -y lsb-release
+```
+
+**Problem**: Distributor ID shows "Debian" instead of "Raspbian"
+
+**Solution**: This is expected on 64-bit Raspberry Pi OS, which is based directly on Debian arm64. The functionality is identical regardless of the distributor ID.
+
+**Problem**: `lsb_release: command not found` despite package being installed
+
+**Solution**: Close and reopen your terminal, then verify the package is installed:
+
+```bash
+dpkg -l | grep lsb-release
+```
+
+---
+
+### Amazon Linux (DNF/YUM)
+
+#### Platform Support Status
+
+**lsb-release is NOT available on Amazon Linux 2023 (AL2023).**
+
+Amazon Linux 2023 does not ship with the `lsb_release` command and does not include the `system-lsb-core` package. Amazon has transitioned to the `/etc/os-release` standard, which is the modern replacement for LSB-based distribution identification.
+
+Amazon Linux 2 (AL2) may have the `system-lsb-core` package available through `yum`, but this is discouraged as AL2 reaches end of support on June 30, 2026.
+
+#### Alternative: Using /etc/os-release
+
+The `/etc/os-release` file is pre-installed on Amazon Linux and requires no additional packages. This is the recommended method for obtaining distribution information.
+
+Run the following command to display distribution information:
+
+```bash
+cat /etc/os-release
+```
+
+Expected output for Amazon Linux 2023 (version numbers may vary):
+
+```
+NAME="Amazon Linux"
+VERSION="2023"
+ID="amzn"
+ID_LIKE="fedora"
+VERSION_ID="2023"
+PLATFORM_ID="platform:al2023"
+PRETTY_NAME="Amazon Linux 2023.6.20241212"
+ANSI_COLOR="0;33"
+CPE_NAME="cpe:2.3:o:amazon:amazon_linux:2023"
+HOME_URL="https://aws.amazon.com/linux/amazon-linux-2023/"
+DOCUMENTATION_URL="https://docs.aws.amazon.com/linux/"
+SUPPORT_URL="https://aws.amazon.com/premiumsupport/"
+BUG_REPORT_URL="https://github.com/amazonlinux/amazon-linux-2023"
+VENDOR_NAME="AWS"
+VENDOR_URL="https://aws.amazon.com/"
+SUPPORT_END="2028-03-15"
+```
+
+**Extract specific information using shell commands:**
+
+```bash
+# Get the distribution name
+grep "^NAME=" /etc/os-release | cut -d'"' -f2
+
+# Get the version
+grep "^VERSION_ID=" /etc/os-release | cut -d'"' -f2
+
+# Get the pretty name
+grep "^PRETTY_NAME=" /etc/os-release | cut -d'"' -f2
+```
+
+**Using shell variables for scripting:**
+
+```bash
+# Source the file to get variables
+source /etc/os-release
+
+# Now you can use the variables directly
+echo "Distribution: $NAME"
+echo "Version: $VERSION_ID"
+echo "Pretty Name: $PRETTY_NAME"
+```
+
+#### Verification
+
+Verify that `/etc/os-release` exists:
+
+```bash
+test -f /etc/os-release && echo "os-release exists" || echo "os-release not found"
+```
+
+Expected output:
+
+```
+os-release exists
+```
+
+#### Troubleshooting
+
+**Problem**: Scripts that depend on `lsb_release` fail on Amazon Linux
+
+**Solution**: Update your scripts to use `/etc/os-release` instead. Create a wrapper function for backward compatibility:
+
+```bash
+# Add this function to scripts that need lsb_release compatibility
+lsb_release_compat() {
+  if command -v lsb_release &> /dev/null; then
+    lsb_release "$@"
+  elif [ -f /etc/os-release ]; then
+    source /etc/os-release
+    case "$1" in
+      -i|--id) echo "Distributor ID: $ID" ;;
+      -d|--description) echo "Description: $PRETTY_NAME" ;;
+      -r|--release) echo "Release: $VERSION_ID" ;;
+      -c|--codename) echo "Codename: ${VERSION_CODENAME:-n/a}" ;;
+      -a|--all)
+        echo "Distributor ID: $ID"
+        echo "Description: $PRETTY_NAME"
+        echo "Release: $VERSION_ID"
+        echo "Codename: ${VERSION_CODENAME:-n/a}"
+        ;;
+      *) echo "Usage: lsb_release_compat [-i|-d|-r|-c|-a]" ;;
+    esac
+  else
+    echo "Neither lsb_release nor /etc/os-release available" >&2
+    return 1
+  fi
+}
+```
+
+**Problem**: Need to determine if running on Amazon Linux in a script
+
+**Solution**: Check for the Amazon Linux identifier in `/etc/os-release`:
+
+```bash
+if grep -q "^ID=amzn" /etc/os-release 2>/dev/null; then
+  echo "Running on Amazon Linux"
+fi
+```
+
+---
+
+### Windows (Chocolatey/winget)
+
+#### Platform Support Status
+
+**lsb-release is NOT available on Windows.**
+
+Windows is not a Linux distribution and does not implement the Linux Standard Base. The `lsb_release` command is a Linux-specific utility with no direct equivalent on Windows.
+
+#### Alternative: Using PowerShell
+
+Windows provides PowerShell commands for obtaining system version information. These commands are pre-installed on all modern Windows systems.
+
+Run the following command in PowerShell to display Windows version information:
+
+```powershell
+Get-ComputerInfo | Select-Object WindowsProductName, WindowsVersion, OsBuildNumber
+```
+
+Expected output (version numbers may vary):
+
+```
+WindowsProductName WindowsVersion OsBuildNumber
+------------------ -------------- -------------
+Windows 11 Pro     22H2           22631
+```
+
+**Additional commands for Windows system information:**
+
+```powershell
+# Get OS version using systeminfo
+systeminfo | findstr /B /C:"OS Name" /C:"OS Version"
+
+# Get Windows version number
+[System.Environment]::OSVersion.Version
+
+# Get detailed OS information
+Get-CimInstance -ClassName Win32_OperatingSystem | Select-Object Caption, Version, BuildNumber, OSArchitecture
+```
+
+**From Command Prompt:**
+
+```cmd
+ver
+systeminfo | findstr /B /C:"OS Name" /C:"OS Version"
+```
+
+#### Verification
+
+Verify that PowerShell commands are available (they should be pre-installed):
+
+```powershell
+Get-Command Get-ComputerInfo
+```
+
+---
+
+### WSL (Ubuntu)
+
+#### Prerequisites
+
+- Windows 10 version 2004 or higher, or Windows 11
+- WSL 2 enabled with Ubuntu distribution installed
+- sudo privileges within WSL
+
+WSL runs Ubuntu (or another Linux distribution) within Windows. Because WSL runs a real Linux distribution, `lsb-release` is available and works exactly as it does on native Ubuntu.
+
+#### Installation Steps
+
+Open your WSL Ubuntu terminal and run:
+
+```bash
+sudo DEBIAN_FRONTEND=noninteractive apt-get update -y
+sudo DEBIAN_FRONTEND=noninteractive apt-get install -y lsb-release
+```
+
+**Note**: On most WSL Ubuntu installations, `lsb-release` is pre-installed by default. Running the installation command will either install the package or confirm it is already installed.
+
+#### Verification
+
+Confirm the installation succeeded:
+
+```bash
+lsb_release --version
+```
+
+Expected output (version numbers may vary):
+
+```
+lsb_release 11.1.0ubuntu4
+```
+
+Display all distribution information:
+
+```bash
+lsb_release -a
+```
+
+Expected output (version numbers may vary):
+
+```
+No LSB modules are available.
+Distributor ID: Ubuntu
+Description:    Ubuntu 24.04 LTS
+Release:        24.04
+Codename:       noble
+```
+
+Verify the installation location:
+
+```bash
+which lsb_release
+```
+
+Expected output:
+
+```
+/usr/bin/lsb_release
+```
+
+#### Troubleshooting
+
+**Problem**: `lsb_release: command not found` in WSL
+
+**Solution**: Install the package:
+
+```bash
+sudo DEBIAN_FRONTEND=noninteractive apt-get update -y
+sudo DEBIAN_FRONTEND=noninteractive apt-get install -y lsb-release
+```
+
+**Problem**: WSL shows a different Ubuntu version than expected
+
+**Solution**: Check which WSL distribution you are running:
+
+```bash
+# From within WSL
+cat /etc/os-release
+
+# From Windows PowerShell
+wsl --list --verbose
+```
+
+You may have multiple WSL distributions installed. Ensure you are using the correct one.
+
+**Problem**: Permission denied errors
+
+**Solution**: Ensure you are using sudo for installation:
+
+```bash
+sudo DEBIAN_FRONTEND=noninteractive apt-get install -y lsb-release
+```
+
+---
+
+### Git Bash (Manual/Portable)
+
+#### Platform Support Status
+
+**lsb-release is NOT available in Git Bash.**
+
+Git Bash is a terminal emulator that runs on Windows and provides a Bash shell environment. However, it does not include Linux-specific system utilities like `lsb_release`. Git Bash is designed to provide Git functionality and common Unix utilities, not to replicate a full Linux environment.
+
+#### Alternative: Using Windows Commands from Git Bash
+
+From Git Bash, you can execute Windows commands to obtain system information:
+
+```bash
+# Get Windows version using cmd
+cmd //c ver
+
+# Get OS information using PowerShell
+powershell -Command "Get-ComputerInfo | Select-Object WindowsProductName, WindowsVersion"
+```
+
+Expected output (version numbers may vary):
+
+```
+Microsoft Windows [Version 10.0.22631.4460]
+```
+
+**If you need lsb_release functionality**, use WSL instead of Git Bash. WSL provides a full Linux environment where `lsb_release` works natively.
+
+#### Verification
+
+Verify that Windows commands are accessible from Git Bash:
+
+```bash
+cmd //c ver
+```
+
+If this command produces output showing the Windows version, Windows commands are accessible from Git Bash.
+
+---
+
+## Post-Installation Configuration
+
+The `lsb_release` command requires no post-installation configuration. It reads system information from files already present on the system and has no user-configurable settings.
+
+### Common Usage Patterns
+
+Here are common ways to use `lsb_release` in scripts and automation:
+
+**Get all information:**
+
+```bash
+lsb_release -a
+```
+
+**Get specific fields:**
+
+```bash
+# Distributor ID only (e.g., "Ubuntu")
+lsb_release -is
+
+# Release number only (e.g., "24.04")
+lsb_release -rs
+
+# Codename only (e.g., "noble")
+lsb_release -cs
+
+# Description only (e.g., "Ubuntu 24.04 LTS")
+lsb_release -ds
+```
+
+**Use in conditional logic:**
+
+```bash
+# Check if running on Ubuntu
+if [ "$(lsb_release -is 2>/dev/null)" = "Ubuntu" ]; then
+  echo "Running on Ubuntu"
+fi
+
+# Check if running on Debian or a Debian-based distribution
+if lsb_release -is 2>/dev/null | grep -qiE "^(debian|ubuntu|raspbian)$"; then
+  echo "Running on a Debian-based distribution"
+fi
+```
+
+**Portable script pattern (works with or without lsb_release):**
+
+```bash
+get_distro() {
+  if command -v lsb_release &> /dev/null; then
+    lsb_release -is
+  elif [ -f /etc/os-release ]; then
+    grep "^ID=" /etc/os-release | cut -d'=' -f2 | tr -d '"'
+  else
+    echo "unknown"
+  fi
+}
+
+DISTRO=$(get_distro)
+echo "Detected distribution: $DISTRO"
+```
+
+---
+
+## Common Issues
+
+### Issue: "No LSB modules are available"
+
+**Symptoms**: Running `lsb_release -a` displays "No LSB modules are available" before the distribution information.
+
+**Solution**: This message is informational, not an error. It indicates that the full LSB compliance packages (`lsb-core`, `lsb-graphics`, etc.) are not installed. The `lsb_release` command still functions correctly and displays distribution information. No action is required unless you specifically need LSB compliance modules.
+
+### Issue: lsb_release Not Available in Container Images
+
+**Symptoms**: `lsb_release: command not found` in Docker containers or minimal OS images.
+
+**Solution**: Minimal container images often exclude `lsb-release` to reduce image size. Install it if needed, or use `/etc/os-release` as an alternative:
+
+```bash
+# In Debian/Ubuntu containers
+apt-get update && apt-get install -y lsb-release
+
+# Or use /etc/os-release (no installation needed)
+cat /etc/os-release
+```
+
+### Issue: Scripts Fail on Non-Linux Platforms
+
+**Symptoms**: Scripts that use `lsb_release` fail on macOS, Windows, or Amazon Linux.
+
+**Solution**: Write portable scripts that check for `lsb_release` availability before using it:
+
+```bash
+#!/bin/bash
+if command -v lsb_release &> /dev/null; then
+  DISTRO=$(lsb_release -is)
+elif [ -f /etc/os-release ]; then
+  source /etc/os-release
+  DISTRO=$ID
+elif command -v sw_vers &> /dev/null; then
+  DISTRO="macOS"
+else
+  DISTRO="unknown"
+fi
+
+echo "Detected: $DISTRO"
+```
+
+### Issue: lsb_release Shows Wrong Information
+
+**Symptoms**: The output of `lsb_release` does not match the actual distribution.
+
+**Solution**: The `lsb_release` command reads from `/etc/lsb-release` or `/etc/os-release`. If these files are corrupted or modified, the output may be incorrect. Verify the source files:
+
+```bash
+# Check lsb-release file
+cat /etc/lsb-release
+
+# Check os-release file
+cat /etc/os-release
+```
+
+If the files are incorrect, reinstall the `lsb-release` package:
+
+```bash
+sudo DEBIAN_FRONTEND=noninteractive apt-get install --reinstall -y lsb-release
+```
+
+### Issue: Command Not Found Despite Package Being Installed
+
+**Symptoms**: `dpkg -l | grep lsb-release` shows the package is installed, but `lsb_release` command is not found.
+
+**Solution**: The command may not be in your PATH. Locate the binary and run it directly:
+
+```bash
+# Find the binary
+dpkg -L lsb-release | grep bin
+
+# Run directly
+/usr/bin/lsb_release -a
+```
+
+If `/usr/bin` is not in your PATH, add it:
+
+```bash
+export PATH="/usr/bin:$PATH"
+```
+
+---
+
+## References
+
+- [Ubuntu Manpage: lsb_release](https://manpages.ubuntu.com/manpages/jammy/man1/lsb_release.1.html)
+- [Debian Wiki: LSB](https://wiki.debian.org/LSB)
+- [Linux Standard Base - Wikipedia](https://en.wikipedia.org/wiki/Linux_Standard_Base)
+- [freedesktop.org: os-release specification](https://www.freedesktop.org/software/systemd/man/os-release.html)
+- [Amazon Linux 2023 User Guide](https://docs.aws.amazon.com/linux/al2023/ug/)
+- [Raspberry Pi Documentation](https://www.raspberrypi.com/documentation/)
+- [Microsoft WSL Documentation](https://learn.microsoft.com/en-us/windows/wsl/)
+- [Apple sw_vers Manual](https://ss64.com/osx/sw_vers.html)