Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]


Groups > linux.debian.user > #236247

Re: A feasible method to add examples to man pages?

From Marco Möller <talby@debianlists.mobilxpress.net>
Newsgroups linux.debian.user
Subject Re: A feasible method to add examples to man pages?
Date 2021-06-21 20:50 +0200
Message-ID <Csx9D-81p-9@gated-at.bofh.it> (permalink)
References <Csu25-6f6-1@gated-at.bofh.it>
Organization linux.* mail to news gateway

Show all headers | View raw


On 21.06.21 17:29, Richard Owlett wrote:
> Many see the need for examples to be associated with man pages.
> Sometime back a post mentioned a web page that could return examples for 
> most(all??) Linux commands. I failed to bookmark it and have not 
> rediscovered it since.
> 
> In another forum I was pointed to https://cht.sh/ .
> Going to  https://cht.sh/XXX  will return a list of examples for XXX.
> 
> Along the right side of each page of /manpages.debian.org/... there is a 
> list of links to various topics.
> 
> Would it be proper/reasonable/practical/??? to add an entry of the form 
> https://cht.sh/XXX ?
> 
> Comments?
> TIA
> 
> 

For displaying examples I am using the tldr command provided by package 
"tldr".
This client's web page is here:
https://github.com/psibi/tldr-hs#readme

The general tldr site is here:
https://tldr.sh/
There are also several web pages which search and display the 
information from the tldr examples collection, like this one:
https://tldr.ostera.io/

The project invites to participate by adding examples to its collection.
Following for years the upcoming discussions about the wish to enhance 
man pages by adding examples to it but confronting the situation that 
man pages are usually maintained by the package maintainers and not all 
of them are in favor of adding examples to the man pages, I think that 
the normal users are best served by supporting as a community an 
examples collection like the above mentioned tldr project.

Just my view as a user.
Marco.

Back to linux.debian.user | Previous | Next — Previous in thread | Find similar | Unroll thread


Thread

A feasible method to add examples to man pages? Richard Owlett <rowlett@cloud85.net> - 2021-06-21 17:30 +0200
  Re: A feasible method to add examples to man pages? Richard Owlett <rowlett@cloud85.net> - 2021-06-21 17:50 +0200
  Re: A feasible method to add examples to man pages? Stefan Monnier <monnier@iro.umontreal.ca> - 2021-06-21 18:20 +0200
    Re: A feasible method to add examples to man pages? Curt <curty@free.fr> - 2021-06-21 22:00 +0200
      Re: A feasible method to add examples to man pages? Richard Owlett <rowlett@cloud85.net> - 2021-06-21 22:30 +0200
        Re: A feasible method to add examples to man pages? Brian <ad44@cityscape.co.uk> - 2021-06-22 01:00 +0200
          Re: A feasible method to add examples to man pages? Greg Wooledge <greg@wooledge.org> - 2021-06-22 03:10 +0200
            Re: A feasible method to add examples to man pages? Curt <curty@free.fr> - 2021-06-22 09:50 +0200
              Re: A feasible method to add examples to man pages? Richard Owlett <rowlett@cloud85.net> - 2021-06-22 13:00 +0200
                Re: A feasible method to add examples to man pages? Curt <curty@free.fr> - 2021-06-22 14:10 +0200
                Re: A feasible method to add examples to man pages? Richard Owlett <rowlett@cloud85.net> - 2021-06-22 14:40 +0200
                Re: A feasible method to add examples to man pages? Curt <curty@free.fr> - 2021-06-22 15:20 +0200
                Re: A feasible method to add examples to man pages? Richard Owlett <rowlett@cloud85.net> - 2021-06-22 15:50 +0200
                Re: A feasible method to add examples to man pages? Curt <curty@free.fr> - 2021-06-22 16:40 +0200
                Re: A feasible method to add examples to man pages? Andrei POPESCU <andreimpopescu@gmail.com> - 2021-06-22 16:30 +0200
                Re: A feasible method to add examples to man pages? Brian <ad44@cityscape.co.uk> - 2021-06-22 18:20 +0200
              Re: A feasible method to add examples to man pages? Stefan Monnier <monnier@iro.umontreal.ca> - 2021-06-22 18:20 +0200
                Re: A feasible method to add examples to man pages? rhkramer@gmail.com - 2021-06-23 13:20 +0200
              Re: A feasible method to add examples to man pages? Richard Owlett <rowlett@cloud85.net> - 2021-06-23 21:40 +0200
  Re: A feasible method to add examples to man pages? Nate Bargmann <n0nb@n0nb.us> - 2021-06-21 19:00 +0200
    Re: A feasible method to add examples to man pages? Richard Owlett <rowlett@cloud85.net> - 2021-06-21 20:30 +0200
  Re: A feasible method to add examples to man pages? Marco Möller <talby@debianlists.mobilxpress.net> - 2021-06-21 20:50 +0200

csiph-web