Skip to content

Commit

Permalink
Merge branch 'tldr-pages:main' into main
Browse files Browse the repository at this point in the history
  • Loading branch information
renner0e authored Nov 10, 2024
2 parents 75ce304 + 42021e8 commit 1296b1f
Show file tree
Hide file tree
Showing 7,291 changed files with 116,209 additions and 6,440 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
5 changes: 3 additions & 2 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
{
"name": "tldr-pages",
"image": "mcr.microsoft.com/devcontainers/base:ubuntu", // Use Microsoft's Ubuntu Base image for the dev container
"features": { // Use Node and Python features in the dev container
"features": { // Use Node, Python and GitHub CLI features in the dev container
"ghcr.io/devcontainers/features/node:1": {},
"ghcr.io/devcontainers/features/python:1": {}
"ghcr.io/devcontainers/features/python:1": {},
"ghcr.io/devcontainers/features/github-cli:1": {}
},

"privileged": false, // Run the container unprivileged
Expand Down
14 changes: 6 additions & 8 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1,23 +1,21 @@
/pages.de/ @pixelcmtd @gutjuri
/pages.es/ @navarroaxel @kant @tricantivu
/pages.es/ @navarroaxel @kant @tricantivu @ikks
/pages.fa/ @MrMw3
/pages.fr/ @Nico385412 @nicokosi @noraj
/pages.hi/ @kbdharun
/pages.hi/ @kbdharun @debghs @karthik-script
/pages.id/ @reinhart1010
/pages.it/ @mebeim @tansiret @Magrid0
/pages.ko/ @IMHOJEONG
/pages.ko/ @IMHOJEONG @Zamoca42 @CodePsy-2001
/pages.nl/ @sebastiaanspeck @leonvsc @Waples
/pages.pl/ @acuteenvy @spageektti
/pages.pt_BR/ @isaacvicente @vitorhcl
/pages.pt_BR/ @isaacvicente @vitorhcl @renie
/pages.pt_PT/ @waldyrious
/pages.ta/ @kbdharun
/pages.tr/ @tansiret
/pages.zh/ @blueskyson @einverne
/pages.zh_TW/ @blueskyson

/pages/common/ @spageektti
/pages/linux/ @cyqsimon @spageektti
/pages/windows/ @spageektti
/pages/linux/ @cyqsimon

/*.md @sbrl @kbdharun @sebastiaanspeck
/.devcontainer/* @kbdharun @sebastiaanspeck
Expand All @@ -36,7 +34,7 @@
/contributing-guides/*.ko.md @IMHOJEONG
/contributing-guides/*.nl.md @sebastiaanspeck @leonvsc @Waples
/contributing-guides/*.pl.md @acuteenvy @spageektti
/contributing-guides/*.pt_BR.md @isaacvicente @vitorhcl
/contributing-guides/*.pt_BR.md @isaacvicente @vitorhcl @renie
/contributing-guides/*.pt_PT.md @waldyrious
/contributing-guides/*.ta.md @kbdharun
/contributing-guides/*.tr.md @tansiret
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/lets-document.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ body:
label: Commands
description: List out all the pages you want to create.
placeholder: |
- [] command1 → <PR_NUMBER>
- [] command2 → <PR_NUMBER>
- [ ] command1 → <PR_NUMBER>
- [ ] command2 → <PR_NUMBER>
validations:
required: true
1 change: 1 addition & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,6 @@ See also https://github.com/tldr-pages/tldr/blob/main/CONTRIBUTING.md
- [ ] The page(s) have at most 8 examples.
- [ ] The page description(s) have links to documentation or a homepage.
- [ ] The page(s) follow the [content guidelines](/tldr-pages/tldr/blob/main/CONTRIBUTING.md#guidelines).
- [ ] The page(s) follow the [style guide](/tldr-pages/tldr/blob/main/contributing-guides/style-guide.md).
- [ ] The PR title conforms to the recommended [templates](/tldr-pages/tldr/blob/main/CONTRIBUTING.md#commit-message-and-pr-title).
- **Version of the command being documented (if known):**
4 changes: 4 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ updates:
directory: "/"
schedule:
interval: "monthly"
- package-ecosystem: "devcontainers"
directory: "/"
schedule:
interval: "monthly"
- package-ecosystem: "npm"
directory: "/"
schedule:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/codespell.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ jobs:

- name: Get changed files
id: changed-files
uses: tj-actions/changed-files@v44.5.7
uses: tj-actions/changed-files@v45.0.3
with:
# Ignore all other languages except English
files_ignore: |
Expand Down
70 changes: 70 additions & 0 deletions .github/workflows/monthly-check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
name: Monthly check GitHub usernames

on:
workflow_dispatch:
schedule:
- cron: "0 0 1 * *"

jobs:
check-usernames:
runs-on: ubuntu-latest
steps:
- name: Restore lychee cache
id: restore-cache
uses: actions/cache/restore@v4
with:
path: .lycheecache
key: cache-lychee-${{ github.sha }}
restore-keys: cache-lychee-

- uses: actions/checkout@v4
with:
fetch-depth: 0

- run: |
cat .github/CODEOWNERS | grep -o "@[a-zA-Z0-9_-]\+" | sort -u | sed 's/@/https:\/\/api.github.com\/users\//' > usernames.txt
cat MAINTAINERS.md | grep -o "\*\*.*@[a-zA-Z0-9_-]\+.*\*\*" | grep -o "@[a-zA-Z0-9_-]\+" | sort -u | sed 's/@/https:\/\/api.github.com\/users\//' >> usernames.txt
sort -u usernames.txt -o usernames.txt
- name: Lychee URL checker
uses: lycheeverse/lychee-action@v2
id: lychee
continue-on-error: true
with:
args: >-
--cache
--verbose
--no-progress
--max-concurrency 25
usernames.txt
env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

- name: Find the last report issue open
uses: micalevisk/last-issue-action@v2
id: last-issue
with:
state: open
labels: check usernames
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Update last report open issue created
if: ${{ env.lychee_exit_code != 0 }}
uses: peter-evans/create-issue-from-file@v5
with:
title: GitHub usernames with errors
content-filepath: lychee/out.md
issue-number: ${{ steps.last-issue.outputs.issue-number }}
labels: check usernames

- name: Close last report open issue
if: ${{ env.lychee_exit_code == 0 && steps.last-issue.outputs.has-found == 'true' }}
run: gh issue close ${{ steps.last-issue.outputs.issue-number }}

- name: Save lychee cache
uses: actions/cache/save@v4
if: always()
with:
path: .lycheecache
key: ${{ steps.restore-cache.outputs.cache-primary-key }}
2 changes: 1 addition & 1 deletion CLIENT-SPECIFICATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Option | Required? | Meaning

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 one 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](https://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.

Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ You should always add a base page (e.g. `git`) that describes the program and ba

The following methods can be used to reference subcommands:

- You can add a note saying ``Some subcommands such as `example command` have their own usage documentation`` to the main page. (See the [subcommand reference](/contributing-guides/translation-templates/subcommand-mention.md) page for translation templates.)
- You can add a note saying ``Some subcommands such as `example command` have their own usage documentation`` to the main page. (See the [subcommand reference](/contributing-guides/translation-templates/subcommand-mention.md) page for translation templates). `example command` should only include the subcommand (e.g. `commit` instead of `git commit`).
- You can use ``See also: `command1`, `command2`.`` template to reference similar commands, aliases and subcommands.
- Alternatively, the whole page can be converted to reference the main subcommands.

Expand Down Expand Up @@ -182,7 +182,7 @@ Translation of pages can be done by simply creating the corresponding page withi
> [!TIP]
> When fixing errors in an existing translation, it is suggested to update the page to match the latest version of the English page.
To see the current progress of all translations, you can visit <https://lukwebsforge.github.io/tldri18n/>, which provides a dynamically updated table of all pages and their translations.
To see the current progress of all translations, you can visit <https://lukwebsforge.github.io/tldri18n/>, which provides a dynamically updated table of all pages and their translations or you can visit <https://github.com/tldr-pages/tldr-maintenance/issues/127>, which provides a dynamically updated list about the translation status (e.g. list all outdated pages) per language.

Some examples of valid locale tags:

Expand Down
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Copyright © 2014—present the [tldr-pages team](https://github.com/orgs/tldr-p
and [contributors](https://github.com/tldr-pages/tldr/graphs/contributors).

**This work is licensed under the
[Creative Commons Attribution 4.0 International License](http://creativecommons.org/licenses/by/4.0/)
[Creative Commons Attribution 4.0 International License](https://creativecommons.org/licenses/by/4.0/)
(CC-BY).**

----
Expand Down
36 changes: 27 additions & 9 deletions MAINTAINERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ If you are an owner of the organization, you can see an automated list [here](ht

- **Jeef ([@jeeftor](https://github.com/jeeftor))**:
[12 March 2017](https://github.com/tldr-pages/tldr/issues/1209#issuecomment-285924778) — present
- **Max Xu ([@jsonbruce](https://github.com/jsonbruce))**:
- **Max Xu ([@maxsxu](https://github.com/maxsxu))**:
[11 January 2018](https://github.com/tldr-pages/tldr/issues/1885) — present
- **David Bialik ([@AnimiVulpis](https://github.com/AnimiVulpis))**:
[5 November 2018](https://github.com/tldr-pages/tldr/issues/2556) — present
Expand Down Expand Up @@ -48,8 +48,6 @@ If you are an owner of the organization, you can see an automated list [here](ht
[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
- **HoJeong Im ([@IMHOJEONG](https://github.com/IMHOJEONG))**:
Expand All @@ -74,6 +72,20 @@ If you are an owner of the organization, you can see an automated list [here](ht
[16 August 2024](https://github.com/tldr-pages/tldr/issues/13450) — present
- **jxu ([@jxu](https://github.com/jxu))**:
[18 August 2024](https://github.com/tldr-pages/tldr/issues/13451) — present
- **Nelson Figueroa ([@nelsonfigueroa](https://github.com/nelsonfigueroa)):**
[21 September 2024](https://github.com/tldr-pages/tldr/issues/13781) — present
- **Iván Hernández Cazorla ([@ivanhercaz](https://github.com/ivanhercaz))**:
[24 December 2019](https://github.com/tldr-pages/tldr/issues/3690)[5 January 2020](https://github.com/tldr-pages/tldr/issues/3736), [22 September 2024](https://github.com/tldr-pages/tldr/issues/5932) — present
- **Yi Liu ([@LiLittleCat](https://github.com/LiLittleCat))**:
[23 September 2024](https://github.com/tldr-pages/tldr/issues/13780) — present
- **Karthik Vallamsetla ([@karthik-script](https://github.com/karthik-script))**:
[01 November 2024](https://github.com/tldr-pages/tldr/issues/14539) — present
- **Igor Támara ([@ikks](https://github.com/ikks))**:
[01 November 2024](https://github.com/tldr-pages/tldr/issues/14536) — present
- **Zamoca42 ([@Zamoca42](https://github.com/Zamoca42))**:
[02 November 2024](https://github.com/tldr-pages/tldr/issues/14538) — present
- **CodePsy-2001 ([@CodePsy-2001](https://github.com/CodePsy-2001))**:
[02 November 2024](https://github.com/tldr-pages/tldr/issues/14537#issuecomment-2457381463) — 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)):
Expand All @@ -82,8 +94,6 @@ If you are an owner of the organization, you can see an automated list [here](ht
[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)):
[28 November 2019](https://github.com/tldr-pages/tldr/issues/3636)[17 December 2019](https://github.com/tldr-pages/tldr/issues/3663)
- Iván Hernández Cazorla ([@ivanhercaz](https://github.com/ivanhercaz)):
[24 December 2019](https://github.com/tldr-pages/tldr/issues/3690)[5 January 2020](https://github.com/tldr-pages/tldr/issues/3736)
- Axel Navarro ([@navarroaxel](https://github.com/navarroaxel)):
[24 August 2020](https://github.com/tldr-pages/tldr/issues/4291)[5 October 2020](https://github.com/tldr-pages/tldr/issues/4504)
- bl-ue ([@bl-ue](https://github.com/bl-ue)):
Expand Down Expand Up @@ -128,16 +138,18 @@ If you are an owner of the organization, you can see an automated list [here](ht
[22 October 2023](https://github.com/tldr-pages/tldr/issues/11159)[3 May 2024](https://github.com/tldr-pages/tldr/issues/12717)
- Darío Hereñú ([@kant](https://github.com/kant)):
[20 September 2023](https://github.com/tldr-pages/tldr/issues/10738)[3 May 2024](https://github.com/tldr-pages/tldr/issues/12718)
- Wiktor ([@spageektti](https://github.com/spageektti)):
- Wiktor Perskawiec ([@spageektti](https://github.com/spageektti)):
[11 May 2024](https://github.com/tldr-pages/tldr/issues/12776)[1 June 2024](https://github.com/tldr-pages/tldr/issues/12869)
- Managor ([@Managor](https://github.com/Managor)):
[4 September 2023](https://github.com/tldr-pages/tldr/issues/10611)[3 October 2024](https://github.com/tldr-pages/tldr/issues/13956)
- Renie ([@renie](https://github.com/renie)):
[03 October 2024](https://github.com/tldr-pages/tldr/issues/13946)[23 October 2024](https://github.com/tldr-pages/tldr/issues/14343)

## Organization members

In addition to everything that repository collaborators can do, organization members have write access to all the repositories in the tldr-pages organization, and [a few extra maintenance capabilities](https://docs.github.com/en/organizations/managing-peoples-access-to-your-organization-with-roles/permission-levels-for-an-organization).
An automated list can be found [here](https://github.com/orgs/tldr-pages/people).

- **Iván Hernández Cazorla ([@ivanhercaz](https://github.com/ivanhercaz))**:
[5 January 2020](https://github.com/tldr-pages/tldr/issues/3736) — present
- **Ein Verne ([@einverne](https://github.com/einverne))**:
[6 January 2020](https://github.com/tldr-pages/tldr/issues/3738) — present
- **Tan Siret Akıncı ([@tansiret](https://github.com/tansiret))**:
Expand All @@ -158,8 +170,12 @@ An automated list can be found [here](https://github.com/orgs/tldr-pages/people)
[3 May 2024](https://github.com/tldr-pages/tldr/issues/12717) — present
- **Darío Hereñú ([@kant](https://github.com/kant))**:
[3 May 2024](https://github.com/tldr-pages/tldr/issues/12718) — present
- **Wiktor ([@spageektti](https://github.com/spageektti))**:
- **Wiktor Perskawiec ([@spageektti](https://github.com/spageektti))**:
[1 June 2024](https://github.com/tldr-pages/tldr/issues/12869) — present
- **Managor ([@Managor](https://github.com/Managor))**:
[3 October 2024](https://github.com/tldr-pages/tldr/issues/13956) — present
- **Renie ([@renie](https://github.com/renie))**:
[23 October 2024](https://github.com/tldr-pages/tldr/issues/14343) — 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)):
Expand Down Expand Up @@ -194,6 +210,8 @@ An automated list can be found [here](https://github.com/orgs/tldr-pages/people)
[24 October 2023](https://github.com/tldr-pages/tldr/issues/11202)[28 April 2024](https://github.com/tldr-pages/tldr/issues/12687)
- Juri ([@gutjuri](https://github.com/gutjuri)):
[24 October 2023](https://github.com/tldr-pages/tldr/issues/11201)[29 April 2024](https://github.com/tldr-pages/tldr/issues/12686)
- Iván Hernández Cazorla ([@ivanhercaz](https://github.com/ivanhercaz)):
[5 January 2020](https://github.com/tldr-pages/tldr/issues/3736)[22 September 2024](https://github.com/tldr-pages/tldr/issues/5932)

## Organization owners

Expand Down
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<!-- markdownlint-disable MD041 -->

<div align="center">
<h1><a href="https://tldr.sh/"><img alt="tldr-pages" src="images/banner.png" width=600/></a></h1>

Expand All @@ -7,6 +8,7 @@
[![Merged PRs][prs-merged-image]][prs-merged-url]
[![GitHub contributors][contributors-image]][contributors-url]
[![license][license-image]][license-url]
[![Mastodon][mastodon-image]][mastodon-url]

[github-actions-url]: https://github.com/tldr-pages/tldr/actions
[github-actions-image]: https://img.shields.io/github/actions/workflow/status/tldr-pages/tldr/ci.yml?branch=main&label=Build
Expand All @@ -18,6 +20,8 @@
[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?label=License
[mastodon-url]: https://fosstodon.org/@tldr_pages
[mastodon-image]: https://img.shields.io/badge/Mastodon-6364FF?logo=mastodon&logoColor=fff
</div>

## What is tldr-pages?
Expand All @@ -26,7 +30,7 @@ The **tldr-pages** project is a collection of community-maintained help pages
for command-line tools, that aims to be a simpler, more approachable complement
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`?
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, in the past, the first option explained in `man tar` was:

Expand All @@ -40,7 +44,7 @@ $ man tar
...
```

There seems to be room for simpler help pages, focused on practical examples.
There is room for simpler help pages focused on practical examples.
How about:

<picture>
Expand All @@ -50,7 +54,8 @@ How about:
</picture>

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.
for the most common UNIX, Linux, macOS, FreeBSD, NetBSD, OpenBSD,
SunOS, Android, and Windows command-line tools.

## How do I use it?

Expand Down Expand Up @@ -84,11 +89,11 @@ accessible through typing `tldr tar` instead of the standard `man tar`.
If you don't want to install any software, check out the [PDF version](https://github.com/tldr-pages/tldr/releases/latest/download/tldr-book.pdf) instead.

> [!NOTE]
> PDFs for translations are available for most languages. You can find them in the releases assets of the [latest release](https://github.com/tldr-pages/tldr/releases/latest).
> PDFs for translations are available for most languages. You can find them in the release assets of the [latest release](https://github.com/tldr-pages/tldr/releases/latest).
There are also **various other clients** provided by the community,
both for the command-line and for other platforms.
For a comprehensive list of clients, head over to our [Wiki](https://github.com/tldr-pages/tldr/wiki/tldr-pages-clients).
For a comprehensive list of clients, head over to our [Wiki](https://github.com/tldr-pages/tldr/wiki/Clients).

## How do I contribute to tldr-pages?

Expand All @@ -101,7 +106,7 @@ Some ways to contribute include:
- Adding requested pages from our issues with the [help wanted](https://github.com/tldr-pages/tldr/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) label.
- Translating pages into different languages.

All `tldr` pages are written in markdown, so they can be edited quite easily and changes can be submitted in
All `tldr` pages are written in Markdown so that they can be edited quite easily and changes can be submitted in
pull requests here using Git on the command-line or
using the GitHub web interface.

Expand Down
Loading

0 comments on commit 1296b1f

Please sign in to comment.