define(`_TITLE', `guide to software')dnl define(`_DESCRIPTION', `do not read')dnl define(`_PAGE', `software/')dnl define(`_STYLE', `')dnl define(`_nothing', `')dnl include(`../html.m4')dnl include(`../head.m4')dnl
include(`../navreturn.m4')dnlDue to the majority of designers having typical ability, use of computers may be significantly more challenging for users with disabilities, especially affecting sight and reading. Change in this regard for those that simply lack the facilities to read but have the patience to do so is inevitable but slow, with current measures being proprietary (designed first to make money and second for function) or sorely lacking in actual useability. Helping users with a deeper inability to read extensively is a tougher problem to which the solution may not yet be known even vaguely. The only advice I can offer is that everyone should, until the point at which it harms others, see to the removal of obstacles to their ability, without hesitation or apology. If you give up on computing, so be it. There are more valuable things to explore in life.
Computers encase lightning within sand with the purpose of creating a lifelike inanimate robot that can consider particularly boring thought. Measures should be taken to avoid attachment, whether mental, emotional, or physical, to computers. Caution can accompany admiration. Ultimately, the humans were the ones that produced the computers, and computers amplify human flaws as well as human feats. Try to be kind to everyone but don't take anything too seriously.
This guide encompasses usage of IBM-compatible, amd64 processor architecture computers, particularly with POSIX and other UNIX-like operating systems like Linux and DragonflyBSD. Non-standard, proprietary operating systems such as VMS, OS/2, Z/OS, and Microsoft Windows are out of scope. Plan 9 from Bell Labs, due to its historical relationship with UNIX, will be mentioned when appropriate.
Don't use _code(`echo(1)'), use _code(`printf(1)'). _code(`printf(1)') simulates the _code(`printf(3)') function in the C standard I/O library which has no significant variations, whereas the functionality of _code(`echo(1)') can vary between vendors.
_code(`printf "%s" "$*"') does not work as _code(`echo(1)') though it's been said to do so (including by this page).
The following is an implementation of _code(`echo(1)') in the C programming language, using the standard library.
#include <stdio.h> int main(int argc, char *argv[]) { int i; for(i = 1; ; ) { printf("%s", argv[i]); ++i; if(i == argc) { putchar('\n'); break; } else putchar(' '); } return 0; }
The following is an implementation of _code(`echo(1)') in shell.
while :; do printf "%s" "$1" `shift' if test -z "$1"; then printf "\n" break else printf " " fi done
A particularly shoddy attempt at _code(`ed(1)') is provided by _code(`busybox'). A traditional _code(`ed(1)') implementation is in plan9ports. I'm pretty sure some later UNIX-based OSes doubled the _code(`ed(1)') buffers, there's pretty much no downside to doing so in the modern era but it should be very easy to do yourself if it hasn't already been done (just double some of the array sizes in the beginning of _code(`ed.c')).
The Advanced Configuration and Power Interface, or ACPI, is the interface through which the operating system and client programs can control features in your computer's firmware. Usually this is used with an ACPI client or opaquely controlled by the operating environment.
On Linux, _code(`acpi(1)') can be used to read and control ACPI events manually. _code(`acpid(8)'), _code(`elogind(8)'), SystemD, and many desktop environments can control the ACPI automatically.
On NetBSD, see _code(`acpi(4)').
For compilation, _code(`tcc(1)'), _code(`gcc(1)'), and _code(`clang(1)') are all reasonable choices depending on your needs.
On Alpine Linux, the standard library headers are in the _code(`musl-dev') package.
In most system package managers, standard library documentation can be found in the _code(`man-pages') and _code(`man-pages-posix') packages.
Many Linux software distributions' system package managers have meta-packages that pull all necessities for C development as dependencies. Alpine has _code(`build-base') and Debian has _code(`build-essential').
For linking to libraries, see _hyperlink(`#pkg-config', `pkg-config').
See _code(`fstab(5).')
postmarketOS requires that the _code(`localmount') OpenRC service be enabled for the system to read _code(`fstab(5)').
Arch and Artix have fstab generators at _code(`genfstab(8)') and _code(`fstabgen(8)') respectively in their installation scripts.
Most audio servers recommend that they be run in userspace with user privileges, with PulseAudio going so far as to exiting when run as root without additional configuration. The Alpine wiki currently recommends _code(`pipewire(1)'), with postmarketOS, which is based on Alpine, coming pre-configured with PipeWire. PipeWire is relatively new and the typical audio server used is PulseAudio; Debian and many popular Debian-based distributions come pre-configured with PulseAudio.
The Alpine wiki ("Adding sound") says to install _code(`alsa-conf'), _code(`alsa-lib'), and _code(`alsa-utils'), add yourself to the _code(`audio') group, and then do some more configuration that I've never needed to do: Use _code(`alsamixer(1)') to find a working sound card (press _code(`F6') from the first screen ALSAMixer presents) and edit _code(`/usr/share/alsa/alsa.conf') and change _code(`defaults.ctl.card') and _code(`defaults.pcm.card') to the sound card that works.
The Alpine wiki doesn't mention this but you'll need to enable the _code(`alsa') OpenRC service and either start it or reboot. I also installed _code(`gstreamer') but I don't know why.
ALSA is clunky, many people prefer to use a frontend such as Pipewire or PulseAudio that exposes its own interface while remaining compatible with ALSA.
Deprecated, unfortunately.
Provided by the _code(`pipewire') package on Alpine.
RTKit error: org.freedesktop.DBus.Error.ServiceUnknown
This means you need _code(`rtkit') installed and running through your initialization system.
On Alpine you'll need the _code(`pulseaudio'), _code(`pulseaudio-alsa'), and _code(`alsa-plugins-pulse') packages for PulseAudio with ALSA compatibility. Start _code(`pulseaudio(1)') when you want audio, ideally in your _code(`.xinitrc').
Linux is usually obtained as part of a software distribution put together to form a useable operating system.
Alpine doesn't include man pages in program packages to save on space, instead keeping them in _code(`[package]-doc') sibling packages. To always install doc packages with program packages, _code(`apk add docs').
Arch is known for using the latest versions of programs, which has given it an undeserved reputation of instability.
Use _code(`pacstrap(8)').
At a minimum you need the _code(`base') package. Select a kernel and install the corresponding package; _code(`linux'), _code(`linux-lts'), or another Linux configuration or fork. The Arch wiki says you need to install _code(`linux-firmware'), this isn't strictly necessary but it is recommended. Install _code(`base-devel') if you plan on using the AUR or if you don't know what the AUR is yet.
It's also a good idea to install any utilities you'll need on the bootstrapped system. Text editors, network managers or utilities, and other administration tools, for example. Manual utilities such as _code(`man-db') and others would also be useful.
From the annals of my notes, 2021-06-04:
Had an issue with pacman missing some ubiquitous packages (esr's `ascii`, xorg-xev, etc). This fixed it. I don't really know why - maybe some issues with my repos? This was cleanly installed artix-openrc. [5:46 PM] Bassman Leyla: So what I did is I went into /etc/pacman.d/mirrorlist-arch and uncommented a local mirror [5:46 PM] Bassman Leyla: Then I appended a config block a package maintainer gave me onto /etc/pacman.conf [5:46 PM] Bassman Leyla: I'll paste it in [5:47 PM] Bassman Leyla: ``` # # ARCHLINUX # #[testing] #Include = /etc/pacman.d/mirrorlist-arch [extra] Include = /etc/pacman.d/mirrorlist-arch #[community-testing] #Include = /etc/pacman.d/mirrorlist-arch [community] Include = /etc/pacman.d/mirrorlist-arch #[multilib-testing] #Include = /etc/pacman.d/mirrorlist-arch #[multilib] #Include = /etc/pacman.d/mirrorlist-arch ```
Artix refers to the series of Arch derivatives which use initialization systems other than SystemD's.
This process differs from Arch's bootstrapping process. Artix uses _code(`basestrap(8)') rather than _code(`pacstrap(8)'); you need to select the initialization you want to use: _code(`66'), _code(`dinit'), _code(`openrc'), _code(`runit'), or _code(`s6-base'), as a package separate from _code(`base'); and Artix's official wiki says you need to install the appropriate _code(`elogind') package (_code(`elogind-[initialization system]') e.g. _code(`elogind-66')) but like _code(`linux-firmware') though it is helpful it isn't strictly necessary.
Debian is known for its stability and longevity. Debian uses SystemD as its initialization system, the GNU core utilities, and dpkg and apt for package management.
While it's possible to use non-Linux kernels within Debian, it's uncommon and the only non-Linux option currently maintained is the GNU HURD microkernel.
pkgsrc can be used on Debian.
postmarketOS is an Alpine-based Linux software distribution that makes configuring and using Linux easy on mobile devices.
By default, postmarketOS will generate a random software MAC address when connecting to a new WLAN network. You can disable this by adding a NetworkManager rule. In _code(`/etc/NetworkManager/conf.d/') you can make a file with any name that has the following:
[device] wifi.scan-rand-mac-address=no
On a live system you can then _code(`rc-service networkmanager restart') to restart NetworkManager and have it load the new configuration.
Ubuntu is a derivative of Debian.
logind (_code(`systemd-logind.service(8)')) is a component of SystemD that exposes information about active users on the system via the org.freedesktop.login1 D-Bus interface which is used by the popular desktop environments GNOME and KDE. It also handles ACPI events. It can be configured in _code(`logind.conf(5)').
On systems without SystemD and with conflicting software, _code(`elogind(8)') may be used.
Xenia was an entry for the Linux logo competition which Tux eventually won.
_code(`make(1)') in modern times is fragmented into the GNU version (in context, _code(`gmake')) and the {Free,Open,Net}BSD version (_code(`bmake')). Complex Makefiles may not be useable in both. It's custom for Linux systems to have _code(`make(1)') as GNU Make and _code(`bmake(1)') as BSD Make, and BSD-based systems to have _code(`make(1)') as BSD Make and _code(`gmake(1)') as GNU Make.
In the context of POSIX and UNIX-like systems, an "on-line" manual is a manual that is accessible via the computer system it documents. Particularly, the _code(`man(1)') utility and the manual "pages" it references.
Alpine by default uses _code(`mandoc').
_code(`less(1)') is _code(`more(1)'); more or less.
Don't use partitioners included with OS media where the same job can be done by GParted (which has live media available) or another good general-purpose partitioner. BSDs and Plan 9 are exceptions to this rule due to their exotic partitioning systems. Using utilities from a shell or TUIs does not make you "cooler" than someone who needs a GUI for partitioning; in some cases, messing up partitioning can have serious consequences, so it's always nice to have some idiot-proofing. I always partition my disks with the GParted live media.
You should do your own research on how you should partition your disks. I personally use separate partitions for /boot, /home, /, and swap. Your needs will vary.
Please note that a separate boot partition is mandatory if you intend to boot via (U)EFI. Check out the linked pages in the "See also" section.
Use _code(`mkfs(8)') for creating filesystems and _code(`mount(8)') for mounting partitions' filesystems.
Available as _code(`sysutils/gpart') in pkgsrc.
_code(`gpart(8)') is a tool that scans a file (or block device presented as a file) for drive partitions regardless of any table present on the medium.
_code(`e2fsprogs') is needed for the _code(`dm_mod') kernel module used for LUKS partition decryption.
To format a partition to a LUKS volume, determine the physical block device location for that partition and run _code(`cryptsetup luksFormat [partition]'). The passphrase used can be changed or removed after creation.
To open a LUKS volume, use _code(`cryptsetup luksOpen [partition] [name]'). This name is the name the decrypted block device location will take in _code(`/dev/mapper/').
Before the decrypted block device has a filesystem it'll just be cleared space - format as normal but use the decrypted block device location.
To mount a partition in an opened LUKS volume, use _code(`mount(8)') as normal, just with the decrypted block device location.
To close an open LUKS volume, _code(`umount(8)') any mapped and mounted partitions from the volume and _code(`cryptsetup luksClose [name]').
To make the LUKS partition openable via keyfile, first make a keyfile (_code(`dd if=/dev/urandom of=/root/keyfile bs=1024 count=4') seems to work), and optionally make it readable by root only (_code(`chmod 0400 [keyfile]')). Then add the keyfile to the partition's LUKS header with _code(`cryptsetup luksAddKey [physical partition block device] [keyfile]').
_code(`dm-crypt') is a service that automatically mounts LUKS volumes at boot.
On most OpenRC-initialized distributions, the _code(`cryptsetup-openrc') package provides _code(`dmcrypt'). Make sure that service is added to runlevel boot.
Configuration is in _code(`/etc/conf.d/dmcrypt') and further configuration should be done in _code(`fstab'). _code(`dm-crypt') will need the UUID of the physical block device while fstab (if being configured with UUIDs will need the UUID of the decrypted block device in the device mapper.
_code(`envstat(1)') can show the current battery status.
Install _code(`filesystems/fuse') and _code(`filesystems/fuse-ext2'). _code(`disklabel(8)') will list ext4 filesystems as of type "Linux Ext2". Use _code(`fuse-ext2(1)') to mount the filesystem.
_code(`fuse-ext2(1)') is spotty in places and may not work correctly.
Install _code(`filesystems/fuse') and _code(`filesystems/fuse-exfat'). Use _code(`mount.exfat') to mount the filesystem (the manual page for which is _code(`mount.exfat-fuse(8)')).
Install _code(`security/mozilla-rootcerts-openssl').
Do not use SSL workarounds like (in the case of git) _code(`GIT_SSL_NO_VERIFY'). These leave your system open to man-in-the-middle attacks.
If using Mullvad, you have to change the shebang on _code(`update-resolv-conf(8)') (a standalone Bash script included in the OpenVPN configurations from Mullvad, intended to be placed in _code(`/etc/openvpn/')) from _code(`#!/bin/bash') to _code(`#!/usr/pkg/bin/bash') if using Bash from pkgsrc or another appropriate location if using a different package manager.
See _code(`syslogd(8)') and _code(`syslog.conf(5)'), which pertain to system logging.
Setting _code(`DDB_ONPANIC') (see _code(`options(4)') and _code(`sysctl(8)')) will save a crash dump at _code(`/var/crash') on kernel panic.
Available as _code(`sysutils/pciutils') from pkgsrc. Supplies _code(`lspci(8)'), _code(`setpci(8)'), and _code(`update-pciids(8)').
_code(`update-pciids(8)') is not part of the _code(`pciutils') package in Alpine Linux repositories.
NetBSD includes _code(`pcictl(8)') which offers similar functionality. _code(`pcictl pci0 list') outputs roughly the same information as _code(`lspci(8)'), though _code(`lspci(8)') may offer slightly more detailed information.
pkg-config provides a way to link to libraries independent of a particular system's directory heirarchy.
The relevant manual pages on NetBSD are _code(`pkgconf(1)'), _code(`pc(5)'), and _code(`pkg.m4(7)').
Try _code(`pkg_admin(1)').
See _code(`pkgtools/pkg_rolling_replace').
Power is managed by ACPI.
SSH keys are typically stored in _code(`$HOME/.ssh').
Typically, the public key's filename will be suffixed with _code(`.pub'), while the private key will not.
You can generate an SSH key with _code(`ssh-keygen(1)'). Currently the preferred implementation is _code(`openssh-keygen'), part of the OpenSSH suite.
Microsoft GitHub documentation suggests a user create a key with _code(`ssh-keygen -t ed25519 -C "[e-mail address]"'). This generates an Ed25519 SSH key with an e-mail address in the key comment.
_code(`top(1)') comes with busybox, otherwise use _code(`htop').
_code(`nano(1)') is a text editor that's usually recommended for beginners because its controls are more intuitive. _code(`ne(1)') is like _code(`nano(1)') but with different superpowers. Not yet in pkgsrc.
Unlike _code(`busybox')'s _code(`ed(1)') implementation, its _code(`vi(1)') is very useable. _code(`vim(1)') is a popular re-implementation of _code(`vi(1)').
Emacs ("editor macros") is a text editor with a very powerful Lisp interpreter included. Lisp is mostly antiquated due to its undeserved lack of popularity. Linus Torvalds uses his own fork of uEmacs ("micro Emacs"), an Emacs without the Lisp interpreter(?).
Technically _code(`cat(1)') and other UNIX utilities can be used in a hacky way for text editing functions. You'd be better off using _code(`ed(1)'); the UX is very similar.
_code(`true(1)') is a tool that only quits silently with an exit status of 0. Similarly, _code(`false(1)') is a tool that only quits silently with an exit status of 1. Recognizing arguments, printing to standard output, reading from standard input, or otherwise exiting with any other status of 0, is a violation of the POSIX specification for _code(`true(1)'). These utilities find use in shell scripting, which, though extremely relevant to these utilities, is beyond the scope of this article.
Because _code(`true(1)')'s required functionality is so simple a POSIX-compliant implementation is a one-liner in most languages, so long as you're willing to make an exception in your code styling. For example, in C:
int main(void) { return 0; }
Because executing an empty shellscript file will in most shells do nothing and return an exit status of 0, technically an empty shellscript file is a POSIX-compliant _code(`true(1)') implementation in 0 bytes. This was the _code(`true(1)') implementation on early versions of UNIX, including Research UNIX, System V, and Sun's Solaris, according to both Rob Pike and John Chambers. A more explicit implementation also exists in POSIX shell:
#!/bin/sh exit 0
This happens to be nearly identical in source to the implementation used by NetBSD.
Python has the same 0 byte _code(`true(1)') implementation feature as most shells. Here's _code(`false(1)') in Python rather than _code(`true(1)') to demonstrate how exiting with an arbitrary exit status can be done:
import sys sys.exit(1)
In some shells, _code(`true(1)') is a shell built-in command, so running _code(`true') will run the shell author's implementation of _code(`true(1)') rather than the system implementation.
GNU _code(`true(1)'), from the GNU coreutils, is well known for being a maximalist implementation - it's eighty lines long and directly includes four C header files. Their _code(`true.c') is 2.3 kilobytes and parses the arguments _code(`--help') and _code(`--version') (only if either are the first argument to the program). The GNU coreutils implementation of _code(`true(1)') is not POSIX compliant.
_code(`util-linux') is distributed on all popular Linux distributions and contains utilities users may expect to be already present on their systems, like _code(`more(1)') or _code(`hexdump(1)').
_code(`wpa_supplicant(1)') is usually good enough for establishing WiFi connections.
Here's an example configuration for a simple WPA-2 PSK access point.
network={ ssid="My SSID" key_mgmt=WPA-PSK scan_ssid=1 psk="My password" }
See _code(`wpa_supplicant.conf(5)').
X is a graphical windowing system that can be used on Linux, FreeBSD, OpenBSD, NetBSD, and some proprietary operating systems as well. X is not the only windowing system; _code(`twin(1)') exists for windowed multitasking within a framebuffer and Wayland is another windowing system intended to replace X.
Xorg requires the user to be a member of the _code(`input') and _code(`video') groups (or superuser), otherwise it won't be able to access the relevent device files. These errors look like _code(`Failed to open /dev/input/event[number] (Permission denied)') when not in the _code(`input') group and _code(`Failed to open /dev/tty[number] (Permission denied)') when not in the _code(`video') group.
Some Linux software distributions have included scripts to automatically fetch and install an X server. Alpine has _code(`setup-xorg-base'), which adds the packages _code(`xorg-server'), _code(`xf86-input-libinput'), _code(`eudev'), and _code(`mesa'), and then enables the OpenRC services for udev.
_code(`startx(1)') is provided as part of xinit.
Arch has the _code(`xorg') and _code(`xorg-apps') package groups. Documentation can be found within _code(`xorg-docs'), drivers within the _code(`xorg-drivers') package group, the server itself as _code(`xorg-server'), the X event monitor as _code(`xorg-xev'), xinit as _code(`xorg-xinit'), xinput as _code(`xorg-xinput'), XRandR as _code(`xorg-xrandr'), the X resource database manager as _code(`xorg-xrdb'), xset as _code(`xorg-xset'), and xsetroot as _code(`xorg-xsetroot').
Alpine has xinput as _code(`xinput').
_code(`mpv(1)') and _code(`vlc(1)') are good options.
It's possible to make X exec a window manager at the end of initialization to ease the creation, deletion, and manipulation of windows. Contrary to what is now popular belief, window managers are not necessary (thought they're extremely convenient compared to the lack of them).
TOR Browser is available through pkgsrc at _code(`security/tor-browser').