diff --git a/tldr/linux/gpu-screen-recorder b/tldr/linux/gpu-screen-recorder new file mode 100644 index 00000000..157f7c01 --- /dev/null +++ b/tldr/linux/gpu-screen-recorder @@ -0,0 +1,37 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# gpu-screen-recorder + +> Record the screen and encode the video with a GPU. +> More information: . + +- Select a source using a desktop portal and record it: + +`gpu-screen-recorder -w portal -o {{path/to/video.mp4}}` + +- Specify a specific video source: + +`gpu-screen-recorder -w {{screen|DP-1|HDMI-A1|...}} -o {{path/to/video.mp4}}` + +- List video capture sources: + +`gpu-screen-recorder --list-capture-options` + +- List audio capture sources: + +`gpu-screen-recorder {{--list-audio-devices|--list-application-audio}}` + +- Record using the replay buffer: + +`gpu-screen-recorder -w {{screen}} -r {{30}} -c {{mp4}} -ro {{path/to/directory}} -o {{whatever}}` + +- Capture a video from the replay buffer: + +`pkill -SIGUSR1 -f gpu-screen-recorder` + +- Run `gpu-screen-recorder` in the background: + +`systemctl start --user gpu-screen-recorder` diff --git a/tldr/linux/loadkeys b/tldr/linux/loadkeys index 71bc6d26..60d5c35d 100644 --- a/tldr/linux/loadkeys +++ b/tldr/linux/loadkeys @@ -11,7 +11,7 @@ source: https://github.com/tldr-pages/tldr.git - Load a specific keyboard layout for the current console: -`sudo loadkeys {{en|de|fi|dvorak|...}}` +`sudo loadkeys {{en|de|fi|dvorak|defkeymap|...}}` - Load a default keymap: diff --git a/tldr/npm b/tldr/npm index 11432f4a..07343965 100644 --- a/tldr/npm +++ b/tldr/npm @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > JavaScript and Node.js package manager. > Manage Node.js projects and their module dependencies. -> More information: . +> More information: . - Create a `package.json` file with default values (omit `--yes` to do it interactively): @@ -15,28 +15,28 @@ source: https://github.com/tldr-pages/tldr.git - Download all the packages listed as dependencies in `package.json`: -`npm install` +`npm {{[i|install]}}` - Download a specific version of a package and add it to the list of dependencies in `package.json`: -`npm install {{package_name}}@{{version}}` +`npm {{[i|install]}} {{package_name}}@{{version}}` - Download the latest version of a package and add it to the list of dev dependencies in `package.json`: -`npm install {{package_name}} {{[-D|--save-dev]}}` +`npm {{[i|install]}} {{package_name}} {{[-D|--save-dev]}}` - Download the latest version of a package and install it globally: -`npm install {{[-g|--global]}} {{package_name}}` +`npm {{[i|install]}} {{[-g|--global]}} {{package_name}}` - Uninstall a package and remove it from the list of dependencies in `package.json`: -`npm uninstall {{package_name}}` +`npm {{[r|uninstall]}} {{package_name}}` - List all locally installed dependencies: -`npm list` +`npm {{[ls|list]}}` - List all top-level globally installed packages: -`npm list {{[-g|--global]}} --depth {{0}}` +`npm {{[ls|list]}} {{[-g|--global]}} --depth {{0}}` diff --git a/tldr/npm-bugs b/tldr/npm-bugs index 245da511..4a56569c 100644 --- a/tldr/npm-bugs +++ b/tldr/npm-bugs @@ -19,8 +19,8 @@ source: https://github.com/tldr-pages/tldr.git - Configure the browser used to open URLs by setting your preferred browser for `npm` commands: -`npm config set browser {{browser_name}}` +`npm {{[c|config]}} set browser {{browser_name}}` - Control URL opening: set `browser` to `true` for the system URL opener, or `false` to print URLs in the terminal: -`npm config set browser {{true|false}}` +`npm {{[c|config]}} set browser {{true|false}}` diff --git a/tldr/npm-cache b/tldr/npm-cache index 705e2eaf..77d5285d 100644 --- a/tldr/npm-cache +++ b/tldr/npm-cache @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # npm cache > Manage the npm package cache. -> More information: . +> More information: . - Add a specific package to the cache: @@ -34,8 +34,8 @@ source: https://github.com/tldr-pages/tldr.git - Show the cache path: -`npm config get cache` +`npm {{[c|config]}} get cache` - Change the cache path: -`npm config set cache {{path/to/directory}}` +`npm {{[c|config]}} set cache {{path/to/directory}}` diff --git a/tldr/npm-check b/tldr/npm-check index 3a00df4c..45435562 100644 --- a/tldr/npm-check +++ b/tldr/npm-check @@ -3,7 +3,7 @@ syntax: markdown tags: [tldr, common] source: https://github.com/tldr-pages/tldr.git --- -# npm check +# npm-check > Check for outdated, incorrect, and unused npm package dependencies. > More information: . diff --git a/tldr/npm-ci b/tldr/npm-ci index 55177639..a2ea5028 100644 --- a/tldr/npm-ci +++ b/tldr/npm-ci @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Clean install of `npm` project dependencies for automated environments. > Installs packages based on `package-lock.json` or `npm-shrinkwrap.json`. -> More information: . +> More information: . - Install project dependencies from `package-lock.json` or `npm-shrinkwrap.json`: diff --git a/tldr/npm-config b/tldr/npm-config index f91f7625..1d2dcd4d 100644 --- a/tldr/npm-config +++ b/tldr/npm-config @@ -3,35 +3,35 @@ syntax: markdown tags: [tldr, common] source: https://github.com/tldr-pages/tldr.git --- -# npm-config +# npm config > Manage the `npm` configuration settings. -> More information: . +> More information: . - Show all configuration settings: -`npm config list` +`npm {{[c|config]}} list` - List all configuration settings as `JSON`: -`npm config list --json` +`npm {{[c|config]}} list --json` - Get the value of a specific configuration key: -`npm config get {{key}}` +`npm {{[c|config]}} get {{key}}` - Set a configuration key to a specific value: -`npm config set {{key}} {{value}}` +`npm {{[c|config]}} set {{key}} {{value}}` - Delete a configuration key: -`npm config delete {{key}}` +`npm {{[c|config]}} delete {{key}}` - Edit the global npm configuration file in the default editor: -`npm config edit` +`npm {{[c|config]}} edit` - Attempt to repair invalid configuration items: -`npm config fix` +`npm {{[c|config]}} fix` diff --git a/tldr/npm-dedupe b/tldr/npm-dedupe index 98c050e2..7307c17c 100644 --- a/tldr/npm-dedupe +++ b/tldr/npm-dedupe @@ -6,28 +6,28 @@ source: https://github.com/tldr-pages/tldr.git # npm dedupe > Reduce duplication in the `node_modules` directory. -> More information: . +> More information: . - Deduplicate packages in `node_modules`: -`npm dedupe` +`npm {{[ddp|dedupe]}}` - Follow `package-lock.json` or `npm-shrinkwrap.json` during deduplication: -`npm dedupe --lock` +`npm {{[ddp|dedupe]}} --lock` - Run deduplication in strict mode: -`npm dedupe --strict` +`npm {{[ddp|dedupe]}} --strict` - Skip optional/peer dependencies during deduplication: -`npm dedupe --omit {{optional|peer}}` +`npm {{[ddp|dedupe]}} --omit {{optional|peer}}` - Enable detailed logging for troubleshooting: -`npm dedupe --loglevel verbose` +`npm {{[ddp|dedupe]}} --loglevel verbose` - Limit deduplication to a specific package: -`npm dedupe {{package_name}}` +`npm {{[ddp|dedupe]}} {{package_name}}` diff --git a/tldr/npm-deprecate b/tldr/npm-deprecate index be7f9e93..338ea4f6 100644 --- a/tldr/npm-deprecate +++ b/tldr/npm-deprecate @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # npm deprecate > Mark a version or range of versions of an `npm` package as deprecated. -> More information: . +> More information: . - Deprecate a specific version of a package: diff --git a/tldr/npm-doctor b/tldr/npm-doctor index 1d97ba64..ac84bcdf 100644 --- a/tldr/npm-doctor +++ b/tldr/npm-doctor @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # npm doctor > Check the health of the npm environment. -> More information: . +> More information: . - Run all default health checks for `npm`: diff --git a/tldr/npm-find-dupes b/tldr/npm-find-dupes index e9828704..f012ae81 100644 --- a/tldr/npm-find-dupes +++ b/tldr/npm-find-dupes @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # npm find-dupes > Identify duplicate dependencies in `node_modules`. -> More information: . +> More information: . - List all duplicate packages within `node_modules`: diff --git a/tldr/npm-fund b/tldr/npm-fund index bec286ab..472478d1 100644 --- a/tldr/npm-fund +++ b/tldr/npm-fund @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # npm fund > Retrieve funding information from packages. -> More information: . +> More information: . - List dependencies with funding URL for the project in the current directory: diff --git a/tldr/npm-init b/tldr/npm-init index 3a6ba250..356ceb2e 100644 --- a/tldr/npm-init +++ b/tldr/npm-init @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # npm init > Create a `package.json` file. -> More information: . +> More information: . - Initialize a new package with prompts: diff --git a/tldr/npm-install b/tldr/npm-install index 78951f28..7bed580c 100644 --- a/tldr/npm-install +++ b/tldr/npm-install @@ -6,20 +6,20 @@ source: https://github.com/tldr-pages/tldr.git # npm install > Install Node packages. -> More information: . +> More information: . - Install dependencies listed in `package.json`: -`npm install` +`npm {{[i|install]}}` - Download a specific version of a package and add it to the list of dependencies in `package.json`: -`npm install {{package_name}}@{{version}}` +`npm {{[i|install]}} {{package_name}}@{{version}}` - Download the latest version of a package and add it to the list of dev dependencies in `package.json`: -`npm install {{package_name}} {{[-D|--save-dev]}}` +`npm {{[i|install]}} {{package_name}} {{[-D|--save-dev]}}` - Download the latest version of a package and install it globally: -`npm install {{[-g|--global]}} {{package_name}}` +`npm {{[i|install]}} {{[-g|--global]}} {{package_name}}` diff --git a/tldr/npm-login b/tldr/npm-login index cc2c4764..afaea46a 100644 --- a/tldr/npm-login +++ b/tldr/npm-login @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Log in to a registry user account. > See also: `npm logout` for logging out. -> More information: . +> More information: . - Log in to a registry user account and save the credentials to the `.npmrc` file: diff --git a/tldr/npm-logout b/tldr/npm-logout index 3b76560a..cae5f5db 100644 --- a/tldr/npm-logout +++ b/tldr/npm-logout @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Log out of the registry user account. > See also: `npm login` for logging in. -> More information: . +> More information: . - Log out of the registry user account: diff --git a/tldr/npm-ls b/tldr/npm-ls index d0ee4844..6ca85dc9 100644 --- a/tldr/npm-ls +++ b/tldr/npm-ls @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # npm ls > Print installed packages to `stdout`. -> More information: . +> More information: . - Print all versions of direct dependencies to `stdout`: diff --git a/tldr/npm-name b/tldr/npm-name index 13e2cf3e..a2134a38 100644 --- a/tldr/npm-name +++ b/tldr/npm-name @@ -3,7 +3,7 @@ syntax: markdown tags: [tldr, common] source: https://github.com/tldr-pages/tldr.git --- -# npm name +# npm-name > Check whether a package or organization name is available on npm. > More information: . diff --git a/tldr/npm-org b/tldr/npm-org index 6b316431..b1ac1828 100644 --- a/tldr/npm-org +++ b/tldr/npm-org @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # npm org > Manage organizations. -> More information: . +> More information: . - Add a new user to an organization: diff --git a/tldr/npm-outdated b/tldr/npm-outdated index a1cafc49..3a0be6a0 100644 --- a/tldr/npm-outdated +++ b/tldr/npm-outdated @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # npm outdated > Check for outdated npm package dependencies. -> More information: . +> More information: . - Find packages that are outdated in a project: diff --git a/tldr/npm-owner b/tldr/npm-owner index 8b2cc30e..72662211 100644 --- a/tldr/npm-owner +++ b/tldr/npm-owner @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # npm owner > Manage ownership of published packages. -> More information: . +> More information: . - Add a new user as a maintainer of a package: diff --git a/tldr/npm-query b/tldr/npm-query index a09f08e6..4de1c83d 100644 --- a/tldr/npm-query +++ b/tldr/npm-query @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # npm query > Print an array of dependency objects using CSS-like selectors. -> More information: . +> More information: . - Print direct dependencies: diff --git a/tldr/npm-root b/tldr/npm-root index 1952dbf1..494a6ab6 100644 --- a/tldr/npm-root +++ b/tldr/npm-root @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # npm root > Display path to `node_modules` directory. -> More information: . +> More information: . - Display path to the local `node_modules` directory: diff --git a/tldr/npm-run b/tldr/npm-run index 382aef40..759802c4 100644 --- a/tldr/npm-run +++ b/tldr/npm-run @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # npm run > Run a script. -> More information: . +> More information: . - Run a script: @@ -30,4 +30,4 @@ source: https://github.com/tldr-pages/tldr.git - Run a script named `test`: -`npm test` +`npm {{[t|test]}}` diff --git a/tldr/npm-search b/tldr/npm-search index 681cded3..64303493 100644 --- a/tldr/npm-search +++ b/tldr/npm-search @@ -6,28 +6,28 @@ source: https://github.com/tldr-pages/tldr.git # npm search > Search for packages in the `npm` registry. -> More information: . +> More information: . - Search for a package by name: -`npm search {{package}}` +`npm {{[s|search]}} {{package}}` - Search for packages by a specific keyword: -`npm search {{keyword}}` +`npm {{[s|search]}} {{keyword}}` - Search for packages, including detailed information (e.g., description, author, version): -`npm search {{package}} --long` +`npm {{[s|search]}} {{package}} --long` - Search for packages maintained by a specific author: -`npm search --author {{author}}` +`npm {{[s|search]}} --author {{author}}` - Search for packages with a specific organization: -`npm search --scope {{organization}}` +`npm {{[s|search]}} --scope {{organization}}` - Search for packages with a specific combination of terms: -`npm search {{term1 term2 ...}}` +`npm {{[s|search]}} {{term1 term2 ...}}` diff --git a/tldr/npm-star b/tldr/npm-star index 4e74459c..348e8557 100644 --- a/tldr/npm-star +++ b/tldr/npm-star @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # npm star > Mark a package as favorite. -> More information: . +> More information: . - Star a public package from the default registry: diff --git a/tldr/npm-team b/tldr/npm-team index 0a24789b..1e69ffb4 100644 --- a/tldr/npm-team +++ b/tldr/npm-team @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # npm team > Manage teams in an organization on the `npm` registry. -> More information: . +> More information: . - Add a user to a team in an organization: diff --git a/tldr/npm-token b/tldr/npm-token index e0fcaf1b..94dbc6f2 100644 --- a/tldr/npm-token +++ b/tldr/npm-token @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # npm token > Manage and generate authentication tokens for the npm registry. -> More information: . +> More information: . - Create a new authentication token: diff --git a/tldr/npm-uninstall b/tldr/npm-uninstall index 7dae0f5a..93f16a9e 100644 --- a/tldr/npm-uninstall +++ b/tldr/npm-uninstall @@ -6,16 +6,16 @@ source: https://github.com/tldr-pages/tldr.git # npm uninstall > Remove a package. -> More information: . +> More information: . - Remove a package from the current project: -`npm uninstall {{package_name}}` +`npm {{[r|uninstall]}} {{package_name}}` - Remove a package globally: -`npm uninstall {{[-g|--global]}} {{package_name}}` +`npm {{[r|uninstall]}} {{[-g|--global]}} {{package_name}}` - Remove multiple packages at once: -`npm uninstall {{package_name1 package_name2 ...}}` +`npm {{[r|uninstall]}} {{package_name1 package_name2 ...}}` diff --git a/tldr/npm-unpublish b/tldr/npm-unpublish index d4252e35..49b4c91b 100644 --- a/tldr/npm-unpublish +++ b/tldr/npm-unpublish @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # npm unpublish > Remove a package from the npm registry. -> More information: . +> More information: . - Unpublish a specific package version: diff --git a/tldr/npm-unstar b/tldr/npm-unstar index 3af72f78..7bfb8cf6 100644 --- a/tldr/npm-unstar +++ b/tldr/npm-unstar @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # npm unstar > Remove the favorite/star mark from a package. -> More information: . +> More information: . - Unstar a public package from the default registry: diff --git a/tldr/npm-update b/tldr/npm-update index dcae66ab..0af850b6 100644 --- a/tldr/npm-update +++ b/tldr/npm-update @@ -6,20 +6,20 @@ source: https://github.com/tldr-pages/tldr.git # npm update > Update packages in the current project. -> More information: . +> More information: . - Update all packages in the current project: -`npm update` +`npm {{[up|update]}}` - Update a specific package in the current project: -`npm update {{package}}` +`npm {{[up|update]}} {{package}}` - Update a package globally: -`npm update {{[-g|--global]}} {{package}}` +`npm {{[up|update]}} {{[-g|--global]}} {{package}}` - Update multiple packages at once: -`npm update {{package1 package2 ...}}` +`npm {{[up|update]}} {{package1 package2 ...}}` diff --git a/tldr/npm-version b/tldr/npm-version index 15d9a5c9..2322a569 100644 --- a/tldr/npm-version +++ b/tldr/npm-version @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # npm version > Bump a node package version. -> More information: . +> More information: . - Check current version: diff --git a/tldr/npm-view b/tldr/npm-view index 91be741e..74365151 100644 --- a/tldr/npm-view +++ b/tldr/npm-view @@ -6,32 +6,32 @@ source: https://github.com/tldr-pages/tldr.git # npm view > View registry information about a package. -> More information: . +> More information: . - View information about the latest version of a package: -`npm view {{package}}` +`npm {{[v|view]}} {{package}}` - View information about a specific version of a package: -`npm view {{package}}@{{version}}` +`npm {{[v|view]}} {{package}}@{{version}}` - View all available versions of a package: -`npm view {{package}} versions` +`npm {{[v|view]}} {{package}} versions` - View the description of a package: -`npm view {{package}} description` +`npm {{[v|view]}} {{package}} description` - View the dependencies of the latest version of a package: -`npm view {{package}} dependencies` +`npm {{[v|view]}} {{package}} dependencies` - View the repository URL of a package: -`npm view {{package}} repository` +`npm {{[v|view]}} {{package}} repository` - View the maintainers of a package: -`npm view {{package}} maintainers` +`npm {{[v|view]}} {{package}} maintainers` diff --git a/tldr/npm-why b/tldr/npm-why index 5402e361..73374363 100644 --- a/tldr/npm-why +++ b/tldr/npm-why @@ -3,7 +3,7 @@ syntax: markdown tags: [tldr, common] source: https://github.com/tldr-pages/tldr.git --- -# npm why +# npm-why > Identifies why an npm package is installed. > More information: . diff --git a/tldr/vagrant b/tldr/vagrant index a298d115..535798fc 100644 --- a/tldr/vagrant +++ b/tldr/vagrant @@ -6,17 +6,18 @@ source: https://github.com/tldr-pages/tldr.git # vagrant > Manage lightweight, reproducible, and portable development environments. -> More information: . +> Some subcommands such as `box`, `snapshot`, `halt`, etc. have their own usage documentation. +> More information: . -- Create Vagrantfile in current directory with the base Vagrant box: +- Create a `Vagrantfile` in the current directory with the base Vagrant box: `vagrant init` -- Create Vagrantfile with the Ubuntu 20.04 (Focal Fossa) box from HashiCorp Atlas: +- Create a `Vagrantfile` with a box from the Vagrant Public Registry: -`vagrant init ubuntu/focal64` +`vagrant init {{ubuntu/focal64}}` -- Start and provision the vagrant environment: +- Start and provision the Vagrant environment: `vagrant up` @@ -28,7 +29,7 @@ source: https://github.com/tldr-pages/tldr.git `vagrant halt` -- Connect to machine via SSH: +- Connect to the machine via SSH: `vagrant ssh` diff --git a/tldr/vagrant-snapshot b/tldr/vagrant-snapshot new file mode 100644 index 00000000..c5b531d6 --- /dev/null +++ b/tldr/vagrant-snapshot @@ -0,0 +1,30 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# vagrant snapshot + +> Manage snapshots of Vagrant machines. +> See also: `vagrant`. +> More information: . + +- Take a snapshot of the machine (running or stopped): + +`vagrant snapshot save {{snapshot_name}}` + +- Restore a snapshot and start the machine: + +`vagrant snapshot restore {{snapshot_name}}` + +- Restore a snapshot without starting the machine: + +`vagrant snapshot restore --no-start {{snapshot_name}}` + +- Delete a snapshot: + +`vagrant snapshot delete {{snapshot_name}}` + +- List available snapshots of the machine: + +`vagrant snapshot list`