github.com/lmorg/murex@v0.0.0-20240217211045-e081c89cd4ef/docs/commands/man-summary.md (about)

     1  # `man-summary`
     2  
     3  > Outputs a man page summary of a command
     4  
     5  ## Description
     6  
     7  `man-summary` reads the man pages for a given command and outputs it's
     8  summary (if one exists).
     9  
    10  ## Usage
    11  
    12  ```
    13  man-summary command -> <stdout>
    14  ```
    15  
    16  ## Examples
    17  
    18  ```
    19  ยป man-summary man 
    20  man - an interface to the on-line reference manuals
    21  ```
    22  
    23  ## See Also
    24  
    25  * [`config`](../commands/config.md):
    26    Query or define Murex runtime settings
    27  * [`man-get-flags` ](../commands/man-get-flags.md):
    28    Parses man page files for command line flags 
    29  * [`murex-docs`](../commands/murex-docs.md):
    30    Displays the man pages for Murex builtins
    31  * [`summary` ](../commands/summary.md):
    32    Defines a summary help text for a command
    33  
    34  <hr/>
    35  
    36  This document was generated from [builtins/core/management/functions_doc.yaml](https://github.com/lmorg/murex/blob/master/builtins/core/management/functions_doc.yaml).