Man-Page Summary (man-summary)

Outputs a man page summary of a command

Description

man-summary reads the man pages for a given command(s) and outputs it’s summary (if one exists).

Usage

man-summary command [ commands ] -> <stdout>

Examples

» man-summary man 
man - an interface to the on-line reference manuals

Detail

man-summary can take multiple parameters and will return the summary for each command. If any commands have no summaries, then the exit number will be incremented. In the example below, two parameters had no associated man page:

» man-summary aa ab ac ad ae
aa - Manipulate Apple Archives
ab - Apache HTTP server benchmarking tool
ac - connect time accounting
ad - no man page exists
ae - no man page exists

» exitnum
2

Synonyms

See Also


This document was generated from builtins/core/management/functions_doc.yaml.

This site's content is rebuilt automatically from murex's source code after each merge to the master branch. Downloadable murex binaries are also built with the website.

Last built on Wed Sep 18 21:18:57 UTC 2024 against commit c037883c03788357164e9846c84d9f777251495d9452a8e.

Current version is 6.3.4225 (develop) which has been verified against tests cases.