• Re: Documentation (man, info, etc.) (was Re: The Bash =?UTF-8?B?SGFja2Vy4oCZcw==?= Wiki)

    From Lawrence =?iso-8859-13?q?D=FFOliveiro?=@ldo@nz.invalid to comp.unix.shell on Wed Aug 27 23:26:11 2025
    From Newsgroup: comp.unix.shell

    On Wed, 27 Aug 2025 16:51:20 -0300, Jim Diamond wrote:

    Over the years I've heard people complain that man pages are too terse.

    The bash(1) man page, for a counterexample, replicates the entire manual.

    Imagine if the man page for ffmpeg(-all), gcc or txr was verbose.

    I just counted over 19,000 words in the ffmpeg(1) man page. That does try
    to explain the use of the core command (including filtergraphs!) with no details specific to particular filters/codecs/formats/etc.
    --- Synchronet 3.21a-Linux NewsLink 1.2
  • From Lawrence =?iso-8859-13?q?D=FFOliveiro?=@ldo@nz.invalid to comp.unix.shell on Sat Aug 30 00:26:12 2025
    From Newsgroup: comp.unix.shell

    On Fri, 29 Aug 2025 12:12:45 -0000 (UTC), Lars Poulsen wrote:

    2) There is not really a consistent mapping between package names and
    folder/file names in /usr/share/doc

    Listing the contents of the package will show where all the files go, including documentation files.

    3) Even if it not in /usr/share/doc on your system, it may in fact
    be available in your repos, but good luck figuring out what the
    package is called.

    Keyword searches can be helpful here.
    --- Synchronet 3.21a-Linux NewsLink 1.2
  • From Lawrence =?iso-8859-13?q?D=FFOliveiro?=@ldo@nz.invalid to comp.unix.shell on Tue Nov 4 21:04:09 2025
    From Newsgroup: comp.unix.shell

    On Tue, 4 Nov 2025 02:37:55 -0800, Yeechang Lee wrote:

    I have had this in ~/.bashrc for years:

    function mani () { info $1 --subnodes --output - | less; }

    HererCOs a handy example command for viewing a man page in a nicely typeset rendering:

    gunzip -c $(man -w bash) | groff -ktman -Tpdf | okular -

    What would be an equivalent for info?
    --- Synchronet 3.21a-Linux NewsLink 1.2
  • From gazelle@gazelle@shell.xmission.com (Kenny McCormack) to comp.unix.shell on Tue Nov 4 22:56:42 2025
    From Newsgroup: comp.unix.shell

    In article <10edpo8$3tq9g$6@dont-email.me>,
    Lawrence DOliveiro <ldo@nz.invalid> wrote:
    On Tue, 4 Nov 2025 02:37:55 -0800, Yeechang Lee wrote:

    I have had this in ~/.bashrc for years:

    function mani () { info $1 --subnodes --output - | less; }

    Heres a handy example command for viewing a man page in a nicely typeset >rendering:

    gunzip -c $(man -w bash) | groff -ktman -Tpdf | okular -

    What would be an equivalent for info?

    I don't know, but here is a simpler version of the above pipeline:

    man -Tpdf bash | xpdf /dev/stdin
    --
    The randomly chosen signature file that would have appeared here is more than 4 lines long. As such, it violates one or more Usenet RFCs. In order to remain in compliance with said RFCs, the actual sig can be found at the following URL:
    http://user.xmission.com/~gazelle/Sigs/Aspergers
    --- Synchronet 3.21a-Linux NewsLink 1.2