while-true-do / tldr

For lazy people out there and if you don't want to read miles of manpages.

tldr

To long, didn't read... the whole mangpage.

Motivation

In most cases reading a manpage or documentation can help a lot. But reading long manpages can be boring, time consuming and tedious. Sometimes, you want to have some common commands for a specific tool at your fingertips.

Cheat Sheets

Cheat Sheets are categorized.

Automation

• ansible

Container

• docker
• podman

Development

• git

Packaging

• DNF
• rpm-ostree
• YUM
• zypper

System

• file operations
• journalctl
• system information
• systemctl
• systemd
• user & groups

Virtualization

• virsh
• virt-install

Testing

This repository is not tested.

Contribute

Thank you so much for considering to contribute. We are very happy, when somebody is joining the hard work. Please fell free to open Bugs, Feature Requests or Pull Requests after reading the Contribution Guideline.

See who has contributed already in the kudos.txt.

License

This work is licensed under a BSD-3-Clause License.

Contact

• Site https://while-true-do.io
• Twitter https://twitter.com/wtd_news
• Code https://github.com/while-true-do
• Mail [email protected]
• IRC freenode, #while-true-do
• Telegram https://t.me/while_true_do

tldr's Issues

Cheatsheet tmux

As a user/community member, I request a cheatsheet for tmux, which is a very popular terminal multiplexer.

Cheatsheet LVM

As a user/operator/administrator, I often face LVM and request a cheat sheet for it.

Rework meta data, tests and README

Lots of rework needed here, to meet current standards.

Design work

As a user/community member/developer, I think the design should contain links and proper styling.

• links for all cheatsheets to proper upstream pages
• small images or pictures can be included
• remove the "|" for the description line
• template a proper format for cheatsheets

Add more stuff

Found a cool search with duckduckgo, which is presenting a ton of commands to add.

https://duckduckgo.com/?q=cheatsheet+linux&ia=cheatsheet&iax=cheatsheet

Another list of some useful things can be found in the README.md

Cheatsheet virt-clone

As a user/community member, I want to see a cheatsheet for virt-clone to clone VM (libvirt).

document virt-install+virsh

Type of Report

Enhancement

Actual behaviour

virt-install+virsh are not documented, but very useful.

Expected behaviour

virt-install is commonly used and can even replace most of the vagrant features. For most of the linux systems is able to automate the deployment of test environments, but seems complicated and has a ton of features.

If most of the common commands for virt-install and virsh are documented, it will help a lot.

metafiles and readme outdated

Type of Report

Enhancement

Actual behaviour

• Outdated documents in ./doc
• Readme is not in best fashion

Expected behaviour

Update the metafiles properly to reflect common guidelines.

Cheatsheet apt

As a user/community member, I want to see some cheatsheets for apt/apt-get.

Cheatsheet VIM

As a user/community member, I think VIM is very popular and needs a cheatsheet. (the vim article is the most often requested on stack overflow).

Cheatsheet for docker

As a contributor/user, I want to have a docker cheat sheet present with some examples and most commonly used commands.

Remove ToDo Lists

As a user, I don't want to see the "open topics" in a released version. All tasks should be handled in a proper task handler.

• remove todo list
• adjust readme to doc-library

Apply doc-library/test-library, after v1.0.0

As a developer/community member, I want to have the doc-library/test-library applied for v1.0.0, after doc-library/test-library reached v1.0.0.

Cheatsheet molecule

As a community member, which is heavily involved in ansible development, I want to see 'molecule' reflected as a cheatsheet.