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

     1  # `fid-list`
     2  
     3  > Lists all running functions within the current Murex session
     4  
     5  ## Description
     6  
     7  `fid-list` is a tool for outputting all the functions currently managed by that
     8  Murex session. Those functions could be Murex functions, builtins or any
     9  external executables launched from Murex.
    10  
    11  Conceptually `fid-list` is a little like `ps` (on POSIX systems) however
    12  `fid-list` was not written to be POSIX compliant.
    13  
    14  Multiple flags cannot be used with each other.
    15  
    16  ## Usage
    17  
    18  ```
    19  fid-list [ flag ] -> <stdout>
    20  ```
    21  
    22  `jobs` is an alias for `fid-list: --jobs`:
    23  ```
    24  jobs -> <stdout>
    25  ```
    26  
    27  ## Flags
    28  
    29  * `--background`
    30      Returns a `json` map of background jobs
    31  * `--csv`
    32      Output table in a `csv` format
    33  * `--help`
    34      Outputs a list of parameters and a descriptions
    35  * `--jobs`
    36      Show background and stopped jobs
    37  * `--jsonl`
    38      Output table in a jsonlines (`jsonl`) format (defaulted to when piped)
    39  * `--stopped`
    40      Returns a `json` map of stopped jobs
    41  * `--tty`
    42      Force default TTY output even when piped
    43  
    44  ## Detail
    45  
    46  Because Murex is a multi-threaded shell, builtins are not forked processes
    47  like in a traditional / POSIX shell. This means that you cannot use the
    48  operating systems default process viewer (eg `ps`) to list Murex functions.
    49  This is where `fid-list` comes into play. It is used to view all the functions
    50  and processes that are managed by the current Murex session. That would
    51  include:
    52  
    53  * any aliases within Murex
    54  * public and private Murex functions
    55  * builtins (eg `fid-list` is a builtin command)
    56  * any external processes that were launched from within this shell session
    57  * any background functions or processes of any of the above
    58  
    59  ## Synonyms
    60  
    61  * `fid-list`
    62  * `jobs`
    63  
    64  
    65  ## See Also
    66  
    67  * [`*` (generic)](../types/generic.md):
    68    generic (primitive)
    69  * [`bexists`](../commands/bexists.md):
    70    Check which builtins exist
    71  * [`bg`](../commands/bg.md):
    72    Run processes in the background
    73  * [`builtins`](../commands/runtime.md):
    74    Returns runtime information on the internal state of Murex
    75  * [`csv`](../types/csv.md):
    76    CSV files (and other character delimited tables)
    77  * [`exec`](../commands/exec.md):
    78    Runs an executable
    79  * [`fexec` ](../commands/fexec.md):
    80    Execute a command or function, bypassing the usual order of precedence.
    81  * [`fg`](../commands/fg.md):
    82    Sends a background process into the foreground
    83  * [`fid-kill`](../commands/fid-kill.md):
    84    Terminate a running Murex function
    85  * [`fid-killall`](../commands/fid-killall.md):
    86    Terminate _all_ running Murex functions
    87  * [`jobs`](../commands/fid-list.md):
    88    Lists all running functions within the current Murex session
    89  * [`jsonl`](../types/jsonl.md):
    90    JSON Lines
    91  * [`murex-update-exe-list`](../commands/murex-update-exe-list.md):
    92    Forces Murex to rescan $PATH looking for executables
    93  
    94  <hr/>
    95  
    96  This document was generated from [builtins/core/processes/fid-list_doc.yaml](https://github.com/lmorg/murex/blob/master/builtins/core/processes/fid-list_doc.yaml).