Reach parity with cheat cheatsheets

[waldyrious]

At the time of writing, the cheat repository has 39 pages that we don't seem to have yet in tldr-pages:

• apparmor (see Let's document: apparmor #11857)
• asterisk
• cheat (cheat: add page #3721)
• cpdf (common/cpdf.md)
• cups (This command is tracked in Issue Let's document: cups #6597)
• gyb(gyb: add page #9021)
• jbang (jbang: add page #12030)
• linux/lshw.md
• linux/lsmod.md
• common/find.md
• linux/find (see the differences in the man page).
• linux/modprobe.md
• linux/lspci.md
• common/cat.md
• linux/dmesg.md
• osx/dmesg.md
• indent
• iwconfig
• nova(nova: add page #8660)
• ntp
• org-mode Not a command
• perlbrew (perlbrew: add page #12032)
• perldoc (perldoc: add page #12035)
• pkgtools (Let's document: pkgtools #11874)
• port (port: add page #1499)
• quickemu (quick{emu,get}: add page #12029)
• quickget (quick{emu,get}: add page #12029)
• r2
• rcs (Let's document: rcs #11873)
• rpm2cpio(rpm2cpio: add page #9023)
• rss2email(rss2email: add page #9024)
• sam2p(sam2p: add page #9109)
• scd(scd: add page #9224)
• slurm (page requests: Slurm commands #2068); (sstat, scontrol: add page #4689 & sacctmgr, sreport: add page #4646)
• snmpwalk
• sockstat (sockstat: add page #9107) [Requires more examples] sockstat: split FreeBSD, NetBSD and Linux implementations #12040 added all options to the pages
• sport (sport: add page and pt_BR translation #11872)
• systemd (Let's document: systemd #10191)
  • linux/systemd-analyze.md
  • linux/systemctl.md
• tidy (tidy: add page #12024)
• trashy(trashy: add page #8749)
• tarsnap (Let's document: tarsnap #11901)
• udisksctl
• urpm (urpmi: add pages #12025)
• xmlto
• zoneadm

We should create them to reach parity!

For context, see #266.

[Mouvedia]

markdown is probably not on scope, it's not a binary per se.

[waldyrious]

Good point, @Mouvedia — I'll strike that one out.

[sbrl]

I think this issue would be a great one to pin.

[ivanhercaz]

I will keep this list in mind for the next contributions. Thank you for this compilation @waldyrious!

[waldyrious]

Thank you for this compilation @waldyrious!

You can thank Venny for doing most of the work ;)

[sbrl]

Looks like we're at our max of 3 issues though, so it might have to wait until another one is closed.

[zlatanvasovic]

@sbrl I'd rather have the branding one(s) pinned first.

[sbrl]

I think the idea of the pinned issues here is to give people some ideas as to some commands they can create pages for - we've always had a handful of meta tracking issues for lists of commands. See #1579 and #2213 for example :-)

[waldyrious]

I have a sense that the branding issue is going to be closed soon anyway (please voice your thoughts there if you haven't yet), so it will cease being a problem ;)

[ivanhercaz]

I have some doubts about how to write the pages for some of these. For example, deb isn't a command, is a package format, and in its respective cheatsheet there are examples of how to work with deb, like how to extract the files inside a deb package and how to install it. What should be written in the pages? Examples of how to work with this kind of packages?

And, what about in the case of ansi, readline and stdout?

[Mouvedia]

strike them and move on

[zlatanvasovic]

I striked all those out, plus asciiart. We need to revisit all the listed ones, there are surely more to be striked out.

[ivanhercaz]

@Mouvedia, @zdroid, thank you for your answers. I will review each command to know if I can contribute writing its page or discard it of this list striking it.

[ivanhercaz]

I edited the issue and splitted systemd in three commands: systemd, systemctl and systemd-analyze. The cheatsheet includes the last two commands and we already have them (you can check the links to the files). However, systemd has its own man page, as the another ones, so it is pending to be written.

I don't know if the way in which I add this information to the issue is the chosen one, if not, correct my edit please.

P.S. Please, check hardware-info point. It isn't a command, it is a cheatsheet with different commands to get hardware information. We have most of them, with the exception of the find command in Linux.

[waldyrious]

That's a great way to format the list, @ivanhercaz. Maybe we could add the platform prefix and the .md suffix to the links to tldr pages, so we can better distinguish them from the cheat cheatsheets. I'd also propose that as we add the missing pages, we link to them as sub-list items like you did, rather than just add a check to the box, so that it's easy for others to validate whether the content we have is complete or could be expanded with stuff from the cheatsheets.

[ivanhercaz]

That's a great way to format the list, @ivanhercaz. Maybe we could add the platform prefix and the .md suffix to the links to tldr pages, so we can better distinguish them from the cheat cheatsheets.

That sounds really nice. I will add the platform prefix and the .md suffix. I will change it now.

I'd also propose that as we add the missing pages, we link to them as sub-list items like you did, rather than just add a check to the box, so that it's easy for others to validate whether the content we have is complete or could be expanded with stuff from the cheatsheets.

All right. Good proposal. I will add them as soon as possible. Although now I am going to add the one made by @andrik (cpdf), as an example.

[waldyrious]

Although now I am going to add the one made by @andrik (cpdf), as an example.

Just to clarify, I meant adding these as sub-lists as well (with a single entry) rather than as notes in parenthesis in the same line as the cheatsheet, so that the formatting is consistent with the ones that correspond to multiple pages, and also to avoid mixing up with the notes for the entries that aren't really commands. Does that make sense?

[zlatanvasovic]

systemd doesn't exist as a command itself in the cheatsheets (but it is present on Linux). I think it should be ticked aswell.

Note: I made a PR for cheat command and noted it in the description.

[waldyrious]

Note: I made a PR for cheat command

Link for reference: #3721

and noted it in the description

I don't understand what you mean by this. Can you clarify?

[zlatanvasovic]

Note: I made a PR for cheat command

Link for reference: #3721

and noted it in the description

I don't understand what you mean by this. Can you clarify?

I added it to this issue's description.

[waldyrious]

D'oh! 🤦‍♂ thanks for clarifying.

[sbrl]

Surely we have a page for find? It's in common. It's in common because it's present on more than 1 platform - linux being one of them.

[ivanhercaz]

Although now I am going to add the one made by @andrik (cpdf), as an example.

Just to clarify, I meant adding these as sub-lists as well (with a single entry) rather than as notes in parenthesis in the same line as the cheatsheet, so that the formatting is consistent with the ones that correspond to multiple pages, and also to avoid mixing up with the notes for the entries that aren't really commands. Does that make sense?

Oh, yes! That's make sense. I will adapt it as you commented.

Surely we have a page for find? It's in common. It's in common because it's present on more than 1 platform - linux being one of them.

It is in common but it seems to be a different command from the Linux on, at least checking both.

[Mouvedia]

If we are adding trashy, we should remove linux/trash which is a duplicate of common/trash-cli.

[sbrl]

I'm not sure that linux/trash would be a duplicate of common/trash-cli. They sound like different commands. Technically, I'd be in favour of deleting trash-cli and replacing it with multiple pages - 1 for each command it mentions.

The basic form of tldr is tldr command - hence 1 page per command.

[npalladium]

We should reach parity for slurm once #4689 and #4646 are merged.

[nath1as]

adding trashy #8749

[EmilyGraceSeville7cf]

org-mode possibly can't be added as it's cheat-sheet doesn't describe CLI, but commands inside this mode.

[ethanbarry]

AppArmor is a package that provides commands like aa-enabled and aa-enforce. Do I need to create an apparmor page, or just pages for the individual commands?

[kbdharun]

AppArmor is a package that provides commands like aa-enabled and aa-enforce. Do I need to create an apparmor page, or just pages for the individual commands?

You could create a main page referring to the subcommand pages in this case.

Note: We already have some AppArmor pages as far as I can remember. So check if the page exists before creating a PR (feel free to edit them if you have any modifications).