2022-12-01 19:53:50 +01:00

2.2 KiB

Raw Blame History

title
Knowledge Base

Linux Knowledgebase

This is a list of quickstart guides for Linux programs, designed to get the user up and running as fast as possible.

Style

Praxis Only

We leave theory alone as much as possible. The documentation should be of the form 'if you want X, type Y'.

We don't need to explain what a program does - anyone looking up 'how to X', already knows what they want to do. We don't even need to explain which program to use - if someone wants to combine an mp4 and webm video into a single video file, they only care about that result, not about learning ffmpeg.

Any interest in these tools only comes after we can use them.

Chronological

Entries should read like scripts - everything in the right order, with small notes on what this does.

The chronology should never branch. If gitea can use three different types of database, the documentation should simply pick one and continue instructions from there. Repetition works better than a reference - if a database requires three commands to set up, it's better to repeat those three commands for every program that requires a database than to just link to another file which discusses databases.

Three Input Types

There are three types of examples:

Fixed input:

ls

Arbitrary Input shows the non-fixed input in italics:

ls myFile.txt

Output shows as unformatted text:

    LK           img
    Mail         kn
    Projects     music

Example

How to see which websites you're actively accessing:

> ss -tr dst :443

What's wrong with everything else?

Man pages

Orders items by the alphabet rather than by relevance.
Often presumes you know everything except that one program.
Often written in the 80's, and it shows.
Zero respect for your time.

curl cheat.sh/

Doesn't have the programs I like.
Too short to get you started on many programs.
Poor understanding of priority (git stash is covered before git commit).

Current State

This started as a few personal notes, and will probably continue to look like that for some time. It's a bit of a mess.

Systemd is taken as a default. Non-systemd commands we relegate to their respective distros, e.g. runit for Void Linux.

2.2 KiB Raw Blame History