Move help strings to markdown files

[tertsdiepraam]

After #2816 and #3180, we can move all the help strings to markdown files.

Below is a list of utils that need to be converted. Let's see if GitHub's task lists are useful here. All of them should be considered good-first-issues.

If you want to pick one up, for now just create a PR and we'll update this list.

Note that some utils (like who) have platform-specific help texts. We should probably leave those until we have a good solution for that.

• arch (arch: move help strings to a markdown file #4373)
• base32 (Create help_section macro and use it for numfmt #3180)
• base64 (Create help_section macro and use it for numfmt #3180)
• basename (basename: move help strings to markdown file #4391)
• basenc (basenc: Move strings to markdown file #4417)
• cat (cat: move help strings to markdown file #4375)
• chcon (chcon: move help strings to a markdown file #4437)
• chgrp (chgrp: move help strings to markdown file #4461)
• chmod (chmod: move help strings to markdown file #4392)
• chown (chown: move help strings to markdown file #4450)
• chroot (chroot: move help strings to markdown file #4468)
• cksum (cksum: move help strings to markdown file #4516)
• comm (comm: move help strings to markdown file #4443)
• cp (cp: move help strings to markdown file #4372)
• csplit (csplit: move help strings to markdown file #4474)
• cut (cut: move help strings to markdown file #4568)
• date (For date, move help strings to .md file #4458)
• dd (dd: parse operands manually via positional args #3938)
• df (df: move help strings to markdown file #4434)
• dircolors (dircolors: move help strings to markdown file #4435)
• dirname (dirname: move help strings to markdown file #4444)
• du (du: move help strings to markdown file #4384)
• echo (echo: move help strings to markdown file #4471)
• env (env: move help strings to a markdown file #4472)
• expand (expand: move help strings to markdown file #4551)
• expr (Markdown in docs v1 #4158)
• factor (factor: move help strings to markdown file #4562)
• false (false: move help strings to markdown file #4553)
• fmt (fmt: move help strings to markdown file #4430)
• fold (fold: move help strings to markdown file #4552)
• groups (groups: move help strings to markdown file #4554)
• hashsum (hashsum: move help strings to markdown file #4563)
• head (head: move help strings to markdown file #4564)
• hostid (hostid: move help strings to markdown file #4575)
• hostname (hostname: move help strings to markdown file #4473)
• id (id: move help strings to a markdown file #4585)
• install (install: move help strings to markdown file #4469)
• join (join: move help strings to markdown file #4583)
• kill (kill: move help strings to markdown file #4395)
• link (link: move help strings to markdown file #4423)
• ln (ln: move help strings to markdown file #4424)
• logname (logname: move help strings to markdown file #4587)
• ls (ls + vdir: move help strings to markdown file #4454)
• mkdir (mkdir: move help strings to markdown file #4403)
• mkfifo (mkfifo: move help strings to markdown file #4506)
• mknod (mknod: move help strings to markdown file #4529)
• mktemp (mktemp: move help strings to markdown file #4547)
• more (more: move help strings to markdown file #4589)
• mv (mv: move help strings to markdown file #4590)
• nice (nice: move help strings to markdown file #4591)
• nl (nl: move help strings to a markdown file #4477)
• nohup (nohup: move help strings to markdown file #4415)
• nproc (nproc: move help strings to markdown file #4579)
• numfmt (Create help_section macro and use it for numfmt #3180)
• od (od: move help strings to markdown file #4406)
• paste (paste: move help strings to markdown file #4650)
• pathchk (pathchk: move help strings to markdown file #4651)
• pinky (pinky: move help strings to markdown file #4701)
• pr (pr: move help strings to markdown file #4678)
• printenv (printenv: move help strings to markdown file #4485)
• printf (printf: move help strings to markdown file #4705)
• ptx (ptx: move help strings to markdown file #4422)
• pwd (pwd: move help strings to markdown file #4455)
• readlink (readlink: move help strings to markdown file #4770)
• realpath (realpath: move help strings to markdown file #4429)
• relpath (relpath: move help strings to markdown file #4491)
• rm (rm: move help strings to markdown file #4413)
• rmdir (rmdir: move help strings to markdown file #4412)
• runcon (runcon: move help strings to markdown file #4774)
• seq (seq: move help strings to markdown file #4779)
• shred (015de72)
• shuf (shuf: move help strings to markdown file #4421)
• sleep (sleep: move help strings to markdown file #4411)
• sort (sort: Move help strings to markdown file #4808)
• split (split: move help strings to markdown file #4785)
• stat (Replace get_long_usage fns with const #4367)
• stdbuf (stdbuf: move help strings to markdown file #4792)
• stty (stty: move help strings to markdown file #4797)
• sum (sum: move help strings to markdown file #4799)
• sync (sync: move help strings to markdown file #4800)
• tac (tac: move help strings to markdown file #4394)
• tail (tail: move help strings to markdown file #4426)
• tee (tee: move help strings to markdown file #4425)
• test (test: move help strings to markdown file #4816)
• timeout (timeout: move help strings to markdown file #4806)
• touch (touch: move help strings to markdown file #4581)
• tr (tr: move help string to markdown file #4805)
• true (true: move help strings to markdown file #4703)
• truncate (truncate: move help strings to markdown file #4456)
• tsort (tsort: move help strings to markdown file #4829)
• tty (tty: move help strings to markdown file #4837)
• uname (uname: move help strings to a markdown file #4476)
• unexpand (unexpand: move help strings to markdown file #4704)
• uniq (uniq: move help strings to markdown file #4681)
• unlink (unlink: move help strings to markdown file #4675)
• uptime (uptime: move help strings to markdown file #4518)
• users (users: move help strings to markdown file #4570)
• wc (wc: move help strings to markdown file #4453)
• who (who: move help strings to markdown file #4549)
• whoami (whoami: move help strings to markdown file #4519)
• yes (yes: move help strings to markdown file #4390)

[zleyyij]

It doesn't appear to be possible to Convert to Issue with my permissions, I checked on multiple browsers and proved that it was working on a project where I have sufficient perms.

[tertsdiepraam]

Oh I hoped that would be possible. That's too bad. I'll figure out some other way to track this. In the meantime you can just create a PR and I'll update the list manually.

[tertsdiepraam]

We could just accept PRs that mention the utils they update and then we manually update, but that's not a great solution. Also, with a project like this, we get situations like this quite often, so I'd like to find a better solution. @sylvestre any ideas?

[cakebaker]

What should be the order of the sections inside the markdown files? Currently half of the files use

Usage
About
...

and the other half:

About
Usage
...

[tertsdiepraam]

Hmm good question. Both will work, but I think I prefer usage first, because that's also how it shows up in clap and in the online docs. Maybe we should even change the macro for the usage to parse the code block directly below the title, so you can write:

# numfmt
```
numfmt [OPTION]... [NUMBER]...
```

## About

Convert numbers from/to human-readable strings

Do you have a preference one way or the other?

[cakebaker]

My preference would be the same as in the online docs:

# numfmt
```
numfmt [OPTION]... [NUMBER]...
```

Convert numbers from/to human-readable strings

[tertsdiepraam]

Ah I see, that would require a separate macro for the about text I suppose. I like that it enforces a strict format. Do you want to implement that?

[cakebaker]

Yes.

[sylvestre]

Looks like we are good ?! :)
cc @tertsdiepraam

[tertsdiepraam]

Wow, that's great! Thanks everyone!

[sylvestre]

yeah, bravo :)