diff --git a/tldr/doctl-account b/tldr/doctl-account index a29c1c83..912f0b77 100644 --- a/tldr/doctl-account +++ b/tldr/doctl-account @@ -18,4 +18,4 @@ source: https://github.com/tldr-pages/tldr.git - Display help: -`doctl account --help` +`doctl account {{[-h|--help]}}` diff --git a/tldr/doctl-auth b/tldr/doctl-auth index 963f4a45..66bf6252 100644 --- a/tldr/doctl-auth +++ b/tldr/doctl-auth @@ -26,4 +26,4 @@ source: https://github.com/tldr-pages/tldr.git - Show available commands: -`doctl auth --help` +`doctl auth {{[-h|--help]}}` diff --git a/tldr/doctl-balance b/tldr/doctl-balance index 5b783ac3..4ce1c476 100644 --- a/tldr/doctl-balance +++ b/tldr/doctl-balance @@ -14,7 +14,7 @@ source: https://github.com/tldr-pages/tldr.git - Get the balance of an account associated with an access token: -`doctl balance get --access-token {{access_token}}` +`doctl balance get {{[-t|--access-token]}} {{access_token}}` - Get the balance of an account associated with a specified context: diff --git a/tldr/doctl-databases b/tldr/doctl-databases index 1ccde2b6..7a9e7aa2 100644 --- a/tldr/doctl-databases +++ b/tldr/doctl-databases @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - Run a `doctl databases` command with an access token: -`doctl databases {{command}} --access-token {{access_token}}` +`doctl databases {{command}} {{[-t|--access-token]}} {{access_token}}` - Get details for a database cluster: diff --git a/tldr/doctl-databases-db b/tldr/doctl-databases-db index 72ab87b5..5fed7b73 100644 --- a/tldr/doctl-databases-db +++ b/tldr/doctl-databases-db @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - Run a `doctl databases db` command with an access token: -`doctl databases db {{command}} --access-token {{access_token}}` +`doctl databases db {{command}} {{[-t|--access-token]}} {{access_token}}` - Retrieve the name of the given database hosted in the given database cluster: diff --git a/tldr/doctl-databases-firewalls b/tldr/doctl-databases-firewalls index 1a1076b8..40caf372 100644 --- a/tldr/doctl-databases-firewalls +++ b/tldr/doctl-databases-firewalls @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - Run a `doctl databases firewalls` command with an access token: -`doctl databases firewalls {{command}} --access-token {{access_token}}` +`doctl databases firewalls {{command}} {{[-t|--access-token]}} {{access_token}}` - Retrieve a list of firewall rules for a given database: diff --git a/tldr/doctl-databases-maintenance-window b/tldr/doctl-databases-maintenance-window index 270b7cc5..09c5e615 100644 --- a/tldr/doctl-databases-maintenance-window +++ b/tldr/doctl-databases-maintenance-window @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - Run a `doctl databases maintenance-window` command with an access token: -`doctl databases maintenance-window {{command}} --access-token {{access_token}}` +`doctl databases maintenance-window {{command}} {{[-t|--access-token]}} {{access_token}}` - Retrieve details about a database cluster's maintenance windows: diff --git a/tldr/doctl-databases-options b/tldr/doctl-databases-options index 10653329..0f85f6e1 100644 --- a/tldr/doctl-databases-options +++ b/tldr/doctl-databases-options @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - Run a `doctl databases options` command with an access token: -`doctl databases options {{command}} --access-token {{access_token}}` +`doctl databases options {{command}} {{[-t|--access-token]}} {{access_token}}` - Retrieve a list of the available database engines: diff --git a/tldr/doctl-databases-pool b/tldr/doctl-databases-pool index 015ba609..0c43b714 100644 --- a/tldr/doctl-databases-pool +++ b/tldr/doctl-databases-pool @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - Run a `doctl databases pool` command with an access token: -`doctl databases pool {{command}} --access-token {{access_token}}` +`doctl databases pool {{command}} {{[-t|--access-token]}} {{access_token}}` - Retrieve information about a database connection pool: diff --git a/tldr/doctl-databases-replica b/tldr/doctl-databases-replica index 883bf434..98b85eeb 100644 --- a/tldr/doctl-databases-replica +++ b/tldr/doctl-databases-replica @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - Run a `doctl databases replica` command with an access token: -`doctl databases pool {{command}} --access-token {{access_token}}` +`doctl databases pool {{command}} {{[-t|--access-token]}} {{access_token}}` - Retrieve information about a read-only database replica: diff --git a/tldr/doctl-databases-sql-mode b/tldr/doctl-databases-sql-mode index f49e7acc..0ed8c42b 100644 --- a/tldr/doctl-databases-sql-mode +++ b/tldr/doctl-databases-sql-mode @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - Run a `doctl databases sql-mode` command with an access token: -`doctl databases sql-mode {{command}} --access-token {{access_token}}` +`doctl databases sql-mode {{command}} {{[-t|--access-token]}} {{access_token}}` - Get a MySQL database cluster's SQL modes: diff --git a/tldr/doctl-databases-user b/tldr/doctl-databases-user index 5693a533..e3590d53 100644 --- a/tldr/doctl-databases-user +++ b/tldr/doctl-databases-user @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - Run a `doctl databases user` command with an access token: -`doctl databases user {{command}} --access-token {{access_token}}` +`doctl databases user {{command}} {{[-t|--access-token]}} {{access_token}}` - Retrieve details about a database user: diff --git a/tldr/godot b/tldr/godot index 761b7c9c..b8d17570 100644 --- a/tldr/godot +++ b/tldr/godot @@ -20,9 +20,9 @@ source: https://github.com/tldr-pages/tldr.git `godot {{[-p|--project-manager]}}` -- Export a project for a given export preset (the preset must be defined in the project): +- Export a project for release using a given export preset (the preset must be defined in the project): -`godot --export {{preset}} {{output_path}}` +`godot --export-release {{preset}} {{output_path}}` - Execute a standalone GDScript file (the script must inherit from `SceneTree` or `MainLoop`): diff --git a/tldr/grip b/tldr/grip index a3e3fe64..630ca26b 100644 --- a/tldr/grip +++ b/tldr/grip @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # grip > Preview GitHub-flavoured Markdown files locally. -> More information: . +> More information: . - Start the server and serve the rendered `README` file of a current directory: @@ -18,7 +18,7 @@ source: https://github.com/tldr-pages/tldr.git - Start the server and open the `README` file of the current directory in the browser: -`grip --browser` +`grip {{[-b|--browser]}}` - Start the server in the specified port and serve the rendered `README` file of the current directory: diff --git a/tldr/handbrakecli b/tldr/handbrakecli index 17108c5b..d78fb1ec 100644 --- a/tldr/handbrakecli +++ b/tldr/handbrakecli @@ -6,28 +6,28 @@ source: https://github.com/tldr-pages/tldr.git # handbrakecli > Command-line interface to the HandBrake video conversion and DVD ripping tool. -> More information: . +> More information: . - Convert a video file to MKV (AAC 160kbit audio and x264 CRF20 video): -`handbrakecli --input {{input.avi}} --output {{output.mkv}} --encoder x264 --quality 20 --ab 160` +`handbrakecli {{[-i|--input]}} {{input.avi}} {{[-o|--output]}} {{output.mkv}} {{[-e|--encoder]}} x264 {{[-q|--quality]}} 20 {{[-B|--ab]}} 160` - Resize a video file to 320x240: -`handbrakecli --input {{input.mp4}} --output {{output.mp4}} --width 320 --height 240` +`handbrakecli {{[-i|--input]}} {{input.mp4}} {{[-o|--output]}} {{output.mp4}} {{[-w|--width]}} 320 {{[-l|--height]}} 240` - List available presets: -`handbrakecli --preset-list` +`handbrakecli {{[-z|--preset-list]}}` - Convert an AVI video to MP4 using the Android preset: -`handbrakecli --preset="Android" --input {{input.ext}} --output {{output.mp4}}` +`handbrakecli {{[-Z|--preset]}} "Android" {{[-i|--input]}} {{input.ext}} {{[-o|--output]}} {{output.mp4}}` - Print the content of a DVD, getting the CSS keys in the process: -`handbrakecli --input {{/dev/sr0}} --title 0` +`handbrakecli {{[-i|--input]}} {{/dev/sr0}} {{[-t|--title]}} 0` - Rip the first track of a DVD in the specified device. Audiotracks and subtitle languages are specified as lists: -`handbrakecli --input {{/dev/sr0}} --title 1 --output {{out.mkv}} --format av_mkv --encoder x264 --subtitle {{1,4,5}} --audio {{1,2}} --aencoder copy --quality {{23}}` +`handbrakecli {{[-i|--input]}} {{/dev/sr0}} {{[-t|--title]}} 1 {{[-o|--output]}} {{out.mkv}} {{[-f|--format]}} av_mkv {{[-e|--encoder]}} x264 {{[-s|--subtitle]}} {{1,4,5}} {{[-a|--audio]}} {{1,2}} {{[-E|--aencoder]}} copy {{[-q|--quality]}} {{23}}` diff --git a/tldr/hardhat b/tldr/hardhat index 7a3fe7bc..3000dceb 100644 --- a/tldr/hardhat +++ b/tldr/hardhat @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # hardhat > A development environment for Ethereum software. -> More information: . +> More information: . - List available subcommands (or create a new project if no configuration exists): diff --git a/tldr/highlight b/tldr/highlight index ec7d2308..197281d0 100644 --- a/tldr/highlight +++ b/tldr/highlight @@ -6,19 +6,19 @@ source: https://github.com/tldr-pages/tldr.git # highlight > Outputs syntax-highlighted source code to a variety of formats. -> More information: . +> More information: . - Produce a complete HTML document from a source code file: -`highlight --out-format={{html}} --style {{theme_name}} --syntax {{language}} {{path/to/source_code}}` +`highlight {{[-o|--out-format]}} {{html}} {{[-s|--style]}} {{theme_name}} {{[-S|--syntax]}} {{language}} {{path/to/source_code}}` - Produce an HTML fragment, suitable for inclusion in a larger document: -`highlight --out-format={{html}} --fragment --syntax {{language}} {{source_file}}` +`highlight {{[-o|--out-format]}} {{html}} {{[-f|--fragment]}} {{[-S|--syntax]}} {{language}} {{source_file}}` - Inline the CSS styling in every tag: -`highlight --out-format={{html}} --inline-css --syntax {{language}} {{source_file}}` +`highlight {{[-o|--out-format]}} {{html}} --inline-css {{[-S|--syntax]}} {{language}} {{source_file}}` - List all supported languages, themes, or plugins: @@ -26,4 +26,4 @@ source: https://github.com/tldr-pages/tldr.git - Print a CSS stylesheet for a theme: -`highlight --out-format={{html}} --print-style --style {{theme_name}} --syntax {{language}}] --stdout` +`highlight {{[-o|--out-format]}} {{html}} --print-style {{[-s|--style]}} {{theme_name}} {{[-S|--syntax]}} {{language}}] --stdout` diff --git a/tldr/ipaggmanip b/tldr/ipaggmanip index ab565dd1..0df5c323 100644 --- a/tldr/ipaggmanip +++ b/tldr/ipaggmanip @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - Combine labels equal in their high-order bits: -`ipaggmanip --prefix {{16}} {{path/to/file}}` +`ipaggmanip {{[-p|--prefix]}} {{16}} {{path/to/file}}` - Remove labels with a count smaller than a given number of bytes and output a random sample of such labels: @@ -18,4 +18,4 @@ source: https://github.com/tldr-pages/tldr.git - Replace each label's count with 1 if it is non-zero: -`ipaggmanip --posterize {{path/to/file}}` +`ipaggmanip {{[-P|--posterize]}} {{path/to/file}}` diff --git a/tldr/jadx b/tldr/jadx index 407e821c..51894b2b 100644 --- a/tldr/jadx +++ b/tldr/jadx @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Dex to Java decompiler. > Produces Java source code from Android Dex and APK files. -> More information: . +> More information: . - Decompile a Dex file into a directory: @@ -15,4 +15,4 @@ source: https://github.com/tldr-pages/tldr.git - Decompile a Dex file into a specific directory: -`jadx --output-dir {{path/to/directory}} {{path/to/file}}` +`jadx {{[-d|--output-dir]}} {{path/to/directory}} {{path/to/file}}` diff --git a/tldr/linux/bcachefs b/tldr/linux/bcachefs index 874a25a0..0f8c9d65 100644 --- a/tldr/linux/bcachefs +++ b/tldr/linux/bcachefs @@ -37,6 +37,6 @@ source: https://github.com/tldr-pages/tldr.git `sudo bcachefs data rereplicate {{path/to/mountpoint}}` -- Display help: +- Create a snapshot of a particular directory: -`bcachefs` +`bcachefs subvolume snapshot {{path/to/directory}} {{path/to/snapshot}}` diff --git a/tldr/linux/dysk b/tldr/linux/dysk index 54b02135..1525c9f6 100644 --- a/tldr/linux/dysk +++ b/tldr/linux/dysk @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # dysk > Display filesystem information in a table. -> More information: . +> More information: . - Get a standard overview of your usual disks: @@ -14,16 +14,16 @@ source: https://github.com/tldr-pages/tldr.git - Sort by free size: -`dysk --sort free` +`dysk {{[-s|--sort]}} free` - Include only HDD disks: -`dysk --filter 'disk = HDD'` +`dysk {{[-f|--filter]}} 'disk = HDD'` - Exclude SSD disks: -`dysk --filter 'disk <> SSD'` +`dysk {{[-f|--filter]}} 'disk <> SSD'` - Display disks with high utilization or low free space: -`dysk --filter 'use > 65% | free < 50G'` +`dysk {{[-f|--filter]}} 'use > 65% | free < 50G'` diff --git a/tldr/linux/gamescope b/tldr/linux/gamescope new file mode 100644 index 00000000..5bfe43d3 --- /dev/null +++ b/tldr/linux/gamescope @@ -0,0 +1,29 @@ +--- +syntax: markdown +tags: [tldr, linux] +source: https://github.com/tldr-pages/tldr.git +--- +# gamescope + +> A micro-compositor used as a game layer. +> More information: . + +- Run a program with gamescope: + +`gamescope -- {{command}}` + +- Upscale a 720p game to 1440p with integer scaling: + +`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%` + +- Toggle fullscreen: + +`` + +- Show help: + +`gamescope --help` diff --git a/tldr/loadtest b/tldr/loadtest index 1cb544c0..eb4a7bbe 100644 --- a/tldr/loadtest +++ b/tldr/loadtest @@ -10,7 +10,7 @@ source: https://github.com/tldr-pages/tldr.git - Run with concurrent users and a specified amount of requests per second: -`loadtest --concurrency {{10}} --rps {{200}} {{https://example.com}}` +`loadtest {{[-c|--concurrency]}} {{10}} {{[--rps|--requestsPerSecond]}} {{200}} {{https://example.com}}` - Run with a custom HTTP header: @@ -18,4 +18,4 @@ source: https://github.com/tldr-pages/tldr.git - Run with a specific HTTP method: -`loadtest --method {{GET}} {{https://example.com}}` +`loadtest {{[-m|--method]}} {{GET}} {{https://example.com}}` diff --git a/tldr/mongodump b/tldr/mongodump index d54a3039..435fc25e 100644 --- a/tldr/mongodump +++ b/tldr/mongodump @@ -14,23 +14,23 @@ source: https://github.com/tldr-pages/tldr.git - Specify an output location for the dump: -`mongodump --out {{path/to/directory}}` +`mongodump {{[-o|--out]}} {{path/to/directory}}` - Create a dump of a given database: -`mongodump --db {{database_name}}` +`mongodump {{[-d|--db]}} {{database_name}}` - Create a dump of a given collection within a given database: -`mongodump --collection {{collection_name}} --db {{database_name}}` +`mongodump {{[-c|--collection]}} {{collection_name}} {{[-d|--db]}} {{database_name}}` - Connect to a given host running on a given port, and create a dump: -`mongodump --host {{host}} --port {{port}}` +`mongodump {{[-h|--host]}} {{host}} --port {{port}}` - Create a dump of a given database with a given username; user will be prompted for password: -`mongodump --username {{username}} {{database}} --password` +`mongodump {{[-u|--username]}} {{username}} {{database}} {{[-p|--password]}}` - Create a dump from a specific instance; host, user, password and database will be defined in the connection string: diff --git a/tldr/obs b/tldr/obs index 13cd3b7f..3a52a43c 100644 --- a/tldr/obs +++ b/tldr/obs @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Open Broadcaster Software. > Video recording and livestreaming program. -> More information: . +> More information: . - Launch OBS: @@ -15,7 +15,7 @@ source: https://github.com/tldr-pages/tldr.git - Launch OBS in portable mode: -`obs --portable` +`obs {{[-p|--portable]}}` - Automatically start recording a video on launch: diff --git a/tldr/pdf-parser b/tldr/pdf-parser index c29f6871..e589ca41 100644 --- a/tldr/pdf-parser +++ b/tldr/pdf-parser @@ -10,12 +10,12 @@ source: https://github.com/tldr-pages/tldr.git - Display statistics for a PDF file: -`pdf-parser --stats {{path/to/file.pdf}}` +`pdf-parser {{[-a|--stats]}} {{path/to/file.pdf}}` - Display objects of type `/Font` in a PDF file: -`pdf-parser --type={{/Font}} {{path/to/file.pdf}}` +`pdf-parser {{[-t|--type]}} {{/Font}} {{path/to/file.pdf}}` - Search for strings in indirect objects: -`pdf-parser --search={{search_string}} {{path/to/file.pdf}}` +`pdf-parser {{[-s|--search]}} {{search_string}} {{path/to/file.pdf}}` diff --git a/tldr/pdfgrep b/tldr/pdfgrep index c65d1a39..34cd55c5 100644 --- a/tldr/pdfgrep +++ b/tldr/pdfgrep @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # pdfgrep > Search text in PDF files. -> More information: . +> More information: . - Find lines that match pattern in a PDF: @@ -14,16 +14,16 @@ source: https://github.com/tldr-pages/tldr.git - Include file name and page number for each matched line: -`pdfgrep --with-filename --page-number {{pattern}} {{file.pdf}}` +`pdfgrep {{[-H|--with-filename]}} {{[-n|--page-number]}} {{pattern}} {{file.pdf}}` - Do a case-insensitive search for lines that begin with "foo" and return the first 3 matches: -`pdfgrep --max-count {{3}} --ignore-case {{'^foo'}} {{file.pdf}}` +`pdfgrep {{[-m|--max-count]}} {{3}} {{[-i|--ignore-case]}} {{'^foo'}} {{file.pdf}}` - Find pattern in files with a `.pdf` extension in the current directory recursively: -`pdfgrep --recursive {{pattern}}` +`pdfgrep {{[-r|--recursive]}} {{pattern}}` - Find pattern on files that match a specific glob in the current directory recursively: -`pdfgrep --recursive --include {{'*book.pdf'}} {{pattern}}` +`pdfgrep {{[-r|--recursive]}} --include {{'*book.pdf'}} {{pattern}}` diff --git a/tldr/rscript b/tldr/rscript index ff4ad036..9bcebe06 100644 --- a/tldr/rscript +++ b/tldr/rscript @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # Rscript > Run a script with the R programming language. -> More information: . +> More information: . - Run a script: diff --git a/tldr/s b/tldr/s index daa91ff7..3856f8c6 100644 --- a/tldr/s +++ b/tldr/s @@ -14,12 +14,12 @@ source: https://github.com/tldr-pages/tldr.git - List all providers: -`s --list-providers` +`s {{[-l|--list-providers]}}` - Search for a query with a given provider: -`s --provider {{provider}} {{query}}` +`s {{[-p|--provider]}} {{provider}} {{query}}` - Use a specified binary to perform the search query: -`s --binary "{{binary}} {{arguments}}" {{query}}` +`s {{[-b|--binary]}} "{{binary}} {{arguments}}" {{query}}` diff --git a/tldr/sshuttle b/tldr/sshuttle index ad1cba84..deaa4700 100644 --- a/tldr/sshuttle +++ b/tldr/sshuttle @@ -11,16 +11,16 @@ source: https://github.com/tldr-pages/tldr.git - Forward all IPv4 TCP traffic via a remote SSH server: -`sshuttle --remote={{username}}@{{sshserver}} {{0.0.0.0/0}}` +`sshuttle {{[-r|--remote]}} {{username}}@{{sshserver}} {{0.0.0.0/0}}` - Also forward all DNS traffic to the server's default DNS resolver: -`sshuttle --dns --remote={{username}}@{{sshserver}} {{0.0.0.0/0}}` +`sshuttle --dns {{[-r|--remote]}} {{username}}@{{sshserver}} {{0.0.0.0/0}}` - Forward all traffic except that which is bound for a specific subnet: -`sshuttle --remote={{username}}@{{sshserver}} {{0.0.0.0/0}} --exclude {{192.168.0.1/24}}` +`sshuttle {{[-r|--remote]}} {{username}}@{{sshserver}} {{0.0.0.0/0}} {{[-x|--exclude]}} {{192.168.0.1/24}}` - Use the tproxy method to forward all IPv4 and IPv6 traffic: -`sshuttle --method=tproxy --remote={{username}}@{{sshserver}} {{0.0.0.0/0}} {{::/0}} --exclude={{your_local_ip_address}} --exclude={{ssh_server_ip_address}}` +`sshuttle --method tproxy {{[-r|--remote]}} {{username}}@{{sshserver}} {{0.0.0.0/0}} {{::/0}} {{[-x|--exclude]}} {{your_local_ip_address}} {{[-x|--exclude]}} {{ssh_server_ip_address}}` diff --git a/tldr/tlmgr b/tldr/tlmgr index adcc3fc2..36b20b06 100644 --- a/tldr/tlmgr +++ b/tldr/tlmgr @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Manage packages and configuration options of an existing TeX Live installation. > Some subcommands such as `paper` have their own usage documentation. -> More information: . +> More information: . - Install a package and its dependencies: diff --git a/tldr/tlmgr-backup b/tldr/tlmgr-backup index afb2abb6..243b5cbb 100644 --- a/tldr/tlmgr-backup +++ b/tldr/tlmgr-backup @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Manage backups of TeX Live packages. > The default backup directory is specified by the `backupdir` option, and can be obtained with `tlmgr option`. -> More information: . +> More information: . - Make a backup of one or more packages: diff --git a/tldr/tlmgr-candidates b/tldr/tlmgr-candidates index 68274938..f7a71b20 100644 --- a/tldr/tlmgr-candidates +++ b/tldr/tlmgr-candidates @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # tlmgr candidates > Get available candidate repositories from which a TeX Live package can be installed. -> More information: . +> More information: . - List all available repositories from which a package can be installed: diff --git a/tldr/tlmgr-check b/tldr/tlmgr-check index 18ce0068..ca22d182 100644 --- a/tldr/tlmgr-check +++ b/tldr/tlmgr-check @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # tlmgr check > Check the consistency of a TeX Live installation. -> More information: . +> More information: . - Check the consistency of the whole TeX Live installation: diff --git a/tldr/tlmgr-conf b/tldr/tlmgr-conf index 7e36fcea..d193a3ff 100644 --- a/tldr/tlmgr-conf +++ b/tldr/tlmgr-conf @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # tlmgr conf > Manage the TeX Live configuration. -> More information: . +> More information: . - Show the current TeX Live configuration: diff --git a/tldr/tlmgr-dump-tlpdb b/tldr/tlmgr-dump-tlpdb index 00c3f4d3..bf784815 100644 --- a/tldr/tlmgr-dump-tlpdb +++ b/tldr/tlmgr-dump-tlpdb @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # tlmgr dump-tlpdb > Dump the TeX Live package database. -> More information: . +> More information: . - Dump the local package database: diff --git a/tldr/tlmgr-generate b/tldr/tlmgr-generate index b767103d..fab7d5e7 100644 --- a/tldr/tlmgr-generate +++ b/tldr/tlmgr-generate @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # tlmgr generate > Remake configuration files from information stored locally. -> More information: . +> More information: . - Remake the configuration file storing into a specific location: diff --git a/tldr/tlmgr-gui b/tldr/tlmgr-gui index db93b67b..803c3a89 100644 --- a/tldr/tlmgr-gui +++ b/tldr/tlmgr-gui @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Start a graphical user interface for `tlmgr`. > `tlmgr gui` depends on the package `perl-tk`, which has to be installed manually. -> More information: . +> More information: . - Start a GUI for `tlmgr`: diff --git a/tldr/tlmgr-info b/tldr/tlmgr-info index 77c1f76e..431ff890 100644 --- a/tldr/tlmgr-info +++ b/tldr/tlmgr-info @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # tlmgr info > Show information about TeX Live packages. -> More information: . +> More information: . - List all available TeX Live packages, prefexing installed ones with `i`: diff --git a/tldr/tlmgr-install b/tldr/tlmgr-install index 9193d4ca..3cefe70f 100644 --- a/tldr/tlmgr-install +++ b/tldr/tlmgr-install @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # tlmgr install > Install TeX Live packages. -> More information: . +> More information: . - Install a package and its dependencies: diff --git a/tldr/tlmgr-key b/tldr/tlmgr-key index 713c329a..c7537ba8 100644 --- a/tldr/tlmgr-key +++ b/tldr/tlmgr-key @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # tlmgr key > Manage GPG keys used to verify TeX Live databases. -> More information: . +> More information: . - List all keys for TeX Live: diff --git a/tldr/tlmgr-option b/tldr/tlmgr-option index 2fc7a5d2..fa0f912d 100644 --- a/tldr/tlmgr-option +++ b/tldr/tlmgr-option @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # tlmgr option > TeX Live settings manager. -> More information: . +> More information: . - List all TeX Live settings: diff --git a/tldr/tlmgr-paper b/tldr/tlmgr-paper index 69228be6..8df04810 100644 --- a/tldr/tlmgr-paper +++ b/tldr/tlmgr-paper @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # tlmgr paper > Manage paper size options of an TeX Live installation. -> More information: . +> More information: . - Show the default paper size used by all TeX Live programs: diff --git a/tldr/tlmgr-path b/tldr/tlmgr-path index 29c8758d..89b0000f 100644 --- a/tldr/tlmgr-path +++ b/tldr/tlmgr-path @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Add or remove symlinks for TeX Live executables, man pages and info pages. > This command has to be re-run for files added in the future. -> More information: . +> More information: . - Add symlinks to TeX Live files: diff --git a/tldr/tlmgr-platform b/tldr/tlmgr-platform index 64f83d93..30242e19 100644 --- a/tldr/tlmgr-platform +++ b/tldr/tlmgr-platform @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # tlmgr platform > Manage TeX Live platforms. -> More information: . +> More information: . - List all available platforms in the package repository: diff --git a/tldr/tlmgr-remove b/tldr/tlmgr-remove index 218d7f84..53cbe283 100644 --- a/tldr/tlmgr-remove +++ b/tldr/tlmgr-remove @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Uninstall TeX Live packages. > By default, removed packages will be backed up to `./tlpkg/backups` under the TL installation directory. -> More information: . +> More information: . - Uninstall a TeX Live package: diff --git a/tldr/tlmgr-repository b/tldr/tlmgr-repository index 0610a9ad..60e1d5ab 100644 --- a/tldr/tlmgr-repository +++ b/tldr/tlmgr-repository @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # tlmgr repository > Manage repositories of a TeX Live installation. -> More information: . +> More information: . - List all configured repositories and their tags (if set): diff --git a/tldr/tlmgr-restore b/tldr/tlmgr-restore index eeb5a34b..232258c8 100644 --- a/tldr/tlmgr-restore +++ b/tldr/tlmgr-restore @@ -7,7 +7,7 @@ source: https://github.com/tldr-pages/tldr.git > Restore package backups created with `tlmgr backup`. > The default backup directory is specified by the `backupdir` option, and can be obtained with `tlmgr option`. -> More information: . +> More information: . - List all available backup revisions for all packages: diff --git a/tldr/tlmgr-search b/tldr/tlmgr-search index d80613f0..9da6a07a 100644 --- a/tldr/tlmgr-search +++ b/tldr/tlmgr-search @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # tlmgr search > Search for TeX Live packages using (Perl) regular expressions. -> More information: . +> More information: . - Search for a package name and descriptions of all locally installed packages from a specific regular expression: diff --git a/tldr/tlmgr-shell b/tldr/tlmgr-shell index 8a10bf48..f5977df0 100644 --- a/tldr/tlmgr-shell +++ b/tldr/tlmgr-shell @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # tlmgr shell > Start an interactive shell of the native TeX Live manager. -> More information: . +> More information: . - Start an interactive shell of `tlmgr`: diff --git a/tldr/tlmgr-update b/tldr/tlmgr-update index a76634c8..2cbcb46d 100644 --- a/tldr/tlmgr-update +++ b/tldr/tlmgr-update @@ -6,7 +6,7 @@ source: https://github.com/tldr-pages/tldr.git # tlmgr update > Update TeX Live packages. -> More information: . +> More information: . - Update all TeX Live packages: diff --git a/tldr/watchexec b/tldr/watchexec index 13a81ef5..33d6e7ca 100644 --- a/tldr/watchexec +++ b/tldr/watchexec @@ -23,3 +23,7 @@ source: https://github.com/tldr-pages/tldr.git - Call/restart `my_server` when any file in the current directory changes, sending `SIGKILL` to stop the child process: `watchexec {{[-r|--restart]}} --stop-signal {{SIGKILL}} {{my_server}}` + +- Restart the execution of a command when any Java source file in the current directory changes, sending `SIGKILL` and only checking for updates every `n`ms: + +`watchexec {{[-r|--restart]}} --stop-signal {{SIGKILL}} --poll {{10000}} {{[-e|--exts]}} {{java}} {{command}}` diff --git a/tldr/watchman b/tldr/watchman new file mode 100644 index 00000000..e896a8d7 --- /dev/null +++ b/tldr/watchman @@ -0,0 +1,33 @@ +--- +syntax: markdown +tags: [tldr, common] +source: https://github.com/tldr-pages/tldr.git +--- +# watchman + +> A service that watches files, and triggers actions when changes occur. +> More information: . + +- Start watching a directory for changes: + +`watchman watch {{path/to/directory}}` + +- Add a trigger to run a command when files with a specified filename pattern in a watched directory change: + +`watchman -- trigger {{path/to/watched_directory}} {{trigger_name}} '{{pattern}}' -- {{command}}` + +- List all watched directories: + +`watchman watch-list` + +- Delete a watch on a directory: + +`watchman watch-del {{path/to/watched_directory}}` + +- List all triggers on a watched directory: + +`watchman trigger-list {{path/to/watched_directory}}` + +- Delete a trigger from a watched directory: + +`watchman trigger-del {{path/to/watched_directory}} {{trigger_name}}`