From 5a1c363361a09f359dcfbf6ae4153b1181353a76 Mon Sep 17 00:00:00 2001 From: spageektti Date: Sun, 16 Jun 2024 22:46:42 +0200 Subject: [PATCH] *: change `command line` to `command-line` (#12996) Change `command line` to `command-line` --- CLIENT-SPECIFICATION.md | 2 +- contributing-guides/style-guide.md | 4 ++-- pages/common/crystal.md | 2 +- pages/common/immich-cli.md | 2 +- pages/common/jbang.md | 2 +- pages/common/mods.md | 2 +- pages/common/set.md | 2 +- pages/common/sf.md | 2 +- pages/common/vboxmanage-registervm.md | 2 +- pages/common/wfuzz.md | 2 +- pages/common/wikit.md | 2 +- pages/linux/grub-editenv.md | 2 +- pages/linux/navi.md | 2 +- 13 files changed, 14 insertions(+), 14 deletions(-) diff --git a/CLIENT-SPECIFICATION.md b/CLIENT-SPECIFICATION.md index 71e82587e4..9ad0c541b7 100644 --- a/CLIENT-SPECIFICATION.md +++ b/CLIENT-SPECIFICATION.md @@ -163,7 +163,7 @@ If a page cannot be found in _any_ platform, then it is RECOMMENDED that clients https://github.com/tldr-pages/tldr/issues/new?title=page%20request:%20{command_name} ``` -where `{command_name}` is the name of the command that was not found. Clients that have control over their exit code on the command line (i.e. clients that provide a CLI) MUST exit with a non-zero exit code in addition to showing the above message. +where `{command_name}` is the name of the command that was not found. Clients that have control over their exit code on the command-line (i.e. clients that provide a CLI) MUST exit with a non-zero exit code in addition to showing the above message. #### If multiple versions of a page were found diff --git a/contributing-guides/style-guide.md b/contributing-guides/style-guide.md index 6f7131cc3e..c557c43955 100644 --- a/contributing-guides/style-guide.md +++ b/contributing-guides/style-guide.md @@ -278,7 +278,7 @@ Use backticks on the following: ### More information links -- On the `More information` link line, we prefer linking to the author's provided documentation of the command line reference or the man page. When not available, use as the default fallback for all platforms +- On the `More information` link line, we prefer linking to the author's provided documentation of the command-line reference or the man page. When not available, use as the default fallback for all platforms (except `osx` and BSD platforms other than FreeBSD). Alternatively, you can link to the author's website or a tutorial page if the command doesn't have a documentation page. @@ -337,7 +337,7 @@ the part of the address that starts with `?view=`. - Avoid using the page title in the description (e.g. use `A sketching and painting program designed for digital artists` instead of `Krita is a sketching and painting program designed for digital artists`) unless the program name differs from the executable name (e.g. `rg` and Ripgrep). -- Avoid mentioning that the program is used on the command line (e.g. use `Ripgrep is a recursive line-oriented search tool` instead of `Ripgrep is a recursive line-oriented CLI search tool`). +- Avoid mentioning that the program is used on the command-line (e.g. use `Ripgrep is a recursive line-oriented search tool` instead of `Ripgrep is a recursive line-oriented CLI search tool`). - For example, when writing documentation for `cd`, a tool to check out and work on a specific directory in the Terminal or Command Prompt, **do not** write a lengthy description such as: ```md diff --git a/pages/common/crystal.md b/pages/common/crystal.md index 2ae31abff2..318403eaba 100644 --- a/pages/common/crystal.md +++ b/pages/common/crystal.md @@ -11,7 +11,7 @@ `crystal build {{path/to/file.cr}}` -- Read Crystal source code from the command line or `stdin`, and execute it: +- Read Crystal source code from the command-line or `stdin`, and execute it: `crystal eval '{{code}}'` diff --git a/pages/common/immich-cli.md b/pages/common/immich-cli.md index e130af88b9..c506f12c4e 100644 --- a/pages/common/immich-cli.md +++ b/pages/common/immich-cli.md @@ -1,6 +1,6 @@ # immich-cli -> Immich has a command line interface (CLI) that allows you to perform certain actions from the command line. +> Immich has a command-line interface (CLI) that allows you to perform certain actions from the command-line. > See also: `immich-go`. > More information: . diff --git a/pages/common/jbang.md b/pages/common/jbang.md index 10fa98613f..88834bea1e 100644 --- a/pages/common/jbang.md +++ b/pages/common/jbang.md @@ -24,7 +24,7 @@ `{{echo 'Files.list(Paths.get("/etc")).forEach(System.out::println);'}} | jbang -` -- Run command line application: +- Run command-line application: `jbang {{path/to/file.java}} {{command}} {{arg1 arg2 ...}}` diff --git a/pages/common/mods.md b/pages/common/mods.md index f1f9f48b9d..4789c80821 100644 --- a/pages/common/mods.md +++ b/pages/common/mods.md @@ -1,6 +1,6 @@ # mods -> AI for the command line, built for pipelines. +> AI for the command-line, built for pipelines. > More information: . - Ask a generic question: diff --git a/pages/common/set.md b/pages/common/set.md index 703f4bf2a6..d3269417ac 100644 --- a/pages/common/set.md +++ b/pages/common/set.md @@ -15,7 +15,7 @@ `set -b` -- Write and edit text in the command line with `vi`-like keybindings (e.g. `yy`): +- Write and edit text in the command-line with `vi`-like keybindings (e.g. `yy`): `set -o {{vi}}` diff --git a/pages/common/sf.md b/pages/common/sf.md index 811dc623fb..9e3dbcc228 100644 --- a/pages/common/sf.md +++ b/pages/common/sf.md @@ -1,6 +1,6 @@ # sf -> A powerful command line interface that simplifies development and build automation when working with your Salesforce org. +> A powerful command-line interface that simplifies development and build automation when working with your Salesforce org. > More information: . - Authorize a Salesforce Organization: diff --git a/pages/common/vboxmanage-registervm.md b/pages/common/vboxmanage-registervm.md index 5ec2f3b093..00ed833599 100644 --- a/pages/common/vboxmanage-registervm.md +++ b/pages/common/vboxmanage-registervm.md @@ -11,6 +11,6 @@ `VBoxManage registervm {{path/to/filename.vbox}} --password {{path/to/password_file}}` -- Prompt for the encryption password on the command line: +- Prompt for the encryption password on the command-line: `VBoxManage registervm {{path/to/filename.vbox}} --password -` diff --git a/pages/common/wfuzz.md b/pages/common/wfuzz.md index 2cb7805352..513adfb6f4 100644 --- a/pages/common/wfuzz.md +++ b/pages/common/wfuzz.md @@ -23,7 +23,7 @@ `wfuzz -c --hc {{401}} -s {{delay_between_requests_in_seconds}} -z file,{{path/to/usernames}} -z file,{{path/to/passwords}} --basic 'FUZZ:FUZ2Z' {{https://example.com}}` -- Provide wordlist directly from the command line and use POST request for fuzzing: +- Provide wordlist directly from the command-line and use POST request for fuzzing: `wfuzz -z list,{{word1-word2-...}} {{https://api.example.com}} -d {{"id=FUZZ&showwallet=true"}}` diff --git a/pages/common/wikit.md b/pages/common/wikit.md index b8e55ba94d..dc2ef00a0e 100644 --- a/pages/common/wikit.md +++ b/pages/common/wikit.md @@ -1,6 +1,6 @@ # wikit -> A command line program for getting Wikipedia summaries easily. +> A command-line program for getting Wikipedia summaries easily. > More information: . - Show a short summary of a specific topic on Wikipedia: diff --git a/pages/linux/grub-editenv.md b/pages/linux/grub-editenv.md index 03baa0bf88..1b3fa45c43 100644 --- a/pages/linux/grub-editenv.md +++ b/pages/linux/grub-editenv.md @@ -15,6 +15,6 @@ `grub-editenv /boot/grub/grubenv unset saved_entry` -- Append "quiet splash" to the kernel command line: +- Append "quiet splash" to the kernel command-line: `grub-editenv /boot/grub/grubenv list kernel_cmdline` diff --git a/pages/linux/navi.md b/pages/linux/navi.md index 7af717f35b..60b1b13263 100644 --- a/pages/linux/navi.md +++ b/pages/linux/navi.md @@ -1,6 +1,6 @@ # navi -> An interactive cheatsheet tool for the command line and application launchers. +> An interactive cheatsheet tool for the command-line and application launchers. > More information: . - Browse through all available cheatsheets: