mention subcommands in every base page (#6383)

beep
marchersimon 2021-09-13 10:21:21 +02:00 committed by GitHub
parent 4fbb601f63
commit bd677b8b48
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
63 changed files with 69 additions and 26 deletions

View File

@ -75,7 +75,8 @@ Many programs use subcommands for separating functionality, which may require th
For instance, `git commit` has its own page, as well as `git push` and many others.
To create a page for a subcommand, the program and subcommand need to be separated with a dash (`-`), so `git-commit.md` is shown when calling `tldr git commit`.
You should always add a base page (e.g. `git`) that describes the program and basic switches like `--version` or `help`.
You should always add a base page (e.g. `git`) that describes the program and basic switches like `--version` or `--help`.
To let users know about the subcommand, add a note saying ``Some subcommands such as `example command` have their own usage documentation`` to the base page.
See these examples for reference:
* [git](pages/common/git.md)

View File

@ -1,7 +1,7 @@
# ansible
> Verwalte Computergruppen per Fernzugriff über SSH.
> Verwende die Datei `/etc/ansible/hosts`, um neue Gruppen/Hosts hinzuzufügen.
> Verwalte Computergruppen per Fernzugriff über SSH (Verwende die Datei `/etc/ansible/hosts`, um neue Gruppen/Hosts hinzuzufügen).
> Manche Unterbefehle wie `ansible galaxy` sind separat dokumentiert.
> Weitere Informationen: <https://www.ansible.com/>.
- Liste Hosts auf, die zu einer Gruppe gehören:

View File

@ -1,7 +1,7 @@
# aws
> Das offizielle CLI für Amazon Web Services.
> Ausführungssassistent, SSO, Autovervollständigung von Ressourcen sowie YAML Optionen sind nur unter Version v2 verfügbar.
> Manche Unterbefehle wie `aws s3` sind separat dokumentiert.
> Weitere Informationen: <https://aws.amazon.com/cli>.
- Konfiguriere die AWS Kommandozeile:

View File

@ -1,7 +1,7 @@
# cargo
> Rust Paketmanager.
> Verwalte Rust-Projekte und deren Abhängigkeiten (crates).
> Manche Unterbefehle wie `cargo build` sind separat dokumentiert.
> Weitere Informationen: <https://crates.io/>.
- Suche nach Abhängigkeiten (crates):

View File

@ -1,7 +1,7 @@
# cradle
> Das Cradle PHP Framework.
> Siehe `cradle-install`, `cradle-deploy`, etc. für zusätzliche Informationen.
> Manche Unterbefehle wie `cradle install` sind separat dokumentiert.
> Weitere Informationen: <https://cradlephp.github.io>.
- Stelle eine Verbindung zu einem Server her:

View File

@ -1,6 +1,7 @@
# docker
> Verwalte Docker Container und Images.
> Manche Unterbefehle wie `docker run` sind separat dokumentiert.
> Weitere Informationen: <https://docs.docker.com/engine/reference/commandline/cli/>.
- Liste zur Zeit laufende Container auf:

View File

@ -1,6 +1,7 @@
# dotnet
> Plattformübergreifende Kommandozeilenandwendungen für .NET Core.
> Manche Unterbefehle wie `dotnet build` sind separat dokumentiert.
> Weitere Informationen: <https://docs.microsoft.com/dotnet/core/tools/>.
- Initialisiere ein neues .NET Projekt:

View File

@ -1,6 +1,7 @@
# git
> Verteiltes Versionskontrollsystem.
> Manche Unterbefehle wie `git commit` sind separat dokumentiert.
> Weitere Informationen: <https://git-scm.com/>.
- Gib die installierte Git Version aus:

View File

@ -1,7 +1,7 @@
# choco
> Ein Kommandozeilenwerkzeug für die Chocolatey Paketverwaltung.
> Schau dir `choco install`, `choco upgrade` und andere Seiten für weitergehende Informationen an.
> Manche Unterbefehle wie `choco install` sind separat dokumentiert.
> Weitere Informationen: <https://chocolatey.org>.
- Führe einen Chocolatey-Befehl aus:

View File

@ -1,6 +1,7 @@
# adb
> Android Debug Bridge: comunica con una instancia de un emulador Android o conecta dispositivos Android.
> Algunos subcomandos, como `adb shell`, tienen su propia documentación de uso.
> Más información: <https://developer.android.com/studio/command-line/adb>.
- Verifica si el proceso del servidor adb está ejecutandose y lo inicia:

View File

@ -1,6 +1,7 @@
# docker
> Administra contenedores e imágenes de Docker.
> Algunos subcomandos, como `docker run`, tienen su propia documentación de uso.
> Más información: <https://docs.docker.com/engine/reference/commandline/cli/>.
- Lista los contenedores de Docker en ejecución:

View File

@ -1,6 +1,7 @@
# dotnet
> Herramienta multiplataforma de línea de comandos para .NET Core.
> Algunos subcomandos, como `dotnet build`, tienen su propia documentación de uso.
> Más información: <https://docs.microsofot.com/dotnet/core/tools>.
- Inicializa un proyecto .NET nuevo:

View File

@ -1,6 +1,7 @@
# adb
> Android Debug Bridge: berkomunikasi dengan emulator Android atau perangkat Android terhubung.
> Kami mempunyai dokumentasi terpisah untuk menggunakan subperintah seperti `adb shell`.
> Informasi lebih lanjut: <https://developer.android.com/studio/command-line/adb>.
- Cek apakah proses server adb telah dimulai dan memulainya:

View File

@ -1,6 +1,7 @@
# docker
> Mengatur kontainer Docker dan image.
> Kami mempunyai dokumentasi terpisah untuk menggunakan subperintah seperti `docker run`.
> Informasi lebih lanjut: <https://docs.docker.com/engine/reference/commandline/cli/>.
- Menampilkan semua daftar kontainer docker yang sedang berjalan:

View File

@ -1,6 +1,7 @@
# git
> Sistem kontrol versi terdistribusi.
> Kami mempunyai dokumentasi terpisah untuk menggunakan subperintah seperti `git commit`.
> Informasi lebih lanjut: <https://git-scm.com/>.
- Memeriksa versi Git:

View File

@ -1,6 +1,7 @@
# pip
> Pengelola paket Python.
> Kami mempunyai dokumentasi terpisah untuk menggunakan subperintah seperti `pip install`.
> Informasi lebih lanjut: <https://pip.pypa.io>.
- Memasang paket:

View File

@ -1,6 +1,7 @@
# vue
> CLI serba guna untuk Vue.js.
> Kami mempunyai dokumentasi terpisah untuk menggunakan subperintah seperti `vue build`.
> Informasi lebih lanjut: <https://cli.vuejs.org>.
- Buat proyek vue baru secara interaktif:

View File

@ -1,6 +1,7 @@
# adb
> 安卓调试桥:与 Android 模拟器或已连接的 Android 设备通信。
> 此命令也有关于其子命令的文件,例如:`adb shell`.
> 更多信息:<https://developer.android.com/studio/command-line/adb>.
- 检查 adb server 进程的是否在运行,并开启它:

View File

@ -1,7 +1,7 @@
# ansible
> 通过 SSH 协议远程管理计算机组。
> 使用 `/etc/ansible/hosts` 文件来添加组 / 主机。
> 通过 SSH 协议远程管理计算机组。使用 `/etc/ansible/hosts` 文件来添加组 / 主机。
> 此命令也有关于其子命令的文件,例如:`ansible galaxy`.
> 主页: <https://www.ansible.com/>.
- 列出给定组下的所有主机:

View File

@ -1,6 +1,7 @@
# docker
> 管理 Docker 容器和镜像。
> 此命令也有关于其子命令的文件,例如:`docker run`.
> 更多信息:<https://docs.docker.com/engine/reference/commandline/cli/>.
- 列出目前正在运行的 docker 容器:

View File

@ -1,8 +1,7 @@
# vue-cli
> 用于初始化 Vue.js 项目的 CLI.
> 本帮助适用于旧的 `vue-cli@2``@vue/cli-init` 插件,新版 CLI 文档请参见更多信息。
> 官方模板包括webpack, webpack-simple, browserify, browserify-simple, simple.
> 此命令也有关于其子命令的文件,例如:`vue build`.
> 更多信息:<https://cli.vuejs.org>.
- 从模板创建新项目:

View File

@ -1,6 +1,7 @@
# btrfs
> 一种基于写时复制COW原理的 Linux 文件系统。
> 此命令也有关于其子命令的文件,例如:`btrfs device`.
> 更多信息:<https://btrfs.wiki.kernel.org/index.php/Manpage/btrfs>.
- 创建子卷:

View File

@ -1,7 +1,7 @@
# choco
> Chocolatey 包管理器的命令行界面。
> 参见 `choco install`, `choco upgrade` 和其他的页面来获取额外的信息。
> 此命令也有关于其子命令的文件,例如:`choco install`.
- 执行 Chocolatey 命令:

View File

@ -1,7 +1,7 @@
# reg
> 用于在 Windows 注册表中管理键及其值的命令行界面。
> 参见 `reg-query`, `reg-add` 和其他的页面来获取额外的信息。
> 此命令也有关于其子命令的文件,例如:`reg add`.
- 执行注册表命令:

View File

@ -1,6 +1,7 @@
# docker
> 管理 Docker 容器和映像檔。
> 此命令也有關於其子命令的文件,例如:`docker run`.
> 更多資訊:<https://docs.docker.com/engine/reference/commandline/cli/>.
- 列出目前正在運行的 docker 容器:

View File

@ -1,6 +1,7 @@
# adb
> Android Debug Bridge: communicate with an Android emulator instance or connected Android devices.
> Some subcommands such as `adb shell` have their own usage documentation.
> More information: <https://developer.android.com/studio/command-line/adb>.
- Check whether the adb server process is running and start it:

View File

@ -1,6 +1,7 @@
# amass
> In-depth Attack Surface Mapping and Asset Discovery tool.
> Some subcommands such as `amass db` have their own usage documentation.
> More information: <https://github.com/OWASP/Amass>.
- Check the Amass version:

View File

@ -1,7 +1,7 @@
# ansible
> Manage groups of computers remotely over SSH.
> Use the `/etc/ansible/hosts` file to add new groups/hosts.
> Manage groups of computers remotely over SSH. (use the `/etc/ansible/hosts` file to add new groups/hosts).
> Some subcommands such as `ansible galaxy` have their own usage documentation.
> More information: <https://www.ansible.com/>.
- List hosts belonging to a group:

View File

@ -1,7 +1,7 @@
# aws
> The official CLI tool for Amazon Web Services.
> Wizard, SSO, Resource Autocompletion, and YAML options are v2 only.
> Some subcommands such as `aws s3` have their own usage documentation.
> More information: <https://aws.amazon.com/cli>.
- Configure the AWS Command-line:

View File

@ -1,6 +1,7 @@
# az
> The official CLI tool for Microsoft Azure.
> Some subcommands such as `az login` have their own usage documentation.
> More information: <https://docs.microsoft.com/cli/azure>.
- Log in to Azure:

View File

@ -1,6 +1,7 @@
# bundletool
> Command-line tool to manipulate Android Application Bundles.
> Some subcommands such as `bundletool validate` have their own usage documentation.
> More information: <https://developer.android.com/studio/command-line/bundletool>.
- Display help for a subcommand:

View File

@ -1,7 +1,7 @@
# cargo
> Rust package manager.
> Manage Rust projects and their module dependencies (crates).
> Some subcommands such as `cargo build` have their own usage documentation.
> More information: <https://crates.io/>.
- Search for crates:

View File

@ -1,6 +1,7 @@
# conan
> The open source, decentralized and cross-platform package manager to create and share all your native binaries.
> Some subcommands such as `conan frogarian` have their own usage documentation.
> More information: <https://conan.io/>.
- Install packages based on `conanfile.txt`:

View File

@ -1,6 +1,7 @@
# conda
> Package, dependency and environment management for any programming language.
> Some subcommands such as `conda create` have their own usage documentation.
> More information: <https://github.com/conda/conda>.
- Create a new environment, installing named packages into it:

View File

@ -1,6 +1,7 @@
# consul
> Distributed key-value store with health checking and service discovery.
> Some subcommands such as `consul kv` have their own usage documentation.
> More information: <https://www.consul.io/commands>.
- Check the Consul version:

View File

@ -1,7 +1,7 @@
# cradle
> The Cradle PHP framework.
> See `cradle-install`, `cradle-deploy` and other pages for additional information.
> Some subcommands such as `cradle install` have their own usage documentation.
> More information: <https://cradlephp.github.io>.
- Connect to a server:

View File

@ -1,6 +1,7 @@
# docker
> Manage Docker containers and images.
> Some subcommands such as `docker run` have their own usage documentation.
> More information: <https://docs.docker.com/engine/reference/commandline/cli/>.
- List currently running docker containers:

View File

@ -1,6 +1,7 @@
# dolt
> Dolt is an SQL database that you can fork, clone, branch, merge, push and pull just like a Git repository.
> Some subcommands such as `dolt commit` have their own usage documentation.
> More information: <https://github.com/dolthub/dolt>.
- Execute a dolt subcommand:

View File

@ -1,6 +1,7 @@
# dotnet
> Cross platform .NET command-line tools for .NET Core.
> Some subcommands such as `dotnet build` have their own usage documentation.
> More information: <https://docs.microsoft.com/dotnet/core/tools>.
- Initialize a new .NET project:

View File

@ -1,7 +1,7 @@
# drupal
> CLI for Drupal.
> Generates boilerplate code, interacts with and debugs Drupal projects.
> Generate boilerplate code, interact with and debug Drupal projects.
> Some subcommands such as `drupal check` have their own usage documentation.
> More information: <https://drupalconsole.com/>.
- Install a module:

View File

@ -1,6 +1,7 @@
# dvc
> Data Version Control: like `git` for data.
> Some subcommands such as `dvc commit` have their own usage documentation.
> More information: <https://dvc.org/>.
- Check the DVC version:

View File

@ -1,6 +1,7 @@
# fc
> Open the most recent command and edit it.
> Some subcommands such as `fc list` have their own usage documentation.
> More information: <https://manned.org/fc>.
- Open in the default system editor:

View File

@ -1,6 +1,7 @@
# gh
> Work seamlessly with GitHub from the command-line.
> Some subcommands such as `gh config` have their own usage documentation.
> More information: <https://cli.github.com/>.
- Clone a GitHub repository locally:

View File

@ -1,6 +1,7 @@
# git
> Distributed version control system.
> Some subcommands such as `git commit` have their own usage documentation.
> More information: <https://git-scm.com/>.
- Check the Git version:

View File

@ -1,6 +1,7 @@
# gitlab
> Ruby wrapper and CLI for the GitLab API.
> Some subcommands such as `gitlab ctl` have their own usage documentation.
> More information: <https://narkoz.github.io/gitlab/>.
- Create a new project:

View File

@ -1,6 +1,7 @@
# go
> Tool for managing go source code.
> Some subcommands such as `go build` have their own usage documentation.
> More information: <https://golang.org>.
- Download and install a package, specified by its import path:

View File

@ -1,7 +1,7 @@
# hg
> A command-line interface for Mercurial, a distributed source control management system.
> See `hg-add`, `hg-commit` and other pages for additional information.
> Some subcommands such as `hg commit` have their own usage documentation.
> More information: <https://www.mercurial-scm.org>.
- Execute Mercurial command:

View File

@ -1,7 +1,7 @@
# kubectl
> Command-line interface for running commands against Kubernetes clusters.
> See also `kubectl describe` and other pages for additional information.
> Some subcommands such as `kubectl run` have their own usage documentation.
> More information: <https://kubernetes.io/docs/reference/kubectl/>.
- List information about a resource with more details:

View File

@ -1,6 +1,7 @@
# odps
> Aliyun ODPS (Open Data Processing Service) command-line tool.
> Some subcommands such as `odps inst` have their own usage documentation.
> More information: <https://www.alibabacloud.com/help/doc-detail/27971.htm>.
- Start the command-line with a custom configuration file:

View File

@ -1,6 +1,7 @@
# openssl
> OpenSSL cryptographic toolkit.
> Some subcommands such as `openssl req` have their own usage documentation.
> More information: <https://www.openssl.org>.
- Print a list of available subcommands:

View File

@ -1,6 +1,7 @@
# pio
> Development environment for embedded boards.
> Some subcommands such as `pio run` have their own usage documentation.
> More information: <https://docs.platformio.org/en/latest/core/userguide/>.
- Show help and list subcommands:

View File

@ -1,6 +1,7 @@
# pip
> Python package manager.
> Some subcommands such as `pip install` have their own usage documentation.
> More information: <https://pip.pypa.io>.
- Install a package (see `pip install` for more install examples):

View File

@ -1,6 +1,7 @@
# pueue
> Pueue is a command-line task management tool for sequential and parallel execution of long-running tasks.
> Some subcommands such as `pueue add` have their own usage documentation.
> More information: <https://github.com/Nukesor/pueue>.
- Show general help and available subcommands:

View File

@ -1,6 +1,7 @@
# rails
> A server-side MVC framework written in Ruby.
> Some subcommands such as `rails generate` have their own usage documentation.
> More information: <https://guides.rubyonrails.org/command_line.html>.
- Create a new rails project:

View File

@ -1,7 +1,7 @@
# virsh
> Manage virsh guest domains.
> NOTE: 'guest_id' can be the id, name or UUID of the guest.
> Manage virsh guest domains. (NOTE: 'guest_id' can be the id, name or UUID of the guest).
> Some subcommands such as `virsh list` have their own usage documentation.
> More information: <https://libvirt.org/virshcmdref.html>.
- Connect to a hypervisor session:

View File

@ -1,6 +1,7 @@
# vue
> Multi-purpose CLI for Vue.js.
> Some subcommands such as `vue build` have their own usage documentation.
> More information: <https://cli.vuejs.org>.
- Create a new Vue project interactively:

View File

@ -1,6 +1,7 @@
# btrfs
> A filesystem based on the copy-on-write (COW) principle for Linux.
> Some subcommands such as `btrfs device` have their own usage documentation.
> More information: <https://btrfs.wiki.kernel.org/index.php/Manpage/btrfs>.
- Create subvolume:

View File

@ -1,6 +1,7 @@
# dpkg
> Debian package manager.
> Some subcommands such as `dpkg deb` have their own usage documentation.
> More information: <https://manpages.debian.org/buster/dpkg/dpkg.1.en.html>.
- Install a package:

View File

@ -1,6 +1,7 @@
# ip
> Show / manipulate routing, devices, policy routing and tunnels.
> Some subcommands such as `ip address` have their own usage documentation.
> More information: <https://www.man7.org/linux/man-pages/man8/ip.8.html>.
- List interfaces with detailed info:

View File

@ -1,6 +1,7 @@
# nmcli
> A command-line tool for controlling NetworkManager.
> Some subcommands such as `nmcli monitor` have their own usage documentation.
> More information: <https://manned.org/nmcli>.
- Run an `nmcli` subcommand:

View File

@ -1,6 +1,7 @@
# pacman
> Arch Linux package manager utility.
> Some subcommands such as `pacman sync` have their own usage documentation.
> More information: <https://man.archlinux.org/man/pacman.8>.
- Synchronize and update all packages:

View File

@ -1,7 +1,7 @@
# choco
> A command-line interface for the Chocolatey package manager.
> See `choco install`, `choco upgrade` and other pages for additional information.
> Some subcommands such as `choco install` have their own usage documentation.
> More information: <https://chocolatey.org>.
- Execute Chocolatey command:

View File

@ -1,7 +1,7 @@
# reg
> A command-line interface for managing keys and their values in the Windows registry.
> See `reg-query`, `reg-add` and other pages for additional information.
> Some subcommands such as `reg add` have their own usage documentation.
> More information: <https://docs.microsoft.com/windows-server/administration/windows-commands/reg>.
- Execute registry commands: