github.com/lmorg/murex@v0.0.0-20240217211045-e081c89cd4ef/builtins/core/processes/fid-list_doc.yaml (about)

     1  - DocumentID: fid-list
     2    Title: >+
     3      `fid-list`
     4    CategoryID: commands
     5    Summary: >-
     6      Lists all running functions within the current Murex session
     7    Description: |-
     8      `fid-list` is a tool for outputting all the functions currently managed by that
     9      Murex session. Those functions could be Murex functions, builtins or any
    10      external executables launched from Murex.
    11  
    12      Conceptually `fid-list` is a little like `ps` (on POSIX systems) however
    13      `fid-list` was not written to be POSIX compliant.
    14  
    15      Multiple flags cannot be used with each other.
    16    Usage: |-
    17      ```
    18      fid-list [ flag ] -> <stdout>
    19      ```
    20  
    21      `jobs` is an alias for `fid-list: --jobs`:
    22      ```
    23      jobs -> <stdout>
    24      ```
    25    #Examples: |-
    26    Flags:
    27      --csv: >-
    28        Output table in a `csv` format
    29      --jsonl: >-
    30        Output table in a jsonlines (`jsonl`) format (defaulted to when piped)
    31      --tty: >-
    32        Force default TTY output even when piped
    33      --jobs: >-
    34        Show background and stopped jobs
    35      --stopped: >-
    36        Returns a `json` map of stopped jobs
    37      --background: >-
    38        Returns a `json` map of background jobs
    39      --help: >-
    40        Outputs a list of parameters and a descriptions
    41    Detail: |-
    42      Because Murex is a multi-threaded shell, builtins are not forked processes
    43      like in a traditional / POSIX shell. This means that you cannot use the
    44      operating systems default process viewer (eg `ps`) to list Murex functions.
    45      This is where `fid-list` comes into play. It is used to view all the functions
    46      and processes that are managed by the current Murex session. That would
    47      include:
    48  
    49      * any aliases within Murex
    50      * public and private Murex functions
    51      * builtins (eg `fid-list` is a builtin command)
    52      * any external processes that were launched from within this shell session
    53      * any background functions or processes of any of the above
    54    Synonyms:
    55      - fid-list
    56      - jobs
    57    Related:
    58      - fid-kill
    59      - fid-killall
    60      - bg
    61      - fg
    62      - jobs
    63      - exec
    64      - fexec
    65      - murex-update-exe-list
    66      - builtins
    67      - bexists
    68      - csv
    69      - jsonl
    70      - generic