github.com/lmorg/murex@v0.0.0-20240217211045-e081c89cd4ef/builtins/docs/docs_doc.yaml (about)

     1  - DocumentID: murex-docs
     2    Title: >+
     3      `murex-docs`
     4    CategoryID: commands
     5    Summary: >-
     6      Displays the man pages for Murex builtins
     7    Description: |-
     8      Displays the man pages for Murex builtins.
     9    Usage: |-
    10      ```
    11      murex-docs [ flag ] command -> <stdout>
    12      ```
    13    Examples: |-
    14      ```
    15      # Output this man page
    16      murex-docs murex-docs
    17      ```
    18    Flags:
    19      --docs: >-
    20        Returns a JSON object of every document available to read offline
    21      --summary: >-
    22        Returns an abridged description of the command rather than the entire
    23        help page
    24    Detail: |-
    25      These man pages are compiled into the Murex executable.
    26    Synonyms:
    27      - murex-docs
    28      - help
    29    Related:
    30      - tout
    31      - err
    32      - brace-quote-func
    33      - cast
    34      - greater-than
    35      - greater-than-greater-than
    36      - out
    37      - tread
    38      - man-get-flags