From 0881b6bcab67dc3102dbabc50433754cb0f3a1ab Mon Sep 17 00:00:00 2001 From: ivuorinen Date: Tue, 16 Dec 2025 00:22:14 +0000 Subject: [PATCH] Update cheatsheets --- tldr/astroterm | 2 +- tldr/brittany | 2 +- tldr/bun-pm-migrate | 13 +++++++++++++ tldr/code2prompt | 2 +- tldr/get_iplayer | 10 +++++----- tldr/grip | 2 +- tldr/gunzip | 23 +++-------------------- tldr/gzip | 8 ++++++-- tldr/ipsumdump | 2 +- tldr/linux/compseq | 2 +- tldr/linux/gamescope | 4 ++-- tldr/linux/img2txt | 2 +- tldr/linux/koji-resubmit | 2 +- tldr/linux/rspamc | 2 +- tldr/linux/whiptail | 2 +- tldr/ng-version | 17 +++++++++++++++++ tldr/opt | 2 +- tldr/osx/dhcp6d | 2 +- tldr/paci | 2 +- tldr/pnmcrop | 2 +- tldr/presenterm | 33 +++++++++++++++++++++++++++++++++ tldr/readarray | 8 ++++++++ tldr/sfdk | 23 ++++++++++++++++------- tldr/toipe | 2 +- tldr/zcat | 23 +++-------------------- 25 files changed, 121 insertions(+), 71 deletions(-) create mode 100644 tldr/bun-pm-migrate create mode 100644 tldr/ng-version create mode 100644 tldr/presenterm diff --git a/tldr/astroterm b/tldr/astroterm index c8ad07f0..f633ed08 100644 --- a/tldr/astroterm +++ b/tldr/astroterm @@ -12,7 +12,7 @@ source: https://github.com/tldr-pages/tldr.git `astroterm` -- Display constellations, use colour, and render the simulation at the given frame rate: +- Display constellations, use color, and render the simulation at the given frame rate: `astroterm {{[-C|--constellations]}} {{[-c|--color]}} {{[-f|--fps]}} {{60}}` diff --git a/tldr/brittany b/tldr/brittany index 42deb928..b68c5da2 100644 --- a/tldr/brittany +++ b/tldr/brittany @@ -16,7 +16,7 @@ source: https://github.com/tldr-pages/tldr.git `brittany --write-mode=inplace {{*.hs}}` -- Check whether a Haskell source file needs changes and indicate the result through the programme's exit code: +- Check whether a Haskell source file needs changes and indicate the result through the program's exit code: `brittany --check-mode {{path/to/file.hs}}` diff --git a/tldr/bun-pm-migrate b/tldr/bun-pm-migrate new file mode 100644 index 00000000..62efc588 --- /dev/null +++ b/tldr/bun-pm-migrate @@ -0,0 +1,13 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# bun pm migrate + +> Convert another package manager’s lockfile to a Bun-compatible lockfile without installing anything. +> More information: . + +- Migrate the lockfile in the current project: + +`bun pm migrate` diff --git a/tldr/code2prompt b/tldr/code2prompt index af498ddf..713f3cc5 100644 --- a/tldr/code2prompt +++ b/tldr/code2prompt @@ -8,7 +8,7 @@ source: https://github.com/tldr-pages/tldr.git > Generate AI-ready prompts from a codebase (extracts, filters and formats code for LLMs). > More information: . -- Generate a prompt for the current project and copy it to the clipboard (default behaviour): +- Generate a prompt for the current project and copy it to the clipboard (default behavior): `code2prompt {{path/to/project}}` diff --git a/tldr/get_iplayer b/tldr/get_iplayer index c893ca7f..97e54915 100644 --- a/tldr/get_iplayer +++ b/tldr/get_iplayer @@ -8,23 +8,23 @@ source: https://github.com/tldr-pages/tldr.git > Indexing tool and personal video recorder for BBC iPlayer and BBC Sounds. > More information: . -- Search programmes by name: +- Search programs by name: `get_iplayer "{{program_name}}"` -- Record programme by results of search: +- Record program by results of search: `get_iplayer "{{program_name}}" {{[-g|--get]}}` -- Record programme by URL from the BBC iPlayer website: +- Record program by URL from the BBC iPlayer website: `get_iplayer "https://www.bbc.co.uk/iplayer/episode/{{program_PID}}/{{name-of-show-episode-number-episode-title}}"` -- Download subtitles for a programme by results of search: +- Download subtitles for a program by results of search: `get_iplayer "{{program_name}}" --subtitles-only` -- Search for a programme, record it and download subtitles: +- Search for a program, record it and download subtitles: `get_iplayer "{{program_name}}" {{[-g|--get]}} --subtitles` diff --git a/tldr/grip b/tldr/grip index 630ca26b..4ea84688 100644 --- a/tldr/grip +++ b/tldr/grip @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # grip -> Preview GitHub-flavoured Markdown files locally. +> Preview GitHub-flavored Markdown files locally. > More information: . - Start the server and serve the rendered `README` file of a current directory: diff --git a/tldr/gunzip b/tldr/gunzip index 587e2031..c765e73e 100644 --- a/tldr/gunzip +++ b/tldr/gunzip @@ -5,25 +5,8 @@ source: https://github.com/tldr-pages/tldr.git --- # gunzip -> Extract files from a `gzip` (`.gz`) archive. -> More information: . +> This command is an alias of `gzip --decompress`. -- Extract a file from an archive, replacing the original file if it exists: +- View documentation for the original command: -`gunzip {{archive.tar.gz}}` - -- Extract a file to a target destination: - -`gunzip {{[-c|--stdout]}} {{archive.tar.gz}} > {{archive.tar}}` - -- Extract a file and keep the archive file: - -`gunzip {{[-k|--keep]}} {{archive.tar.gz}}` - -- List the contents of a compressed file: - -`gunzip {{[-l|--list]}} {{file.txt.gz}}` - -- Decompress an archive from `stdin`: - -`cat {{path/to/archive.gz}} | gunzip` +`tldr gzip` diff --git a/tldr/gzip b/tldr/gzip index f725c09c..ca6e9a60 100644 --- a/tldr/gzip +++ b/tldr/gzip @@ -16,6 +16,10 @@ source: https://github.com/tldr-pages/tldr.git `gzip {{[-d|--decompress]}} {{path/to/file.gz}}` +- Display the name and reduction percentage for each file compressed: + +`gzip {{[-v|--verbose]}} {{path/to/file.gz}}` + - Compress a file, keeping the original file: `gzip {{[-k|--keep]}} {{path/to/file}}` @@ -32,6 +36,6 @@ source: https://github.com/tldr-pages/tldr.git `gzip -{{1..9}} {{[-c|--stdout]}} {{path/to/file}} > {{path/to/compressed_file.gz}}` -- Display the name and reduction percentage for each file compressed or decompressed: +- List the contents of a compressed file: -`gzip {{[-vd|--verbose --decompress]}} {{path/to/file.gz}}` +`gzip {{[-l|--list]}} {{path/to/file.txt.gz}}` diff --git a/tldr/ipsumdump b/tldr/ipsumdump index 7f2b04be..1439a741 100644 --- a/tldr/ipsumdump +++ b/tldr/ipsumdump @@ -16,6 +16,6 @@ source: https://github.com/tldr-pages/tldr.git `ipsumdump --interface {{eth0}} -tsSdDp` -- Print the anonymised source address, anonymised destination address, and IP packet length of all packets in a PCAP file: +- Print the anonymized source address, anonymized destination address, and IP packet length of all packets in a PCAP file: `ipsumdump --src --dst --length --anonymize {{path/to/file.pcap}}` diff --git a/tldr/linux/compseq b/tldr/linux/compseq index a2327a12..1fec24eb 100644 --- a/tldr/linux/compseq +++ b/tldr/linux/compseq @@ -28,7 +28,7 @@ source: https://github.com/tldr-pages/tldr.git `compseq -sequence {{path/to/input_rna.fasta}} -word 3 {{path/to/output_file.comp}} -nozero -frame 3` -- Count amino acid triplets in a FASTA file and compare to a previous run of `compseq` to calculate expected and normalised frequency values: +- Count amino acid triplets in a FASTA file and compare to a previous run of `compseq` to calculate expected and normalized frequency values: `compseq -sequence {{path/to/human_proteome.fasta}} -word 3 {{path/to/output_file1.comp}} -nozero -infile {{path/to/output_file2.comp}}` diff --git a/tldr/linux/gamescope b/tldr/linux/gamescope index 0faecce3..9f1b59f6 100644 --- a/tldr/linux/gamescope +++ b/tldr/linux/gamescope @@ -19,11 +19,11 @@ source: https://github.com/tldr-pages/tldr.git - Upscale a 720p game to 1440p with integer scaling: -`gamescope {{[-h|--nested-height]}} 720 {{[-H|--output-height]}} 1440 {{[-S|--scaler]}} integer -- %command%` +`gamescope {{[-h|--nested-height]}} 720 {{[-H|--output-height]}} 1440 {{[-S|--scaler]}} integer -- {{command}}` - Limit a vsynced game to 30 FPS: -`gamescope {{[-r|--nested-refresh]}} 30 -- %command%` +`gamescope {{[-r|--nested-refresh]}} 30 -- {{command}}` - Launch Steam in Big Picture Mode and integrate with gamescope: diff --git a/tldr/linux/img2txt b/tldr/linux/img2txt index f38e3293..48a6e6ce 100644 --- a/tldr/linux/img2txt +++ b/tldr/linux/img2txt @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # img2txt -> Convert images to colour ASCII characters and output them to text-based coloured files. +> Convert images to color ASCII characters and output them to text-based colored files. > More information: . - Set output column count to a specific value: diff --git a/tldr/linux/koji-resubmit b/tldr/linux/koji-resubmit index 245e4605..23f7ef7d 100644 --- a/tldr/linux/koji-resubmit +++ b/tldr/linux/koji-resubmit @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # koji resubmit -> Retry a canceled or failed task, using the same parameter as the original task. +> Retry a cancelled or failed task, using the same parameter as the original task. > More information: . - Resubmit a task: diff --git a/tldr/linux/rspamc b/tldr/linux/rspamc index b82817ba..9a2c9aa9 100644 --- a/tldr/linux/rspamc +++ b/tldr/linux/rspamc @@ -12,7 +12,7 @@ source: https://github.com/tldr-pages/tldr.git `rspamc learn_spam {{path/to/email_file}}` -- Train the bayesian filter to recognise an email as ham: +- Train the bayesian filter to recognize an email as ham: `rspamc learn_ham {{path/to/email_file}}` diff --git a/tldr/linux/whiptail b/tldr/linux/whiptail index f8a4a705..495a5a25 100644 --- a/tldr/linux/whiptail +++ b/tldr/linux/whiptail @@ -17,7 +17,7 @@ source: https://github.com/tldr-pages/tldr.git `whiptail --title "{{title}}" --yesno "{{message}}" {{height_in_chars}} {{width_in_chars}}` -- Customise the text on the yes/no buttons: +- Customize the text on the yes/no buttons: `whiptail --title "{{title}}" --yes-button "{{text}}" --no-button "{{text}}" --yesno "{{message}}" {{height_in_chars}} {{width_in_chars}}` diff --git a/tldr/ng-version b/tldr/ng-version new file mode 100644 index 00000000..7f2103b2 --- /dev/null +++ b/tldr/ng-version @@ -0,0 +1,17 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# ng version + +> Display Angular CLI version. +> More information: . + +- Display version: + +`ng {{[v|version]}}` + +- Display the CLI, framework, system, and project dependency versions in JSON format: + +`ng {{[v|version]}} --json` diff --git a/tldr/opt b/tldr/opt index ff7abba4..7a42fc18 100644 --- a/tldr/opt +++ b/tldr/opt @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # opt -> Run optimizations and analyse LLVM source files. +> Run optimizations and analyze LLVM source files. > More information: . - Run an optimization or analysis on a bitcode file: diff --git a/tldr/osx/dhcp6d b/tldr/osx/dhcp6d index c64f7a8e..e9721efe 100644 --- a/tldr/osx/dhcp6d +++ b/tldr/osx/dhcp6d @@ -6,8 +6,8 @@ source: https://github.com/tldr-pages/tldr.git # dhcp6d > Stateless DHCPv6 server. -> See also: `InternetSharing`. > It should not be invoked manually. +> See also: `InternetSharing`. > More information: . - Start the daemon: diff --git a/tldr/paci b/tldr/paci index f82d4016..9951786a 100644 --- a/tldr/paci +++ b/tldr/paci @@ -12,7 +12,7 @@ source: https://github.com/tldr-pages/tldr.git `paci refresh` -- Configure its behaviour: +- Configure its behavior: `paci configure` diff --git a/tldr/pnmcrop b/tldr/pnmcrop index b986ec11..ddcbb1ae 100644 --- a/tldr/pnmcrop +++ b/tldr/pnmcrop @@ -20,6 +20,6 @@ source: https://github.com/tldr-pages/tldr.git `pnmcrop -bg-corner {{topleft|topright|bottomleft|bottomright}} {{path/to/image.pnm}} > {{path/to/output.pnm}}` -- Leave a border with a width of `n` pixels. Additionally, specify the behaviour if the image is entirely made out of background: +- Leave a border with a width of `n` pixels. Additionally, specify the behavior if the image is entirely made out of background: `pnmcrop {{[-m|-margin]}} {{n}} {{[-blan|-blank-image]}} {{pass|minimize|maxcrop}} {{path/to/image.pnm}} > {{path/to/output.pnm}}` diff --git a/tldr/presenterm b/tldr/presenterm new file mode 100644 index 00000000..1fc888ac --- /dev/null +++ b/tldr/presenterm @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# presenterm + +> A terminal-based slideshow tool that renders markdown presentations. +> More information: . + +- Display a presentation: + +`presenterm {{path/to/slides.md}}` + +- Display a presentation with a specific theme: + +`presenterm --theme {{dark|light|tokyonight-storm|...}} {{path/to/slides.md}}` + +- List all available themes: + +`presenterm --list-themes` + +- Export a presentation to PDF: + +`presenterm --export-pdf --output {{path/to/output.pdf}} {{path/to/slides.md}}` + +- Display a presentation with code snippet execution enabled: + +`presenterm --enable-snippet-execution {{path/to/slides.md}}` + +- Validate that presentation content fits within the terminal: + +`presenterm --validate-overflows {{path/to/slides.md}}` diff --git a/tldr/readarray b/tldr/readarray index a587a60b..ffddd790 100644 --- a/tldr/readarray +++ b/tldr/readarray @@ -24,6 +24,14 @@ source: https://github.com/tldr-pages/tldr.git `readarray < {{path/to/file.txt}} -n {{n}} {{array_name}}` +- Skip the first `n` lines: + +`readarray < {{path/to/file.txt}} -s {{n}} {{array_name}}` + +- Define a custom delimiter: + +`readarray < {{path/to/file.txt}} -d {{delimiter}} {{array_name}}` + - Display help: `help mapfile` diff --git a/tldr/sfdk b/tldr/sfdk index d4df2cb5..46880c05 100644 --- a/tldr/sfdk +++ b/tldr/sfdk @@ -6,23 +6,32 @@ source: https://github.com/tldr-pages/tldr.git # sfdk > Frontend of the Sailfish SDK. +> Some subcommands such as `init`, `build-init`, `device` have their own usage documentation. > More information: . -- Execute a subcommand: +- Setup the current environment for building for SailfishOS with a specific versions and architecture target: -`sfdk {{subcommand}}` +`sfdk config target=SailfishOS-{{5.0.0.62}}-{{aarch64}}` -- Execute a subcommand on a custom working directory: +- Initialize the current directory as the build directory: -`git -C {{path/to/directory}} {{subcommand}}` +`sfdk build-init` -- Execute a subcommand with a given configuration set: +- Execute build steps of the RPM SPEC file for a specific project: -`git -c '{{name}}={{value}}' {{subcommand}}` +`sfdk -C {{path/to/project}} build` + +- List repositories in the SailfishOS 5.0.0.62 armv7hl build target: + +`sfdk -c 'target=SailfishOS-5.0.0.62-armv7hl' build-shell --maintain ssu lr` + +- Deploy the package to the emulator: + +`sfdk config device="{{Sailfish OS Emulator 5.0.0.62}}"; sfdk deploy --sdk` - Display help: -`sfdk {{[-h|--help]}}` +`sfdk --help` - Display help for specific topic (`building`, `testing`, `maintaining`, `ide`, `all`): diff --git a/tldr/toipe b/tldr/toipe index dd1f4a36..40d4dc4a 100644 --- a/tldr/toipe +++ b/tldr/toipe @@ -5,7 +5,7 @@ source: https://github.com/tldr-pages/tldr.git --- # toipe -> Yet another typing test, but crab flavoured. +> Yet another typing test, but crab flavored. > A trusty terminal typing tester. > More information: . diff --git a/tldr/zcat b/tldr/zcat index 6a61574f..8f120bf8 100644 --- a/tldr/zcat +++ b/tldr/zcat @@ -5,25 +5,8 @@ source: https://github.com/tldr-pages/tldr.git --- # zcat -> Print data from `gzip` compressed files to `stdout`. -> More information: . +> This command is an alias of `gzip --stdout --decompress`. -- Print the uncompressed contents of a `gzip` archive to `stdout`: +- View documentation for the original command: -`zcat {{path/to/file.txt.gz}}` - -- Print compression details of a `gzip` archive to `stdout`: - -`zcat {{[-l|--list]}} {{path/to/file.txt.gz}}` - -- Test the integrity of a compressed file verbosely: - -`zcat {{[-v|--verbose]}} {{[-t|--test]}} {{path/to/file.txt.gz}}` - -- Suppress all warnings when decompressing a file: - -`zcat {{[-q|--quiet]}} {{path/to/file.txt.gz}}` - -- Avoid any system crashes when decompressing a file (slower output): - -`zcat --synchronous {{path/to/file.txt.gz}}` +`tldr gzip`