Simplified man pages

Topics relating to MX Docs and MX Videos
Message
Author
User avatar
Richard
Posts: 1577
Joined: Fri Dec 12, 2008 10:31 am

Re: Simplified man pages

#11 Post by Richard »

@Stevo,
Much quicker, thanks.

@cpoakes,
Valid complaints that exemplify the need
for extending and improving the tldr pages project;
otherwise, you may be right.

I've been waiting a long time for more examples in man pages.
Thinkpad T430 & Dell Latitude E7450, both with MX-21.3.1
kernal 5.10.0-26-amd64 x86_64; Xfce-4.18.0; 8 GB RAM
Intel Core i5-3380M, Graphics, Audio, Video; & SSDs.

skidoo
Posts: 753
Joined: Tue Sep 22, 2015 6:56 pm

Re: Simplified man pages

#12 Post by skidoo »

disappointed with the implementation and conceptualization
To their credit, accepting markdown-formatted submissions does set a low barrier-to-entry for prospective contributors.
(via a provided client? The way I'm reading it, an API converts the submission into a pull request)
Perhaps a webpage for submissions would be easier. Fill in plaintext into templated form fields & have the server apply the markup(down).
The "curl" aspect that I groused about in earlier post, and the node.js stack, those are only involved until/unless someone builds an alternative to their reference implementation of a client https://github.com/tldr-pages/tldr-node-client

I scraped their "common" and "linux" lists, then quickly eliminated non-relevant stuffs like
archey, brew, calibre-server, ebook-convert, heroku, npm, odps, odps-auth, odps-func, odps-inst, odps-resource,
odps-table, odps-tunnel, supervisorctl, supervisord, systemd-analyze, vagrant, yaourt, zbarimg, zypper

and counted approx 470 potentially-relevant (to an MX user) commands.(YMMV. My /usr/share/man[1-8] path currently contains 2,900+ manpages.)
Spot-checking the contents of those "simplified" entries, shrug, I wasn't impressed.
Swap [squarebrackets] for {{curlybraces}} isn't an improvement, and the examples don't necessarily illustrate the expected most-commonly-used command options.


food for thought:
MX could host a commandlinefu -like subdomain, seeding a knowledgebase with "questions" (command names) and invite usage examples as "answers" (from registered forum members) starting with internal shell commands, then cover the commands provided by coreutils...
http://www.question2answer.org/qa/
https://github.com/q2a/question2answer
http://qa-themes.com/forums/topic/phpbb ... ntegration

Post Reply

Return to “Documentation and videos”