Compare commits

..

No commits in common. "master" and "master" have entirely different histories.

130 changed files with 571 additions and 1165 deletions

View File

@ -1,71 +0,0 @@
MAKEFLAGS += -j
MAKEFLAGS += -s
EDITOR ?= vi
FZF != command -v sk || command -v fzy || command -v fzf || \
{ echo install a fuzzy finder && exit 1 ;}
help: ## Print the help message
@awk 'BEGIN {FS = ":.*?## "} /^[0-9a-zA-Z._-]+:.*?## / {printf "\033[36m%s\033[0m : %s\n", $$1, $$2}' $(MAKEFILE_LIST) | \
sort | \
column -s ':' -t
articles != find * -type f -name "*.md"
categories != ls -d */
databases = $(patsubst %/, .dbs/%.rec, $(categories))
default += $(databases)
$(databases): .dbs/%.rec: %/ | .dbs/
$(info making $(@F))
mkdir -p $(@D)
for entry in $(shell find $< -type f -name "*.md") ; do \
sed -n '2,/^---$$/ {/^---$$/d; p}' "$$entry" |\
sed -e 's/\[ //' -e 's/ \]//' |\
tr -d '"' ;\
printf "wordcount: %s\n" "$$(wc -w < $$entry)" ;\
printf "file: %s\n\n" "$$entry" ;\
done >> $@
for entry in $(shell find $< -type f -name "*.md"); do \
recset $@ -e "file = '$${entry}'" -f wordcount --set-add="$$(wc -w < $${entry})" ;\
done
db.rec: $(databases)
printf '%s\n' '%rec: guide' > $@
printf '%s\n' '%type: wordcount int' >> $@
printf '%s\n\n' '%sort: title' >> $@
cat $^ >> $@
recsel $@ -e "requires != ''" -CR title,requires |\
while read title requires; do \
IFS=', ' && for provider in $$requires; do \
recset $@ -e "title = '$${provider}'" -f provides -a "$${title}" ;\
done ;\
done
$(info Created main database: $@)
recfix --sort $@
default += db.rec
.git/info/exclude: $(default)
echo $^ | tr ' ' '\n' > $@
default += .git/info/exclude
.PHONY: database
database: $(default) ## Make a recfiles database
.PHONY: article
article: ## Write an article
@path=$$(find $(categories) -type d | sort | uniq | $(FZF)) ;\
read -p "Title: " title ;\
filename="$$(echo "$$title" | tr '[:upper:]' '[:lower:]' | tr ' ' '_')" ;\
printf '%s\n' '---' >> $$path/$$filename.md ;\
printf 'title: "%s"\n' "$$title" >> $$path/$$filename.md ;\
printf 'tags: [ "%s" ]\n' "$$path" | sed 's#\/#", "#g' >> $$path/$$filename.md ;\
printf '%s\n\n' '---' >> $$path/$$filename.md ;\
$(EDITOR) +5 "$$path/$$filename.md"
.PHONY: clean
clean: ## Remove all generated files
$(RM) $(default)

104
README.md
View File

@ -1,79 +1,77 @@
--- ---
title: "Linux Knowledge Base" title: "Knowledge Base"
--- ---
The Linux Knowledge-Base provides quick-start guides for working with terminal programs. # Linux Knowledgebase
# Setup This is a list of quickstart guides for Linux programs, designed to get the user up and running as fast as possible.
Install `make`, `recutils`, and any fuzzy-finder (i.e. `sk`, `fzy`, or `fzf`).
## Usage
```sh
make
make database
recsel db.rec -q database
recsel db.rec -q gpg
recsel db.rec -e "title = 'ssh'"
recsel db.rec -e "title ~ 'ssh'"
recsel db.rec -e "title ~ 'bash'" -R title,wordcount
```
# Style # Style
## No History, No Context ## Praxis Only
- Nobody cares about how the project started. We leave theory alone as much as possible.
- Nobody wants to read what `ffmpeg` is, because anyone who wants to use it already knows what it is. The documentation should be of the form 'if you want *X*, type *Y*'.
## Be Opinionated 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`.
- Guides should not ask the reader to select options half-way through. Any interest in these tools only comes after we can use them.
- Options for different filesystems, databases, et c., should be written as separate guides.
## Repetition Beats Reference ## Chronological
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. Entries should read like scripts - everything in the right order, with small notes on what this does.
## Show Arguments as Variables 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.
Look at this line: ---
```sh ### Closing
grep ls --color=always $HISTFILE | less -R
Introductory documents should show anything required to cleanly uninstall a program, without leaving bulky configuration files behind.
## Three Input Types
There are three types of examples:
Fixed input:
```bash
ls
``` ```
What else can go in place of `always`? Anything with arbitrary input should be shown as a variable.
Can you say `--color=red`?
Can you put anything?
The answer is not obvious.
What about this line: ```bash
ls $FILE
```sh
git branch new
git checkout new
``` ```
Do you always use `new`? Non-commands (e.g. output) should be shown as quoted text:
Can you use another word here?
The answer is not obvious.
It's better to make all arbitrary values variables. > LK img
> Mail kn
> Projects music
```sh ---
git branch $branch_name
git checkout $branch_name # Example
PAGER='less -R'
grep ls --color=always $HISTFILE | $PAGER ```
How to see which websites you're actively accessing:
` ` `bash
ss -tr dst :$PORT
` ` ` ` ` `
Now we can see what can be changed. > State Recv-Q Send-Q Local Address:Port Peer Address:Port Process
> ESTAB 0 0 192.168.0.14:42476 149.154.167.91:https
> ESTAB 0 0 192.168.0.14:43644 104.17.90.199:https
# What's Wrong with Everything Else? ```
# What's wrong with everything else?
## Man pages ## Man pages
@ -81,14 +79,12 @@ Now we can see what can be changed.
- Often presumes you know everything except that one program. - Often presumes you know everything except that one program.
- Often written in the 80's, and it shows. - Often written in the 80's, and it shows.
- Zero respect for your time. - Zero respect for your time.
- Often references `info` pages (yuck).
## `curl cheat.sh` ## curl cheat.sh/
- Doesn't have the programs I like. - Doesn't have the programs I like.
- Too short to get you started on many programs. - Too short to get you started on many programs.
- Poor understanding of priority (`git stash` is covered before `git commit`). - Poor understanding of priority (`git stash` is covered before `git commit`).
- Repetitive
# Current State # Current State

View File

@ -6,20 +6,7 @@ tags: [ "fun" ]
- `asciiquarium` - `asciiquarium`
- `cbonsai -lim "$(fortune)"` - `cbonsai -lim "$(fortune)"`
```sh ```bash
cow=$(cowsay -l | sort -R | head -1) cow=$(cowsay -l | sort -R | head -1)
fortune -s | figlet | cowsay -nf $cow | lolcat fortune -s | figlet | cowsay -nf $cow | lolcat
``` ```
Watch the [Collatz Conjecture](https://en.wikipedia.org/wiki/Collatz_conjecture) collapse:
```sh
x="$(du -sc ~/.cache | tr -d '[:alpha:]' | tail -1)"
until [ "$x" -eq "1" ]; do
test "$(( x % 2 ))" -eq 0 && x=$(( x / 2 )) || \
x=$(( x * 3 + 1 ))
clear -x
figlet "$x" | lolcat
sleep 1
done
```

View File

@ -1,6 +1,6 @@
--- ---
title: "at" title: "at"
tags: [ "Basics", "time" ] tags: [ "Documentation", "Basics" ]
--- ---
Install with: Install with:

View File

@ -1,6 +1,6 @@
--- ---
title: "Basics" title: "Basics"
tags: [ "Basics" ] tags: [ "Documentation", "Basics" ]
--- ---
You need about a dozen commands to move around Linux. You need about a dozen commands to move around Linux.
@ -342,12 +342,11 @@ apt install $PROGRAM
Remove `lolcat`, because it's useless: Remove `lolcat`, because it's useless:
```sh ```bash
sudo apt remove lolcat sudo apt remove lolcat
``` ```
...and that's pretty much it. ... and that's pretty much it. You can move, create, destroy, install things, and look things up.
You can move, create, destroy, install things, and look things up.
# Review # Review

View File

@ -1,6 +1,6 @@
--- ---
title: "clock" title: "clock"
tags: [ "Basics", "time" ] tags: [ "Documentation", "Basics" ]
--- ---
Show system time: Show system time:

View File

@ -1,36 +0,0 @@
---
title: "column"
tags: [ "basics", "format", "json" ]
---
Put output into column.
```bash
du -h /etc/* | column
```
Reformat file with an explicit separator (`-s`):
```bash
column -ts: /etc/passwd
```
Give columns names (`-N`), so you can hide some (`-H`):
```bash
column -ts: -N User,PW,UID,GID,Description,Home,shell -H PW,GID /etc/passwd
```
Reorder with `-O` (unspecified items remain):
```bash
column -ts: -N User,PW,UID,GID,Description,Home,shell -H PW,GID -O User,Description,shell /etc/passwd
```
Output to json format with `-J`:
```bash
column -J -ts: -H PW,GID,shell -N User,PW,UID,GID,Description,Home,shell /etc/passwd
```

View File

@ -1,6 +1,6 @@
--- ---
title: "conditionals" title: "conditionals"
tags: [ "Basics" ] tags: [ "Documentation", "Basics" ]
--- ---
# If statements # If statements

View File

@ -1,6 +1,6 @@
--- ---
title: "cron" title: "cron"
tags: [ "Basics", "time" ] tags: [ "Documentation", "Basics" ]
--- ---
# Cronie # Cronie

View File

@ -1,6 +1,6 @@
--- ---
title: "bash games" title: "bash games"
tags: [ "Games" ] tags: [ "Documentation", "Games" ]
--- ---
Games are a great way to learn bash. Games are a great way to learn bash.

View File

@ -1,6 +1,6 @@
--- ---
title: "kernel" title: "kernel"
tags: [ "Basics" ] tags: [ "Documentation", "Basics" ]
--- ---
## Living Space ## Living Space

View File

@ -1,6 +1,6 @@
--- ---
title: "kill" title: "kill"
tags: [ "Basics" ] tags: [ "Documentation", "Basics" ]
--- ---
If you want to kill a program in a graphical environment, open a terminal and type: If you want to kill a program in a graphical environment, open a terminal and type:

View File

@ -1,6 +1,6 @@
--- ---
title: "locale" title: "locale"
tags: [ "Basics", "time" ] tags: [ "Documentation", "Basics" ]
--- ---
Your locale tells the computer your location, preferred time-and-date format, standard language, papersize, et c. Your locale tells the computer your location, preferred time-and-date format, standard language, papersize, et c.

View File

@ -1,33 +1,62 @@
--- ---
title: "locating" title: "locating"
tags: [ "Basics" ] tags: [ "Documentation", "Basics" ]
--- ---
# Type # Type
`type` shows what kind of thing you're running, be it an alias, function, or binary program. `type` shows what kind of thing you're running, be it an alias, function, or binary program.
```sh ```bash
type cd type cmus
type ls
type -P ls
type -a cat
``` ```
# Whereis the Program # Whereis the Program
Where is `grep` and all its configuration files? Ask where the `angband` program is, along with all its configuration files:
```sh `whereis angband`
whereis grep
Also `which` shows where a binary file (the program) is,
```bash
which cmus
``` ```
Which one of these is the binary file which you actually use? # Search Instantly with `plocate`
```sh You can search every file on the computer instantly by installing `plocate`.
which grep
Once installed, run `sudo updatedb` to create the database of (nearly) every file on the computer.
Check how big the database is:
```bash
du -h /var/lib/plocate/plocate.db
``` ```
# More Once you have the database, you can find nearly any file instantly.
- [Search instantly with `plocate`](data/search_system.md) - Search for gifs: `locate .gif`
- Search for gifs in the `/usr/` directory: `locate /usr/ .gif`
- Search for jpg images with 'dog' or 'Dog' in the name: `locate -i dog jpg`
- Search for videos: `plocate --regex '.mp4$|.mkv$|.wmv$|.webm$|.mov$|.avi$'`
For best results, run `updatedb` regularly, perhaps in [crontab](../system/cron.md).
## Search More Places
`plocate` will not search `/tmp/`, because nobody cares about those files, and won't search inside `/mnt/`, because that's where USB sticks get mounted, so the files keep changing as USB sticks come and go.
Change where `plocate` searches by editing the configuration file at `/etc/updatedb.conf`.
By default, the `/mnt` directory is 'pruned' from the database.
So if you want to search `/mnt` for videos, remove the word `/mnt` from the configuration file.
```bash
cat /etc/updatedb.conf
sudo sed 's#/mnt/##' /etc/updatedb.conf
sudo updatedb
plocate --regex '.mp4$|.mkv$|.wmv$|.webm$|.mov$|.avi$'
```

View File

@ -1,6 +1,6 @@
--- ---
title: "processes" title: "processes"
tags: [ "Basics" ] tags: [ "Documentation", "Basics" ]
--- ---
# Proccesses # Proccesses

View File

@ -1,6 +1,6 @@
--- ---
title: "time" title: "time"
tags: [ "Basics", "time" ] tags: [ "Documentation", "Basics" ]
--- ---
# systemd # systemd

View File

@ -1,6 +1,6 @@
--- ---
title: "users" title: "users"
tags: [ "Basics" ] tags: [ "Documentation", "Basics" ]
--- ---
# Basic Information # Basic Information

57
chat/profanity-otr.md Normal file
View File

@ -0,0 +1,57 @@
---
title: "profanity"
tags: [ "Documentation", "Chat", "OTR" ]
---
# otr
'Off The Record' encryption seems mostly dead to me.
But this is what I did, back in the day...
Install libotr-dev or libotr5-dev or whatever..
```
sudo apt -y install lib5otr-dev
```
Make your otr keys.
```
/otr gen
```
Then you can start an otr converstation.
```
/otr start bob@jobbies.org
```
Or if you already have a conversation windows open, switch to our using:
```
/otr
```
Finally, verify!
```
/otr question "Who are you?" bob
```
Bob is verified upon the answer, 'bob'.
### OTR Finger Prints
Get yours with
```
/otr myfp
```
```
/otr theirfp
```
```
/otr myfp
```

View File

@ -1,6 +1,6 @@
--- ---
title: "profanity" title: "profanity"
tags: [ "Chat", "omemo" ] tags: [ "Documentation", "Chat", "omemo" ]
--- ---
# Setup (Commands) # Setup (Commands)

View File

@ -1,29 +1,29 @@
--- ---
title: "wgetpaste" title: "wgetpaste"
tags: [ "Chat" ] tags: [ "Documentation", "Chat" ]
--- ---
See available pastebins: See available pastebins:
```sh ```bash
wgetpaste -S wgetpaste -S
``` ```
Upload script.sh to bpaste: Upload script.sh to bpaste:
```sh ```bash
wgetpaste -s bpaste script.sh wgetpaste -s bpaste script.sh
``` ```
Input clipboard to dpaste with the heading "Title" Input clipboard to dpaste with the heading "Title"
```sh ```bash
wgetpaste -s dpaste -d Title -x wgetpaste -s dpaste -d Title -x
``` ```
Paste in the file then load the result to the right-hand clipboard: Paste in the file then load the result to the right-hand clipboard:
```sh ```bash
wgetpaste -s dpaste -X wgetpaste -s dpaste -X
``` ```

View File

@ -1,6 +1,6 @@
--- ---
title: "Archives" title: "Archives"
tags: [ "tar", "backups", ".tgz", "tar.gz" ] tags: [ "Documentation", "tar", "backups" ]
--- ---
# `tar` # `tar`

View File

@ -1,6 +1,6 @@
--- ---
title: "unison" title: "unison"
tags: [ "Backups", "synch" ] tags: [ "Documentation", "Backups" ]
--- ---
Install unison on both machines, and make sure both have the same version of unison, with the same version of the ocaml compiler (the smallest difference will cause problems). Install unison on both machines, and make sure both have the same version of unison, with the same version of the ocaml compiler (the smallest difference will cause problems).

View File

@ -1,6 +1,6 @@
--- ---
title: "Base 16" title: "Base 16"
tags: [ "Data" ] tags: [ "Documentation", "Data" ]
--- ---
```bash ```bash

View File

@ -1,6 +1,6 @@
--- ---
title: "exiftool" title: "exiftool"
tags: [ "Metadata" ] tags: [ "Documentation", "Metadata" ]
--- ---
Find metadata. Find metadata.

View File

@ -1,6 +1,6 @@
--- ---
title: "git" title: "git"
tags: [ "data" ] tags: [ "Documentation", "data" ]
--- ---
# Starting # Starting

View File

@ -1,6 +1,6 @@
--- ---
title: "git-lfs" title: "git-lfs"
tags: [ "data" ] tags: [ "Documentation", "data" ]
--- ---
Install, and add with Install, and add with

View File

@ -1,6 +1,6 @@
--- ---
title: "git hooks" title: "git hooks"
tags: [ "data", "git" ] tags: [ "Documentation", "data", "git" ]
--- ---
Check out the sample hooks: Check out the sample hooks:

View File

@ -1,6 +1,6 @@
--- ---
title: "git" title: "git"
tags: [ "data", "git", "subtree" ] tags: [ "Documentation", "data", "git", "subtree" ]
--- ---
## Pulling a Subtree from an existing git ## Pulling a Subtree from an existing git

View File

@ -1,6 +1,6 @@
--- ---
title: "gpg" title: "gpg"
tags: [ "data", "GPG" ] tags: [ "Documentation", "data", "GPG" ]
--- ---
- [Setup](gpg/basics.md) - [Setup](gpg/basics.md)

View File

@ -1,6 +1,6 @@
--- ---
title: "GPG Basics" title: "GPG Basics"
tags: [ "data", "GPG" ] tags: [ "Documentation", "data", "GPG" ]
--- ---
# Making keys # Making keys

View File

@ -1,7 +1,6 @@
--- ---
title: "gpg" title: "gpg"
tags: [ "vim", "data", "GPG" ] tags: [ "Documentation", "vim", "data", "GPG" ]
requires: [ "GPG Basics", "vim basics" ]
--- ---
The `vim-gnupg` plugin lets vim edit gpg-encrypted files as if they were unencrypted. The `vim-gnupg` plugin lets vim edit gpg-encrypted files as if they were unencrypted.

View File

@ -1,6 +1,6 @@
--- ---
title: "groff" title: "groff"
tags: [ "Data" ] tags: [ "Documentation", "Data" ]
--- ---
# Basic Documents # Basic Documents

View File

@ -1,6 +1,6 @@
--- ---
title: "khard" title: "khard"
tags: [ "Data" ] tags: [ "Documentation", "Data" ]
--- ---
Get the basic config: Get the basic config:

View File

@ -1,6 +1,6 @@
--- ---
title: "newsboat" title: "newsboat"
tags: [ "RSS" ] tags: [ "Documentation", "RSS" ]
--- ---
Create the configuration directory before you start, and add at least 1 URL. Create the configuration directory before you start, and add at least 1 URL.

View File

@ -1,6 +1,6 @@
--- ---
title: "pass" title: "pass"
tags: [ "data" ] tags: [ "Documentation", "data" ]
--- ---
[Video instructions](https://www.hooktube.com/watch?v=hlRQTj1D9LA) [Video instructions](https://www.hooktube.com/watch?v=hlRQTj1D9LA)

View File

@ -1,6 +1,6 @@
--- ---
title: "pdf to txt" title: "pdf to txt"
tags: [ "data", "pdf", "ocr" ] tags: [ "Documentation", "data", "pdf", "ocr" ]
--- ---
How to translate pdf book images to text (results are very poor, and will need lots of corrections). How to translate pdf book images to text (results are very poor, and will need lots of corrections).

View File

@ -1,11 +1,8 @@
--- ---
title: "PDF Metadata Erasure" title: "PDF Metadata Erasure"
tags: [ "Metadata", "Ghost Script", "gs", ".pdf" ] tags: [ "Documentation", "Metadata", "Ghost Script" ]
--- ---
You cannot erase pdf metadata with `exiftool` (it only *appends* your changes).
To delete pdf metadata, you'll need `gs`.
Make a text file called 'pdfmark.txt'. Make a text file called 'pdfmark.txt'.

View File

@ -1,51 +0,0 @@
---
title: "Recfiles"
tags: [ "data", "database" ]
---
Create:
```sh
database=games.rec
touch $database
for g in Vojvodina Saboter Carcassonne Chess; do
recins -r "Name: $g" -r "Played: yes" $database
done
```
Read:
```sh
recsel $database
query=Carc
recsel --quick=$query $database
game=Vojvodina
recsel --expression="Name = '${game}'" $database
```
Update:
```sh
recset --expression="Name = '${game}'" -f Played --set="no" $database
new_field=Played
value=no
recset -f "$new_field" --delete $database
recset -f "$new_field" --set-add="$value" $database
recsel $database
```
Delete:
```sh
recdel --expression="Name = '${game}'" $database
recset -f "$new_field" --delete $database
```
- [Extended example](recfiles/extended.md)
- [Playing with board games data](recfiles/Board_Games.md)
# Resources
- [Recfiles for gemini capsules](gemini://tilde.town/~dozens/gemlog/21.gmi)

View File

@ -1,62 +0,0 @@
---
title: "Board Games with Recfiles"
tags: [ "data", "recfiles", "games" ]
requires: "Recfiles"
---
You can play with a board games database from boardgamegeek.com.
## Download the Database
```sh
mkdir board_games
cd board_games
curl -Lo bg.zip 'https://www.kaggle.com/api/v1/datasets/download/threnjen/board-games-database-from-boardgamegeek'
unzip bg.zip
```
The header line shows fields with a bunch of colons, which will confused `recutils`, so we'll have to get rid of them.
```sh
sed -i '1s/://g' *.csv
```
Convert the games to `.rec` format.
```sh
csv2rec games.csv > games.rec
```
## Queries
If you try to look at older games, you'll find lots of results.
```sh
recsel games.rec -e "YearPublished < 1800" -c
recsel games.rec -e "YearPublished < 1800" -Cp Name
```
But most are wrong.
The problem is games with a `YearPublished` date of `0`, probably because the year published is unknown.
```sh
recsel games.rec -e "Name = 'The Goblin King is Angry'" -p YearPublished
```
Fix the query by removing games published in '0 AD'.
```sh
recsel games.rec -e "YearPublished < 1800 && YearPublished != 0" -R YearPublished,Name
```
Or fix the database setting `YearPublished` to 'unknown':
```sh
recsel games.rec -e "YearPublished = 0" -Cp Name
recset games.rec -e "YearPublished = 0" -f "YearPublished" -S 'unknown'
```
Strategic games which work best with 3 players, sorted by Average Rating:
```sh
recsel games.rec -e "BestPlayers = 3 && CatStrategy = 1" -CR Name --sort=AvgRating
```

View File

@ -1,118 +0,0 @@
---
title: "Recfiles Extended Example"
tags: [ "data", "database", "recfiles" ]
---
## Create
Make a database for your boardgames, specifying only one field and value:
```bash
database=games.rec
n=Name
g=Vojvodina
touch $database
recins -f $n --value $g $database
recsel $database
```
Insert a few more, with the estimated playtime:
```bash
recins -f Name -v Saboter -f Playtime -v 30 $database
recins -f Name -v Chess -f Playtime -v 30 $database
```
View all games, or select one by number:
```bash
recsel $database
recsel -n 0 $database
```
Each game should note whether or not you have played it yet, so you can add that field and set the default to `yes`.
```bash
f=played
v=yes
recset -f $f -a $v $database
```
...but the field is wrong, it should have a capital letter:
```bash
new_field=Played
recset -f $f --rename $new_field
```
## Read
Check how many records the database has:
```bash
recinf $database
```
Look at just the games you've never played:
```bash
recsel --expression="Played = 'no'" $database
```
Print how many, then just print the names:
```bash
recsel -e "Played = 'no'" --count $database
recsel -e "Played = 'no'" --print=Name $database
```
## Update
To change a game's `Played` field from `no` to `yes`, use `recset` to specify the number, and change that field.
```bash
num=0
f=Played
value=yes
recsel --number=$num $database
recset --number=$num -f $f --set=$value $database
```
Find all games with a playtime of `30`, and set the field `Max_Players` to `4`.
```bash
recset -e "Playtime = 40" -f Max_Players --set 50 games.rec
```
This doesn't work, because that field does not exist.
You can `--set-add` the field, to add it wherever it does not exist.
```bash
recset -e "Playtime = 40" -f Max_Players --set-add 50 games.rec
```
## Delete
Remove `Played` record from first game:
```bash
num=0
recset --number=$num -f Played --delete $database
```
You can comment the line instead of deleting it:
```bash
num=1
recset --number=$num -f Played --delete $database
recsel $database
cat $database
```
Delete an entire record:
```bash
num=2
recdel --number=$num $database
```

View File

@ -1,6 +1,6 @@
--- ---
title: "sc-im" title: "sc-im"
tags: [ "TUI", "data", "spreadsheet", ".csv" ] tags: [ "Documentation", "TUI", "data" ]
--- ---
- [Sample file](sc-im/sample.sc) - [Sample file](sc-im/sample.sc)

View File

@ -1,49 +0,0 @@
---
title: "Search System"
tags: [ "data", "search", "locate", "plocate" ]
requires: "cron"
---
You can search every file on the computer instantly by installing `plocate`.
Once installed, run `sudo updatedb` to create the database of (nearly) every file on the computer.
Check how big the database is:
```sh
du -h /var/lib/plocate/plocate.db
```
Once you have the database, you can find nearly any file instantly.
- Search for gifs: `locate .gif`
- Search for gifs in the `/usr/` directory: `locate /usr/ .gif`
- Search for jpg images with 'dog' or 'Dog' in the name: `locate -i dog jpg`
- Search for videos: `plocate --regex '.mp4$|.mkv$|.wmv$|.webm$|.mov$|.avi$'`
For best results, run `updatedb` regularly, perhaps in [crontab](../system/cron.md).
## Search More Places
`plocate` will not search `/tmp/`, because nobody cares about those files, and won't search inside `/mnt/`, because that's where USB sticks get mounted, so the files keep changing as USB sticks come and go.
Change where `plocate` searches by editing the configuration file at `/etc/updatedb.conf`.
By default, the `/mnt` directory is 'pruned' from the database.
So if you want to search `/mnt` for videos, remove the word `/mnt` from the configuration file.
```bash
su root
cat /etc/updatedb.conf
sed -i 's#/mnt/##' /etc/updatedb.conf
updatedb
exit
```
Now you can search in `/mnt` for films:
```sh
plocate --regex '.mp4$|.mkv$|.wmv$|.webm$|.mov$|.avi$'
```

View File

@ -1,6 +1,6 @@
--- ---
title: "Soft Serve through https" title: "Soft Serve through https"
tags: [ "data", "git server", "lfs" ] tags: [ "data", "git" ]
--- ---
## `http` Setup ## `http` Setup

View File

@ -1,6 +1,6 @@
--- ---
title: "sqlite" title: "sqlite"
tags: [ "data" ] tags: [ "Documentation", "data" ]
--- ---
Work with a database: Work with a database:

View File

@ -1,6 +1,6 @@
--- ---
title: "task" title: "task"
tags: [ "Organization" ] tags: [ "Documentation", "Organization" ]
--- ---
Set up the configuration file: Set up the configuration file:

View File

@ -1,6 +1,6 @@
--- ---
title: "timewarrior" title: "timew"
tags: [ "Data", "tracking", "time", "timew" ] tags: [ "Documentation", "Data" ]
--- ---
# Summaries # Summaries

View File

@ -1,6 +1,6 @@
--- ---
title: "w3m" title: "w3m"
tags: [ "browsers" ] tags: [ "Documentation", "browsers" ]
--- ---
Open a search tab: Open a search tab:

View File

@ -8,7 +8,7 @@ tags: [ "networking", "ssh", "android" ]
3. Open fdroid, and run: 3. Open fdroid, and run:
```sh ```bash
pkg upgrade pkg upgrade
pkg install busybox termux-services openssh openssh-sftp-server pkg install busybox termux-services openssh openssh-sftp-server
source $PREFIX/etc/profile.d/start-services.sh source $PREFIX/etc/profile.d/start-services.sh

View File

@ -1,53 +0,0 @@
---
title: "Maintenance"
tags: [ "arch" ]
---
# Package Cache
Clean the cache of old packages in `/var/cachepacman/pkg/`:
```bash
ls /var/cache/pacman/pkg/ | wc -l
sudo pacman -Sc
ls /var/cache/pacman/pkg/ | wc -l
```
And the same for `yay` (with `-Yc` to remove old dependencies):
```bash
ls ~/.cache/yay/ | wc -l
yay -Sc
yay -Yc
ls ~/.cache/yay/ | wc -l
```
# New Configs
If you chance a configuration file, such as `/etc/environment`, and `pacman` wants to update the file, it will place `/etc/environment.pacnew`.
Check the new files, then look at the difference between the `pacman` version, and your version.
```bash
sudo find /etc/ /var/ /usr/ -name "*.pacnew"
diff /etc/pacman.d/mirrorlist*
```
Either,
- Update the files manually,
```bash
sudo -e /etc/pacman.d/mirrorlist
sudo rm /etc/pacman.d/mirrorlist.pacnew
```
Or,
- use a tool like `pacdiff` to view the changes next to each other, and select them with `vim`.
```bash
sudo pacman -S pacman-contrib
sudo pacdiff
```

View File

@ -1,6 +1,6 @@
--- ---
title: "Arch on a Raspberry Pi 4" title: "Arch on a Raspberry Pi 4"
tags: [ "distros", "raspberry pi", "rpi" ] tags: [ "Documentation", "distros", "raspberry pi", "rpi" ]
--- ---
The [Official Instructions](https://archlinuxarm.org/platforms/armv8/broadcom/raspberry-pi-4) for a Raspberry pi 4 do not allow for working sound from the headphone jack, unless you use the aarch64 Installation. The [Official Instructions](https://archlinuxarm.org/platforms/armv8/broadcom/raspberry-pi-4) for a Raspberry pi 4 do not allow for working sound from the headphone jack, unless you use the aarch64 Installation.

View File

@ -1,6 +1,6 @@
--- ---
title: "autologin" title: "autologin"
tags: [ "Distros", "Arch" ] tags: [ "Documentation", "Distros", "Arch" ]
--- ---
# Automatic Login # Automatic Login

View File

@ -1,7 +1,6 @@
--- ---
title: "basic-install" title: "basic-install"
tags: [ "arch" ] tags: [ "Documentation", "arch" ]
requires: [ "partitions", "time" ]
--- ---
Keyboard layout changed. Keyboard layout changed.

View File

@ -1,25 +1,24 @@
--- ---
title: "fonts" title: "fonts"
tags: [ "distros" ] tags: [ "Documentation", "distros" ]
--- ---
# Basics # Basics
Update font-cache: Update font-cache:
```sh ```bash
su root
fc-cache fc-cache
``` ```
List fonts: List fonts:
```sh ```bash
fc-list fc-list
``` ```
Grab the part of the font name you need for Xresources: Grab the part of the font name you need for Xresources:
```sh ```bash
fc-list | cut -d: -f2 fc-list | cut -d: -f2
``` ```

View File

@ -1,6 +1,6 @@
--- ---
title: "fonts" title: "fonts"
tags: [ "distros" ] tags: [ "Documentation", "distros" ]
--- ---
# Step 1: Multilib # Step 1: Multilib

View File

@ -1,6 +1,6 @@
--- ---
title: "pacman" title: "pacman"
tags: [ "distros" ] tags: [ "Documentation", "distros" ]
--- ---
Packages are kept in /var/cache/pacman/pkg. Packages are kept in /var/cache/pacman/pkg.

View File

@ -1,6 +1,6 @@
--- ---
title: "apt" title: "apt"
tags: [ "distros" ] tags: [ "Documentation", "distros" ]
--- ---
## apt ## apt
@ -8,27 +8,27 @@ tags: [ "distros" ]
Messed up a package's configuration files? Messed up a package's configuration files?
```sh ```bash
sudo apt-get purge [thing] sudo apt-get purge [thing]
``` ```
```sh ```bash
sudo apt autoremove sudo apt autoremove
``` ```
Check if you still have related things: Check if you still have related things:
```sh ```bash
apt search [thing] apt search [thing]
``` ```
```sh ```bash
sudo apt-get install [ thing ] sudo apt-get install [ thing ]
``` ```
Still have problems? Still have problems?
```sh ```bash
sudo dpgk --force-confmiss -i /var/cache/apt/archives/[thing] sudo dpgk --force-confmiss -i /var/cache/apt/archives/[thing]
``` ```

View File

@ -1,24 +1,18 @@
--- ---
title: "Aeroplane Mode in Void" title: "Aeroplane Mode in Void"
tags: [ "Void" ] tags: [ "Documentation", "Void" ]
--- ---
Put your device in 'aeroplane' mode (e.g. where no trace of signal leaves it) by turning off Wi-Fi and blue-tooth. Put your device in 'aeroplane' mode (e.g. where no trace of signal leaves it) by turning off Wi-Fi and blue-tooth.
```sh > sudo sv stop wpa_supplicant bluetoothd
su root
sv stop wpa_supplicant bluetoothd
```
Find your device's name with `ip a`. Find your device's name with `ip a`.
If unsure, try this: If unsure, try this:
```sh > name=$(ip a | grep -Eo 'wlp\w{3}')
name=$(ip a | grep -Eo 'wlp\w{3}')
echo $name > echo $name
```
Then set that device down: Then set that device down:
```sh > sudo ip link set $name down
ip link set $name down
```

View File

@ -1,6 +1,6 @@
--- ---
title: "Void Autologin" title: "Void Autologin"
tags: [ "Void" ] tags: [ "Documentation", "Void" ]
--- ---
Make the autologin service: Make the autologin service:

View File

@ -1,22 +1,22 @@
--- ---
title: "extrace" title: "extrace"
tags: [ "Void" ] tags: [ "Documentation", "Void" ]
--- ---
Monitor all processes: Monitor all processes:
```sh ```bash
extrace extrace
``` ```
Monitor one process: Monitor one process:
```sh ```bash
extrace ls extrace ls
``` ```
Monitor a script: Monitor a script:
```sh ```bash
./script.sh | extrace ./script.sh | extrace
``` ```

View File

@ -9,17 +9,16 @@ Jenkins is janky.
## Start ## Start
Start the service file. Start the service file.
```sh ```bash
su root sudo ln -s /etc/sv/jenkins /var/service
ln -s /etc/sv/jenkins /var/service sudo sv start jenkins
sv start jenkins
``` ```
Then visit the web interface with `$BROWSER localhost:8080`. Then visit the web interface with `$BROWSER localhost:8080`.
If it's not working, try running the command from the run file the first time: If it's not working, try running the command from the run file the first time:
```sh ```bash
chpst -u jenkins java -jar /opt/jenkins/jenkins.war chpst -u jenkins java -jar /opt/jenkins/jenkins.war
``` ```

View File

@ -6,13 +6,13 @@ tags: [ "void", "locale" ]
Check the current locales: Check the current locales:
```sh ```bash
locale -a locale -a
``` ```
Add the languages you want by editing `/etc/default/libc-locales`, and uncommenting your choice: Add the languages you want by editing `/etc/default/libc-locales`, and uncommenting your choice:
```sh ```bash
#en_DK.UTF-8 UTF-8 #en_DK.UTF-8 UTF-8
#en_DK ISO-8859-1 #en_DK ISO-8859-1
en_GB.UTF-8 UTF-8 en_GB.UTF-8 UTF-8
@ -25,14 +25,13 @@ Now you can generate what you need for those languages.
However, instead of generating what you need, you're going to generate everything which needs updating: However, instead of generating what you need, you're going to generate everything which needs updating:
```sh ```bash
su root sudo xbps-reconfigure glibc-locales
xbps-reconfigure glibc-locales
``` ```
Finally, select your chosen locale by placing it in `/etc/locale.conf`. Finally, select your chosen locale by placing it in `/etc/locale.conf`.
```sh ```bash
echo "LC_ALL=en_GB.UTF-8 echo "LC_ALL=en_GB.UTF-8
LANG=en_GB.UTF-8 LANG=en_GB.UTF-8
LANGUAGE=en_GB.UTF-8" > /etc/locale.conf LANGUAGE=en_GB.UTF-8" > /etc/locale.conf
@ -49,7 +48,7 @@ en_GB ISO-8859-1
Check your new locales are available: Check your new locales are available:
```sh ```bash
locale -a locale -a
``` ```

View File

@ -1,6 +1,6 @@
--- ---
title: "sv" title: "sv"
tags: [ "Void" ] tags: [ "Documentation", "Void" ]
--- ---
# List Services # List Services

View File

@ -1,6 +1,6 @@
--- ---
title: "Void Linux Basics" title: "Void Linux Basics"
tags: [ "Void" ] tags: [ "Documentation", "Void" ]
--- ---
# Updates # Updates

View File

@ -1,6 +1,6 @@
--- ---
title: "xbps" title: "xbps"
tags: [ "Void" ] tags: [ "Documentation", "Void" ]
--- ---
## Search ## Search

View File

@ -1,6 +1,6 @@
--- ---
title: "brightness" title: "brightness"
tags: [ "hardware", "laptop" ] tags: [ "Documentation", "hardware" ]
--- ---
# Brightness # Brightness

View File

@ -1,65 +0,0 @@
---
title: "keyboard"
tags: [ "keyboard", "vim" ]
---
# System-Wide Capslock and Escape Swap
This works everywhere, including in a bare-ass tty.
Select a keymap, and create a new custom map.
```bash
su root
basemap=/usr/share/kbd/keymaps/i386/qwerty/pl1.map.gz
newmap=/usr/share/kbd/keymaps/custom.map.gz
gunzip -c $basemap | \
sed 's/Caps_Lock/\n/g;s/Escape/Caps_Lock/g;s/\n/Escape/g' | \
gzip > $newmap
```
Tell the system to use this keymap at startup by naming it in the `rc.conf` file:
```bash
echo "KEYMAP=$newmap" >> /etc/rc.conf
cat /etc/rc.conf
reboot
```
# Set Layout with X Display
Set layout to British English.
```bash
setxkbmap -layout gb
```
Or Polish with:
```bash
setxkbmap -layout pl
```
| Language | short |
|:--------|:------|
| Polish | pl |
| Serbian | rs |
Set 'alt + shift', as the command which cycles through the British English, Polish and Serbian keyboard layout.
```bash
setxkbmap -layout gb,pl,rs -option grp:alt_shift_toggle
```
## Alt_GR
Remap, e.g., the right Windows key, to Alt_Gr.
```
key <RWIN> {[ ISO_Level3_Shift ]};
```

View File

@ -0,0 +1,68 @@
---
title: "keyboard"
tags: [ "Documentation", "keyboard" ]
---
# Set Layout with X Display
Set layout to British English.
```bash
setxkbmap -layout gb
```
Or Polish with:
```bash
setxkbmap -layout pl
```
| Language | short |
|:--------|:------|
| Polish | pl |
| Serbian | rs |
Set 'alt + shift', as the command which cycles through the British English, Polish and Serbian keyboard layout.
```bash
setxkbmap -layout gb,pl,rs -option grp:alt_shift_toggle
```
## Alt_GR
Remap, e.g., the right Windows key, to Alt_Gr.
```
key <RWIN> {[ ISO_Level3_Shift ]};
```
# Set TTY Keymap
Copy your keymap, e.g. if it's polish-1, then:
```bash
cp /usr/share/kbd/keymaps/i386/qwerty/pl1.map.gz /usr/share/kbd/keymaps/*custom*.map.gz
```
Then change that map:
```bash
sudo vim /usr/share/kbd/keymaps/custom.map.gz
```
---
You can switch Escape and Caps Lock with a single line:
```bash
sudo sh -c "gunzip -c /usr/share/kbd/keymaps/i386/qwerty/pl1.map.gz | sed 's/ Escape/ PLACEHOLDER/ ; s/Caps_Lock/Escape/g ; s/PLACEHOLDER/Caps_Lock/' | gzip > /usr/share/kbd/keymaps/custom.map.gz"
```
---
Change the default keyboard mapping to the custom map:
```bash
echo 'KEYMAP="/usr/share/kbd/keymaps/*custom*.map.gz"' | sudo tee /etc/vconsole.conf
```
Reboot to have changes take effect.

View File

@ -0,0 +1,37 @@
☢ ☣ s ☠ ⚠
radioactive sign biohazard sign skull and crossbones warning sign
☤ ⚕ ⚚ †
caduceus staff of aesculapius staff of hermes dagger
☯ ⚖ ☮ ⚘
yin yang scales peace flower
⚔ ☭ ⚒ ⚓
crossed swords hammer and sickle hammer and pick anchor
⚛ ⚜ ⚡ ⚶
atom symbol fleur-de-lis lightning vesta
☥ ✠ ✙ ✞
ankh cross cross cross
✟ ✧ ⋆ ★
cross diamond star star
☆ ✪ ✫ ✬
star star star star
✭ ✮ ✯ ✰
star star star star
☸ ✵ ❂ ☘
wheel of dharma star sun shamrock
♡ ♥ ❤ ⚘
heart heart big heart flower
❀ ❃ ❁ ✼
flower flower flower flower
☀ ✌ ♫ ♪
sun V sign music note / melody music note / melody
☃ ❄ ❅ ❆
snowman snowflake snowflake snowflake
☕ ☂ ❦ ✈
cofee umbrella floral heart / leaf airplane
♕ ♛ ♖ ♜
white king / crown black king / crown white rook / tower black rook / tower
☁ ☾
cloud waning crescent moon

View File

@ -1,16 +1,12 @@
--- ---
title: "monitor" title: "monitor"
tags: [ "hardware" ] tags: [ "Documentation", "hardware" ]
--- ---
See screen size See screen size
```sh > xrandr -q
xrandr -q
```
Automatically configure: Automatically configure:
```sh > xrandr --auto
xrandr --auto
```

View File

@ -1,6 +1,6 @@
--- ---
title: "printers" title: "printers"
tags: [ "hardware" ] tags: [ "Documentation", "hardware" ]
--- ---
# Cups: The Common Unix Printing System # Cups: The Common Unix Printing System

View File

@ -1,7 +1,6 @@
--- ---
title: "fail2ban" title: "fail2ban"
tags: [ "Networking" ] tags: [ "Documentation", "Networking" ]
requires: [ "ssh" ]
--- ---
# SSH Daemon Jail # SSH Daemon Jail

View File

@ -1,6 +1,6 @@
--- ---
title: "Easy Network Graph" title: "Easy Network Graph"
tags: [ "Networking" ] tags: [ "Documentation", "Networking" ]
--- ---
Set up a file like this, called `troubleshooting.txt`. Set up a file like this, called `troubleshooting.txt`.

View File

@ -1,6 +1,6 @@
--- ---
title: "iptables" title: "iptables"
tags: [ "Networking" ] tags: [ "Documentation", "Networking" ]
--- ---
# Intro # Intro

View File

@ -1,6 +1,6 @@
--- ---
title: "nmap" title: "nmap"
tags: [ "Networking" ] tags: [ "Documentation", "Networking" ]
--- ---
Example: Example:

View File

@ -1,6 +1,6 @@
--- ---
title: "pi-hole-server" title: "pi-hole-server"
tags: [ "Distros" ] tags: [ "Documentation", "Distros" ]
--- ---
# Installation # Installation

View File

@ -1,6 +1,6 @@
--- ---
title: "rclone" title: "rclone"
tags: [ "Networking" ] tags: [ "Documentation", "Networking" ]
--- ---
The manpage's 'Synopsis' provides a fast reference. The manpage's 'Synopsis' provides a fast reference.
``` ```

View File

@ -1,6 +1,6 @@
--- ---
title: "Download videos" title: "Download videos"
tags: [ "Scraping" ] tags: [ "Documentation", "Scraping" ]
--- ---
Install `yt-dlp`. Install `yt-dlp`.

View File

@ -1,6 +1,6 @@
--- ---
title: "Agate on Arch Linux" title: "Agate on Arch Linux"
tags: [ "Networking", "Arch", "Gemini" ] tags: [ "Documentation", "Networking", "Arch", "Gemini" ]
--- ---
Docs are [here](https://github.com/mbrubeck/agate). Docs are [here](https://github.com/mbrubeck/agate).

View File

@ -1,7 +1,6 @@
--- ---
title: "sshfs" title: "sshfs"
tags: [ "Networking" ] tags: [ "Documentation", "Networking" ]
requires: [ "ssh" ]
--- ---
# Mount # Mount

View File

@ -1,7 +1,6 @@
--- ---
title: "ssh-tricks" title: "ssh tricks"
tags: [ "Networking", "ssh", "tricks" ] tags: [ "Documentation", "Networking", "ssh", "tricks" ]
requires: [ "ssh" ]
--- ---
Mount a remote filesystem locally with fuse-sshfs: Mount a remote filesystem locally with fuse-sshfs:

View File

@ -1,6 +1,6 @@
--- ---
title: "tor" title: "tor"
tags: [ "Networking" ] tags: [ "Documentation", "Networking" ]
--- ---
# Get a hostname # Get a hostname

View File

@ -1,6 +1,6 @@
--- ---
title: "transmission" title: "transmission"
tags: [ "Networking", "Torrenting" ] tags: [ "Documentation", "Networking", "Torrenting" ]
--- ---
# Torrench # Torrench

View File

@ -1,6 +1,6 @@
--- ---
title: "troubleshooting" title: "troubleshooting"
tags: [ "Networking" ] tags: [ "Documentation", "Networking" ]
--- ---
# Do you have an IP? # Do you have an IP?

View File

@ -1,6 +1,6 @@
--- ---
title: "nginx" title: "nginx"
tags: [ "Networking" ] tags: [ "Documentation", "Networking" ]
--- ---
Install nginx: Install nginx:

View File

@ -1,6 +1,6 @@
--- ---
title: "wifi" title: "wifi"
tags: [ "Networking" ] tags: [ "Documentation", "Networking" ]
--- ---
# Netstat Stuff # Netstat Stuff

View File

@ -1,6 +1,6 @@
--- ---
title: "wireguard" title: "wireguard"
tags: [ "Networking", "VPN" ] tags: [ "Documentation", "Networking", "VPN" ]
--- ---
<!-- <!--
from from

View File

@ -1,6 +1,6 @@
--- ---
title: "wireless" title: "wireless"
tags: [ "Networking" ] tags: [ "Documentation", "Networking" ]
--- ---
# Check wifi's working # Check wifi's working

View File

@ -1,6 +1,6 @@
--- ---
title: "wpa_supplicant" title: "wpa_supplicant"
tags: [ "Networking" ] tags: [ "Documentation", "Networking" ]
--- ---
wpa_supplicant configurations are stored in /etc/wpa_supplicant/wpa_supplicant-wlan0 (or equivalent). wpa_supplicant configurations are stored in /etc/wpa_supplicant/wpa_supplicant-wlan0 (or equivalent).

27
new.sh Executable file
View File

@ -0,0 +1,27 @@
#!/bin/sh
echo Select a category
category="$(find . -type d -printf '%P\n' | fzy)"
[ ! -d "$category" ] && mkdir "$category"
echo Select a name
read name
filePath="$category/$(echo $name | sed 's/ /_/g').md"
tagsList="$(echo \"$category | sed 's#\/#", "#g')\""
[ -e "$filePath" ] && $EDITOR "$filePath" && exit 0
echo "---
title: \"$name\"
tags: [ $tagsList ]
---
" > "$filePath"
$EDITOR "$filePath"

View File

@ -1,6 +1,6 @@
--- ---
title: "Basic Sound" title: "Basic Sound"
tags: [ "Sound" ] tags: [ "Documentation", "Sound" ]
--- ---
# Pulse # Pulse

View File

@ -1,16 +1,16 @@
--- ---
title: "festival" title: "festival"
tags: [ "Sound" ] tags: [ "Documentation", "Sound" ]
--- ---
# Basics # Basics
Add your user to the audio group, and install `festival-english`. Add your user to the audio group, and install `festival-english`.
```sh ```bash
echo "(Parameter.set 'Audio_Method 'Audio_Command)" >> /usr/share/festival/voices.scm echo "(Parameter.set 'Audio_Method 'Audio_Command)" >> /usr/share/festival/voices.scm
``` ```
```sh ```bash
echo "(Parameter.set 'Audio_Command "aplay -q -c 1 -t raw -f s16 -r $SR $FILE")" /usr/share/festival/voices.scm echo "(Parameter.set 'Audio_Command "aplay -q -c 1 -t raw -f s16 -r $SR $FILE")" /usr/share/festival/voices.scm
``` ```

View File

@ -1,6 +1,6 @@
--- ---
title: "mpd" title: "mpd"
tags: [ "Sound" ] tags: [ "Documentation", "Sound" ]
--- ---
# Setup # Setup

View File

@ -1,6 +1,6 @@
--- ---
title: "ncmpcpp" title: "ncmpcpp"
tags: [ "Sound" ] tags: [ "Documentation", "Sound" ]
--- ---
# Music Player Daemon # Music Player Daemon

View File

@ -1,185 +0,0 @@
---
title: "Makefiles"
tags: [ "system", "make" ]
---
The `make` system wants to know:
1. What file you want to make,
1. Which other files it depends on, and
1. How to build the file.
Start with a basic test-area.
```sh
mkdir make_test ; cd $_
printf "%s:\n" README.md > Makefile
printf "\t%s\n" 'echo "Basic makefile example." > $@' >> Makefile
make
```
**NB:** Always tell `make` how to build files with a `\t` (tab) character.
Using four spaces will not work!
## Dependency Files
Now we've made a `README.md` file, we can show how a makefile looks in the README:
```make
README.md: Makefile
echo "Basic makefile example." > $@
echo "" >> $@
echo '```' >> $@
cat $< >> $@
echo '```' >> $@
```
Note the order:
1. The first thing is the file you want, then a colon (`:`).
1. After the colon, any file it depends on.
1. Finally, the shell commands to execute.
# Strange Sigils
Notice that the file above can print into the README by using `echo "" >> $@`.
The `$@` stands for 'the file which we want', and `$<` stands for 'the first dependency file'.
The `make` program starts by replacing those variables, and the result it:
```make
README.md: Makefile
echo "Basic makefile example." > README.md
echo "" >> README.md
echo '```' >> README.md
cat Makefile >> README.md
echo '```' >> README.md
```
| Sigil | Meaning |
|:-------:|:--------------------------------------:|
| `$@` | The file we want |
| `$<` | First dependency file |
| `$^` | All dependency files |
| `$(@F)` | Filename of the file we want |
| `$(@D)` | Directory path of the file we want |
| `$(<F)` | Filename of the first dependency |
| `$(@D)` | Directory path of the first dependency |
## Basic Variables
You can assign a variable normally, but must refer to it in brackets.
```make
storage_directory = backups
README.md: Makefile
echo "Basic makefile example." > $@
echo "" >> $@
echo '```' >> $@
cat $< >> $@
echo '```' >> $@
$(storage_directory)/README.md: README.md
mkdir $(@D)
cp $< $@
```
Now you can tell `make` to create the backup:
```sh
make backups/README.md
```
## Command Variables
The backup `README.md` could be named after the current minute of the day, using `date +%M`.
This allows up-to-the-minute backups:
```make
current_minute != date +%M
storage_directory = backups
README.md: Makefile
echo "Basic makefile example." > $@
echo "" >> $@
echo '```' >> $@
cat $< >> $@
echo '```' >> $@
$(storage_directory)/backup_$(current_minute).md: README.md
mkdir $(@D)
cp $< $@
```
...but the repeated use of `mkdir` is causing an error, because that directory already exists.
We can solve this by using `mkdir -p`.
## Phony Targets
But we don't want to look up the current minute of the day to make backups.
Better to just say `make backup`.
However, this will confuse `make`, because `make` thinks everything is a file, so it would try to make a file called `backup`.
The solution is to tell `make` that `backup` is a phony target.
```make
[ ... ]
.PHONY: backup
backup: $(storage_directory)/backup_$(current_minute).md
$(storage_directory)/backup_$(current_minute).md: README.md
mkdir -p $(@D)
cp $< $@
```
Now run `make backup` to create an up-to-date backup.
# Order
Makefile thinks like this:
1. Fill in all the variables in the file, from top to bottom.
1. If variables are missing, go through the file again.
1. Figure out the order the files should be built in.
In this case, the makefile can see that `backup` depends on the current backup file (with the minute in the filename), which depends on the `README.md` file, which depends on the Makefile itself.
```graph
┌──────────────────────┐
│ Makefile │
└──────────────────────┘
┌──────────────────────┐
│ README.md │
└──────────────────────┘
┌──────────────────────┐
│ backups/backup_06.md │
└──────────────────────┘
┌──────────────────────┐
│ backup │
└──────────────────────┘
```
# The Rest
- [File patterns](Makefiles/patterns.md)
- [Makefile graphs](Makefiles/graph-easy.md)
- [In-build help](Makefiles/help.md)
- [Makefile graphs](Makefiles/graph-easy.md)

View File

@ -1,15 +0,0 @@
---
title: "Makefile Graphs"
tags: [ "system", "make", "graph" ]
---
If you have `graph-easy` (often in the package `perl-graph-easy` or similar), you can make a graph from the makefile with `make2graph` (the package is often called `makefile2graph`).
Start with the command to 'make all targets' (`-B`), and 'do a dummy run' (`-n`) with debug into (`-d`):
```bash
make -Bnd
make -Bnd | make2graph
make -Bnd | make2graph | graph-easy --boxart
```

View File

@ -1,18 +0,0 @@
---
title: "Makefiles"
tags: [ "system", "make", "help" ]
---
Make your first target 'help' to give an overview of the main targets.
Running `make help` will search for text which starts with `## ` and show what that target does.
```make
help: ## Print the help message
@awk 'BEGIN {FS = ":.*?## "} /^[0-9a-zA-Z._-]+:.*?## / {printf "\033[36m%s\033[0m : %s\n", $$1, $$2}' $(MAKEFILE_LIST) | \
sort | \
column -s ':' -t
clean: ## Remove generated files
$(RM) $(defaults)
```

View File

@ -1,56 +0,0 @@
---
title: "Makefile Patterns"
tags: [ "system", "make" ]
---
Using the [basic example](../Makefile.md), you can make a complete backup of all backup files.
This file will depend upon everything inside the `$(storage_directory)`.
Unlike `bash`, you can't just say `storage_directory/*`: the pattern must be stated as a 'wildcard'.
```make
$(storage_directory)/backup.tgz: $(wildcard $(storage_directory)/*.md)
tar czf $@ $^
```
The `make` rules start by processing variables:
```make
backups/backup.tgz: $(wildcard backups/*.md)
tar czf backups/backup.tgz $^
```
Then the `wildcard` variable equals whichever backup files are in the `backups/` directory:
```make
backups/backup.tgz: backups/backup_29.md backups/backup_30.md
tar czf backups/backup.tgz backups/backup_29.md backups/backup_30.md
```
The phony `backup` target should now point to this tar backup.
```make
current_minute != date +%M
storage_directory = backups
.PHONY: backup
backup: $(storage_directory)/backup.tgz
$(storage_directory)/backup.tgz: $(wildcard $(storage_directory)/*.md)
tar czf $@ $^
README.md: Makefile
echo "Basic makefile example." > $@
echo "" >> $@
echo '```' >> $@
cat $< >> $@
echo '```' >> $@
$(storage_directory)/backup_$(current_minute).md: README.md
mkdir -p $(@D)
cp $< $@
```

View File

@ -1,6 +1,6 @@
--- ---
title: "android" title: "android"
tags: [ "System", "phone" ] tags: [ "Documentation", "System" ]
--- ---
# mtpfs # mtpfs

View File

@ -1,6 +1,6 @@
--- ---
title: "awk" title: "awk"
tags: [ "System", ".csv" ] tags: [ "Documentation", "System" ]
--- ---
# Basics # Basics

View File

@ -1,6 +1,6 @@
--- ---
title: "bash tips" title: "bash tips"
tags: [ "Shell", "POSIX" ] tags: [ "Documentation", "Shell", "POSIX" ]
--- ---
## Track Live Changes ## Track Live Changes
@ -30,7 +30,7 @@ There are a bunch of files:
Goal: swap the word "Column" for "Alice" in all files. Goal: swap the word "Column" for "Alice" in all files.
```sh ```
IFS=$'\n' IFS=$'\n'
for f in $(find . -name "Col*"); do for f in $(find . -name "Col*"); do
mv "$f" $(echo "$f" | sed s/Column/Alice/) mv "$f" $(echo "$f" | sed s/Column/Alice/)

Some files were not shown because too many files have changed in this diff Show More