Attention maintainers!
In this release we are adding a new client-side syntax to allow the clients to show either shortform or longform options. This should remove a lot of clutter and allow power users to view shortform options by default while showing longform options to new users. The syntax is backwards compatible so there is no need to rush support.
Important
The old https://tldr.sh domain will stop providing assets at the end of this year.
Changelog
- Added longform/shortform specifications (#15253) (by @Managor)
- Specify
commonas a supported platform option (#15855) (by @kbdharun) - Add the date of removal of the old asset website (#15862) (by @acuteenvy)
- Various grammar fixes
Option placeholders
Previously we have used a basic placeholder such as {{-h|--help}} to show both the short and long options to the user. While this gave the user more information, it also caused a lot of clutter and reduced the pasteability of the commands. The new option placeholder adds single square brackets inside the placeholder ({{[-h|--help]}}) where clients are allowed to pick which one to show. It is recommended for the clients to show only longform options by default, but if a client wants to brand itself as a power user tool they can default to showings shortform options. There is also a backwards compatible presentation style for showing both which is just the curly braces removed ([-h|--help]).
Style guide improvements
If you are a contributor to the tldr pages, do check out the style guide.
We have made several improvements and restructuring to it such as standardizing keypress notation, adding instructions for disambiguation and grouping pages, instructing to avoid using = in option arguments whenever possible, example.com clarification and much more.