diff --git a/tldr/in-toto-run b/tldr/in-toto-run index 3d9c3c30..945b750b 100644 --- a/tldr/in-toto-run +++ b/tldr/in-toto-run @@ -22,4 +22,4 @@ source: https://github.com/tldr-pages/tldr.git - Scan the image using Trivy and generate link file: -`in-toto-run {{[-n|--step-name]}} {{scan}} -k {{key_file}} {{[-p|--products]}} {{report.json}} -- {{/bin/sh -c "trivy {{[-o|--output]}} report.json {{[-f|--format]}} json "}}` +`in-toto-run {{[-n|--step-name]}} {{scan}} -k {{key_file}} {{[-p|--products]}} {{report.json}} -- {{/bin/sh -c "trivy --output report.json --format json "}}` diff --git a/tldr/ippeveps b/tldr/ippeveps index f171377e..7dd581bc 100644 --- a/tldr/ippeveps +++ b/tldr/ippeveps @@ -16,4 +16,4 @@ source: https://github.com/tldr-pages/tldr.git - Print a file from `stdin` to `stdout`: -`{{wget {{[-O|--output-document]}} - https://example.com/file}} | ippeveps` +`{{wget --output-document - https://example.com/file}} | ippeveps` diff --git a/tldr/linux/counter-strike-2 b/tldr/linux/counter-strike-2 index 814f087c..c1be36be 100644 --- a/tldr/linux/counter-strike-2 +++ b/tldr/linux/counter-strike-2 @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Run a game with specified maximum number of players: -`{{path/to/cs2}} -dedicated +map {{de_dust2}} -maxplayers {{64}}` +`{{path/to/cs2}} -dedicated +map {{de_dust2}} -maxplayers {{64}}` - Run a game with specified server IP and port: diff --git a/tldr/linux/eu-readelf b/tldr/linux/eu-readelf index c2c4ab8f..82928924 100644 --- a/tldr/linux/eu-readelf +++ b/tldr/linux/eu-readelf @@ -14,4 +14,4 @@ source: https://github.com/tldr-pages/tldr.git - Display the contents of all NOTE segments/sections, or of a particular segment/section: -`eu-readelf {{[-n--notes]}} {{.note.ABI-tag}} {{path/to/file}}` +`eu-readelf {{[-n|--notes]}} {{.note.ABI-tag}} {{path/to/file}}` diff --git a/tldr/linux/hwinfo b/tldr/linux/hwinfo index 5401c70f..63e06c62 100644 --- a/tldr/linux/hwinfo +++ b/tldr/linux/hwinfo @@ -8,17 +8,17 @@ source: https://github.com/tldr-pages/tldr.git > Probe for the hardware present in the system. > More information: . -- Get graphics card information: +- Display all available hardware information: -`hwinfo --gfxcard` +`hwinfo` -- Get network device information: +- Display information about a specific hardware component: -`hwinfo --network` +`hwinfo --{{cpu|memory|disk|gfxcard|network|usb|pci|keyboard|mouse|monitor|sound|fingerprint|...}}` -- List disks and CD-ROM drives, abbreviating the output: +- Display information about a specific hardware component succinctly: -`hwinfo --short --disk --cdrom` +`hwinfo {{--component}} --short` - Write all hardware information to a file: diff --git a/tldr/linux/links b/tldr/linux/links index cb3e52d6..d837f140 100644 --- a/tldr/linux/links +++ b/tldr/linux/links @@ -22,11 +22,11 @@ source: https://github.com/tldr-pages/tldr.git - Navigate forwards and backwards through the links on a page: -`{{ArrowUp|ArrowDown}}` +`{{|}}` - Go forwards and backwards one page: -`{{ArrowLeft|ArrowRight}}` +`{{|}}` - Exit: diff --git a/tldr/linux/pasuspender b/tldr/linux/pasuspender index 89d19d1c..e7ec5f32 100644 --- a/tldr/linux/pasuspender +++ b/tldr/linux/pasuspender @@ -10,4 +10,4 @@ source: https://github.com/tldr-pages/tldr.git - Suspend PulseAudio while running `jackd`: -`pasuspender -- {{jackd {{[-d|--driver]}} alsa {{[-d|--device]}} hw:0}}` +`pasuspender -- {{jackd --driver alsa --device hw:0}}` diff --git a/tldr/linux/screenkey b/tldr/linux/screenkey index 6c6c73fb..3fa52f6a 100644 --- a/tldr/linux/screenkey +++ b/tldr/linux/screenkey @@ -34,4 +34,4 @@ source: https://github.com/tldr-pages/tldr.git - Drag and select a window on screen to display screenkey: -`screenkey {{[-p|--position]}} fixed {{[-g|--geometry]}} {{$(slop {{[-n|--nodecorations]}} {{[-f|--format]}} '%g')}}` +`screenkey {{[-p|--position]}} fixed {{[-g|--geometry]}} {{$(slop --nodecorations --format '%g')}}` diff --git a/tldr/mpic++ b/tldr/mpic++ index 2871c592..c5efbf4b 100644 --- a/tldr/mpic++ +++ b/tldr/mpic++ @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Open MPI wrapper compiler for C++. > See also: `mpirun`. -> More information: . +> More information: . - Compile an Open MPI program: diff --git a/tldr/mpicc b/tldr/mpicc index 04a92445..15693230 100644 --- a/tldr/mpicc +++ b/tldr/mpicc @@ -6,7 +6,6 @@ source: https://github.com/tldr-pages/tldr.git # mpicc > Open MPI C wrapper compiler. -> The wrappers are simply thin shells on top of a C compiler, they add the relevant compiler and linker flags to the command-line that are necessary to compile/link Open MPI programs, and then invoke the underlying C compiler to actually perform the command. > More information: . - Compile a source code file into an object file: diff --git a/tldr/openocd b/tldr/openocd new file mode 100644 index 00000000..2aba7342 --- /dev/null +++ b/tldr/openocd @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# openocd + +> Debug and program embedded systems with OpenOCD. +> More information: . + +- Attach OpenOCD session to a board with a configuration file: + +`openocd {{[-f|--file]}} {{config_file.cfg}}` + +- Attach OpenOCD session to a board with multiple configuration files: + +`openocd {{[-f|--file]}} {{config_file1.cfg}} {{[-f|--file]}} {{config_file2.cfg}}` + +- Attach OpenOCD session to a board with configuration files and a list of commands to be executed on server startup: + +`openocd {{[-f|--file]}} {{config_file.cfg}} {{[-c|--command]}} "{{command}}"` + +- Use configuration files in the specified path: + +`openocd {{[-s|--search]}} {{path/to/search}} {{[-f|--file]}} {{config_file.cfg}}` + +- After OpenOCD startup, connect GDB to OpenOCD default port 3333: + +`target extended-remote localhost` + +- List site-wide script library: + +`ls /usr/local/share/openocd/scripts` diff --git a/tldr/pueue-add b/tldr/pueue-add index d7947a34..13f7ae15 100644 --- a/tldr/pueue-add +++ b/tldr/pueue-add @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - Add a command but do not start it if it's the first in a queue: -`pueue add {{[-s|--stashed]}} -- {{rsync {{[-a|--archive]}} {{[-z|--compress]}} /local/directory /remote/directory}}` +`pueue add {{[-s|--stashed]}} -- {{rsync --archive --compress /local/directory /remote/directory}}` - Add a command to a group and start it immediately, see `pueue group` to manage groups: diff --git a/tldr/pulumi-policy b/tldr/pulumi-policy new file mode 100644 index 00000000..01af694d --- /dev/null +++ b/tldr/pulumi-policy @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# pulumi policy + +> Manage resource policies on Pulumi Cloud (Business Critical) or locally (no organization sub-commands). +> More information: . + +- Create a new Pulumi Policy Pack from a template or URL: + +`pulumi policy new --dir {{path/to/directory}} {{template|url}}` + +- Validate syntax of a policy. To check a policy against a project use `pulumi preview`: + +`pulumi policy validate-config {{organization_name}}/{{policy_pack_name}} {{version}}` + +- List all policies for an organization: + +`pulumi policy ls {{[-j|--json]}} {{organization_name}}` + +- Publish a policy to the Pulumi Cloud: + +`pulumi policy publish {{organization_name}}` + +- Enable a policy with a specific version: + +`pulumi policy enable {{organization_name}}/{{policy_pack_name}} {{latest|version}}` + +- Disable a policy with a specific version (defaults to all versions): + +`pulumi policy disable {{organization_name}}/{{policy_pack_name}} --version {{version}}` + +- Display help: + +`pulumi policy {{[-h|--help]}}` diff --git a/tldr/pulumi-preview b/tldr/pulumi-preview index 0f16b0b8..3db7d40c 100644 --- a/tldr/pulumi-preview +++ b/tldr/pulumi-preview @@ -20,6 +20,10 @@ source: https://github.com/tldr-pages/tldr.git `pulumi preview --diff` +- Preview updates using a Policy Pack (without Pulumi Cloud, best on CI/CD): + +`pulumi preview --policy-pack {{path/to/directory}}` + - Display help: `pulumi preview {{[-h|--help]}}` diff --git a/tldr/wezterm b/tldr/wezterm index f5e310a6..7019a4b1 100644 --- a/tldr/wezterm +++ b/tldr/wezterm @@ -6,13 +6,14 @@ source: https://github.com/tldr-pages/tldr.git # wezterm > Wez's Terminal Emulator - a powerful cross-platform terminal emulator and multiplexer. +> Some subcommands such as `cli` have their own usage documentation. > More information: . - Start a new Wezterm process and create a window: `wezterm` -- Establish an `ssh` session: +- Establish an `ssh` session in a new Wezterm window: `wezterm ssh {{user}}@{{host}}:{{port}}` @@ -24,11 +25,11 @@ source: https://github.com/tldr-pages/tldr.git `wezterm imgcat {{path/to/image}}` -- Record a terminal session as an asciicat (by default recordings are found in `/tmp`): +- Record a terminal session as an asciicast (by default recordings are saved to `/tmp`): `wezterm record` -- Replay an asciicat terminal session: +- Replay an asciicast terminal session: `wezterm replay {{path/to/cast_file}}` diff --git a/tldr/wezterm-cli b/tldr/wezterm-cli new file mode 100644 index 00000000..24a5a24b --- /dev/null +++ b/tldr/wezterm-cli @@ -0,0 +1,25 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# wezterm cli + +> Interact with a running Wezterm GUI or multiplexer. +> More information: . + +- List windows, tabs, and panes: + +`wezterm cli list` + +- Split the current pane and print the new pane's ID to `stdout`: + +`wezterm cli split-pane --{{left|right|top|bottom}} --{{cells|percent}} {{n}}` + +- Activate (focus) a pane: + +`wezterm cli activate-pane --pane-id {{id}}` + +- Kill a pane: + +`wezterm cli kill-pane --pane-id {{id}}` diff --git a/tldr/x8 b/tldr/x8 index a920cb46..acbac3f5 100644 --- a/tldr/x8 +++ b/tldr/x8 @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - Send parameters via POST body with JSON format: -`x8 {{[-u|--url]}} {{https://example.com/}} {{[-X|--method]}} {{POST}} {{[-b|--body]}} {{'{"x":{%s}}'}} {{[-w|--wordlist]}} {{path/to/wordlist.txt}}` +`x8 {{[-u|--url]}} {{https://example.com/}} {{[-X|--method]}} {{POST}} {{[-b|--body]}} {{'{"x":{%s\}\}'}} {{[-w|--wordlist]}} {{path/to/wordlist.txt}}` - Check parameters with a custom template (`%k` for key, `%v` for value):