*: adhere to the style guide (#22052)

2026-08-26 14:13:36 +01:00 · 2026-04-15 16:47:18 +07:00
parent fac0692ce5
commit 3ad691c364
25 changed files with 30 additions and 30 deletions
@@ -27,7 +27,7 @@

 `bd update {{issue_id}} {{[-s|--status]}} {{open|in_progress|blocked|closed}}`

- Manually sync changes and import latest from git:
+- Manually sync changes and import latest from Git:

 `bd sync`

@@ -1,6 +1,6 @@
 # bfg

-> Remove large files or passwords from Git history like git-filter-branch.
+> Remove large files or passwords from Git history like `git filter-branch`.
 > Note: If your repository is connected to a remote, you will need to force push to it.
 > More information: <https://rtyley.github.io/bfg-repo-cleaner/>.

@@ -23,7 +23,7 @@

 `bun pm pack --ignore-scripts`

- Set the gzip compression level (0-9, default: 9):
+- Set the `gzip` compression level (0-9, default: 9):

 `bun pm pack --gzip-level 5`

@@ -1,6 +1,6 @@
 # f3read

-> Validate .h2w files to test the real capacity of the drive.
+> Validate `.h2w` files to test the real capacity of the drive.
 > See also: `f3write`, `f3probe`, `f3fix`.
 > More information: <https://oss.digirati.com.br/f3/>.

@@ -1,6 +1,6 @@
 # f3write

-> Fill a drive out with .h2w files to test its real capacity.
+> Fill a drive out with `.h2w` files to test its real capacity.
 > See also: `f3read`, `f3probe`, `f3fix`.
 > More information: <https://oss.digirati.com.br/f3/>.

@@ -7,10 +7,10 @@

 `funzip {{path/to/archive.zip}}`

- Print the content in a gzip archive:
+- Print the content in a `gzip` archive:

 `funzip {{path/to/archive.gz}}`

- Decrypt a Zip or gzip archive and print the content:
+- Decrypt a Zip or `gzip` archive and print the content:

 `funzip -password {{password}} {{path/to/archive}}`
@@ -24,6 +24,6 @@

 `git guilt 'git log --until "3 weeks ago" --format "%H" {{[-n|--max-count]}} 1'`

- Find blame delta over the last three weeks (git 1.8.5+):
+- Find blame delta over the last three weeks (Git 1.8.5+):

 `git guilt @{3.weeks.ago}`
@@ -7,7 +7,7 @@

 `ioping .`

- Measure latency on /tmp using 10 requests of 1 megabyte each:
+- Measure latency on `/tmp` using 10 requests of 1 megabyte each:

 `ioping {{[-c|-count]}} 10 {{[-s|-size]}} 1M /tmp`

@@ -3,7 +3,7 @@
 > Monitor a process and trigger a banner notification.
 > More information: <https://github.com/variadico/noti/blob/main/docs/noti.md>.

- Display a notification when tar finishes compressing files:
+- Display a notification when `tar` finishes compressing files:

 `noti {{tar -cjf example.tar.bz2 example/}}`

@@ -7,7 +7,7 @@

 `patator ssh_login host={{ip_or_host}} user=FILE0 password=FILE1 0={{path/to/users.txt}} 1={{path/to/passwords.txt}} --rate_limit={{seconds}} --timeout={{seconds}} -x ignore:mesg='Authentication failed.'`

- Brute force encrypted zip file:
+- Brute force encrypted ZIP file:

 `patator unzip_pass zipfile={{path/to/file.zip}} password=FILE0 0={{path/to/passwords.txt}} -x ignore:code!=0`

@@ -27,7 +27,7 @@

 `pg_receivewal --synchronous {{[-D|--directory]}} {{directory}} {{[-h|--host]}} {{host}} {{[-p|--port]}} {{port}} {{[-U|--username]}} {{username}}`

- Compress WAL output (gzip, level 0-9):
+- Compress WAL output (`gzip`, level 0-9):

 `pg_receivewal {{[-Z|--compress]}} {{level|method}} {{[-D|--directory]}} {{directory}} {{[-h|--host]}} {{host}} {{[-p|--port]}} {{port}} {{[-U|--username]}} {{username}}`

@@ -3,7 +3,7 @@
 > PHPUnit test runner.
 > More information: <https://docs.phpunit.de/en/12.4/textui.html#command-line-options>.

- Run tests in the current directory. Note: Expects you to have a 'phpunit.xml':
+- Run tests in the current directory. Note: Expects you to have a `phpunit.xml'`:

 `phpunit`

@@ -4,7 +4,7 @@
 > See also: `podman import`, `podman save`.
 > More information: <https://docs.podman.io/en/latest/markdown/podman-export.1.html>.

- Export a container's filesystem to a tar file:
+- Export a container's filesystem to a `.tar` file:

 `podman export {{[-o|--output]}} {{path/to/file.tar}} {{container_name_or_id}}`

@@ -4,11 +4,11 @@
 > See also: `podman save`, `podman import`.
 > More information: <https://docs.podman.io/en/latest/markdown/podman-load.1.html>.

- Load an image from a tar file:
+- Load an image from a `.tar` file:

 `podman load {{[-i|--input]}} {{path/to/file.tar}}`

- Load an image from a compressed tar file:
+- Load an image from a compressed `.tar` file:

 `podman load {{[-i|--input]}} {{path/to/file.tar[.gz|.bz2|.xz|.zst]}}`

@@ -4,7 +4,7 @@
 > See also: `podman load`, `podman export`.
 > More information: <https://docs.podman.io/en/latest/markdown/podman-save.1.html>.

- Save an image to a tar file:
+- Save an image to a `.tar` file:

 `podman save {{[-o|--output]}} {{path/to/file.tar}} {{image:tag}}`

@@ -8,7 +8,7 @@

 `ssh-add`

- Add a specific key to the ssh-agent:
+- Add a specific key to the `ssh-agent`:

 `ssh-add {{path/to/private_key}}`

@@ -16,14 +16,14 @@

 `ssh-add -l`

- Delete a key from the ssh-agent:
+- Delete a key from the `ssh-agent`:

 `ssh-add -d {{path/to/private_key}}`

- Delete all currently loaded keys from the ssh-agent:
+- Delete all currently loaded keys from the `ssh-agent`:

 `ssh-add -D`

- Add a key to the ssh-agent and the keychain:
+- Add a key to the `ssh-agent` and the keychain:

 `ssh-add -K {{path/to/private_key}}`
@@ -23,7 +23,7 @@

 `xidel {{https://example.org}} {{[-f|--follow]}} "{{<a>{.}</a>*}}" {{[-e|--extract]}} "{{<title>{.}</title>}}"`

- Read the pattern from example.xml (which will also check if the element containing "ood" is there, and fail otherwise):
+- Read the pattern from `example.xml` (which will also check if the element containing "ood" is there, and fail otherwise):

 `xidel {{path/to/example.xml}} {{[-e|--extract]}} "{{<x><foo>ood</foo><bar>{.}</bar></x>}}"`

@@ -3,7 +3,7 @@
 > Compress or decompress XZ and LZMA files.
 > More information: <https://manned.org/xz>.

- Compress a file using xz:
+- Compress a file into XZ format:

 `xz {{path/to/file}}`

@@ -1,6 +1,6 @@
 # yadm git-crypt

-> Git Crypt enables transparent encryption and decryption of files in a git repository.
+> Git Crypt enables transparent encryption and decryption of files in a Git repository.
 > More information: <https://github.com/AGWA/git-crypt>.

 - Initialize repo to use Git Crypt:
@@ -23,6 +23,6 @@

 `CONFIG -set "dos ems=off"`

- Get property value (stored in %CONFIG%):
+- Get property value (stored in `%CONFIG%`):

 `CONFIG -get "cpu core"`
@@ -1,6 +1,6 @@
 # engrampa

-> Package files into zip/tar file in MATE desktop environment.
+> Package files into zip/`.tar` file in MATE desktop environment.
 > See also: `zip`, `tar`.
 > More information: <https://github.com/mate-desktop/engrampa>.

@@ -11,7 +11,7 @@

 `sudo importctl pull-raw {{https://example.com/source.ext}} {{name}} --class={{machine|portable|sysext|confext}}`

- Import a raw disk image into the image directory that is possibly compressed with xz, gzip, or bzip2:
+- Import a raw disk image into the image directory that is possibly compressed with `xz`, `gzip`, or `bzip2`:

 `importctl import-raw {{path/to/file.ext}} {{name}} --class={{machine|portable|sysext|confext}}`

@@ -20,6 +20,6 @@

 `sudo pkgtool --install_menu`

- Set up packages interactively (run doinst.sh scripts):
+- Set up packages interactively (run `doinst.sh` scripts):

 `sudo pkgtool --setup_menu`
@@ -1,6 +1,6 @@
 # uinput

-> Intercept and write input events to a virtual keyboard device using /dev/uinput.
+> Intercept and write input events to a virtual keyboard device using `/dev/uinput`.
 > More information: <https://gitlab.com/interception/linux/tools/-/tree/master#uinput>.

 - Show resulting YAML device description merge and exit (dry-run):
@@ -7,7 +7,7 @@

 `sudo route add "{{destination_ip_address}}" "{{gateway_address}}"`

- Add a route to a /24 subnet through a gateway:
+- Add a route to a `/24` subnet through a gateway:

 `sudo route add "{{subnet_ip_address}}/24" "{{gateway_address}}"`