Merge branch 'main' into lid

This commit is contained in:
Sebastiaan Speck 2023-10-23 22:22:03 +02:00 committed by GitHub
commit d00988304f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8039 changed files with 74156 additions and 4481 deletions

7
.gitattributes vendored
View File

@ -1,8 +1,5 @@
# This ensures that the line endings in any files added or modified are
# normalized before being committed. On Windows they will automatically
# be checked-out as CRLF, and re-converted to LF before check-in.
# See https://git-scm.com/docs/gitattributes for more information.
* text=auto
# https://github.com/tldr-pages/tldr/issues/7097
* text=auto eol=lf
# GitHub linguist ignores markdown files by default, but tldr-pages
# is mostly markdown, so we explicitly make the pages detectable

25
.github/CODEOWNERS vendored Normal file
View File

@ -0,0 +1,25 @@
/pages.de/ @pixelcmtd @marchersimon
/pages.es/ @navarroaxel @kant
/pages.id/ @reinhart1010
/pages.it/ @mebeim @yutyo @Magrid0
/pages.nl/ @sebastiaanspeck
/pages.pl/ @acuteenvy
/pages.pt_BR/ @waldyrious @isaacvicente
/pages.pt_PT/ @waldyrious
/pages.ta/ @kbdharun
/pages.tr/ @yutyo
/pages.zh/ @blueskyson @einverne
/pages.zh_TW/ @blueskyson
/contributing-guides/*.de.md @pixelcmtd @marchersimon
/contributing-guides/*.es.md @navarroaxel @kant
/contributing-guides/*.id.md @reinhart1010
/contributing-guides/*.it.md @mebeim @yutyo @Magrid0
/contributing-guides/*.nl.md @sebastiaanspeck
/contributing-guides/*.pl.md @acuteenvy
/contributing-guides/*.pt_BR.md @waldyrious @isaacvicente
/contributing-guides/*.pt_PT.md @waldyrious
/contributing-guides/*.ta.md @kbdharun
/contributing-guides/*.tr.md @yutyo
/contributing-guides/*.zh.md @blueskyson @einverne
/contributing-guides/*.zh_TW.md @blueskyson

View File

@ -1,8 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Gitter chat
url: https://gitter.im/tldr-pages/tldr
about: You can ask and answer questions here
- name: Matrix Space
- name: Chat room
url: https://matrix.to/#/#tldr-pages:matrix.org
about: Matrix view of our Gitter chat rooms
about: Consider joining the chat room to discuss your issue, question or suggestion with the community before opening an issue.

View File

@ -0,0 +1,25 @@
name: 📄 Page modification request
title: "page modification request: "
description: Page modification request template.
labels: page edit, help wanted
body:
- type: textarea
attributes:
label: Command description
description: Describe the command you want the page(s) to be modified.
placeholder: Tell us about the changes in the command!
- type: input
attributes:
label: Command details
description: Describe any details related to a command.
placeholder: e.g. command version
- type: checkboxes
attributes:
label: OS
description: Select which operating system(s) this command works with.
options:
- label: Android
- label: Linux
- label: macOS (osx)
- label: sunOS
- label: Windows

View File

@ -20,8 +20,7 @@ body:
options:
- label: Android
- label: Linux
- label: macOS
- label: macOS (osx)
- label: sunOS
- label: Windows

18
.github/dependabot.yml vendored Normal file
View File

@ -0,0 +1,18 @@
version: 2
updates:
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "monthly"
- package-ecosystem: "npm"
directory: "/"
schedule:
interval: "monthly"
- package-ecosystem: "pip"
directory: "/"
schedule:
interval: "monthly"
- package-ecosystem: "pip"
directory: "/scripts/pdf"
schedule:
interval: "monthly"

View File

@ -12,7 +12,7 @@ jobs:
name: CI
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- uses: actions/setup-python@v4
with:
@ -43,7 +43,7 @@ jobs:
- name: Build PDF
if: github.repository == 'tldr-pages/tldr' && github.ref == 'refs/heads/main'
working-directory: ./scripts/pdf
run: python render.py ../../pages -c solarized-light
run: bash build-pdf.sh
- name: Deploy
if: github.repository == 'tldr-pages/tldr' && github.ref == 'refs/heads/main'

View File

@ -7,18 +7,18 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- name: Get changed files
id: changed-files
uses: tj-actions/changed-files@v26.1
uses: tj-actions/changed-files@v39.0.0
with:
# Ignore all other languages except English
files_ignore: |
pages.*/*/*
package-lock.json
- uses: codespell-project/actions-codespell@master
- uses: codespell-project/actions-codespell@v2
with:
ignore_words_file: .github/codespell-ignore
# Exit with 0 regardless of typos.

View File

@ -1,18 +0,0 @@
name: Main Mirror
on:
push:
branches: ['main']
permissions: {}
jobs:
mirror:
permissions:
contents: write # to update branch
runs-on: ubuntu-latest
steps:
- uses: zofrex/mirror-branch@v1
with:
target-branch: master

View File

@ -1,52 +0,0 @@
name: 'Manage stale issues'
on:
schedule:
- cron: '0 0 * * *'
permissions: {}
jobs:
stale:
permissions:
issues: write # to close stale issues (actions/stale)
pull-requests: write # to close stale PRs (actions/stale)
runs-on: ubuntu-latest
steps:
- name: Stale Bot
uses: actions/stale@v6
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
# Number of days of inactivity before an issue or PR is considered stale
days-before-pr-stale: 15
days-before-issue-stale: 45
# Number of days of inactivity before a stale issue or PR is closed
days-before-pr-close: 30
days-before-issue-close: 90
# Issues or PRs with these labels will never be considered stale
exempt-pr-labels: stalebot ignore
exempt-issue-labels: stalebot ignore,help wanted
# Label to use when marking an issue or PR as stale
stale-pr-label: waiting
# Comment to post when marking an issue or PR as stale
stale-pr-message: |
Hi all! This thread has not had any recent activity.
Are there any updates? Thanks!
# Comment to post when closing a stale issue or PR
close-pr-message: |
Hi everyone.
This thread is being closed as there was no response to the previous prompt.
However, please leave a comment whenever you're ready to resume, so the thread can be reopened.
Thanks again!

2
.gitignore vendored
View File

@ -27,4 +27,4 @@ scripts/pdf/tldr-pages.pdf
# Python venv for testing the PDF script
# Create it with: python3 -m venv scripts/pdf/venv/
scripts/pdf/venv/
venv

View File

@ -1,6 +1,6 @@
# tldr-pages client specification
**Current Specification Version:** 1.5
**Current Specification Version:** 2.0
This document contains the official specification for tldr-pages clients. It is _not_ a specification of the format of the pages themselves - only a specification of how a user should be able to interface with an official client. For a list of previous versions of the specification, see the [changelog section](#Changelog) below.
@ -9,7 +9,7 @@ The keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SH
## Terminology
In order to aid the understanding of this specification document, a number of terms will be defined in this section.
This section defines key terms that are relevant for understanding this specification document.
### Page
@ -20,7 +20,7 @@ tldr-pages consists of multiple _pages_ - each of which describes a specific com
Pages are grouped by platform, i.e. operating systems — for example, `windows`, `linux`, `osx`.
The special platform `common` contains pages for commands that work identically across more than one platform.
If a page is common across multiple platforms, but slightly differently on a given platform, then the page is still stored in `common`, but a copy tailored for the differing platform is placed in that platform's specific folder.
If a page is common across multiple platforms, but slightly different on a given platform, then the page is still stored in the `common` directory, but a copy tailored for the differing platform is placed in that platform's specific folder.
For example, if the command `foo` is common to `mac`, `windows`, and `linux` but functions differently on `windows`, then the main page will be stored in `common`, and a copy will be placed in `windows` that's altered to match the different functionality.
@ -31,23 +31,23 @@ This section describes the standardised command-line interface (CLI) for clients
### Arguments
A number of command-line options MUST be supported (unless otherwise specified) if a CLI is implemented:
The following command-line options MUST be supported (unless otherwise specified) if a CLI is implemented:
Option | Required? | Meaning
-------------------|-------------|----------
`-v`, `--version` | Yes | Shows the current version of the client, and the version of this specification that it implements.
`-p`, `--platform` | Yes | Specifies the platform to be used to perform the action (either listing or searching) as an argument. If this option is specified, the selected platform MUST be checked first instead of the current platform as described below.
`-u`, `--update` | Conditional | Updates the offline cache of pages. MUST be implemented if cache is supported.
`-u`, `--update` | Conditional | Updates the offline cache of pages. MUST be implemented if caching is supported.
`-l`, `--list` | No | Lists all the pages in the current platform to the standard output.
`-L`, `--language` | No | Specifies the preferred language for the page returned. Overrides other language detection mechanisms. See the [language section](#language) for more information.
Clients MAY choose to only implement the short version of an option, ignoring the long form.
Clients MUST implement both the short and long versions of an option.
Additional decoration MAY be printed if the standard output is a [TTY](http://www.linusakesson.net/programming/tty/index.php). If not, then the output MUST not contain any additional decorations. For example a page list MUST be formatted with 1 page name per line (to enable easy manipulation using standard CLI tools such as `grep` etc.).
Additional decoration MAY be printed if the standard output is a [TTY](http://www.linusakesson.net/programming/tty/index.php). If not, then the output MUST not contain any additional decorations. For example, a page list MUST be formatted with one page name per line (to enable easy manipulation using standard CLI tools such as `grep` etc.).
Clients MAY support additional custom arguments and syntax not documented here.
Here are some examples invocations using the above flags:
Here are some examples of invocations using the above flags:
```bash
tldr --update
@ -131,14 +131,14 @@ After transparently replacing spaces (` `) with dashes (`-`) and lowercasing the
### Platform
Clients MUST default to displaying the page associated with the platform on which the client is running.
For example, a client running on _Windows 10_ will default to displaying pages from the `windows` platform.
For example, a client running on _Windows 11_ will default to displaying pages from the `windows` platform.
Clients MAY provide a user-configurable option to override this behaviour, however.
If a page is not available for the host platform, clients MUST fallback to the special `common` platform.
If a page is not available for the host platform, clients MUST fall back to the special `common` platform.
If a page is not available for either the host platform or the `common` platform, then clients SHOULD search other platforms and display a page from there - along with a warning message.
For example, a user has a client on windows, and requests the `apt` page. The client consults the platforms in the following order:
For example, a user has a client on Windows and requests the `apt` page. The client consults the platforms in the following order:
1. `windows` - Not available
2. `common` - Not available
@ -157,7 +157,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
@ -166,11 +166,11 @@ If multiple versions of a page were found for different platforms, then a client
## Language
Pages can be written in multiple languages. If a client has access to environment variables, it MUST use them derive the preferred user language as described in the next paragraphs. If not, then clients MUST make reasonable assumptions based on the information provided by the environment in which they operate (e.g. consulting `navigator.languages` in a browser, etc.).
Pages can be written in multiple languages. If a client has access to environment variables, it MUST use them to derive the preferred user language as described in the next paragraphs. If not, then clients MUST make reasonable assumptions based on the information provided by the environment in which they operate (e.g. consulting `navigator.languages` in a browser, etc.).
The [`LANG` environment variable](https://www.gnu.org/software/gettext/manual/html_node/Locale-Environment-Variables.html) specifies the user preferred locale (in the form `ll[_CC][.encoding]`). The [`LANGUAGE` environment variable](https://www.gnu.org/software/gettext/manual/html_node/The-LANGUAGE-variable.html) specifies a priority list of locales (in the form `l1:l2:...`) that can be used if the locale defined by `LANG` is not available. Both `LANG` and `LANGUAGE` may contain the values `C` or `POSIX`, which should be ignored.
The [`LANG` environment variable](https://www.gnu.org/software/gettext/manual/html_node/Locale-Environment-Variables.html) specifies the user's preferred locale (in the form `ll[_CC][.encoding]`). The [`LANGUAGE` environment variable](https://www.gnu.org/software/gettext/manual/html_node/The-LANGUAGE-variable.html) specifies a priority list of locales (in the form `l1:l2:...`) that can be used if the locale defined by `LANG` is not available. Both `LANG` and `LANGUAGE` may contain the values `C` or `POSIX`, which should be ignored.
In order to determine the display language, a client MUST:
To determine the display language, a client MUST:
1. Check the value of `LANG`. If not set, then skip to step 5.
2. Extract the priority list from `LANGUAGE`. If not set, start with an empty priority list.
@ -188,13 +188,14 @@ Examples:
unset |`it:cz` | `en`
unset |unset | `en`
Regardless of the language determined through the environment, clients MUST always attempt to fallback to English if the page does not exist in the user preferred language. Clients MAY notify the user when a page in their preferred language cannot be found (optionally including a link to the [translations section of the contributing guide](https://github.com/tldr-pages/tldr/blob/main/CONTRIBUTING.md#translations)).
Regardless of the language determined through the environment, clients MUST always attempt to fall back to English if the page does not exist in the user's preferred language. Clients MAY notify the user when a page in their preferred language cannot be found (optionally including a link to the [translations section of the contributing guide](https://github.com/tldr-pages/tldr/blob/main/CONTRIBUTING.md#translations)).
It is also RECOMMENDED to make the language configurable, as to not only rely on the environment. Clients SHOULD offer options to configure or override the language using configuration files or even command-line options (like `-L, --language` as suggested in the [arguments section](#arguments) above). If such a command-line option is specified, a client must strictly adhere to its value, and MUST NOT show pages in a different language, failing with an appropriate error message instead.
It is also RECOMMENDED to make the language configurable, to not only rely on the environment. Clients SHOULD offer options to configure or override the language using configuration files or even command-line options (like `-L, --language` as suggested in the [arguments section](#arguments) above). If such a command-line option is specified, a client must strictly adhere to its value, and MUST NOT show pages in a different language, failing with an appropriate error message instead.
The [`LC_MESSAGES` environment variable](https://www.gnu.org/software/gettext/manual/html_node/Locale-Environment-Variables.html) MAY be present. If the client itself is localized and this environment variable is present, it MUST use its value in order to determine the language in which interface text is shown (separately from the language used for pages). In absence of `LC_MESSAGES`, then `LANG` and `LANGUAGE` MUST be used for this purpose instead.
The [`LC_MESSAGES` environment variable](https://www.gnu.org/software/gettext/manual/html_node/Locale-Environment-Variables.html) MAY be present. If the client itself is localized and this environment variable is present, it MUST use its value to determine the language in which interface text is shown (separately from the language used for pages). In the absence of `LC_MESSAGES`, then `LANG` and `LANGUAGE` MUST be used for this purpose instead.
**Note that** for page lookup it is highly RECOMMENDED to give precedence to the platform over the language. In other words, look for a platform under each language, before checking the next preferred language. This ensures a meaningful and correct page resolution.
> [!IMPORTANT]
> For page lookup it is highly RECOMMENDED to give precedence to the platform over the language. In other words, look for a platform under each language, before checking the next preferred language. This ensures a meaningful and correct page resolution.
Here's an example of how the lookup should be done on `linux` having set `LANG=it` and `LANGUAGE="it:fr:en"`:
@ -207,9 +208,9 @@ Here's an example of how the lookup should be done on `linux` having set `LANG=i
## Caching
If appropriate, it is RECOMMENDED that clients implement a cache of pages. If implemented, clients MUST download the archive either from **[https://tldr.sh/assets/tldr.zip](https://tldr.sh/assets/tldr.zip)** or [https://raw.githubusercontent.com/tldr-pages/tldr-pages.github.io/master/assets/tldr.zip](https://raw.githubusercontent.com/tldr-pages/tldr-pages.github.io/master/assets/tldr.zip) (which is pointed to by the first link).
If appropriate, it is RECOMMENDED that clients implement a cache of pages. If implemented, clients MUST download the entire archive either as a whole from **[https://tldr.sh/assets/tldr.zip](https://tldr.sh/assets/tldr.zip)** (Which redirects to [https://raw.githubusercontent.com/tldr-pages/tldr-pages.github.io/main/assets/tldr.zip](https://raw.githubusercontent.com/tldr-pages/tldr-pages.github.io/main/assets/tldr.zip)) or download language-specific translation archives in the format `https://tldr.sh/assets/tldr-pages.{{language-code}}.zip` (Which redirects to [https://raw.githubusercontent.com/tldr-pages/tldr-pages.github.io/main/assets/tldr-pages.{{language-code}}.zip](https://raw.githubusercontent.com/tldr-pages/tldr-pages.github.io/main/assets)), along with the archive for English from **[https://tldr.sh/assets/tldr-pages.zip](https://tldr.sh/assets/tldr-pages.zip)** (It redirects to [https://raw.githubusercontent.com/tldr-pages/tldr-pages.github.io/main/assets/tldr-pages.zip](https://raw.githubusercontent.com/tldr-pages/tldr-pages.github.io/main/assets/tldr-pages.zip)).
Caching SHOULD be done according to the user's language configuration (if any), as to not waste unneeded space for unused languages. Additionally, clients MAY automatically update the cache on a regular basis.
Caching SHOULD be done according to the user's language configuration (if any), to not waste unneeded space for unused languages. Additionally, clients MAY automatically update the cache regularly.
## Changelog
@ -225,10 +226,14 @@ including the changes. NOTE: tagging of the commit with a new version tag (in
the form `vX.Y`) should be done immediately AFTER merging the version bump, as
the commit hash changes when merging with squash or rebase.
-->
- Unreleased
- Add recommendation to support `macos` alias for `osx` ([#7514](https://github.com/tldr-pages/tldr/pull/7514))
- Drop the special "all" platform from `--list` flag ([#7561](https://github.com/tldr-pages/tldr/pull/7561))
- [v2.0, September 10th 2023](https://github.com/tldr-pages/tldr/blob/v2.0/CLIENT-SPECIFICATION.md) ([#10148](https://github.com/tldr-pages/tldr/pull/10148))
- Add recommendation to support `macos` alias for `osx` ([#7514](https://github.com/tldr-pages/tldr/pull/7514))
- Drop the special "all" platform from the `--list` flag ([#7561](https://github.com/tldr-pages/tldr/pull/7561))
- Drop the `master` branch from the assets link. ([#9668](https://github.com/tldr-pages/tldr/pull/9668))
- Require support for long options ([#9651](https://github.com/tldr-pages/tldr/pull/9651))
- Add recommendation to support caching individual translation archives ([#10148](https://github.com/tldr-pages/tldr/pull/10148))
- [v1.5, March 17th 2021](https://github.com/tldr-pages/tldr/blob/v1.5/CLIENT-SPECIFICATION.md) ([#5428](https://github.com/tldr-pages/tldr/pull/5428))
- Add requirement for converting command names to lowercase before running the page resolution algorithm.
@ -239,11 +244,11 @@ the commit hash changes when merging with squash or rebase.
- [v1.3, June 11th 2020](https://github.com/tldr-pages/tldr/blob/v1.3/CLIENT-SPECIFICATION.md) ([#4101](https://github.com/tldr-pages/tldr/pull/4101))
- Clarified fallback to English in the language resolution algorithm.
- Update `LANG` and `LANGUAGE` environment variable to conform to the GNU spec.
- Update the `LANG` and `LANGUAGE` environment variables to conform to the GNU spec.
- [v1.2, July 3rd 2019](https://github.com/tldr-pages/tldr/blob/v1.2/CLIENT-SPECIFICATION.md) ([#3168](https://github.com/tldr-pages/tldr/pull/3168))
- Addition of a new `-L, --language` recommended command-line option.
- Rewording of the language section also encouraging the use of configuration files for language.
- Rewording of the language section, also encouraging the use of configuration files for language.
- Shift from BCP-47 to POSIX style locale tags, with consequent **deprecation of previous versions of the spec**.
- Clearer clarification about the recommended caching functionality.
- Correction of the usage of the term "arguments" in the homonym section.

View File

@ -46,8 +46,9 @@ exceptions can always be considered, via open community discussion.)
This means they will be able to
push commits to all of the organization's repositories,
merge PRs, label and close issues, among other things.
_Note_: All members of the tldr-pages organization
must make their membership public.
> [!NOTE]
> All members of the tldr-pages organization
> must make their membership public.
- **Organization members who remain active for a while should become organization owners.**
Specifically: members of the tldr-pages organization
@ -78,8 +79,9 @@ exceptions can always be considered, via open community discussion.)
## How to change roles
*Note: This section is aimed at owners in the tldr-pages organization
(i.e. the group of people who are able to perform these changes).*
> [!NOTE]
> This section is aimed at owners in the tldr-pages organization
> (i.e. the group of people who are able to perform these changes).
If you notice a contributor being particularly active,
review their recent contributions to check whether a role transition is due,
@ -126,7 +128,7 @@ using one of the template messages below as a base.
According to our [community roles documentation](https://github.com/tldr-pages/tldr/blob/main/COMMUNITY-ROLES.md), you've now met the thresholds to be effectively considered an active maintainer of the project.
To publicly acknowledge that fact, we'd like to add you to the tldr-pages organization.
If you accept the invitation, we ask you to make your membership public, and (in case you don't already) start hanging out in our Gitter chat room.
If you accept the invitation, we ask you to make your membership public, and (in case you don't already) start hanging out in our [Matrix chat room](https://matrix.to/#/#tldr-pages:matrix.org).
Additionally, consider subscribing to the notifications from the various repositories under the [tldr-pages organization](https://github.com/tldr-pages).
As one of the public faces of the tldr-pages project, it's also especially important that you follow and encourage the [project
governance principles](https://github.com/tldr-pages/tldr/blob/main/COMMUNITY-ROLES.md).

View File

@ -1,21 +1,21 @@
# Contributing
[![Gitter chat][gitter-image]][gitter-url]
[![Matrix chat][matrix-image]][matrix-url]
[![Merged PRs][prs-merged-image]][prs-merged-url]
[![GitHub contributors][contributors-image]][contributors-url]
[![CLA assistant][cla-assistant-image]][cla-assistant-url]
[![license][license-image]][license-url]
[gitter-url]: https://gitter.im/tldr-pages/tldr
[gitter-image]: https://img.shields.io/badge/chat-on_gitter-deeppink
[matrix-url]: https://matrix.to/#/#tldr-pages:matrix.org
[matrix-image]: https://img.shields.io/matrix/tldr-pages:matrix.org?label=Chat+on+Matrix
[prs-merged-url]: https://github.com/tldr-pages/tldr/pulls?q=is:pr+is:merged
[prs-merged-image]: https://img.shields.io/github/issues-pr-closed-raw/tldr-pages/tldr.svg?label=merged+PRs&color=green
[prs-merged-image]: https://img.shields.io/github/issues-pr-closed-raw/tldr-pages/tldr.svg?label=Merged+PRs&color=green
[contributors-url]: https://github.com/tldr-pages/tldr/graphs/contributors
[contributors-image]: https://img.shields.io/github/contributors/tldr-pages/tldr.svg
[contributors-image]: https://img.shields.io/github/contributors/tldr-pages/tldr.svg?label=Contributors
[cla-assistant-url]: https://cla-assistant.io/tldr-pages/tldr
[cla-assistant-image]: https://cla-assistant.io/readme/badge/tldr-pages/tldr
[license-url]: https://github.com/tldr-pages/tldr/blob/main/LICENSE.md
[license-image]: https://img.shields.io/badge/license-CC_BY_4.0-blue.svg
[license-image]: https://img.shields.io/badge/license-CC_BY_4.0-blue.svg?label=License
Contributions to the tldr-pages project are [most welcome](GOVERNANCE.md)!
All `tldr` pages are stored in Markdown right here on GitHub.
@ -23,7 +23,8 @@ Just open an issue or send a pull request and we'll incorporate it as soon as po
To get started, please [sign](https://cla-assistant.io/tldr-pages/tldr) the
[Contributor License Agreement](https://gist.github.com/waldyrious/e50feec13683e565769fbd58ce503d4e).
*Note*: when submitting a new command, please base your PR against the `main` branch, and check if there's already a pull request in progress for it.
> [!NOTE]
> When submitting a new command, please base your PR against the `main` branch, and check if there's already a pull request in progress for it.
## Guidelines

View File

@ -38,7 +38,7 @@ Community members are asked to abide by the following principles:
e.g. when setting up services that require passwords,
but otherwise all communications that impact the project
will either happen in issue and PR discussions,
or in the [Gitter chat room](https://gitter.im/tldr-pages/tldr)
or in the [Matrix chat room](https://matrix.to/#/#tldr-pages:matrix.org)
(which is open to all, and publicly logged).
4. **All decisions are made by community consensus**.

View File

@ -1,8 +1,10 @@
# Maintainers
This file contains a list of the maintainers of the tldr-pages project.
Note: only the people marked with **bold** are currently in the indicated role.
The other entries are kept for historical record.
> [!NOTE]
> Only the people marked with **bold** are currently in the indicated role.
> The other entries are kept for historical record.
There are three types of maintainers, as described in
[COMMUNITY-ROLES.md](https://github.com/tldr-pages/tldr/blob/main/COMMUNITY-ROLES.md#when-to-change-roles):
@ -39,33 +41,39 @@ If you are an owner of the organization, you can see an automated list
- **Sahil Dhiman ([@sahilister](https://github.com/sahilister))**:
[27 November 2020](https://github.com/tldr-pages/tldr/issues/4994) - present
- **Adam Herst ([@aherst](https://github.com/aherst))**:
[21 April 2021](https://github.com/tldr-pages/tldr/issues/5810) - present
[21 April 2021](https://github.com/tldr-pages/tldr/issues/5810) present
- **Nicolas Kosinski ([@nicokosi](https://github.com/nicokosi))**:
[03 May 2021](https://github.com/tldr-pages/tldr/issues/5873) — present
- **Patrice Denis ([@patricedenis](https://github.com/patricedenis))**:
[10 May 2021](https://github.com/tldr-pages/tldr/issues/5919) — present
- **Lin Cheng Chieh ([@blueskyson](https://github.com/blueskyson))**:
[12 Aug 2021](https://github.com/tldr-pages/tldr/issues/6330) — present
- **Pixel Häußler ([@pixelcmtd](https://github.com/pixelcmtd))**:
[27 Aug 2021](https://github.com/tldr-pages/tldr/issues/6415) — present
- **Reinhart Previano Koentjoro ([@reinhart1010](https://github.com/reinhart1010))**:
[23 Nov 2021](https://github.com/tldr-pages/tldr/issues/7404) — present
[23 November 2021](https://github.com/tldr-pages/tldr/issues/7404) — present
- **258204 ([@258204](https://github.com/258204))**:
[10 December 2021](https://github.com/tldr-pages/tldr/issues/7522) — present
- **Nicolas Hansse ([@Nico385412](https://github.com/Nico385412))**:
[19 July 2022](https://github.com/tldr-pages/tldr/issues/8224) — present
- **K.B.Dharun Krishna ([@kbdharun](https://github.com/kbdharun))**:
[06 August 2022](https://github.com/tldr-pages/tldr/issues/8309) — present
- **Adrien Thebo ([@adrienthebo](https://github.com/adrienthebo))**:
[17 August 2022](https://github.com/tldr-pages/tldr/issues/8321) — present
- **Cairn ([@CairnThePerson](https://github.com/CairnThePerson))**:
[1 September 2022](https://github.com/tldr-pages/tldr/issues/8438) — present
- **Managor ([@Managor](https://github.com/Managor))**:
[4 September 2023](https://github.com/tldr-pages/tldr/issues/10611) — present
- **Lucas Schneider ([@schneiderl](https://github.com/schneiderl))**:
[11 April 2019](https://github.com/tldr-pages/tldr/issues/2898) — [17 January 2020](https://github.com/tldr-pages/tldr/issues/3764), [7 February 2023](https://github.com/tldr-pages/tldr/issues/10674) — present
- **Isaac Vicente ([@isaacvicente](https://github.com/isaacvicente))**:
[20 September 2023](https://github.com/tldr-pages/tldr/issues/10737) — present
- **Darío Hereñú ([@kant](https://github.com/kant))**:
[20 September 2023](https://github.com/tldr-pages/tldr/issues/10738) — present
- **Juri ([@gutjuri](https://github.com/gutjuri))**:
[06 October 2023](https://github.com/tldr-pages/tldr/issues/10874) — present
- **Sebastiaan Speck ([@sebastiaanspeck](https://github.com/sebastiaanspeck))**:
[19 October 2023](https://github.com/tldr-pages/tldr/issues/11075) — present
- **Magrid0 ([@Magrid0](https://github.com/Magrid0))**:
[22 October 2023](https://github.com/tldr-pages/tldr/issues/11159) — present
- Owen Voke ([@owenvoke](https://github.com/owenvoke))
[11 January 2018](https://github.com/tldr-pages/tldr/issues/1885) — [26 August 2018](https://github.com/tldr-pages/tldr/issues/2258)
- Marco Bonelli ([@mebeim](https://github.com/mebeim)):
[28 January 2019](https://github.com/tldr-pages/tldr/issues/2735) — [8 April 2019](https://github.com/tldr-pages/tldr/issues/2874)
- Lucas Schneider ([@schneiderl](https://github.com/schneiderl)):
[11 April 2019](https://github.com/tldr-pages/tldr/issues/2898) — [17 January 2020](https://github.com/tldr-pages/tldr/issues/3764)
- Ein Verne ([@einverne](https://github.com/einverne)):
[27 October 2019](https://github.com/tldr-pages/tldr/issues/3488) — [6 January 2020](https://github.com/tldr-pages/tldr/issues/3738)
- Zlatan Vasović ([@zlatanvasovic](https://github.com/zlatanvasovic)):
@ -90,8 +98,16 @@ If you are an owner of the organization, you can see an automated list
[6 September 2018](https://github.com/tldr-pages/tldr/issues/2306) — [21 June 2021](https://github.com/tldr-pages/tldr/issues/6142)
- Seth Falco ([@SethFalco](https://github.com/SethFalco)):
[19 May 2021](https://github.com/tldr-pages/tldr/issues/5993) - [21 June 2021](https://github.com/tldr-pages/tldr/issues/6149)
- Pixel Häußler ([@pixelcmtd](https://github.com/pixelcmtd)):
[27 August 2021](https://github.com/tldr-pages/tldr/issues/6415) — [16 October 2022](https://github.com/tldr-pages/tldr/pull/9072#issuecomment-1279847932)
- Emily Grace Seville ([@EmilySeville7cfg](https://github.com/EmilySeville7cfg)):
[19 January 2022](https://github.com/tldr-pages/tldr/issues/1209#issuecomment-285924778) — [24 April 2022](https://github.com/tldr-pages/tldr/issues/8053)
- K.B.Dharun Krishna ([@kbdharun](https://github.com/kbdharun)):
[06 August 2022](https://github.com/tldr-pages/tldr/issues/8309) — [14 December 2022](https://github.com/tldr-pages/tldr/issues/9625)
- Lin Cheng Chieh ([@blueskyson](https://github.com/blueskyson)):
[12 August 2021](https://github.com/tldr-pages/tldr/issues/6330) — [4 January 2023](https://github.com/tldr-pages/tldr/issues/9671)
- Lena ([@acuteenvy](https://github.com/acuteenvy)):
[13 May 2023](https://github.com/tldr-pages/tldr/issues/10187) — [21 June 2023](https://github.com/tldr-pages/tldr/issues/10406)
## Organization members
@ -105,17 +121,15 @@ An automated list can be found [here](https://github.com/orgs/tldr-pages/people)
- **Ein Verne ([@einverne](https://github.com/einverne))**:
[6 January 2020](https://github.com/tldr-pages/tldr/issues/3738) — present
- **Matthew Peveler ([@MasterOdin](https://github.com/MasterOdin))**:
[18 March 2021](https://github.com/tldr-pages/tldr/issues/5473) - present
[18 March 2021](https://github.com/tldr-pages/tldr/issues/5473) present
- **Tan Siret Akıncı ([@yutyo](https://github.com/yutyo))**:
[7 April 2021](https://github.com/tldr-pages/tldr/issues/5702) - present
[7 April 2021](https://github.com/tldr-pages/tldr/issues/5702) present
- **Florian Benscheidt ([@Waples](https://github.com/Waples))**:
[19 May 2021](https://github.com/tldr-pages/tldr/issues/5989) — present
- **Muhammad Falak R Wani ([@mfrw](https://github.com/mfrw))**:
[21 June 2021](https://github.com/tldr-pages/tldr/issues/6142) — present
- **Seth Falco ([@SethFalco](https://github.com/SethFalco))**:
[21 June 2021](https://github.com/tldr-pages/tldr/issues/6149) — present
- **Emily Grace Seville ([@EmilySeville7cfg](https://github.com/EmilySeville7cfg))**:
[25 April 2022](https://github.com/tldr-pages/tldr/issues/8053) — present
- **Lena ([@acuteenvy](https://github.com/acuteenvy))**:
[21 June 2023](https://github.com/tldr-pages/tldr/issues/10406) — present
- Owen Voke ([@owenvoke](https://github.com/owenvoke))
[26 August 2018](https://github.com/tldr-pages/tldr/issues/2258) — [8 May 2019](https://github.com/tldr-pages/tldr/issues/2989)
- Marco Bonelli ([@mebeim](https://github.com/mebeim)):
@ -127,11 +141,21 @@ An automated list can be found [here](https://github.com/orgs/tldr-pages/people)
- Axel Navarro ([@navarroaxel](https://github.com/navarroaxel)):
[5 October 2020](https://github.com/tldr-pages/tldr/issues/4504) — [7 April 2021](https://github.com/tldr-pages/tldr/issues/5703)
- bl-ue ([@bl-ue](https://github.com/bl-ue)):
[2 February 2021](https://github.com/tldr-pages/tldr/issues/5219) — [25 June 2021](https://gitter.im/tldr-pages/tldr?at=60d615598a40b117282a96d7)
[2 February 2021](https://github.com/tldr-pages/tldr/issues/5219) — [25 June 2021](https://matrix.to/#/!zXiOpjSkFTvtMpsenJ:gitter.im/$qCyBANu8Ub_GKJgwh0zKlVSgWASLYxYJXBn4NDEEQPw)
- CleanMachine1 ([@CleanMachine1](https://github.com/CleanMachine1)):
[14 June 2021](https://github.com/tldr-pages/tldr/issues/6123) — [14 December 2021](https://github.com/tldr-pages/tldr/issues/7541)
- Marcher Simon ([@marchersimon](https://github.com/marchersimon)):
[9 April 2021](https://github.com/tldr-pages/tldr/issues/5722) — [9 August 2022](https://github.com/tldr-pages/tldr/issues/7540)
- Emily Grace Seville ([@EmilySeville7cfg](https://github.com/EmilySeville7cfg)):
[25 April 2022](https://github.com/tldr-pages/tldr/issues/8053) — [12 January 2022](https://matrix.to/#/!zXiOpjSkFTvtMpsenJ:gitter.im/$n3Jk7mhIzG6edTVUv6MkAoX_1N5z5MPRj2hclyrfKBI)
- Pixel Häußler ([@pixelcmtd](https://github.com/pixelcmtd)):
[16 October 2022](https://github.com/tldr-pages/tldr/pull/9072#issuecomment-1279847932) — [10 May 2023](https://github.com/tldr-pages/tldr/pull/10056)
- Muhammad Falak R Wani ([@mfrw](https://github.com/mfrw)):
[21 June 2021](https://github.com/tldr-pages/tldr/issues/6142) — [9 June 2023](https://github.com/tldr-pages/tldr/issues/10053)
- K.B.Dharun Krishna ([@kbdharun](https://github.com/kbdharun)):
[14 December 2022](https://github.com/tldr-pages/tldr/issues/9625) — [19 June 2023](https://github.com/tldr-pages/tldr/issues/10057)
- Lin Cheng Chieh ([@blueskyson](https://github.com/blueskyson)):
[4 January 2023](https://github.com/tldr-pages/tldr/issues/9671) — [7 July 2023](https://github.com/tldr-pages/tldr/issues/10054)
## Organization owners
@ -142,21 +166,27 @@ An automated list can be found [here](https://github.com/orgs/tldr-pages/people)
- **Romain Prieto ([@rprieto](https://github.com/rprieto))**:
created the project on [8 December 2013](https://github.com/tldr-pages/tldr/commit/11264d9b19000734a2d35ecbdbdebc0b0b45aed9)
- **Agniva De Sarker ([@agnivade](https://github.com/agnivade))**:
[27 September 2016](https://gitter.im/tldr-pages/tldr?at=57eaedefe4e41c6a4afc2f47) — present
[21 September 2016](https://github.com/tldr-pages/tldr/issues/9899) — present
- **Starbeamrainbowlabs ([@sbrl](https://github.com/sbrl))**:
[23 April 2017](https://gitter.im/tldr-pages/tldr?at=58fc6fce3e27cac331b5c397) — present
[19 April 2017](https://github.com/tldr-pages/tldr/issues/9899) — present
- **Owen Voke ([@owenvoke](https://github.com/owenvoke))**
[8 May 2019](https://github.com/tldr-pages/tldr/issues/2989) — present
- **Marco Bonelli ([@mebeim](https://github.com/mebeim))**:
[21 December 2019](https://github.com/tldr-pages/tldr/issues/3672) — present
- **Lucas Schneider ([@schneiderl](https://github.com/schneiderl))**:
[3 February 2021](https://github.com/tldr-pages/tldr/issues/5224) — present
- **Axel Navarro ([@navarroaxel](https://github.com/navarroaxel))**:
[7 April 2021](https://github.com/tldr-pages/tldr/issues/5703) - present
[7 April 2021](https://github.com/tldr-pages/tldr/issues/5703) — present
- **CleanMachine1 ([@CleanMachine1](https://github.com/CleanMachine1))**:
[14 December 2021](https://github.com/tldr-pages/tldr/issues/7541) - present
[14 December 2021](https://github.com/tldr-pages/tldr/issues/7541) present
- **Marcher Simon ([@marchersimon](https://github.com/marchersimon))**:
[9 August 2022](https://github.com/tldr-pages/tldr/issues/7540) — present
- **Pixel Häußler ([@pixelcmtd](https://github.com/pixelcmtd))**:
[10 May 2023](https://github.com/tldr-pages/tldr/pull/10056) — present
- **Muhammad Falak R Wani ([@mfrw](https://github.com/mfrw))**:
[9 June 2023](https://github.com/tldr-pages/tldr/pull/10355) — present
- **K.B.Dharun Krishna ([@kbdharun](https://github.com/kbdharun))**:
[19 June 2023](https://github.com/tldr-pages/tldr/issues/10057) — present
- **Lin Cheng Chieh ([@blueskyson](https://github.com/blueskyson))**:
[7 July 2023](https://github.com/tldr-pages/tldr/issues/10054) — present
- Igor Shubovych ([@igorshubovych](https://github.com/igorshubovych)):
until [18 January 2018](https://github.com/tldr-pages/tldr/issues/1878#issuecomment-358610454)
- Ruben Vereecken ([@rubenvereecken](https://github.com/rubenvereecken)):
@ -175,3 +205,5 @@ An automated list can be found [here](https://github.com/orgs/tldr-pages/people)
until [26 August 2018](https://github.com/tldr-pages/tldr/issues/2257)
- Zlatan Vasović ([@zlatanvasovic](https://github.com/zlatanvasovic)):
until [14 December 2021](https://github.com/tldr-pages/tldr/issues/7538)
- Lucas Schneider ([@schneiderl](https://github.com/schneiderl)):
until [7 February 2023](https://github.com/tldr-pages/tldr/issues/10674)

View File

@ -2,21 +2,21 @@
<h1><a href="https://tldr.sh/"><img alt="tldr-pages" src="images/banner.png" width=600/></a></h1>
[![Build status][github-actions-image]][github-actions-url]
[![Gitter chat][gitter-image]][gitter-url]
[![Matrix chat][matrix-image]][matrix-url]
[![Merged PRs][prs-merged-image]][prs-merged-url]
[![GitHub contributors][contributors-image]][contributors-url]
[![license][license-image]][license-url]
[github-actions-url]: https://github.com/tldr-pages/tldr/actions
[github-actions-image]: https://img.shields.io/github/workflow/status/tldr-pages/tldr/CI.svg
[gitter-url]: https://gitter.im/tldr-pages/tldr
[gitter-image]: https://img.shields.io/badge/chat-on_gitter-deeppink
[github-actions-image]: https://img.shields.io/github/actions/workflow/status/tldr-pages/tldr/ci.yml?branch=main&label=Build
[matrix-url]: https://matrix.to/#/#tldr-pages:matrix.org
[matrix-image]: https://img.shields.io/matrix/tldr-pages:matrix.org?label=Chat+on+Matrix
[prs-merged-url]: https://github.com/tldr-pages/tldr/pulls?q=is:pr+is:merged
[prs-merged-image]: https://img.shields.io/github/issues-pr-closed-raw/tldr-pages/tldr.svg?label=merged+PRs&color=green
[prs-merged-image]: https://img.shields.io/github/issues-pr-closed-raw/tldr-pages/tldr.svg?label=Merged+PRs&color=green
[contributors-url]: https://github.com/tldr-pages/tldr/graphs/contributors
[contributors-image]: https://img.shields.io/github/contributors-anon/tldr-pages/tldr.svg
[contributors-image]: https://img.shields.io/github/contributors-anon/tldr-pages/tldr.svg?label=Contributors
[license-url]: https://github.com/tldr-pages/tldr/blob/main/LICENSE.md
[license-image]: https://img.shields.io/badge/license-CC_BY_4.0-blue.svg
[license-image]: https://img.shields.io/badge/license-CC_BY_4.0-blue.svg?label=License
</div>
## What is tldr-pages?
@ -27,19 +27,23 @@ to traditional [man pages](https://en.wikipedia.org/wiki/Man_page).
Maybe you're new to the command-line world? Perhaps you're just a little rusty or can't always recall the arguments for commands like `lsof`, or `tar`?
It certainly doesn't help that the first option explained in `man tar` is:
It certainly doesn't help that, in the past, the first option explained in `man tar` was:
```
```console
$ man tar
...
-b blocksize
Specify the block size, in 512-byte records, for tape drive I/O.
As a rule, this argument is only needed when reading from or writing to tape drives,
and usually not even then as the default block size of 20 records (10240 bytes) is very common.
...
```
There seems to be room for simpler help pages, focused on practical examples.
How about:
![Animated SVG of the tldr client displaying the tar command.](images/tldr.svg)
![Screenshot of the tldr client displaying the tar command in light mode.](images/tldr-light.png#gh-light-mode-only)
![Screenshot of the tldr client displaying the tar command in dark mode.](images/tldr-dark.png#gh-dark-mode-only)
This repository is just that: an ever-growing collection of examples
for the most common UNIX, Linux, macOS, SunOS, Android and Windows command-line tools.
@ -54,12 +58,18 @@ which is supported by the tldr-pages project maintainers:
npm install -g tldr
```
Alternatively, you can also use the [Python client](https://github.com/tldr-pages/tldr-python-client) which can be installed via `pip3`.
Alternatively, you can also use the [Python client](https://github.com/tldr-pages/tldr-python-client), which can be installed via `pip3`.
```sh
pip3 install tldr
```
Or Mac users can also install our [C Client](https://github.com/tldr-pages/tldr-c-client) using Homebrew.
```sh
brew install tldr
```
Then you have direct access to simplified, easy-to-read help for commands, such as `tar`,
accessible through typing `tldr tar` instead of the standard `man tar`.
@ -67,7 +77,7 @@ If you want an offline version without installing any software,
check out the [PDF version](https://tldr.sh/assets/tldr-book.pdf).
For browsing without installing a client to your computer,
see the web client at <https://tldr.ostera.io>.
see the web client at <https://tldr.inbrowser.app> (with offline support using PWA).
There are also **various other clients** provided by the community,
both for the command-line and for other platforms.
@ -96,6 +106,9 @@ to see the overall progress of all translations, and which translations are miss
## Similar projects
- [Command Line Interface Pages](https://github.com/command-line-interface-pages)
allows you to write standardized help pages for CLI, directories and configs.
- [Cheat](https://github.com/cheat/cheat)
allows you to create and view interactive cheatsheets on the command-line.
It was designed to help remind *nix system administrators of options

View File

@ -14,7 +14,8 @@ The overall process should look somewhat like this:
3. Create a feature branch, e.g. named after the command you plan to edit:
`git checkout -b {{branch_name}}`
> :warning: It is bad practice to submit a PR from the `main` branch of your forked repository. Please create pull requests from a well named feature branch.
> [!WARNING]
> It is bad practice to submit a PR from the `main` branch of your forked repository. Please create pull requests from a well named feature branch.
4. Make your changes (edit existing files or create new ones)
@ -24,7 +25,8 @@ The overall process should look somewhat like this:
6. Push the commit(s) to your fork:
`git push origin {{branch_name}}`
> :warning: Please avoid force-pushing since it makes the review process harder.
> [!WARNING]
> Please avoid force-pushing since it makes the review process harder.
7. Go to the GitHub page for your fork and click the green "Compare & pull request" button.

View File

@ -3,14 +3,15 @@
The following guidelines are meant to provide a general basis
for the behavior expected of tldr-pages maintainers.
*Note:* This text is a living standard;
that is, it is meant to *describe* the project's maintenance practices,
rather than *prescribe* them.
As a maintainer, you're expected to refer to it for clarifications
about the collaborative workflows of the project,
but also to propose changes to it
that you feel would make it more useful
as a guideline for current and future maintainers.
> [!NOTE]
> This text is a living standard;
> that is, it is meant to *describe* the project's maintenance practices,
> rather than *prescribe* them.
> As a maintainer, you're expected to refer to it for clarification
> about the collaborative workflows of the project,
> but also to propose changes to it
> that you feel would make it more useful
> as a guideline for current and future maintainers.
## I. Responding to contributions
@ -25,8 +26,8 @@ as a guideline for current and future maintainers.
You can respond yourself
or ask other members to provide their thoughts/opinions.
In addition, if possible, try to hang around in the
[Gitter chat room](https://gitter.im/tldr-pages/tldr)
on a regular basis as well, or at least show up every now and then.
[Matrix chat room](https://matrix.to/#/#tldr-pages:matrix.org)
regularly as well, or at least show up every now and then.
- **Know when and how to say no**.
Sometimes requests or contributions need to be declined,
@ -39,11 +40,11 @@ as a guideline for current and future maintainers.
- Always remember to **thank every contribution**,
even when it can't be accepted (in fact, especially then).
Keep in mind that
[every form of contribution](https://github.com/kentcdodds/all-contributors)
[every form of contribution](https://github.com/all-contributors/all-contributors)
(pull request, feature request, bug report, etc.)
is a voluntary gift of time offered to the tldr-pages project
by someone who cares about it,
so make sure it's clear that that we don't take it for granted.
so make sure it's clear that we don't take it for granted.
- Try to **keep the entire contribution process web-based**, if possible,
to ensure it is accessible and straightforward.
@ -63,15 +64,15 @@ as a guideline for current and future maintainers.
- If a PR fails to get a review from a second maintainer after a few days,
the first maintainer should ping others for review. If it still lingers around
for **over a week without a second maintainers approval**,
the first maintainer can go ahead and merge it.
the first maintainer (if Owner) can go ahead and merge it. Otherwise, a message
can be sent in the chatroom asking other maintainers to review the PR.
- If the only issues holding up a merge are **trivial fixes**
(typos, syntax errors, etc.), and the author doesn't respond in a day or two,
**maintainers can make the necessary changes themselves**,
and proceed with the merge process.
- If a PR **stops getting feedback from the submitter** and is marked as stale
by [probot-stale](../.github/workflows/stale.yml),
- If a PR **stops getting feedback from the submitter** for more than a month,
any maintainer can choose to take over the PR
and make the necessary changes to get the content ready for merging.
@ -85,7 +86,7 @@ as a guideline for current and future maintainers.
or if the multiple commits are not semantically independent changes,
use the `Squash and merge` method.
(Don't forget to clean up the body of the squashed commit message.)
If instead the PR author took the time to craft
If instead, the PR author took the time to craft
individual, informative messages for each commit,
then use the `Rebase and merge` method,
to honor that work and preserve the history of the changes.
@ -93,10 +94,19 @@ as a guideline for current and future maintainers.
is that if there are more "dirty" commits than "clean" commits,
then prefer squash, else do a rebase.
- Although having push access allows committing directly to the repository,
please **create pull requests for all of your changes**,
except the simplest ones (e.g. typo fixes).
- Although having push access allows committing directly to the repository to all branches (except main),
please **create pull requests for all of your changes**.
This ensures that the entire process that regular contributors go through
is also exposed to maintainers,
who can then identify and address bottlenecks or inconveniences.
Similarly, **avoid merging your own PRs** unless approved by other maintainers.
- At the last week of October, all applicable PRs that wouldn't get merged
in time can be labeled as `hacktoberfest-accepted`.
## III. Transparency
- All non-confidential requests/mail made/sent on behalf of the project
should be documented as an issue with the [archive](https://github.com/tldr-pages/tldr/issues?q=label%3Aarchive) label
and must be communicated with other maintainers.
- All repository/organization settings changes must be documented as an issue with the [archive](https://github.com/tldr-pages/tldr/issues?q=label%3Aarchive) label.

View File

@ -2,11 +2,11 @@
Diese Seite listet alle Regeln für `tldr`-Seiten auf.
## Layout
## Layout
Eine Standard-`tldr`-Seite sollte dem folgenden Format entsprechen:
```
```md
# befehl
> Kurze Beschreibung.
@ -26,21 +26,21 @@
Er wird automatisch bei jeder Pull Request ausgeführt,
er kann aber auch manuell installiert werden, um seine Seiten schon vorher zu überprüfen:
```
```sh
npm install --global tldr-lint
tldr-lint {{seite.md}}
```
```
Für andere Optionen von `tldr-lint`, wie zum Beispiel das Linten eines ganzen Verzeichnisses:
[`tldr tldr-lint`](https://github.com/tldr-pages/tldr/blob/main/pages/common/tldr-lint.md). Alternativ, kann man auch den Alias `tldrl` verwenden.
Viele Clients unterstützen die `--render` Flag zum Anzeigen einer Seite:
```
```sh
tldr --render {{seite.md}}
```
```
## Token-Syntax
## Token-Syntax
Eingaben der Nutzer\*innen sollten die `{{Token}}`-Syntax benutzen,
damit `tldr`-Clients sie hervorheben können.
@ -77,15 +77,16 @@
2. Dateiendungen, wie `.dll`.
3. Befehle, wie `ls`.
## Serial Comma
## Serial Comma
Benutze für eine Liste von 3 oder mehr Elementen ein [serial comma](https://en.wikipedia.org/wiki/Serial_comma), um Mehrdeutigkeiten zu verhindern.
> Delete the Git branches, tags and remotes.
Das obige Beispiel nutzt kein serial comma und ist somit mehrdeutig:
* Lösche die Git Branches namens `tags` und `remotes`.
* Lösche die Git Branches und die Git Tags und die Git Remotes.
- Lösche die Git Branches namens `tags` und `remotes`.
- Lösche die Git Branches und die Git Tags und die Git Remotes.
Dies kann durch ein Komma vor "and" oder "or" gelöst werden.

View File

@ -5,6 +5,7 @@
## 레이아웃
각 페이지의 기본 포맷은 다음 템플릿과 일치해야 하며, 다음과 최대 8개의 명령어 예제를 포함해야 합니다:
```md
# 명령어 이름
@ -102,6 +103,7 @@ tldr --render path/to/tldr_page.md
토큰을 선택할 때 다음의 가이드라인을 염두에 두십시오:
### Naming
- 짧지만 설명적인 토큰을 사용하세요.
- 파일 및 디렉토리 경로에 대한 참조의 경우:
`{{path/to/<placeholder>}}`의 포맷을 사용하세요.
@ -125,7 +127,7 @@ tldr --render path/to/tldr_page.md
- 만약 명령어가 파일 시스템이나 장치에 돌이킬 수 없는 변경을 수행하는 경우, 모든 예제를 생각 없이 복사하여 붙여넣을 수 없도록 작성하십시오.
예를 들어 `ddrescue --force --no-scrape /dev/sda /dev/sdb` 대신에 `ddrescue --force --no-scrape {{/dev/sdX}} {{/dev/sdY}}`를 사용하고, *block device*에 `/dev/sda1` 대신 `{{/dev/sdXY}}` 자리 표시자를 사용하세요.
- 명령어가 많은 수의 명령어를 포함할 수 있는 경우, 다음과 같이 생략하여 표현하세요.
`{{arg1 arg2 ...}}` 여러 옵션 중 하나가 가능한 경우 `{{either|or}}`로 작성합니다.
`{{argument1 argument2 ...}}` 여러 옵션 중 하나가 가능한 경우 `{{either|or}}`로 작성합니다.
일반적으로, 토큰은 가능한 한 직관적이어야 합니다.
명령을 사용하는 방법을 파악하고 값으로 채우십시오.
@ -150,8 +152,9 @@ tldr --render path/to/tldr_page.md
> Git brances, tags, remotes를 삭제하세요.
위의 예는 직렬 쉼표를 사용하지 않으므로 다음 두 가지 중 하나를 의미할 수 있습니다.
* `tags``remotes`라는 Git branch들을 삭제하세요.
* Git branches, Git tag, Git remotes를 모두 삭제하세요.
- `tags``remotes`라는 Git branch들을 삭제하세요.
- Git branches, Git tag, Git remotes를 모두 삭제하세요.
목록의 마지막 요소에서 "and" 또는 "or" 앞에 쉼표를 삽입하면 이 문제를 해결할 수 있습니다.

View File

@ -29,7 +29,7 @@ Example:
```md
# krita
> Krita is a sketching and painting program designed for digital artists.
> A sketching and painting program designed for digital artists.
> See also: `gimp`.
> More information: <https://docs.krita.org/en/reference_manual/linux_command_line.html>.
@ -54,7 +54,8 @@ Example:
`krita --fullscreen`
```
> :bulb: The help page can be any documentation/project/tutorial page, not just a man page,
> [!NOTE]
> The help page can be any documentation/project/tutorial page, not just a man page,
> but documentation pages are preferred.
There is a linter that enforces the format above.
@ -102,24 +103,36 @@ Example:
`tldr vim`
```
- Pre-translated alias page templates can be found [here](https://github.com/tldr-pages/tldr/blob/main/contributing-guides/translation-templates/alias-pages.md).
## Token syntax
## Option syntax
User-provided values should use the `{{token}}` syntax
- Use GNU-style **long options** (like `--help` rather than `-h`) when they are cross-platform compatible (intended to work the same across multiple platforms).
- In other cases, use short options (like `-h`).
- Prefer using a space instead of the equals sign (`=`) to separate options from their arguments (i.e. use `--opt arg` instead of `--opt=arg`), unless the program does not support it.
## Placeholder syntax
User-provided values should use the `{{placeholder}}` syntax
in order to allow `tldr` clients to highlight them.
Keep the following guidelines in mind when choosing tokens:
Keep the following guidelines in mind when choosing placeholders:
### Naming
- Use short but descriptive tokens,
such as `{{source_file}}` or `{{wallet.txt}}`.
- Use [`snake_case`](https://wikipedia.org/wiki/snake_case) for multi-word tokens.
- Use an actual value rather than a generic placeholder where appropriate.
For example, use `iostat {{2}}` rather than `iostat {{interval_in_secs}}`.
- Use short but descriptive placeholders,
such as `{{path/to/source_file}}` or `{{path/to/wallet.txt}}`.
- Use [`snake_case`](https://wikipedia.org/wiki/snake_case) for multi-word placeholders.
- Use a generic placeholder rather than an actual value where a generic placeholder is available (but there is an exception to this listed below). For example, use
`iostat {{1..infinity}}` rather than `iostat {{2}}`.
- If there are several consecutive placeholders of the same type
which don't allow adding arbitrary text in them (ranges), then instead of generic placeholders use descriptive ones. For example prefer `input swipe {{x_position}} {{y_position}} {{x_position}} {{y_position}} {{seconds}}`
instead of `input swipe {{-infinity..infinity}} {{-infinity..infinity}} {{-infinity..infinity}} {{-infinity..infinity}} {{1..infinity}}`.
### Paths
- Use `{{filename}}` rather than `{{file_name}}`.
- Use `{{filename}}` when just file name is expected.
- For any reference to paths of files or directories,
use the format `{{path/to/<placeholder>}}`,
except when the location is implicit.
@ -133,40 +146,84 @@ Keep the following guidelines in mind when choosing tokens:
### Extensions
- If a particular extension is expected for the file, append it.
For example, `unrar x {{compressed.rar}}`.
For example, `unrar x {{path/to/compressed.rar}}`.
- In case a generic extension is needed, use `{{.ext}}`, but **only** if an extension is required.
For instance, in `find.md`'s example "Find files by extension" (`find {{root_path}} -name '{{*.ext}}'`)
For instance, in `find.md`'s example "Find files by extension" (`find {{path/to/root}} -name '{{*.ext}}'`)
using `{{*.ext}}` explains the command without being unnecessarily specific;
while in `wc -l {{file}}` using `{{file}}` (without extension) is sufficient.
while in `wc -l {{path/to/file}}` using `{{path/to/file}}` (without extension) is sufficient.
### Grouping placeholders
- If a command can take 0 or more arguments of the same kind, use an ellipsis: `{{placeholder1 placeholder2 ...}}`.
For instance, if multiple paths are expected `{{path/to/directory1 path/to/directory2 ...}}` can be used.
- If a command can take 0 or more arguments of different kinds, use an ellipsis: `{{placeholder1|placeholder2|...}}`.
If there are more than 5 possible values use `|...` after the last item.
- It's impossible to restrict the minimum or (and) maximum placeholder count via `ellipsis`.
It's up to the program to decide how to handle duplicating values, provided syntax
tells no info about whether items are mutually exclusive or not.
### Special cases
- If a command performs irreversible changes to a file system or devices,
write every example in a way that cannot be thoughtlessly copy-pasted.
write every example in a way that cannot be copy pasted thoughtlessly.
For example, instead of `ddrescue --force --no-scrape /dev/sda /dev/sdb`
write `ddrescue --force --no-scrape {{/dev/sdX}} {{/dev/sdY}}`
and use the `{{/dev/sdXY}}` placeholder for *block devices* instead of `/dev/sda1`.
- If a command can take a variable number of arguments, use an ellipsis: `{{arg1 arg2 ...}}`.
If one of the multiple options is possible, write it as `{{either|or}}`.
In general, tokens should make it as intuitive as possible
In general, placeholders should make it as intuitive as possible
to figure out how to use the command and fill it in with values.
Technical wording on description lines should use the `backtick` syntax.
Use backticks on the following:
- Paths, ex. `package.json`, `/etc/package.json`.
- Extensions, ex. `.dll`.
- Commands, ex. `ls`.
- Paths, e.g. `package.json`, `/etc/package.json`.
- Extensions, e.g. `.dll`.
- Commands, e.g. `ls`.
## Imperative Mood
## Descriptions
Example descriptions have to be phrased in imperative mood.
For example, use `List all files`, instead of `Listing all files` or `File listing`.
This also applies to all translations by default, unless otherwise specified in the language-specific section below.
- 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`).
### Imperative Mood
- **All descriptions must be concise and phrased in the imperative mood.**
- This also applies to all translations by default unless otherwise specified in the language-specific section below.
- 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
> `cd` is a system tool, available in Windows, macOS, and Linux, to check out a specific directory to get things done in the Command Prompt, Terminal, and PowerShell.
```
It should instead be simplified to make it easier for everyone to read:
```md
> Change the current working directory.
```
If you are afraid the commands may differ between platforms or operating systems (e.g. Windows vs macOS), most [tldr pages clients](https://github.com/tldr-pages/tldr/wiki/tldr-pages-clients) will choose the most suitable version of the command.
In this case, the information of the Windows version of `cd` (stored in `pages/windows/cd.md`) will be displayed by default to Windows users, and a generic/common version (stored in `pages/common/cd.md`) will be displayed for Linux, macOS, and other platforms.
When writing descriptions for command examples, **check for any grammatical errors**. `Go to the specified directory` is preferred instead of:
- `Going to the specified directory` (should not be in present participle form)
- `This command will go to the specified directory` (it is clear that this example works for *this* comment)
- `Let's go to the specified directory!`
- `Directory change` (use the active form instead of passive, if possible)
For instance, instead of `Listing all files:`, `List all files:` can be be used as the example's description below:
```md
- Listing all files:
`ls`
```
## Serial Comma
When declaring a list of 3 or more items,
- When declaring a list of 3 or more items,
use a [serial comma](https://en.wikipedia.org/wiki/Serial_comma),
also known as the Oxford comma,
since omitting it can create ambiguity.
@ -174,8 +231,9 @@ since omitting it can create ambiguity.
> Delete the Git branches, tags and remotes.
The example above does not use a serial comma, so this could mean one of two things:
* Delete the Git branches named `tags` and `remotes`.
* Delete all of the following: Git branches, Git tags, and Git remotes.
- Delete the Git branches named `tags` and `remotes`.
- Delete all of the following: Git branches, Git tags, and Git remotes.
This can be resolved by inserting a comma before the "and" or "or" in the final element in the list.
@ -185,7 +243,7 @@ This can be resolved by inserting a comma before the "and" or "or" in the final
On the `More information` line, prefer linking to the author's provided documentation.
When not available, use <https://manned.org> as the default fallback.
When not available, use <https://manned.org> as the default fallback.
## Language-Specific Rules
@ -193,22 +251,33 @@ When not available, use <https://manned.org> as the default fallback.
When Chinese words, Latin words and Arabic numerals are written in the same sentence, more attention must be paid to copywriting.
The following guidelines are applied to Chinese (zh) and traditional Chinese (zh_TW):
The following guidelines are applied to Chinese (`zh`) and traditional Chinese (`zh_TW`) pages:
1. Place one space before/after English words and numbers.
For example, use `列出所有 docker 容器` rather than `列出所有docker容器`.
For example, use `宽度为 50 个字` rather than `宽度为50个字`.
2. Place one space between numbers and units **except** degrees and percentages.
For example, use `容量 50 MB` rather than `容量 50MB`.
For instances of degree and percentage, use `50°C` and `50%` rather than `50 °C` and `50 %`.
3. No additional spaces before/after full-width punctuations.
For example, use `开启 shell进入交互模式` rather than `开启 shell ,进入交互模式`
4. Use full-width punctuations except for long Latin clauses.
For example, use `嗨,你好。` rather than `嗨, 你好.`
5. Use a half-width punctuation to end a sentence when the last character is half-width.
For example, use `将代码转化为 Python 3.` rather than `将代码转化为 Python 3。`
6. Use precise form for technical terms, and do not use unofficial Chinese abbreviations.
For example, use `Facebook` rather than `facebook`, `fb` or `脸书`.
1. Place one space before/after English words and numbers.
- For example, use `列出所有 docker 容器` rather than `列出所有docker容器`.
- For example, use `宽度为 50 个字` rather than `宽度为50个字`.
2. Place one space between numbers and units **except** degrees and percentages.
- For example, use `容量 50 MB` rather than `容量 50MB`.
- For instances of degree and percentage, use `50°C` and `50%` rather than `50 °C` and `50 %`.
3. No additional spaces before/after full-width punctuations.
- For example, use `开启 shell进入交互模式` rather than `开启 shell ,进入交互模式`
4. Use full-width punctuations except for long Latin clauses.
- For example, use `嗨,你好。` rather than `嗨, 你好.`
5. Use a half-width punctuation to end a sentence when the last character is half-width.
- For example, use `将代码转化为 Python 3.` rather than `将代码转化为 Python 3。`
6. Use precise form for technical terms, and do not use unofficial Chinese abbreviations.
- For example, use `Facebook` rather than `facebook`, `fb` or `脸书`.
In order to maintain readability and normalization, please comply with the 6 rules above as much as possible when translating pages into Chinese.

View File

@ -8,7 +8,7 @@
首先,你的页面应该看起来像这样:
```
```md
# 命令名称
> 短小精悍的描述。
@ -28,7 +28,7 @@
你也可以在提交前在本地测试自己的贡献:
```
```sh
npm install --global tldr-lint
tldr-lint {{page.md}}
```
@ -37,12 +37,11 @@ tldr-lint {{page.md}}
如果你用 tldr-pages 的 Node.js 客户端,你可以在命令后加 `-f` (`--render`) 来在本地预览自己的页面:
```
```sh
tldr --render {{page.md}}
```
## 占位符 (token) 语法
## 占位符token语法
当命令涉及用户自己提供的值时,请用 `{{token}}` 语法来使 `tldr` 客户端自动高亮它们:
@ -84,7 +83,7 @@ tldr --render {{page.md}}
以下规则适用于中文zh和繁体中文zh_TW
1. 在西文单词和数字前后放置一个空格。
例如:`列出所有 docker 容器` 而不是 `列出所有docker容器`
例如:`列出所有 docker 容器` 而不是 `列出所有docker容器`
例如:`宽度为 50 个字` 而不是 `宽度为50个字`
2. 除了度数和百分比,在数字和单位之间留一个空格。
例如:`容量 50 MB` 而不是 `容量 50MB`
@ -101,4 +100,3 @@ tldr --render {{page.md}}
为保持可读性和一致性,将页面翻译成中文时,请尽可能遵守以上 6 条规则。
有关更多中西文混排规则的信息,请参考 [《中文文案排版指北》](https://github.com/sparanoid/chinese-copywriting-guidelines)。

View File

@ -11,6 +11,7 @@ The templates can be changed when necessary.
[bn](#bn) •
[bs](#bs) •
[ca](#ca) •
[cs](#cs) •
[da](#da) •
[de](#de) •
[es](#es) •
@ -41,7 +42,9 @@ The templates can be changed when necessary.
[uz](#uz) •
[zh](#zh) •
[zh_TW](#zh_tw)
---
### en
```markdown
@ -55,6 +58,7 @@ The templates can be changed when necessary.
```
---
### ar
```markdown
@ -68,11 +72,21 @@ The templates can be changed when necessary.
```
---
### bn
Not translated yet.
```markdown
# example
> এই কমান্ড একটি উপনাম `example`.
- মূল কমান্ডের জন্য ডকুমেন্টেশন দেখুন:
`tldr example`
```
---
### bs
```markdown
@ -86,6 +100,7 @@ Not translated yet.
```
---
### ca
```markdown
@ -99,6 +114,21 @@ Not translated yet.
```
---
### cs
```markdown
# example
> Tento příkaz je aliasem pro `example`.
- Podívejte se na dokumentaci původního příkazu:
`tldr example`
```
---
### da
```markdown
@ -112,6 +142,7 @@ Not translated yet.
```
---
### de
```markdown
@ -125,6 +156,7 @@ Not translated yet.
```
---
### es
```markdown
@ -138,11 +170,21 @@ Not translated yet.
```
---
### fa
Not translated yet.
```markdown
# example
> این دستور یک نام مستعار از `example` است.
- مشاهده مستندات دستور اصلی :
`tldr example`
```
---
### fr
```markdown
@ -156,6 +198,7 @@ Not translated yet.
```
---
### hi
```markdown
@ -169,6 +212,7 @@ Not translated yet.
```
---
### id
```markdown
@ -182,6 +226,7 @@ Not translated yet.
```
---
### it
```markdown
@ -195,6 +240,7 @@ Not translated yet.
```
---
### ja
```markdown
@ -208,6 +254,7 @@ Not translated yet.
```
---
### ko
```markdown
@ -221,6 +268,7 @@ Not translated yet.
```
---
### lo
```markdown
@ -234,6 +282,7 @@ Not translated yet.
```
---
### ml
```markdown
@ -247,6 +296,7 @@ Not translated yet.
```
---
### ne
```markdown
@ -260,6 +310,7 @@ Not translated yet.
```
---
### nl
```markdown
@ -273,6 +324,7 @@ Not translated yet.
```
---
### no
```markdown
@ -286,6 +338,7 @@ Not translated yet.
```
---
### pl
```markdown
@ -293,12 +346,13 @@ Not translated yet.
> To polecenie jest aliasem `example`.
- Zobacz dokumentację orginalnego polecenia:
- Zobacz dokumentację oryginalnego polecenia:
`tldr example`
```
---
### pt_BR
```markdown
@ -312,6 +366,7 @@ Not translated yet.
```
---
### pt_PT
```markdown
@ -325,11 +380,13 @@ Not translated yet.
```
---
### ro
Not translated yet.
---
### ru
```markdown
@ -343,16 +400,27 @@ Not translated yet.
```
---
### sh
Not translated yet.
---
### sr
Not translated yet.
```markdown
# example
> Ова наредба је псеудоним `example`.
- Погледајте документацију за оригиналну команду:
`tldr example`
```
---
### sv
```markdown
@ -366,6 +434,7 @@ Not translated yet.
```
---
### ta
```markdown
@ -379,12 +448,13 @@ Not translated yet.
```
---
### th
```markdown
# example
> คำสั่งนี้เป็นอีกชื่อหนึ่งของคำสั่ง `example`.
> คำสั่งนี้เป็นอีกชื่อหนึ่งของคำสั่ง `example`
- เรียกดูรายละเอียดสำหรับคำสั่งตัวเต็ม:
@ -392,6 +462,7 @@ Not translated yet.
```
---
### tr
```markdown
@ -405,6 +476,7 @@ Not translated yet.
```
---
### uk
```markdown
@ -418,11 +490,21 @@ Not translated yet.
```
---
### uz
Not translated yet.
```markdown
# example
> Ushbu buyruq taxallus `example`.
- Asl buyruq uchun hujjatlarni ko'rish:
`tldr example`
```
---
### zh
```markdown
@ -436,6 +518,7 @@ Not translated yet.
```
---
### zh_TW
```markdown

View File

@ -11,10 +11,11 @@ Only the left-alignment of the header gets lost and has to be re-added again (`|
| bn | | | | | |
| bs | | | | | |
| ca | camí/al/fitxer | camí/al/directori | camí/al/fitxer_o_directori | paquet | nom_usuari |
| cs | cesta/k/souboru | cesta/k/adresari | cesta/k/souboru_ci_adresari | balíček | jmeno_uzivatele |
| da | sti/til/fil | sti/til/mappe | sti/til/fil_eller_mappe | pakke | brugernavn |
| de | pfad/zu/datei | pfad/zu/verzeichnis | pfad/zu/datei_oder_verzeichnis | paket | benutzername |
| es | ruta/al/archivo | ruta/al/directorio | ruta/al/archivo_o_directorio | paquete | nombre_de_usuario |
| fa | | | | | |
| fa | مسیر/به/فایل | مسیر/به/پوشه | مسیر/به/فایل_یا_پوشه | بسته | نام کاربری |
| fr | chemin/vers/fichier | chemin/vers/dossier | chemin/vers/fichier_ou_dossier | paquet | nom_d_utilisateur |
| hi | फ़ाइल/का/पथ | निर्देशिका/का/पथ | फ़ाइल_या_निर्देशिका/का/पथ | पैकेज | उपयोगकर्ता_नाम |
| id | jalan/menuju/file | jalan/menuju/direktori | jalan/menuju/file_atau_direktori | paket | nama_pengguna |
@ -23,11 +24,11 @@ Only the left-alignment of the header gets lost and has to be re-added again (`|
| ko | 경로/대상/파일 | 경로/대상/폴더 | 경로/대상/파일_또는_폴더 | 패키지 | 사용자 명 |
| ml |ഫയലിലേക്കുള്ള/പാത |ഡയറക്ടറിയിലേക്കുള്ള/പാത |ഫയലിലേക്കോ_ഡയറക്ടറിയിലേക്കോ/ഉള്ള/പാത |പാക്കേജ് |ഉപയോക്തൃനാമം |
| ne | फाइल/को/पथ | निर्देशिका/को/पथ | फाइल_वा_निर्देशिका/को/पथ | प्याकेज | प्रयोगकर्ता_नाम |
| nl | pad/naar/bestand | pad/naar/directory | pad/naar/bestand_of_directory | | |
| nl | pad/naar/bestand | pad/naar/map | pad/naar/bestand_of_map | pakket | gebruikersnaam |
| no | | | | | |
| pl | ścieżka/do/pliku | ścieżka/do/katalogu | ścieżka/do/pliku_lub_katalogu | pakiet | nazwa_użytkownika |
| pt_BR | caminho/para/arquivo | caminho/para/diretorio | caminho/para/arquivo_ou_diretorio | pacote | nome_do_usuario |
| pt_PT | | | | | |
| pt_PT | diretório/ficheiro | diretório/ficheiro_ou_diretório | pacote | |
| ro | | | | | |
| ru | путь/до/файла | путь/до/папки | путь/до/файла_или_папки | пакет | имя_пользователя |
| sh | | | | | |

View File

@ -10,6 +10,7 @@ This file contains the translation templates of this notice.
[bn](#bn) •
[bs](#bs) •
[ca](#ca) •
[cs](#cs) •
[da](#da) •
[de](#de) •
[es](#es) •
@ -42,6 +43,7 @@ This file contains the translation templates of this notice.
[zh_TW](#zh_tw)
---
### en
```markdown
@ -49,6 +51,7 @@ Some subcommands such as `example command` have their own usage documentation.
```
---
### ar
```markdown
@ -56,16 +59,19 @@ Some subcommands such as `example command` have their own usage documentation.
```
---
### bn
Not translated yet.
---
### bs
Not translated yet.
---
### ca
```markdown
@ -73,13 +79,23 @@ Alguns subcomandaments com `example command` tenen la seva pròpia documentació
```
---
### da
### cs
```markdown
Visse underkommandoer såsom `example command` har sin egen dokumentation.
Některé dílčí příkazy jako je `example command` mají svou vlastní dokumentaci.
```
---
### da
```markdown
Visse underkommandoer såsom `example command` har sin egen dokumentation.
```
---
### de
```markdown
@ -87,6 +103,7 @@ Manche Unterbefehle wie `example command` sind separat dokumentiert.
```
---
### es
```markdown
@ -94,11 +111,15 @@ Algunos subcomandos, como `example command`, tienen su propia documentación de
```
---
### fa
Not translated yet.
```markdown
برخی از دستورات فرعی مانند `example command` سند استفاده خاص خودشون رو دارند.
```
---
### fr
```markdown
@ -106,6 +127,7 @@ Certaines sous-commandes comme `example command` ont leur propre documentation.
```
---
### hi
```markdown
@ -113,6 +135,7 @@ Certaines sous-commandes comme `example command` ont leur propre documentation.
```
---
### id
```markdown
@ -120,6 +143,7 @@ Kami mempunyai dokumentasi terpisah untuk menggunakan subperintah seperti `examp
```
---
### it
```markdown
@ -127,6 +151,7 @@ Alcuni comandi aggiuntivi, come `example command`, hanno la propria documentazio
```
---
### ja
```markdown
@ -134,21 +159,27 @@ Alcuni comandi aggiuntivi, come `example command`, hanno la propria documentazio
```
---
### ko
Not translated yet.
```markdown
`example command`와 같은 일부 하위 명령에는 자체 사용 설명서가 있습니다.
```
---
### lo
Not translated yet.
---
### ml
Not translated yet.
---
### ne
```markdown
@ -156,6 +187,7 @@ Not translated yet.
```
---
### nl
```markdown
@ -163,16 +195,19 @@ Sommige subcommando's zoals `example command` hebben een eigen documentatie pagi
```
---
### no
Not translated yet.
---
### pl
Not translated yet.
---
### pt_BR
```markdown
@ -180,6 +215,7 @@ Alguns subcomandos como `example command` tem sua própia documentação de uso.
```
---
### pt_PT
```markdown
@ -187,11 +223,13 @@ Alguns subcomandos, como `example command`, tem a sua própria documentação de
```
---
### ro
Not translated yet.
---
### ru
```markdown
@ -199,24 +237,27 @@ Not translated yet.
```
---
### sh
Not translated yet.
---
### sr
Not translated yet.
---
### sv
```markdown
En del underkommandon som t.ex: `example command` har sin egen användningsdokumentation.
```
---
### ta
```markdown
@ -224,11 +265,13 @@ En del underkommandon som t.ex: `example command` har sin egen användningsdokum
```
---
### th
Not translated yet.
---
### tr
```markdown
@ -236,6 +279,7 @@ Not translated yet.
```
---
### uk
```markdown
@ -243,11 +287,13 @@ Not translated yet.
```
---
### uz
Not translated yet.
---
### zh
```markdown
@ -255,6 +301,7 @@ Not translated yet.
```
---
### zh_TW
```markdown

BIN
images/tldr-dark.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 96 KiB

BIN
images/tldr-light.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 100 KiB

View File

@ -1,494 +0,0 @@
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="1250" height="738.14">
<rect width="1250" height="738.14" rx="0" ry="0" class="a" />
<svg height="738.14" viewBox="0 0 125 73.814" width="1250" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<style>@keyframes l{0%{transform:translateX(0)}10.3%{transform:translateX(-125px)}10.5%{transform:translateX(-375px)}19%{transform:translateX(-500px)}20.2%{transform:translateX(-625px)}22.1%{transform:translateX(-750px)}24.9%{transform:translateX(-875px)}27.8%{transform:translateX(-1000px)}29.6%{transform:translateX(-1125px)}31.4%{transform:translateX(-1250px)}32.9%{transform:translateX(-1375px)}35.7%{transform:translateX(-1750px)}44%{transform:translateX(-2000px)}44.2%{transform:translateX(-2250px)}44.5%{transform:translateX(-2625px)}to{transform:translateX(-2750px)}}.a{fill:#000000}.c,.d{fill:#00ff00;font-weight:700;white-space:pre}.d{fill:#00ffff}.e,.g,.h,.i{fill:#ffffff;white-space:pre}.g,.h,.i{fill:#00ff00}.h,.i{fill:#ff0000}.i{fill:#0ff}</style>
<g font-family="Monaco,Consolas,Menlo,'Bitstream Vera Sans Mono','Powerline Symbols',monospace" font-size="1.67">
<defs>
<symbol id="1">
<text y="1.67" class="c"></text>
<text x="3.006" y="1.67" class="d">~</text>
</symbol>
<symbol id="2">
<text y="1.67" class="c"></text>
<text x="3.006" y="1.67" class="d">~</text>
<text x="5.01" y="1.67" class="e">tldr</text>
</symbol>
<symbol id="3">
<text y="1.67" class="c"></text>
<text x="3.006" y="1.67" class="d">~</text>
<text x="5.01" y="1.67" class="e">tldr</text>
<text x="10.02" y="1.67" class="e">tar</text>
</symbol>
<symbol id="4">
<text x="2.004" y="1.67" style="white-space:pre" fill="#fff" font-weight="700">tar</text>
</symbol>
<symbol id="5">
<text x="2.004" y="1.67" class="e">Archiving</text>
<text x="12.024" y="1.67" class="e">utility.</text>
</symbol>
<symbol id="6">
<text x="2.004" y="1.67" class="e">Often</text>
<text x="8.016" y="1.67" class="e">combined</text>
<text x="17.034" y="1.67" class="e">with</text>
<text x="22.044" y="1.67" class="e">a</text>
<text x="24.048" y="1.67" class="e">compression</text>
<text x="36.072" y="1.67" class="e">method,</text>
<text x="44.088" y="1.67" class="e">such</text>
<text x="49.098" y="1.67" class="e">as</text>
<text x="52.104" y="1.67" class="e">gzip</text>
<text x="57.114" y="1.67" class="e">or</text>
<text x="60.12" y="1.67" class="e">bzip2.</text>
</symbol>
<symbol id="7">
<text x="2.004" y="1.67" class="e">More</text>
<text x="7.014" y="1.67" class="e">information:</text>
<text x="20.04" y="1.67" class="e">https://www.gnu.org/software/tar.</text>
</symbol>
<symbol id="8">
<text x="2.004" y="1.67" class="g">-</text>
<text x="4.008" y="1.67" class="g">[c]reate</text>
<text x="13.026" y="1.67" class="g">an</text>
<text x="16.032" y="1.67" class="g">archive</text>
<text x="24.048" y="1.67" class="g">from</text>
<text x="29.058" y="1.67" class="g">[f]iles:</text>
</symbol>
<symbol id="9">
<text x="4.008" y="1.67" class="h">tar</text>
<text x="8.016" y="1.67" class="h">cf</text>
<text x="11.022" y="1.67" class="i">target.tar</text>
<text x="22.044" y="1.67" class="i">file1</text>
<text x="28.056" y="1.67" class="i">file2</text>
<text x="34.068" y="1.67" class="i">file3</text>
</symbol>
<symbol id="10">
<text x="2.004" y="1.67" class="g">-</text>
<text x="4.008" y="1.67" class="g">[c]reate</text>
<text x="13.026" y="1.67" class="g">a</text>
<text x="15.03" y="1.67" class="g">g[z]ipped</text>
<text x="25.05" y="1.67" class="g">archive</text>
<text x="33.066" y="1.67" class="g">from</text>
<text x="38.076" y="1.67" class="g">[f]iles:</text>
</symbol>
<symbol id="11">
<text x="4.008" y="1.67" class="h">tar</text>
<text x="8.016" y="1.67" class="h">czf</text>
<text x="12.024" y="1.67" class="i">target.tar.gz</text>
<text x="26.052" y="1.67" class="i">file1</text>
<text x="32.064" y="1.67" class="i">file2</text>
<text x="38.076" y="1.67" class="i">file3</text>
</symbol>
<symbol id="12">
<text x="2.004" y="1.67" class="g">-</text>
<text x="4.008" y="1.67" class="g">[c]reate</text>
<text x="13.026" y="1.67" class="g">a</text>
<text x="15.03" y="1.67" class="g">g[z]ipped</text>
<text x="25.05" y="1.67" class="g">archive</text>
<text x="33.066" y="1.67" class="g">from</text>
<text x="38.076" y="1.67" class="g">a</text>
<text x="40.08" y="1.67" class="g">directory</text>
<text x="50.1" y="1.67" class="g">using</text>
<text x="56.112" y="1.67" class="g">relative</text>
<text x="65.13" y="1.67" class="g">paths:</text>
</symbol>
<symbol id="13">
<text x="4.008" y="1.67" class="h">tar</text>
<text x="8.016" y="1.67" class="h">czf</text>
<text x="12.024" y="1.67" class="i">target.tar.gz</text>
<text x="26.052" y="1.67" class="h">--directory=</text>
<text x="38.076" y="1.67" class="i">path/to/directory</text>
<text x="56.112" y="1.67" class="h">.</text>
</symbol>
<symbol id="14">
<text x="2.004" y="1.67" class="g">-</text>
<text x="4.008" y="1.67" class="g">E[x]tract</text>
<text x="14.028" y="1.67" class="g">a</text>
<text x="16.032" y="1.67" class="g">(compressed)</text>
<text x="29.058" y="1.67" class="g">archive</text>
<text x="37.074" y="1.67" class="g">[f]ile</text>
<text x="44.088" y="1.67" class="g">into</text>
<text x="49.098" y="1.67" class="g">the</text>
<text x="53.106" y="1.67" class="g">current</text>
<text x="61.122" y="1.67" class="g">directory:</text>
</symbol>
<symbol id="15">
<text x="4.008" y="1.67" class="h">tar</text>
<text x="8.016" y="1.67" class="h">xf</text>
<text x="11.022" y="1.67" class="i">source.tar[.gz|.bz2|.xz]</text>
</symbol>
<symbol id="16">
<text x="2.004" y="1.67" class="g">-</text>
<text x="4.008" y="1.67" class="g">E[x]tract</text>
<text x="14.028" y="1.67" class="g">a</text>
<text x="16.032" y="1.67" class="g">(compressed)</text>
<text x="29.058" y="1.67" class="g">archive</text>
<text x="37.074" y="1.67" class="g">[f]ile</text>
<text x="44.088" y="1.67" class="g">into</text>
<text x="49.098" y="1.67" class="g">the</text>
<text x="53.106" y="1.67" class="g">target</text>
<text x="60.12" y="1.67" class="g">directory:</text>
</symbol>
<symbol id="17">
<text x="4.008" y="1.67" class="h">tar</text>
<text x="8.016" y="1.67" class="h">xf</text>
<text x="11.022" y="1.67" class="i">source.tar[.gz|.bz2|.xz]</text>
<text x="36.072" y="1.67" class="h">--directory=</text>
<text x="48.096" y="1.67" class="i">directory</text>
</symbol>
<symbol id="18">
<text x="2.004" y="1.67" class="g">-</text>
<text x="4.008" y="1.67" class="g">[c]reate</text>
<text x="13.026" y="1.67" class="g">a</text>
<text x="15.03" y="1.67" class="g">compressed</text>
<text x="26.052" y="1.67" class="g">archive</text>
<text x="34.068" y="1.67" class="g">from</text>
<text x="39.078" y="1.67" class="g">[f]iles,</text>
<text x="48.096" y="1.67" class="g">using</text>
<text x="54.108" y="1.67" class="g">[a]rchive</text>
<text x="64.128" y="1.67" class="g">suffix</text>
<text x="71.142" y="1.67" class="g">to</text>
<text x="74.148" y="1.67" class="g">determine</text>
<text x="84.168" y="1.67" class="g">the</text>
<text x="88.176" y="1.67" class="g">compression</text>
<text x="100.2" y="1.67" class="g">program:</text>
</symbol>
<symbol id="19">
<text x="4.008" y="1.67" class="h">tar</text>
<text x="8.016" y="1.67" class="h">caf</text>
<text x="12.024" y="1.67" class="i">target.tar.xz</text>
<text x="26.052" y="1.67" class="i">file1</text>
<text x="32.064" y="1.67" class="i">file2</text>
<text x="38.076" y="1.67" class="i">file3</text>
</symbol>
<symbol id="20">
<text x="2.004" y="1.67" class="g">-</text>
<text x="4.008" y="1.67" class="g">Lis[t]</text>
<text x="11.022" y="1.67" class="g">the</text>
<text x="15.03" y="1.67" class="g">contents</text>
<text x="24.048" y="1.67" class="g">of</text>
<text x="27.054" y="1.67" class="g">a</text>
<text x="29.058" y="1.67" class="g">tar</text>
<text x="33.066" y="1.67" class="g">[f]ile</text>
<text x="40.08" y="1.67" class="g">[v]erbosely:</text>
</symbol>
<symbol id="21">
<text x="4.008" y="1.67" class="h">tar</text>
<text x="8.016" y="1.67" class="h">tvf</text>
<text x="12.024" y="1.67" class="i">source.tar</text>
</symbol>
<symbol id="22">
<text x="2.004" y="1.67" class="g">-</text>
<text x="4.008" y="1.67" class="g">E[x]tract</text>
<text x="14.028" y="1.67" class="g">[f]iles</text>
<text x="22.044" y="1.67" class="g">matching</text>
<text x="31.062" y="1.67" class="g">a</text>
<text x="33.066" y="1.67" class="g">pattern:</text>
</symbol>
<symbol id="23">
<text x="4.008" y="1.67" class="h">tar</text>
<text x="8.016" y="1.67" class="h">xf</text>
<text x="11.022" y="1.67" class="i">source.tar</text>
<text x="22.044" y="1.67" class="h">--wildcards</text>
<text x="34.068" y="1.67" class="h">&quot;</text>
<text x="35.07" y="1.67" class="i">*.html</text>
<text x="41.082" y="1.67" class="h">&quot;</text>
</symbol>
<symbol id="a">
<path fill="transparent" d="M0 0h125v34H0z" />
</symbol>
<symbol id="b">
<path fill="#6f7683" d="M0 0h1.102v2.171H0z" />
</symbol>
</defs>
<path class="a" d="M0 0h125v73.814H0z" />
<g style="animation-duration:6.274285s;animation-iteration-count:infinite;animation-name:l;animation-timing-function:steps(1,end)">
<svg width="2875">
<svg>
<use xlink:href="#a" />
<use xlink:href="#b" x="-.004" />
</svg>
<svg x="125">
<use xlink:href="#a" />
<use xlink:href="#b" x="-.004" />
</svg>
<svg x="250">
<use xlink:href="#a" />
<use xlink:href="#b" x="4.996" />
<use xlink:href="#1" />
</svg>
<svg x="375">
<use xlink:href="#a" />
<use xlink:href="#b" x="4.996" />
<use xlink:href="#1" />
</svg>
<svg x="500">
<use xlink:href="#a" />
<use xlink:href="#b" x="5.996" />
<text y="1.67" class="c"></text>
<text x="3.006" y="1.67" class="d">~</text>
<text x="5.01" y="1.67" class="e">t</text>
</svg>
<svg x="625">
<use xlink:href="#a" />
<use xlink:href="#b" x="6.996" />
<text y="1.67" class="c"></text>
<text x="3.006" y="1.67" class="d">~</text>
<text x="5.01" y="1.67" class="e">tl</text>
</svg>
<svg x="750">
<use xlink:href="#a" />
<use xlink:href="#b" x="7.996" />
<text y="1.67" class="c"></text>
<text x="3.006" y="1.67" class="d">~</text>
<text x="5.01" y="1.67" class="e">tld</text>
</svg>
<svg x="875">
<use xlink:href="#a" />
<use xlink:href="#b" x="8.996" />
<use xlink:href="#2" />
</svg>
<svg x="1000">
<use xlink:href="#a" />
<use xlink:href="#b" x="9.996" />
<use xlink:href="#2" />
</svg>
<svg x="1125">
<use xlink:href="#a" />
<use xlink:href="#b" x="10.996" />
<text y="1.67" class="c"></text>
<text x="3.006" y="1.67" class="d">~</text>
<text x="5.01" y="1.67" class="e">tldr</text>
<text x="10.02" y="1.67" class="e">t</text>
</svg>
<svg x="1250">
<use xlink:href="#a" />
<use xlink:href="#b" x="11.996" />
<text y="1.67" class="c"></text>
<text x="3.006" y="1.67" class="d">~</text>
<text x="5.01" y="1.67" class="e">tldr</text>
<text x="10.02" y="1.67" class="e">ta</text>
</svg>
<svg x="1375">
<use xlink:href="#a" />
<use xlink:href="#b" x="12.996" />
<use xlink:href="#3" />
</svg>
<svg x="1500">
<use xlink:href="#a" />
<use xlink:href="#b" x="12.996" />
<use xlink:href="#3" />
</svg>
<svg x="1625">
<use xlink:href="#a" />
<use xlink:href="#b" x="-.004" y="2.146" />
<use xlink:href="#3" />
</svg>
<svg x="1750">
<use xlink:href="#a" />
<use xlink:href="#b" x="-.004" y="2.146" />
<use xlink:href="#3" />
</svg>
<svg x="1875">
<use xlink:href="#a" />
<use xlink:href="#b" x="47.996" y="45.566" />
<use xlink:href="#3" />
<use xlink:href="#4" y="4.342" />
<use xlink:href="#5" y="8.684" />
<use xlink:href="#6" y="10.855" />
<use xlink:href="#7" y="13.026" />
<use xlink:href="#8" y="17.368" />
<use xlink:href="#9" y="19.539" />
<use xlink:href="#10" y="23.881" />
<use xlink:href="#11" y="26.052" />
<use xlink:href="#12" y="30.394" />
<use xlink:href="#13" y="32.565" />
<use xlink:href="#14" y="36.907" />
<use xlink:href="#15" y="39.078" />
<use xlink:href="#16" y="43.42" />
<text x="4.008" y="47.261" class="h">tar</text>
<text x="8.016" y="47.261" class="h">xf</text>
<text x="11.022" y="47.261" class="i">source.tar[.gz|.bz2|.xz]</text>
<text x="36.072" y="47.261" class="h">--directory=</text>
</svg>
<svg x="2000">
<use xlink:href="#a" />
<use xlink:href="#b" x="-.004" y="71.618" />
<use xlink:href="#3" />
<use xlink:href="#4" y="4.342" />
<use xlink:href="#5" y="8.684" />
<use xlink:href="#6" y="10.855" />
<use xlink:href="#7" y="13.026" />
<use xlink:href="#8" y="17.368" />
<use xlink:href="#9" y="19.539" />
<use xlink:href="#10" y="23.881" />
<use xlink:href="#11" y="26.052" />
<use xlink:href="#12" y="30.394" />
<use xlink:href="#13" y="32.565" />
<use xlink:href="#14" y="36.907" />
<use xlink:href="#15" y="39.078" />
<use xlink:href="#16" y="43.42" />
<use xlink:href="#17" y="45.591" />
<use xlink:href="#18" y="49.933" />
<use xlink:href="#19" y="52.104" />
<use xlink:href="#20" y="56.446" />
<use xlink:href="#21" y="58.617" />
<use xlink:href="#22" y="62.959" />
<use xlink:href="#23" y="65.13" />
</svg>
<svg x="2125">
<use xlink:href="#a" />
<use xlink:href="#b" x="-.004" y="71.618" />
<use xlink:href="#3" />
<use xlink:href="#4" y="4.342" />
<use xlink:href="#5" y="8.684" />
<use xlink:href="#6" y="10.855" />
<use xlink:href="#7" y="13.026" />
<use xlink:href="#8" y="17.368" />
<use xlink:href="#9" y="19.539" />
<use xlink:href="#10" y="23.881" />
<use xlink:href="#11" y="26.052" />
<use xlink:href="#12" y="30.394" />
<use xlink:href="#13" y="32.565" />
<use xlink:href="#14" y="36.907" />
<use xlink:href="#15" y="39.078" />
<use xlink:href="#16" y="43.42" />
<use xlink:href="#17" y="45.591" />
<use xlink:href="#18" y="49.933" />
<use xlink:href="#19" y="52.104" />
<use xlink:href="#20" y="56.446" />
<use xlink:href="#21" y="58.617" />
<use xlink:href="#22" y="62.959" />
<use xlink:href="#23" y="65.13" />
</svg>
<svg x="2250">
<use xlink:href="#a" />
<use xlink:href="#b" x="-.004" y="71.618" />
<use xlink:href="#3" />
<use xlink:href="#4" y="4.342" />
<use xlink:href="#5" y="8.684" />
<use xlink:href="#6" y="10.855" />
<use xlink:href="#7" y="13.026" />
<use xlink:href="#8" y="17.368" />
<use xlink:href="#9" y="19.539" />
<use xlink:href="#10" y="23.881" />
<use xlink:href="#11" y="26.052" />
<use xlink:href="#12" y="30.394" />
<use xlink:href="#13" y="32.565" />
<use xlink:href="#14" y="36.907" />
<use xlink:href="#15" y="39.078" />
<use xlink:href="#16" y="43.42" />
<use xlink:href="#17" y="45.591" />
<use xlink:href="#18" y="49.933" />
<use xlink:href="#19" y="52.104" />
<use xlink:href="#20" y="56.446" />
<use xlink:href="#21" y="58.617" />
<use xlink:href="#22" y="62.959" />
<use xlink:href="#23" y="65.13" />
</svg>
<svg x="2375">
<use xlink:href="#a" />
<use xlink:href="#b" x="4.996" y="71.618" />
<use xlink:href="#3" />
<use xlink:href="#4" y="4.342" />
<use xlink:href="#5" y="8.684" />
<use xlink:href="#6" y="10.855" />
<use xlink:href="#7" y="13.026" />
<use xlink:href="#8" y="17.368" />
<use xlink:href="#9" y="19.539" />
<use xlink:href="#10" y="23.881" />
<use xlink:href="#11" y="26.052" />
<use xlink:href="#12" y="30.394" />
<use xlink:href="#13" y="32.565" />
<use xlink:href="#14" y="36.907" />
<use xlink:href="#15" y="39.078" />
<use xlink:href="#16" y="43.42" />
<use xlink:href="#17" y="45.591" />
<use xlink:href="#18" y="49.933" />
<use xlink:href="#19" y="52.104" />
<use xlink:href="#20" y="56.446" />
<use xlink:href="#21" y="58.617" />
<use xlink:href="#22" y="62.959" />
<use xlink:href="#23" y="65.13" />
<use xlink:href="#1" y="71.643" />
</svg>
<svg x="2500">
<use xlink:href="#a" />
<use xlink:href="#b" x="4.996" y="71.618" />
<use xlink:href="#3" />
<use xlink:href="#4" y="4.342" />
<use xlink:href="#5" y="8.684" />
<use xlink:href="#6" y="10.855" />
<use xlink:href="#7" y="13.026" />
<use xlink:href="#8" y="17.368" />
<use xlink:href="#9" y="19.539" />
<use xlink:href="#10" y="23.881" />
<use xlink:href="#11" y="26.052" />
<use xlink:href="#12" y="30.394" />
<use xlink:href="#13" y="32.565" />
<use xlink:href="#14" y="36.907" />
<use xlink:href="#15" y="39.078" />
<use xlink:href="#16" y="43.42" />
<use xlink:href="#17" y="45.591" />
<use xlink:href="#18" y="49.933" />
<use xlink:href="#19" y="52.104" />
<use xlink:href="#20" y="56.446" />
<use xlink:href="#21" y="58.617" />
<use xlink:href="#22" y="62.959" />
<use xlink:href="#23" y="65.13" />
<use xlink:href="#1" y="71.643" />
</svg>
<svg x="2625">
<use xlink:href="#a" />
<use xlink:href="#b" x="4.996" y="71.618" />
<use xlink:href="#3" />
<use xlink:href="#4" y="4.342" />
<use xlink:href="#5" y="8.684" />
<use xlink:href="#6" y="10.855" />
<use xlink:href="#7" y="13.026" />
<use xlink:href="#8" y="17.368" />
<use xlink:href="#9" y="19.539" />
<use xlink:href="#10" y="23.881" />
<use xlink:href="#11" y="26.052" />
<use xlink:href="#12" y="30.394" />
<use xlink:href="#13" y="32.565" />
<use xlink:href="#14" y="36.907" />
<use xlink:href="#15" y="39.078" />
<use xlink:href="#16" y="43.42" />
<use xlink:href="#17" y="45.591" />
<use xlink:href="#18" y="49.933" />
<use xlink:href="#19" y="52.104" />
<use xlink:href="#20" y="56.446" />
<use xlink:href="#21" y="58.617" />
<use xlink:href="#22" y="62.959" />
<use xlink:href="#23" y="65.13" />
<use xlink:href="#1" y="71.643" />
</svg>
<svg x="2750">
<use xlink:href="#a" />
<use xlink:href="#b" x="-.004" y="71.618" />
<use xlink:href="#4" y="2.171" />
<use xlink:href="#5" y="6.513" />
<use xlink:href="#6" y="8.684" />
<use xlink:href="#7" y="10.855" />
<use xlink:href="#8" y="15.197" />
<use xlink:href="#9" y="17.368" />
<use xlink:href="#10" y="21.71" />
<use xlink:href="#11" y="23.881" />
<use xlink:href="#12" y="28.223" />
<use xlink:href="#13" y="30.394" />
<use xlink:href="#14" y="34.736" />
<use xlink:href="#15" y="36.907" />
<use xlink:href="#16" y="41.249" />
<use xlink:href="#17" y="43.42" />
<use xlink:href="#18" y="47.762" />
<use xlink:href="#19" y="49.933" />
<use xlink:href="#20" y="54.275" />
<use xlink:href="#21" y="56.446" />
<use xlink:href="#22" y="60.788" />
<use xlink:href="#23" y="62.959" />
<use xlink:href="#1" y="69.472" />
</svg>
</svg>
</g>
</g>
</svg>
</svg>

Before

Width:  |  Height:  |  Size: 28 KiB

1044
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -6,12 +6,12 @@
"repository": "tldr-pages/tldr",
"homepage": "https://tldr.sh/",
"dependencies": {
"glob": "7.2.0",
"markdownlint-cli": "^0.31.1",
"glob": "10.3.10",
"markdownlint-cli": "^0.37.0",
"tldr-lint": "^0.0.13"
},
"devDependencies": {
"husky": "^7.0.4"
"husky": "^8.0.3"
},
"scripts": {
"lint-markdown": "markdownlint pages*/**/*.md",

View File

@ -0,0 +1,8 @@
# bundler
> هذا الأمر هو اسم مستعار لـ `bundle`.
> لمزيد من التفاصيل: <https://bundler.io/man/bundle.1.html>.
- إعرض التوثيقات للأمر الأصلي:
`tldr bundle`

View File

@ -0,0 +1,8 @@
# clamav
> هذا الأمر هو اسم مستعار لـ `clamdscan`.
> لمزيد من التفاصيل: <https://www.clamav.net>.
- إعرض التوثيقات للأمر الأصلي:
`tldr clamdscan`

View File

@ -0,0 +1,7 @@
# clang-cpp
> هذا الأمر هو اسم مستعار لـ `clang++`.
- إعرض التوثيقات للأمر الأصلي:
`tldr clang++`

View File

@ -0,0 +1,7 @@
# clojure
> هذا الأمر هو اسم مستعار لـ `clj`.
- إعرض التوثيقات للأمر الأصلي:
`tldr clj`

7
pages.ar/common/cola.md Normal file
View File

@ -0,0 +1,7 @@
# cola
> هذا الأمر هو اسم مستعار لـ `git-cola`.
- إعرض التوثيقات للأمر الأصلي:
`tldr git-cola`

7
pages.ar/common/cron.md Normal file
View File

@ -0,0 +1,7 @@
# cron
> هذا الأمر هو اسم مستعار لـ `crontab`.
- إعرض التوثيقات للأمر الأصلي:
`tldr crontab`

View File

@ -0,0 +1,8 @@
# fossil-ci
> هذا الأمر هو اسم مستعار لـ `fossil-commit`.
> لمزيد من التفاصيل: <https://fossil-scm.org/home/help/commit>.
- إعرض التوثيقات للأمر الأصلي:
`tldr fossil-commit`

View File

@ -0,0 +1,8 @@
# fossil-delete
> هذا الأمر هو اسم مستعار لـ `fossil rm`.
> لمزيد من التفاصيل: <https://fossil-scm.org/home/help/delete>.
- إعرض التوثيقات للأمر الأصلي:
`tldr fossil rm`

View File

@ -0,0 +1,8 @@
# fossil-forget
> هذا الأمر هو اسم مستعار لـ `fossil rm`.
> لمزيد من التفاصيل: <https://fossil-scm.org/home/help/forget>.
- إعرض التوثيقات للأمر الأصلي:
`tldr fossil rm`

View File

@ -0,0 +1,8 @@
# fossil-new
> هذا الأمر هو اسم مستعار لـ `fossil-init`.
> لمزيد من التفاصيل: <https://fossil-scm.org/home/help/new>.
- إعرض التوثيقات للأمر الأصلي:
`tldr fossil-init`

8
pages.ar/common/gh-cs.md Normal file
View File

@ -0,0 +1,8 @@
# gh-cs
> هذا الأمر هو اسم مستعار لـ `gh-codespace`.
> لمزيد من التفاصيل: <https://cli.github.com/manual/gh_codespace>.
- إعرض التوثيقات للأمر الأصلي:
`tldr gh-codespace`

View File

@ -0,0 +1,8 @@
# gnmic-sub
> هذا الأمر هو اسم مستعار لـ `gnmic subscribe`.
> لمزيد من التفاصيل: <https://gnmic.kmrd.dev/cmd/subscribe>.
- إعرض التوثيقات للأمر الأصلي:
`tldr gnmic subscribe`

View File

@ -0,0 +1,8 @@
# google-chrome
> هذا الأمر هو اسم مستعار لـ `chromium`.
> لمزيد من التفاصيل: <https://chrome.google.com>.
- إعرض التوثيقات للأمر الأصلي:
`tldr chromium`

7
pages.ar/common/hx.md Normal file
View File

@ -0,0 +1,7 @@
# hx
> هذا الأمر هو اسم مستعار لـ `helix`.
- إعرض التوثيقات للأمر الأصلي:
`tldr helix`

View File

@ -0,0 +1,7 @@
# kafkacat
> هذا الأمر هو اسم مستعار لـ `kcat`.
- إعرض التوثيقات للأمر الأصلي:
`tldr kcat`

View File

@ -0,0 +1,7 @@
# llvm-ar
> هذا الأمر هو اسم مستعار لـ `ar`.
- إعرض التوثيقات للأمر الأصلي:
`tldr ar`

View File

@ -0,0 +1,7 @@
# llvm-g++
> هذا الأمر هو اسم مستعار لـ `clang++`.
- إعرض التوثيقات للأمر الأصلي:
`tldr clang++`

View File

@ -0,0 +1,7 @@
# llvm-gcc
> هذا الأمر هو اسم مستعار لـ `clang`.
- إعرض التوثيقات للأمر الأصلي:
`tldr clang`

View File

@ -0,0 +1,7 @@
# llvm-nm
> هذا الأمر هو اسم مستعار لـ `nm`.
- إعرض التوثيقات للأمر الأصلي:
`tldr nm`

View File

@ -0,0 +1,7 @@
# llvm-objdump
> هذا الأمر هو اسم مستعار لـ `objdump`.
- إعرض التوثيقات للأمر الأصلي:
`tldr objdump`

View File

@ -0,0 +1,7 @@
# llvm-strings
> هذا الأمر هو اسم مستعار لـ `strings`.
- إعرض التوثيقات للأمر الأصلي:
`tldr strings`

8
pages.ar/common/lzcat.md Normal file
View File

@ -0,0 +1,8 @@
# lzcat
> هذا الأمر هو اسم مستعار لـ `xz`.
> لمزيد من التفاصيل: <https://manned.org/lzcat>.
- إعرض التوثيقات للأمر الأصلي:
`tldr xz`

8
pages.ar/common/lzma.md Normal file
View File

@ -0,0 +1,8 @@
# lzma
> هذا الأمر هو اسم مستعار لـ `xz`.
> لمزيد من التفاصيل: <https://manned.org/lzma>.
- إعرض التوثيقات للأمر الأصلي:
`tldr xz`

View File

@ -0,0 +1,8 @@
# mscore
> هذا الأمر هو اسم مستعار لـ `musescore`.
> لمزيد من التفاصيل: <https://musescore.org/handbook/command-line-options>.
- إعرض التوثيقات للأمر الأصلي:
`tldr musescore`

View File

@ -0,0 +1,7 @@
# nm-classic
> هذا الأمر هو اسم مستعار لـ `nm`.
- إعرض التوثيقات للأمر الأصلي:
`tldr nm`

8
pages.ar/common/ntl.md Normal file
View File

@ -0,0 +1,8 @@
# ntl
> هذا الأمر هو اسم مستعار لـ `netlify`.
> لمزيد من التفاصيل: <https://cli.netlify.com>.
- إعرض التوثيقات للأمر الأصلي:
`tldr netlify`

View File

@ -0,0 +1,7 @@
# pio-init
> هذا الأمر هو اسم مستعار لـ `pio project`.
- إعرض التوثيقات للأمر الأصلي:
`tldr pio project`

View File

@ -0,0 +1,7 @@
# piodebuggdb
> هذا الأمر هو اسم مستعار لـ `pio debug`.
- إعرض التوثيقات للأمر الأصلي:
`tldr pio debug`

View File

@ -0,0 +1,8 @@
# platformio
> هذا الأمر هو اسم مستعار لـ `pio`.
> لمزيد من التفاصيل: <https://docs.platformio.org/en/latest/core/userguide/>.
- إعرض التوثيقات للأمر الأصلي:
`tldr pio`

View File

@ -0,0 +1,7 @@
# ptpython3
> هذا الأمر هو اسم مستعار لـ `ptpython`.
- إعرض التوثيقات للأمر الأصلي:
`tldr ptpython`

12
pages.ar/common/pwd.md Normal file
View File

@ -0,0 +1,12 @@
# pwd
> اطبع اسم الدليل الحالي.
> لمزيد من التفاصيل: <https://www.gnu.org/software/coreutils/pwd>.
- اطبع اسم الدليل الحالي:
`pwd`
- اطبع اسم الدليل الحالي و حل جميع الروابط اللينة (وبمعنى آخر إظهار المسارالفعلي) :
`pwd -P`

View File

@ -0,0 +1,7 @@
# python3
> هذا الأمر هو اسم مستعار لـ `python`.
- إعرض التوثيقات للأمر الأصلي:
`tldr python`

7
pages.ar/common/r2.md Normal file
View File

@ -0,0 +1,7 @@
# r2
> هذا الأمر هو اسم مستعار لـ `radare2`.
- إعرض التوثيقات للأمر الأصلي:
`tldr radare2`

7
pages.ar/common/rcat.md Normal file
View File

@ -0,0 +1,7 @@
# rcat
> هذا الأمر هو اسم مستعار لـ `rc`.
- إعرض التوثيقات للأمر الأصلي:
`tldr rc`

View File

@ -0,0 +1,7 @@
# ripgrep
> هذا الأمر هو اسم مستعار لـ `rg`.
- إعرض التوثيقات للأمر الأصلي:
`tldr rg`

8
pages.ar/common/tldrl.md Normal file
View File

@ -0,0 +1,8 @@
# tldrl
> هذا الأمر هو اسم مستعار لـ `tldr-lint`.
> لمزيد من التفاصيل: <https://github.com/tldr-pages/tldr-lint>.
- إعرض التوثيقات للأمر الأصلي:
`tldr tldr-lint`

View File

@ -0,0 +1,8 @@
# tlmgr-arch
> هذا الأمر هو اسم مستعار لـ `tlmgr platform`.
> لمزيد من التفاصيل: <https://www.tug.org/texlive/tlmgr.html>.
- إعرض التوثيقات للأمر الأصلي:
`tldr tlmgr platform`

View File

@ -0,0 +1,8 @@
# todoman
> هذا الأمر هو اسم مستعار لـ `todo`.
> لمزيد من التفاصيل: <https://todoman.readthedocs.io/>.
- إعرض التوثيقات للأمر الأصلي:
`tldr todo`

View File

@ -0,0 +1,8 @@
# transmission
> هذا الأمر هو اسم مستعار لـ `transmission-daemon`.
> لمزيد من التفاصيل: <https://transmissionbt.com/>.
- إعرض التوثيقات للأمر الأصلي:
`tldr transmission-daemon`

View File

@ -0,0 +1,8 @@
# unlzma
> هذا الأمر هو اسم مستعار لـ `xz`.
> لمزيد من التفاصيل: <https://manned.org/unlzma>.
- إعرض التوثيقات للأمر الأصلي:
`tldr xz`

8
pages.ar/common/unxz.md Normal file
View File

@ -0,0 +1,8 @@
# unxz
> هذا الأمر هو اسم مستعار لـ `xz`.
> لمزيد من التفاصيل: <https://manned.org/unxz>.
- إعرض التوثيقات للأمر الأصلي:
`tldr xz`

7
pages.ar/common/vi.md Normal file
View File

@ -0,0 +1,7 @@
# vi
> هذا الأمر هو اسم مستعار لـ `vim`.
- إعرض التوثيقات للأمر الأصلي:
`tldr vim`

8
pages.ar/common/xzcat.md Normal file
View File

@ -0,0 +1,8 @@
# xzcat
> هذا الأمر هو اسم مستعار لـ `xz`.
> لمزيد من التفاصيل: <https://manned.org/xzcat>.
- إعرض التوثيقات للأمر الأصلي:
`tldr xz`

View File

@ -0,0 +1,8 @@
# alternatives
> هذا الأمر هو اسم مستعار لـ `update-alternatives`.
> لمزيد من التفاصيل: <https://manned.org/alternatives>.
- إعرض التوثيقات للأمر الأصلي:
`tldr update-alternatives`

8
pages.ar/linux/batcat.md Normal file
View File

@ -0,0 +1,8 @@
# batcat
> هذا الأمر هو اسم مستعار لـ `bat`.
> لمزيد من التفاصيل: <https://github.com/sharkdp/bat>.
- إعرض التوثيقات للأمر الأصلي:
`tldr bat`

8
pages.ar/linux/bspwm.md Normal file
View File

@ -0,0 +1,8 @@
# bspwm
> هذا الأمر هو اسم مستعار لـ `bspc`.
> لمزيد من التفاصيل: <https://github.com/baskerville/bspwm>.
- إعرض التوثيقات للأمر الأصلي:
`tldr bspc`

8
pages.ar/linux/cc.md Normal file
View File

@ -0,0 +1,8 @@
# cc
> هذا الأمر هو اسم مستعار لـ `gcc`.
> لمزيد من التفاصيل: <https://gcc.gnu.org>.
- إعرض التوثيقات للأمر الأصلي:
`tldr gcc`

View File

@ -0,0 +1,8 @@
# cgroups
> هذا الأمر هو اسم مستعار لـ `cgclassify`.
> لمزيد من التفاصيل: <https://www.kernel.org/doc/Documentation/cgroup-v2.txt>.
- إعرض التوثيقات للأمر الأصلي:
`tldr cgclassify`

View File

@ -0,0 +1,7 @@
# ip-route-list
> هذا الأمر هو اسم مستعار لـ `ip-route-show`.
- إعرض التوثيقات للأمر الأصلي:
`tldr ip-route-show`

8
pages.ar/linux/megadl.md Normal file
View File

@ -0,0 +1,8 @@
# megadl
> هذا الأمر هو اسم مستعار لـ `megatools-dl`.
> لمزيد من التفاصيل: <https://megatools.megous.com/man/megatools-dl.html>.
- إعرض التوثيقات للأمر الأصلي:
`tldr megatools-dl`

8
pages.ar/linux/ncal.md Normal file
View File

@ -0,0 +1,8 @@
# ncal
> هذا الأمر هو اسم مستعار لـ `cal`.
> لمزيد من التفاصيل: <https://manned.org/ncal>.
- إعرض التوثيقات للأمر الأصلي:
`tldr cal`

View File

@ -0,0 +1,8 @@
# ubuntu-bug
> هذا الأمر هو اسم مستعار لـ `apport-bug`.
> لمزيد من التفاصيل: <https://manned.org/ubuntu-bug>.
- إعرض التوثيقات للأمر الأصلي:
`tldr apport-bug`

7
pages.ar/osx/aa.md Normal file
View File

@ -0,0 +1,7 @@
# aa
> هذا الأمر هو اسم مستعار لـ `yaa`.
- إعرض التوثيقات للأمر الأصلي:
`tldr yaa`

7
pages.ar/osx/g[.md Normal file
View File

@ -0,0 +1,7 @@
# g[
> هذا الأمر هو اسم مستعار لـ `-p linux [`.
- إعرض التوثيقات للأمر الأصلي:
`tldr -p linux [`

7
pages.ar/osx/gawk.md Normal file
View File

@ -0,0 +1,7 @@
# gawk
> هذا الأمر هو اسم مستعار لـ `-p linux awk`.
- إعرض التوثيقات للأمر الأصلي:
`tldr -p linux awk`

7
pages.ar/osx/gb2sum.md Normal file
View File

@ -0,0 +1,7 @@
# gb2sum
> هذا الأمر هو اسم مستعار لـ `-p linux b2sum`.
- إعرض التوثيقات للأمر الأصلي:
`tldr -p linux b2sum`

7
pages.ar/osx/gbase32.md Normal file
View File

@ -0,0 +1,7 @@
# gbase32
> هذا الأمر هو اسم مستعار لـ `-p linux base32`.
- إعرض التوثيقات للأمر الأصلي:
`tldr -p linux base32`

7
pages.ar/osx/gbase64.md Normal file
View File

@ -0,0 +1,7 @@
# gbase64
> هذا الأمر هو اسم مستعار لـ `-p linux base64`.
- إعرض التوثيقات للأمر الأصلي:
`tldr -p linux base64`

View File

@ -0,0 +1,7 @@
# gbasename
> هذا الأمر هو اسم مستعار لـ `-p linux basename`.
- إعرض التوثيقات للأمر الأصلي:
`tldr -p linux basename`

7
pages.ar/osx/gbasenc.md Normal file
View File

@ -0,0 +1,7 @@
# gbasenc
> هذا الأمر هو اسم مستعار لـ `-p linux basenc`.
- إعرض التوثيقات للأمر الأصلي:
`tldr -p linux basenc`

7
pages.ar/osx/gcat.md Normal file
View File

@ -0,0 +1,7 @@
# gcat
> هذا الأمر هو اسم مستعار لـ `-p linux cat`.
- إعرض التوثيقات للأمر الأصلي:
`tldr -p linux cat`

7
pages.ar/osx/gchcon.md Normal file
View File

@ -0,0 +1,7 @@
# gchcon
> هذا الأمر هو اسم مستعار لـ `-p linux chcon`.
- إعرض التوثيقات للأمر الأصلي:
`tldr -p linux chcon`

7
pages.ar/osx/gchgrp.md Normal file
View File

@ -0,0 +1,7 @@
# gchgrp
> هذا الأمر هو اسم مستعار لـ `-p linux chgrp`.
- إعرض التوثيقات للأمر الأصلي:
`tldr -p linux chgrp`

7
pages.ar/osx/gchmod.md Normal file
View File

@ -0,0 +1,7 @@
# gchmod
> هذا الأمر هو اسم مستعار لـ `-p linux chmod`.
- إعرض التوثيقات للأمر الأصلي:
`tldr -p linux chmod`

7
pages.ar/osx/gchown.md Normal file
View File

@ -0,0 +1,7 @@
# gchown
> هذا الأمر هو اسم مستعار لـ `-p linux chown`.
- إعرض التوثيقات للأمر الأصلي:
`tldr -p linux chown`

7
pages.ar/osx/gchroot.md Normal file
View File

@ -0,0 +1,7 @@
# gchroot
> هذا الأمر هو اسم مستعار لـ `-p linux chroot`.
- إعرض التوثيقات للأمر الأصلي:
`tldr -p linux chroot`

7
pages.ar/osx/gcksum.md Normal file
View File

@ -0,0 +1,7 @@
# gcksum
> هذا الأمر هو اسم مستعار لـ `-p linux cksum`.
- إعرض التوثيقات للأمر الأصلي:
`tldr -p linux cksum`

7
pages.ar/osx/gcomm.md Normal file
View File

@ -0,0 +1,7 @@
# gcomm
> هذا الأمر هو اسم مستعار لـ `-p linux comm`.
- إعرض التوثيقات للأمر الأصلي:
`tldr -p linux comm`

7
pages.ar/osx/gcp.md Normal file
View File

@ -0,0 +1,7 @@
# gcp
> هذا الأمر هو اسم مستعار لـ `-p linux cp`.
- إعرض التوثيقات للأمر الأصلي:
`tldr -p linux cp`

Some files were not shown because too many files have changed in this diff Show More